Skip to Content

OpenID Connect (Authorization Code + PKCE)

O fluxo OIDC Authorization Code com PKCE de ponta a ponta, com HTTP simples e curl, para que perceba cada passo antes de recorrer a uma biblioteca.

Este guia percorre o Authorization Code flow com PKCE usando apenas HTTP, para que veja exatamente o que cada passo envia e recebe. Os guias de Node e React fazem o mesmo com uma biblioteca; leia este primeiro.

Certifique-se de que registou uma aplicação e um redirect URI, conforme descrito em Antes de começar.

O fluxo numa imagem

  1. A sua aplicação redireciona o browser para o authorization endpoint com um desafio PKCE.
  2. O utilizador inicia sessão; a plataforma redireciona de volta para o seu redirect URI com um code de utilização única.
  3. A sua aplicação troca o code (mais o verifier do PKCE) no token endpoint por um ID token e um access token.
  4. A sua aplicação valida o ID token e, opcionalmente, chama o endpoint UserInfo.

1. Criar um verifier e um challenge PKCE

Gere um code verifier aleatório e derive dele o code challenge SHA-256:

# code verifier: 43-128 chars of unreserved characters
CODE_VERIFIER=$(openssl rand -base64 60 | tr -d '\n=+/' | cut -c1-64)

# code challenge: base64url(SHA256(verifier))
CODE_CHALLENGE=$(printf '%s' "$CODE_VERIFIER" | openssl dgst -binary -sha256 | openssl base64 | tr '+/' '-_' | tr -d '=\n')

echo "verifier:  $CODE_VERIFIER"
echo "challenge: $CODE_CHALLENGE"
import { createHash, randomBytes } from 'node:crypto';

const codeVerifier = randomBytes(48).toString('base64url'); // 64 chars
const codeChallenge = createHash('sha256').update(codeVerifier).digest('base64url');

console.log('verifier: ', codeVerifier);
console.log('challenge:', codeChallenge);
import base64, hashlib, secrets

code_verifier = secrets.token_urlsafe(48)  # 64 chars
digest = hashlib.sha256(code_verifier.encode("ascii")).digest()
code_challenge = base64.urlsafe_b64encode(digest).rstrip(b"=").decode()

print("verifier: ", code_verifier)
print("challenge:", code_challenge)
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.SecureRandom;
import java.util.Base64;

var random = new byte[48];
new SecureRandom().nextBytes(random);
var encoder = Base64.getUrlEncoder().withoutPadding();

var codeVerifier = encoder.encodeToString(random); // 64 chars
var codeChallenge = encoder.encodeToString(
    MessageDigest.getInstance("SHA-256").digest(codeVerifier.getBytes(StandardCharsets.US_ASCII)));

System.out.println("verifier:  " + codeVerifier);
System.out.println("challenge: " + codeChallenge);
using System.Security.Cryptography;
using System.Text;

static string B64Url(byte[] bytes) =>
    Convert.ToBase64String(bytes).TrimEnd('=').Replace('+', '-').Replace('/', '_');

var codeVerifier = B64Url(RandomNumberGenerator.GetBytes(48)); // 64 chars
var codeChallenge = B64Url(SHA256.HashData(Encoding.ASCII.GetBytes(codeVerifier)));

Console.WriteLine($"verifier:  {codeVerifier}");
Console.WriteLine($"challenge: {codeChallenge}");
import (
	"crypto/rand"
	"crypto/sha256"
	"encoding/base64"
	"fmt"
)

random := make([]byte, 48)
rand.Read(random)

codeVerifier := base64.RawURLEncoding.EncodeToString(random) // 64 chars
sum := sha256.Sum256([]byte(codeVerifier))
codeChallenge := base64.RawURLEncoding.EncodeToString(sum[:])

fmt.Println("verifier: ", codeVerifier)
fmt.Println("challenge:", codeChallenge)
function b64url(string $bytes): string {
    return rtrim(strtr(base64_encode($bytes), '+/', '-_'), '=');
}

$codeVerifier = b64url(random_bytes(48)); // 64 chars
$codeChallenge = b64url(hash('sha256', $codeVerifier, true));

echo "verifier:  $codeVerifier\n";
echo "challenge: $codeChallenge\n";
use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine};
use rand::RngCore;
use sha2::{Digest, Sha256};

