-
Notifications
You must be signed in to change notification settings - Fork 10
/
test_bundle.py
418 lines (333 loc) · 13.2 KB
/
test_bundle.py
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
import json
import os
import tempfile
from pathlib import Path
from typing import Any
import pytest # type: ignore
from cryptography import x509
from sigstore_protobuf_specs.dev.sigstore.bundle.v1 import Bundle
from test.client import BundleMaterials, ClientFail, SigstoreClient
from test.conftest import _MakeMaterialsByType, _VerifyBundle
def test_verify(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Test the happy path of verification
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.good.sigstore.json")
verify_bundle(materials, input_path)
def test_verify_v_0_3(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Test the happy path of verification of a v0.3 bundle
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.good.v0.3.sigstore")
verify_bundle(materials, input_path)
def test_verify_dsse_bundle_with_trust_root(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Test the happy path of verification for DSSE bundle w/ custom trust root
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.good.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
verify_bundle(materials, input_path)
def test_verify_rejects_root(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle that contains a root certificate.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("has_root_in_chain.txt", BundleMaterials)
with client.raises():
verify_bundle(materials, input_path)
@pytest.mark.signing
def test_sign_does_not_produce_root(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client does not produce a bundle that contains a root
certificate.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
assert not materials.exists()
# Sign for our input.
client.sign(materials, input_path)
# Parse the output bundle.
bundle_contents = materials.bundle.read_bytes()
bundle = Bundle().from_json(bundle_contents)
# Iterate over our cert chain and check for roots.
certs = bundle.verification_material.x509_certificate_chain
for x509cert in certs.certificates:
cert = x509.load_der_x509_certificate(x509cert.raw_bytes)
try:
constraints = cert.extensions.get_extension_for_class(x509.BasicConstraints)
assert not constraints.value.ca
# BasicConstraints isn't required to appear in leaf certificates.
except x509.ExtensionNotFound:
pass
def test_verify_rejects_staging_cert(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle that doesn't match trust root.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.staging.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_invalid_set(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle with a signed entry timestamp from
the future.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.invalid_set.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_invalid_signature(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle with a modified signature.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.invalid_signature.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_invalid_key(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle with a modified public key in the
hashrekord entry.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.invalid_key.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_invalid_inclusion_proof(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle with an old inclusion proof
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.invalid_inclusion_proof.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_different_materials(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle for different materials.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("b.txt", BundleMaterials)
materials.bundle = Path("a.txt.good.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_expired_certificate(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the certificate was issued
outside the validity window of the trusted root
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.cert-expired.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_missing_inclusion_proof(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a v0.2 bundle if the TLog entry does NOT
contain an inclusion proof
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.no-inclusion-proof.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_bad_tlog_timestamp(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the TLog entry contains a
timestamp that falls outside the validity window of the signing
certificate.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.tlog-timestamp-error.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_bad_tlog_entry(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the body of the TLog entry does
not match the signed artifact.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.tlog-body-error.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_bad_tsa_timestamp(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the TSA timestamp falls outside
the validity window of the signing certificate.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("d.txt", BundleMaterials)
materials.bundle = Path("d.txt.tsa-timestamp-error.sigstore.json")
materials.trusted_root = Path("trusted_root.d.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_bad_checkpoint(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the checkpoint signature is
invalid.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.checkpoint_invalid_signature.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_valid_but_mismatched_checkpoint(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the checkpoint self consistent
but does not apply to this bundle (root hash is wrong).
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.checkpoint_wrong_roothash.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_rejects_checkpoint_with_no_matching_key(
client: SigstoreClient,
make_materials_by_type: _MakeMaterialsByType,
verify_bundle: _VerifyBundle,
) -> None:
"""
Check that the client rejects a bundle if the checkpoint signature
does not match the transparency log providing the entry.
"""
materials: BundleMaterials
input_path, materials = make_materials_by_type("a.txt", BundleMaterials)
materials.bundle = Path("a.txt.checkpoint_bad_keyhint.sigstore.json")
with client.raises():
verify_bundle(materials, input_path)
def test_verify_cpython_release_bundles(subtests, client):
cpython_release_dir = Path(os.getenv("GITHUB_WORKSPACE")) / "cpython-release-tracker"
if not cpython_release_dir.is_dir():
pytest.skip("cpython-release-tracker data is not available")
identities = json.loads((cpython_release_dir / "signing-identities.json").read_text())
def version_path_to_identity(path: Path) -> dict[str, Any] | None:
# Transforms /foo/bar/versions/3.11.6.json into a suitable
# verification identity.
# "3.11.6"
full_version = path.with_suffix("").name
# "3.11"
version = ".".join(full_version.split(".")[0:2])
return next((ident for ident in identities if ident["Release"] == version), None)
def temp_bundle_path(bundle: dict) -> Path:
# We let the system dispose of these after process teardown.
tmpfile = tempfile.NamedTemporaryFile(mode="w+t", suffix=".sigstore.json", delete=False)
tmpfile.write(json.dumps(bundle))
tmpfile.close()
return Path(tmpfile.name)
versions = cpython_release_dir / "versions"
for version_path in versions.glob("*.json"):
ident = version_path_to_identity(version_path)
if not ident:
continue
version = json.loads(version_path.read_text())
for artifact in version:
with subtests.test(artifact["url"]):
bundle = artifact.get("sigstore")
if not bundle:
continue
bundle_path = temp_bundle_path(bundle)
sha256 = artifact["sha256"]
# NOTE: We currently do this completely manually,
# since the client verify APIs are baked around
# the assumption of a static identity.
try:
client.run(
"verify-bundle",
"--bundle",
str(bundle_path),
"--certificate-identity",
ident["Release manager"],
"--certificate-oidc-issuer",
ident["OIDC Issuer"],
f"sha256:{sha256}",
)
except ClientFail as e:
pytest.fail(f"verify for {artifact['url']} failed: {e}")