aboutsummaryrefslogtreecommitdiff
path: root/spec/srv-spec/specification-spec.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/srv-spec/specification-spec.md')
-rw-r--r--spec/srv-spec/specification-spec.md34
1 files changed, 17 insertions, 17 deletions
diff --git a/spec/srv-spec/specification-spec.md b/spec/srv-spec/specification-spec.md
index 8a35d22..63ffaff 100644
--- a/spec/srv-spec/specification-spec.md
+++ b/spec/srv-spec/specification-spec.md
@@ -1,6 +1,6 @@
<a id="srv-spec.txt-4"></a>
-# Specification [SPEC]
+# Specification \[SPEC\]
<a id="srv-spec.txt-4.1"></a>
@@ -20,7 +20,7 @@ in their votes to announce that they take part in the protocol.
<a id="srv-spec.txt-4.1.1"></a>
-### Computing commitments and reveals [COMMITREVEAL]
+### Computing commitments and reveals \[COMMITREVEAL\]
A directory authority that wants to participate in this protocol needs to
create a new pair of commitment/reveal values for every protocol
@@ -48,7 +48,7 @@ REVEAL = base64-encode( TIMESTAMP || H(RN) )
<a id="srv-spec.txt-4.1.2"></a>
-### Validating commitments and reveals [VALIDATEVALUES]
+### Validating commitments and reveals \[VALIDATEVALUES\]
Given a COMMIT message and a REVEAL message it should be possible to verify
that they indeed correspond. To do so, the client extracts the random value
@@ -64,17 +64,17 @@ correspond to commit values published during the Commitment Phase.
<a id="srv-spec.txt-4.1.4"></a>
-### Encoding commit/reveal values in votes [COMMITVOTE]
+### Encoding commit/reveal values in votes \[COMMITVOTE\]
An authority puts in its vote the commitments and reveals it has produced and
seen from the other authorities. To do so, it includes the following in its
votes:
-"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
where VERSION is the version of the protocol the commit was created with.
IDENTITY is the authority's SHA1 identity fingerprint and COMMIT is the
-encoded commit [COMMITREVEAL]. Authorities during the reveal phase can
+encoded commit \[COMMITREVEAL\]. Authorities during the reveal phase can
also optionally include an encoded reveal value REVEAL. There MUST be only
one line per authority else the vote is considered invalid. Finally, the
ALGNAME is the hash algorithm that should be used to compute COMMIT and
@@ -82,7 +82,7 @@ REVEAL which is "sha3-256" for version 1.
<a id="srv-spec.txt-4.1.5"></a>
-### Shared Random Value [SRVOTE]
+### Shared Random Value \[SRVOTE\]
Authorities include a shared random value (SRV) in their votes using the
following encoding for the previous and current value respectively:
@@ -93,7 +93,7 @@ following encoding for the previous and current value respectively:
```
where VALUE is the actual shared random value encoded in hex (computed as
-specified in section [SRCALC]. NUM_REVEALS is the number of reveal values
+specified in section \[SRCALC\]. NUM_REVEALS is the number of reveal values
used to generate this SRV.
To maintain consistent ordering, the shared random values of the previous
@@ -101,14 +101,14 @@ period should be listed before the values of the current period.
<a id="srv-spec.txt-4.2"></a>
-## Encoding Shared Random Values in the consensus [SRCONSENSUS]
+## Encoding Shared Random Values in the consensus \[SRCONSENSUS\]
Authorities insert the two active shared random values in the consensus
-following the same encoding format as in [SRVOTE].
+following the same encoding format as in \[SRVOTE\].
<a id="srv-spec.txt-4.3"></a>
-## Persistent state format [STATEFORMAT]
+## Persistent state format \[STATEFORMAT\]
As a way to keep ground truth state in this protocol, an authority MUST
keep a persistent state of the protocol. The next sub-section suggest a
@@ -122,13 +122,13 @@ the order given here:
"Version" SP version NL
-[At start, exactly once.]
+\[At start, exactly once.\]
A document format version. For this specification, version is "1".
"ValidUntil" SP YYYY-MM-DD SP HH:MM:SS NL
-[Exactly once]
+\[Exactly once\]
```text
After this time, this state is expired and shouldn't be used nor
@@ -139,11 +139,11 @@ A document format version. For this specification, version is "1".
The following details the commitment and reveal section. They are encoded
the same as in the vote. This makes it easier for implementation purposes.
-"Commit" SP version SP algname SP identity SP commit [SP reveal] NL
+"Commit" SP version SP algname SP identity SP commit \[SP reveal\] NL
-[Exactly once per authority]
+\[Exactly once per authority\]
-The values are the same as detailed in section [COMMITVOTE].
+The values are the same as detailed in section \[COMMITVOTE\].
This line is also used by an authority to store its own value.
@@ -151,7 +151,7 @@ Finally is the shared random value section.
"SharedRandPreviousValue" SP num_reveals SP value NL
-[At most once]
+\[At most once\]
```text
This is the previous shared random value agreed on at the previous