Struct ssi_claims::JWTClaims

pub struct JWTClaims<T = AnyClaims> {
    pub registered: RegisteredClaims,
    pub private: T,
}

JSON Web Token claims.

Fields

registered: RegisteredClaims

Registered claims.

private: T

Private claims.

Implementations

impl JWTClaims

pub fn builder() -> JWTClaimsBuilder

impl<T> JWTClaims<T>

pub fn new() -> JWTClaims<T>

where T: Default,

pub fn from_private_claims(private: T) -> JWTClaims<T>

Trait Implementations

impl<T> ClaimSet for JWTClaims<T>

where T: ClaimSet,

fn contains<C>(&self) -> bool

where C: Claim,

fn try_get<C>(&self) -> Result<Option<Cow<'_, C>>, InvalidClaimValue>

where C: Claim,

fn try_set<C>(&mut self, claim: C) -> Result<Result<(), C>, InvalidClaimValue>

where C: Claim,

fn try_remove<C>(&mut self) -> Result<Option<C>, InvalidClaimValue>

where C: Claim,

fn validate_registered_claims<E>(&self, env: &E) -> Result<(), InvalidClaims>

where E: DateTimeProvider,

impl<T> Clone for JWTClaims<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ConcealJwtClaims for JWTClaims<T>

where T: Serialize,

fn conceal( &self, sd_alg: SdAlg, pointers: &[impl Borrow<JsonPointer>], ) -> Result<(SdJwtPayload, Vec<DecodedDisclosure<'static>>), ConcealError>

Conceals these JWT claims.

fn conceal_with( &self, sd_alg: SdAlg, pointers: &[impl Borrow<JsonPointer>], rng: impl CryptoRng + RngCore, ) -> Result<(SdJwtPayload, Vec<DecodedDisclosure<'static>>), ConcealError>

Conceals these JWT claims with the given rng.

async fn conceal_and_sign( &self, sd_alg: SdAlg, pointers: &[impl Borrow<JsonPointer>], signer: impl JwsSigner, ) -> Result<SdJwtBuf, SignatureError>

Conceals and signs these JWT claims.

async fn conceal_and_sign_with( &self, sd_alg: SdAlg, pointers: &[impl Borrow<JsonPointer>], signer: impl JwsSigner, rng: impl CryptoRng + RngCore, ) -> Result<SdJwtBuf, SignatureError>

Conceals and signs these JWT claims with the given rng.

impl<T> Debug for JWTClaims<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for JWTClaims<T>

where T: Default,

fn default() -> JWTClaims<T>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for JWTClaims<P>

where P: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<JWTClaims<P>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Hash for JWTClaims<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> JwsPayload for JWTClaims<T>

where T: Serialize,

fn typ(&self) -> Option<&'static str>

JWS type.

fn payload_bytes(&self) -> Cow<'_, [u8]>

fn cty(&self) -> Option<&str>

JWS cty header value.

async fn sign(&self, signer: impl JwsSigner) -> Result<JwsBuf, SignatureError>

Signs the payload and returns a compact JWS.

impl<T> Ord for JWTClaims<T>

where T: Ord,

fn cmp(&self, other: &JWTClaims<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for JWTClaims<T>

where T: PartialEq,

fn eq(&self, other: &JWTClaims<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for JWTClaims<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &JWTClaims<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for JWTClaims<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P, T, E> ValidateClaims<E, P> for JWTClaims<T>

where T: ClaimSet + ValidateClaims<E, P>, E: DateTimeProvider,

fn validate_claims(&self, env: &E, proof: &P) -> Result<(), InvalidClaims>

impl<T, E> ValidateJwsHeader<E> for JWTClaims<T>

fn validate_jws_header( &self, _env: &E, _header: &Header, ) -> Result<(), InvalidClaims>

impl<T> Eq for JWTClaims<T>

where T: Eq,

impl<T> StructuralPartialEq for JWTClaims<T>