Skip to main content

WitnessQuorumPolicy

Struct WitnessQuorumPolicy 

Source
#[non_exhaustive]
pub struct WitnessQuorumPolicy { pub trusted_witnesses: BTreeSet<String>, pub pinned_documents: BTreeMap<String, Value>, pub witness: WitnessPolicy, pub enforcement: WitnessEnforcement, }
Expand description

Witness corroboration of the checkpoint carried in log_inclusion (RFC-ACDP-0015 §8).

Cosignatures are read from the retrieval’s top-level witness_signatures member (§6.1). Witness trust is deployment policy, bootstrapped out of band (§13). Only the trusted_witnesses can count toward the quorum. Each witness’s DID document comes from one of two places:

  • pinned_documents, for a direct-from-witness deployment that already holds it (§6.2);
  • otherwise it is resolved: did:web through the verification’s WebResolver (with its SSRF protections), did:key offline.

A witness whose document cannot be obtained does not count, and the reason is recorded in WitnessQuorumReport::failures.

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.
§trusted_witnesses: BTreeSet<String>

Witness DIDs the consumer trusts.

§pinned_documents: BTreeMap<String, Value>

Witness DID documents held out of band, by witness DID. These take precedence over resolution.

§witness: WitnessPolicy

Quorum size, freshness bound and clock skew. Defaults to WitnessPolicy::default: one witness, 300 s, 120 s.

§enforcement: WitnessEnforcement

Whether a shortfall fails verification. Default WitnessEnforcement::Report.

Implementations§

Source§

impl WitnessQuorumPolicy

Source

pub fn new<I, S>(witnesses: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Trust witnesses, with the default quorum (one witness), report-only.

Source

pub fn with_document( self, witness_id: impl Into<String>, document: Value, ) -> Self

Use document for witness_id instead of resolving it.

Source

pub fn with_min_witnesses(self, n: u32) -> Self

Require n distinct trusted witnesses.

Source

pub fn with_witness_policy(self, witness: WitnessPolicy) -> Self

Replace the quorum, freshness and skew settings.

Source

pub fn enforce(self, enforcement: WitnessEnforcement) -> Self

Set when a shortfall fails verification.

Trait Implementations§

Source§

impl Clone for WitnessQuorumPolicy

Source§

fn clone(&self) -> Self

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 WitnessQuorumPolicy

Source§

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

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

impl Eq for WitnessQuorumPolicy

Source§

impl PartialEq for WitnessQuorumPolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WitnessQuorumPolicy

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<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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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