Only the Tor Specifications themselves are approved. The Proposals are, by their nature, drafts.
When linking to the Specifications, consider using one of the links advertised in the Table of Permalinks.
The Specifications and Proposals are maintained by the Tor Project in a gitlab repository.
Corrections and clarifications are welcome. To propose a change to the Tor protocol, use the Proposals process
The documents are in Markdown and formatted with mdbook. To build the formatted HTML:
cargo install mdbook git clone https://gitlab.torproject.org/tpo/core/torspec/ cd torspec bin/build_html
The output is then in
There are two mdbook books here:
The Tor Specifications: source code in
specs/, formatted output in
Proposals: source code in
proposals/, formatted output in
Each book's source files are listed,
and the chapter defined,
The format is pretty restrictive;
To edit these specs, clone the
and edit the
appropriate file in the
spec directory. These files will match
the URLs of their corresponding pages, so if you want to edit
you'll be looking for a file
We have started a style guide for writing new parts of this spec; as of 2023 it is quite preliminary. You should feel free to edit it!