Module netstatus 

Parsing implementation for networkstatus documents.

In Tor, a networkstatus documents describes a complete view of the relays in the network: how many there are, how to contact them, and so forth.

A networkstatus document can either be a “votes” – an authority’s view of the network, used as input to the voting process – or a “consensus” – a combined view of the network based on multiple authorities’ votes, and signed by multiple authorities.

A consensus document can itself come in two different flavors: a plain (unflavoured) consensus has references to router descriptors, and a “microdesc”-flavored consensus (“md”) has references to microdescriptors.

To keep an up-to-date view of the network, clients download microdescriptor-flavored consensuses periodically, and then download whatever microdescriptors the consensus lists that the client doesn’t already have.

For full information about the network status format, see dir-spec.txt.

Limitations

NOTE: The consensus format has changes time, using a “consensus-method” mechanism. This module is does not yet handle all all historical consensus-methods.

NOTE: This module does parse some fields that are not in current use, like relay nicknames, and the “published” times on microdescriptors. We should probably decide whether we actually want to do this.

TODO: This module doesn’t implement vote parsing at all yet.

TODO: This module doesn’t implement plain consensuses.

TODO: More testing is needed!

TODO: There should be accessor functions for most of the fields here. As with the other tor-netdoc types, I’m deferring those till I know what they should be.

Re-exports

pub use plain::RouterStatusBuilder as PlainRouterStatusBuilder;plain-consensus

pub use md::RouterStatusBuilder as MdRouterStatusBuilder;

pub use plain::RouterStatus as PlainRouterStatus;plain-consensus

pub use md::RouterStatus as MdRouterStatus;

pub use vote::RouterStatus as VoteRouterStatus;ns-vote

pub use plain::Header as PlainHeader;plain-consensus

pub use md::Header as MdHeader;

pub use vote::Header as VoteHeader;ns-vote

pub use PlainConsensus as NsConsensus;ns_consensus

pub use PlainRouterStatus as NsRouterStatus;ns_consensus

pub use UncheckedPlainConsensus as UncheckedNsConsensus;ns_consensus

pub use UnvalidatedPlainConsensus as UnvalidatedNsConsensus;ns_consensus

Modules

md

Implementation for microdesc consensus documents.

plainplain-consensus

Implementation for plain consensus documents.

votens-vote

Implementation for plain consensus documents.

Structs

ConsensusVoterInfo

All information about a single authority, as represented in a consensus

DirSource

Description of an authority’s identity and address.

Footer

The signed footer of a consensus netstatus.

Lifetime

The lifetime of a networkstatus document.

MdConsensusBuilderbuild_docs

A builder object used to construct a consensus.

NetParams

A set of named network parameters.

PlainConsensusBuilderplain-consensus and build_docs

A builder object used to construct a consensus.

ProtoStatus

A list of subprotocol versions that implementors should/must provide.

ProtoStatuses

A set of recommended and required protocols when running in various scenarios.

RelayFlags

A set of recognized directory flags on a single relay.

SharedRandStatus

A shared-random value produced by the directory authorities, along with meta-information about that value.

SharedRandVal

A shared random value produced by the directory authorities.

Signature

The signature of a single directory authority on a networkstatus document.

SignatureGroup

A collection of signatures that can be checked on a networkstatus document

Enums

ConsensusFlavor

A recognized ‘flavor’ of consensus document.

NetstatusKwd

Keywords that can be used in votes and consensuses.

ProtocolSupportError

A subprotocol that is recommended or required in the consensus was not present.

RelayWeight

Recognized weight fields on a single relay in a consensus

Type Aliases

MdConsensus

A consensus document that lists relays along with their microdescriptor documents.

PlainConsensusplain-consensus

A consensus document that lists relays along with their router descriptor documents.

UncheckedMdConsensus

An MdConsensus that has been parsed but not checked for signatures and timeliness.

UncheckedPlainConsensusplain-consensus

An PlainConsensus that has been parsed but not checked for signatures and timeliness.

UnvalidatedMdConsensus

An MdConsensus that has been parsed and checked for timeliness, but not for signatures.

UnvalidatedPlainConsensusplain-consensus

An PlainConsensus that has been parsed and checked for timeliness, but not for signatures.