Struct asap_deps_jsonwebtoken::Validation [−][src]
pub struct Validation { pub leeway: i64, pub validate_exp: bool, pub validate_iat: bool, pub validate_nbf: bool, pub aud: Option<Value>, pub iss: Option<String>, pub sub: Option<String>, pub algorithms: Vec<Algorithm>, }
Contains the various validations that are applied after decoding a token.
All time validation happen on UTC timestamps.
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"); // string validation.set_audience(&["Me", "You"]); // array of strings
Fields
leeway: i64
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_iat: bool
Whether to validate the iat
field.
It will return an error if the time in the iat
field is in the future.
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 true
.
aud: Option<Value>
If it contains a value, the validation will check that the aud
field is the same as the
one provided and will error otherwise.
Since aud
can be either a String or a Vec
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]
.
Methods
impl Validation
[src]
impl Validation
pub fn new(alg: Algorithm) -> Validation
[src]
pub fn new(alg: Algorithm) -> Validation
Create a default validation setup allowing the given alg
pub fn set_audience<T: Serialize>(&mut self, audience: &T)
[src]
pub fn set_audience<T: Serialize>(&mut self, audience: &T)
Since aud
can be either a String or an array of String in the JWT spec, this method will take
care of serializing the value.
Trait Implementations
impl Debug for Validation
[src]
impl Debug for Validation
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for Validation
[src]
impl Clone for Validation
fn clone(&self) -> Validation
[src]
fn clone(&self) -> Validation
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for Validation
[src]
impl PartialEq for Validation
fn eq(&self, other: &Validation) -> bool
[src]
fn eq(&self, other: &Validation) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Validation) -> bool
[src]
fn ne(&self, other: &Validation) -> bool
This method tests for !=
.
impl Default for Validation
[src]
impl Default for Validation
fn default() -> Validation
[src]
fn default() -> Validation
Returns the "default value" for a type. Read more
Auto Trait Implementations
impl Send for Validation
impl Send for Validation
impl Sync for Validation
impl Sync for Validation