b3f989d689
Since our last round of releases, these crates have had either trivial changes, or changes that did not affect their APIs. Therefore we are bumping their versions, but not changing which versions of them other crates depend on. |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
README.md
tor-protover
Implementation of Tor's "subprotocol versioning" feature.
Overview
The Tor system is built out of numerous "subprotocols" that are
versioned more or less independently. The tor-protover crate
implements parsing and handling for these subprotocol versions, so
that different Tor instances know which parts of the protocol
they support.
Subprotocol versions are also used to determine which versions of the protocol are required to connect to the network (or just recommended).
For more details, see tor-spec.txt section 9.
This crate is part of Arti, a project to implement Tor in Rust. It's unlikely to be of general interest unless you are writing a Tor implementation, or a program that needs to examine fine-grained details of the Tor network.
Design notes
We're giving tor-protover its own crate within arti because it
needs to be used to multiple higher level crates that do not
themselves depend on one another. (For example, [tor-proto]
needs to know which variant of a subprotocol can be used with a
given relay, whereas [tor-netdoc] needs to parse lists of
subprotocol versions from directory documents. Eventually,
[arti-client] will need to check its own list of supported
protocols against the required list in the consensus.)
License: MIT OR Apache-2.0