Struct RotateRefreshToken 

pub struct RotateRefreshToken {
    pub session_id: SessionId,
    pub family: SessionFamilyRecord,
    pub lease: RenewalLease,
    pub previous_refresh_token_hash: RefreshTokenHash,
    pub next_refresh_token_hash: RefreshTokenHash,
    pub next_session: SessionRecord,
}

Input required to atomically rotate a refresh token.

Examples

use std::time::{Duration, SystemTime};
use webgates_sessions::lease::{LeaseId, LeaseTtl, RenewalLease};
use webgates_sessions::repository::RotateRefreshToken;
use webgates_sessions::session::{Session, SessionFamilyId, SessionFamilyRecord};
use webgates_sessions::tokens::RefreshTokenHash;

let now = SystemTime::UNIX_EPOCH + Duration::from_secs(1_000);
let family_id = SessionFamilyId::new();
let session = Session::new(
    family_id,
    "user-42",
    now,
    now + Duration::from_secs(3_600),
);
let family = SessionFamilyRecord::new(family_id, "user-42", now);
let lease = RenewalLease::from_ttl(
    session.session_id,
    LeaseId::new(),
    now,
    LeaseTtl::new(Duration::from_secs(30)),
);

let input = RotateRefreshToken {
    session_id: session.session_id,
    family,
    lease,
    previous_refresh_token_hash: RefreshTokenHash::new("prev-hash-abc").unwrap(),
    next_refresh_token_hash: RefreshTokenHash::new("next-hash-xyz").unwrap(),
    next_session: session.clone().touched(now),
};

assert_eq!(input.session_id, session.session_id);

Fields

session_id: SessionId

Session that is being renewed.

family: SessionFamilyRecord

Session family that owns the session.

lease: RenewalLease

Lease expected to authorize this rotation.

previous_refresh_token_hash: RefreshTokenHash

Previously active refresh-token hash.

next_refresh_token_hash: RefreshTokenHash

Newly issued refresh-token hash to persist.

next_session: SessionRecord

Updated session record that should become current after rotation.

Trait Implementations

impl Clone for RotateRefreshToken

fn clone(&self) -> RotateRefreshToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RotateRefreshToken

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

Formats the value using the given formatter.

impl PartialEq for RotateRefreshToken

fn eq(&self, other: &RotateRefreshToken) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RotateRefreshToken

impl StructuralPartialEq for RotateRefreshToken