Skip to content

Commit cd70f40

Browse files
committed
proto: Add required/optional and explain PAE.
1 parent 03659e1 commit cd70f40

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

envelope.proto

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,30 @@ package io.intoto;
55
// An authenticated message of arbitrary type.
66
message Envelope {
77
// Message to be signed. (In JSON, this is encoded as base64.)
8+
// REQUIRED.
89
bytes payload = 1;
910

1011
// String unambiguously identifying how to interpret payload.
12+
// REQUIRED.
1113
string payloadType = 2;
1214

1315
// Signature over:
1416
// le64(2) || le64(len(utf8(payloadType))) || utf8(payloadType) ||
1517
// le64(len(payload)) || payload
16-
// At least one signature must be present.
18+
// where:
19+
// le64(n) := 64-bit little-endian encoding of integer `n`, 0 <= n < 2^63
20+
// len(s) := number of octets in byte sequence `s`
21+
// utf8(s) := UTF-8 encoding of unicode string `s`
22+
// REQUIRED (length >= 1).
1723
repeated Signature signatures = 3;
1824
}
1925

2026
message Signature {
2127
// Signature itself. (In JSON, this is encoded as base64.)
28+
// REQUIRED.
2229
bytes sig = 1;
2330

2431
// *Unauthenticated* hint identifying which public key was used.
32+
// OPTIONAL.
2533
string keyid = 2;
2634
}

0 commit comments

Comments
 (0)