unofficial git repo -- report bugs/issues/pull requests on https://gitlab.torproject.org/ -- discuss proposals on tor-dev@lists.torproject
Go to file
2020-08-03 08:36:53 -04:00
attic Move tor-fw-helper-spec.txt to attic. This feature is no longer supported. 2020-07-27 09:56:29 -04:00
proposals Move proposal 309 to "Open" status. 2020-07-31 10:17:08 -04:00
.gitignore Ignore OS X's .DS_Store directory metadata files 2015-10-19 06:28:13 +11:00
.gitlab-ci.yml gitlab-ci: add header/footer blocks to generate complete HTML 2019-12-10 16:06:53 +01:00
address-spec.txt Merge proposal 204 into addr-spec.txt 2017-03-08 11:52:57 -05:00
bandwidth-file-spec.txt Bug 33759: Fix recent_measurements_excluded_few_count key 2020-03-30 13:32:56 +00:00
bridgedb-spec.txt convert text blocks into widely compatible "blockquote" syntax 2019-12-10 16:06:53 +01:00
cert-spec.txt Correct the certificate extension identifier for signed-with-ed25519-key 2020-04-28 10:10:34 -04:00
control-spec.txt Document CONTROLLER_WAIT stream status. 2020-08-03 08:36:53 -04:00
dir-list-spec.txt dir-list: Fix a version typo 2020-03-13 11:22:41 +10:00
dir-spec.txt Merge remote-tracking branch 'jigsaw/remove-padding-fix-7869' 2020-07-23 08:28:28 -04:00
gettor-spec.txt fix erroneous header numbering punctuation 2019-11-26 21:03:19 +01:00
glossary.txt fix erroneous header numbering punctuation 2019-11-26 21:03:19 +01:00
guard-spec.txt including prop310 rational 2020-06-07 19:56:25 +02:00
padding-spec.txt Document relay commands for circpad cells. 2020-07-06 11:32:05 -05:00
path-spec.txt convert text blocks into widely compatible "blockquote" syntax 2019-12-10 16:06:53 +01:00
pt-spec.txt fix erroneous header numbering punctuation 2019-11-26 21:03:19 +01:00
README.md Write a README.md for torspec. 2020-07-27 09:56:06 -04:00
rend-spec-v2.txt convert text blocks into widely compatible "blockquote" syntax 2019-12-10 16:06:53 +01:00
rend-spec-v3.txt rend-spec-v3.txt: Various spec fixes from OBv3 development. 2020-03-04 19:34:19 +02:00
socks-extensions.txt standardize whitespace in the titles 2019-11-26 20:29:12 +01:00
srv-spec.txt convert text blocks into widely compatible "blockquote" syntax 2019-12-10 16:06:53 +01:00
tor-spec.txt Document relay commands for circpad cells. 2020-07-06 11:32:05 -05:00
version-spec.txt resolve singularity for which version used the new version spec 2020-05-16 18:10:17 -04:00

Tor specifications

This repository holds the specifications that describe how Tor works. They try to present Tor's protocols in sufficient detail to allow the reader to implement a compatible implementation of Tor without ever having to read the Tor source code.

The proposals directory holds our design proposals. These include historical documents that have now been merged into . For more information on the proposal process, including an explanation of how to make new proposals, see, see 001-process.txt.

What you can find here

Tor's specification is pretty big, and we've broken it into a bunch of files.

  • General interest
    • tor-spec.txt contains the specification for the core Tor protocol itself; this is a good place to start reading.
    • cert-spec.txt describes a certificate format used in the other parts of the protocol.
    • dir-spec.txt specifies the operations and formats used to maintain a view of the network directory.
    • padding-spec.txt describes a set of padding mechanisms used to impede traffic analysis.
    • version-spec.txt explains how to parse Tor version numbers.
    • glossary.txt is a glossary of terms used in the other specifications.
  • Client operations
    • address-spec.txt lists a set of special addresses that Tor handles differently from the regular DNS system.
    • guard-spec.txt explains the "guard node" algorithm that Tor clients use to avoid sampling attacks.
    • path-spec.txt explains how clients choose their paths through the Tor network.
    • socks-extensions specifies Tor-specific extensions to the SOCKS protocol.
  • Onion services
  • Censorship resistance
    • bridgedb-spec.txt explains how the bridgedb server gives out bridges to censored clients.
    • gettor-spec.txt describes the gettor tool, which is used to download Tor in censored areas.
    • pt-spec.txt describes the protocol that Tor clients and relays use to communicate with pluggable transports used for traffic obfuscation.
  • Directory authorities
    • bandwidth-file-spec.txt specifies the file format used by bandwidth-measuring tools to report their observations to directory authorities.
    • srv-spec.txt specifies the protocol that directory authorities use to securely compute shared random values for the network.
  • Controller protocol
    • control-spec.txt explains the protocol used by controllers to communicate with a running Tor process.
  • Miscellaneous
    • dir-list-spec.txt explains the format used by tools like the fallback directory scripts to output a list of Tor directories for inclusion in the Tor source code.
    • The attic directory has obsolete or historical documents.