September 2021 - tor-commits - lists.torproject.org

[torspec/main] version-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit 6c02a45c8d5b7dc673f7f0fb4cf58e0bef393716 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Mon Aug 23 19:32:06 2021 +0300 version-spec: Add 'Table of contents' --- version-spec.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/version-spec.txt b/version-spec.txt index 63782b6..615f6f2 100644 --- a/version-spec.txt +++ b/version-spec.txt @@ -1,6 +1,12 @@ HOW TOR VERSION NUMBERS WORK +Table of Contents + + 1. The Old Way + 2. The New Way + 3. Version status. + 1. The Old Way Before 0.1.0, versions were of the format:

1 0

[torspec/main] path-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit 8f906ed1c5d009e7c5180dbffef111f983dda097 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Mon Aug 23 19:30:36 2021 +0300 path-spec: Add 'Table of contents' --- path-spec.txt | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/path-spec.txt b/path-spec.txt index 90c4d96..b1c9fde 100644 --- a/path-spec.txt +++ b/path-spec.txt @@ -19,6 +19,48 @@ of their choices. "OPTIONAL" in this document are to be interpreted as described in RFC 2119. +Tables of Contents + + 1. General operation + 1.1. Terminology + 1.2. A relay's bandwidth + 2. Building circuits + 2.1. When we build + 2.1.0. We don't build circuits until we have enough directory info + 2.1.1. Clients build circuits preemptively + 2.1.2. Clients build circuits on demand + 2.1.3. Relays build circuits for testing reachability and bandwidth + 2.1.4. Hidden-service circuits + 2.1.5. Rate limiting of failed circuits + 2.1.6. When to tear down circuits + 2.2. Path selection and constraints + 2.2.1. Choosing an exit + 2.2.2. User configuration + 2.3. Cannibalizing circuits + 2.4. Learning when to give up ("timeout") on circuit construction + 2.4.1 Distribution choice and parameter estimation + 2.4.2. How much data to record + 2.4.3. How to record timeouts + 2.4.4. Detecting Changing Network Conditions + 2.4.5. Consensus parameters governing behavior + 2.4.6. Consensus parameters governing behavior + 2.5. Handling failure + 3. Attaching streams to circuits + 4. Hidden-service related circuits + 5. Guard nodes + 5.1. How consensus bandwidth weights factor into entry guard selection + 6. Server descriptor purposes + 7. Detecting route manipulation by Guard nodes (Path Bias) + 7.1. Measuring path construction success rates + 7.2. Measuring path usage success rates + 7.3. Scaling success counts + 7.4. Parametrization + 7.5. Known barriers to enforcement + X. Old notes + X.1. Do we actually do this? + X.2. A thing we could do to deal with reachability. + X.3. Some stuff that worries me about entry guards. 2006 Jun, Nickm. + 1. General operation Tor begins building circuits as soon as it has enough directory

1 0

