Integração autenticamente pythônica

Uma biblioteca Python para integração com o Login Único gov.br. Ela oferece um núcleo assíncrono OAuth 2.0/OpenID Connect, independente de framework, que concentra as partes sensíveis do fluxo: PKCE, nonce, state criptografado, troca de tokens, validação de assinatura e claims do ID Token, além da consulta ao UserInfo.

Adaptadores opcionais conectam esse mesmo núcleo ao FastAPI, Django e Flask, entregando uma API pequena, tipada e previsível.

Para desenvolvimento e testes, govbr-auth inclui o FakeGov, um simulador local que permite exercitar o fluxo completo de autenticação sem depender do provedor externo. Isso reduz dependências durante o desenvolvimento, acelera o setup e encurta o ciclo de depuração. O FakeGov é uma ferramenta de desenvolvimento e não substitui a integração ou a homologação oficial.

As transações OAuth do consumidor são stateless no backend: múltiplos workers podem processar o fluxo sem armazenamento compartilhado, desde que utilizem o mesmo segredo GOVBR_TRANSACTION_SECRET.

O envelope do state usa Fernet e TTL e carrega os vínculos de PKCE e nonce. O state não é um registro de uso único; a proteção contra replay depende também do authorization code descartável, do PKCE e da validação do nonce.

Important

1. Este é um projeto open source independente, sem manutenção, homologação ou endosso do Governo Federal.
2. O FakeGov é estritamente um simulador para testes end-to-end e desenvolvimento. Jamais o exponha em ambientes de produção.

Índice

Começar

• Instalação
• Como a comunicação funciona
• Teste a integração sem depender do gov.br

Referência

• Credenciais de teste
• Variáveis de ambiente

Aprofundar

• Customizar usuários
• Provedor oficial
• Desenvolvimento

Instalação

Instale somente o core ou o extra correspondente à aplicação:

Comando	Para quê
pip install govbr-auth	Somente o core
pip install "govbr-auth[fastapi]"	Adapter FastAPI
pip install "govbr-auth[django]"	Adapter Django
pip install "govbr-auth[flask]"	Adapter Flask
pip install "govbr-auth[fastapi,fake]"	FastAPI + FakeGov + uvicorn

Como a comunicação funciona

O marcador verde percorre as requisições e respostas em ordem, em um ciclo de 24 segundos. Se a preferência por movimento reduzido estiver ativada no sistema ou navegador, o diagrama permanece estático.

A aplicação expõe /auth/govbr/login. O navegador é redirecionado para o provedor selecionado e retorna pelo callback configurado. Depois do login, o backend troca o código, busca as chaves, valida o ID Token e consulta userinfo antes de chamar on_success.

Toda comunicação com o provedor oficial deve usar HTTPS. Em dispositivos móveis, abra o fluxo no navegador nativo; não incorpore a autenticação em WebView. A página que recebe o code deve redirecionar depois do callback, e a aplicação deve criar sua própria sessão. Mantenha tokens no backend: use o access token para APIs autorizadas e nunca envie o ID token a uma API. O logout é iniciado pelo frontend pela rota configurada da aplicação.

Com GOVBR_PROVIDER=official, as chamadas vão para o gov.br. Com GOVBR_PROVIDER=fake, o FakeGov troca apenas os endpoints do provedor e o transporte HTTP interno; o mesmo runtime consumidor e a fachada GovBrAuth permanecem os mesmos. O diagrama completo está no guia de fluxo de comunicação. Internamente, o adapter usa FakeGovHttpTransport para manter essa troca sem abrir uma conexão de rede.

Para composições avançadas, o simulador canônico é govbr_auth.fake.FakeGovSimulator, criado por govbr_auth.fake.create_fake_gov_simulator. Para iniciar uma demonstração visual local, o launcher exibe o botão Entrar com GOV.BR na raiz /; o caminho /govbr-auth-demo permanece disponível como alias.

Teste a integração sem depender do gov.br

FakeGov é um provedor OAuth/OIDC local incluído na biblioteca. Ele permite desenvolver, demonstrar e testar o fluxo completo sem credenciais oficiais, sem acesso à internet e sem alterar o código consumidor. O caminho principal começa pela sua aplicação; as ferramentas isoladas do provedor permanecem disponíveis no guia completo.

