aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-12 21:36:21 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-12 21:36:21 -0400
commitc7b1172618fbeadd0d6236a406697e2a99e58af9 (patch)
treeb7bda5e05a6b503b3d9e2cd9a0a67a53bb1df236
parent5c91b7895837105337821ee736a22007110149d4 (diff)
downloadtorspec-c7b1172618fbeadd0d6236a406697e2a99e58af9.tar.gz
torspec-c7b1172618fbeadd0d6236a406697e2a99e58af9.zip
Clean up a section of dirspec that looked like html tags.
-rw-r--r--spec/dir-spec/general-use-http-urls.md67
1 files changed, 34 insertions, 33 deletions
diff --git a/spec/dir-spec/general-use-http-urls.md b/spec/dir-spec/general-use-http-urls.md
index d3c68ad..9cd0a02 100644
--- a/spec/dir-spec/general-use-http-urls.md
+++ b/spec/dir-spec/general-use-http-urls.md
@@ -5,15 +5,15 @@
The most recent v3 consensus should be available at:
-http://<hostname>/tor/status-vote/current/consensus.z
+`http://<hostname>/tor/status-vote/current/consensus.z`
Similarly, the v3 microdescriptor consensus should be available at:
-http://<hostname>/tor/status-vote/current/consensus-microdesc.z
+`http://<hostname>/tor/status-vote/current/consensus-microdesc.z`
Starting with Tor version 0.2.1.1-alpha is also available at:
-http://<hostname>/tor/status-vote/current/consensus/<F1>+<F2>+<F3>.z
+`http://<hostname>/tor/status-vote/current/consensus/<F1>+<F2>+<F3>.z`
(NOTE: Due to squid proxy url limitations at most 96 fingerprints can be
retrieved in a single request.)
@@ -35,42 +35,42 @@ that is known to support this URL format.
A concatenated set of all the current key certificates should be available
at:
-http://<hostname>/tor/keys/all.z
+`http://<hostname>/tor/keys/all.z`
The key certificate for this server should be available at:
-http://<hostname>/tor/keys/authority.z
+`http://<hostname>/tor/keys/authority.z`
The key certificate for an authority whose authority identity fingerprint
-is <F> should be available at:
+is `<F>` should be available at:
-http://<hostname>/tor/keys/fp/<F>.z
+`http://<hostname>/tor/keys/fp/<F>.z`
-The key certificate whose signing key fingerprint is <F> should be
+The key certificate whose signing key fingerprint is `<F>` should be
available at:
-http://<hostname>/tor/keys/sk/<F>.z
+`http://<hostname>/tor/keys/sk/<F>.z`
-The key certificate whose identity key fingerprint is <F> and whose signing
-key fingerprint is <S> should be available at:
+The key certificate whose identity key fingerprint is `<F>` and whose signing
+key fingerprint is `<S>` should be available at:
-http://<hostname>/tor/keys/fp-sk/<F>-<S>.z
+`http://<hostname>/tor/keys/fp-sk/<F>-<S>.z`
(As usual, clients may request multiple certificates using:
-http://<hostname>/tor/keys/fp-sk/<F1>-<S1>+<F2>-<S2>.z )
+`http://<hostname>/tor/keys/fp-sk/<F1>-<S1>+<F2>-<S2>.z` )
[The above fp-sk format was not supported before Tor 0.2.1.9-alpha.]
The most recent descriptor for a server whose identity key has a
-fingerprint of <F> should be available at:
+fingerprint of `<F>` should be available at:
-http://<hostname>/tor/server/fp/<F>.z
+`http://<hostname>/tor/server/fp/<F>.z`
The most recent descriptors for servers with identity fingerprints
-<F1>,<F2>,<F3> should be available at:
+`<F1>`, `<F2>`,`<F3>` should be available at:
-http://<hostname>/tor/server/fp/<F1>+<F2>+<F3>.z
+`http://<hostname>/tor/server/fp/<F1>+<F2>+<F3>.z`
(NOTE: Due to squid proxy url limitations at most 96 fingerprints can be
retrieved in a single request.
@@ -80,47 +80,48 @@ fingerprint. This allows a corrupted server (in collusion with a cache) to
provide a unique descriptor to a client, and thereby partition that client
from the rest of the network.)
-The server descriptor with (descriptor) digest <D> (in hex) should be
+The server descriptor with (descriptor) digest `<D>` (in hex) should be
available at:
-http://<hostname>/tor/server/d/<D>.z
+`http://<hostname>/tor/server/d/<D>.z`
-The most recent descriptors with digests <D1>,<D2>,<D3> should be
+The most recent descriptors with digests `<D1>`, `<D2>`, `<D3>` should be
available at:
-http://<hostname>/tor/server/d/<D1>+<D2>+<D3>.z
+`http://<hostname>/tor/server/d/<D1>+<D2>+<D3>.z`
The most recent descriptor for this server should be at:
-http://<hostname>/tor/server/authority.z
+`http://<hostname>/tor/server/authority.z`
This is used for authorities, and also if a server is configured
as a bridge. The official Tor implementations (starting at
0.1.1.x) use this resource to test whether a server's own DirPort
-is reachable. It is also useful for debugging purposes.
+is reachable. It is also useful for debugging purposes.
A concatenated set of the most recent descriptors for all known servers
should be available at:
-http://<hostname>/tor/server/all.z
+`http://<hostname>/tor/server/all.z`
-Extra-info documents are available at the URLS
+Extra-info documents are available at the URLS:
```text
http://<hostname>/tor/extra/d/...
http://<hostname>/tor/extra/fp/...
http://<hostname>/tor/extra/all[.z]
http://<hostname>/tor/extra/authority[.z]
- (As for /tor/server/ URLs: supports fetching extra-info
- documents by their digest, by the fingerprint of their servers,
- or all at once. When serving by fingerprint, we serve the
- extra-info that corresponds to the descriptor we would serve by
- that fingerprint. Only directory authorities of version
- 0.2.0.1-alpha or later are guaranteed to support the first
- three classes of URLs. Caches may support them, and MUST
- support them if they have advertised "caches-extra-info".)
```
+(These work like the `/tor/server/` URLs: they support fetching extra-info
+documents by their digest, by the fingerprint of their servers,
+or all at once. When serving by fingerprint, we serve the
+extra-info that corresponds to the descriptor we would serve by
+that fingerprint. Only directory authorities of version
+0.2.0.1-alpha or later are guaranteed to support the first
+three classes of URLs. Caches may support them, and MUST
+support them if they have advertised "caches-extra-info".)
+
For debugging, directories SHOULD expose non-compressed objects at
URLs like the above, but without the final ".z". If the client uses
Accept-Encodings header, it should override the presence or absence