Struct VerificationOptions

pub struct VerificationOptions {
    pub reject_before: Option<UnixTimeStamp>,
    pub accept_future: bool,
    pub required_subject: Option<String>,
    pub required_key_id: Option<String>,
    pub required_public_key: Option<String>,
    pub required_nonce: Option<String>,
    pub allowed_issuers: Option<HashSet<String>>,
    pub allowed_audiences: Option<HashSet<String>>,
    pub time_tolerance: Option<Duration>,
    pub max_validity: Option<Duration>,
    pub max_token_length: Option<usize>,
    pub max_header_length: Option<usize>,
}

Additional features to enable during verification. Signatures and token expiration are already automatically verified.

Fields

reject_before: Option<UnixTimeStamp>

Reject tokens created before the given date

For a given user, the time of the last successful authentication can be kept in a database, and reject_before can then be used to reject older (replayed) tokens.

accept_future: bool

Accept tokens created with a date in the future

required_subject: Option<String>

Require a specific subject to be present

required_key_id: Option<String>

Require a specific key identifier to be present

required_public_key: Option<String>

Require a specific public key to be present

required_nonce: Option<String>

Require a specific nonce to be present

allowed_issuers: Option<HashSet<String>>

Require the issuer to be present in the set

allowed_audiences: Option<HashSet<String>>

Require the audience to be present in the set

time_tolerance: Option<Duration>

How much clock drift to tolerate when verifying token timestamps

max_validity: Option<Duration>

Reject tokens created more than max_validity ago

max_token_length: Option<usize>

Maximum token length to accept

max_header_length: Option<usize>

Maximum unsafe, untrusted, unverified JWT header length to accept

Trait Implementations

impl Clone for VerificationOptions

fn clone(&self) -> VerificationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VerificationOptions

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

Formats the value using the given formatter.

impl Default for VerificationOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for VerificationOptions

fn eq(&self, other: &VerificationOptions) -> 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 VerificationOptions

impl StructuralPartialEq for VerificationOptions