Struct EmailPasswordPlugin 

pub struct EmailPasswordPlugin { /* private fields */ }

Email and password authentication plugin

Implementations

impl EmailPasswordPlugin

pub fn callbacks<S: AuthSchema>( self, callbacks: EmailPasswordCallbacks<S>, ) -> impl AuthPlugin<S>

Attach typed notification callbacks after configuring the password options.

impl EmailPasswordPlugin

pub fn new() -> Self

pub fn with_config(config: EmailPasswordConfig) -> Self

pub fn with_email_verification( self, plugin: Arc<EmailVerificationPlugin>, ) -> Self

Attach an EmailVerificationPlugin so that send_on_sign_in is automatically called when a user signs in with an unverified email.

pub fn enable_signup(self, enable: bool) -> Self

pub fn username(self, enabled: bool) -> Self

Enable username registration, sign-in, availability checks, and updates.

The user entity must persist username and display_username.

pub fn require_email_verification(self, require: bool) -> Self

pub fn password_min_length(self, length: usize) -> Self

pub fn password_max_length(self, length: usize) -> Self

pub fn auto_sign_in(self, auto: bool) -> Self

pub fn password_hasher(self, hasher: Arc<dyn PasswordHasher>) -> Self

pub fn on_existing_user_sign_up( self, callback: Arc<dyn OnExistingUserSignUp>, ) -> Self

Set the notification for a duplicate signup protected against enumeration.

pub fn custom_synthetic_user(self, callback: Arc<CustomSyntheticUser>) -> Self

Customize synthetic users returned by enumeration-safe signup.

Trait Implementations

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

fn telemetry(&self, options: &mut PluginTelemetry)

Report configured options without invoking callbacks or initializing the plugin.

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

Plugin name - should be unique

fn telemetry_plugin_id(&self) -> Option<&'static str>

Return the upstream plugin ID; core option wrappers have no plugin ID.

fn openapi(&self) -> AuthResult<OpenApiPluginMetadata>

Document this configured plugin without invoking application field policies.

fn password_hasher(&self) -> Option<Arc<dyn PasswordHasher>>

Select the base password hasher before plugin initialization wraps it.

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 routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

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

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

Called for a registered endpoint after HTTP body decoding and origin checks.

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 rate_limits(&self) -> Result<Vec<PluginRateLimit>, AuthError>

Default endpoint limits, overridden by explicit application limits.

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 an HTTP request after rate limiting and before endpoint middleware. Native API calls do not run this hook. A response skips endpoint hooks.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> 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,

Inspect the HTTP router response, including route misses and body errors. Early HTTP request responses and native endpoint calls skip this hook. A replacement response stops the remaining HTTP response hooks.

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

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

Inspect or extend the final route response after session cookies are applied.