Struct GetCertsState

struct GetCertsState<R: Runtime> {
    cache_usage: CacheUsage,
    consensus_source: DocSource,
    consensus: GetCertsConsensus,
    consensus_meta: ConsensusMeta,
    missing_certs: HashSet<AuthCertKeyIds>,
    certs: Vec<AuthCert>,
    rt: R,
    config: Arc<DirMgrConfig>,
    prev_netdir: Option<Arc<dyn PreviousNetDir>>,
    protocol_statuses: Option<(SystemTime, Arc<ProtoStatuses>)>,
    filter: Arc<dyn DirFilter>,
}

Second state: fetching or loading authority certificates.

TODO: we should probably do what C tor does, and try to use the same directory that gave us the consensus.

TODO SECURITY: This needs better handling for the DOS attack where we are given a bad consensus signed with fictional certificates that we can never find.

Fields

cache_usage: CacheUsage

The cache usage we had in mind when we began. Used to reset.

consensus_source: DocSource

Where did we get our consensus?

consensus: GetCertsConsensus

The consensus that we are trying to validate, or an error if we’ve given up on validating it.

consensus_meta: ConsensusMeta

Metadata for the consensus.

missing_certs: HashSet<AuthCertKeyIds>

A set of the certificate keypairs for the certificates we don’t have yet.

certs: Vec<AuthCert>

A list of the certificates we’ve been able to load or download.

rt: R

A Runtime implementation.

config: Arc<DirMgrConfig>

The configuration of the directory manager. Used for download configuration purposes.

prev_netdir: Option<Arc<dyn PreviousNetDir>>

If one exists, the netdir we’re trying to update.

protocol_statuses: Option<(SystemTime, Arc<ProtoStatuses>)>

If present a set of protocols to install as our latest recommended set.

filter: Arc<dyn DirFilter>

Available on crate feature dirfilter only.

A filter that gets applied to directory objects before we use them.

Implementations

impl<R: Runtime> GetCertsState<R>

fn check_parsed_certificate<'s>( &self, parsed: Result<UncheckedAuthCert>, source: &DocSource, within: &'s str, ) -> Result<(AuthCert, &'s str)>

Handle a certificate result returned by tor_netdoc: checking it for timeliness and well-signedness.

On success return the AuthCert and the string that represents it within the string within. On failure, return an error.

fn try_checking_sigs(&mut self) -> Result<()>

If we have enough certificates, and we have not yet checked the signatures on the consensus, try checking them.

If the consensus is valid, remove the unvalidated consensus from self and put the validated consensus there instead.

If the consensus is invalid, throw it out set a blocking error.

Trait Implementations

impl<R: Clone + Runtime> Clone for GetCertsState<R>

fn clone(&self) -> GetCertsState<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Runtime> Debug for GetCertsState<R>

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

Formats the value using the given formatter.

impl<R: Runtime> DirState for GetCertsState<R>

fn describe(&self) -> String

Return a human-readable description of this state.

fn missing_docs(&self) -> Vec<DocId>

Return a list of the documents we’re missing.

fn is_ready(&self, _ready: Readiness) -> bool

Describe whether this state has reached ready status.

fn can_advance(&self) -> bool

Return true if this state can advance to another state via its advance method.

fn bootstrap_progress(&self) -> DirProgress

Return a summary of this state as a DirProgress.

fn dl_config(&self) -> DownloadSchedule

Return a configuration for attempting downloads.

fn add_from_cache( &mut self, docs: HashMap<DocId, DocumentText>, changed: &mut bool, ) -> Result<()>

Add one or more documents from our cache; returns ‘true’ if there was any change in this state.

fn add_from_download( &mut self, text: &str, request: &ClientRequest, source: DocSource, storage: Option<&Mutex<Box<dyn Store>>>, changed: &mut bool, ) -> Result<()>

Add information that we have just downloaded to this state.

fn advance(self: Box<Self>) -> Box<dyn DirState>

If possible, advance to the next state.

fn get_netdir_change(&mut self) -> Option<NetDirChange<'_>>

If the state object wants to make changes to the currently running NetDir, return the proposed changes.

fn reset_time(&self) -> Option<SystemTime>

Return a time (if any) when downloaders should stop attempting to advance this state, and should instead reset it and start over.

fn reset(self: Box<Self>) -> Box<dyn DirState>

Reset this state and start over.