Skip to content

Commit 6543a2d

Browse files
mihaimaruseacmihaimaruseac
committed
Add in-toto format with hashes of shards as subjects
This converts model serialization manifests that record every model file shard hash into an in-toto payload that can then be passed to Sigstore's `sign_intoto` for signing to generate a Sigstore `Bundle` (if using Sigstore). This time, we record every hash as part of the subject instead of in the payload. We require verifiers to be aware of this and acknowledge that verifiers that only check subject by subject (that is, they check if the hash of a passed in argument is in the list of subjects and don't check if all the hashes are present), can fail to fully detect if the model integrity is compromised by renaming one file in the model, interchanging two file names, deleting a file, or reordering two shards. The signing library will have additional checks for this, but verifying the signature with other tools might result in invalid results. Signed-off-by: Mihai Maruseac <[email protected]>
1 parent 03def6b commit 6543a2d

File tree

9 files changed

+368
-0
lines changed

9 files changed

+368
-0
lines changed

‎model_signing/signing/in_toto.py

+105
Original file line numberDiff line numberDiff line change
@@ -480,3 +480,108 @@ def from_manifest(cls, manifest: manifest_module.Manifest) -> Self:
480480
manifest, predicate_type=cls.predicate_type
481481
)
482482
return cls(statement)
483+
484+
485+
class ShardDigestsIntotoPayload(IntotoPayload):
486+
"""In-toto payload where the subjects are the model shards themselves.
487+
488+
This payload is supposed to be used for manifests where every file shard in
489+
the model is matched with a digest. Because existing tooling only supports
490+
established hashing algorithms, we annotate every subject with the actual
491+
hash algorithm used to compute the file digest, and use "sha256" as the
492+
algorithm name in the digest itself.
493+
494+
Example:
495+
```json
496+
{
497+
"_type": "https://in-toto.io/Statement/v1",
498+
"subject": [
499+
{
500+
"name": "d0/d1/d2/d3/d4/f0:0:16",
501+
"digest": {
502+
"sha256": "6efa14..."
503+
},
504+
"annotations": {
505+
"actual_hash_algorithm": "file-sha256-1000000"
506+
}
507+
},
508+
{
509+
"name": "d0/d1/d2/d3/d4/f1:0:16",
510+
"digest": {
511+
"sha256": "a9bc14..."
512+
},
513+
"annotations": {
514+
"actual_hash_algorithm": "file-sha256-1000000"
515+
}
516+
},
517+
{
518+
"name": "d0/d1/d2/d3/d4/f2:0:16",
519+
"digest": {
520+
"sha256": "5f597e..."
521+
},
522+
"annotations": {
523+
"actual_hash_algorithm": "file-sha256-1000000"
524+
}
525+
},
526+
{
527+
"name": "d0/d1/d2/d3/d4/f3:0:16",
528+
"digest": {
529+
"sha256": "eaf677..."
530+
},
531+
"annotations": {
532+
"actual_hash_algorithm": "file-sha256-1000000"
533+
}
534+
}
535+
],
536+
"predicateType": "https://model_signing/ShardDigests/v0.1",
537+
"predicate": {
538+
"unused": "Unused, just passed due to API requirements"
539+
}
540+
}
541+
```
542+
543+
If the annotation for a subject is missing, or it does not contain
544+
actual_hash_algorithm, it should be assumed that the digest is computed via
545+
the algorithm listed in the digest dictionary (i.e., sha256).
546+
547+
See also https://github.com/sigstore/sigstore-python/issues/1018.
548+
"""
549+
550+
predicate_type: Final[str] = (
551+
"https://model_signing/ShardDigests/v0.1"
552+
)
553+
554+
def __init__(self, statement: statement.Statement):
555+
"""Builds an instance of this in-toto payload.
556+
557+
Don't call this directly in production. Use `from_manifest()` instead.
558+
559+
Args:
560+
statement: The DSSE statement representing this in-toto payload.
561+
"""
562+
self.statement = statement
563+
564+
@classmethod
565+
@override
566+
def from_manifest(cls, manifest: manifest_module.Manifest) -> Self:
567+
"""Converts a manifest to the signing payload used for signing.
568+
569+
The manifest must be one where every model shard is paired with its own
570+
digest. Currently, this is only `ShardLevelManifest`.
571+
572+
Args:
573+
manifest: the manifest to convert to signing payload.
574+
575+
Returns:
576+
An instance of `DigestOfDigestsIntotoPayload`.
577+
578+
Raises:
579+
TypeError: If the manifest is not `ShardLevelManifest`.
580+
"""
581+
if not isinstance(manifest, manifest_module.ShardLevelManifest):
582+
raise TypeError("Only ShardLevelManifest is supported")
583+
584+
statement = _convert_descriptors_to_direct_statement(
585+
manifest, predicate_type=cls.predicate_type
586+
)
587+
return cls(statement)

‎model_signing/signing/in_toto_test.py

