Struct SdJwtVcBuilder

pub struct SdJwtVcBuilder<H = Sha256Hasher> { /* private fields */ }

A structure to ease the creation of an SdJwtVc.

Implementations

impl SdJwtVcBuilder

pub fn new<T: Serialize>(object: T) -> Result<Self>

Creates a new SdJwtVcBuilder using object JSON representation and default sha-256 hasher.

impl<H: Hasher> SdJwtVcBuilder<H>

pub fn new_with_hasher<T: Serialize>(object: T, hasher: H) -> Result<Self>

Creates a new SdJwtVcBuilder using object JSON representation and a given hasher hasher.

pub fn new_from_credential( credential: Credential, hasher: H, ) -> Result<Self, Error>

Creates a new SdJwtVcBuilder starting from a Credential that is converted to a JWT claim set.

pub fn make_concealable(self, path: &str) -> Result<Self>

Substitutes a value with the digest of its disclosure.

Notes

• path indicates the pointer to the value that will be concealed using the syntax of JSON pointer.

Example

use serde_json::json;  
use identity_credential::sd_jwt_vc::SdJwtVcBuilder;

let obj = json!({
  "id": "did:value",
  "claim1": {
     "abc": true
  },
  "claim2": ["val_1", "val_2"]
});
let builder = SdJwtVcBuilder::new(obj)
  .unwrap()
  .make_concealable("/id").unwrap() //conceals "id": "did:value"
  .make_concealable("/claim1/abc").unwrap() //"abc": true
  .make_concealable("/claim2/0").unwrap(); //conceals "val_1"

pub fn header(self, header: JsonObject) -> Self

Sets the JWT header.

Notes

• if SdJwtVcBuilder::header is not called, the default header is used: json { "typ": "sd-jwt", "alg": "<algorithm used in SdJwtBuilder::finish>" }
• alg is always replaced with the value passed to SdJwtVcBuilder::finish.

pub fn add_decoys(self, path: &str, number_of_decoys: usize) -> Result<Self>

Adds a decoy digest to the specified path.

path indicates the pointer to the value that will be concealed using the syntax of JSON pointer.

Use path = “” to add decoys to the top level.

pub fn require_key_binding(self, key_bind: RequiredKeyBinding) -> Self

Require a proof of possession of a given key from the holder.

This operation adds a JWT confirmation (cnf) claim as specified in RFC8300.

pub fn iss(self, issuer: Url) -> Self

Inserts an iss claim. See super::SdJwtVcClaims::iss.

pub fn nbf(self, nbf: Timestamp) -> Self

Inserts a nbf claim. See super::SdJwtVcClaims::nbf.

pub fn exp(self, exp: Timestamp) -> Self

Inserts a exp claim. See super::SdJwtVcClaims::exp.

pub fn iat(self, iat: Timestamp) -> Self

Inserts a iat claim. See super::SdJwtVcClaims::iat.

pub fn vct(self, vct: impl Into<StringOrUrl>) -> Self

Inserts a vct claim. See super::SdJwtVcClaims::vct.

pub fn sub(self, sub: impl Into<StringOrUrl>) -> Self

Inserts a sub claim. See super::SdJwtVcClaims::sub.

pub fn status(self, status: Status) -> Self

Inserts a status claim. See super::SdJwtVcClaims::status.

pub async fn finish<S>(self, signer: &S, alg: &str) -> Result<SdJwtVc>

where S: JwsSigner,

Creates an SdJwtVc with the provided data.

Trait Implementations

impl<H: Debug> Debug for SdJwtVcBuilder<H>

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

Formats the value using the given formatter.

impl Default for SdJwtVcBuilder

fn default() -> Self

Returns the “default value” for a type.