Skip to content

sbom: Use layer digest for layer package version #2018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wlynch wants to merge 1 commit into
base: main
Choose a base branch
from
+99 −12
Open

sbom: Use layer digest for layer package version #2018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion internal/cli/testdata/golden/sboms/sbom-aarch64.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
{
"SPDXID": "SPDXRef-Package-sha256-b075b4a14ed0c1e236bac3448fa494c77772feb140cfad4033450e45010da27f",
"name": "sha256:b075b4a14ed0c1e236bac3448fa494c77772feb140cfad4033450e45010da27f",
"versionInfo": "1.0.0",
"versionInfo": "sha256:b075b4a14ed0c1e236bac3448fa494c77772feb140cfad4033450e45010da27f",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/testdata/golden/sboms/sbom-x86_64.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
{
"SPDXID": "SPDXRef-Package-sha256-622ca92e75385bab9884a8c8c65c3f4a4c3dd0eafbd2a57f2762bafcb393a456",
"name": "sha256:622ca92e75385bab9884a8c8c65c3f4a4c3dd0eafbd2a57f2762bafcb393a456",
"versionInfo": "1.0.0",
"versionInfo": "sha256:622ca92e75385bab9884a8c8c65c3f4a4c3dd0eafbd2a57f2762bafcb393a456",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
8 changes: 4 additions & 4 deletions pkg/sbom/generator/spdx/spdx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,13 +427,13 @@ func (sx *SPDX) imagePackage(opts *options.Options) (p *Package) {

// LayerPackage returns a package describing the layer
func (sx *SPDX) layerPackage(opts *options.Options, layer v1.Descriptor) *Package {
layerPackageName := hashToString(layer.Digest)
mainPkgID := stringToIdentifier(layerPackageName)
layerDigest := hashToString(layer.Digest)
mainPkgID := stringToIdentifier(layerDigest)

return &Package{
ID: fmt.Sprintf("SPDXRef-Package-%s", mainPkgID),
Name: layerPackageName,
Version: opts.OS.Version,
Name: layerDigest,
Version: layerDigest,
FilesAnalyzed: false,
Description: "apko operating system layer",
DownloadLocation: NOASSERTION,
Expand Down
27 changes: 27 additions & 0 deletions pkg/sbom/generator/spdx/spdx_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,33 @@ func TestSPDX_Generate(t *testing.T) {
},
},
},
{
name: "layer-with-digest",
opts: &options.Options{
ImageInfo: options.ImageInfo{
Layers: []v1.Descriptor{{
Digest: v1.Hash{
Algorithm: "sha256",
Hex: "abc123def456",
},
}},
},
OS: options.OSInfo{
Name: "unknown",
ID: "unknown",
Version: "3.0",
},
FileName: "sbom",
Packages: []*apk.InstalledPackage{
{
Package: apk.Package{
Name: "libattr1",
Version: "2.5.1-r2",
},
},
},
},
},
}

for _, tt := range tests {
Expand Down
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/both-describes-methods.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/custom-license.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/describes-relationship.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
66 changes: 66 additions & 0 deletions pkg/sbom/generator/spdx/testdata/expected_image_sboms/layer-with-digest.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"SPDXID": "SPDXRef-DOCUMENT",
"name": "sbom-sha256:abc123def456",
"spdxVersion": "SPDX-2.3",
"creationInfo": {
"created": "0001-01-01T00:00:00Z",
"creators": [
"Tool: apko (devel)",
"Organization: Chainguard, Inc"
],
"licenseListVersion": "3.16"
},
"dataLicense": "CC0-1.0",
"documentNamespace": "https://spdx.org/spdxdocs/apko/",
"documentDescribes": [
"SPDXRef-Package-sha256-abc123def456"
],
"packages": [
{
"SPDXID": "SPDXRef-Package-sha256-abc123def456",
"name": "sha256:abc123def456",
"versionInfo": "sha256:abc123def456",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
"supplier": "Organization: unknown",
"externalRefs": [
{
"referenceCategory": "PACKAGE-MANAGER",
"referenceLocator": "pkg:oci/image@sha256%3Aabc123def456?mediaType=\u0026os=linux",
"referenceType": "purl"
}
]
},
{
"SPDXID": "SPDXRef-OperatingSystem-unknown",
"name": "unknown",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "Operating System",
"downloadLocation": "NOASSERTION",
"supplier": "Organization: unknown",
"primaryPackagePurpose": "OPERATING_SYSTEM"
},
{
"SPDXID": "SPDXRef-Package-libattr1-2.5.1-r2",
"name": "libattr1",
"versionInfo": "2.5.1-r2",
"filesAnalyzed": false,
"licenseConcluded": "NOASSERTION",
"licenseDeclared": "GPL-2.0-or-later",
"downloadLocation": "NOASSERTION",
"originator": "Organization: unknown",
"supplier": "Organization: unknown",
"copyrightText": "TODO\n",
"externalRefs": [
{
"referenceCategory": "PACKAGE_MANAGER",
"referenceLocator": "pkg:apk/wolfi/libattr1@2.5.1-r2?arch=x86_64",
"referenceType": "purl"
}
]
}
],
"relationships": []
}
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/no-supplier.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/package-deduplicating.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
1 change: 0 additions & 1 deletion pkg/sbom/generator/spdx/testdata/expected_image_sboms/unbound-package-dedupe.spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
{
"SPDXID": "SPDXRef-Package-",
"name": "",
"versionInfo": "3.0",
"filesAnalyzed": false,
"description": "apko operating system layer",
"downloadLocation": "NOASSERTION",
Expand Down
Loading