Struct CachedKeySet 

pub struct CachedKeySet<C, S> { /* private fields */ }

A caching wrapper for any KeySource implementation.

This wrapper uses the cache-aside pattern: it first checks the cache for a key, and only fetches from the underlying source on a cache miss. Retrieved keys are then stored in the cache for future requests.

Type Parameters

• C - The cache implementation (must implement KeyCache)
• S - The underlying key source (must implement KeySource)

Examples

use jwk_simple::{CachedKeySet, InMemoryKeyCache, RemoteKeySet, KeySource};
use std::time::Duration;
use std::sync::Arc;

// Create a cached remote JWKS
let cache = InMemoryKeyCache::new(Duration::from_secs(300));
let remote = RemoteKeySet::new("https://example.com/.well-known/jwks.json");
let cached = CachedKeySet::new(cache, remote);

// First call fetches from remote, caches the key
let key = cached.get_key("kid").await?;

// Subsequent calls use the cache
let key = cached.get_key("kid").await?;

Implementations

impl<C, S> CachedKeySet<C, S>

pub fn new(cache: C, source: S) -> Self

Creates a new cached key source.

Arguments

• cache - The cache implementation to use.
• source - The underlying key source to fetch from on cache misses.

pub fn cache(&self) -> &C

Returns a reference to the cache.

pub fn source(&self) -> &S

Returns a reference to the underlying source.

impl<S> CachedKeySet<InMemoryKeyCache, S>

pub fn with_ttl(source: S, ttl: Duration) -> Self

Available on crate feature cache-inmemory only.

Creates a new cached key source with in-memory caching and the specified TTL.

pub fn with_default_ttl(source: S) -> Self

Available on crate feature cache-inmemory only.

Creates a new cached key source with in-memory caching and the default TTL.

pub async fn invalidate(&self)

Available on crate feature cache-inmemory only.

Invalidates the cache, forcing fresh fetches on subsequent requests.

pub async fn invalidate_key(&self, kid: &str)

Available on crate feature cache-inmemory only.

Removes a specific key from the cache.

Trait Implementations

impl<C: Debug, S: Debug> Debug for CachedKeySet<C, S>

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

Formats the value using the given formatter.

impl<C, S> KeySource for CachedKeySet<C, S>

where C: KeyCache + Send + Sync, S: KeySource + Send + Sync,

fn get_key<'life0, 'life1, 'async_trait>( &'life0 self, kid: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Key>>> + Send + 'async_trait>>

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

Gets a key by its key ID (kid).

fn get_keyset<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<KeySet>> + Send + 'async_trait>>

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

Gets all available keys as a KeySet.