Struct JwtClaims 

#[non_exhaustive]
pub struct JwtClaims {
    pub iss: Option<String>,
    pub sub: Option<String>,
    pub aud: Option<OneOrMany<String>>,
    pub exp: Option<i64>,
    pub nbf: Option<i64>,
    pub iat: Option<i64>,
    pub jti: Option<String>,
    pub additional: IndexMap<String, Value>,
}

Available on crate feature vc only.

A JWT claims set: the registered claims of RFC 7519 §4.1 as fields, every other claim (vc, vp, nonce, cnf, …) in additional.

Times are NumericDate values, seconds since the Unix epoch; JwtClaims::numeric_date and JwtClaims::timestamp convert.

Examples

use identity_kit::vc::JwtClaims;

let claims: JwtClaims = serde_json::from_str(
    r#"{"iss":"did:example:123","exp":1573029723,"nonce":"660!6345FSer"}"#,
)?;
assert_eq!(claims.iss.as_deref(), Some("did:example:123"));
assert_eq!(
    claims.exp.and_then(JwtClaims::timestamp).map(|t| t.to_rfc3339()),
    Some("2019-11-06T08:42:03+00:00".to_owned())
);
assert_eq!(claims.additional["nonce"], "660!6345FSer");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

iss: Option<String>

iss: the issuer of the token.

sub: Option<String>

sub: the subject of the token.

aud: Option<OneOrMany<String>>

aud: the intended recipients.

exp: Option<i64>

exp: when the token expires.

nbf: Option<i64>

nbf: when the token becomes valid.

iat: Option<i64>

iat: when the token was issued.

jti: Option<String>

jti: the identifier of the token.

additional: IndexMap<String, Value>

Every other claim, in insertion order.

Implementations

impl JwtClaims

pub const REGISTERED: [&'static str; 7]

The registered claim names of RFC 7519 §4.1, which have fields of their own.

pub fn new() -> Self

An empty claims set.

pub fn with_iss(self, issuer: impl Into<String>) -> Self

This claims set with iss set to issuer.

pub fn with_sub(self, subject: impl Into<String>) -> Self

This claims set with sub set to subject.

pub fn with_jti(self, id: impl Into<String>) -> Self

This claims set with jti set to id.

pub fn numeric_date(time: DateTime<Utc>) -> i64

time as a NumericDate: whole seconds since the Unix epoch, fractions dropped.

pub fn timestamp(numeric_date: i64) -> Option<DateTime<Utc>>

The time a NumericDate names, if it is in the range chrono represents.

pub fn audiences(&self) -> impl Iterator<Item = &str>

The audiences, in order; empty when aud is absent.

pub fn with_exp(self, time: DateTime<Utc>) -> Self

This claims set with exp set to time.

pub fn with_nbf(self, time: DateTime<Utc>) -> Self

This claims set with nbf set to time.

pub fn with_iat(self, time: DateTime<Utc>) -> Self

This claims set with iat set to time.

pub fn with_aud(self, audience: impl Into<String>) -> Self

This claims set with aud set to the one audience audience.

pub fn with_claim( self, name: impl Into<String>, value: impl Into<Value>, ) -> Self

This claims set with the claim name set to value.

name should not be one of REGISTERED, which have setters of their own: Jwt::sign refuses a claims set holding a registered claim under additional.

Trait Implementations

impl Clone for JwtClaims

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JwtClaims

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

Formats the value using the given formatter.

impl Default for JwtClaims

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JwtClaims

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JwtClaims

impl PartialEq for JwtClaims

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JwtClaims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JwtClaims