Skip to content

Commit

Permalink
source-build: support SPDX SBOMs
Browse files Browse the repository at this point in the history
Support extracting the base image from both CycloneDX SBOMs and SPDX
SBOMs.

In an SPDX SBOM, the base/builder images are identified via JSON-encoded
annotations. Example:

        {
            "SPDXID": "SPDXRef-image-...
            "name": "registry.access.redhat.com/ubi9/ubi-micro",
            "downloadLocation": "NOASSERTION",
            "externalRefs": [
                {
                    "referenceCategory": "PACKAGE-MANAGER",
                    "referenceType": "purl",
                    "referenceLocator": "pkg:oci/ubi-micro@sha256:...?repository_url=..."
                }
            ],
            "annotations": [
                {
                    "annotator": "Tool: konflux:jsonencoded",
                    "comment": "{\"name\":\"konflux:container:is_base_image\",\"value\":\"true\"}",
                    "annotationDate": "2025-01-13T12:15:31Z",
                    "annotationType": "OTHER"
                }
            ]
        }

Signed-off-by: Adam Cmiel <[email protected]>
  • Loading branch information
chmeliik committed Jan 15, 2025
1 parent 9f209df commit 848460a
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 16 deletions.
28 changes: 20 additions & 8 deletions task/source-build-oci-ta/0.1/source-build-oci-ta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,28 @@ spec:
fi
echo -n "Looking for base image in SBOM"
echo " (.formulation[].components[] with 'konflux:container:is_base_image' property)"
# Note: the SBOM should contain at most one image with the is_base_image property - the
# base image for the last FROM instruction. That is the only base image we care about.
jq -r '
.formulation[]?
| .components[]?
| select(any(.properties[]?; .name == "konflux:container:is_base_image"))
| (.purl | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<<"$sbom" | tee "$BASE_IMAGES_FILE"
if jq -e '.bomFormat == "CycloneDX"' <<<"$sbom" >/dev/null; then
echo " (.formulation[].components[] with 'konflux:container:is_base_image' property)"
jq -r '
.formulation[]?
| .components[]?
| select(any(.properties[]?; .name == "konflux:container:is_base_image"))
| (.purl | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<<"$sbom" | tee "$BASE_IMAGES_FILE"
else
echo ' (a package with a {"name": "konflux:container:is_base_image"} JSON-encoded annotation)'
jq -r '
.packages[]
| select(any(.annotations[]?.comment; (fromjson?).name? == "konflux:container:is_base_image"))
| [.externalRefs[]? | select(.referenceType == "purl").referenceLocator] as $purls
| ($purls | first | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<<"$sbom" | tee "$BASE_IMAGES_FILE"
fi
- name: build
image: quay.io/konflux-ci/source-container-build:latest@sha256:4002c18472e33b5f3d2b92e7897b0b31e4181dd5f8b8a3c4097937035e899ba3
workingDir: /var/workdir
Expand Down
28 changes: 20 additions & 8 deletions task/source-build/0.1/source-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,28 @@ spec:
fi
echo -n "Looking for base image in SBOM"
echo " (.formulation[].components[] with 'konflux:container:is_base_image' property)"
# Note: the SBOM should contain at most one image with the is_base_image property - the
# base image for the last FROM instruction. That is the only base image we care about.
jq -r '
.formulation[]?
| .components[]?
| select(any(.properties[]?; .name == "konflux:container:is_base_image"))
| (.purl | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<< "$sbom" | tee "$BASE_IMAGES_FILE"
if jq -e '.bomFormat == "CycloneDX"' <<< "$sbom" >/dev/null; then
echo " (.formulation[].components[] with 'konflux:container:is_base_image' property)"
jq -r '
.formulation[]?
| .components[]?
| select(any(.properties[]?; .name == "konflux:container:is_base_image"))
| (.purl | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<< "$sbom" | tee "$BASE_IMAGES_FILE"
else
echo ' (a package with a {"name": "konflux:container:is_base_image"} JSON-encoded annotation)'
jq -r '
.packages[]
| select(any(.annotations[]?.comment; (fromjson?).name? == "konflux:container:is_base_image"))
| [.externalRefs[]? | select(.referenceType == "purl").referenceLocator] as $purls
| ($purls | first | capture("^pkg:oci/.*?@(?<digest>.*?:[a-f0-9]*)")) as $matched
| .name + "@" + $matched.digest
' <<< "$sbom" | tee "$BASE_IMAGES_FILE"
fi
- name: build
image: quay.io/konflux-ci/source-container-build:latest@sha256:4002c18472e33b5f3d2b92e7897b0b31e4181dd5f8b8a3c4097937035e899ba3
Expand Down

0 comments on commit 848460a

Please sign in to comment.