thunderbird_accounts.authentication.mfa_management

Functions

`get_user_access_token`(request)	Return the end user's OIDC access token for the self-service MFA provider.
`make_mfa_reauthentication_response`(request)
`mfa_management_error_response`(request, exc)
`mfa_session_expired_response`()
`serialize_recovery_codes_credentials`(credentials)	Serialize stored recovery-codes credentials without returning plaintext codes.
`serialize_totp_credentials`(credentials)

Classes

`MfaManagementService`(request[, keycloak, ...])
`MfaMethodsResult`(totp_credentials, ...)

Exceptions

`MfaAccountNotConnectedError`
`MfaAuthenticatorAlreadyConfiguredError`
`MfaAuthenticatorNotFoundError`
`MfaInvalidTotpCodeError`
`MfaLoadMethodsUnavailableError`
`MfaManagementError`
`MfaReauthenticationRequired`
`MfaRecoveryCodesNotFoundError`
`MfaRecoveryCodesRejectedError`
`MfaRemoveAuthenticatorUnavailableError`
`MfaRemoveRecoveryCodesUnavailableError`
`MfaSaveAuthenticatorUnavailableError`
`MfaSaveRecoveryCodesUnavailableError`
`MfaSessionExpiredResponseRequired`
`MfaSetupExpiredError`
`MfaStartSetupUnavailableError`
`MfaTotpRequiredForRecoveryCodesError`

exception thunderbird_accounts.authentication.mfa_management.MfaManagementError[source]: Bases: Exception

exception thunderbird_accounts.authentication.mfa_management.MfaAccountNotConnectedError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaLoadMethodsUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaStartSetupUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaSaveAuthenticatorUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaRemoveAuthenticatorUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaSaveRecoveryCodesUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaRemoveRecoveryCodesUnavailableError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaSetupExpiredError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaInvalidTotpCodeError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaAuthenticatorAlreadyConfiguredError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaTotpRequiredForRecoveryCodesError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaRecoveryCodesRejectedError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaAuthenticatorNotFoundError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaRecoveryCodesNotFoundError[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaSessionExpiredResponseRequired[source]: Bases: MfaManagementError

exception thunderbird_accounts.authentication.mfa_management.MfaReauthenticationRequired[source]: Bases: MfaManagementError

class thunderbird_accounts.authentication.mfa_management.MfaMethodsResult(totp_credentials: list[dict], recovery_codes_credentials: list[dict])[source]

Bases: object

__init__(totp_credentials: list[dict], recovery_codes_credentials: list[dict]) → None

thunderbird_accounts.authentication.mfa_management.get_user_access_token(request: Request) → str | None[source]: Return the end user’s OIDC access token for the self-service MFA provider.

thunderbird_accounts.authentication.mfa_management.serialize_recovery_codes_credentials(credentials: list[dict]) → list[dict][source]: Serialize stored recovery-codes credentials without returning plaintext codes.