Struct axum_login::AuthSession

pub struct AuthSession<Backend: AuthnBackend> {
    pub user: Option<Backend::User>,
    pub backend: Backend,
    /* private fields */
}

A specialized session for identification, authentication, and authorization of users associated with a backend.

The session is generic over some backend which implements AuthnBackend. The backend may also implement AuthzBackend, in which case it will also supply authorization methods.

Methods for authenticating the session and logging a user in are provided.

Generally this session will be used in the context of some authentication workflow, for example via a frontend login form. There a user would provide their credentials, such as username and password, and via the backend the session would authenticate those credentials.

Once the supplied credentials have been authenticated, a user will be returned. In the case the credentials are invalid, no user will be returned. When we do have a user, it’s then possible to set the state of the session so that the user is logged in.

Fields

user: Option<Backend::User>

The user associated by the backend. None when not logged in.

backend: Backend

The authentication and authorization backend.

Implementations

impl<Backend: AuthnBackend> AuthSession<Backend>

pub async fn authenticate( &self, creds: Backend::Credentials ) -> Result<Option<Backend::User>, Error<Backend>>

Verifies the provided credentials via the backend returning the authenticated user if valid and otherwise None.

pub async fn login( &mut self, user: &Backend::User ) -> Result<(), Error<Backend>>

Updates the session such that the user is logged in.

pub async fn logout(&mut self) -> Result<Option<Backend::User>, Error<Backend>>

Updates the session such that the user is logged out.

Trait Implementations

impl<Backend: Clone + AuthnBackend> Clone for AuthSession<Backend>

where Backend::User: Clone,

fn clone(&self) -> AuthSession<Backend>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Backend: Debug + AuthnBackend> Debug for AuthSession<Backend>

where Backend::User: Debug,

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

Formats the value using the given formatter.

impl<S, Backend> FromRequestParts<S> for AuthSession<Backend>

where S: Send + Sync, Backend: AuthnBackend + Send + Sync + 'static,

type Rejection = (StatusCode, &'static str)

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

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

Perform the extraction.