Expand description
§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 NetDirs 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
Re-exports§
pub(crate) use hsdir_ring::HsDirRing;🔒pub(crate) use std::iter;🔒pub(crate) use rand::seq::IndexedRandom as _;🔒pub(crate) use rand::seq::SliceRandom as _;🔒pub(crate) use rand::seq::WeightError;🔒pub use err::Error;pub use weight::WeightRole;pub use err::OnionDirLookupError;pub use err::VerbatimCircTargetDecodeError;pub(crate) use params::NetParameters;🔒pub use hsdir_params::HsDirParams;pub(crate) use async_trait::async_trait;🔒pub(crate) use itertools::chain;🔒pub(crate) use itertools::chain;🔒pub(crate) use tor_error::warn_report;🔒pub(crate) use tor_linkspec::OwnedCircTarget;🔒pub(crate) use ChanTarget;🔒pub(crate) use DirectChanMethodsHelper;🔒pub(crate) use HasAddrs;🔒pub(crate) use HasRelayIds;🔒pub(crate) use RelayIdRef;🔒pub(crate) use RelayIdType;🔒pub(crate) use tor_llcrypto as ll;🔒pub(crate) use ed25519::Ed25519Identity;🔒pub(crate) use rsa::RsaIdentity;🔒pub(crate) use MdDigest;🔒pub(crate) use MicrodescAndHash;🔒pub(crate) use netstatus;🔒pub(crate) use MdConsensus;🔒pub(crate) use MdRouterStatus;🔒pub(crate) use std::iter;🔒pub(crate) use From;🔒pub(crate) use Into;🔒pub(crate) use StreamExt;🔒pub(crate) use stream::BoxStream;🔒pub(crate) use IntoPrimitive;🔒pub(crate) use TryFromPrimitive;🔒pub(crate) use TryFromPrimitive;🔒pub(crate) use WeightError;🔒pub(crate) use serde::Deserialize;🔒pub(crate) use serde::Deserialize;🔒pub(crate) use std::collections::HashMap;🔒pub(crate) use std::net::IpAddr;🔒pub(crate) use std::ops::Deref;🔒pub(crate) use std::sync::Arc;🔒pub(crate) use std::time::SystemTime;🔒pub(crate) use EnumCount;🔒pub(crate) use EnumCount;🔒pub(crate) use EnumIter;🔒pub(crate) use tracing::warn;🔒pub(crate) use TiSlice;🔒pub(crate) use TiVec;🔒pub(crate) use itertools::Itertools;🔒pub(crate) use std::collections::HashSet;🔒pub(crate) use std::result::Result as StdResult;🔒pub(crate) use Bug;🔒pub(crate) use internal;🔒pub(crate) use pk::HsBlindId;🔒pub(crate) use time::TimePeriod;🔒pub(crate) use OwnedChanTargetBuilder;🔒pub(crate) use verbatim::VerbatimLinkSpecCircTarget;🔒pub(crate) use tor_llcrypto::pk::curve25519;🔒pub(crate) use CountryCode;🔒pub(crate) use GeoipDb;🔒pub(crate) use HasCountryCode;🔒
Modules§
- details
- Functionality for exposing details about a relay that most users should avoid.
- err 🔒
- Declare error type for tor-netdir
- hsdir_
params 🔒 - Compute which time period and shared random value from a consensus to use at any given time.
- hsdir_
ring 🔒 - Functions and type for implementing the onion service directory ring.
- params
- Implements a usable view of Tor network parameters.
- testnet
- Support for unit tests, in this crate and elsewhere.
- testprovider
- A testing implementation of
NetDirProvider. - weight 🔒
- Functions for applying the correct weights to relays when choosing a relay at random.
Structs§
- DirEvent
Iter - An iterator over the variants of DirEvent
- Family
Rules - Configuration for which listed family information to use when deciding whether relays belong to the same family.
- HsDirs 🔒
- Collection of hidden service directories (or parameters for them)
- NetDir
- A view of the Tor directory, suitable for use in building circuits.
- Netdir
Provider Shutdown - The network directory provider is shutting down without giving us the netdir we asked for.
- Partial
NetDir - A partially build NetDir – it can’t be unwrapped until it has enough information to build safe paths.
- Relay
- A view of a relay on the Tor network, suitable for building circuits.
- Relay
Weight - An opaque type representing the weight with which a relay or set of relays will be selected for a given role.
- Router
Status 🔒Idx - Index into the consensus relays
- Subnet
Config - Configuration for determining when two relays have addresses “too close” in the network.
- Unchecked
Relay - A relay that we haven’t checked for validity or usability in routing.
Enums§
- DirEvent
- An event that a
NetDirProvidercan broadcast to indicate that a change in the status of its directory. - HsDirOp
- An operation for which we might be requesting a hidden service directory.
- Relay
Lookup Error - An error value returned from
NetDir::by_ids_detailed. - Timeliness
- How “timely” must a network directory be?
Traits§
- Consensus
Relays 🔒 - Extension trait to provide index-type-safe
.c_relays()method - MdReceiver
- A partial or full network directory that we can download microdescriptors for.
- NetDir
Provider - An object that can provide
NetDirs, as well as inform consumers when they might have changed. - Upcast
ArcNet DirProvider - Helper trait: allows any
Arc<X>to be upcast to aArc<dyn NetDirProvider>if X is an implementation or supertrait of NetDirProvider.
Type Aliases§
- Result
- A Result using the Error type from the tor-netdir crate