Struct biscuit::RegisteredClaims
source · pub struct RegisteredClaims {
pub issuer: Option<StringOrUri>,
pub subject: Option<StringOrUri>,
pub audience: Option<SingleOrMultiple<StringOrUri>>,
pub expiry: Option<Timestamp>,
pub not_before: Option<Timestamp>,
pub issued_at: Option<Timestamp>,
pub id: Option<String>,
}
Expand description
Registered claims defined by RFC7519#4.1
Fields
issuer: Option<StringOrUri>
Token issuer. Serialized to iss
.
subject: Option<StringOrUri>
Subject where the JWT is referring to. Serialized to sub
audience: Option<SingleOrMultiple<StringOrUri>>
Audience intended for the JWT. Serialized to aud
expiry: Option<Timestamp>
Expiration time in seconds since Unix Epoch. Serialized to exp
not_before: Option<Timestamp>
Not before time in seconds since Unix Epoch. Serialized to nbf
issued_at: Option<Timestamp>
Issued at Time in seconds since Unix Epoch. Serialized to iat
id: Option<String>
Application specific JWT ID. Serialized to jti
Implementations
sourceimpl RegisteredClaims
impl RegisteredClaims
sourcepub fn validate_claim_presence(
&self,
options: ClaimPresenceOptions
) -> Result<(), ValidationError>
pub fn validate_claim_presence(
&self,
options: ClaimPresenceOptions
) -> Result<(), ValidationError>
Validates that the token contains the claims defined as required
sourcepub fn validate_exp(
&self,
validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>
pub fn validate_exp(
&self,
validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>
Validates that if the token has an exp
claim, it has not passed.
sourcepub fn validate_nbf(
&self,
validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>
pub fn validate_nbf(
&self,
validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>
Validates that if the token has an nbf
claim, it has passed.
sourcepub fn validate_iat(
&self,
validation: Validation<(Duration, TemporalOptions)>
) -> Result<(), ValidationError>
pub fn validate_iat(
&self,
validation: Validation<(Duration, TemporalOptions)>
) -> Result<(), ValidationError>
Validates that if the token has an iat
claim, it is not in the future and not older than the Duration
sourcepub fn validate_aud(
&self,
validation: Validation<StringOrUri>
) -> Result<(), ValidationError>
pub fn validate_aud(
&self,
validation: Validation<StringOrUri>
) -> Result<(), ValidationError>
Validates that if the token has an aud
claim, it contains an entry which matches the expected audience
sourcepub fn validate_iss(
&self,
validation: Validation<StringOrUri>
) -> Result<(), ValidationError>
pub fn validate_iss(
&self,
validation: Validation<StringOrUri>
) -> Result<(), ValidationError>
Validates that if the token has an iss
claim, it matches the expected issuer
sourcepub fn validate(&self, options: ValidationOptions) -> Result<(), ValidationError>
pub fn validate(&self, options: ValidationOptions) -> Result<(), ValidationError>
Performs full validation of the token according to the ValidationOptions
supplied
First it validates that all claims marked as required are present Then it validates each claim marked to be validated if they are present in the token (even those that are not marked as required, but are present).
Trait Implementations
sourceimpl Clone for RegisteredClaims
impl Clone for RegisteredClaims
sourcefn clone(&self) -> RegisteredClaims
fn clone(&self) -> RegisteredClaims
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for RegisteredClaims
impl Debug for RegisteredClaims
sourceimpl Default for RegisteredClaims
impl Default for RegisteredClaims
sourcefn default() -> RegisteredClaims
fn default() -> RegisteredClaims
sourceimpl<'de> Deserialize<'de> for RegisteredClaims
impl<'de> Deserialize<'de> for RegisteredClaims
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl PartialEq<RegisteredClaims> for RegisteredClaims
impl PartialEq<RegisteredClaims> for RegisteredClaims
sourcefn eq(&self, other: &RegisteredClaims) -> bool
fn eq(&self, other: &RegisteredClaims) -> bool
sourceimpl Serialize for RegisteredClaims
impl Serialize for RegisteredClaims
impl Eq for RegisteredClaims
impl StructuralEq for RegisteredClaims
impl StructuralPartialEq for RegisteredClaims
Auto Trait Implementations
impl RefUnwindSafe for RegisteredClaims
impl Send for RegisteredClaims
impl Sync for RegisteredClaims
impl Unpin for RegisteredClaims
impl UnwindSafe for RegisteredClaims
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.