Struct tor_netdoc::doc::netstatus::UnvalidatedConsensus

pub struct UnvalidatedConsensus<RS> { /* private fields */ }

A Microdesc consensus whose signatures have not yet been checked.

To validate this object, call set_n_authorities() on it, then call check_signature() on that result with the set of certs that you have. Make sure only to provide authority certificates representing real authorities!

Implementations

impl<RS> UnvalidatedConsensus<RS>

pub fn set_n_authorities(self, n_authorities: u16) -> Self

Tell the unvalidated consensus how many authorities we believe in.

Without knowing this number, we can’t validate the signature.

pub fn signing_cert_ids(&self) -> impl Iterator<Item = AuthCertKeyIds>

Return an iterator of all the certificate IDs that we might use to validate this consensus.

pub fn peek_lifetime(&self) -> &Lifetime

Return the lifetime of this unvalidated consensus

pub fn authorities_are_correct(&self, authorities: &[&RsaIdentity]) -> bool

Return true if a client who believes in exactly the provided set of authority IDs might might consider this consensus to be well-signed.

(This is the case if the consensus claims to be signed by more than half of the authorities in the list.)

Trait Implementations

impl<RS: Clone> Clone for UnvalidatedConsensus<RS>

fn clone(&self) -> UnvalidatedConsensus<RS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RS: Debug> Debug for UnvalidatedConsensus<RS>

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

Formats the value using the given formatter.

impl<RS> ExternallySigned<Consensus<RS>> for UnvalidatedConsensus<RS>

type Key = [AuthCert]

The type of the public key object.

type KeyHint = Vec<AuthCertKeyIds>

A type that describes what keys are missing for this object.

type Error = Error

An error type that’s returned when the object is not well-signed.

fn key_is_correct(&self, k: &Self::Key) -> Result<(), Self::KeyHint>

Check whether k is the right key for this object. If not, return an error describing what key would be right.

fn is_well_signed(&self, k: &Self::Key) -> Result<(), Self::Error>

Check the signature on this object

fn dangerously_assume_wellsigned(self) -> Consensus<RS>

Unwrap this object without checking any signatures on it.

fn check_signature(self, k: &Self::Key) -> Result<T, Self::Error>

Unwrap this object if it’s correctly signed by a provided key.