Struct JwtValidationOptions 

#[non_exhaustive]
pub struct JwtValidationOptions {
    pub algorithms: BTreeSet<JwsAlgorithm>,
    pub typ: Option<String>,
    pub issuer: Option<String>,
    pub audience: Option<String>,
    pub role: KeyRole,
    pub issuer_binding: IssuerBinding,
    pub required_claims: BTreeSet<String>,
    pub now: Option<i64>,
    pub leeway: Duration,
}

Options of JwtValidator: what the token must be, and when.

The default accepts every algorithm the crate verifies, any typ, any issuer and audience, with the key bound to iss, at the current time without leeway, and requires no claim.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

algorithms: BTreeSet<JwsAlgorithm>

The algorithms accepted; every algorithm when empty.

typ: Option<String>

The header typ the token must have, if any.

issuer: Option<String>

The iss the token must have, if any.

audience: Option<String>

The audience the token’s aud must include, if any.

role: KeyRole

The role the signing key is resolved for: KeyRole::Issuer (assertionMethod in a DID document) by default, KeyRole::Subject (authentication) for a token that proves possession.

issuer_binding: IssuerBinding

Whether the signing key must belong to iss.

required_claims: BTreeSet<String>

Claims that must be present, registered or not.

now: Option<i64>

The validation time in seconds since the Unix epoch; the current time when None.

leeway: Duration

How far exp, nbf and iat may miss the validation time and still pass.

Implementations

impl JwtValidationOptions

pub fn new() -> Self

The default options.

pub fn with_algorithm(self, alg: JwsAlgorithm) -> Self

These options also accepting alg. Once one algorithm is named, only the named ones are accepted.

pub fn with_typ(self, typ: impl Into<String>) -> Self

These options requiring the header typ to be typ.

pub fn with_issuer(self, issuer: impl Into<String>) -> Self

These options requiring iss to be issuer.

pub fn with_audience(self, audience: impl Into<String>) -> Self

These options requiring aud to include audience.

pub fn with_role(self, role: KeyRole) -> Self

These options resolving the signing key for role.

pub fn with_issuer_binding(self, binding: IssuerBinding) -> Self

These options with binding.

pub fn with_required_claims<I, S>(self, claims: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

These options also requiring every claim of claims.

pub fn at(self, now: i64) -> Self

These options validating at now, in seconds since the Unix epoch.

pub fn with_leeway(self, leeway: Duration) -> Self

These options with leeway.

pub fn now(&self) -> i64

The validation time, in seconds since the Unix epoch.

Trait Implementations

impl Clone for JwtValidationOptions

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 JwtValidationOptions

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

Formats the value using the given formatter.

impl Default for JwtValidationOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for JwtValidationOptions

impl PartialEq for JwtValidationOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JwtValidationOptions