Struct Integrity 

pub struct Integrity { /* private fields */ }

Available on crate feature sd-jwt only.

Integrity metadata (SD-JWT VC §6, W3C SRI §3): one or more <algorithm>-<base64 digest> expressions separated by whitespace, verified against the octets of the retrieved document with the strongest algorithm this crate supports.

Examples

use identity_kit::sd_jwt_vc::{Integrity, IntegrityAlgorithm};

let document = br#"{"vct":"https://example.com/base-type-metadata"}"#;
let integrity = Integrity::compute(IntegrityAlgorithm::Sha256, document);
assert!(integrity.as_str().starts_with("sha256-"));
assert!(integrity.verify(document).is_ok());
assert!(integrity.verify(b"{}").is_err());

// SD-JWT VC §5.1, Figure 17.
let integrity: Integrity = "sha256-ilOUJsTultOwLfz7QUcFALaRa3BP/jelX1ds04kB9yU=".parse()?;
assert_eq!(integrity.algorithms(), vec![IntegrityAlgorithm::Sha256]);

Implementations

impl Integrity

pub fn parse(metadata: &str) -> Self

Parses metadata, keeping the expressions of the algorithms this crate supports.

pub fn compute(algorithm: IntegrityAlgorithm, document: &[u8]) -> Self

The integrity metadata of document under algorithm.

pub fn as_str(&self) -> &str

The metadata string.

pub fn algorithms(&self) -> Vec<IntegrityAlgorithm>

The supported algorithms the metadata uses, strongest last.

pub fn verify(&self, document: &[u8]) -> Result<(), IntegrityError>

Checks document against the expressions of the strongest supported algorithm.

Errors

IntegrityError::NoSupportedAlgorithm or IntegrityError::Mismatch.

Trait Implementations

impl Clone for Integrity

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 Integrity

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

Formats the value using the given formatter.

impl Display for Integrity

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

Formats the value using the given formatter.

impl Eq for Integrity

impl FromStr for Integrity

type Err = !

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 Integrity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Integrity