History

Nick Mathewson 592d6bf8a3 Bump the patch version of each crate with _trivial_ changes. These crates have not had changes to their behavior; as such it is not necessary to bump their dependencies to require the new versions.		2023-02-01 10:10:36 -05:00
..
src	Allow clippy::unchecked_duration_subtraction in tests	2023-01-27 08:28:02 -05:00
Cargo.toml	Bump the patch version of each crate with _trivial_ changes.	2023-02-01 10:10:36 -05:00
README.md	Update README.md files (automated).	2022-05-06 09:51:11 -04:00

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