Skip to Content

Backend Node / Express

Dodaj logowanie do aplikacji Node.js Express przy użyciu biblioteki openid-client i przepływu Authorization Code z PKCE.

Ten przewodnik dodaje logowanie OIDC do aplikacji Express przy użyciu biblioteki openid-client, 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

npm install express express-session openid-client

2. Skonfiguruj klienta

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

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

3. Rozpocznij logowanie

Zbuduj adres URL autoryzacji z PKCE challenge i parametrem state, zapamiętaj oba w sesji i przekieruj przeglądarkę.

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. Obsłuż wywołanie zwrotne

Wymień kod na tokeny. Biblioteka openid-client weryfikuje za Ciebie odpowiedź, wartość state oraz PKCE verifier.

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. Wyloguj

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

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

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.
  • Błędy state albo PKCE 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).
  • 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