Struct jsonwebtoken::Validation

pub struct Validation {
    pub leeway: u64,
    pub validate_exp: bool,
    pub validate_nbf: bool,
    pub aud: Option<HashSet<String>>,
    pub iss: Option<String>,
    pub sub: Option<String>,
    pub algorithms: Vec<Algorithm>,
}

Contains the various validations that are applied after decoding a JWT.

All time validation happen on UTC timestamps as seconds.

use jsonwebtoken::Validation;

// Default value
let validation = Validation::default();

// Changing one parameter
let mut validation = Validation {leeway: 60, ..Default::default()};

// Setting audience
let mut validation = Validation::default();
validation.set_audience(&["Me"]); // a single string
validation.set_audience(&["Me", "You"]); // array of strings

Fields

leeway: u64

Add some leeway (in seconds) to the exp, iat and nbf validation to account for clock skew.

Defaults to 0.

validate_exp: bool

Whether to validate the exp field.

It will return an error if the time in the exp field is past.

Defaults to true.

validate_nbf: bool

Whether to validate the nbf field.

It will return an error if the current timestamp is before the time in the nbf field.

Defaults to false.

aud: Option<HashSet<String>>

If it contains a value, the validation will check that the aud field is a member of the audience provided and will error otherwise.

Defaults to None.

iss: Option<String>

If it contains a value, the validation will check that the iss field is the same as the one provided and will error otherwise.

Defaults to None.

sub: Option<String>

If it contains a value, the validation will check that the sub field is the same as the one provided and will error otherwise.

Defaults to None.

algorithms: Vec<Algorithm>

If it contains a value, the validation will check that the alg of the header is contained in the ones provided and will error otherwise.

Defaults to vec![Algorithm::HS256].

Implementations

impl Validation

pub fn new(alg: Algorithm) -> Validation

Create a default validation setup allowing the given alg

pub fn set_audience<T: ToString>(&mut self, items: &[T])

aud is a collection of one or more acceptable audience members

Trait Implementations

impl Clone for Validation

fn clone(&self) -> Validation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Validation

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

Formats the value using the given formatter.

impl Default for Validation

fn default() -> Validation

Returns the “default value” for a type.

impl PartialEq<Validation> for Validation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Validation