[torspec/main] tor-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit fc55af27004ba1fc45fdb9196f1655806ca932f9 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Mon Aug 23 19:31:32 2021 +0300 tor-spec: Add 'Table of contents' --- tor-spec.txt | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/tor-spec.txt b/tor-spec.txt index de95acb..4b2c7f2 100644 --- a/tor-spec.txt +++ b/tor-spec.txt @@ -4,6 +4,77 @@ Roger Dingledine Nick Mathewson +Table of Contents + + 0. Preliminaries + 0.1. Notation and encoding + 0.2. Security parameters + 0.3. Ciphers + 0.4. A bad hybrid encryption algorithm, for legacy purposes + 1. System overview + 1.1. Keys and names + 2. Connections + 2.1. Picking TLS ciphersuites + 2.2. TLS security considerations + 3. Cell Packet format + 4. Negotiating and initializing connections + 4.1. Negotiating versions with VERSIONS cells + 4.2. CERTS cells + 4.3. AUTH_CHALLENGE cells + 4.4. AUTHENTICATE cells + 4.4.1. Link authentication type 1: RSA-SHA256-TLSSecret + 4.4.2. Link authentication type 3: Ed25519-SHA256-RFC5705 + 4.5. NETINFO cells + 5. Circuit management + 5.1. CREATE and CREATED cells + 5.1.1. Choosing circuit IDs in create cells + 5.1.2. EXTEND and EXTENDED cells + 5.1.3. The "TAP" handshake + 5.1.4. The "ntor" handshake + 5.1.5. CREATE_FAST/CREATED_FAST cells + 5.2. Setting circuit keys + 5.2.1. KDF-TOR + 5.2.2. KDF-RFC5869 + 5.3. Creating circuits + 5.3.1. Canonical connections + 5.4. Tearing down circuits + 5.5. Routing relay cells + 5.5.1. Circuit ID Checks + 5.5.2. Forward Direction + 5.5.2.1. Routing from the Origin + 5.5.2.2. Relaying Forward at Onion Routers + 5.5.3. Backward Direction + 5.5.3.1. Relaying Backward at Onion Routers + 5.5.4. Routing to the Origin + 5.6. Handling relay_early cells + 6. Application connections and stream management + 6.1. Relay cells + 6.2. Opening streams and transferring data + 6.2.1. Opening a directory stream + 6.3. Closing streams + 6.4. Remote hostname lookup + 7. Flow control + 7.1. Link throttling + 7.2. Link padding + 7.3. Circuit-level flow control + 7.3.1. SENDME Cell Format + 7.4. Stream-level flow control + 8. Handling resource exhaustion + 8.1. Memory exhaustion + 9. Subprotocol versioning + 9.1. "Link" + 9.2. "LinkAuth" + 9.3. "Relay" + 9.4. "HSIntro" + 9.5. "HSRend" + 9.6. "HSDir" + 9.7. "DirCache" + 9.8. "Desc" + 9.9. "Microdesc" + 9.10. "Cons" + 9.11. "Padding" + 9.12. "FlowCtrl" + Note: This document aims to specify Tor as currently implemented, though it may take it a little time to become fully up to date. Future versions of Tor may implement improved protocols, and compatibility is not guaranteed.

1 0

[torspec/main] address-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit 31a4d28693db46cadbf243763c0c95fbedf99608 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Mon Aug 23 19:27:53 2021 +0300 address-spec: Add 'Table of contents' --- address-spec.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/address-spec.txt b/address-spec.txt index 2a6f7db..98e7068 100644 --- a/address-spec.txt +++ b/address-spec.txt @@ -2,6 +2,13 @@ Special Hostnames in Tor Nick Mathewson +Table of Contents + + 1. Overview + 2. .exit + 3. .onion + 4. .noconnect + 1. Overview Most of the time, Tor treats user-specified hostnames as opaque: When

1 0

[torspec/main] socks-extensions: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit 5af83a2afd7a4490d5f1d55ff905a113169b1c7a Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Mon Aug 23 19:31:00 2021 +0300 socks-extensions: Add 'Table of contents' --- socks-extensions.txt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/socks-extensions.txt b/socks-extensions.txt index 5fd1f82..0107856 100644 --- a/socks-extensions.txt +++ b/socks-extensions.txt @@ -1,6 +1,15 @@ Tor's extensions to the SOCKS protocol +Table of Contents + + 1. Overview + 1.1. Extent of support + 2. Name lookup + 3. Other command extensions. + 4. HTTP-resistance + 5. Optimistic data + 1. Overview The SOCKS protocol provides a generic interface for TCP proxies. Client

1 0

[torspec/main] bridgedb-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit 686be04ce55da073a788aa99691c527b4c72203d Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Wed Aug 25 16:26:11 2021 +0300 bridgedb-spec: Add 'Table of contents' --- bridgedb-spec.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/bridgedb-spec.txt b/bridgedb-spec.txt index a4c4708..5ccce92 100644 --- a/bridgedb-spec.txt +++ b/bridgedb-spec.txt @@ -4,6 +4,21 @@ Karsten Loesing Nick Mathewson +Table of Contents + + 0. Preliminaries + 1. Importing bridge network statuses and bridge descriptors + 1.1. Parsing bridge network statuses + 1.2. Parsing bridge descriptors + 1.3. Parsing extra-info documents + 2. Assigning bridges to distributors + 3. Giving out bridges upon requests + 4. Selecting bridges to be given out based on IP addresses + 5. Selecting bridges to be given out based on email addresses + 6. Selecting unallocated bridges to be stored in file buckets + 7. Displaying Bridge Information + 8. Writing bridge assignments for statistics + 0. Preliminaries This document specifies how BridgeDB processes bridge descriptor files

1 0

