Struct SdObjectEncoder

pub struct SdObjectEncoder<H = Sha256Hasher>
where
    H: Hasher,
{ /* private fields */ }

Transforms a JSON object into an SD-JWT object by substituting selected values with their corresponding disclosure digests.

Implementations

impl SdObjectEncoder

pub fn new(object: &str) -> Result<SdObjectEncoder, Error>

Creates a new SdObjectEncoder with sha-256 hash function.

Error

Returns Error::DeserializationError if object is not a valid JSON object.

pub fn try_from_serializable<T>(object: T) -> Result<SdObjectEncoder, Error>

where T: Serialize,

Creates a new SdObjectEncoder with sha-256 hash function from a serializable object.

Error

Returns Error::DeserializationError if object can not be serialized into a valid JSON object.

impl<H> SdObjectEncoder<H>

where H: Hasher,

pub fn with_custom_hasher( object: &str, hasher: H, ) -> Result<SdObjectEncoder<H>, Error>

Creates a new SdObjectEncoder with custom hash function to create digests.

pub fn conceal( &mut self, path: &str, salt: Option<String>, ) -> Result<Disclosure, Error>

Substitutes a value with the digest of its disclosure. If no salt is provided, the disclosure will be created with a random salt value.

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

Example

use sd_jwt_payload::SdObjectEncoder;
use sd_jwt_payload::json;

let obj = json!({
 "id": "did:value",
 "claim1": {
    "abc": true
 },
 "claim2": ["val_1", "val_2"]
});
let mut encoder = SdObjectEncoder::try_from(obj).unwrap();
encoder.conceal("/id", None).unwrap(); //conceals "id": "did:value"
encoder.conceal("/claim1/abc", None).unwrap(); //"abc": true
encoder.conceal("/claim2/0", None).unwrap(); //conceals "val_1"

Error

• Error::InvalidPath if pointer is invalid.
• Error::DataTypeMismatch if existing SD format is invalid.

pub fn add_sd_alg_property(&mut self) -> Option<Value>

Adds the _sd_alg property to the top level of the object. The value is taken from the crate::Hasher::alg_name implementation.

pub fn try_to_string(&self) -> Result<String, Error>

Returns the modified object as a string.

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

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 object(&self) -> Result<&Map<String, Value>, Error>

Returns a reference to the internal object.

pub fn salt_size(&self) -> usize

Returns the used salt length.

pub fn set_salt_size(&mut self, salt_size: usize) -> Result<(), Error>

Sets size of random data used to generate the salts for disclosures in bytes.

Warning

Salt size must be >= 16.

Trait Implementations

impl<H> Clone for SdObjectEncoder<H>

where H: Clone + Hasher,

fn clone(&self) -> SdObjectEncoder<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Debug for SdObjectEncoder<H>

where H: Debug + Hasher,

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

Formats the value using the given formatter.

impl TryFrom<Value> for SdObjectEncoder

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Value, ) -> Result<SdObjectEncoder, <SdObjectEncoder as TryFrom<Value>>::Error>

Performs the conversion.