🔌 Controller - Conectores para Frameworks

GovBrConnector

class govbr_auth.controller.GovBrConnector(config: GovBrConfig, prefix='/auth/govbr', authorize_endpoint='authorize', authenticate_endpoint='authenticate', on_auth_success: Callable[[dict, object], object] | None = None, fake_users: dict | None = None, fake_jwt_secret: str = 'fake-govbr-dev-secret')[source]

Bases: object

Classe responsável por conectar o Gov.br com os frameworks FastAPI, Flask e Django. Ela fornece métodos para inicializar as rotas de autenticação e autorização do Gov.br em cada um desses frameworks.

__init__(config: GovBrConfig, prefix='/auth/govbr', authorize_endpoint='authorize', authenticate_endpoint='authenticate', on_auth_success: Callable[[dict, object], object] | None = None, fake_users: dict | None = None, fake_jwt_secret: str = 'fake-govbr-dev-secret')[source]

Inicializa a classe GovBrConnector com as configurações necessárias.

Parameters:
  • config – Instância de GovBrConfig contendo as configurações necessárias para a autenticação.

  • prefix – Prefixo para as rotas de autenticação (padrão: “/auth/govbr”).

  • authorize_endpoint – Endpoint para autorização (padrão: “authorize”).

  • authenticate_endpoint – Endpoint para autenticação (padrão: “authenticate”).

  • on_auth_success – Função de callback a ser chamada após a autenticação bem-sucedida.

  • fake_users – Dicionário de usuários fake (opcional, apenas para modo fake).

  • fake_jwt_secret – Chave secreta para JWT fake (opcional, apenas para modo fake).

init_fastapi(app)[source]
init_flask(app)[source]
init_django()[source]

Métodos de Inicialização

FastAPI

GovBrConnector.init_fastapi(app)[source]

Flask

GovBrConnector.init_flask(app)[source]

Django

GovBrConnector.init_django()[source]