Node/Express-backend
Voeg aanmelding toe aan een Node.js-Express-app met de bibliotheek openid-client en de authorization code flow met PKCE.
Deze handleiding voegt OIDC-aanmelding toe aan een Express-app met de bibliotheek openid-client, die 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
npm install express express-session openid-client2. De client configureren
import * as client from 'openid-client';
// Your instance's login domain (issuer). openid-client reads the
// discovery document at <issuer>/.well-known/openid-configuration.
const server = new URL('https://<your-domain>');
const clientId = process.env.OIDC_CLIENT_ID;
const clientSecret = process.env.OIDC_CLIENT_SECRET;
const redirectUri = 'https://app.example.com/callback';
const scope = 'openid profile email offline_access';
// Discover endpoints and prepare the client (default: client_secret_basic).
const config = await client.discovery(server, clientId, clientSecret);Houd OIDC_CLIENT_ID en OIDC_CLIENT_SECRET in de omgeving, nooit in versiebeheer.
3. De aanmelding starten
Bouw de autorisatie-URL met een PKCE-challenge en een state, onthoud beide in de sessie en stuur de browser door.
import express from 'express';
import session from 'express-session';
const app = express();
app.use(session({ secret: process.env.SESSION_SECRET, resave: false, saveUninitialized: false }));
app.get('/login', async (req, res) => {
const codeVerifier = client.randomPKCECodeVerifier();
const codeChallenge = await client.calculatePKCECodeChallenge(codeVerifier);
const state = client.randomState();
// stash for the callback
req.session.codeVerifier = codeVerifier;
req.session.state = state;
const authUrl = client.buildAuthorizationUrl(config, {
redirect_uri: redirectUri,
scope,
code_challenge: codeChallenge,
code_challenge_method: 'S256',
state,
});
res.redirect(authUrl.href);
});4. De callback verwerken
Wissel de code in voor tokens. openid-client valideert het antwoord, de state en de PKCE-verifier voor u.
app.get('/callback', async (req, res) => {
const currentUrl = new URL(req.originalUrl, 'https://app.example.com');
const tokens = await client.authorizationCodeGrant(config, currentUrl, {
pkceCodeVerifier: req.session.codeVerifier,
expectedState: req.session.state,
});
const claims = tokens.claims(); // validated ID-token claims
req.session.user = { sub: claims.sub, name: claims.name, email: claims.email };
req.session.idToken = tokens.id_token;
// Optional: fetch additional claims from UserInfo
// const userinfo = await client.fetchUserInfo(config, tokens.access_token, claims.sub);
res.redirect('/');
});5. Afmelden
Stuur de gebruiker naar het end-session-eindpunt en wis daarna uw eigen sessie.
app.get('/logout', (req, res) => {
const endSession = client.buildEndSessionUrl(config, {
id_token_hint: req.session.idToken,
post_logout_redirect_uri: 'https://app.example.com/',
});
req.session.destroy(() => res.redirect(endSession.href));
});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-configurationvanaf uw server bereikbaar is en dat het domein de aanmeldhost van uw instantie is. state- of PKCE-fouten bij de callback. De sessie die de aanmelding heeft gestart, moet dezelfde zijn die de callback verwerkt. Zorg dat sessiecookies de doorverwijzing overleven (correcteSameSiteen, in productie,secure-cookies over HTTPS).- Er wordt nooit een refresh token teruggegeven. Neem
offline_accessop in de scope en bevestig dat de applicatie is geconfigureerd om refresh tokens te ontvangen.
Volgende stappen
- React single-page-app voor een client die alleen in de browser draait.
- Applicaties om tokenlevensduren en andere clientinstellingen te bekijken.
OpenID Connect (Authorization Code + PKCE)
De OIDC authorization code flow met PKCE van begin tot eind, met kale HTTP en curl, zodat u elke stap begrijpt voordat u naar een bibliotheek grijpt.
Python/Flask-backend
Voeg aanmelding toe aan een Python-Flask-app met de bibliotheek Authlib en de authorization code flow met PKCE.