Struct Presentation 

#[non_exhaustive]
pub struct Presentation {
    pub context: Context,
    pub id: Option<Uri>,
    pub types: OneOrMany<String>,
    pub verifiable_credential: Vec<Jwt>,
    pub holder: Option<Party>,
    pub properties: IndexMap<String, Value>,
}

Available on crate feature vc only.

A verifiable presentation of the Verifiable Credentials Data Model 1.1 whose credentials are JWTs, as data.

Deserialization checks that the first @context is the base context and type includes VerifiablePresentation. A presentation is secured by signing its JWT form, see to_jwt_claims; the holder signs it, so the holder is the iss.

Examples

use identity_kit::did::{Did, Uri};
use identity_kit::vc::{Jwt, Presentation};

let credential: Jwt = "eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc.\
    hgyY0il_MGCjP0JzlnLWG1PPOt7-09PGcvMg3AIbQR6dWbhijcNR4ki4iylGjg5BhVsPt9g7sVvpAr_MuM0KAg"
    .parse()?;
let presentation = Presentation::new()
    .with_id(Uri::parse("urn:uuid:3978344f-8596-4c3a-a978-8fcaba3903c5")?)
    .with_holder(Did::parse("did:example:ebfeb1f712ebc6f1c276e12ec21")?)
    .with_credential(credential);

let claims = presentation.to_jwt_claims()?.with_aud("did:example:4a57546973436f6f6c4a4a57573");
assert_eq!(claims.iss.as_deref(), Some("did:example:ebfeb1f712ebc6f1c276e12ec21"));
assert_eq!(claims.jti.as_deref(), Some("urn:uuid:3978344f-8596-4c3a-a978-8fcaba3903c5"));
assert_eq!(claims.additional["vp"]["verifiableCredential"].as_array().map(Vec::len), Some(1));
assert_eq!(Presentation::from_jwt_claims(&claims)?, presentation);

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.

context: Context

@context, starting with Presentation::CONTEXT.

id: Option<Uri>

The identifier of the presentation.

types: OneOrMany<String>

type, including Presentation::TYPE.

verifiable_credential: Vec<Jwt>

The presented credentials, as JWTs.

holder: Option<Party>

The holder presenting the credentials.

properties: IndexMap<String, Value>

Every other property, in insertion order.

Implementations

impl Presentation

pub fn serialize<__S>( __self: &Presentation, __serializer: __S, ) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

impl<'de> Presentation

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

where __D: Deserializer<'de>,

impl Presentation

pub const CONTEXT: &'static str = CONTEXT_V1

The base context, https://www.w3.org/2018/credentials/v1.

pub const TYPE: &'static str = "VerifiablePresentation"

The type every presentation has, VerifiablePresentation.

pub fn new() -> Self

An empty presentation of type VerifiablePresentation in the base context.

pub fn with_context(self, context: impl Into<String>) -> Self

This presentation with context appended to its @context.

pub fn with_id(self, id: impl Into<Uri>) -> Self

This presentation with its id set.

pub fn with_type(self, presentation_type: impl Into<String>) -> Self

This presentation with presentation_type appended to its type.

pub fn with_holder(self, holder: impl Into<Party>) -> Self

This presentation with its holder set.

pub fn with_credential(self, credential: Jwt) -> Self

This presentation with credential added.

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

This presentation with the property name set to value.

pub fn has_type(&self, presentation_type: &str) -> bool

Whether presentation_type is among the types.

pub fn check(&self) -> Result<(), CredentialError>

Checks that the first @context is the base context and type includes VerifiablePresentation.

Errors

The first CredentialError found.

pub fn to_jwt_claims(&self) -> Result<JwtClaims, CredentialError>

The JWT claims set of the presentation (VCDM 1.1 §6.3.1 “JWT Encoding”): iss is the holder, jti the id, and the presentation without those properties is the vp claim. aud, nbf, exp and nonce are the caller’s to add.

Errors

What check reports.

pub fn from_jwt_claims(jwt_claims: &JwtClaims) -> Result<Self, CredentialError>

The presentation of a JWT claims set (VCDM 1.1 §6.3.1 “JWT Decoding”): the vp claim with iss and jti mapped back to holder and id.

Errors

As Credential::from_jwt_claims, for vp.

Trait Implementations

impl Clone for Presentation

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 Presentation

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

Formats the value using the given formatter.

impl Default for Presentation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Presentation

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

Reads the presentation and checks it with Presentation::check.

impl Eq for Presentation

impl PartialEq for Presentation

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for Presentation

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for Presentation

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Presentation

impl ToSchema for Presentation

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.