Struct actix_jwt_session::RefreshToken

pub struct RefreshToken {
    pub issues_at: OffsetDateTime,
    pub access_ttl: JwtTtl,
    pub refresh_jti: Uuid,
    pub refresh_ttl: RefreshTtl,
    pub expiration_time: u64,
    pub not_before: u64,
    pub audience: String,
    pub issuer: String,
    /* private fields */
}

Internal claims which allows to extend tokens pair livetime

After encoding it can be used as HTTP token send to endpoint, decoded and extend pair livetime. It’s always created while calling SessionStorage::store. If there’s any extractor for refresh you can use this structure as guard for an endpoint.

Example:

use actix_web::{get, HttpResponse};
use actix_web::web::Data;
use actix_jwt_session::*;

#[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 }
}

#[get("/session/refresh")]
async fn refresh_session(
    auth: Authenticated<RefreshToken>,
    storage: Data<SessionStorage>,
) -> HttpResponse {
    let storage = storage.into_inner();
    storage.refresh::<AppClaims>(auth.refresh_jti).await.unwrap();
    HttpResponse::Ok().json(&*auth)
}

Fields

issues_at: OffsetDateTime

date and time when token was created

access_ttl: JwtTtl

JWT lifetime

refresh_jti: Uuid

this token unique identifier

refresh_ttl: RefreshTtl

this token lifetime

expiration_time: u64

this token lifetime as integer (this field is required by standard)

not_before: u64

time before which token is not validate (this field is required by standard and always set 0)

audience: String

target audience (this field is required by standard) who created this token (this field is required by standard)

issuer: String

Implementations

impl RefreshToken

pub fn is_access_valid(&self) -> bool

pub fn is_refresh_valid(&self) -> bool

pub fn access_jti(&self) -> Uuid

Trait Implementations

impl Claims for RefreshToken

fn jti(&self) -> Uuid

Unique token identifier

fn subject(&self) -> &str

Login, email or other identifier

impl Clone for RefreshToken

fn clone(&self) -> RefreshToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RefreshToken

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RefreshToken

fn eq(&self, o: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RefreshToken

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.