Instalar → Configurar → Entrar → Concluir. O exemplo abaixo é copiável, executável em um diretório vazio e exercita o mesmo core usado com o provedor oficial.

1. Crie a aplicação e, opcionalmente, um usuário fictício

pip install "govbr-auth[fastapi,fake]"

Salve este conteúdo como fake-users.local.json:

{
  "users": [
    {
      "cpf": "11122233344",
      "password": "senha-ficticia",
      "name": "Usuário Fake",
      "email": "fake@example.test"
    }
  ]
}

Salve o bloco completo abaixo como myapp.py:

from pathlib import Path

import uvicorn
from dotenv import load_dotenv
from fastapi import FastAPI
from fastapi.responses import JSONResponse

from govbr_auth.fastapi import AuthContext, GovBrAuth
from govbr_auth.runtime import GovBrRuntimeSettings


async def authenticated(context: AuthContext) -> JSONResponse:
    # context.user contém o perfil OIDC validado para a sessão da aplicação.
    return JSONResponse({"authenticated": True})


def create_app(settings: GovBrRuntimeSettings) -> FastAPI:
    app = FastAPI()
    auth = GovBrAuth(settings=settings, on_success=authenticated)
    app.include_router(auth.router)
    return app


load_dotenv(dotenv_path=Path.cwd() / ".env", override=False)
settings = GovBrRuntimeSettings.from_environment()
app = create_app(settings)


if __name__ == "__main__":
    uvicorn.run(app, host="127.0.0.1", port=8000, log_level="info")

2. Escolha como configurar

Para carregar por variáveis de ambiente, crie .env. O myapp.py carrega somente Path.cwd() / ".env", sem procurar arquivos em diretórios ancestrais, e preserva variáveis que já existem no processo com override=False. Em seguida, GovBrRuntimeSettings.from_environment() aplica a configuração:

GOVBR_PROVIDER=fake
GOVBR_FAKE_USERS_FILE=./fake-users.local.json

Um valor vazio seguido de comentário, como GOVBR_CLIENT_ID= # preencher, continua vazio e é rejeitado na validação. Preencha o valor ou remova a variável quando quiser usar um default permitido pelo FakeGov; o comentário não é um valor.

Quando a aplicação ou os testes já possuem um sistema próprio de configuração, substitua as duas linhas que criam settings e app no final de myapp.py pela composição explícita abaixo. O restante da aplicação permanece igual:

from pathlib import Path

from govbr_auth.runtime import (
    GovBrProvider,
    GovBrRuntimeSettings,
)

settings = GovBrRuntimeSettings(
    provider=GovBrProvider.FAKE,
    fake_users_file=Path("fake-users.local.json"),
)
app = create_app(settings)

Para configurar o provedor oficial diretamente, componha os endpoints validados com GovBrSettings. Segredos continuam vindo do ambiente ou de um cofre, nunca do código versionado:

from os import environ

from pydantic import SecretStr
from govbr_auth.core import GovBrSettings, ProviderEnvironment
from govbr_auth.runtime import (
    GovBrProvider,
    GovBrRuntimeSettings,
)

settings = GovBrRuntimeSettings(
    provider=GovBrProvider.OFFICIAL,
    oauth=GovBrSettings(
            environment=ProviderEnvironment.STAGING,
            authorization_url="https://sso.staging.acesso.gov.br/authorize",
            token_url="https://sso.staging.acesso.gov.br/token",
            userinfo_url="https://sso.staging.acesso.gov.br/userinfo/",
            client_id=environ["GOVBR_CLIENT_ID"],
            client_secret=SecretStr(environ["GOVBR_CLIENT_SECRET"]),
            redirect_uri=environ["GOVBR_REDIRECT_URI"],
            transaction_secret=SecretStr(environ["GOVBR_TRANSACTION_SECRET"]),
            issuer="https://sso.staging.acesso.gov.br/",
            jwks_url="https://sso.staging.acesso.gov.br/jwk",
        ),
)
app = create_app(settings)

3. Execute e use o resultado

python myapp.py

Abra http://localhost:8000/auth/govbr/login. Entre com as credenciais de teste e conclua o callback.

