Struct LinkedPresentationBuilder 

#[non_exhaustive]
pub struct LinkedPresentationBuilder {
    pub holder: Did,
    pub id: Option<Uri>,
    pub credentials: Vec<Jwt>,
    pub issued_at: DateTime<Utc>,
    pub expiration: Option<DateTime<Utc>>,
}

Available on crate feature linked-vp only.

Builds a linked presentation in the JSON Web Token form: a VCDM 1.1 presentation of credential JWTs held by holder, with iss, sub and holder the holder, jti the presentation’s id, iat and nbf the issuance time, exp when an expiration is set, and neither aud nor nonce.

Examples

use chrono::{TimeZone as _, Utc};
use identity_kit::did::{Did, Uri};
use identity_kit::linked_vp::LinkedPresentationBuilder;

let holder = Did::parse("did:example:123")?;
let claims = LinkedPresentationBuilder::new(holder)
    .with_id(Uri::parse("https://bar.example.com/verifiable-presentation.jwt")?)
    .with_issued_at(Utc.with_ymd_and_hms(2024, 2, 8, 17, 38, 46).unwrap())
    .with_expiration(Utc.with_ymd_and_hms(2029, 2, 8, 17, 38, 46).unwrap())
    .jwt_claims()?;
assert_eq!(claims.iss.as_deref(), Some("did:example:123"));
assert_eq!(claims.sub, claims.iss);
assert_eq!((claims.iat, claims.nbf, claims.exp), (Some(1707413926), Some(1707413926), Some(1865266726)));
assert_eq!(claims.jti.as_deref(), Some("https://bar.example.com/verifiable-presentation.jwt"));
assert!(claims.aud.is_none() && !claims.additional.contains_key("nonce"));

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.

holder: Did

The holder: the DID whose document links the presentation.

id: Option<Uri>

The presentation’s id, usually the URL it is published at.

credentials: Vec<Jwt>

The credential JWTs.

issued_at: DateTime<Utc>

iat and nbf.

expiration: Option<DateTime<Utc>>

exp, if the presentation expires.

Implementations

impl LinkedPresentationBuilder

pub fn new(holder: Did) -> Self

A presentation by holder of no credentials, issued now, without id or expiration.

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

This presentation with its id set.

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

This presentation with credential added.

pub fn with_issued_at(self, issued_at: DateTime<Utc>) -> Self

This presentation issued at issued_at.

pub fn with_expiration(self, expiration: DateTime<Utc>) -> Self

This presentation expiring at expiration, which the specification recommends to limit how long a published presentation stays valid.

pub fn presentation(&self) -> Presentation

The presentation.

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

The JWT claims: the presentation’s (iss, jti, vp) with sub, iat, nbf and exp.

Errors

A CredentialError when the presentation does not map to claims; one built here always does.

pub async fn sign( &self, kid: &DidUrl, signer: &dyn Signer, ) -> Result<Jwt, LinkedVpError>

The presentation signed with signer under a header of alg, typ JWT and kid, kid naming a verification method of the holder, which a verifier resolves under authentication.

Errors

LinkedVpError::Validation with ValidationError::HolderMismatch when kid is not a key of the holder, or with ValidationError::Jws when signing fails.

Trait Implementations

impl Clone for LinkedPresentationBuilder

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 LinkedPresentationBuilder

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

Formats the value using the given formatter.

impl Eq for LinkedPresentationBuilder

impl PartialEq for LinkedPresentationBuilder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinkedPresentationBuilder