Struct SessionProvider 

pub struct SessionProvider<S, U>
where
    S: SessionStorage<SessionId = SessionId, SessionData = SessionData>,
    U: Authenticatable,
{ /* private fields */ }

Session-based authentication provider

Implementations

impl<S, U> SessionProvider<S, U>

where S: SessionStorage<SessionId = SessionId, SessionData = SessionData>, U: Authenticatable + Clone,

pub fn new( storage: S, session_duration: Duration, cleanup_interval: Duration, ) -> Self

Create new session provider

pub fn cleanup_interval(&self) -> Duration

pub fn with_default_config(storage: S) -> Self

Create session provider with default settings

pub fn storage(&self) -> &S

Get session storage reference

pub async fn create_session( &self, user: &U, csrf_token: Option<String>, ip_address: Option<String>, user_agent: Option<String>, ) -> AuthResult<SessionId>

Create a new session for authenticated user

pub async fn validate_session( &self, session_id: &SessionId, ) -> AuthResult<SessionData>

Validate session and return session data

pub async fn extend_session(&self, session_id: &SessionId) -> AuthResult<()>

Extend session expiration

pub async fn destroy_session(&self, session_id: &SessionId) -> AuthResult<()>

Delete session (logout)

pub async fn cleanup_expired(&self) -> AuthResult<u64>

Clean up expired sessions

Trait Implementations

impl<S, U> AuthProvider<U> for SessionProvider<S, U>

where S: SessionStorage<SessionId = SessionId, SessionData = SessionData>, U: Authenticatable + Clone,

type Token = SessionId

type Credentials = SessionCredentials

fn authenticate<'life0, 'life1, 'async_trait>( &'life0 self, credentials: &'life1 Self::Credentials, ) -> Pin<Box<dyn Future<Output = AuthResult<AuthenticationResult<U, Self::Token>>> + Send + 'async_trait>>

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

Authenticate user with credentials and return a token

fn validate_token<'life0, 'life1, 'async_trait>( &'life0 self, _token: &'life1 Self::Token, ) -> Pin<Box<dyn Future<Output = AuthResult<U>> + Send + 'async_trait>>

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

Validate an existing token and return user information

fn revoke_token<'life0, 'life1, 'async_trait>( &'life0 self, token: &'life1 Self::Token, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

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

Revoke a token

fn provider_name(&self) -> &str

Get provider name for identification

fn refresh_token<'life0, 'life1, 'async_trait>( &'life0 self, _token: &'life1 Self::Token, ) -> Pin<Box<dyn Future<Output = AuthResult<Self::Token>> + Send + 'async_trait>>

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

Refresh a token if supported

impl<S, U> Debug for SessionProvider<S, U>

where S: SessionStorage<SessionId = SessionId, SessionData = SessionData> + Debug, U: Authenticatable + Debug,

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

Formats the value using the given formatter.