⭐️ add evidence of package files on disk into sbom

mondoohq · Feb 14, 2024 · 06a5796 · 06a5796
1 parent 6ee9670
commit 06a5796
Show file tree

Hide file tree

Showing 15 changed files with 636 additions and 92 deletions.
diff --git a/apps/cnquery/cmd/sbom.go b/apps/cnquery/cmd/sbom.go
@@ -27,6 +27,7 @@ func init() {
 	sbomCmd.Flags().String("asset-name", "", "User-override for the asset name")
 	sbomCmd.Flags().StringToString("annotation", nil, "Add an annotation to the asset.") // user-added, editable
 	sbomCmd.Flags().StringP("output", "o", "list", "Set output format: "+sbom.AllFormats())
+	sbomCmd.Flags().Bool("with-evidences", false, "Display evidence for each component")
 }
 
 var sbomCmd = &cobra.Command{
@@ -50,6 +51,11 @@ Note this command is experimental and may change in the future.
 		if err != nil {
 			log.Fatal().Err(err).Msg("failed to bind output flag")
 		}
+
+		err = viper.BindPFlag("with-evidences", cmd.Flags().Lookup("with-evidences"))
+		if err != nil {
+			log.Fatal().Err(err).Msg("failed to bind with-evidences flag")
+		}
 	},
 	// we have to initialize an empty run so it shows up as a runnable command in --help
 	Run: func(cmd *cobra.Command, args []string) {},
@@ -100,6 +106,13 @@ var sbomCmdRun = func(cmd *cobra.Command, runtime *providers.Runtime, cliRes *pl
 		log.Fatal().Err(err).Msg("failed to get exporter for output format: " + output)
 	}
 