O adapter registra as rotas de autenticação. Quando o provedor é FakeGov, ele também registra a página inicial de demonstração na raiz /; com o provedor oficial, essa página não é criada. O callback continua sob controle da aplicação e, neste exemplo, responde JSON. Para a experiência visual completa, use o launcher (python -m govbr_auth.fake): o botão abre a autenticação em uma nova guia ou janela nativa e a página original muda para o estado de sucesso quando o callback é validado.

O callback authenticated recebe um AuthContext já validado:

Valor	Uso esperado
context.user	Perfil OIDC tipado; use subject para localizar ou criar a conta local
context.claims	Claims imutáveis e validadas do ID Token para decisões no backend
context.tokens	None por padrão; só aparece com expose_tokens=True e nunca deve ser enviado ao navegador

Nesse ponto, a aplicação pode criar sua sessão, emitir seu próprio cookie, atualizar o perfil local ou redirecionar para uma área autenticada. O exemplo responde somente {"authenticated": true} e mantém as claims validadas no backend; CPF, senha, tokens e segredos não são exibidos. O arquivo de usuários aceita apenas dados fictícios: não use credenciais reais.

Para trocar o FakeGov pelo provedor oficial, mantenha myapp.py e altere apenas GOVBR_PROVIDER e os endpoints oficiais descritos em Provedor oficial. O FakeGov nunca funciona como fallback automático.

Outros frameworks

No Django, inclua auth.urlpatterns no urlpatterns do projeto. No Flask, registre os dois blueprints condicionais com auth.register(app). Em ambos os casos, o código do consumidor permanece o mesmo; só a configuração do provedor é alterada.

Os exemplos completos de FastAPI, Django e Flask no guia de início rápido criam os arquivos da aplicação no diretório do usuário e funcionam após a instalação do extra correspondente; não dependem de um checkout deste repositório.

Credenciais de teste

Campo	Valor
CPF	11122233344
Senha	senha-ficticia

Essas credenciais funcionam no perfil padrão, sem GOVBR_FAKE_USERS_FILE. Quando essa variável é definida, o arquivo substitui os usuários padrão.

Warning

Credenciais fictícias, válidas apenas no FakeGov local. Para trocá-las, veja Customizar usuários.

Variáveis de ambiente

Variável	Valores	Efeito
GOVBR_PROVIDER	official (default), fake	Escolhe os endpoints do provedor e o transporte HTTP interno
GOVBR_ENVIRONMENT	production, staging, local	Identifica o ambiente do provedor; endpoints oficiais incompatíveis impedem a inicialização
GOVBR_FAKE_USERS_FILE	Caminho para um JSON fora do Git	Substitui os usuários defaults do FakeGov
GOVBR_CLIENT_ID	Identificador do cliente	Compartilhado entre o provedor oficial e o FakeGov
GOVBR_CLIENT_SECRET	Segredo do cliente	Compartilhado entre o provedor oficial e o FakeGov
GOVBR_REDIRECT_URI	Callback da aplicação	Compartilhado entre o provedor oficial e o FakeGov
GOVBR_SCOPE	Escopo OAuth	Compartilhado entre o provedor oficial e o FakeGov
GOVBR_LOGOUT_URL	Endpoint de logout do provedor	Deve ser configurado junto com GOVBR_POST_LOGOUT_REDIRECT_URI
GOVBR_POST_LOGOUT_REDIRECT_URI	Retorno após logout	URI previamente autorizada no provedor
GOVBR_TRANSACTION_SECRET	Segredo gerado uma única vez	Compartilhado entre o provedor oficial e o FakeGov; o mesmo valor em todas as instâncias

Customizar usuários

Defina GOVBR_FAKE_USERS_FILE com um JSON fora do Git, no formato:

{"users": [{"cpf": "11122233344", "password": "senha-ficticia", "name": "Usuário Fake", "email": "fake@example.test"}]}

No POSIX:

cat > fake-users.local.json <<'JSON'
{"users": [{"cpf": "11122233344", "password": "senha-ficticia", "name": "Usuário Fake", "email": "fake@example.test"}]}
JSON
export GOVBR_FAKE_USERS_FILE="$PWD/fake-users.local.json"

