Struct CacheStore 

pub struct CacheStore<C: Cache> { /* private fields */ }

Sessions stored as JSON in a Cache, with the store TTL.

Revoking a user is one write: it increments a per-user epoch counter, and load rejects any record whose auth_epoch differs from the counter. That works on MemoryCache and Redis alike and also stops a stale in-flight write from reviving a revoked session.

The epoch counters have no expiry. Use a cache that does not evict them: Redis with noeviction or a volatile-* policy, or a MemoryCache sized so it never evicts (it is an LRU, and an evicted counter would revive revoked sessions). Keys hold the session id hash and a hash of the user name, never the raw values.

Deleting a session (logout, rotation) also writes a tombstone for its id, and load refuses an id with a tombstone. The cache has no conditional write, so a slow request racing a logout could store the record again; the tombstone keeps that record from ever being served. A hit therefore costs one more read. The tombstone lifetime (with_tombstone_ttl, 24 hours by default) must be at least the session’s absolute lifetime; update never writes a record that outlives it.

Errors from the cache are replaced by a generic StoreError: cache error texts can carry addresses.

Implementations

impl<C: Cache> CacheStore<C>

pub fn new(cache: C) -> Self

Store sessions in cache under the siderite:session: prefix.

pub fn with_tombstone_ttl(self, ttl: Duration) -> Self

Keep deleted ids refused for ttl. Set it to at least the session’s absolute lifetime.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Use another key prefix, for example one per application.

Trait Implementations

impl<C: Cache> Clone for CacheStore<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Cache> Debug for CacheStore<C>

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

Formats the value using the given formatter.

impl<C: Cache> SessionStore for CacheStore<C>

fn load<'life0, 'life1, 'async_trait>( &'life0 self, id_hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<SessionRecord>, StoreError>> + Send + 'async_trait>>

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

Fetch the record for id_hash; Ok(None) when absent or expired or revoked.

fn save<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id_hash: &'life1 str, record: &'life2 SessionRecord, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

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

Store record under id_hash, replacing any record, for ttl.

fn update<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id_hash: &'life1 str, record: &'life2 SessionRecord, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<bool, StoreError>> + Send + 'async_trait>>

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

Replace the record under id_hash only if one is stored, for ttl; Ok(false) when there is none.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, id_hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

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

Remove id_hash. Removing an absent record is not an error.

fn revoke_user<'life0, 'life1, 'async_trait>( &'life0 self, user: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StoreError>> + Send + 'async_trait>>

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

Invalidate every session of user, now and for stale in-flight writes. Use it after password changes and account recovery.

fn auth_epoch<'life0, 'life1, 'async_trait>( &'life0 self, user: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u64, StoreError>> + Send + 'async_trait>>

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

The user’s current revocation epoch, recorded in SessionRecord::auth_epoch at login. Stores that revoke by deleting records can keep the default of 0.