Skip to content

common_auth.authenticators.authenticator

The request-authentication front door: typed construction and delegation.

Classes

Authenticator

Construct one scheme and delegate its shared request-authentication surface.

Holds the chosen engine; injected sources, token providers and signing profiles stay borrowed. Construction opens no connections. Pass this object directly as common-http’s auth= collaborator.

__init__

def __init__(config: AuthenticatorConfig | Mapping[str, object], *, source: CredentialSource | None = None, token: AccessToken | str | SecretStr | TokenSource | None = None, profile: Callable[[Request, Signer, ApiKeyCredential | None], Request] | Callable[[Request, Signer, float], Request] | None = None) -> None

Fields and properties declared here; inherited members belong to the bases above.

config

Read-only property.

config: AuthenticatorConfig

api_key

@classmethod
def api_key(value: str | SecretStr, *, allowed_origins: Sequence[str], name: str, location: str = 'header') -> Self

Construct direct API-key authentication without a source or store.

apply

async def apply(request: Request, *, prepare: Callable[[Request], Request]) -> AuthResult[Request]

available_methods

@staticmethod
def available_methods() -> tuple[str, ...]

basic

@classmethod
def basic(username: str, password: str | SecretStr, *, allowed_origins: Sequence[str], encoding: str = 'utf-8') -> Self

Construct direct HTTP Basic authentication from supplied settings.

bearer

@classmethod
def bearer(token: AccessToken | str | SecretStr | TokenSource, *, allowed_origins: Sequence[str], max_challenge_replays: int = 0) -> Self

Use a static opaque token, typed AccessToken, or async token provider.

flow

def flow(request: Request, *, prepare: Callable[[Request], Request]) -> AsyncGenerator[Request, HttpResponseHead]

requires_body

def requires_body(response: HttpResponseHead) -> bool