Skip to main content

JwtPresentationValidator

Struct JwtPresentationValidator 

Source
pub struct JwtPresentationValidator<R, V = DefaultVerifier> { /* private fields */ }
Available on crate feature vc only.
Expand description

Validates presentation JWTs and the credential JWTs they carry, see the module documentation for the checks.

Built over a JwtCredentialValidator, which validates the credentials with the same key resolver, verifier and status check.

Each profile has its own method, as for credentials: validate for the VCDM 1.1 JWT profile (typ JWT, the vp claim, credentials as JWTs) and validate_v2 for VCDM 2.0 secured with VC-JOSE-COSE (typ vp+jwt, the payload is the presentation, credentials enveloped). Neither accepts the other’s typ. A verifier that takes both picks by typ, and since typ is optional in both profiles, picks a token without one by its payload: VCDM 1.1 puts the presentation in a vp claim, VCDM 2.0 never has one.

use identity_kit::jose::DefaultVerifier;
use identity_kit::methods::DidKey;
use identity_kit::resolver::Resolver;
use identity_kit::vc::validation::{JwtPresentationValidator, PresentationValidationOptions};
use identity_kit::vc::{Jwt, JwtClaims, PresentationV2};

/// Whether `jwt` is a VCDM 2.0 presentation rather than a VCDM 1.1 one.
fn is_v2(jwt: &Jwt) -> Result<bool, Box<dyn std::error::Error>> {
    let jws = jwt.decode()?;
    Ok(match jws.header().typ.as_deref() {
        Some(typ) => typ == PresentationV2::JWT_TYP,
        None => {
            let claims: JwtClaims = serde_json::from_slice(jws.payload())?;
            !claims.additional.contains_key("vp")
        }
    })
}

async fn holder_of(
    validator: &JwtPresentationValidator<Resolver>,
    jwt: &Jwt,
    options: &PresentationValidationOptions,
) -> Result<Option<String>, Box<dyn std::error::Error>> {
    let holder = if is_v2(jwt)? {
        validator.validate_v2(jwt, options).await?.holder().cloned()
    } else {
        validator.validate(jwt, options).await?.holder().cloned()
    };
    Ok(holder.map(|holder| holder.to_string()))
}

let resolver = Resolver::builder().with(DidKey::default()).build();
let _validator = JwtPresentationValidator::new(resolver, DefaultVerifier);

Implementations§

Source§

impl<R: KeyResolver, V: JwsVerifier> JwtPresentationValidator<R, V>

Source

pub fn new(resolver: R, verifier: V) -> Self

A validator resolving keys with resolver and verifying signatures with verifier, without a status check.

Source

pub fn from_credential_validator( credentials: JwtCredentialValidator<R, V>, ) -> Self

A validator over credentials, sharing its resolver, verifier and status check.

Source

pub fn with_status_check(self, check: impl StatusCheck + 'static) -> Self

This validator checking credentialStatus with check.

Source

pub fn credential_validator(&self) -> &JwtCredentialValidator<R, V>

The credential validator.

Source

pub async fn validate( &self, jwt: &Jwt, options: &PresentationValidationOptions, ) -> Result<DecodedPresentation, PresentationValidationError>

Validates a presentation JWT and every credential it carries.

§Errors

A PresentationValidationError naming what failed: the presentation (in which case no credential was validated), or the credentials that failed, all of them under FailFast::AllErrors.

Source

pub async fn validate_v2( &self, jwt: &Jwt, options: &PresentationValidationOptions, ) -> Result<DecodedPresentationV2, PresentationValidationError>

Validates a VCDM 2.0 presentation JWT secured with VC-JOSE-COSE and every credential it envelopes.

The checks are those of validate, with the profile’s own shape: typ, when present, is vp+jwt (or one of options.additional_typ); the payload is the presentation, with iss and jti agreeing with holder and id and no vp claim; the holder, from holder or else iss, is required and owns the signing key (KeyReference::binds_to). Each credential is unwrapped from its EnvelopedVerifiableCredential and validated under options.credentials: an application/vc+jwt one with JwtCredentialValidator::validate_v2; with the sd-jwt feature, an application/vc+sd-jwt one as SdJwtCredentialValidator::validate_v2 of sd_jwt_vc does, with its credentialStatus entries and its status claim checked by this validator’s StatusCheck and the key binding of options.key_binding required when set (none by default: the presentation JWT already proves holder control). An envelope of another media type (a COSE credential) fails for that credential alone.

§Errors

As validate.

Trait Implementations§

Source§

impl<R: Debug, V: Debug> Debug for JwtPresentationValidator<R, V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more