Skip to main content

JwtSession

Struct JwtSession 

Source
pub struct JwtSession { /* private fields */ }
Expand description

Request-scoped JWT session manager.

JwtSession is an axum FromRequest extractor that captures the JwtSessionService from router state and pre-reads any tokens it needs (including the body when refresh_source = Body { field }).

Handlers use it to call rotate or logout without manually fishing tokens out of the request.

§Trade-off

Because this extractor may consume the request body (when the refresh source is Body { field }), handlers that also need a typed body extractor (e.g., a login handler that parses LoginReq) cannot combine JwtSession with another body extractor. Those handlers should inject State<JwtSessionService> directly instead.

§Example

async fn refresh(jwt: JwtSession) -> Result<Json<TokenPair>> {
    Ok(Json(jwt.rotate().await?))
}

async fn logout(jwt: JwtSession) -> Result<StatusCode> {
    jwt.logout().await?;
    Ok(StatusCode::NO_CONTENT)
}

Implementations§

Source§

impl JwtSession

Source

pub fn current(&self) -> Option<&Session>

Returns the Session injected by JwtLayer, if present.

Source

pub async fn authenticate( &self, user_id: &str, meta: &SessionMeta, ) -> Result<TokenPair>

Authenticate a user and issue a new TokenPair.

Delegates directly to JwtSessionService::authenticate.

Source

pub async fn rotate(&self) -> Result<TokenPair>

Rotate the refresh token and return a fresh TokenPair.

Finds the refresh token according to refresh_source in the config.

Source

pub async fn logout(&self) -> Result<()>

Revoke the session associated with the current access token.

Finds the access token according to access_source in the config.

Source

pub async fn list(&self, user_id: &str) -> Result<Vec<Session>>

List all active sessions for the given user.

Source

pub async fn revoke(&self, user_id: &str, id: &str) -> Result<()>

Revoke a specific session by its ULID identifier.

Source

pub async fn revoke_all(&self, user_id: &str) -> Result<()>

Revoke all sessions for the given user.

Source

pub async fn revoke_all_except( &self, user_id: &str, keep_id: &str, ) -> Result<()>

Revoke all sessions for the given user except the session with keep_id.

Trait Implementations§

Source§

impl<S: Send + Sync> FromRequest<S> for JwtSession

Source§

type Rejection = Error

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

async fn from_request(req: Request, state: &S) -> Result<Self>

Perform the extraction.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more