Skip to content
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

feat(sbom): add image labels into SPDX and CycloneDX reports #7257

Merged
merged 5 commits into from
Jul 30, 2024
Merged

feat(sbom): add image labels into SPDX and CycloneDX reports #7257

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9005894
feat(core): save labels to properties
DmitriyLewen Jul 30, 2024
5880237
test(spdx): update unit test
DmitriyLewen Jul 30, 2024
7d21ba2
test(cyclonedx): update unit test
DmitriyLewen Jul 30, 2024
f04528e
refactor: remove `:` suffix for `PropertyLabelsPrefix`
DmitriyLewen Jul 30, 2024
8e9afc3
refactor: add `:` between `PropertyLabelsPrefix` and label
DmitriyLewen Jul 30, 2024
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
11 changes: 6 additions & 5 deletions pkg/sbom/core/bom.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ const (
PropertyClass = "Class"

// Image properties
PropertySize = "Size"
PropertyImageID = "ImageID"
PropertyRepoDigest = "RepoDigest"
PropertyDiffID = "DiffID"
PropertyRepoTag = "RepoTag"
PropertySize = "Size"
PropertyImageID = "ImageID"
PropertyRepoDigest = "RepoDigest"
PropertyDiffID = "DiffID"
PropertyRepoTag = "RepoTag"
PropertyLabelsPrefix = "Labels:"
DmitriyLewen marked this conversation as resolved.
Show resolved Hide resolved

// Package properties
PropertyPkgID = "PkgID"
Expand Down
9 changes: 9 additions & 0 deletions pkg/sbom/cyclonedx/marshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,11 @@ func TestMarshaler_MarshalReport(t *testing.T) {
RepoDigests: []string{"rails@sha256:a27fd8080b517143cbbbab9dfb7c8571c40d67d534bbdee55bd6c473f432b177"},
ImageConfig: v1.ConfigFile{
Architecture: "arm64",
Config: v1.Config{
Labels: map[string]string{
"vendor": "aquasecurity",
},
},
},
},
Results: types.Results{
Expand Down Expand Up @@ -301,6 +306,10 @@ func TestMarshaler_MarshalReport(t *testing.T) {
Name: "aquasecurity:trivy:ImageID",
Value: "sha256:5d0da3dc976460b72c77d94c8a1ad043720b0416bfc16c52c45d4847e53fadb6",
},
{
Name: "aquasecurity:trivy:Labels:vendor",
Value: "aquasecurity",
},
{
Name: "aquasecurity:trivy:RepoDigest",
Value: "rails@sha256:a27fd8080b517143cbbbab9dfb7c8571c40d67d534bbdee55bd6c473f432b177",
Expand Down
9 changes: 9 additions & 0 deletions pkg/sbom/io/encode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@ func (e *Encoder) rootComponent(r types.Report) (*core.Component, error) {
Value: r.Metadata.ImageID,
})

// Save image labels as properties with `Labels:` prefix.
// e.g. `LABEL vendor="aquasecurity"` => `Labels:vendor` -> `aquasecurity`
for label, value := range r.Metadata.ImageConfig.Config.Labels {
props = append(props, core.Property{
Name: core.PropertyLabelsPrefix + label,
DmitriyLewen marked this conversation as resolved.
Show resolved Hide resolved
Value: value,
})
}

p, err := purl.New(purl.TypeOCI, r.Metadata, ftypes.Package{})
if err != nil {
return nil, xerrors.Errorf("failed to new package url for oci: %w", err)
Expand Down
12 changes: 12 additions & 0 deletions pkg/sbom/io/encode_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package io_test
import (
"testing"

v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/package-url/packageurl-go"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -43,6 +44,13 @@ func TestEncoder_Encode(t *testing.T) {
RepoDigests: []string{
"debian@sha256:4482958b4461ff7d9fabc24b3a9ab1e9a2c85ece07b2db1840c7cbc01d053e90",
},
ImageConfig: v1.ConfigFile{
Config: v1.Config{
Labels: map[string]string{
"vendor": "aquasecurity",
},
},
},
},
Results: []types.Result{
{
Expand Down Expand Up @@ -185,6 +193,10 @@ func TestEncoder_Encode(t *testing.T) {
BOMRef: "pkg:oci/debian@sha256%3A4482958b4461ff7d9fabc24b3a9ab1e9a2c85ece07b2db1840c7cbc01d053e90?repository_url=index.docker.io%2Flibrary%2Fdebian",
},
Properties: []core.Property{
{
Name: "Labels:vendor",
Value: "aquasecurity",
},
{
Name: core.PropertyRepoDigest,
Value: "debian@sha256:4482958b4461ff7d9fabc24b3a9ab1e9a2c85ece07b2db1840c7cbc01d053e90",
Expand Down
6 changes: 6 additions & 0 deletions pkg/sbom/spdx/marshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ func TestMarshaler_Marshal(t *testing.T) {
RepoDigests: []string{"rails@sha256:a27fd8080b517143cbbbab9dfb7c8571c40d67d534bbdee55bd6c473f432b177"},
ImageConfig: v1.ConfigFile{
Architecture: "arm64",
Config: v1.Config{
Labels: map[string]string{
"vendor": "aquasecurity",
},
},
},
},
Results: types.Results{
Expand Down Expand Up @@ -199,6 +204,7 @@ func TestMarshaler_Marshal(t *testing.T) {
PackageAttributionTexts: []string{
"DiffID: sha256:d871dadfb37b53ef1ca45be04fc527562b91989991a8f545345ae3be0b93f92a",
"ImageID: sha256:5d0da3dc976460b72c77d94c8a1ad043720b0416bfc16c52c45d4847e53fadb6",
"Labels:vendor: aquasecurity",
"RepoDigest: rails@sha256:a27fd8080b517143cbbbab9dfb7c8571c40d67d534bbdee55bd6c473f432b177",
"RepoTag: rails:latest",
"SchemaVersion: 2",
Expand Down