Struct Engine 

pub struct Engine<S = Missing, T = Missing> {
    pub providers: HashMap<String, Arc<dyn ErasedOAuthFlow>>,
    pub auth_methods: HashMap<String, Arc<dyn AuthMethod>>,
    pub mfa_methods: HashMap<String, Arc<dyn AuthMethod>>,
    pub mfa_jwt_secret: [u8; 32],
    pub session_store: S,
    pub session_config: SessionConfig,
    pub token_manager: T,
}

The central orchestrator for Engine.

Engine ties together authentication methods, session management, and flows. It is constructed using the EngineBuilder which uses the Typestate pattern to ensure that certain methods are only available when the necessary components are configured.

Fields

providers: HashMap<String, Arc<dyn ErasedOAuthFlow>>

Map of registered OAuth providers.

auth_methods: HashMap<String, Arc<dyn AuthMethod>>

Map of registered local authentication methods.

mfa_methods: HashMap<String, Arc<dyn AuthMethod>>

Map of methods explicitly registered for step-up (MFA) use.

mfa_jwt_secret: [u8; 32]

Internal secret for signing temporary MFA JWT tokens.

session_store: S

The session storage backend.

session_config: SessionConfig

Configuration for session cookies.

token_manager: T

Manager for JWT signing and verification.

Implementations

impl Engine<Missing, Missing>

pub fn builder() -> EngineBuilder<Missing, Missing>

Start building a new Engine.

impl<S, T> Engine<S, T>

pub async fn authenticate( &self, input: AuthInput, ) -> Result<AuthResult, AuthError>

Attempt to authenticate a user. Returns AuthResult::Success if authentication is fully complete, or AuthResult::MfaRequired if a second factor is needed.

impl<T> Engine<Configured<Arc<dyn SessionStore>>, T>

pub fn session_store(&self) -> Arc<dyn SessionStore>

Get the session store.

pub async fn create_session( &self, identity: Identity, ) -> Result<Session, AuthError>

Create a new session for the given identity.

impl<S> Engine<S, Configured<Arc<TokenManager>>>

pub fn token_manager(&self) -> Arc<TokenManager>

Get the token manager.

pub fn issue_token( &self, identity: Identity, expires_in_secs: u64, ) -> Result<String, AuthError>

Issue a JWT for the given identity.

Trait Implementations

impl<S, T> Clone for Engine<S, T>

where S: Clone, T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> HasSessionStore for Engine<Configured<Arc<dyn SessionStore>>, T>

fn session_store(&self) -> Arc<dyn SessionStore>

Returns the session store.

impl<S> HasTokenManager for Engine<S, Configured<Arc<TokenManager>>>

Available on crate feature token only.

fn token_manager(&self) -> Arc<TokenManager>

Returns the token manager.