Skip to content

Commit d16248a

Browse files
authored
Merge pull request #1455 from mprpic/sbom-unique-spdx-ids
fix(sbom): make package SPDX ids unique per document
2 parents e9b86d8 + 4d4e573 commit d16248a

2 files changed

Lines changed: 118 additions & 10 deletions

File tree

‎src/fromager/sbom.py‎

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import json
1111
import logging
1212
import pathlib
13+
import re
1314
import typing
1415
import uuid
1516
from datetime import UTC, datetime
@@ -29,6 +30,19 @@
2930
SBOM_FILENAME = "fromager.spdx.json"
3031

3132

33+
def _spdx_id(kind: str, name: str, version: str, doc_suffix: str) -> str:
34+
"""Build a package SPDX id unique to this package and document.
35+
36+
SPDX ids only need to be unique within a document, but tools that read
37+
several SBOMs (e.g. syft scanning an environment) merge packages by id.
38+
Name and version keep different wheels apart; the per-document suffix
39+
keeps apart two builds of the same version that may carry different
40+
data. SPDX ids only allow letters, digits, ``.`` and ``-``.
41+
"""
42+
spdx_id = f"SPDXRef-{kind}-{name}-{version}-{doc_suffix}"
43+
return re.sub(r"[^A-Za-z0-9.\-]+", "-", spdx_id)
44+
45+
3246
def _build_downstream_purl(
3347
*,
3448
name: NormalizedName,
@@ -109,6 +123,10 @@ def generate_sbom(
109123
package entry, its purl, and the document identity use
110124
``wheel_version`` when given; the upstream package entry always
111125
uses ``version``.
126+
127+
Package SPDX ids include a per-document suffix and are not predictable,
128+
so consumers should find the wheel package through the document's
129+
DESCRIBES relationship rather than by a fixed id.
112130
"""
113131
sbom_settings = ctx.settings.sbom_settings
114132
if sbom_settings is None:
@@ -143,13 +161,19 @@ def generate_sbom(
143161
# contain URI-hostile characters.
144162
doc_name = downstream.name
145163
doc_version = downstream.version or str(wheel_version or version)
164+
doc_uuid = uuid.uuid4()
146165
namespace = (
147166
f"{sbom_settings.namespace!s}/{quote(doc_name, safe='')}"
148-
f"-{quote(doc_version, safe='')}-{uuid.uuid4()}.spdx.json"
167+
f"-{quote(doc_version, safe='')}-{doc_uuid}.spdx.json"
149168
)
150169

170+
upstream_version = upstream.version or str(version)
171+
doc_suffix = doc_uuid.hex[:8]
172+
wheel_id = _spdx_id("wheel", doc_name, doc_version, doc_suffix)
173+
upstream_id = _spdx_id("upstream", upstream.name, upstream_version, doc_suffix)
174+
151175
wheel_entry: dict[str, typing.Any] = {
152-
"SPDXID": "SPDXRef-wheel",
176+
"SPDXID": wheel_id,
153177
"name": doc_name,
154178
"versionInfo": doc_version,
155179
"downloadLocation": "NOASSERTION",
@@ -164,9 +188,9 @@ def generate_sbom(
164188
}
165189

166190
upstream_entry: dict[str, typing.Any] = {
167-
"SPDXID": "SPDXRef-upstream",
191+
"SPDXID": upstream_id,
168192
"name": upstream.name,
169-
"versionInfo": upstream.version or str(version),
193+
"versionInfo": upstream_version,
170194
"downloadLocation": "NOASSERTION",
171195
"supplier": "NOASSERTION",
172196
"externalRefs": [
@@ -193,12 +217,12 @@ def generate_sbom(
193217
{
194218
"spdxElementId": "SPDXRef-DOCUMENT",
195219
"relationshipType": "DESCRIBES",
196-
"relatedSpdxElement": "SPDXRef-wheel",
220+
"relatedSpdxElement": wheel_id,
197221
},
198222
{
199-
"spdxElementId": "SPDXRef-wheel",
223+
"spdxElementId": wheel_id,
200224
"relationshipType": "GENERATED_FROM",
201-
"relatedSpdxElement": "SPDXRef-upstream",
225+
"relatedSpdxElement": upstream_id,
202226
},
203227
],
204228
}

‎tests/test_sbom.py‎

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import json
22
import pathlib
3+
import re
34
import typing
45
import uuid
56
from unittest.mock import patch
@@ -391,14 +392,97 @@ def test_generate_sbom_relationships(tmp_path: pathlib.Path) -> None:
391392
version=Version("0.1.0"),
392393
)
393394

395+
wheel_id, upstream_id = (p["SPDXID"] for p in doc["packages"])
394396
rels = doc["relationships"]
395397
assert len(rels) == 2
396398
assert rels[0]["spdxElementId"] == "SPDXRef-DOCUMENT"
397399
assert rels[0]["relationshipType"] == "DESCRIBES"
398-
assert rels[0]["relatedSpdxElement"] == "SPDXRef-wheel"
399-
assert rels[1]["spdxElementId"] == "SPDXRef-wheel"
400+
assert rels[0]["relatedSpdxElement"] == wheel_id
401+
assert rels[1]["spdxElementId"] == wheel_id
400402
assert rels[1]["relationshipType"] == "GENERATED_FROM"
401-
assert rels[1]["relatedSpdxElement"] == "SPDXRef-upstream"
403+
assert rels[1]["relatedSpdxElement"] == upstream_id
404+
_validate_spdx(doc)
405+
406+
407+
def test_generate_sbom_spdx_ids_name_package_and_document(
408+
tmp_path: pathlib.Path,
409+
) -> None:
410+
"""Verify package SPDX ids carry name, version, and a document suffix."""
411+
ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings())
412+
fixed_uuid = uuid.UUID("12345678-1234-5678-1234-567812345678")
413+
with patch("fromager.sbom.uuid.uuid4", return_value=fixed_uuid):
414+
doc = sbom.generate_sbom(
415+
ctx=ctx,
416+
req=Requirement("test==0.1.0"),
417+
version=Version("0.1.0"),
418+
)
419+
420+
assert [p["SPDXID"] for p in doc["packages"]] == [
421+
"SPDXRef-wheel-test-0.1.0-12345678",
422+
"SPDXRef-upstream-test-0.1.0-12345678",
423+
]
424+
_validate_spdx(doc)
425+
426+
427+
def test_generate_sbom_spdx_ids_differ_between_packages(
428+
tmp_path: pathlib.Path,
429+
) -> None:
430+
"""Verify SBOMs of different wheels share no package SPDX ids.
431+
432+
Tools such as syft merge packages from several SBOMs by SPDX id, so
433+
shared ids would attribute one wheel's data to another. Both documents
434+
get the same UUID so only the name and version can keep the ids apart.
435+
"""
436+
ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings())
437+
fixed_uuid = uuid.UUID("12345678-1234-5678-1234-567812345678")
438+
with patch("fromager.sbom.uuid.uuid4", return_value=fixed_uuid):
439+
docs = [
440+
sbom.generate_sbom(ctx=ctx, req=Requirement(req), version=Version(ver))
441+
for req, ver in [("idna==3.6", "3.6"), ("packaging==26.3", "26.3")]
442+
]
443+
444+
ids = [{p["SPDXID"] for p in doc["packages"]} for doc in docs]
445+
assert ids[0].isdisjoint(ids[1])
446+
447+
448+
def test_generate_sbom_spdx_ids_differ_between_documents(
449+
tmp_path: pathlib.Path,
450+
) -> None:
451+
"""Verify two SBOMs of the same package share no package SPDX ids.
452+
453+
Two builds of one version (e.g. for different variants) can carry
454+
different data; shared ids would let tools merge them into one package.
455+
"""
456+
ctx = make_sbom_ctx(tmp_path, sbom_settings=SbomSettings())
457+
docs = [
458+
sbom.generate_sbom(
459+
ctx=ctx, req=Requirement("idna==3.6"), version=Version("3.6")
460+
)
461+
for _ in range(2)
462+
]
463+
464+
ids = [{p["SPDXID"] for p in doc["packages"]} for doc in docs]
465+
assert ids[0].isdisjoint(ids[1])
466+
467+
468+
def test_generate_sbom_spdx_ids_are_sanitized(tmp_path: pathlib.Path) -> None:
469+
"""Verify characters SPDX ids do not allow are replaced."""
470+
ctx = make_sbom_ctx(
471+
tmp_path,
472+
sbom_settings=SbomSettings(),
473+
package_overrides={"purl": {"version": "0.5.5+local.1"}},
474+
)
475+
doc = sbom.generate_sbom(
476+
ctx=ctx,
477+
req=Requirement("test-pkg==0.5.5"),
478+
version=Version("0.5.5"),
479+
)
480+
481+
wheel_id, upstream_id = (p["SPDXID"] for p in doc["packages"])
482+
assert re.fullmatch(
483+
r"SPDXRef-wheel-test-pkg-0\.5\.5-local\.1-[0-9a-f]{8}", wheel_id
484+
)
485+
assert re.fullmatch(r"SPDXRef-upstream-test-pkg-0\.5\.5-[0-9a-f]{8}", upstream_id)
402486
_validate_spdx(doc)
403487

404488

0 commit comments

Comments
 (0)