Skip to Content

Aplikacja jednostronicowa React

Dodaj logowanie do przeglądarkowej aplikacji React jako klienta public, przy użyciu react-oidc-context i przepływu Authorization Code z PKCE.

Ten przewodnik dodaje logowanie OIDC do aplikacji React bez własnego backendu, przy użyciu react-oidc-context (zbudowanej na oidc-client-ts). Aplikacja przeglądarkowa jest klientem public: ma client ID, ale nie ma secretu, i opiera się na PKCE.

Najpierw zarejestruj aplikację jako klienta OIDC typu public / single-page i dodaj swój redirect URI; zobacz Zanim zaczniesz. Protokół leżący u podstaw opisuje strona OpenID Connect (Authorization Code + PKCE).

1. Zainstaluj

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

2. Skonfiguruj providera

Opakuj swoją aplikację w AuthProvider. Wartość authority to domena logowania Twojej instancji; biblioteka odnajduje punkty końcowe i domyślnie używa przepływu Authorization Code z 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>
);

Nie umieszczaj client secretu w kodzie działającym w przeglądarce. Klient public go nie ma.

3. Zaloguj się i odczytaj użytkownika

Użyj hooka useAuth, aby uruchomić logowanie i odczytać jego wynik.

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

Obiekt auth.user.profile zawiera claimy z ID tokenu (takie jak sub, name, email). Wartość auth.user.access_token to token, który wysyłasz do własnych interfejsów API jako Authorization: Bearer <token>.

4. Obsłuż przekierowanie

Biblioteka react-oidc-context przetwarza wywołanie zwrotne automatycznie, gdy aplikacja ładuje się pod adresem redirect_uri, o ile AuthProvider opakowuje drzewo komponentów. Skieruj swój redirect URI na trasę obsługiwaną przez aplikację (na przykład /callback) i zadbaj o to, aby ta trasa renderowała tę samą aplikację opakowaną providerem.

Rozwiązywanie problemów

  • Przekierowanie zapętla się albo adres URL zachowuje parametr code. Dodaj pokazaną wyżej procedurę obsługi onSigninCallback, aby jednorazowe parametry zostały usunięte po przetworzeniu.
  • Niezgodność redirect_uri. Wartość redirect_uri musi dokładnie odpowiadać wartości zarejestrowanej przy aplikacji, łącznie ze ścieżką. Zarejestruj używany przez siebie adres wywołania zwrotnego SPA.
  • Tokeny znikają po odświeżeniu. Domyślnie tokeny są trzymane w pamięci i przepadają po pełnym przeładowaniu. Skonfiguruj magazyn użytkownika (na przykład WebStorageStateStore z localStorage), jeśli mają być trwałe, i rozważ kompromis bezpieczeństwa związany z przechowywaniem tokenów w przeglądarce.
  • invalid_client. Aplikacja musi być zarejestrowana jako klient public (PKCE). Klient confidential oczekuje secretu, którego przeglądarka nie może dostarczyć.

Dalsze kroki

Na tej stronie