No PowerShell:

@'
{"users": [{"cpf": "11122233344", "password": "senha-ficticia", "name": "Usuário Fake", "email": "fake@example.test"}]}
'@ | Set-Content -Encoding UTF8 .\fake-users.local.json
$env:GOVBR_FAKE_USERS_FILE = "$PWD\fake-users.local.json"

O arquivo substitui os usuários defaults, é validado na inicialização e fica em memória; não use credenciais reais. Para fontes próprias, implemente o protocolo de repositório descrito no guia de FakeGov.

Provedor oficial

Configuração

Instale a biblioteca sem extras e configure GOVBR_PROVIDER=official (o default), endpoints, credenciais, redirect e GOVBR_TRANSACTION_SECRET. Para habilitar o logout, configure também GOVBR_LOGOUT_URL e GOVBR_POST_LOGOUT_REDIRECT_URI; o segundo valor deve estar previamente autorizado no Gov.br. Gere uma vez o segredo:

from govbr_auth import generate_transaction_secret

print(generate_transaction_secret())

Mantenha o valor secreto e use o mesmo valor em todas as instâncias. Não gere uma chave nova a cada inicialização.

Estado e replay

O backend cifra e autentica com Fernet um envelope de state com TTL, PKCE e nonce. O state não é um registro de uso único: a prevenção de replay depende do authorization code de uso único validado pelo provedor.

Os adapters também exigem uma prova de navegador independente do state, em cookie autenticado e HttpOnly, antes de trocar o código. Inicie o fluxo pela rota de login no mesmo navegador e host que receberão o callback; copiar apenas a URL de callback para outro navegador não autentica. O cookie expira em cinco minutos e é removido ao concluir o callback, inclusive em respostas de erro. Até oito tentativas simultâneas são preservadas por cliente/callback.

Em HTTPS, o cookie é host-only, usa __Host-, Secure, Path=/ e SameSite=None para permitir os callbacks POST de Django/Flask. Em HTTP de loopback, usa nome distinto e SameSite=Lax. A política é definida pela URI de callback configurada, não por cabeçalhos de proxy. O cookie não contém tokens, PKCE, nonce nem dados pessoais e não substitui a sessão da aplicação.

Integrações que usam apenas o core devem implementar seu próprio vínculo entre navegador e transação. Callbacks iniciados antes desta atualização precisam reiniciar o login para obter o novo cookie.

Múltiplos workers

Esse desenho permite múltiplos workers sem armazenamento compartilhado; todos precisam receber a mesma secret GOVBR_TRANSACTION_SECRET. Em produção, por exemplo:

uvicorn myapp:app --workers 4

Em Django/Flask sob WSGI, a ponte síncrona mantém um event loop dedicado por processo, permitindo reutilizar conexões HTTP entre autenticações. Encerre o adapter com auth.close() no desligamento do worker. Não compartilhe um runtime HTTP já utilizado entre processos ou com um event loop ASGI independente.

Consulte a documentação para configuração completa, solução de problemas e uso avançado.

Desenvolvimento

Os extras FastAPI e FakeGov exigem FastAPI >=0.142.2. Esse piso evita acúmulo de instrumentação de endpoints durante logins consecutivos, inclusive quando integrações legadas encapsulam os handlers do framework.

python -m pip install -r requirements-dev.txt
python -m pytest --tb=short --disable-warnings -q

requirements-min.txt registra os pisos públicos de pyproject.toml, não as versões mais recentes. O CI verifica essa igualdade e executa a suíte com os pisos em Python 3.11, além da matriz com as versões resolvidas pelos intervalos declarados. Atualize os dois arquivos juntos quando elevar um piso por correção, segurança ou requisito de compatibilidade e registre o impacto no changelog.

Nas atualizações de versão, o Dependabot não altera automaticamente esse arquivo de mínimos; continua analisando os manifestos públicos e de desenvolvimento. A estratégia increase-if-necessary preserva intervalos que já aceitam a versão nova. Essa exclusão não se aplica às atualizações de segurança. Se um PR de segurança alterar um piso ou a fixture de mínimos, sincronize ambos e o contrato da superfície pública antes de passar pelo CI.

Licença

MIT. Consulte LICENSE.