[torspec/main] cert-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit b5494af92f12291f80b9441e67c4ea0071bb6cd5 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Wed Aug 25 16:31:59 2021 +0300 cert-spec: Add 'Table of contents' --- cert-spec.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/cert-spec.txt b/cert-spec.txt index 08d754d..1782141 100644 --- a/cert-spec.txt +++ b/cert-spec.txt @@ -1,6 +1,21 @@ Ed25519 certificates in Tor +Table of Contents + + 1. Scope and Preliminaries + 1.1. Signing + 1.2. Integer encoding + 2. Document formats + 2.1. Ed25519 Certificates + 2.2. Basic extensions + 2.2.1. Signed-with-ed25519-key extension [type 04] + 2.3. RSA->Ed25519 cross-certificate + A.1. List of certificate types (CERT_TYPE field) + A.2. List of extension types + A.3. List of signature prefixes + A.4. List of certified key types (CERT_KEY_TYPE field) + 1. Scope and Preliminaries This document describes a certificate format that Tor uses for

1 0

[torspec/main] ext-orport-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit e1412094ee00cefcaa9650ee74ddc26f2ea356ce Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Wed Aug 25 16:57:38 2021 +0300 ext-orport-spec: Add 'Table of contents' --- ext-orport-spec.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/ext-orport-spec.txt b/ext-orport-spec.txt index 8008c4f..ec88244 100644 --- a/ext-orport-spec.txt +++ b/ext-orport-spec.txt @@ -1,6 +1,20 @@ Extended ORPort for pluggable transports George Kadianakis, Nick Mathewson +Table of Contents + + 1. Overview + 2. Establishing a connection and authenticating. + 2.1. Authentication type: SAFE_COOKIE + 2.1.2. Cookie-file format + 2.1.3. SAFE_COOKIE Protocol specification + 3. The extended ORPort protocol + 3.1. Protocol + 3.2. Command descriptions + 3.2.1. USERADDR + 3.2.2. TRANSPORT + 4. Security Considerations + 1. Overview This document describes the "Extended ORPort" protocol, a wrapper

1 0

[torspec/main] glossary: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit cd7b43ae4fe6f9dbf865da829aa80ebb2c77e53e Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Wed Sep 22 14:56:40 2021 +0300 glossary: Add 'Table of contents' --- glossary.txt | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/glossary.txt b/glossary.txt index 6debe20..68de376 100644 --- a/glossary.txt +++ b/glossary.txt @@ -11,6 +11,27 @@ This glossary is not a design document; it is only a reference. This glossary is a work-in-progress; double-check its definitions before citing them authoritatively. ;) +Table of Contents + + 0. Preliminaries + 1.0. Commonly used Tor configuration terms + 2.0. Tor network components + 2.1. Relays, aka OR (onion router) + 2.1.1. Specific roles + 2.2. Client, aka OP (onion proxy) + 2.3. Authorities + 2.4. Hidden Service + 2.5. Circuit + 2.6. Edge connection + 2.7. Consensus + 2.8. Descriptor + 3.0. Tor network protocols + 3.1. Link handshake + 3.2. Circuit handshake + 3.3. Hidden Service Protocol + 3.4. Directory Protocol + 4.0. General network definitions + 0. Preliminaries The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL

1 0

[torspec/main] dir-list-spec: Add 'Table of contents'
by dgoulet＠torproject.org 27 Sep '21

27 Sep '21

commit da38430e3da87dda9e8e13ee66d96885ffa40812 Author: Oleh Franchuk <0x00.gear(a)gmail.com> Date: Wed Aug 25 16:41:52 2021 +0300 dir-list-spec: Add 'Table of contents' --- dir-list-spec.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/dir-list-spec.txt b/dir-list-spec.txt index 3557721..c2d83f4 100644 --- a/dir-list-spec.txt +++ b/dir-list-spec.txt @@ -2,6 +2,30 @@ Tor Directory List Format Tim Wilson-Brown (teor) +Table of Contents + + 1. Scope and Preliminaries + 1.1. Format Overview + 1.2. Acknowledgements + 1.3. Format Versions + 1.4. Future Plans + 2. Format Details + 2.1. Nonterminals + 2.2. List Header + 2.2.1. List Header Format + 2.3. List Generation + 2.3.1. List Generation Format + 2.4. Directory Entry + 2.4.1. Directory Entry Format + 3. Usage Considerations + 3.1. Caching + 3.2. Retrieving Directory Information + 3.3. Fallback Reliability + A.1. Sample Data + A.1.1. Sample Fallback List Header + A.1.2. Sample Fallback List Generation + A.1.3. Sample Fallback Entries + 1. Scope and Preliminaries This document describes the format of Tor's directory lists, which are

1 0