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 issuer(self, val: String) -> Self

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

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

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

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

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

impl TwoFactorPlugin

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

Install a custom OTP sender.

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

Read the currently stored backup codes for a user.

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

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 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 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 before route matching for every incoming request.

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) -> TwoFactorPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TwoFactorPlugin

fn default() -> Self

Returns the “default value” for a type.