Struct EmailOtpPlugin 

pub struct EmailOtpPlugin { /* private fields */ }

Implementations

impl EmailOtpPlugin

pub fn change_email_email_otp_endpoint( input: &EmailOtpChangeInput, ) -> AuthResult<ServerEndpoint<EmailOtpChanged>>

Consume a new-mailbox challenge using the caller’s authoritative session.

Errors

Returns an error if the supplied input cannot be serialized.

pub fn request_email_change_email_otp_endpoint( input: &EmailOtpChangeRequestInput, ) -> AuthResult<ServerEndpoint<EmailOtpChangeRequested>>

Request a new-mailbox challenge using an authoritative caller session.

Errors

Returns an error if the supplied input cannot be serialized.

pub fn reset_password_email_otp_endpoint( input: &EmailOtpPasswordResetInput, ) -> AuthResult<ServerEndpoint<EmailOtpPasswordReset>>

Consume a reset proof and replace or create the owner’s credential.

Errors

Returns an error if reset input cannot be serialized.

pub fn request_password_reset_email_otp_endpoint( email: impl Into<String>, ) -> ServerEndpoint<EmailOtpResetRequested>

Request a scoped reset proof without exposing whether the mailbox exists.

pub fn forget_password_email_otp_endpoint( email: impl Into<String>, ) -> ServerEndpoint<EmailOtpResetRequested>

Call the published deprecated reset-request alias.

pub fn sign_in_email_otp_endpoint( input: &EmailOtpSignInInput, ) -> AuthResult<ServerEndpoint<EmailOtpSignInResult>>

Consume a sign-in proof and apply returning-user or signup policy.

Errors

Returns an error if the supplied sign-in input cannot be serialized.

pub fn verify_email_otp_endpoint( email: impl Into<String>, otp: impl Into<String>, ) -> ServerEndpoint<EmailOtpVerification>

Consume a mailbox proof and apply verification/session policy.

pub fn check_verification_otp_endpoint( email: impl Into<String>, otp_type: EmailOtpType, otp: impl Into<String>, ) -> ServerEndpoint<EmailOtpCheck>

Check a scoped proof without consuming a successful validation.

pub fn send_verification_otp_endpoint( email: impl Into<String>, otp_type: EmailOtpType, ) -> ServerEndpoint<EmailOtpSent>

Send a scoped OTP through the installed delivery and storage policies.

pub fn create_verification_otp_endpoint( email: impl Into<String>, otp_type: EmailOtpType, ) -> ServerEndpoint<String>

Create a code through the installed endpoint hooks and post-hook validation.

pub fn get_verification_otp_endpoint( email: impl Into<String>, otp_type: EmailOtpType, ) -> ServerEndpoint<EmailOtpRead>

Retrieve a code through the installed endpoint hooks.

impl EmailOtpPlugin

pub const fn new(config: EmailOtpConfig) -> Self

pub async fn create_verification_otp( &self, ctx: &AuthContext<impl AuthSchema>, email: &str, otp_type: EmailOtpType, ) -> AuthResult<String>

Create and persist a code without delivering it or checking whether the mailbox has an account. This operation is available only to server code.

Errors

Returns an error if OTP generation, encoding, or persistence fails.

pub async fn get_verification_otp( &self, ctx: &AuthContext<impl AuthSchema>, email: &str, otp_type: EmailOtpType, ) -> AuthResult<Option<String>>

Retrieve a live plaintext/decryptable code without consuming it. Hashed storage rejects this operation, since a hash cannot reveal a code.

Errors

Returns an error if storage fails or the configured OTP representation cannot be recovered.

Trait Implementations

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

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 after_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, response: AuthResponse, ) -> Pin<Box<dyn Future<Output = AuthResult<AuthResponse>> + Send + 'async_trait>>

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

Transform a completed response, including redirects and rejections.

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 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 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 EmailOtpPlugin

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 EmailOtpPlugin

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

Formats the value using the given formatter.

impl<S: AuthSchema> VerificationEmailOverride<S> for EmailOtpPlugin

fn send<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, user: &'life1 UserView, request: Option<&'life2 AuthRequest>, ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

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

fn send_in_transaction<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, user: &'life1 UserView, request: Option<&'life2 AuthRequest>, ctx: &'life3 AuthContext<S>, tx: &'life4 dyn AuthTransaction<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

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