Skip to content

Commit

Permalink
fix(cyclonedx): move root component from scanned cyclonedx file to ou…
Browse files Browse the repository at this point in the history 
…tput cyclonedx file (#6113)
  • Loading branch information
@DmitriyLewen
DmitriyLewen committed Feb 16, 2024
1 parent 14adbb4 commit a813506
Show file tree
Hide file tree
Showing 4 changed files with 255 additions and 0 deletions.
7 changes: 7 additions & 0 deletions pkg/fanal/types/sbom.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,15 @@ type Component struct {
MIMEType string `json:"mime-type,omitempty" xml:"mime-type,attr,omitempty"`
Type ComponentType `json:"type" xml:"type,attr"`
Name string `json:"name" xml:"name"`
Group string `json:"group" xml:"group"`
Version string `json:"version,omitempty" xml:"version,omitempty"`
PackageURL string `json:"purl,omitempty" xml:"purl,omitempty"`
Properties []Property `json:"properties,omitempty" xml:"properties>property,omitempty"`
}

type Property struct {
Name string `json:"name" xml:"name,attr"`
Value string `json:"value" xml:",chardata"`
}

type (
Expand Down
36 changes: 36 additions & 0 deletions pkg/sbom/cyclonedx/marshal.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,8 @@ func (e *Marshaler) rootComponent(r types.Report) (*core.Component, error) {
root.Type = cdx.ComponentTypeContainer
case ftypes.ArtifactFilesystem, ftypes.ArtifactRepository:
root.Type = cdx.ComponentTypeApplication
case ftypes.ArtifactCycloneDX:
return toCoreComponent(r.CycloneDX.Metadata.Component)
}

if r.Metadata.Size != 0 {
Expand Down Expand Up @@ -396,3 +398,37 @@ func filterProperties(props []core.Property) []core.Property {
return !(property.Value == "" || (property.Name == PropertySrcEpoch && property.Value == "0"))
})
}

func toCoreComponent(c ftypes.Component) (*core.Component, error) {
var props []core.Property
for _, prop := range c.Properties {
var namespace string
name := prop.Name
// Separate the Trivy namespace to avoid double spelling of namespaces.
if strings.HasPrefix(name, core.Namespace) {
name = strings.TrimPrefix(name, core.Namespace)
namespace = core.Namespace
}
props = append(props, core.Property{
Namespace: namespace,
Name: name,
Value: prop.Value,
})
}
var p *purl.PackageURL
if c.PackageURL != "" {
var err error
p, err = purl.FromString(c.PackageURL)
if err != nil {
return nil, xerrors.Errorf("failed to parse purl: %w", err)
}
}

return &core.Component{
Name: c.Name,
Group: c.Group,
PackageURL: p,
Type: cdx.ComponentType(c.Type),
Properties: props,
}, nil
}
203 changes: 203 additions & 0 deletions pkg/sbom/cyclonedx/marshal_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1401,6 +1401,209 @@ func TestMarshaler_Marshal(t *testing.T) {
},
},
},
{
name: "happy path for sbom (cyclonedx) scan",
inputReport: types.Report{
SchemaVersion: report.SchemaVersion,
ArtifactName: "./report.cdx.json",
ArtifactType: ftypes.ArtifactCycloneDX,
CycloneDX: &ftypes.CycloneDX{
BOMFormat: "CycloneDX",
SpecVersion: 6,
SerialNumber: "urn:uuid:ea7360be-19a5-4f61-98dd-d4e170eb6737",
Version: 1,
Metadata: ftypes.Metadata{
Timestamp: "2024-02-16T06:05:53+00:00",
Component: ftypes.Component{
BOMRef: "aff65b54-6009-4c32-968d-748949ef46e8",
Type: "application",
Name: "jackson-databind-2.13.4.1.jar",
Properties: []ftypes.Property{
{
Name: "aquasecurity:trivy:SchemaVersion",
Value: "2",
},
},
},
},
},
Results: types.Results{
{
Target: "Java",
Class: types.ClassLangPkg,
Type: ftypes.Jar,
Packages: []ftypes.Package{
{
Name: "com.fasterxml.jackson.core:jackson-databind",
Version: "2.13.4.1",
Identifier: ftypes.PkgIdentifier{
BOMRef: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
PURL: &packageurl.PackageURL{
Type: packageurl.TypeMaven,
Namespace: "com.fasterxml.jackson.core",
Name: "jackson-databind",
Version: "2.13.4.1",
},
},
FilePath: "jackson-databind-2.13.4.1.jar",
},
},
Vulnerabilities: []types.DetectedVulnerability{
{
VulnerabilityID: "CVE-2022-42003",
PkgName: "com.fasterxml.jackson.core:jackson-databind",
PkgPath: "jackson-databind-2.13.4.1.jar",
PkgIdentifier: ftypes.PkgIdentifier{
BOMRef: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
PURL: &packageurl.PackageURL{
Type: packageurl.TypeMaven,
Namespace: "com.fasterxml.jackson.core",
Name: "jackson-databind",
Version: "2.13.4.1",
},
},
InstalledVersion: "2.13.4.1",
FixedVersion: "2.12.7.1, 2.13.4.2",
Status: dtypes.StatusFixed,
SeveritySource: "ghsa",
PrimaryURL: "https://avd.aquasec.com/nvd/cve-2022-42003",
DataSource: &dtypes.DataSource{
ID: vulnerability.GHSA,
Name: "GitHub Security Advisory Maven",
URL: "https://github.com/advisories?query=type%3Areviewed+ecosystem%3Amaven",
},
Vulnerability: dtypes.Vulnerability{
Title: "jackson-databind: deep wrapper array nesting wrt UNWRAP_SINGLE_VALUE_ARRAYS",
Description: "In FasterXML jackson-databind before versions 2.13.4.1 and 2.12.17.1, resource exhaustion can occur because of a lack of a check in primitive value deserializers to avoid deep wrapper array nesting, when the UNWRAP_SINGLE_VALUE_ARRAYS feature is enabled.",
Severity: dtypes.SeverityHigh.String(),
VendorSeverity: dtypes.VendorSeverity{
vulnerability.GHSA: dtypes.SeverityHigh,
},
CVSS: dtypes.VendorCVSS{
vulnerability.GHSA: dtypes.CVSS{
V3Vector: "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
V3Score: 7.5,
},
},
References: []string{
"https://access.redhat.com/security/cve/CVE-2022-42003",
},
PublishedDate: lo.ToPtr(time.Date(2022, 10, 02, 05, 15, 0, 0, time.UTC)),
LastModifiedDate: lo.ToPtr(time.Date(2022, 12, 20, 10, 15, 0, 0, time.UTC)),
},
},
},
},
},
},
want: &cdx.BOM{
XMLNS: "http://cyclonedx.org/schema/bom/1.5",
BOMFormat: "CycloneDX",
SpecVersion: cdx.SpecVersion1_5,
JSONSchema: "http://cyclonedx.org/schema/bom-1.5.schema.json",
SerialNumber: "urn:uuid:3ff14136-e09f-4df9-80ea-000000000001",
Version: 1,
Metadata: &cdx.Metadata{
Timestamp: "2021-08-25T12:20:30+00:00",
Tools: &cdx.ToolsChoice{
Components: &[]cdx.Component{
{
Type: cdx.ComponentTypeApplication,
Name: "trivy",
Group: "aquasecurity",
Version: "dev",
},
},
},
Component: &cdx.Component{
BOMRef: "3ff14136-e09f-4df9-80ea-000000000002",
Type: cdx.ComponentTypeApplication,
Name: "jackson-databind-2.13.4.1.jar",
Properties: &[]cdx.Property{
{
Name: "aquasecurity:trivy:SchemaVersion",
Value: "2",
},
},
},
},
Components: &[]cdx.Component{
{
BOMRef: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
Type: cdx.ComponentTypeLibrary,
Group: "com.fasterxml.jackson.core",
Name: "jackson-databind",
Version: "2.13.4.1",
PackageURL: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1",
Properties: &[]cdx.Property{
{
Name: "aquasecurity:trivy:FilePath",
Value: "jackson-databind-2.13.4.1.jar",
},
{
Name: "aquasecurity:trivy:PkgType",
Value: "jar",
},
},
},
},
Vulnerabilities: &[]cdx.Vulnerability{
{
ID: "CVE-2022-42003",
Source: &cdx.Source{
Name: string(vulnerability.GHSA),
URL: "https://github.com/advisories?query=type%3Areviewed+ecosystem%3Amaven",
},
Recommendation: "Upgrade com.fasterxml.jackson.core:jackson-databind to version 2.12.7.1, 2.13.4.2",
Ratings: &[]cdx.VulnerabilityRating{
{
Source: &cdx.Source{
Name: string(vulnerability.GHSA),
},
Score: lo.ToPtr(7.5),
Severity: cdx.SeverityHigh,
Method: cdx.ScoringMethodCVSSv31,
Vector: "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H",
},
},
Description: "In FasterXML jackson-databind before versions 2.13.4.1 and 2.12.17.1, resource exhaustion can occur because of a lack of a check in primitive value deserializers to avoid deep wrapper array nesting, when the UNWRAP_SINGLE_VALUE_ARRAYS feature is enabled.",
Advisories: &[]cdx.Advisory{
{
URL: "https://avd.aquasec.com/nvd/cve-2022-42003",
},
{
URL: "https://access.redhat.com/security/cve/CVE-2022-42003",
},
},
Published: "2022-10-02T05:15:00+00:00",
Updated: "2022-12-20T10:15:00+00:00",
Affects: &[]cdx.Affects{
{
Ref: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
Range: &[]cdx.AffectedVersions{
{
Version: "2.13.4.1",
Status: cdx.VulnerabilityStatusAffected,
},
},
},
},
},
},
Dependencies: &[]cdx.Dependency{
{
Ref: "3ff14136-e09f-4df9-80ea-000000000002",
Dependencies: &[]string{
"pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
},
},
{
Ref: "pkg:maven/com.fasterxml.jackson.core/jackson-databind@2.13.4.1?file_path=jackson-databind-2.13.4.1.jar",
Dependencies: lo.ToPtr([]string{}),
},
},
},
},
{
name: "happy path. 2 packages for 1 CVE",
inputReport: types.Report{
Expand Down
9 changes: 9 additions & 0 deletions pkg/sbom/cyclonedx/unmarshal.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -408,13 +408,22 @@ func fillSrcPkg(pkg *ftypes.Package) {
}

func toTrivyCdxComponent(component cdx.Component) ftypes.Component {
var props []ftypes.Property
for _, prop := range lo.FromPtr(component.Properties) {
props = append(props, ftypes.Property{
Name: prop.Name,
Value: prop.Value,
})
}
return ftypes.Component{
BOMRef: component.BOMRef,
MIMEType: component.MIMEType,
Type: ftypes.ComponentType(component.Type),
Name: component.Name,
Group: component.Group,
Version: component.Version,
PackageURL: component.PackageURL,
Properties: props,
}
}

Expand Down

0 comments on commit a813506

Please sign in to comment.