+62
Original file line numberDiff line numberDiff line change
@@ -266,3 +266,65 @@ def test_only_runs_on_expected_manifest_types(self):
266266
match="Only FileLevelManifest is supported",
267267
):
268268
in_toto.DigestsIntotoPayload.from_manifest(manifest)
269+
270+
271+
class TestShardDigestsIntotoPayload:
272+
273+
def _hasher_factory(
274+
self, path: pathlib.Path, start: int, end: int
275+
) -> file.ShardedFileHasher:
276+
return file.ShardedFileHasher(
277+
path, memory.SHA256(), start=start, end=end
278+
)
279+
280+
@pytest.mark.parametrize("model_fixture_name", test_support.all_test_models)
281+
def test_known_models(self, request, model_fixture_name):
282+
# Set up variables (arrange)
283+
testdata_path = request.path.parent / "testdata"
284+
test_path = testdata_path / "in_toto"
285+
test_class_path = test_path / "TestShardDigestsIntotoPayload"
286+
golden_path = test_class_path / model_fixture_name
287+
should_update = request.config.getoption("update_goldens")
288+
model = request.getfixturevalue(model_fixture_name)
289+
290+
# Compute payload (act)
291+
serializer = serialize_by_file_shard.ManifestSerializer(
292+
self._hasher_factory, allow_symlinks=True
293+
)
294+
manifest = serializer.serialize(model)
295+
payload = in_toto.ShardDigestsIntotoPayload.from_manifest(manifest)
296+
297+
# Compare with golden, or write to golden (approximately "assert")
298+
if should_update:
299+
with open(golden_path, "w", encoding="utf-8") as f:
300+
f.write(f"{json_format.MessageToJson(payload.statement.pb)}\n")
301+
else:
302+
with open(golden_path, "r", encoding="utf-8") as f:
303+
json_contents = f.read()
304+
proto = json_format.Parse(
305+
json_contents, statement_pb2.Statement()
306+
)
307+
308+
assert payload.statement.pb == proto
309+
310+
def test_produces_valid_statements(self, sample_model_folder):
311+
serializer = serialize_by_file_shard.ManifestSerializer(
312+
self._hasher_factory, allow_symlinks=True
313+
)
314+
manifest = serializer.serialize(sample_model_folder)
315+
316+
payload = in_toto.ShardDigestsIntotoPayload.from_manifest(
317+
manifest
318+
)
319+
320+
payload.statement.validate()
321+
322+
def test_only_runs_on_expected_manifest_types(self):
323+
digest = hashing.Digest("test", b"test_digest")
324+
manifest = manifest_module.DigestManifest(digest)
325+
326+
with pytest.raises(
327+
TypeError,
328+
match="Only ShardLevelManifest is supported",
329+
):
330+
in_toto.ShardDigestsIntotoPayload.from_manifest(manifest)

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/deep_model_folder

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"subject": [
4+
{
5+
"name": "d0/d1/d2/d3/d4/f0:0:16",
6+
"digest": {
7+
"sha256": "6efa14bb03544fcb76045c55f25b9315b6eb5be2d8a85f703193a76b7874c6ff"
8+
},
9+
"annotations": {
10+
"actual_hash_algorithm": "file-sha256-1000000"
11+
}
12+
},
13+
{
14+
"name": "d0/d1/d2/d3/d4/f1:0:16",
15+
"digest": {
16+
"sha256": "a9bc149b70b9d325cd68d275d582cfdb98c0347d3ce54590aa6533368daed3d2"
17+
},
18+
"annotations": {
19+
"actual_hash_algorithm": "file-sha256-1000000"
20+
}
21+
},
22+
{
23+
"name": "d0/d1/d2/d3/d4/f2:0:16",
24+
"digest": {
25+
"sha256": "5f597e6a92d1324d9adbed43d527926d11d0131487baf315e65ae1ef3b1ca3c0"
26+
},
27+
"annotations": {
28+
"actual_hash_algorithm": "file-sha256-1000000"
29+
}
30+
},
31+
{
32+
"name": "d0/d1/d2/d3/d4/f3:0:16",
33+
"digest": {
34+
"sha256": "eaf677c35fec6b87889d9e4563d8bb65dcb9869ca0225697c9cc44cf49dca008"
35+
},
36+
"annotations": {
37+
"actual_hash_algorithm": "file-sha256-1000000"
38+
}
39+
}
40+
],
41+
"predicateType": "https://model_signing/ShardDigests/v0.1",
42+
"predicate": {
43+
"unused": "Unused, just passed due to API requirements"
44+
}
45+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/empty_model_file

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"predicateType": "https://model_signing/ShardDigests/v0.1",
4+
"predicate": {
5+
"unused": "Unused, just passed due to API requirements"
6+
}
7+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/empty_model_folder

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"predicateType": "https://model_signing/ShardDigests/v0.1",
4+
"predicate": {
5+
"unused": "Unused, just passed due to API requirements"
6+
}
7+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/model_folder_with_empty_file

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"predicateType": "https://model_signing/ShardDigests/v0.1",
4+
"predicate": {
5+
"unused": "Unused, just passed due to API requirements"
6+
}
7+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/sample_model_file

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"subject": [
4+
{
5+
"name": ".:0:22",
6+
"digest": {
7+
"sha256": "3aab065c7181a173b5dd9e9d32a9f79923440b413be1e1ffcdba26a7365f719b"
8+
},
9+
"annotations": {
10+
"actual_hash_algorithm": "file-sha256-1000000"
11+
}
12+
}
13+
],
14+
"predicateType": "https://model_signing/ShardDigests/v0.1",
15+
"predicate": {
16+
"unused": "Unused, just passed due to API requirements"
17+
}
18+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/sample_model_folder

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"subject": [
4+
{
5+
"name": "d0/f00:0:23",
6+
"digest": {
7+
"sha256": "fdd8925354242a7fd1515e79534317b800015607a609cd306e0b4dcfe6c92249"
8+
},
9+
"annotations": {
10+
"actual_hash_algorithm": "file-sha256-1000000"
11+
}
12+
},
13+
{
14+
"name": "d0/f01:0:23",
15+
"digest": {
16+
"sha256": "e16940b5e44ce981150bda37c4ba95881a749a521b4a297c5cdf97bdcfe965e6"
17+
},
18+
"annotations": {
19+
"actual_hash_algorithm": "file-sha256-1000000"
20+
}
21+
},
22+
{
23+
"name": "d0/f02:0:23",
24+
"digest": {
25+
"sha256": "407822246ea8f9e26380842c3f4cd10d7b23e78f1fe7c74c293608682886a426"
26+
},
27+
"annotations": {
28+
"actual_hash_algorithm": "file-sha256-1000000"
29+
}
30+
},
31+
{
32+
"name": "d1/f10:0:23",
33+
"digest": {
34+
"sha256": "6a3b08b5df77c4d418ceee1ac136a9ad49fc7c41358b5e82c1176daccb21ff3f"
35+
},
36+
"annotations": {
37+
"actual_hash_algorithm": "file-sha256-1000000"
38+
}
39+
},
40+
{
41+
"name": "d1/f11:0:23",
42+
"digest": {
43+
"sha256": "a484b3d8ea5e99b75f9f123f9a42c882388693edc7d85d82ccba54834712cadf"
44+
},
45+
"annotations": {
46+
"actual_hash_algorithm": "file-sha256-1000000"
47+
}
48+
},
49+
{
50+
"name": "d1/f12:0:23",
51+
"digest": {
52+
"sha256": "8f577930f5f40c2c2133cb299d36f9527fde98c1608569017cae6b5bcd01abb3"
53+
},
54+
"annotations": {
55+
"actual_hash_algorithm": "file-sha256-1000000"
56+
}
57+
},
58+
{
59+
"name": "f0:0:24",
60+
"digest": {
61+
"sha256": "997b37cc51f1ca1c7a270466607e26847429cd7264c30148c1b9352e224083fc"
62+
},
63+
"annotations": {
64+
"actual_hash_algorithm": "file-sha256-1000000"
65+
}
66+
},
67+
{
68+
"name": "f1:0:24",
69+
"digest": {
70+
"sha256": "c88a04d48353133fb065ba2c8ab369abab21395b9526aa20373ad828915fa7ae"
71+
},
72+
"annotations": {
73+
"actual_hash_algorithm": "file-sha256-1000000"
74+
}
75+
},
76+
{
77+
"name": "f2:0:24",
78+
"digest": {
79+
"sha256": "700e3ba5065d8dd47e41fd928ea086670d628f891ba363be0ca3c31d20d7d719"
80+
},
81+
"annotations": {
82+
"actual_hash_algorithm": "file-sha256-1000000"
83+
}
84+
},
85+
{
86+
"name": "f3:0:24",
87+
"digest": {
88+
"sha256": "912bcf5ebdf44dc7b4085b07940e0a81d157fba24b276e73fd911121d4544c4a"
89+
},
90+
"annotations": {
91+
"actual_hash_algorithm": "file-sha256-1000000"
92+
}
93+
}
94+
],
95+
"predicateType": "https://model_signing/ShardDigests/v0.1",
96+
"predicate": {
97+
"unused": "Unused, just passed due to API requirements"
98+
}
99+
}

‎model_signing/signing/testdata/in_toto/TestShardDigestsIntotoPayload/symlink_model_folder

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"_type": "https://in-toto.io/Statement/v1",
3+
"subject": [
4+
{
5+
"name": "symlink_file:0:22",
6+
"digest": {
7+
"sha256": "3aab065c7181a173b5dd9e9d32a9f79923440b413be1e1ffcdba26a7365f719b"
8+
},
9+
"annotations": {
10+
"actual_hash_algorithm": "file-sha256-1000000"
11+
}
12+
}
13+
],
14+
"predicateType": "https://model_signing/ShardDigests/v0.1",
15+
"predicate": {
16+
"unused": "Unused, just passed due to API requirements"
17+
}
18+
}

0 commit comments

Comments
 (0)