History

Ian Jackson 42df88d6bf Run maint/add_warning to add lint block everywhere		2023-08-23 10:34:00 +01:00
..
src	Run maint/add_warning to add lint block everywhere	2023-08-23 10:34:00 +01:00
Cargo.toml	Upgrade num_enum dependency to 0.7	2023-08-21 13:47:08 -04:00
README.md	…
semver.md	tor-netdir: Deprecate hs_dirs().	2023-08-22 15:47:47 +01: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