Struct TwoFactorPlugin 

pub struct TwoFactorPlugin { /* private fields */ }

Two-factor authentication plugin providing TOTP, OTP, and backup code flows.

Implementations

impl TwoFactorPlugin

pub fn new() -> Self

pub fn with_config(config: TwoFactorConfig) -> Self

pub fn allow_passwordless(self, val: bool) -> Self

pub fn totp_allow_passwordless(self, val: bool) -> Self

pub fn backup_allow_passwordless(self, val: bool) -> Self

pub fn backup_code_amount(self, val: f64) -> Self

pub fn backup_code_length(self, val: f64) -> Self

pub fn account_lockout(self, val: AccountLockoutConfig) -> Self

pub fn issuer(self, val: String) -> Self

pub fn skip_verification_on_enable(self, val: bool) -> Self

pub fn two_factor_cookie_max_age(self, val: f64) -> Self

pub fn trust_device_max_age(self, val: f64) -> Self

pub fn totp_period(self, val: f64) -> Self

pub fn totp_digits(self, val: f64) -> Self

pub fn totp_issuer(self, val: String) -> Self

pub fn totp_disabled(self, val: bool) -> Self

pub fn otp_digits(self, val: f64) -> Self

pub fn otp_period_minutes(self, val: f64) -> Self

pub fn otp_allowed_attempts(self, val: f64) -> Self

impl TwoFactorPlugin

pub fn generate_backup_codes_endpoint( input: GenerateBackupCodesInput, ) -> ServerEndpoint<BackupCodesOutput>

Replace the authenticated owner’s recovery-code set.

pub fn verify_backup_code_endpoint( input: VerifyBackupCodeInput, ) -> ServerEndpoint<BackupCodeVerified>

Consume a recovery code for the current owner or pending sign-in challenge.

pub fn verify_two_factor_otp_endpoint( input: VerifyOtpInput, ) -> ServerEndpoint<TotpVerified>

Verify a delivered code for the current session or pending sign-in challenge.

pub fn send_two_factor_otp_endpoint() -> ServerEndpoint<TwoFactorOtpSent>

Persist and deliver a code for the session owner or pending sign-in challenge.

pub fn verify_totp_endpoint( input: VerifyTotpInput, ) -> ServerEndpoint<TotpVerified>

Verify an authenticator code for enrollment or a pending sign-in challenge.

pub fn get_totp_uri_endpoint( input: GetTotpUriInput, ) -> ServerEndpoint<TotpUriOutput>

Recover the signed-in owner’s authenticator URI using configured password policy.

pub fn disable_two_factor_endpoint( input: DisableTwoFactorInput, ) -> ServerEndpoint<TwoFactorDisabled>

Disable the persistent session owner’s factor and rotate that session.

pub fn enable_two_factor_endpoint( input: EnableTwoFactorInput, ) -> ServerEndpoint<TwoFactorEnabled>

Enroll the signed-in owner using the configured factor and backup-code policies.

pub fn view_backup_codes_endpoint( user_id: impl Into<String>, ) -> ServerEndpoint<BackupCodesOutput>

Read trusted server-only backup codes through installed endpoint hooks.

pub fn generate_totp_endpoint( secret: impl Into<String>, ) -> ServerEndpoint<TotpOutput>

Generate a TOTP through installed endpoint hooks and current configured policy.

impl TwoFactorPlugin

pub fn custom_send_otp(self, sender: Arc<dyn SendTwoFactorOtp>) -> Self

Install a custom OTP sender.

pub fn generate_totp(&self, secret: &str) -> AuthResult<String>

Generate a current TOTP from an application-owned UTF-8 secret.

This corresponds to auth.api.generateTOTP; it has no public HTTP route.

Errors

Returns an error if the secret cannot be decoded or the TOTP configuration is invalid.

pub async fn view_backup_codes<S: AuthSchema>( &self, user_id: &str, ctx: &AuthContext<S>, ) -> AuthResult<Value>

Read the currently stored backup JSON for a user.