+	if viper.GetBool("with-evidences") {
+		x, ok := exporter.(*sbom.TextList)
+		if ok {
+			x.ApplyOptions(sbom.WithEvidences())
+		}
+	}
+
 	for _, bom := range boms {
 		output := bytes.Buffer{}
 		err := exporter.Render(&output, &bom)

diff --git a/sbom/cnquery_bom_test.go b/sbom/cnquery_bom_test.go
@@ -30,5 +30,7 @@ func TestSimpleBom(t *testing.T) {
 
 	data := output.String()
 	assert.Contains(t, data, "alpine-baselayout")
-	assert.Contains(t, data, "cpe:2.3:a:alpine-baselayout:alpine-baselayout:1683642107:x86_64:*:*:*:*:amd64:*")
+	assert.Contains(t, data, "cpe:2.3:a:alpine-baselayout:alpine-baselayout:1695795276:aarch64:*:*:*:*:*:*")
+	// check that package files are included
+	assert.Contains(t, data, "etc/profile.d/color_prompt.sh.disabled")
 }
diff --git a/sbom/cyclonedx.go b/sbom/cyclonedx.go
@@ -60,14 +60,41 @@ func (ccx *CycloneDX) convert(bom *Sbom) (*cyclonedx.BOM, error) {
 		if len(pkg.Cpes) > 0 {
 			cpe = pkg.Cpes[0]
 		}
+
+		fileLocations := []cyclonedx.EvidenceOccurrence{}
+
+		// pkg.Location is deprecated, use pkg.Evidences instead
+		if pkg.Location != "" {
+			fileLocations = append(fileLocations, cyclonedx.EvidenceOccurrence{
+				Location: pkg.Location,
+			})
+		}
+
+		if pkg.Evidences != nil {
+			for i := range pkg.Evidences {
+				e := pkg.Evidences[i]
+				if e.Type == EvidenceType_EVIDENCE_TYPE_FILE {
+					fileLocations = append(fileLocations, cyclonedx.EvidenceOccurrence{
+						Location: e.Value,
+					})
+				}
+			}
+		}
+
+		var evidence *cyclonedx.Evidence
+		if len(fileLocations) > 0 {
+			evidence = &cyclonedx.Evidence{
+				Occurrences: &fileLocations,
+			}
+		}
+
 		bomPkg := cyclonedx.Component{
 			Type:       cyclonedx.ComponentTypeLibrary,
 			Name:       pkg.Name,
 			Version:    pkg.Version,
 			PackageURL: pkg.Purl,
 			CPE:        cpe,
-			// TODO: use evidence location in 1.5 once available
-			Description: pkg.Location,
+			Evidence:   evidence,
 		}
 
 		components = append(components, bomPkg)

diff --git a/sbom/cyclonedx_test.go b/sbom/cyclonedx_test.go
@@ -33,5 +33,7 @@ func TestCycloneDX(t *testing.T) {
 	// os.WriteFile("./testdata/bom_cyclone.json", output.Bytes(), 0700)
 	assert.Contains(t, data, "cyclonedx")
 	assert.Contains(t, data, "alpine-baselayout")
-	assert.Contains(t, data, "cpe:2.3:a:alpine-baselayout:alpine-baselayout:1683642107:x86_64:*:*:*:*:amd64:*")
+	assert.Contains(t, data, "cpe:2.3:a:alpine-baselayout:alpine-baselayout:1695795276:aarch64:*:*:*:*:*:*")
+	// check that package files are included
+	assert.Contains(t, data, "etc/profile.d/color_prompt.sh.disabled")
 }
diff --git a/sbom/formats.go b/sbom/formats.go
@@ -50,6 +50,6 @@ func NewExporter(fomat string) Exporter {
 	case FormatList:
 		fallthrough
 	default:
-		return &CliList{}
+		return &TextList{}
 	}
 }
diff --git a/sbom/report_collection.go b/sbom/report_collection.go
@@ -39,13 +39,17 @@ type BomAsset struct {
 }
 
 type BomPackage struct {
-	Name     string   `json:"name,omitempty"`
-	Version  string   `json:"version,omitempty"`
-	Purl     string   `json:"purl,omitempty"`
-	CPEs     []string `json:"cpes.map,omitempty"`
-	FilePath string   `json:"file.path,omitempty"`
-	Format   string   `json:"format,omitempty"`
+	Name    string   `json:"name,omitempty"`
+	Version string   `json:"version,omitempty"`
+	Purl    string   `json:"purl,omitempty"`
+	CPEs    []string `json:"cpes.map,omitempty"`
+	// used by python packages
+	FilePath string `json:"file.path,omitempty"`
+	// used by os packages
+	FilePaths []string `json:"files.map,omitempty"`
+	Format    string   `json:"format,omitempty"`
 }
+
 type BomReport struct {
 	Asset          *BomAsset    `json:"asset,omitempty"`
 	Packages       []BomPackage `json:"packages.list,omitempty"`

diff --git a/sbom/sbom.go b/sbom/sbom.go
@@ -80,25 +80,51 @@ func GenerateBom(r *ReportCollectionJson) ([]Sbom, error) {
 			}
 			if rb.Packages != nil {
 				for _, pkg := range rb.Packages {
-					bom.Packages = append(bom.Packages, &Package{
+					bomPkg := &Package{
 						Name:    pkg.Name,
 						Version: pkg.Version,
 						Purl:    pkg.Purl,
 						Cpes:    pkg.CPEs,
 						Type:    pkg.Format,
-					})
+					}
+
+					for _, filepath := range pkg.FilePaths {
+						bomPkg.Evidences = append(bomPkg.Evidences, &Evidence{
+							Type:  EvidenceType_EVIDENCE_TYPE_FILE,
+							Value: filepath,
+						})
+					}
+
+					bom.Packages = append(bom.Packages, bomPkg)
 				}
 			}
 			if rb.PythonPackages != nil {
 				for _, pkg := range rb.PythonPackages {
-					bom.Packages = append(bom.Packages, &Package{
-						Name:     pkg.Name,
-						Version:  pkg.Version,
-						Purl:     pkg.Purl,
-						Cpes:     pkg.CPEs,
-						Location: pkg.FilePath,
-						Type:     "pypi",
-					})
+					bomPkg := &Package{
+						Name:    pkg.Name,
+						Version: pkg.Version,
+						Purl:    pkg.Purl,
+						Cpes:    pkg.CPEs,
+						Type:    "pypi",
+					}
+
+					// deprecated path, all files are now in the FilePaths field
+					// TODO: update once the pythong resource returns multiple results
+					if pkg.FilePath != "" {
+						bomPkg.Evidences = append(bomPkg.Evidences, &Evidence{
+							Type:  EvidenceType_EVIDENCE_TYPE_FILE,
+							Value: pkg.FilePath,
+						})
+					}
+
+					for _, filepath := range pkg.FilePaths {
+						bomPkg.Evidences = append(bomPkg.Evidences, &Evidence{
+							Type:  EvidenceType_EVIDENCE_TYPE_FILE,
+							Value: filepath,
+						})
+					}
+
+					bom.Packages = append(bom.Packages, bomPkg)
 				}
 			}
 		}

diff --git a/sbom/sbom.mql.yaml b/sbom/sbom.mql.yaml
@@ -12,7 +12,7 @@ packs:
         mql: asset { name platform version arch ids labels cpes.map(uri) }
       - uid: mondoo-sbom-packages
         title: Retrieve list of installed packages
-        mql: packages { name version purl cpes.map(uri) format }
+        mql: packages { name version purl cpes.map(uri) format files.map(path) }
       - uid: mondoo-sbom-python-packages
         title: Retrieve list of installed Python packages
         mql: python.packages { name version purl cpes.map(uri) file.path }