Skip to Content

React-Single-Page-App

Fügen Sie einer React-Browser-App die Anmeldung als Public Client hinzu, mit react-oidc-context und dem Authorization Code Flow mit PKCE.

Diese Anleitung fügt einer React-App ohne eigenes Backend die OIDC-Anmeldung hinzu, mit react-oidc-context (aufbauend auf oidc-client-ts). Eine Browser-App ist ein Public Client: Sie hat eine Client-ID, aber kein Secret, und stützt sich auf PKCE.

Registrieren Sie die Anwendung zuerst als Public/Single-Page-OIDC-Client und fügen Sie Ihre Redirect-URI hinzu; siehe Bevor Sie beginnen. Zum zugrunde liegenden Protokoll siehe OpenID Connect (Authorization Code + PKCE).

1. Installieren

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

2. Provider konfigurieren

Umschließen Sie Ihre App mit AuthProvider. Die authority ist die Login-Domain Ihrer Instanz; die Bibliothek ermittelt die Endpunkte per Discovery und verwendet standardmäßig Authorization Code mit 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>
);

Hinterlegen Sie kein Client-Secret im Browser-Code. Ein Public Client hat keines.

3. Anmelden und Benutzer auslesen

Verwenden Sie den useAuth-Hook, um die Anmeldung auszulösen und das Ergebnis auszulesen.

// 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 enthält die ID-Token-Claims (etwa sub, name, email). auth.user.access_token ist das Token, das Sie als Authorization: Bearer <token> an Ihre eigenen APIs senden.

4. Redirect verarbeiten

react-oidc-context verarbeitet den Callback automatisch, wenn die App unter der redirect_uri lädt, solange der AuthProvider den Komponentenbaum umschließt. Richten Sie Ihre Redirect-URI auf eine Route, die Ihre App ausliefert (zum Beispiel /callback), und stellen Sie sicher, dass diese Route dieselbe vom Provider umschlossene App rendert.

Fehlerbehebung

  • Der Redirect läuft in einer Schleife oder die URL behält den code-Parameter. Ergänzen Sie den oben gezeigten onSigninCallback-Handler, damit die Einmal-Parameter nach der Verarbeitung entfernt werden.
  • redirect_uri stimmt nicht überein. Die redirect_uri muss exakt einem an der Anwendung registrierten Wert entsprechen, einschließlich des Pfads. Registrieren Sie die Callback-URL, die Ihre SPA verwendet.
  • Tokens verschwinden beim Neuladen. Standardmäßig werden Tokens im Speicher gehalten und gehen bei einem vollständigen Neuladen verloren. Konfigurieren Sie einen User-Store (zum Beispiel WebStorageStateStore mit localStorage), wenn sie erhalten bleiben sollen, und wägen Sie den Sicherheitskompromiss ab, Tokens im Browser zu speichern.
  • invalid_client. Die Anwendung muss als Public Client (PKCE) registriert sein. Ein Confidential Client erwartet ein Secret, das der Browser nicht liefern kann.

Nächste Schritte

  • Node/Express-Backend, falls Sie eine Server-Komponente ergänzen.
  • APIs, um Ihre eigene API mit dem Access-Token zu schützen.

Auf dieser Seite