Struct ProofConfiguration

pub struct ProofConfiguration<S: CryptographicSuite> {
    pub context: Option<Context>,
    pub type_: S,
    pub created: Option<Lexical<DateTimeStamp>>,
    pub verification_method: ReferenceOrOwned<S::VerificationMethod>,
    pub proof_purpose: ProofPurpose,
    pub expires: Option<Lexical<DateTimeStamp>>,
    pub domains: Vec<String>,
    pub challenge: Option<String>,
    pub nonce: Option<String>,
    pub options: S::ProofOptions,
    pub extra_properties: BTreeMap<String, Value>,
}

Proof configuration.

Proof object without the signature value.

Fields

context: Option<Context>

type_: S

Proof type.

created: Option<Lexical<DateTimeStamp>>

Date a creation of the proof.

verification_method: ReferenceOrOwned<S::VerificationMethod>

Verification method.

proof_purpose: ProofPurpose

Purpose of the proof.

expires: Option<Lexical<DateTimeStamp>>

Specifies when the proof expires.

domains: Vec<String>

Conveys one or more security domains in which the proof is meant to be used.

A verifier SHOULD use the value to ensure that the proof was intended to be used in the security domain in which the verifier is operating. The specification of the domain parameter is useful in challenge-response protocols where the verifier is operating from within a security domain known to the creator of the proof.

Example domain values include: domain.example`` (DNS domain), https://domain.example:8443(Web origin),mycorp-intranet(bespoke text string), andb31d37d4-dd59-47d3-9dd8-c973da43b63a` (UUID).

challenge: Option<String>

Used to mitigate replay attacks.

Used once for a particular domain and window of time. Examples of a challenge value include: 1235abcd6789, 79d34551-ae81-44ae-823b-6dadbab9ebd4, and ruby.

nonce: Option<String>

Arbitrary string supplied by the proof creator.

One use of this field is to increase privacy by decreasing linkability that is the result of deterministically generated signatures.

options: S::ProofOptions

Additional proof options required by the cryptographic suite.

For instance, tezos cryptosuites requires the public key associated with the verification method, which is a blockchain account id.

extra_properties: BTreeMap<String, Value>

Extra properties.

Implementations

impl<S: CryptographicSuite> ProofConfiguration<S>

pub fn new( type_: S, created: Lexical<DateTimeStamp>, verification_method: ReferenceOrOwned<S::VerificationMethod>, proof_purpose: ProofPurpose, options: S::ProofOptions, ) -> Self

pub fn from_method_and_options( type_: S, verification_method: ReferenceOrOwned<S::VerificationMethod>, options: S::ProofOptions, ) -> Self

pub fn from_method( type_: S, verification_method: ReferenceOrOwned<S::VerificationMethod>, ) -> Self

where S::ProofOptions: Default,

pub fn into_suite_and_options( self, ) -> (S, ProofOptions<S::VerificationMethod, S::ProofOptions>)

pub fn into_options( self, ) -> ProofOptions<S::VerificationMethod, S::ProofOptions>

pub fn into_proof(self, signature: S::Signature) -> Proof<S>

pub fn map<T: CryptographicSuite>( self, map_type: impl FnOnce(S) -> T, map_verification_method: impl FnOnce(S::VerificationMethod) -> T::VerificationMethod, map_options: impl FnOnce(S::ProofOptions) -> T::ProofOptions, ) -> ProofConfiguration<T>

pub fn borrowed(&self) -> ProofConfigurationRef<'_, S>

Trait Implementations

impl<S: Clone + CryptographicSuite> Clone for ProofConfiguration<S>

where S::VerificationMethod: Clone, S::ProofOptions: Clone,

fn clone(&self) -> ProofConfiguration<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + CryptographicSuite> Debug for ProofConfiguration<S>

where S::VerificationMethod: Debug, S::ProofOptions: Debug,

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

Formats the value using the given formatter.

impl<'de, T: DeserializeCryptographicSuite<'de>> Deserialize<'de> for ProofConfiguration<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> Serialize for ProofConfiguration<S>

where S: SerializeCryptographicSuite + CryptographicSuite,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.