Skip to content

Commit 2a22db7

Browse files
committed
chore(ISV-6864): Add information about CPE_ID in sbom section.
1 parent 447a9ca commit 2a22db7

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

docs/sbom.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ state of the software as it is distributed to end users. This SBOM type should s
7474
as defined by CISA, but it simply includes additional metadata that is not available during the build process and is
7575
added later on. For lack of a better term, we could call these _Curated Build SBOMs_.
7676

77+
For component-level _Release-time_ SBOMs (for example, container images), the package that represents the component may include product CPE(s) in its externalRefs with referenceCategory `SECURITY` and referenceType `cpe22Type` (and the CPE string in referenceLocator), so the component is explicitly associated with the Red Hat product(s) it is released as part of.
78+
7779
Red Hat's publicly available SBOMs are of the release-time type, including details about where an artifact
7880
can be located after being released.
7981

@@ -283,7 +285,9 @@ A more detailed breakdown of some of the fields:
283285
: At least one of the references must include a Package URL (purl) unless the object is describing a product.
284286
[Identifying Red Hat components using Package URL](./purl.md) documents what purl strings for different types of
285287
components should look like. Note that multiple purls may be used for a single package to identify multiple
286-
locations from where the package can be accessed.
288+
locations from where the package can be accessed. For release-time component-level SBOMs, externalRefs may also
289+
include `SECURITY` references with referenceType `cpe22Type` and the product CPE string(s) in `referenceLocator`, linking
290+
the component to the Red Hat product(s) it is released as part of; one or more CPEs per package is allowed.
287291

288292
[`checksums`](https://spdx.github.io/spdx-spec/v2.3/package-information/#710-package-checksum-field)
289293
: The checksums of the component. The type of checksum used will depend on the type of the component. See below

sbom/examples/container_image/release/ubi9-micro-container-9.4-6.1716471860_amd64.spdx.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@
2929
"referenceCategory": "PACKAGE-MANAGER",
3030
"referenceType": "purl",
3131
"referenceLocator": "pkg:oci/ubi9-micro@sha256:sha256:213fd2a0116a76eaa274fee20c86eef4dfba9f311784e8fb7d7f5fc38b32f3ef?arch=amd64&repository_url=registry.access.redhat.com/ubi9-micro&tag=9.4-6.1716471860"
32+
},
33+
{
34+
"referenceCategory": "SECURITY",
35+
"referenceType": "cpe22Type",
36+
"referenceLocator": "cpe:/a:redhat:product:1.0::el9"
3237
}
3338
],
3439
"checksums": [

0 commit comments

Comments
 (0)