Skip to Content

React single-page-app

Voeg aanmelding als public client toe aan een React-browserapp met react-oidc-context en de authorization code flow met PKCE.

Deze handleiding voegt OIDC-aanmelding toe aan een React-app zonder eigen backend, met react-oidc-context (gebouwd op oidc-client-ts). Een browserapp is een public client: ze heeft een client ID maar geen secret, en steunt op PKCE.

Registreer de applicatie eerst als public / single-page-OIDC-client en voeg uw redirect-URI toe; zie Voordat u begint. Voor het onderliggende protocol, zie OpenID Connect (Authorization Code + PKCE).

1. Installeren

npm install react-oidc-context oidc-client-ts

2. De provider configureren

Omsluit uw app met AuthProvider. De authority is het aanmelddomein van uw instantie; de bibliotheek achterhaalt de eindpunten via discovery en gebruikt standaard authorization code met PKCE.

// main.jsx
import { createRoot } from 'react-dom/client';
import { AuthProvider } from 'react-oidc-context';
import App from './App';

const oidcConfig = {
  authority: 'https://<your-domain>',
  client_id: '<your-client-id>',
  redirect_uri: 'https://app.example.com/callback',
  post_logout_redirect_uri: 'https://app.example.com/',
  scope: 'openid profile email',
  // Clean the code/state params out of the URL after the redirect back.
  onSigninCallback: () =>
    window.history.replaceState({}, document.title, window.location.pathname),
};

createRoot(document.getElementById('root')).render(
  <AuthProvider {...oidcConfig}>
    <App />
  </AuthProvider>
);

Zet geen client secret in browsercode. Een public client heeft er geen.

3. Aanmelden en de gebruiker uitlezen

Gebruik de hook useAuth om de aanmelding te starten en het resultaat uit te lezen.

// App.jsx
import { useAuth } from 'react-oidc-context';

export default function App() {
  const auth = useAuth();

  if (auth.isLoading) return <p>Loading...</p>;
  if (auth.error) return <p>Sign-in error: {auth.error.message}</p>;

  if (auth.isAuthenticated) {
    return (
      <div>
        <p>Signed in as {auth.user?.profile.email}</p>
        <button onClick={() => auth.signoutRedirect()}>Log out</button>
      </div>
    );
  }

  return <button onClick={() => auth.signinRedirect()}>Log in</button>;
}

auth.user.profile bevat de claims uit het ID token (zoals sub, name, email). auth.user.access_token is het token dat u als Authorization: Bearer <token> naar uw eigen API's stuurt.

4. De doorverwijzing verwerken

react-oidc-context verwerkt de callback automatisch wanneer de app onder de redirect_uri laadt, zolang de AuthProvider de componentenboom omsluit. Richt uw redirect-URI op een route die uw app uitlevert (bijvoorbeeld /callback) en zorg dat die route dezelfde door de provider omsloten app rendert.

Probleemoplossing

  • De doorverwijzing raakt in een lus of de URL houdt de parameter code. Voeg de hierboven getoonde handler onSigninCallback toe, zodat de eenmalige parameters na de verwerking worden gewist.
  • redirect_uri komt niet overeen. De redirect_uri moet exact overeenkomen met een waarde die bij de applicatie is geregistreerd, inclusief het pad. Registreer de callback-URL die uw SPA gebruikt.
  • Tokens verdwijnen bij het herladen. Standaard worden tokens in het geheugen bewaard en gaan ze bij een volledige herlaadbeurt verloren. Configureer een user store (bijvoorbeeld WebStorageStateStore met localStorage) als ze behouden moeten blijven, en weeg de beveiligingsafweging af van het opslaan van tokens in de browser.
  • invalid_client. De applicatie moet als public client (PKCE) zijn geregistreerd. Een confidential client verwacht een secret dat de browser niet kan leveren.

Volgende stappen

Op deze pagina