Struct Disclosure 

pub struct Disclosure { /* private fields */ }

Available on crate feature sd-jwt only.

A disclosure: the salt, the claim name (for an object property; an array element has none) and the claim value, base64url-encoded as a JSON array.

A disclosure keeps the encoded string it was parsed from, since the digest is taken over that string and any JSON serialization of the array is as valid as another.

Examples

use identity_kit::sd_jwt_vc::{Disclosure, HashAlgorithm};
use serde_json::json;

// RFC 9901 §4.2.1.
let disclosure: Disclosure =
    "WyJfMjZiYzRMVC1hYzZxMktJNmNCVzVlcyIsICJmYW1pbHlfbmFtZSIsICJNw7ZiaXVzIl0".parse()?;
assert_eq!(disclosure.salt(), "_26bc4LT-ac6q2KI6cBW5es");
assert_eq!(disclosure.name(), Some("family_name"));
assert_eq!(disclosure.value(), &json!("Möbius"));
assert_eq!(
    disclosure.digest(HashAlgorithm::Sha256),
    "X9yH0Ajrdm1Oij4tWso9UzzKJvPoDxwmuEcO3XAdRC0"
);

// RFC 9901 §4.2.2: an array element.
let element: Disclosure = "WyJsa2x4RjVqTVlsR1RQVW92TU5JdkNBIiwgIkZSIl0".parse()?;
assert_eq!(element.name(), None);
assert_eq!(element.value(), &json!("FR"));

Implementations

impl Disclosure

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

A disclosure for the object property name with value, encoded as compact JSON.

pub fn element(salt: impl Into<String>, value: Value) -> Self

A disclosure for the array element value, encoded as compact JSON.

pub fn parse(encoded: &str) -> Result<Self, SdJwtError>

Decodes the base64url string encoded.

Errors

SdJwtError::InvalidDisclosure when the string is not base64url of a JSON array of two elements (a string salt and a value) or three (a string salt, a string name and a value).

pub fn as_str(&self) -> &str

The encoded disclosure, as it travels in an SD-JWT.

pub fn salt(&self) -> &str

The salt.

pub fn name(&self) -> Option<&str>

The claim name; None for an array element.

pub fn value(&self) -> &Value

The claim value.

pub fn is_element(&self) -> bool

Whether this discloses an array element rather than an object property.

pub fn digest(&self, alg: HashAlgorithm) -> String

The digest of the encoded disclosure under alg (RFC 9901 §4.2.3).

Trait Implementations

impl AsRef<str> for Disclosure

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Disclosure

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 Disclosure

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Disclosure

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

Deserialize this value from the given Serde deserializer.

impl Display for Disclosure

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

Formats the value using the given formatter.

impl Eq for Disclosure

impl FromStr for Disclosure

type Err = SdJwtError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Disclosure

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Disclosure

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Disclosure