-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
marshal.go
398 lines (350 loc) · 10.5 KB
/
marshal.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
package cyclonedx
import (
"fmt"
"strconv"
"strings"
cdx "github.com/CycloneDX/cyclonedx-go"
"github.com/samber/lo"
"golang.org/x/xerrors"
"github.com/aquasecurity/trivy/pkg/digest"
ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
"github.com/aquasecurity/trivy/pkg/purl"
"github.com/aquasecurity/trivy/pkg/sbom/cyclonedx/core"
"github.com/aquasecurity/trivy/pkg/scanner/utils"
"github.com/aquasecurity/trivy/pkg/types"
)
const (
PropertySchemaVersion = "SchemaVersion"
PropertyType = "Type"
PropertyClass = "Class"
// Image properties
PropertySize = "Size"
PropertyImageID = "ImageID"
PropertyRepoDigest = "RepoDigest"
PropertyDiffID = "DiffID"
PropertyRepoTag = "RepoTag"
// Package properties
PropertyPkgID = "PkgID"
PropertyPkgType = "PkgType"
PropertySrcName = "SrcName"
PropertySrcVersion = "SrcVersion"
PropertySrcRelease = "SrcRelease"
PropertySrcEpoch = "SrcEpoch"
PropertyModularitylabel = "Modularitylabel"
PropertyFilePath = "FilePath"
PropertyLayerDigest = "LayerDigest"
PropertyLayerDiffID = "LayerDiffID"
)
var (
ErrInvalidBOMLink = xerrors.New("invalid bomLink format error")
)
type Marshaler struct {
core *core.CycloneDX
}
func NewMarshaler(version string) *Marshaler {
return &Marshaler{
core: core.NewCycloneDX(version),
}
}
// Marshal converts the Trivy report to the CycloneDX format
func (e *Marshaler) Marshal(report types.Report) (*cdx.BOM, error) {
// Convert
root, err := e.MarshalReport(report)
if err != nil {
return nil, xerrors.Errorf("failed to marshal report: %w", err)
}
return e.core.Marshal(root), nil
}
func (e *Marshaler) MarshalReport(r types.Report) (*core.Component, error) {
// Metadata component
root, err := e.rootComponent(r)
if err != nil {
return nil, err
}
for _, result := range r.Results {
components, err := e.marshalResult(r.Metadata, result)
if err != nil {
return nil, err
}
root.Components = append(root.Components, components...)
}
return root, nil
}
func (e *Marshaler) marshalResult(metadata types.Metadata, result types.Result) ([]*core.Component, error) {
if result.Type == ftypes.NodePkg || result.Type == ftypes.PythonPkg ||
result.Type == ftypes.GemSpec || result.Type == ftypes.Jar || result.Type == ftypes.CondaPkg {
// If a package is language-specific package that isn't associated with a lock file,
// it will be a dependency of a component under "metadata".
// e.g.
// Container component (alpine:3.15) ----------------------- #1
// -> Library component (npm package, express-4.17.3) ---- #2
// -> Library component (python package, django-4.0.2) --- #2
// -> etc.
// ref. https://cyclonedx.org/use-cases/#inventory
// Dependency graph from #1 to #2
components, err := e.marshalPackages(metadata, result)
if err != nil {
return nil, err
}
return components, nil
} else if result.Class == types.ClassOSPkg || result.Class == types.ClassLangPkg {
// If a package is OS package, it will be a dependency of "Operating System" component.
// e.g.
// Container component (alpine:3.15) --------------------- #1
// -> Operating System Component (Alpine Linux 3.15) --- #2
// -> Library component (bash-4.12) ------------------ #3
// -> Library component (vim-8.2) ------------------ #3
// -> etc.
//
// Else if a package is language-specific package associated with a lock file,
// it will be a dependency of "Application" component.
// e.g.
// Container component (alpine:3.15) ------------------------ #1
// -> Application component (/app/package-lock.json) ------ #2
// -> Library component (npm package, express-4.17.3) --- #3
// -> Library component (npm package, lodash-4.17.21) --- #3
// -> etc.
// #2
appComponent := e.resultComponent(result, metadata.OS)
// #3
components, err := e.marshalPackages(metadata, result)
if err != nil {
return nil, err
}
// Dependency graph from #2 to #3
appComponent.Components = components
// Dependency graph from #1 to #2
return []*core.Component{appComponent}, nil
}
return nil, nil
}
func (e *Marshaler) marshalPackages(metadata types.Metadata, result types.Result) ([]*core.Component, error) {
// Get dependency parents first
parents := ftypes.Packages(result.Packages).ParentDeps()
// Group vulnerabilities by package ID
vulns := lo.GroupBy(result.Vulnerabilities, func(v types.DetectedVulnerability) string {
return lo.Ternary(v.PkgID == "", fmt.Sprintf("%s@%s", v.PkgName, v.InstalledVersion), v.PkgID)
})
// Create package map
pkgs := lo.SliceToMap(result.Packages, func(pkg ftypes.Package) (string, Package) {
pkgID := lo.Ternary(pkg.ID == "", fmt.Sprintf("%s@%s", pkg.Name, utils.FormatVersion(pkg)), pkg.ID)
return pkgID, Package{
Type: result.Type,
Metadata: metadata,
Package: pkg,
Vulnerabilities: vulns[pkgID],
}
})
var directComponents []*core.Component
for _, pkg := range pkgs {
// Skip indirect dependencies
if pkg.Indirect && len(parents[pkg.ID]) != 0 {
continue
}
// Recursive packages from direct dependencies
if component, err := e.marshalPackage(pkg, pkgs, make(map[string]*core.Component)); err != nil {
return nil, nil
} else if component != nil {
directComponents = append(directComponents, component)
}
}
return directComponents, nil
}
type Package struct {
ftypes.Package
Type ftypes.TargetType
Metadata types.Metadata
Vulnerabilities []types.DetectedVulnerability
}
func (e *Marshaler) marshalPackage(pkg Package, pkgs map[string]Package, components map[string]*core.Component,
) (*core.Component, error) {
if c, ok := components[pkg.ID]; ok {
return c, nil
}
component, err := pkgComponent(pkg)
if err != nil {
return nil, xerrors.Errorf("failed to parse pkg: %w", err)
}
// Skip component that can't be converted from `Package`
if component == nil {
return nil, nil
}
components[pkg.ID] = component
// Iterate dependencies
for _, dep := range pkg.DependsOn {
childPkg, ok := pkgs[dep]
if !ok {
continue
}
child, err := e.marshalPackage(childPkg, pkgs, components)
if err != nil {
return nil, xerrors.Errorf("failed to parse pkg: %w", err)
}
component.Components = append(component.Components, child)
}
return component, nil
}
func (e *Marshaler) rootComponent(r types.Report) (*core.Component, error) {
root := &core.Component{
Name: r.ArtifactName,
}
props := []core.Property{
{
Name: PropertySchemaVersion,
Value: strconv.Itoa(r.SchemaVersion),
},
}
switch r.ArtifactType {
case ftypes.ArtifactContainerImage:
root.Type = cdx.ComponentTypeContainer
props = append(props, core.Property{
Name: PropertyImageID,
Value: r.Metadata.ImageID,
})
p, err := purl.NewPackageURL(purl.TypeOCI, r.Metadata, ftypes.Package{})
if err != nil {
return nil, xerrors.Errorf("failed to new package url for oci: %w", err)
}
if p != nil {
root.PackageURL = p
}
case ftypes.ArtifactVM:
root.Type = cdx.ComponentTypeContainer
case ftypes.ArtifactFilesystem, ftypes.ArtifactRepository:
root.Type = cdx.ComponentTypeApplication
}
if r.Metadata.Size != 0 {
props = append(props, core.Property{
Name: PropertySize,
Value: strconv.FormatInt(r.Metadata.Size, 10),
})
}
if len(r.Metadata.RepoDigests) > 0 {
props = append(props, core.Property{
Name: PropertyRepoDigest,
Value: strings.Join(r.Metadata.RepoDigests, ","),
})
}
if len(r.Metadata.DiffIDs) > 0 {
props = append(props, core.Property{
Name: PropertyDiffID,
Value: strings.Join(r.Metadata.DiffIDs, ","),
})
}
if len(r.Metadata.RepoTags) > 0 {
props = append(props, core.Property{
Name: PropertyRepoTag,
Value: strings.Join(r.Metadata.RepoTags, ","),
})
}
root.Properties = filterProperties(props)
return root, nil
}
func (e *Marshaler) resultComponent(r types.Result, osFound *ftypes.OS) *core.Component {
component := &core.Component{
Name: r.Target,
Properties: []core.Property{
{
Name: PropertyType,
Value: string(r.Type),
},
{
Name: PropertyClass,
Value: string(r.Class),
},
},
}
switch r.Class {
case types.ClassOSPkg:
// UUID needs to be generated since Operating System Component cannot generate PURL.
// https://cyclonedx.org/use-cases/#known-vulnerabilities
if osFound != nil {
component.Name = string(osFound.Family)
component.Version = osFound.Name
}
component.Type = cdx.ComponentTypeOS
case types.ClassLangPkg:
// UUID needs to be generated since Application Component cannot generate PURL.
// https://cyclonedx.org/use-cases/#known-vulnerabilities
component.Type = cdx.ComponentTypeApplication
}
return component
}
func pkgComponent(pkg Package) (*core.Component, error) {
pu, err := purl.NewPackageURL(pkg.Type, pkg.Metadata, pkg.Package)
if err != nil {
return nil, xerrors.Errorf("failed to new package purl: %w", err)
}
name := pkg.Name
version := pkg.Version
var group string
// there are cases when we can't build purl
// e.g. local Go packages
if pu != nil {
version = pu.Version
// use `group` field for GroupID and `name` for ArtifactID for jar files
if pkg.Type == ftypes.Jar {
name = pu.Name
group = pu.Namespace
}
}
properties := []core.Property{
{
Name: PropertyPkgID,
Value: pkg.ID,
},
{
Name: PropertyPkgType,
Value: string(pkg.Type),
},
{
Name: PropertyFilePath,
Value: pkg.FilePath,
},
{
Name: PropertySrcName,
Value: pkg.SrcName,
},
{
Name: PropertySrcVersion,
Value: pkg.SrcVersion,
},
{
Name: PropertySrcRelease,
Value: pkg.SrcRelease,
},
{
Name: PropertySrcEpoch,
Value: strconv.Itoa(pkg.SrcEpoch),
},
{
Name: PropertyModularitylabel,
Value: pkg.Modularitylabel,
},
{
Name: PropertyLayerDigest,
Value: pkg.Layer.Digest,
},
{
Name: PropertyLayerDiffID,
Value: pkg.Layer.DiffID,
},
}
return &core.Component{
Type: cdx.ComponentTypeLibrary,
Name: name,
Group: group,
Version: version,
PackageURL: pu,
Supplier: pkg.Maintainer,
Licenses: pkg.Licenses,
Hashes: lo.Ternary(pkg.Digest == "", nil, []digest.Digest{pkg.Digest}),
Properties: filterProperties(properties),
Vulnerabilities: pkg.Vulnerabilities,
}, nil
}
func filterProperties(props []core.Property) []core.Property {
return lo.Filter(props, func(property core.Property, index int) bool {
return !(property.Value == "" || (property.Name == PropertySrcEpoch && property.Value == "0"))
})
}