Struct jwt_simple::claims::JWTClaims

pub struct JWTClaims<CustomClaims> {
    pub issued_at: Option<UnixTimeStamp>,
    pub expires_at: Option<UnixTimeStamp>,
    pub invalid_before: Option<UnixTimeStamp>,
    pub issuer: Option<String>,
    pub subject: Option<String>,
    pub audiences: Option<Audiences>,
    pub jwt_id: Option<String>,
    pub nonce: Option<String>,
    pub custom: CustomClaims,
}

A set of JWT claims.

The CustomClaims parameter can be set to NoCustomClaims if only standard claims are used, or to a user-defined type that must be serde-serializable if custom claims are required.

Fields

issued_at: Option<UnixTimeStamp>

Time the claims were created at

expires_at: Option<UnixTimeStamp>

Time the claims expire at

invalid_before: Option<UnixTimeStamp>

Time the claims will be invalid until

issuer: Option<String>

Issuer - This can be set to anything application-specific

subject: Option<String>

Subject - This can be set to anything application-specific

audiences: Option<Audiences>

Audience

jwt_id: Option<String>

JWT identifier

That property was originally designed to avoid replay attacks, but keeping all previously sent JWT token IDs is unrealistic.

Replay attacks are better addressed by keeping only the timestamp of the last valid token for a user, and rejecting anything older in future tokens.

nonce: Option<String>

Nonce

custom: CustomClaims

Custom (application-defined) claims

Implementations

impl<CustomClaims> JWTClaims<CustomClaims>

pub fn invalid_before(self, unix_timestamp: UnixTimeStamp) -> Self

Set the token as not being valid until unix_timestamp

pub fn with_issuer(self, issuer: impl ToString) -> Self

Set the issuer

pub fn with_subject(self, subject: impl ToString) -> Self

Set the subject

pub fn with_audiences(self, audiences: HashSet<impl ToString>) -> Self

Register one or more audiences (optional recipient identifiers), as a set

pub fn with_audience(self, audience: impl ToString) -> Self

Set a unique audience (an optional recipient identifier), as a string

pub fn with_jwt_id(self, jwt_id: impl ToString) -> Self

Set the JWT identifier

pub fn with_nonce(self, nonce: impl ToString) -> Self

Set the nonce

pub fn create_nonce(&mut self) -> String

Create a nonce, attach it and return it

Trait Implementations

impl<CustomClaims: Clone> Clone for JWTClaims<CustomClaims>

fn clone(&self) -> JWTClaims<CustomClaims>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CustomClaims: Debug> Debug for JWTClaims<CustomClaims>

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

Formats the value using the given formatter.

impl<'de, CustomClaims> Deserialize<'de> for JWTClaims<CustomClaims>where
    CustomClaims: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<CustomClaims> Serialize for JWTClaims<CustomClaims>where
    CustomClaims: Serialize,

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

Serialize this value into the given Serde serializer.