History

Nick Mathewson 745c90e92c Enable cargo_common_metadata warning.		2021-05-25 15:42:47 -04:00
..
src	Enable cargo_common_metadata warning.	2021-05-25 15:42:47 -04:00
Cargo.toml	tor-netdir no longer uses caret.	2021-05-25 11:25:19 -04:00
README.md	Add automatically generated README.md files to each crate.	2021-05-25 15:41:23 -04:00

README.md

tor-netdir

Represents a clients'-eye view of the Tor network.

Overview

The tor-netdir crate wraps objects from tor-netdoc, and combines them to provide a unified view of the relays on the network. It is responsible for representing a client's knowledge of the network's state and who is on it.

This crate is part of Arti, a project to implement Tor in Rust. Its purpose is to expose an abstract view of a Tor network and the relays in it, so that higher-level crates don't need to know about the particular documents that describe the network and its properties.

There are two intended users for this crate. First, producers like [tor-dirmgr] create [NetDir] objects fill them with information from the Tor nettwork directory. Later, consumers like [tor-circmgr] use [NetDir]s to select relays for random paths through the Tor network.

Limitations

Only modern consensus methods and microdescriptor consensuses are supported.

License: MIT OR Apache-2.0