Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,15 @@ checker's accepted fields. Preserve the process exit code as well as the output.
- OCI plain-TAR or gzip layers; Docker-save plain-TAR layers. Extended PAX/GNU
long-name/sparse records, zstd, foreign layers, unsupported digests, outer gzip
and other archive formats are unresolved, not silently accepted as complete.
- OCI-layout descriptors must explicitly identify an OCI image manifest/index
or Docker schema-2 manifest/list. An optional manifest `mediaType` must match
its descriptor. Only OCI image-config or Docker image-config media types
authorize filesystem interpretation; the config bytes remain opaque and
digest-verified. Manifests declaring `artifactType`, empty artifact configs,
missing config media types and unknown descriptor/config types are incomplete
artifact records with no package observations or consumer records. Verified
manifest digests remain in canonical output, and supported image siblings
retain their observations.
- JSON CycloneDX 1.4/1.5/1.6, including metadata.component and nested components;
SPDX 2.2/2.3 package metadata. This reads selected metadata fields, not full SBOM
conformance or deployment/relationship attestation.
Expand Down
2 changes: 1 addition & 1 deletion SHA256SUMS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
b6422d9849a64a4fe54a316a1d64f3fed4a20f52486697990b1d9bc08e6547f2 oci_runtime_inventory.py
21d6cbd46b86c101b346d507ed0de30af6f6655fc8b4825ce7b6c2b0ec44c4fe oci_runtime_inventory.py
14 changes: 13 additions & 1 deletion oci_runtime_inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,16 @@ def image_plans(stream, index, budget):
raise InventoryError("image_descriptor_limit")
try:
manifest = blob_json(stream, index, descriptor, budget)
if isinstance(manifest, dict) and "manifests" in manifest:
media = descriptor.get("mediaType")
index_media = {"application/vnd.oci.image.index.v1+json", "application/vnd.docker.distribution.manifest.list.v2+json"}
image_media = {"application/vnd.oci.image.manifest.v1+json", "application/vnd.docker.distribution.manifest.v2+json"}
if not isinstance(media, str) or media not in index_media | image_media:
raise InventoryError("unsupported_manifest_media_type")
if not isinstance(manifest, dict) or ("mediaType" in manifest and manifest["mediaType"] != media):
raise InventoryError("unsupported_manifest_media_type")
if "artifactType" in manifest:
raise InventoryError("unsupported_oci_artifact")
if media in index_media:
pending.append((manifest, depth + 1))
continue
if not isinstance(manifest, dict) or type(manifest.get("schemaVersion")) is not int or manifest["schemaVersion"] != 2 or not isinstance(manifest.get("layers"), list):
Expand All @@ -336,6 +345,9 @@ def image_plans(stream, index, budget):
config_name = descriptor_path(config, index)
if hashlib.sha256(read_member(stream, index, config_name, budget)).hexdigest() != config["digest"][7:]:
raise InventoryError("config_digest_mismatch")
config_media = config.get("mediaType")
if not isinstance(config_media, str) or config_media not in {"application/vnd.oci.image.config.v1+json", "application/vnd.docker.container.image.v1+json"}:
raise InventoryError("unsupported_image_config_media_type")
layers = []
for layer in manifest["layers"]:
name = descriptor_path(layer, index)
Expand Down
78 changes: 78 additions & 0 deletions test_artifact_semantics.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
"""Offline fixtures distinguish verified artifact bytes from image filesystems."""
import hashlib
import io
import json
import tarfile
import unittest

import test_inventory as t


class ArtifactSemanticsTests(unittest.TestCase):
cli = t.InventoryTests.cli
scan = t.InventoryTests.scan
def test_unsupported_artifacts_never_supply_image_components(self):
base = t.oci_archive([t.tar_bytes([("app/package.json", t.package())])])
with tarfile.open(fileobj=io.BytesIO(base)) as archive:
original = {m.name: archive.extractfile(m).read() for m in archive if m.isfile()}
for case in ("empty_config_artifact", "artifact_with_image_config", "unknown_descriptor",
"unknown_config", "missing_config_type", "unknown_manifest_type",
"non_string_descriptor", "non_string_config"):
with self.subTest(case=case):
files = dict(original)
index = json.loads(files["index.json"])
valid = index["manifests"][0]
manifest = json.loads(files["blobs/sha256/" + valid["digest"][7:]])
if case in ("empty_config_artifact", "artifact_with_image_config"):
manifest["artifactType"] = "application/vnd.example.attestation"
if case == "empty_config_artifact":
raw = b"{}"
digest = hashlib.sha256(raw).hexdigest()
files["blobs/sha256/" + digest] = raw
manifest["config"] = dict(digest="sha256:" + digest, size=len(raw),
mediaType="application/vnd.oci.empty.v1+json")
if case == "unknown_config":
manifest["config"]["mediaType"] = "application/vnd.example.config+json"
if case == "missing_config_type":
manifest["config"].pop("mediaType")
if case == "non_string_config":
manifest["config"]["mediaType"] = []
if case == "unknown_manifest_type":
manifest["mediaType"] = "application/vnd.example.manifest+json"
raw = json.dumps(manifest).encode()
digest = hashlib.sha256(raw).hexdigest()
files["blobs/sha256/" + digest] = raw
bad = dict(digest="sha256:" + digest, size=len(raw),
mediaType="application/vnd.oci.image.manifest.v1+json")
if case == "unknown_descriptor":
bad["mediaType"] = "application/vnd.example.manifest+json"
if case == "non_string_descriptor":
bad["mediaType"] = []
# Descriptor identity remains distinct even when only its media type changes.
for siblings in ([bad], [valid, bad], [bad, valid]):
index["manifests"] = siblings
files["index.json"] = json.dumps(index).encode()
payload = t.tar_bytes(list(files.items()))
code, report, _ = self.scan(payload)
self.assertEqual(2, code)
self.assertFalse(report["complete"])
failed = [image for image in report["images"] if not image["coverage_complete"]]
self.assertEqual(1, len(failed))
self.assertEqual(bad["digest"], failed[0]["digest"])
self.assertEqual([], failed[0]["components"])
self.assertTrue(any("unsupported" in note for note in failed[0]["notes"]))
healthy = [image for image in report["images"] if image["coverage_complete"]]
self.assertEqual(len(siblings) - 1, len(healthy))
if healthy:
self.assertEqual("sharp", healthy[0]["components"][0]["name"])
_, consumer, _ = self.scan(payload, "--consumer", "sharp")
# The failed artifact cannot create any additional consumer record.
if healthy:
self.assertEqual([["0.35.5"]], [row["sharp_versions"] for row in consumer["records"]])
self.assertEqual("not_tested", healthy[0]["components"][0]["exploitability"])
else:
self.assertEqual([{"asset_id": "metadata-coverage"}], consumer["records"])


if __name__ == "__main__":
unittest.main()
Loading