aboutsummaryrefslogtreecommitdiff
path: root/spec/dir-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-14 18:52:20 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-14 18:53:18 -0400
commit3457b0720834c8347d8318c1080ebc9486d77300 (patch)
treeb486a3d03fdfae7d98c4e6cf510179cf907c443f /spec/dir-spec
parenta331e9f48790ad4beaba1ee443c5ad8b13d3afb4 (diff)
downloadtorspec-3457b0720834c8347d8318c1080ebc9486d77300.tar.gz
torspec-3457b0720834c8347d8318c1080ebc9486d77300.zip
Add short IDs for most long section names
I've left off sections that are headings for their whole document.
Diffstat (limited to 'spec/dir-spec')
-rw-r--r--spec/dir-spec/client-operation.md29
-rw-r--r--spec/dir-spec/directory-cache-operation.md16
-rw-r--r--spec/dir-spec/outline.md6
-rw-r--r--spec/dir-spec/serving-bandwidth-list-files.md18
4 files changed, 25 insertions, 44 deletions
diff --git a/spec/dir-spec/client-operation.md b/spec/dir-spec/client-operation.md
index 42a5906..a9e6783 100644
--- a/spec/dir-spec/client-operation.md
+++ b/spec/dir-spec/client-operation.md
@@ -7,7 +7,7 @@ not have a DirPort set) implements this section.
<a id="dir-spec.txt-5.1"></a>
-## Downloading network-status documents
+## Downloading network-status documents { #download-ns }
Each client maintains a list of directory authorities. Insofar as
possible, clients SHOULD all use the same list.
@@ -90,7 +90,7 @@ most recent consensus it has if that consensus is "reasonably live". A
<a id="dir-spec.txt-5.2"></a>
-## Downloading server descriptors or microdescriptors
+## Downloading server descriptors or microdescriptors { #download-desc }
Clients try to have the best descriptor for each router. A descriptor is
"best" if:
@@ -164,7 +164,7 @@ for longer or shorter times.
<a id="dir-spec.txt-5.3"></a>
-## Downloading extra-info documents
+## Downloading extra-info documents { #download-extra }
Any client that uses extra-info documents should implement this
section.
@@ -180,7 +180,7 @@ We follow the same splitting and back-off rules as in section 5.2.
<a id="dir-spec.txt-5.4"></a>
-## Using directory information
+## Using directory information { #using-info }
\[XXX This subsection really belongs in path-spec.txt, not here. -KL\]
@@ -191,7 +191,7 @@ above.)
<a id="dir-spec.txt-5.4.1"></a>
-### Choosing routers for circuits
+### Choosing routers for circuits { #choosing-routers }
Circuits SHOULD NOT be built until the client has enough directory
information: a live consensus network status \[XXXX fallback?\] and
@@ -219,25 +219,6 @@ These flags are used as follows:
See the "path-spec.txt" document for more details.
```
-<a id="dir-spec.txt-5.4.2"></a>
-
-### Managing naming
-
-(This section is removed; authorities no longer assign the 'Named' flag.)
-
-<a id="dir-spec.txt-5.4.3"></a>
-
-### Software versions
-
-An implementation of Tor SHOULD warn when it has fetched a consensus
-network-status, and it is running a software version not listed.
-
-<a id="dir-spec.txt-5.4.4"></a>
-
-### Warning about a router's status
-
-(This section is removed; authorities no longer assign the 'Named' flag.)
-
<a id="dir-spec.txt-5.5"></a>
## Retrying failed downloads
diff --git a/spec/dir-spec/directory-cache-operation.md b/spec/dir-spec/directory-cache-operation.md
index 9807857..14f9a9c 100644
--- a/spec/dir-spec/directory-cache-operation.md
+++ b/spec/dir-spec/directory-cache-operation.md
@@ -6,7 +6,7 @@ All directory caches implement this section, except as noted.
<a id="dir-spec.txt-4.1"></a>
-## Downloading consensus status documents from directory authorities
+## Downloading consensus status documents from directory authorities { #download-ns-from-auth }
All directory caches try to keep a recent
network-status consensus document to serve to clients. A cache ALWAYS
@@ -36,7 +36,7 @@ the directory authorities.
<a id="dir-spec.txt-4.2"></a>
-## Downloading server descriptors from directory authorities
+## Downloading server descriptors from directory authorities { #download-desc-from-auth }
Periodically (currently, every 10 seconds), directory caches check
whether there are any specific descriptors that they do not have and that
@@ -61,7 +61,7 @@ descriptor seemed newest.)
<a id="dir-spec.txt-4.3"></a>
-## Downloading microdescriptors from directory authorities
+## Downloading microdescriptors from directory authorities { #download-md-from-auth }
Directory mirrors should fetch, cache, and serve each microdescriptor
from the authorities.
@@ -85,7 +85,7 @@ can be retrieved in a single request.)
<a id="dir-spec.txt-4.4"></a>
-## Downloading extra-info documents from directory authorities
+## Downloading extra-info documents from directory authorities { #download-ei-from-auth }
Any cache that chooses to cache extra-info documents should implement this
section.
@@ -99,7 +99,7 @@ same splitting and back-off rules as in section 4.2.
<a id="dir-spec.txt-4.5"></a>
-## Consensus diffs
+## Consensus diffs { #diffs }
Instead of downloading an entire consensus, clients may download
a "diff" document containing an ed-style diff from a previous
@@ -112,7 +112,7 @@ advertised with the DirCache protocol version "2" or later.)
<a id="dir-spec.txt-4.5.1"></a>
-### Consensus diff format
+### Consensus diff format { #diff-format }
Consensus diffs are formatted as follows:
@@ -134,7 +134,7 @@ in appendix E.
<a id="dir-spec.txt-4.5.2"></a>
-### Serving and requesting diffs
+### Serving and requesting diffs { #diff-requests }
When downloading the current consensus, a client may include an
HTTP header of the form
@@ -162,6 +162,6 @@ fingerprints as in appendix B.
<a id="dir-spec.txt-4.6"></a>
-## Retrying failed downloads
+## Retrying failed downloads { #retry-as-cache }
See section 5.5 below; it applies to caches as well as clients.
diff --git a/spec/dir-spec/outline.md b/spec/dir-spec/outline.md
index e183e33..5d3ed01 100644
--- a/spec/dir-spec/outline.md
+++ b/spec/dir-spec/outline.md
@@ -46,7 +46,7 @@ All directory information is uploaded and downloaded with HTTP.
<a id="dir-spec.txt-1.1"></a>
-## What's different from version 2?
+## What's different from version 2? { #changes-since-v2 }
Clients used to download multiple network status documents,
corresponding roughly to "status votes" above. They would compute the
@@ -61,7 +61,7 @@ main descriptors.
<a id="dir-spec.txt-1.2"></a>
-## Document meta-format
+## Document meta-format { #metaformat }
Server descriptors, directories, and running-routers documents all obey the
following lightweight extensible information format.
@@ -160,7 +160,7 @@ Whenever an item DOES NOT allow extra arguments, we will tag it with
<a id="dir-spec.txt-1.3"></a>
-## Signing documents
+## Signing documents { #signing }
Every signable document below is signed in a similar manner, using a
given "Initial Item", a final "Signature Item", a digest algorithm, and
diff --git a/spec/dir-spec/serving-bandwidth-list-files.md b/spec/dir-spec/serving-bandwidth-list-files.md
index 6b0296b..7397dba 100644
--- a/spec/dir-spec/serving-bandwidth-list-files.md
+++ b/spec/dir-spec/serving-bandwidth-list-files.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.4.3"></a>
-### Serving bandwidth list files
+### Serving bandwidth list files { #serving-bwlist }
If an authority has used a bandwidth list file to generate a vote
document it SHOULD make it available at
@@ -29,13 +29,13 @@ Tor 0.4.0.4-alpha.
<a id="dir-spec.txt-3.5"></a>
-## Downloading missing certificates from other directory authorities
+## Downloading missing certificates from other directory authorities { #download-missing-certs }
XXX when to download certificates.
<a id="dir-spec.txt-3.6"></a>
-## Downloading server descriptors from other directory authorities
+## Downloading server descriptors from other directory authorities { #download-missing-descs }
Periodically (currently, every 10 seconds), directory authorities check
whether there are any specific descriptors that they do not have and that
@@ -71,7 +71,7 @@ immediately reject for reasons listed in section 3.2.
<a id="dir-spec.txt-3.7"></a>
-## Downloading extra-info documents from other directory authorities
+## Downloading extra-info documents from other directory authorities { #download-missing-extrainfo }
Periodically, an authority checks whether it is missing any extra-info
documents: in other words, if it has any server descriptors with an
@@ -82,7 +82,7 @@ as in section 3.6.
<a id="dir-spec.txt-3.8"></a>
-## Computing a consensus from a set of votes
+## Computing a consensus from a set of votes { #computing-consensus }
Given a set of votes, authorities compute the contents of the consensus.
@@ -316,7 +316,7 @@ earlier item.
<a id="dir-spec.txt-3.8.0.1"></a>
-### Deciding which Ids to include
+### Deciding which Ids to include { #choosing-relay-ids }
This sorting algorithm is used for consensus-method 22 and later.
@@ -343,7 +343,7 @@ This sorting algorithm is used for consensus-method 22 and later.
<a id="dir-spec.txt-3.8.0.2"></a>
-#### Deciding which descriptors to include
+#### Deciding which descriptors to include { #choosing-relay-descs }
Deciding which descriptors to include.
@@ -362,7 +362,7 @@ published, and then in favor of the smaller server descriptor digest.
<a id="dir-spec.txt-3.8.1"></a>
-### Forward compatibility
+### Forward compatibility { #consensus-method-list }
Future versions of Tor will need to include new information in the
consensus documents, but it is important that all authorities (or at least
@@ -844,7 +844,7 @@ consensus document.\]
<a id="dir-spec.txt-3.11"></a>
-## Publishing the signed consensus
+## Publishing the signed consensus { #publishing-signed-consensus }
The voting period ends at the valid-after time. If the consensus has
been signed by a majority of authorities, these documents are made