Skip to main content

DataIntegrityProof

Struct DataIntegrityProof 

Source
#[non_exhaustive]
pub struct DataIntegrityProof { pub type_: String, pub cryptosuite: CryptoSuite, pub created: Option<String>, pub verification_method: String, pub proof_purpose: String, pub proof_value: Option<String>, pub nonce: Option<String>, pub context: Option<Vec<String>>, }
Expand description

Serialized Data Integrity proof.

#[non_exhaustive]: produce via DataIntegrityProof::sign or DataIntegrityProof::new rather than a struct literal. Fields stay public for reads.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§type_: String

Must be ‘DataIntegrityProof’

§cryptosuite: CryptoSuite§created: Option<String>§verification_method: String§proof_purpose: String§proof_value: Option<String>§nonce: Option<String>

The proof’s nonce (VC Data Integrity §2.1), an optional value the proof creator supplies to reduce linkability between signatures.

It carries no verification semantics of its own, but it is part of the proof configuration, and every cryptosuite hashes the proof configuration. Without this field serde dropped a producer’s nonce on deserialize, so verify re-hashed a configuration the producer never signed and rejected a valid proof as signature invalid. Producers that set one — affinidi-ssi-dart does on every proof — could not be verified here at all.

This crate’s own signer does not set it.

§context: Option<Vec<String>>

Implementations§

Source§

impl DataIntegrityProof

Source

pub async fn sign_multi<S>( data_doc: &S, signers: &[&dyn Signer], options: SignOptions, ) -> Result<Vec<DataIntegrityProof>, DataIntegrityError>
where S: Serialize,

Signs data_doc with every signer in signers, producing one DataIntegrityProof per signer.

Fail-fast: if any signer errors, no proofs are emitted and the error is returned immediately.

All signers share the same SignOptions — the per-signer cryptosuite still defaults via Signer::cryptosuite, so a heterogeneous list of signers (Ed25519 + ML-DSA-44) produces one proof per suite automatically.

Source§

impl DataIntegrityProof

Source

pub fn new( cryptosuite: CryptoSuite, verification_method: String, proof_purpose: String, proof_value: Option<String>, created: Option<String>, context: Option<Vec<String>>, ) -> Self

Assemble a Data Integrity proof from its parts. type_ is fixed to "DataIntegrityProof". Most callers should use DataIntegrityProof::sign; this is for reconstructing a proof from known components (e.g. tests or custom flows).

Source

pub async fn sign<S>( data_doc: &S, signer: &dyn Signer, options: SignOptions, ) -> Result<DataIntegrityProof, DataIntegrityError>
where S: Serialize,

Produces a Data Integrity proof over data_doc.

The cryptosuite is picked from SignOptions::cryptosuite if set, otherwise from Signer::cryptosuite. Canonicalization (JCS or RDFC) is derived from the suite.

Source

pub fn verify_with_public_key<S>( &self, data_doc: &S, public_key_bytes: &[u8], options: VerifyOptions, ) -> Result<(), DataIntegrityError>
where S: Serialize,

Verifies a proof against data_doc using caller-provided public key bytes.

Sync because this is pure CPU — callers who already have the key should not be forced into an async runtime. See verify for the resolver-based async variant.

Source

pub async fn verify<S, R>( &self, data_doc: &S, resolver: &R, options: VerifyOptions, ) -> Result<(), DataIntegrityError>

Verifies a proof by resolving the public key from its verificationMethod via a VerificationMethodResolver.

Use did_vm::DidKeyResolver for did:key: URIs (no I/O); plug in a custom resolver for did:web, did:webvh, or any other method. The library also checks that the resolved key’s KeyType matches the proof’s cryptosuite — a cheap guard against “right proof, wrong key” class bugs.

Async because typical resolvers perform I/O (HTTP, cache lookups, HSM introspection).

Trait Implementations§

Source§

impl Clone for DataIntegrityProof

Source§

fn clone(&self) -> DataIntegrityProof

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DataIntegrityProof

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DataIntegrityProof

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DataIntegrityProof

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more