Struct IdToken

pub struct IdToken<AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm>(/* private fields */);

OpenID Connect ID token.

Implementations

impl<AC, GC, JE, JS> IdToken<AC, GC, JE, JS>

where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm,

pub fn new<S>( claims: IdTokenClaims<AC, GC>, signing_key: &S, alg: JS, access_token: Option<&AccessToken>, code: Option<&AuthorizationCode>, ) -> Result<Self, JsonWebTokenError>

where S: PrivateSigningKey, <S as PrivateSigningKey>::VerificationKey: JsonWebKey<SigningAlgorithm = JS>,

Initializes an ID token with the specified claims, signed using the given signing key and algorithm.

If an access_token and/or code are provided, this method sets the at_hash and/or c_hash claims using the given signing algorithm, respectively. Otherwise, those claims are unchanged from the values specified in claims.

pub fn claims<'a, K, N>( &'a self, verifier: &IdTokenVerifier<'_, K>, nonce_verifier: N, ) -> Result<&'a IdTokenClaims<AC, GC>, ClaimsVerificationError>

where K: JsonWebKey<SigningAlgorithm = JS>, N: NonceVerifier,

Verifies and returns a reference to the ID token claims.

pub fn into_claims<K, N>( self, verifier: &IdTokenVerifier<'_, K>, nonce_verifier: N, ) -> Result<IdTokenClaims<AC, GC>, ClaimsVerificationError>

where K: JsonWebKey<SigningAlgorithm = JS>, N: NonceVerifier,

Verifies and returns the ID token claims.

pub fn signing_alg(&self) -> Result<&JS, SignatureVerificationError>

Returns the JwsSigningAlgorithm used to sign this ID token.

This function returns an error if the token is unsigned or utilizes JSON Web Encryption (JWE).

pub fn signing_key<'s, K>( &self, verifier: &'s IdTokenVerifier<'s, K>, ) -> Result<&'s K, SignatureVerificationError>

where K: JsonWebKey<SigningAlgorithm = JS>,

Returns the JsonWebKey usable for verifying this ID token’s JSON Web Signature.

This function returns an error if the token has no signature or a corresponding key cannot be found.

Trait Implementations

impl<AC: Clone + AdditionalClaims, GC: Clone + GenderClaim, JE: Clone + JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: Clone + JwsSigningAlgorithm> Clone for IdToken<AC, GC, JE, JS>

fn clone(&self) -> IdToken<AC, GC, JE, JS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<AC: Debug + AdditionalClaims, GC: Debug + GenderClaim, JE: Debug + JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: Debug + JwsSigningAlgorithm> Debug for IdToken<AC, GC, JE, JS>

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

Formats the value using the given formatter.

impl<'de, AC, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm> Deserialize<'de> for IdToken<AC, GC, JE, JS>

where AC: AdditionalClaims,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<AC, GC, JE, JS> FromStr for IdToken<AC, GC, JE, JS>

where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<AC: PartialEq + AdditionalClaims, GC: PartialEq + GenderClaim, JE: PartialEq + JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: PartialEq + JwsSigningAlgorithm> PartialEq for IdToken<AC, GC, JE, JS>

fn eq(&self, other: &IdToken<AC, GC, JE, JS>) -> 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<AC, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm> Serialize for IdToken<AC, GC, JE, JS>

where AC: AdditionalClaims,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<AC, GC, JE, JS> ToString for IdToken<AC, GC, JE, JS>

where AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm,

fn to_string(&self) -> String

Converts the given value to a String.

impl<AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<KeyType = JS::KeyType>, JS: JwsSigningAlgorithm> StructuralPartialEq for IdToken<AC, GC, JE, JS>