Skip to Content

Backend Python / Flask

Dodaj logowanie do aplikacji Python Flask przy użyciu biblioteki Authlib i przepływu Authorization Code z PKCE.

Ten przewodnik dodaje logowanie OIDC do aplikacji Flask przy użyciu biblioteki Authlib, która obsługuje za Ciebie discovery, PKCE i weryfikację tokenów. Zakłada klienta confidential (backend zdolny utrzymać secret w tajemnicy).

Jeśli nie zarejestrowałeś jeszcze aplikacji, zobacz Zanim zaczniesz. Protokół stojący za tym opisuje strona OpenID Connect (Authorization Code + PKCE).

1. Zainstaluj zależności

pip install flask authlib requests

2. Skonfiguruj klienta

import os

from authlib.integrations.flask_client import OAuth
from flask import Flask, redirect, session, url_for

app = Flask(__name__)
app.secret_key = os.environ["SESSION_SECRET"]

oauth = OAuth(app)
oauth.register(
    "idp",
    client_id=os.environ["OIDC_CLIENT_ID"],
    client_secret=os.environ["OIDC_CLIENT_SECRET"],
    # Your instance's login domain (issuer). Authlib reads the discovery
    # document and configures all endpoints from it.
    server_metadata_url="https://<your-domain>/.well-known/openid-configuration",
    client_kwargs={
        "scope": "openid profile email offline_access",
        "code_challenge_method": "S256",  # send a PKCE challenge as well
    },
)

Trzymaj OIDC_CLIENT_ID i OIDC_CLIENT_SECRET w zmiennych środowiskowych, nigdy w systemie kontroli wersji.

3. Rozpocznij logowanie

Authlib buduje adres URL autoryzacji z PKCE challenge i parametrem state, zapamiętuje oba w sesji i przekierowuje przeglądarkę:

@app.route("/login")
def login():
    redirect_uri = url_for("callback", _external=True)  # e.g. https://app.example.com/callback
    return oauth.idp.authorize_redirect(redirect_uri)

Wartość redirect_uri musi dokładnie odpowiadać wartości zarejestrowanej przy aplikacji.

4. Obsłuż wywołanie zwrotne

Wymień kod na tokeny. Authlib weryfikuje za Ciebie odpowiedź, wartość state, PKCE verifier oraz ID token.

@app.route("/callback")
def callback():
    tokens = oauth.idp.authorize_access_token()

    claims = tokens["userinfo"]  # validated ID-token claims
    session["user"] = {"sub": claims["sub"], "name": claims.get("name"), "email": claims.get("email")}
    session["id_token"] = tokens["id_token"]

    # Optional: fetch additional claims from UserInfo
    # userinfo = oauth.idp.userinfo(token=tokens)

    return redirect("/")

5. Wyloguj

Wyślij użytkownika do punktu końcowego end session, a następnie wyczyść własną sesję.

from urllib.parse import urlencode

@app.route("/logout")
def logout():
    metadata = oauth.idp.load_server_metadata()
    params = urlencode({
        "id_token_hint": session.get("id_token", ""),
        "post_logout_redirect_uri": "https://app.example.com/",
    })
    session.clear()
    return redirect(f"{metadata['end_session_endpoint']}?{params}")

Zarejestruj https://app.example.com/ jako adres przekierowania po wylogowaniu przy aplikacji, tak samo jak rejestrujesz redirect URI.

Rozwiązywanie problemów

  • Wywołanie discovery kończy się niepowodzeniem. Potwierdź, że adres https://<your-domain>/.well-known/openid-configuration jest osiągalny z Twojego serwera i że domena jest hostem logowania Twojej instancji.
  • mismatching_state przy wywołaniu zwrotnym. Sesja, która rozpoczęła logowanie, musi być tą, która obsługuje wywołanie zwrotne. Zadbaj o to, aby ciasteczka sesji przetrwały przekierowanie (poprawne SameSite, a w środowisku produkcyjnym ciasteczka secure przesyłane po HTTPS), oraz o to, aby secret_key był identyczny we wszystkich procesach roboczych; losowy klucz na każdy proces po cichu psuje sesję przy każdym przekierowaniu.
  • Refresh token nigdy nie jest zwracany. Uwzględnij offline_access w scope i potwierdź, że aplikacja jest skonfigurowana do otrzymywania refresh tokenów.

Dalsze kroki

Na tej stronie