config ¶

Pydantic configuration models for authentication.

Classes:

AuthConfig –

Top-level authentication configuration.
HeaderProviderConfig –

Settings specific to the header-based authentication provider.
NoneProviderConfig –

Settings for the provider: none (disabled auth) mode.
SignatureVerificationConfig –

JWT signature verification sub-config (under provider: header).

Functions:

parse_auth_config –

Parse an AuthConfig from a raw dict (e.g., loaded from YAML).
parse_header_provider_config –

Parse a HeaderProviderConfig from a raw dict, raising on missing fields.
parse_none_provider_config –

Parse a NoneProviderConfig from a raw dict, raising on missing fields.

AuthConfig ¶


              flowchart TD
              oqtopus_auth.config.AuthConfig[AuthConfig]

              

              click oqtopus_auth.config.AuthConfig href "" "oqtopus_auth.config.AuthConfig"

Top-level authentication configuration.

HeaderProviderConfig ¶


              flowchart TD
              oqtopus_auth.config.HeaderProviderConfig[HeaderProviderConfig]

              

              click oqtopus_auth.config.HeaderProviderConfig href "" "oqtopus_auth.config.HeaderProviderConfig"

Settings specific to the header-based authentication provider.

NoneProviderConfig ¶


              flowchart TD
              oqtopus_auth.config.NoneProviderConfig[NoneProviderConfig]

              

              click oqtopus_auth.config.NoneProviderConfig href "" "oqtopus_auth.config.NoneProviderConfig"

Settings for the provider: none (disabled auth) mode.

SignatureVerificationConfig ¶


              flowchart TD
              oqtopus_auth.config.SignatureVerificationConfig[SignatureVerificationConfig]

              

              click oqtopus_auth.config.SignatureVerificationConfig href "" "oqtopus_auth.config.SignatureVerificationConfig"

JWT signature verification sub-config (under provider: header).

parse_auth_config ¶

parse_auth_config(raw: dict) -> AuthConfig

Parse an AuthConfig from a raw dict (e.g., loaded from YAML).

Delegates to parse_none_provider_config and parse_header_provider_config which raise ValueError when required fields are missing.

Returns:

AuthConfig –

A validated AuthConfig instance.

parse_header_provider_config ¶

parse_header_provider_config(
    raw: dict,
) -> HeaderProviderConfig

Parse a HeaderProviderConfig from a raw dict, raising on missing fields.

Returns:

HeaderProviderConfig –

A validated HeaderProviderConfig instance.

Raises:

ValueError –

If jwt_header or user_claim is missing.

parse_none_provider_config ¶

parse_none_provider_config(raw: dict) -> NoneProviderConfig

Parse a NoneProviderConfig from a raw dict, raising on missing fields.

Returns:

NoneProviderConfig –

A validated NoneProviderConfig instance.

Raises:

ValueError –

If default_account or default_roles is missing.