Skip to Content

Aplicação de página única em React

Acrescente o início de sessão a uma aplicação React de browser como cliente public, com react-oidc-context e o fluxo Authorization Code com PKCE.

Este guia acrescenta o início de sessão OIDC a uma aplicação React sem backend próprio, com react-oidc-context (assente em oidc-client-ts). Uma aplicação de browser é um cliente public: tem um client ID mas nenhum segredo, e assenta em PKCE.

Registe primeiro a aplicação como cliente OIDC public / de página única e adicione o seu redirect URI; consulte Antes de começar. Para o protocolo subjacente, consulte OpenID Connect (Authorization Code + PKCE).

1. Instalar

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

2. Configurar o provider

Envolva a sua aplicação com AuthProvider. O authority é o domínio de início de sessão da sua instância; a biblioteca descobre os endpoints e utiliza, por predefinição, Authorization Code com 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>
);

Não coloque um client secret em código de browser. Um cliente public não tem nenhum.

3. Iniciar sessão e ler o utilizador

Utilize o hook useAuth para desencadear o início de sessão e ler o resultado.

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

O auth.user.profile contém os claims do ID token (como sub, name, email). O auth.user.access_token é o token que envia às suas próprias APIs em Authorization: Bearer <token>.

4. Processar o redirecionamento

O react-oidc-context processa o callback automaticamente quando a aplicação carrega no redirect_uri, desde que o AuthProvider envolva a árvore de componentes. Aponte o seu redirect URI para uma rota servida pela sua aplicação (por exemplo, /callback) e certifique-se de que essa rota renderiza a mesma aplicação envolvida pelo provider.

Resolução de problemas

  • O redirecionamento entra em ciclo ou o URL mantém o parâmetro code. Acrescente o handler onSigninCallback apresentado acima, para que os parâmetros de utilização única sejam removidos após o processamento.
  • redirect_uri não coincide. O redirect_uri tem de corresponder exatamente a um valor registado na aplicação, incluindo o caminho. Registe o URL de callback que a sua SPA utiliza.
  • Os tokens desaparecem ao recarregar. Por predefinição, os tokens são mantidos em memória e perdem-se num recarregamento completo. Configure um user store (por exemplo, WebStorageStateStore com localStorage) se precisar que persistam, e pondere o compromisso de segurança de guardar tokens no browser.
  • invalid_client. A aplicação tem de estar registada como cliente public (PKCE). Um cliente confidential espera um segredo que o browser não pode fornecer.

Passos seguintes

Nesta página