/
sigstore_bundle.proto
141 lines (133 loc) · 7.44 KB
/
sigstore_bundle.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
// Copyright 2022 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package dev.sigstore.bundle.v1;
import "google/api/field_behavior.proto";
// https://raw.githubusercontent.com/secure-systems-lab/dsse/9c813476bd36de70a5738c72e784f123ecea16af/envelope.proto
import "envelope.proto";
import "sigstore_common.proto";
import "sigstore_rekor.proto";
option go_package = "github.com/sigstore/protobuf-specs/gen/pb-go/bundle/v1";
option java_package = "dev.sigstore.proto.bundle.v1";
option java_multiple_files = true;
option java_outer_classname = "BundleProto";
option ruby_package = "Sigstore::Bundle::V1";
// Notes on versioning.
// The primary message ('Bundle') MUST be versioned, by populating the
// 'media_type' field. Semver-ish (only major/minor versions) scheme MUST
// be used. The current version as specified by this file is:
// application/vnd.dev.sigstore.bundle.v0.3+json
// The semantic version is thus '0.3'.
// Various timestamped counter signatures over the artifacts signature.
// Currently only RFC3161 signatures are provided. More formats may be added
// in the future.
message TimestampVerificationData {
// A list of RFC3161 signed timestamps provided by the user.
// This can be used when the entry has not been stored on a
// transparency log, or in conjunction for a stronger trust model.
// Clients MUST verify the hashed message in the message imprint
// against the signature in the bundle.
repeated dev.sigstore.common.v1.RFC3161SignedTimestamp rfc3161_timestamps = 1;
}
// VerificationMaterial captures details on the materials used to verify
// signatures. This message may be embedded in a DSSE envelope as a signature
// extension. Specifically, the `ext` field of the extension will expect this
// message when the signature extension is for Sigstore. This is identified by
// the `kind` field in the extension, which must be set to
// application/vnd.dev.sigstore.verificationmaterial;version=0.1 for Sigstore.
// When used as a DSSE extension, if the `public_key` field is used to indicate
// the key identifier, it MUST match the `keyid` field of the signature the
// extension is attached to.
message VerificationMaterial {
// The key material for verification purposes.
//
// This allows key material to be conveyed in one of three forms:
//
// 1. An unspecified public key identifier, for retrieving a key
// from an out-of-band mechanism (such as a keyring);
//
// 2. A sequence of one or more X.509 certificates, of which the first member
// MUST be a leaf certificate conveying the signing key. Subsequent members
// SHOULD be in issuing order, meaning that `n + 1` should be an issuer for `n`.
//
// Signers MUST NOT include root CA certificates in bundles, and SHOULD NOT
// include intermediate CA certificates that appear in an independent root of trust
// (such as the Public Good Instance's trusted root).
//
// Verifiers MUST validate the chain carefully to ensure that it chains up
// to a CA certificate that they independently trust. Verifiers SHOULD
// handle old or non-complying bundles that have superfluous intermediate and/or
// root CA certificates by either ignoring them or explicitly considering them
// untrusted for the purposes of chain building.
//
// 3. A single X.509 certificate, which MUST be a leaf certificate conveying
// the signing key.
//
// When used with the Public Good Instance (PGI) of Sigstore for "keyless" signing
// via Fulcio, form (1) MUST NOT be used, regardless of bundle version. Form (1)
// MAY be used with the PGI for self-managed keys.
//
// When used in a `0.1` or `0.2` bundle with the PGI and "keyless" signing,
// form (2) MUST be used.
//
// When used in a `0.3` bundle with the PGI and "keyless" signing,
// form (3) MUST be used.
oneof content {
dev.sigstore.common.v1.PublicKeyIdentifier public_key = 1 [(google.api.field_behavior) = REQUIRED];
dev.sigstore.common.v1.X509CertificateChain x509_certificate_chain = 2 [(google.api.field_behavior) = REQUIRED];
dev.sigstore.common.v1.X509Certificate certificate = 5 [(google.api.field_behavior) = REQUIRED];
}
// An inclusion proof and an optional signed timestamp from the log.
// Client verification libraries MAY provide an option to support v0.1
// bundles for backwards compatibility, which may contain an inclusion
// promise and not an inclusion proof. In this case, the client MUST
// validate the promise.
// Verifiers SHOULD NOT allow v0.1 bundles if they're used in an
// ecosystem which never produced them.
repeated dev.sigstore.rekor.v1.TransparencyLogEntry tlog_entries = 3;
// Timestamp may also come from
// tlog_entries.inclusion_promise.signed_entry_timestamp.
TimestampVerificationData timestamp_verification_data = 4;
}
message Bundle {
// MUST be application/vnd.dev.sigstore.bundle.v0.3+json when
// when encoded as JSON.
// Clients must to be able to accept media type using the previously
// defined formats:
// * application/vnd.dev.sigstore.bundle+json;version=0.1
// * application/vnd.dev.sigstore.bundle+json;version=0.2
// * application/vnd.dev.sigstore.bundle+json;version=0.3
string media_type = 1;
// When a signer is identified by a X.509 certificate, a verifier MUST
// verify that the signature was computed at the time the certificate
// was valid as described in the Sigstore client spec: "Verification
// using a Bundle".
// <https://docs.google.com/document/d/1kbhK2qyPPk8SLavHzYSDM8-Ueul9_oxIMVFuWMWKz0E/edit#heading=h.x8bduppe89ln>
// If the verification material contains a public key identifier
// (key hint) and the `content` is a DSSE envelope, the key hints
// MUST be exactly the same in the verification material and in the
// DSSE envelope.
VerificationMaterial verification_material = 2 [(google.api.field_behavior) = REQUIRED];
oneof content {
dev.sigstore.common.v1.MessageSignature message_signature = 3 [(google.api.field_behavior) = REQUIRED];
// A DSSE envelope can contain arbitrary payloads.
// Verifiers must verify that the payload type is a
// supported and expected type. This is part of the DSSE
// protocol which is defined here:
// <https://github.com/secure-systems-lab/dsse/blob/master/protocol.md>
io.intoto.Envelope dsse_envelope = 4 [(google.api.field_behavior) = REQUIRED];
}
// Reserved for future additions of artifact types.
reserved 5 to 50;
}