Struct SdJwtVc

pub struct SdJwtVc { /* private fields */ }

An SD-JWT carrying a verifiable credential as described in SD-JWT VC specification.

Implementations

impl SdJwtVc

pub fn parse(s: &str) -> Result<Self>

Parses a string into an SdJwtVc.

pub fn claims(&self) -> &SdJwtVcClaims

Returns a reference to this SdJwtVc’s JWT claims.

pub fn into_presentation( self, hasher: &dyn Hasher, ) -> Result<SdJwtVcPresentationBuilder>

Prepares this SdJwtVc for a presentation, returning an SdJwtVcPresentationBuilder.

Errors

• Error::SdJwt is returned if the provided hasher’s algorithm doesn’t match the algorithm specified by SD-JWT’s _sd_alg claim. “sha-256” is used if the claim is missing.

pub fn into_disclosed_object(self, hasher: &dyn Hasher) -> Result<JsonObject>

Returns the JSON object obtained by replacing all disclosures into their corresponding JWT concealable claims.

pub async fn issuer_metadata<R>( &self, resolver: &R, ) -> Result<Option<IssuerMetadata>>

where R: Resolver<Url, Vec<u8>>,

Retrieves this SD-JWT VC’s issuer’s metadata by querying its default location.

Notes

This method doesn’t perform any validation of the retrieved IssuerMetadata besides its syntactical validity. To check if the retrieved IssuerMetadata is valid use IssuerMetadata::validate.

pub async fn type_metadata<R>( &self, resolver: &R, ) -> Result<(TypeMetadata, Vec<u8>)>

where R: Resolver<StringOrUrl, Vec<u8>>,

Retrieve this SD-JWT VC credential’s type metadata TypeMetadata.

Notes

resolver is fed with whatever value SdJwtVc’s vct might have. If vct is a URI with scheme https, resolver must fetch the TypeMetadata resource by combining vct’s value with WELL_KNOWN_VCT. To simplify this process the utility function vct_to_url is provided.

Returns the parsed TypeMetadata along with the raw Resolver’s response. The latter can be used to validate the vct#integrity claim if present.

pub async fn issuer_jwk<R>(&self, resolver: &R) -> Result<Jwk>

where R: Resolver<Url, Vec<u8>>,

Resolves the issuer’s public key in JWK format. The issuer’s JWK is first fetched through the issuer’s metadata, if this attempt fails resolver is used to query the key directly through kid’s value.

pub fn verify_signature<V>(&self, jws_verifier: &V, jwk: &Jwk) -> Result<()>

where V: JwsVerifier,

Verifies this SdJwtVc JWT’s signature.

pub fn validate_claims_disclosability( &self, claims_metadata: &[ClaimMetadata], ) -> Result<()>

Checks the disclosability of this SdJwtVc’s claims against a list of ClaimMetadata.

Notes

This check should be performed by the token’s holder in order to assert the issuer’s compliance with the credential’s type.

pub async fn validate<R, V>( &self, resolver: &R, jws_verifier: &V, hasher: &dyn Hasher, ) -> Result<()>

where R: Resolver<Url, Vec<u8>> + Resolver<StringOrUrl, Vec<u8>> + Resolver<Url, Value>, V: JwsVerifier,

Check whether this SdJwtVc is valid.

This method checks:

• JWS signature
• credential’s type
• claims’ disclosability

pub fn verify_key_binding<V: JwsVerifier>( &self, jws_verifier: &V, jwk: &Jwk, ) -> Result<()>

Verify the signature of this SdJwtVc’s [sd_jwt_payload_rework::KeyBindingJwt].

pub fn validate_key_binding<V: JwsVerifier>( &self, jws_verifier: &V, jwk: &Jwk, hasher: &dyn Hasher, options: &KeyBindingJWTValidationOptions, ) -> Result<()>

Check the validity of this SdJwtVc’s [sd_jwt_payload_rework::KeyBindingJwt].

Notes

Validation of the required key binding (specified through the cnf JWT’s claim) is only partially validated - custom and “jwe” requirement are not checked.

Methods from Deref<Target = SdJwt>

pub fn header(&self) -> &Map<String, Value>

pub fn claims(&self) -> &SdJwtClaims

pub fn disclosures(&self) -> &[Disclosure]

pub fn required_key_bind(&self) -> Option<&RequiredKeyBinding>

pub fn key_binding_jwt(&self) -> Option<&KeyBindingJwt>

pub fn presentation(&self) -> String

Serializes the components into the final SD-JWT.

Error

Returns [Error::DeserializationError] if parsing fails.

Trait Implementations

impl Clone for SdJwtVc

fn clone(&self) -> SdJwtVc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SdJwtVc

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

Formats the value using the given formatter.

impl Deref for SdJwtVc

type Target = SdJwt

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for SdJwtVc

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

Formats the value using the given formatter.

impl From<SdJwtVc> for SdJwt

fn from(value: SdJwtVc) -> Self

Converts to this type from the input type.

impl FromStr for SdJwtVc

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 PartialEq for SdJwtVc

fn eq(&self, other: &SdJwtVc) -> 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 TryFrom<SdJwt> for SdJwtVc

type Error = Error

The type returned in the event of a conversion error.

fn try_from(sd_jwt: SdJwt) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SdJwtVc

impl StructuralPartialEq for SdJwtVc