Skip to Content

Python/Flask-backend

Voeg aanmelding toe aan een Python-Flask-app met de bibliotheek Authlib en de authorization code flow met PKCE.

Deze handleiding voegt OIDC-aanmelding toe aan een Flask-app met Authlib, dat discovery, PKCE en tokenvalidatie voor u afhandelt. Ze gaat uit van een confidential client (een backend dat een secret geheim kan houden).

Hebt u nog geen applicatie geregistreerd, zie dan Voordat u begint. Voor het onderliggende protocol, zie OpenID Connect (Authorization Code + PKCE).

1. Afhankelijkheden installeren

pip install flask authlib requests

2. De client configureren

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
    },
)

Houd OIDC_CLIENT_ID en OIDC_CLIENT_SECRET in de omgeving, nooit in versiebeheer.

3. De aanmelding starten

Authlib bouwt de autorisatie-URL met een PKCE-challenge en een state, onthoudt beide in de sessie en stuurt de browser door:

@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)

De redirect_uri moet exact overeenkomen met een waarde die bij de applicatie is geregistreerd.

4. De callback verwerken

Wissel de code in voor tokens. Authlib valideert het antwoord, de state, de PKCE-verifier en het ID token voor u.

@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. Afmelden

Stuur de gebruiker naar het end-session-eindpunt en wis daarna uw eigen sessie.

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}")

Registreer https://app.example.com/ als post-logout-redirect-URI bij de applicatie, op dezelfde manier als een redirect-URI.

Probleemoplossing

  • De discovery-aanroep mislukt. Bevestig dat https://<your-domain>/.well-known/openid-configuration vanaf uw server bereikbaar is en dat het domein de aanmeldhost van uw instantie is.
  • mismatching_state bij de callback. De sessie die de aanmelding heeft gestart, moet dezelfde zijn die de callback verwerkt. Zorg dat sessiecookies de doorverwijzing overleven (correcte SameSite en, in productie, secure-cookies over HTTPS) en dat secret_key over alle workers identiek is; een willekeurige sleutel per worker maakt de sessie bij elke doorverwijzing stilzwijgend stuk.
  • Er wordt nooit een refresh token teruggegeven. Neem offline_access op in de scope en bevestig dat de applicatie is geconfigureerd om refresh tokens te ontvangen.

Volgende stappen

Op deze pagina