Struct Jwks 

pub struct Jwks { /* private fields */ }

The keys at a JWKS URL, fetched and kept current. See the module documentation.

Cloning shares it. Jwks::keys is the handle a crate::JwtConfig verifies with; crate::JwtConfig::with_jwks sets both.

Implementations

impl Jwks

pub fn builder( url: impl Into<String>, fetch: impl Fetch + 'static, ) -> JwksBuilder

Start building one for url, fetched through fetch.

pub fn keys(&self) -> &JwtKeys

The keys in force, for crate::JwtConfig::keys.

pub fn url(&self) -> &str

The URL the keys are fetched from.

pub fn is_loaded(&self) -> bool

Whether a set has ever been fetched.

pub fn status(&self) -> JwksStatus

What has happened so far.

pub fn next_refresh_in(&self) -> Duration

How long until the next fetch is due.

pub async fn refresh(&self) -> Result<(), FetchError>

Fetch the set now, whenever it was last fetched, waiting for any fetch already in flight first. The outcome is also in Jwks::status.

Always from the provider, never from a JwksStore: this is what a schedule calls, and what writes the store for everyone else.

pub async fn refresh_forever<S, F>(&self, sleep: S)

where S: FnMut(Duration) -> F, F: Future<Output = ()>,

Keep the set fresh until the end of time: fetch whenever the next fetch is due, sleeping with sleep in between.

For a host that runs background tasks – the server spawns this on its runtime with tokio::time::sleep. Once it runs, requests no longer refresh a set that is merely due; they still fetch for an unknown kid.

pub async fn ensure_for_token(&self, token: &str)

Make sure the keys a token needs are here, fetching if they may not be. Never fails: a token still without a key is refused by the synchronous check that follows, as PGRST301.

Returns without awaiting anything when the set in force holds a key for the token’s header – unless no background task keeps the set fresh and it is due, when the request that notices fetches it (and one that finds a fetch already running goes on with the set it has).

Trait Implementations

impl Clone for Jwks

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Jwks

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

Formats the value using the given formatter.