Struct biscuit::RegisteredClaims

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>,
}

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

Methods

impl RegisteredClaims

pub fn validate_claim_presence(
    &self,
    options: ClaimPresenceOptions
) -> Result<(), ValidationError>

Validates that the token contains the claims defined as required

pub fn validate_exp(
    &self,
    validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>

Validates that if the token has an exp claim, it has not passed.

pub fn validate_nbf(
    &self,
    validation: Validation<TemporalOptions>
) -> Result<(), ValidationError>

Validates that if the token has an nbf claim, it has passed.

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

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

pub fn validate_iss(
    &self,
    validation: Validation<StringOrUri>
) -> Result<(), ValidationError>

Validates that if the token has an iss claim, it matches the expected issuer

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

impl Clone for RegisteredClaims

fn clone(&self) -> RegisteredClaims

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RegisteredClaims

fn default() -> RegisteredClaims

Returns the "default value" for a type.

impl Eq for RegisteredClaims

impl PartialEq<RegisteredClaims> for RegisteredClaims

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

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

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

This method tests for !=.

impl Debug for RegisteredClaims

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

Formats the value using the given formatter.

impl StructuralPartialEq for RegisteredClaims

impl StructuralEq for RegisteredClaims

impl Serialize for RegisteredClaims

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for RegisteredClaims

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.