Expand description
§tor-linkspec
Descriptions of Tor relays, as used to connect to them.
§Overview
The tor-linkspec crate provides traits and data structures that
describe how to connect to Tor relays.
When describing the location of a Tor relay on the network, the
Tor protocol uses a set of “link specifiers”, each of which
corresponds to a single aspect of the relay’s location or
identity—such as its IP address and port, its Ed25519 identity
key, its (legacy) RSA identity fingerprint, or so on. This
crate’s LinkSpec type encodes these structures.
When a client is building a circuit through the Tor network, it
needs to know certain information about the relays in that
circuit. This crate’s ChanTarget and CircTarget traits
represent objects that describe a relay on the network that a
client can use as the first hop, or as any hop, in a circuit.
This crate is part of Arti, a project to implement Tor in Rust. Several other crates in Arti depend on it. You will probably not need this crate yourself unless you are interacting with the Tor protocol at a fairly low level.
tor-linkspec is a separate crate so that it can be used by other
crates that expose link specifiers and by crates that consume
them.
§Future work
TODO: Possibly we should rename this crate. “Linkspec” is a pretty esoteric term in the Tor protocols.
TODO: Possibly the link specifiers and the *Target traits belong in different crates.
§Compile-time features
-
pt-client– Build with enhanced data types to support pluggable transports. -
full– Build with all the features above.
§Experimental and unstable features
Note that the APIs enabled by these features are NOT covered by semantic versioning1 guarantees: we might break them or remove them between patch versions.
experimental– Build with all experimental features above. (Currently, there are no experimental features in this crate, but there may be in the future.)
License: MIT OR Apache-2.0
Remember, semantic versioning is what makes various
cargofeatures work reliably. To be explicit: if you wantcargo updateto only make safe changes, then you cannot enable these features. ↩
Re-exports§
pub use ids::RelayId;pub use ids::RelayIdError;pub use ids::RelayIdRef;pub use ids::RelayIdType;pub use ids::RelayIdTypeIter;pub use ids::by_id::ByRelayIds;pub use ids::by_id::ListByRelayIds;pub use ids::by_id::ListByRelayIdsIter;pub use ids::set::RelayIdSet;pub use ls::EncodedLinkSpec;pub use ls::LinkSpec;pub use ls::LinkSpecType;pub use owned::IntoOwnedChanTarget;pub use owned::LoggedChanTarget;pub use owned::OwnedChanTarget;pub use owned::OwnedChanTargetBuilder;pub use owned::OwnedCircTarget;pub use owned::OwnedCircTargetBuilder;pub use owned::RelayIds;pub use owned::RelayIdsBuilder;pub use traits::ChanTarget;pub use traits::CircTarget;pub use traits::DirectChanMethodsHelper;pub use traits::HasAddrs;pub use traits::HasChanMethod;pub use traits::HasRelayIds;pub use traits::HasRelayIdsLegacy;pub use transport::BridgeAddr;pub use transport::BridgeAddrError;pub use transport::ChannelMethod;pub use transport::TransportId;pub use transport::TransportIdError;pub use transport::PtTarget;pub use transport::PtTargetAddr;pub use transport::PtTargetInvalidSetting;pub use transport::PtTargetSettings;pub use transport::PtTransportName;
Modules§
- decode
- Analyze a list of link specifiers as a
OwnedChanTarget. - ids 🔒
- Code to abstract over the notion of relays having one or more identities.
- ls 🔒
- Link specifier objects
- owned 🔒
- Owned variants of
ChanTargetandCircTarget. - traits 🔒
- Declare traits to be implemented by types that describe a place that Tor can connect to, directly or indirectly.
- transport 🔒
- Support for identifying a particular transport.
- verbatim
- Wrappers for using a CircTarget with a verbatim list of link specifiers.
Enums§
- ByRelay
IdsError - An error returned from an operation on an
n_key_set. - List
ByRelay IdsError - An error returned from an operation on an
n_key_list.