Installed storage may contain any truthy JSON value. Dates are revived with the pinned grammar and numbers use JavaScript JSON serialization; generated code arrays retain their ordinary array-of-strings shape.

This is the Rust server-side equivalent of the TypeScript auth.api.viewBackupCodes capability. It is intentionally not exposed as a public HTTP route.

Errors

Returns an error if backup codes are unavailable, cannot be decrypted, or cannot be loaded.

Trait Implementations

impl<S: AuthSchema> AuthPlugin<S> for TwoFactorPlugin

fn name(&self) -> &'static str

Plugin name - should be unique

fn routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<AuthResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each request - return Some(response) to handle, None to pass through

fn static_openapi_metadata(&self) -> PluginOpenApiMetadata

Base declarations for documentation without an initialized auth instance.

fn openapi_metadata(&self, ctx: &AuthInitContext<S>) -> PluginOpenApiMetadata

Documentation annotations collected after all plugins initialize. Override this hook for custom endpoints and model field policies.

fn rate_limits(&self) -> Vec<PluginRateLimit>

Ordered rate-limit policies supplied by this installed plugin.

fn server_endpoints(&self) -> Vec<EndpointDefinition>

Trusted operations available through host dispatch, independently of HTTP visibility.

fn validate_endpoint( &self, call: &EndpointCall, _ctx: &AuthContext<S>, ) -> AuthResult<EndpointInput>

Validate actual input after all before-hook patches have been applied.

fn on_endpoint<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, call: &'life1 EndpointCall, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<EndpointResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a registered operation with validated handler-phase context.

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthInitContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized

fn endpoint_hooks(&self) -> Vec<&dyn EndpointHook<S>>

Installed logical-call hooks, in this plugin’s registration order.

fn allowed_media_types(&self, _route: &AuthRoute) -> Vec<&'static str>

Media types accepted before request hooks and endpoint dispatch. An empty list disables the media restriction for an application-owned endpoint.

fn origin_check_skip_paths(&self) -> Vec<&'static str>

Protocol callback prefixes whose verified state replaces browser origin admission.

fn session_fields(&self) -> IndexMap<String, FieldConfig>

Session field policies contributed by this registered plugin.

fn user_fields(&self) -> IndexMap<String, FieldConfig>

fn account_fields(&self) -> IndexMap<String, FieldConfig>

fn on_http_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect the original physical HTTP request before routing, body parsing, origin validation and endpoint hooks. Disabled paths and transport/rate limiting middleware run first. Returning a response stops dispatch and later plugin hooks. Server-only endpoint calls do not invoke this hook.

fn on_http_request_action<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<HttpRequestAction>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect or replace the physical request. The default preserves existing on_http_request implementations. Request-local configuration has already been resolved from the incoming request, matching the Source HTTP handler.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, _response: &'life3 AuthResponse, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Observe the routed HTTP response before transport middleware (including CORS). Hooks run in registration order; the first replacement stops this chain. Early HTTP request-hook responses skip this stage. Errors escape dispatch; they cannot reverse writes already committed by an endpoint.

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<BeforeRequestAction>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called after route matching and before endpoint dispatch.

fn on_http_endpoint<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<HttpEndpointResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Dispatch the resolved HTTP endpoint. Existing plugins return logical values through on_request; plugins returning a native raw response can override this method to bypass the endpoint after-hook pipeline.

fn after_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, response: AuthResponse, ) -> Pin<Box<dyn Future<Output = Result<AuthResponse, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Transform a completed response, including redirects and rejections.

fn on_user_created<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _user: &'life1 <S as AuthSchema>::User, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called after a user is created

fn on_session_created<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session: &'life1 <S as AuthSchema>::Session, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called after a session is created

fn on_user_deleted<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _user_id: &'life1 str, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called before a user is deleted

fn on_session_deleted<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session_token: &'life1 str, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Called before a session is deleted

impl Clone for TwoFactorPlugin

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TwoFactorPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TwoFactorPlugin

fn default() -> Self

Returns the “default value” for a type.