History

Nick Mathewson 039601f179 tor-netdir: Add a by_id_pair() function to look up a relay by both IDs.		2021-09-16 10:19:35 -04:00
..
src	tor-netdir: Add a by_id_pair() function to look up a relay by both IDs.	2021-09-16 10:19:35 -04:00
Cargo.toml	Use derive_builder for Authority and FallbackDir.	2021-09-10 10:03:33 -04:00
README.md	Move all crates into a `crates` subdirectory.	2021-08-27 09:53:09 -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 network 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