diff options
Diffstat (limited to 'spec/dir-spec/vote-consensus-status-document-formats.md')
| -rw-r--r-- | spec/dir-spec/vote-consensus-status-document-formats.md | 94 |
1 files changed, 47 insertions, 47 deletions
diff --git a/spec/dir-spec/vote-consensus-status-document-formats.md b/spec/dir-spec/vote-consensus-status-document-formats.md index 379cd8f..6fe5637 100644 --- a/spec/dir-spec/vote-consensus-status-document-formats.md +++ b/spec/dir-spec/vote-consensus-status-document-formats.md @@ -23,21 +23,21 @@ order given here: "network-status-version" SP version NL -[At start, exactly once.] +\[At start, exactly once.\] A document format version. For this specification, the version is "3". "vote-status" SP type NL -[Exactly once.] +\[Exactly once.\] The status MUST be "vote" or "consensus", depending on the type of the document. "consensus-methods" SP IntegerList NL -[At most once for votes; does not occur in consensuses.] +\[At most once for votes; does not occur in consensuses.\] A space-separated list of supported methods for generating consensuses from votes. See section 3.8.1 for details. Absence of @@ -45,8 +45,8 @@ the line means that only method "1" is supported. "consensus-method" SP Integer NL -[At most once for consensuses; does not occur in votes.] -[No extra arguments] +\[At most once for consensuses; does not occur in votes.\] +\[No extra arguments\] See section 3.8.1 for details. @@ -55,13 +55,13 @@ later.) "published" SP YYYY-MM-DD SP HH:MM:SS NL -[Exactly once for votes; does not occur in consensuses.] +\[Exactly once for votes; does not occur in consensuses.\] The publication time for this status document (if a vote). "valid-after" SP YYYY-MM-DD SP HH:MM:SS NL -[Exactly once.] +\[Exactly once.\] The start of the Interval for this vote. Before this time, the consensus document produced from this vote is not officially in @@ -75,7 +75,7 @@ See section 1.4 for voting timeline information. "fresh-until" SP YYYY-MM-DD SP HH:MM:SS NL -[Exactly once.] +\[Exactly once.\] The time at which the next consensus should be produced; before this time, there is no point in downloading another consensus, since there @@ -83,7 +83,7 @@ won't be a new one. See section 1.4 for voting timeline information. "valid-until" SP YYYY-MM-DD SP HH:MM:SS NL -[Exactly once.] +\[Exactly once.\] The end of the Interval for this vote. After this time, all clients should try to find a more recent consensus. See section 1.4 @@ -95,7 +95,7 @@ downloaded. "voting-delay" SP VoteSeconds SP DistSeconds NL -[Exactly once.] +\[Exactly once.\] VoteSeconds is the number of seconds that we will allow to collect votes from all authorities; DistSeconds is the number of seconds @@ -104,7 +104,7 @@ section 1.4 for voting timeline information. "client-versions" SP VersionList NL -[At most once.] +\[At most once.\] A comma-separated list of recommended Tor versions for client usage, in ascending order. The versions are given as defined by @@ -113,7 +113,7 @@ versions. "server-versions" SP VersionList NL -[At most once.] +\[At most once.\] A comma-separated list of recommended Tor versions for relay usage, in ascending order. The versions are given as defined by @@ -122,7 +122,7 @@ versions. "package" SP PackageName SP Version SP URL SP DIGESTS NL -[Any number of times.] +\[Any number of times.\] For this element: @@ -150,7 +150,7 @@ did not include this; method 34 removed it. "known-flags" SP FlagList NL -[Exactly once.] +\[Exactly once.\] A space-separated list of all of the flags that this document might contain. A flag is "known" either because the authority @@ -160,7 +160,7 @@ opinion to have been formed about their status. "flag-thresholds" SP Thresholds NL -[At most once for votes; does not occur in consensuses.] +\[At most once for votes; does not occur in consensuses.\] ```text A space-separated list of the internal performance thresholds @@ -209,7 +209,7 @@ opinion to have been formed about their status. "required-client-protocols" SP Entries NL "required-relay-protocols" SP Entries NL -[At most once for each.] +\[At most once for each.\] The "proto" element as specified in section 2.1.1. @@ -225,9 +225,9 @@ the Tor code. The tor-spec.txt section 9 details how a relay and a client should behave when they encounter these lines in the consensus. -"params" SP [Parameters] NL +"params" SP \[Parameters\] NL -[At most once] +\[At most once\] Parameter ::= Keyword '=' Int32 Int32 ::= A decimal integer between -2147483648 and 2147483647. @@ -244,7 +244,7 @@ See param-spec.txt for a list of parameters and their meanings. "shared-rand-previous-value" SP NumReveals SP Value NL -[At most once] +\[At most once\] NumReveals ::= An integer greater or equal to 0. Value ::= Base64-encoded-data @@ -254,8 +254,8 @@ shared randomness protocol run. For example, if this document was created on the 5th of November, this field carries the shared random value generated during the protocol run of the 3rd of November. -See section [SRCALC] of srv-spec.txt for instructions on how to compute -this value, and see section [CONS] for why we include old shared random +See section \[SRCALC\] of srv-spec.txt for instructions on how to compute +this value, and see section \[CONS\] for why we include old shared random values in votes and consensus. Value is the actual shared random value encoded in base64. It will @@ -264,7 +264,7 @@ to generate this SRV. "shared-rand-current-value" SP NumReveals SP Value NL -[At most once] +\[At most once\] NumReveals ::= An integer greater or equal to 0. Value ::= Base64-encoded-data @@ -274,7 +274,7 @@ randomness protocol run. For example, if this document was created on the 5th of November, this field carries the shared random value generated during the protocol run of the 4th of November -See section [SRCALC] of srv-spec.txt for instructions on how to compute +See section \[SRCALC\] of srv-spec.txt for instructions on how to compute this value given the active commits. Value is the actual shared random value encoded in base64. It will @@ -283,7 +283,7 @@ generate this SRV. "bandwidth-file-headers" SP KeyValues NL -[At most once for votes; does not occur in consensuses.] +\[At most once for votes; does not occur in consensuses.\] KeyValues ::= "" | KeyValue | KeyValues SP KeyValue KeyValue ::= Keyword '=' Value @@ -301,9 +301,9 @@ fails, this line SHOULD appear in its vote, but without any headers. First-appeared: Tor 0.3.5.1-alpha. -"bandwidth-file-digest" 1*(SP algorithm "=" digest) NL +"bandwidth-file-digest" 1\*(SP algorithm "=" digest) NL -[At most once for votes; does not occur in consensuses.] +\[At most once for votes; does not occur in consensuses.\] A digest of the bandwidth file used to generate this vote. "algorithm" is the name of the hash algorithm producing "digest", @@ -340,7 +340,7 @@ connections. "contact" SP string NL -[Exactly once] +\[Exactly once\] An arbitrary string describing how to contact the directory server's administrator. Administrators should include at least an @@ -348,7 +348,7 @@ email address and a PGP fingerprint. "legacy-dir-key" SP FINGERPRINT NL -[At most once] +\[At most once\] Lists a fingerprint for an obsolete _identity_ key still used by this authority to keep older clients working. This option @@ -360,24 +360,24 @@ Debian OpenSSL RNG bug of May 2008.) "shared-rand-participate" NL -[At most once] +\[At most once\] Denotes that the directory authority supports and can participate in the shared random protocol. -"shared-rand-commit" SP Version SP AlgName SP Identity SP Commit [SP Reveal] NL +"shared-rand-commit" SP Version SP AlgName SP Identity SP Commit \[SP Reveal\] NL -[Any number of times] +\[Any number of times\] Version ::= An integer greater or equal to 0. -AlgName ::= 1*(ALPHA / DIGIT / "_" / "-") -Identity ::= 40* HEXDIG +AlgName ::= 1\*(ALPHA / DIGIT / "\_" / "-") +Identity ::= 40\* HEXDIG Commit ::= Base64-encoded-data Reveal ::= Base64-encoded-data Denotes a directory authority commit for the shared randomness protocol, containing the commitment value and potentially also the -reveal value. See sections [COMMITREVEAL] and [VALIDATEVALUES] of +reveal value. See sections \[COMMITREVEAL\] and \[VALIDATEVALUES\] of srv-spec.txt on how to generate and validate these values. Version is the current shared randomness protocol version. AlgName is @@ -391,13 +391,13 @@ receiver MUST only consider the first commit listed. "shared-rand-previous-value" SP NumReveals SP Value NL -[At most once] +\[At most once\] See shared-rand-previous-value description above. "shared-rand-current-value" SP NumReveals SP Value NL -[At most once] +\[At most once\] See shared-rand-current-value description above. @@ -461,7 +461,7 @@ in non-vote documents. "a" SP address ":" port NL -[Any number] +\[Any number\] The first advertised IPv6 address for the OR, if it is reachable. @@ -477,7 +477,7 @@ consensus-method 14 or later.) "s" SP Flags NL -[Exactly once.] +\[Exactly once.\] A series of space-separated status flags, in lexical order (as ASCII byte strings). Currently documented flags are: @@ -535,7 +535,7 @@ long. "pr" SP Entries NL -[At most once.] +\[At most once.\] The "proto" family element as specified in section 2.1.1. @@ -546,9 +546,9 @@ in section D. They are included in the consensus using the same rules as currently used for "v" lines, if a sufficiently late consensus method is in use. -"w" SP "Bandwidth=" INT [SP "Measured=" INT] [SP "Unmeasured=1"] NL +"w" SP "Bandwidth=" INT \[SP "Measured=" INT\] \[SP "Unmeasured=1"\] NL -[At most once.] +\[At most once.\] An estimate of the bandwidth of this relay, in an arbitrary unit (currently kilobytes per second). Used to weight router @@ -572,7 +572,7 @@ Clients MUST ignore keywords they do not recognize. "p" SP ("accept" / "reject") SP PortList NL -[At most once.] +\[At most once.\] PortList = PortOrRange PortList = PortList "," PortOrRange @@ -582,9 +582,9 @@ A list of those ports that this router supports (if 'accept') or does not support (if 'reject') for exit to "most addresses". -"m" SP methods 1*(SP algorithm "=" digest) NL +"m" SP methods 1\*(SP algorithm "=" digest) NL -[Any number, only in votes.] +\[Any number, only in votes.\] Microdescriptor hashes for all consensus methods that an authority supports and that use the same microdescriptor format. "methods" @@ -606,7 +606,7 @@ the router's microdescriptor with trailing =s omitted. ``` KeyValue ::= Keyword '=' Number -Number ::= [0-9]+("."[0-9]+)? +Number ::= \[0-9\]+("."\[0-9\]+)? KeyValues ::= KeyValue | KeyValues SP KeyValue Line containing various statistics that an authority has computed for @@ -625,7 +625,7 @@ The footer section is delineated in all votes and consensuses supporting consensus method 9 and above with the following: "directory-footer" NL -[No extra arguments] +\[No extra arguments\] It contains two subsections, a bandwidths-weights line and a directory-signature. (Prior to consensus method 9, footers only contained @@ -635,7 +635,7 @@ bandwidth-weights.) The bandwidths-weights line appears At Most Once for a consensus. It does not appear in votes. -"bandwidth-weights" [SP Weights] NL +"bandwidth-weights" \[SP Weights\] NL Weight ::= Keyword '=' Int32 Int32 ::= A decimal integer between -2147483648 and 2147483647. |