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

Jump to bottom

fix(sbom): add trivy version to spdx creators tool field #3756

Merged
merged 2 commits into from
Mar 3, 2023
Merged

fix(sbom): add trivy version to spdx creators tool field #3756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5866eac
fix(sbom): add trivy version to spdx creators tool field
DmitriyLewen Mar 3, 2023
bae91df
refactor test
DmitriyLewen Mar 3, 2023
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
4 changes: 2 additions & 2 deletions docs/docs/sbom/spdx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ SPDXID: SPDXRef-DOCUMENT
DocumentName: alpine:3.15
DocumentNamespace: http://aquasecurity.github.io/trivy/container_image/alpine:3.15-bebf6b19-a94c-4e2c-af44-065f63923f48
Creator: Organization: aquasecurity
Creator: Tool: trivy
Creator: Tool: trivy-0.38.1
Created: 2022-04-28T07:32:57.142806Z

##### Package: zlib
Expand Down Expand Up @@ -167,7 +167,7 @@ $ cat result.spdx.json | jq .
"creationInfo": {
"created": "2022-04-28T08:16:55.328255Z",
"creators": [
"Tool: trivy",
"Tool: trivy-0.38.1",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion integration/testdata/conda-spdx.json.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2023-01-08T23:58:16.700785648Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion integration/testdata/fixtures/sbom/centos-7-spdx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-13T13:27:55.874784Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion integration/testdata/fixtures/sbom/centos-7-spdx.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SPDXID: SPDXRef-DOCUMENT
DocumentName: integration/testdata/fixtures/images/centos-7.tar.gz
DocumentNamespace: http://aquasecurity.github.io/trivy/container_image/integration/testdata/fixtures/images/centos-7.tar.gz-6a2c050f-bc12-46dc-b2df-1f4e3e0b5e1d
Creator: Organization: aquasecurity
Creator: Tool: trivy
Creator: Tool: trivy-dev
Created: 2022-09-13T13:24:58.796907Z

##### Package: integration/testdata/fixtures/images/centos-7.tar.gz
Expand Down
2 changes: 1 addition & 1 deletion pkg/report/spdx/spdx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ func NewWriter(output io.Writer, version string, spdxFormat string) Writer {
output: output,
version: version,
format: spdxFormat,
marshaler: spdx.NewMarshaler(),
marshaler: spdx.NewMarshaler(version),
}
}

Expand Down
22 changes: 12 additions & 10 deletions pkg/sbom/spdx/marshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,11 @@ var (
)

type Marshaler struct {
format spdx.Document2_1
clock clock.Clock
newUUID newUUID
hasher Hash
format spdx.Document2_1
clock clock.Clock
newUUID newUUID
hasher Hash
appVersion string // Trivy version. It needed for `creator` field
}

type Hash func(v interface{}, format hashstructure.Format, opts *hashstructure.HashOptions) (uint64, error)
Expand All @@ -90,12 +91,13 @@ func WithHasher(hasher Hash) marshalOption {
}
}

