Skip to content

Commit e2e1d84

Browse files
committed
Use RFC 2119 language consistently.
Always use MUST/SHOULD in caps with bold, and avoid those terms outside their RFC 2119 meaning.
1 parent 04fc5ce commit e2e1d84

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

specification.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Parameters:
5858
- etc...
5959

6060
* KEYID is an optional, unauthenticated hint indicating what key was used to
61-
sign the message. It **must not** be used for security decisions.
61+
sign the message. It **MUST NOT** be used for security decisions.
6262

6363
Functions:
6464

@@ -71,7 +71,7 @@ Functions:
7171
le64(n) := 64-bit little-endian encoding of `n`, where 0 <= n < 2^63
7272
```
7373
74-
* Sign() is an arbitrary digital signature format. Details must be agreed upon
74+
* Sign() is an arbitrary digital signature format. Details are agreed upon
7575
out-of-band by the signer and verifier. This specification places no
7676
restriction on the signature algorithm or format.
7777
@@ -103,13 +103,13 @@ To verify:
103103
fails.
104104
105105
Either standard or URL-safe base64 encodings are allowed. Signers may use
106-
either, and verifiers must accept either.
106+
either, and verifiers **MUST** accept either.
107107
108108
### Backwards compatible signatures
109109
110110
To convert existing signatures from the current format to the new format,
111-
`"backwards-compatible-json"` must be added to the payload type URI to indicate
112-
that the signature is over the raw payload. This allows the signatures to remain
111+
`"backwards-compatible-json"` is added to the payload type URI to indicate that
112+
the signature is over the raw payload. This allows the signatures to remain
113113
valid while avoiding the verifier from having to use [Canonical JSON].
114114
115115
```json
@@ -127,7 +127,7 @@ Support for this backwards compatibility mode is optional.
127127

128128
To sign:
129129

130-
- BODY **must** be an object type (`{...}`).
130+
- BODY **MUST** be an object type (`{...}`).
131131
- Serialize BODY as [Canonical JSON]; call this SERIALIZED_BODY.
132132
- Sign SERIALIZED_BODY, base64-encode the result, and store it in `sig`.
133133
- Optionally, compute a KEYID and store it in `keyid`.
@@ -144,14 +144,14 @@ To verify:
144144
decoding or the signature verification fails.
145145
- Parse SERIALIZED_BODY as a JSON object. Reject if the parsing fails or if
146146
the result is not a JSON object. In particular, the first byte of
147-
SERIALIZED_BODY must be `{`. Verifiers **must not** require SERIALIZED_BODY
147+
SERIALIZED_BODY **MUST** be `{`. Verifiers **MUST NOT** require SERIALIZED_BODY
148148
to be Canonical JSON.
149149

150150
Backwards compatible signatures are not recommended because they lack the
151151
authenticated payloadType indicator.
152152

153153
This scheme is safe from rollback attacks because the first byte of
154-
SERIALIZED_BODY must be 0x7b (`{`) in backwards compatibility mode and 0x02 in
154+
SERIALIZED_BODY is be 0x7b (`{`) in backwards compatibility mode and 0x02 in
155155
regular mode.
156156

157157
### Multiple signatures

0 commit comments

Comments
 (0)