Module tor_netdoc::doc

source ·
Expand description

Individual document types that we can parse in Tor’s meta-format.

Right now, we recognize four kinds of documents.

A netstatus::MdConsensus is a multi-signed document that the directory authorities use to tell clients and relays who is on the network. It contains information about each relay, and it links to additional microdescriptors (microdesc::Microdesc) that have more information about each relay.

In order to validate a netstatus::MdConsensus, you need to have the authority certificate (authcert::AuthCert) for the directory authorities that signed it.

Finally, in order to use relays not listed in the consensus (such as bridges), clients use those relays’ self-signed router descriptors (routerdesc::RouterDesc). These router descriptors are also uploaded to the authorities in order to tell them about relays and their status.

All of these formats are described in dir-spec.txt.

§Limitations

Tor recognizes other kinds of documents that this crate doesn’t parse yet. There are “ExtraInfo documents” that encode information about relays that almost nobody needs. Finally, there are the voting documents themselves that authorities use in order to calculate the consensus.

Modules§

  • Parsing implementation for Tor authority certificates
  • hsdeschs-common
    Implementation for onion service descriptors.
  • Parsing implementation for Tor microdescriptors.
  • Parsing implementation for networkstatus documents.
  • routerdescrouterdesc
    A “router descriptor” is a signed statement that a relay makes about itself, explaining its keys, its capabilities, its location, and its status.