[−]Struct roa::jwt::Validation
feature="jwt"
only.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
feature="jwt"
only.Add some leeway (in seconds) to the exp
, iat
and nbf
validation to
account for clock skew.
Defaults to 0
.
validate_exp: bool
feature="jwt"
only.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
feature="jwt"
only.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, RandomState>>
feature="jwt"
only.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>
feature="jwt"
only.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>
feature="jwt"
only.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>
feature="jwt"
only.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
pub fn new(alg: Algorithm) -> Validation
feature="jwt"
only.Create a default validation setup allowing the given alg
pub fn set_audience<T>(&mut self, items: &[T]) where
T: ToString,
T: ToString,
feature="jwt"
only.aud
is a collection of one or more acceptable audience members
Trait Implementations
impl Clone for Validation
fn clone(&self) -> Validation
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Validation
impl Default for Validation
fn default() -> Validation
impl PartialEq<Validation> for Validation
fn eq(&self, other: &Validation) -> bool
fn ne(&self, other: &Validation) -> bool
impl StructuralPartialEq for Validation
Auto Trait Implementations
impl RefUnwindSafe for Validation
impl Send for Validation
impl Sync for Validation
impl Unpin for Validation
impl UnwindSafe for Validation
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> State for T where
T: 'static + Clone + Send + Sync,
[src]
T: 'static + Clone + Send + Sync,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,