func NewMarshaler(opts ...marshalOption) *Marshaler {
func NewMarshaler(version string, opts ...marshalOption) *Marshaler {
m := &Marshaler{
format: spdx.Document2_1{},
clock: clock.RealClock{},
newUUID: uuid.New,
hasher: hashstructure.Hash,
format: spdx.Document2_1{},
clock: clock.RealClock{},
newUUID: uuid.New,
hasher: hashstructure.Hash,
appVersion: version,
}

for _, opt := range opts {
Expand Down Expand Up @@ -149,7 +151,7 @@ func (m *Marshaler) Marshal(r types.Report) (*spdx.Document2_2, error) {
DocumentName: r.ArtifactName,
DocumentNamespace: getDocumentNamespace(r, m),
CreatorOrganizations: []string{CreatorOrganization},
CreatorTools: []string{CreatorTool},
CreatorTools: []string{fmt.Sprintf("%s-%s", CreatorTool, m.appVersion)},
Created: m.clock.Now().UTC().Format(time.RFC3339),
},
Packages: packages,
Expand Down
12 changes: 6 additions & 6 deletions pkg/sbom/spdx/marshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ func TestMarshaler_Marshal(t *testing.T) {
DocumentName: "rails:latest",
DocumentNamespace: "http://aquasecurity.github.io/trivy/container_image/rails:latest-3ff14136-e09f-4df9-80ea-000000000001",
CreatorOrganizations: []string{"aquasecurity"},
CreatorTools: []string{"trivy"},
CreatorTools: []string{"trivy-0.38.1"},
Created: "2021-08-25T12:20:30Z",
},
Packages: map[spdx.ElementID]*spdx.Package2_2{
Expand Down Expand Up @@ -310,7 +310,7 @@ func TestMarshaler_Marshal(t *testing.T) {
DocumentName: "centos:latest",
DocumentNamespace: "http://aquasecurity.github.io/trivy/container_image/centos:latest-3ff14136-e09f-4df9-80ea-000000000001",
CreatorOrganizations: []string{"aquasecurity"},
CreatorTools: []string{"trivy"},
CreatorTools: []string{"trivy-0.38.1"},
Created: "2021-08-25T12:20:30Z",
},
Packages: map[spdx.ElementID]*spdx.Package2_2{
Expand Down Expand Up @@ -463,7 +463,7 @@ func TestMarshaler_Marshal(t *testing.T) {
DocumentName: "masahiro331/CVE-2021-41098",
DocumentNamespace: "http://aquasecurity.github.io/trivy/filesystem/masahiro331/CVE-2021-41098-3ff14136-e09f-4df9-80ea-000000000001",
CreatorOrganizations: []string{"aquasecurity"},
CreatorTools: []string{"trivy"},
CreatorTools: []string{"trivy-0.38.1"},
Created: "2021-08-25T12:20:30Z",
},
Packages: map[spdx.ElementID]*spdx.Package2_2{
Expand Down Expand Up @@ -546,7 +546,7 @@ func TestMarshaler_Marshal(t *testing.T) {
DocumentName: "test-aggregate",
DocumentNamespace: "http://aquasecurity.github.io/trivy/repository/test-aggregate-3ff14136-e09f-4df9-80ea-000000000001",
CreatorOrganizations: []string{"aquasecurity"},
CreatorTools: []string{"trivy"},
CreatorTools: []string{"trivy-0.38.1"},
Created: "2021-08-25T12:20:30Z",
},
Packages: map[spdx.ElementID]*spdx.Package2_2{
Expand Down Expand Up @@ -621,7 +621,7 @@ func TestMarshaler_Marshal(t *testing.T) {
DocumentName: "empty/path",
DocumentNamespace: "http://aquasecurity.github.io/trivy/filesystem/empty/path-3ff14136-e09f-4df9-80ea-000000000001",
CreatorOrganizations: []string{"aquasecurity"},
CreatorTools: []string{"trivy"},
CreatorTools: []string{"trivy-0.38.1"},
Created: "2021-08-25T12:20:30Z",
},
Packages: map[spdx.ElementID]*spdx.Package2_2{
Expand Down Expand Up @@ -678,7 +678,7 @@ func TestMarshaler_Marshal(t *testing.T) {
return h.Sum64(), nil
}

marshaler := tspdx.NewMarshaler(tspdx.WithClock(clock), tspdx.WithNewUUID(newUUID), tspdx.WithHasher(hasher))
marshaler := tspdx.NewMarshaler("0.38.1", tspdx.WithClock(clock), tspdx.WithNewUUID(newUUID), tspdx.WithHasher(hasher))
spdxDoc, err := marshaler.Marshal(tc.inputReport)
require.NoError(t, err)

Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/testdata/happy/bom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-12T17:02:46.826609Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/testdata/happy/empty-bom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-12T17:03:35.840861Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/testdata/happy/os-only-bom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-12T17:04:09.262672Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/testdata/happy/unrelated-bom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-12T17:04:28.43059Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/sbom/spdx/testdata/sad/invalid-source-info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"creationInfo": {
"created": "2022-09-12T17:02:46.826609Z",
"creators": [
"Tool: trivy",
"Tool: trivy-dev",
"Organization: aquasecurity"
]
},
Expand Down