aboutsummaryrefslogtreecommitdiff
path: root/spec/dir-spec/directory-cache-operation.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-13 18:00:42 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-13 18:00:42 -0400
commitf79272ef1f774b3788b74a3fe4fef75095dfae06 (patch)
tree8f47bebaa06c444f632bf8c4afbd793c4972a27d /spec/dir-spec/directory-cache-operation.md
parentfa014ec90411fd754dd257d04afa1a953e15bf31 (diff)
downloadtorspec-f79272ef1f774b3788b74a3fe4fef75095dfae06.tar.gz
torspec-f79272ef1f774b3788b74a3fe4fef75095dfae06.zip
Run markdownlint --fix on spec.
Diffstat (limited to 'spec/dir-spec/directory-cache-operation.md')
-rw-r--r--spec/dir-spec/directory-cache-operation.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/spec/dir-spec/directory-cache-operation.md b/spec/dir-spec/directory-cache-operation.md
index ed14fc2..1aa3f4b 100644
--- a/spec/dir-spec/directory-cache-operation.md
+++ b/spec/dir-spec/directory-cache-operation.md
@@ -1,9 +1,11 @@
<a id="dir-spec.txt-4"></a>
+
# Directory cache operation
All directory caches implement this section, except as noted.
<a id="dir-spec.txt-4.1"></a>
+
## Downloading consensus status documents from directory authorities
All directory caches try to keep a recent
@@ -33,6 +35,7 @@ length. Caches serve all consensus flavors from the same locations as
the directory authorities.
<a id="dir-spec.txt-4.2"></a>
+
## Downloading server descriptors from directory authorities
Periodically (currently, every 10 seconds), directory caches check
@@ -57,6 +60,7 @@ descriptor seemed newest.)
[XXXX define recent]
<a id="dir-spec.txt-4.3"></a>
+
## Downloading microdescriptors from directory authorities
Directory mirrors should fetch, cache, and serve each microdescriptor
@@ -80,6 +84,7 @@ the fetch URL or the hashes from the consensus, respectively).
can be retrieved in a single request.)
<a id="dir-spec.txt-4.4"></a>
+
## Downloading extra-info documents from directory authorities
Any cache that chooses to cache extra-info documents should implement this
@@ -93,6 +98,7 @@ documents are missing. Caches download from authorities. We follow the
same splitting and back-off rules as in section 4.2.
<a id="dir-spec.txt-4.5"></a>
+
## Consensus diffs
Instead of downloading an entire consensus, clients may download
@@ -105,6 +111,7 @@ record of older consensuses.
advertised with the DirCache protocol version "2" or later.)
<a id="dir-spec.txt-4.5.1"></a>
+
### Consensus diff format
Consensus diffs are formatted as follows:
@@ -126,7 +133,8 @@ ToDigest in a limited subset of the ed diff format, as specified
in appendix E.
<a id="dir-spec.txt-4.5.2"></a>
-### Serving and requesting diffs.
+
+### Serving and requesting diffs
When downloading the current consensus, a client may include an
HTTP header of the form
@@ -153,7 +161,7 @@ FPRLIST is +-separated list of recognized authority identity
fingerprints as in appendix B.
<a id="dir-spec.txt-4.6"></a>
+
## Retrying failed downloads
See section 5.5 below; it applies to caches as well as clients.
-