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): use group field for pom.xml and nodejs files for CycloneDX reports #5922

Merged
merged 1 commit into from
Jan 15, 2024
Merged

fix(sbom): use group field for pom.xml and nodejs files for CycloneDX reports #5922

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
6 changes: 4 additions & 2 deletions integration/testdata/pom-cyclonedx.json.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@
{
"bom-ref": "pkg:maven/com.example/[email protected]",
"type": "library",
"name": "com.example:log4shell",
"group": "com.example",
"name": "log4shell",
"version": "1.0-SNAPSHOT",
"purl": "pkg:maven/com.example/[email protected]",
"properties": [
Expand All @@ -61,7 +62,8 @@
{
"bom-ref": "pkg:maven/com.fasterxml.jackson.core/[email protected]",
"type": "library",
"name": "com.fasterxml.jackson.core:jackson-databind",
"group": "com.fasterxml.jackson.core",
"name": "jackson-databind",
"version": "2.9.1",
"purl": "pkg:maven/com.fasterxml.jackson.core/[email protected]",
"properties": [
Expand Down
8 changes: 6 additions & 2 deletions pkg/sbom/cyclonedx/marshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"strings"

cdx "github.com/CycloneDX/cyclonedx-go"
"github.com/package-url/packageurl-go"
"github.com/samber/lo"
"golang.org/x/xerrors"

Expand Down Expand Up @@ -323,8 +324,11 @@ func pkgComponent(pkg Package) (*core.Component, error) {
// e.g. local Go packages
if pu := pkg.Identifier.PURL; pu != nil {
version = pu.Version
// use `group` field for GroupID and `name` for ArtifactID for jar files
if pkg.Type == ftypes.Jar {
// Use `group` field for GroupID and `name` for ArtifactID for java files
// https://github.com/aquasecurity/trivy/issues/4675
// Use `group` field for npm scopes
// https://github.com/aquasecurity/trivy/issues/5908
if pu.Type == packageurl.TypeMaven || pu.Type == packageurl.TypeNPM {
name = pu.Name
group = pu.Namespace
}
Expand Down
64 changes: 64 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 @@ -1224,6 +1224,26 @@ func TestMarshaler_Marshal(t *testing.T) {
},
},
},
{
Target: "yarn.lock",
Class: types.ClassLangPkg,
Type: ftypes.Yarn,
Packages: []ftypes.Package{
{
ID: "@babel/[email protected]",
Name: "@babel/helper-string-parser",
Version: "7.23.4",
Identifier: ftypes.PkgIdentifier{
PURL: &packageurl.PackageURL{
Type: packageurl.TypeNPM,
Namespace: "@babel",
Name: "helper-string-parser",
Version: "7.23.4",
},
},
},
},
},
},
},
want: &cdx.BOM{
Expand Down Expand Up @@ -1270,6 +1290,21 @@ func TestMarshaler_Marshal(t *testing.T) {
},
},
},
{
BOMRef: "3ff14136-e09f-4df9-80ea-000000000004",
Type: cdx.ComponentTypeApplication,
Name: "yarn.lock",
Properties: &[]cdx.Property{
{
Name: "aquasecurity:trivy:Class",
Value: "lang-pkgs",
},
{
Name: "aquasecurity:trivy:Type",
Value: "yarn",
},
},
},
{
BOMRef: "pkg:gem/[email protected]",
Type: "library",
Expand Down Expand Up @@ -1301,13 +1336,32 @@ func TestMarshaler_Marshal(t *testing.T) {
},
},
},
{
BOMRef: "pkg:npm/%40babel/[email protected]",
Type: "library",
Name: "helper-string-parser",
Group: "@babel",
Version: "7.23.4",
PackageURL: "pkg:npm/%40babel/[email protected]",
Properties: &[]cdx.Property{
{
Name: "aquasecurity:trivy:PkgID",
Value: "@babel/[email protected]",
},
{
Name: "aquasecurity:trivy:PkgType",
Value: "yarn",
},
},
},
},
Vulnerabilities: &[]cdx.Vulnerability{},
Dependencies: &[]cdx.Dependency{
{
Ref: "3ff14136-e09f-4df9-80ea-000000000002",
Dependencies: &[]string{
"3ff14136-e09f-4df9-80ea-000000000003",
"3ff14136-e09f-4df9-80ea-000000000004",
"pkg:maven/org.springframework/[email protected]?file_path=spring-web-5.3.22.jar",
},
},
Expand All @@ -1317,6 +1371,12 @@ func TestMarshaler_Marshal(t *testing.T) {
"pkg:gem/[email protected]",
},
},
{
Ref: "3ff14136-e09f-4df9-80ea-000000000004",
Dependencies: &[]string{
"pkg:npm/%40babel/[email protected]",
},
},
{
Ref: "pkg:gem/[email protected]",
Dependencies: lo.ToPtr([]string{}),
Expand All @@ -1325,6 +1385,10 @@ func TestMarshaler_Marshal(t *testing.T) {
Ref: "pkg:maven/org.springframework/[email protected]?file_path=spring-web-5.3.22.jar",
Dependencies: lo.ToPtr([]string{}),
},
{
Ref: "pkg:npm/%40babel/[email protected]",
Dependencies: lo.ToPtr([]string{}),
},
},
},
},
Expand Down
7 changes: 4 additions & 3 deletions pkg/sbom/cyclonedx/testdata/happy/bom.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,9 @@
]
},
{
"bom-ref": "pkg:npm/[email protected]?file_path=app%2Fapp%2Fpackage.json",
"bom-ref": "pkg:npm/@example/[email protected]?file_path=app%2Fapp%2Fpackage.json",
"type": "library",
"group": "@example",
"name": "bootstrap",
"version": "5.0.2",
"licenses": [
Expand All @@ -132,7 +133,7 @@
}
}
],
"purl": "pkg:npm/[email protected]",
"purl": "pkg:npm/@example/[email protected]",
"properties": [
{
"name": "aquasecurity:trivy:FilePath",
Expand Down Expand Up @@ -265,7 +266,7 @@
"60e9f57b-d4a6-4f71-ad14-0893ac609182",
"pkg:maven/org.codehaus.mojo/[email protected]?file_path=app%2Fmaven%2Ftarget%2Fchild-project-1.0.jar",
"pkg:maven/com.example/[email protected]",
"pkg:npm/[email protected]?file_path=app%2Fapp%2Fpackage.json",
"pkg:npm/@example/[email protected]?file_path=app%2Fapp%2Fpackage.json",
"100925ff-7c0a-470f-a725-8fb973b40e7b",
"1a111e6b-a682-470e-8b0e-aaa49d93cd39"
]
Expand Down
15 changes: 12 additions & 3 deletions pkg/sbom/cyclonedx/unmarshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,10 +419,11 @@ func toTrivyCdxComponent(component cdx.Component) ftypes.Component {
}

func packageName(typ, pkgNameFromPurl string, component cdx.Component) string {
if typ == packageurl.TypeMaven {
// Jar uses `Group` field for `GroupID`
if typ == packageurl.TypeMaven || typ == packageurl.TypeNPM {
// Maven uses `Group` field for `GroupID`
// Npm uses `Group` field for `Scope`
if component.Group != "" {
return fmt.Sprintf("%s:%s", component.Group, component.Name)
return fmt.Sprintf("%s%s%s", component.Group, packageNameSeparator(typ), component.Name)
} else {
// use name derived from purl if `Group` doesn't exist
return pkgNameFromPurl
Expand All @@ -431,6 +432,14 @@ func packageName(typ, pkgNameFromPurl string, component cdx.Component) string {
return component.Name
}

// packageNameSeparator selects separator to join `group` and `name` fields of the component
func packageNameSeparator(typ string) string {
if typ == packageurl.TypeMaven {
return ":"
}
return "/"
}

// parsePackageLicenses checks all supported license fields and returns a list of licenses.
// https://cyclonedx.org/docs/1.5/json/#components_items_licenses
func parsePackageLicenses(l *cdx.Licenses) []string {
Expand Down
11 changes: 6 additions & 5 deletions pkg/sbom/cyclonedx/unmarshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,15 +172,16 @@ func TestUnmarshaler_Unmarshal(t *testing.T) {
FilePath: "",
Libraries: ftypes.Packages{
{
Name: "bootstrap",
Name: "@example/bootstrap",
Version: "5.0.2",
Identifier: ftypes.PkgIdentifier{
PURL: &packageurl.PackageURL{
Type: packageurl.TypeNPM,
Name: "bootstrap",
Version: "5.0.2",
Type: packageurl.TypeNPM,
Namespace: "@example",
Name: "bootstrap",
Version: "5.0.2",
},
BOMRef: "pkg:npm/[email protected]?file_path=app%2Fapp%2Fpackage.json",
BOMRef: "pkg:npm/@example/[email protected]?file_path=app%2Fapp%2Fpackage.json",
},
Licenses: []string{"MIT"},
Layer: ftypes.Layer{
Expand Down