aboutsummaryrefslogtreecommitdiff
path: root/dir-list-spec.txt
diff options
context:
space:
mode:
authorteor <teor@torproject.org>2019-12-09 16:21:07 +1000
committerteor <teor@torproject.org>2019-12-09 16:31:22 +1000
commit33c70fcd2e724ce7bf8835fbf766f6aee355bb87 (patch)
tree0cd8e4175a69fffffff206f5131cc25bf605a6e1 /dir-list-spec.txt
parent68437951a3f758475d24b872c5b66c6f227b3ae5 (diff)
downloadtorspec-33c70fcd2e724ce7bf8835fbf766f6aee355bb87.tar.gz
torspec-33c70fcd2e724ce7bf8835fbf766f6aee355bb87.zip
dir-list-spec: Modify "source=" line format
* Rename "whitelist" to "offer-list" for 32699. * Add "descriptor" for 24839. * Allow multiple values for the 24839 transition to signed offers in descriptors. Part of 32699 and 24839.
Diffstat (limited to 'dir-list-spec.txt')
-rw-r--r--dir-list-spec.txt30
1 files changed, 22 insertions, 8 deletions
diff --git a/dir-list-spec.txt b/dir-list-spec.txt
index 063fc24..608a683 100644
--- a/dir-list-spec.txt
+++ b/dir-list-spec.txt
@@ -85,6 +85,8 @@
2.1.0 - Adds a source list comment to the header.
+ 3.0.0 - Modifies the format of the source list comment.
+
1.4. Future Plans
Tor also has an auth_dirs.inc file, but it is not yet in this format.
@@ -199,19 +201,31 @@
The current timestamp format is YYYYMMDDHHMMSS, as an integer.
- "/*" SP+ "source=" Keyword SP+ "*/" SP* NL
+ "/*" SP+ "source=" Keyword ("," Keyword)* SP+ "*/" SP* NL
[Zero or one time.]
- The source of the directory entries in the list.
+ A list of the sources of the directory entries in the list.
+
+ As of version 3.0.0, the possible sources are:
+ * "offer-list" - the fallback_offer_list file in the fallback-scripts
+ repository.
+ * "descriptor" - one or more signed descriptors, each containing an
+ "offer-fallback-dir" line. This feature will be
+ implemented in ticket #24839.
+ * "fallback" - a fallback_dirs.inc file from a tor repository.
+ Used in check_existing mode.
+
+ Before #24839 is implemented, the default is "offer-list". During the
+ transition to signed offers, it will be "descriptor,offer-list".
+ Afterwards, it will be "descriptor".
- As of version 2.1.0, the sources are:
- * "whitelist" - the fallback.whitelist file in the fallback-scripts
- repository. This is the default.
- * "fallback" - a fallback_dirs.inc file from a tor repository.
- Used in check_existing mode.
+ In version 2.1.0, only one source name was allowed after "source=",
+ and the deprecated "whitelist" source name was used instead of
+ "offer-list".
- This line was added in version 2.1.0 of this specification.
+ This line was added in version 2.1.0 of this specification. The format
+ of this line was modified in version 3.0.0 of this specification.
"/*" SP+ key_value SP+ "*/" SP* NL