Enum HashAlgorithm 

#[non_exhaustive]
pub enum HashAlgorithm {
    Sha256,
    Sha384,
    Sha512,
}

Available on crate feature sd-jwt only.

The hash algorithm an SD-JWT uses for its disclosure digests and its sd_hash, named as in the IANA “Named Information Hash Algorithm” registry (sha-256, the default and the one every implementation must support, sha-384 or sha-512).

Examples

use identity_kit::sd_jwt_vc::HashAlgorithm;

// RFC 9901 §4.2.3: the digest of the `family_name` disclosure.
let disclosure = "WyJfMjZiYzRMVC1hYzZxMktJNmNCVzVlcyIsICJmYW1pbHlfbmFtZSIsICJNw7ZiaXVzIl0";
assert_eq!(
    HashAlgorithm::Sha256.digest(disclosure.as_bytes()),
    "X9yH0Ajrdm1Oij4tWso9UzzKJvPoDxwmuEcO3XAdRC0"
);
assert_eq!("sha-256".parse::<HashAlgorithm>()?, HashAlgorithm::Sha256);
assert!("md5".parse::<HashAlgorithm>().is_err());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sha256

sha-256, the default when _sd_alg is absent.

Sha384

sha-384.

Sha512

sha-512.

Implementations

impl HashAlgorithm

pub const CLAIM: &'static str = "_sd_alg"

The claim carrying the algorithm, _sd_alg.

pub const fn name(self) -> &'static str

The IANA hash name string.

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

The algorithm with the IANA hash name name.

Errors

SdJwtError::UnsupportedHashAlgorithm for any other name.

pub fn digest(self, data: &[u8]) -> String

The base64url-encoded digest of data.

Trait Implementations

impl Clone for HashAlgorithm

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HashAlgorithm

impl Debug for HashAlgorithm

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

Formats the value using the given formatter.

impl Default for HashAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HashAlgorithm

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

Deserialize this value from the given Serde deserializer.

impl Display for HashAlgorithm

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

Formats the value using the given formatter.

impl Eq for HashAlgorithm

impl FromStr for HashAlgorithm

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 Hash for HashAlgorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HashAlgorithm

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HashAlgorithm

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HashAlgorithm