let mut random = [0u8; 48];
rand::thread_rng().fill_bytes(&mut random);

let code_verifier = URL_SAFE_NO_PAD.encode(random); // 64 chars
let code_challenge = URL_SAFE_NO_PAD.encode(Sha256::digest(code_verifier.as_bytes()));

println!("verifier:  {code_verifier}");
println!("challenge: {code_challenge}");

Guarde o verifier para o passo 3. Gere também um state aleatório (e, se o verificar, um nonce) como proteção contra cross-site request forgery e replay.

2. Enviar o utilizador para o authorization endpoint

Abra este URL no browser (aqui quebrado em várias linhas para facilitar a leitura):

https://<your-domain>/authorize
  ?response_type=code
  &client_id=<your-client-id>
  &redirect_uri=https://app.example.com/callback
  &scope=openid%20profile%20email%20offline_access
  &state=<random-state>
  &code_challenge=<CODE_CHALLENGE>
  &code_challenge_method=S256
  • O scope tem de incluir openid. Acrescente profile e email para os claims padrão, e offline_access se pretender um refresh token.
  • Depois de o utilizador iniciar sessão, a plataforma redireciona para https://app.example.com/callback?code=<one-time-code>&state=<random-state>.
  • Verifique se o state devolvido coincide com o que enviou antes de prosseguir.

3. Trocar o código por tokens

Envie o código e o verifier do PKCE por POST para o token endpoint.

Num cliente confidential, autentique-se com o client secret (aqui apresentado com HTTP Basic):

curl -X POST https://<your-domain>/oauth/token \
  -u '<your-client-id>:<your-client-secret>' \
  -d grant_type=authorization_code \
  -d redirect_uri=https://app.example.com/callback \
  -d code=<one-time-code> \
  -d code_verifier=$CODE_VERIFIER

Num cliente public (sem segredo), envie o client_id como campo de formulário e assente em PKCE:

curl -X POST https://<your-domain>/oauth/token \
  -d grant_type=authorization_code \
  -d client_id=<your-client-id> \
  -d redirect_uri=https://app.example.com/callback \
  -d code=<one-time-code> \
  -d code_verifier=$CODE_VERIFIER

A resposta contém os tokens:

{
  "access_token": "<jwt>",
  "id_token": "<jwt>",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "<token>",
  "scope": "openid profile email offline_access"
}

Só existe um refresh_token se tiver pedido offline_access e a aplicação estiver autorizada a receber um.

4. Validar o ID token

O ID token é um JWT que comprova quem iniciou sessão. Valide-o antes de confiar nele:

  • Verifique a assinatura face às chaves de assinatura da plataforma em /.well-known/jwks.
  • Confirme que iss corresponde à sua instância, que aud corresponde ao seu client ID e que o token não expirou (exp).
  • Se enviou um nonce, confirme que coincide.

O claim sub é o identificador estável do utilizador; os scopes profile e email acrescentam claims como name e email.

5. Chamar o UserInfo (opcional)

Para obter claims para além dos do ID token, chame o endpoint UserInfo com o access token:

curl https://<your-domain>/userinfo \
  -H 'Authorization: Bearer <access_token>'

6. Terminar a sessão do utilizador (opcional)

Para encerrar a sessão, envie o utilizador para o endpoint de end session:

https://<your-domain>/logout
  ?id_token_hint=<id_token>
  &post_logout_redirect_uri=https://app.example.com/

Registe previamente o post_logout_redirect_uri na sua aplicação, da mesma forma que regista um redirect URI.

Resolução de problemas

  • redirect_uri não coincide. O redirect_uri dos passos 2 e 3 tem de ser idêntico entre si e a um valor registado na aplicação, comparado carácter a carácter (esquema, host, porta, caminho, barra final).
  • invalid_grant no token endpoint. O código é de utilização única e de curta duração; peça um novo. Este erro surge também quando o code_verifier não corresponde ao code_challenge enviado.
  • invalid_client. A autenticação do cliente está errada: um cliente confidential tem de enviar o seu segredo; um cliente public não o pode fazer e tem de estar registado como cliente public (PKCE).

Passos seguintes

Nesta página