Struct SessionStorage

pub struct SessionStorage { /* private fields */ }

Allow to save, read and remove session from storage.

Implementations

impl SessionStorage

pub fn new( storage: Arc<dyn TokenStorage>, jwt_encoding_key: Arc<EncodingKey>, algorithm: Algorithm, ) -> Self

Abstraction layer over database holding tokens information

It allows read/write/update/delete operation on tokens

pub async fn find_jwt<ClaimsType: Claims>( &self, jti: Uuid, ) -> Result<ClaimsType, Error>

Load claims from storage or returns Error if record does not exists or there was other error while trying to fetch data from storage.

pub async fn refresh<ClaimsType: Claims>( &self, refresh_jti: Uuid, ) -> Result<Pair<ClaimsType>, Error>

Changes RefreshToken::issues_at allowing Claims and RefreshToken to be accessible longer

Examples:

use actix_jwt_session::SessionStorage;
use actix_web::{Error, HttpResponse};

#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct AppClaims { id: uuid::Uuid, sub: String }
impl actix_jwt_session::Claims for AppClaims {
    fn jti(&self) -> uuid::Uuid { self.id }
    fn subject(&self) -> &str { &self.sub }
}

async fn extend_tokens_lifetime(
    session_storage: SessionStorage,
    jti: uuid::Uuid
) -> Result<HttpResponse, Error> {
    session_storage.refresh::<AppClaims>(jti).await?;
    Ok(HttpResponse::Ok().finish())
}

pub async fn store<ClaimsType: Claims>( &self, claims: ClaimsType, access_ttl: JwtTtl, refresh_ttl: RefreshTtl, ) -> Result<Pair<ClaimsType>, Error>

Save claims in storage in a way claims can be loaded from database using jti as uuid::Uuid (JWT ID)

pub async fn erase<ClaimsType: Claims>(&self, jti: Uuid) -> Result<(), Error>

Erase claims from storage. You may ignore if claims does not exists in storage. Redis implementation returns Error::NotFound if record does not exists.

Trait Implementations

impl Clone for SessionStorage

fn clone(&self) -> SessionStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for SessionStorage

type Target = Arc<dyn TokenStorage>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.