Remove MetadataType from core package object and normalize JSON metadataType values (#1983)

* [wip] Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * distinct the package metadata functions Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * remove metadata type from package core model Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * incorporate review feedback for names Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add RPM archive metadata and split parser helpers Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * clarify the python package metadata type Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename the KB metadata type Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * break hackage and composer types by use case Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * linting fix Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix encoding and decoding for syft-json and cyclonedx Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * bump json schema to 11 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update cyclonedx-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update cyclonedx-xml snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update spdx-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update spdx-tv snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update syft-json snapshots Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * correct metadata type in stack yaml parser test Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix bom-ref redactor for cyclonedx-xml Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add tests for legacy package metadata names Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * regenerate json schema v11 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix legacy HackageMetadataType reflect type value check Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * packagemetadata discovery should account for type shadowing Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * bump json schema version to v12 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update json schema to incorporate changes from main Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add syft-json legacy config option Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add tests around v11-v12 json decoding Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add docs for SYFT_JSON_LEGACY Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * rename structs to be compliant with new naming scheme Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
2026-11-05 08:56:41 +01:00 · 2023-10-30 12:12:04 -04:00
parent f442586ec9
commit 1aaa644007
261 changed files with 7010 additions and 4040 deletions
@@ -91,7 +91,7 @@ func createKernelToModuleRelationships(kernelPackages, modulePackages []pkg.Pack

 	modulesByKernelVersion := make(map[string][]*pkg.Package)
 	for idx, p := range modulePackages {
-		m, ok := p.Metadata.(pkg.LinuxKernelModuleMetadata)
+		m, ok := p.Metadata.(pkg.LinuxKernelModule)
 		if !ok {
 			log.Debug("linux-kernel-module package found without metadata: %s@%s", p.Name, p.Version)
 			continue
@@ -20,10 +20,9 @@ func Test_KernelCataloger(t *testing.T) {
 				"/lib/modules/6.0.7-301.fc37.x86_64/vmlinuz",
 			),
 		),
-		Type:         pkg.LinuxKernelPkg,
-		PURL:         "pkg:generic/linux-kernel@6.0.7-301.fc37.x86_64",
-		MetadataType: pkg.LinuxKernelMetadataType,
-		Metadata: pkg.LinuxKernelMetadata{
+		Type: pkg.LinuxKernelPkg,
+		PURL: "pkg:generic/linux-kernel@6.0.7-301.fc37.x86_64",
+		Metadata: pkg.LinuxKernel{
 			Name:            "",
 			Architecture:    "x86",
 			Version:         "6.0.7-301.fc37.x86_64",
@@ -55,10 +54,9 @@ func Test_KernelCataloger(t *testing.T) {
 				),
 			),
 		),
-		Type:         pkg.LinuxKernelModulePkg,
-		PURL:         "pkg:generic/ttynull",
-		MetadataType: pkg.LinuxKernelModuleMetadataType,
-		Metadata: pkg.LinuxKernelModuleMetadata{
+		Type: pkg.LinuxKernelModulePkg,
+		PURL: "pkg:generic/ttynull",
+		Metadata: pkg.LinuxKernelModule{
 			Name:          "ttynull",
 			Version:       "",
 			SourceVersion: "",
@@ -10,15 +10,14 @@ import (

 const linuxKernelPackageName = "linux-kernel"

-func newLinuxKernelPackage(metadata pkg.LinuxKernelMetadata, archiveLocation file.Location) pkg.Package {
+func newLinuxKernelPackage(metadata pkg.LinuxKernel, archiveLocation file.Location) pkg.Package {
 	p := pkg.Package{
-		Name:         linuxKernelPackageName,
-		Version:      metadata.Version,
-		Locations:    file.NewLocationSet(archiveLocation.WithAnnotation(pkg.EvidenceAnnotationKey, pkg.PrimaryEvidenceAnnotation)),
-		PURL:         packageURL(linuxKernelPackageName, metadata.Version),
-		Type:         pkg.LinuxKernelPkg,
-		MetadataType: pkg.LinuxKernelMetadataType,
-		Metadata:     metadata,
+		Name:      linuxKernelPackageName,
+		Version:   metadata.Version,
+		Locations: file.NewLocationSet(archiveLocation.WithAnnotation(pkg.EvidenceAnnotationKey, pkg.PrimaryEvidenceAnnotation)),
+		PURL:      packageURL(linuxKernelPackageName, metadata.Version),
+		Type:      pkg.LinuxKernelPkg,
+		Metadata:  metadata,
 	}

 	p.SetID()
@@ -26,16 +25,15 @@ func newLinuxKernelPackage(metadata pkg.LinuxKernelMetadata, archiveLocation fil
 	return p
 }

-func newLinuxKernelModulePackage(metadata pkg.LinuxKernelModuleMetadata, kmLocation file.Location) pkg.Package {
+func newLinuxKernelModulePackage(metadata pkg.LinuxKernelModule, kmLocation file.Location) pkg.Package {
 	p := pkg.Package{
-		Name:         metadata.Name,
-		Version:      metadata.Version,
-		Locations:    file.NewLocationSet(kmLocation.WithAnnotation(pkg.EvidenceAnnotationKey, pkg.PrimaryEvidenceAnnotation)),
-		Licenses:     pkg.NewLicenseSet(pkg.NewLicensesFromLocation(kmLocation, metadata.License)...),
-		PURL:         packageURL(metadata.Name, metadata.Version),
-		Type:         pkg.LinuxKernelModulePkg,
-		MetadataType: pkg.LinuxKernelModuleMetadataType,
-		Metadata:     metadata,
+		Name:      metadata.Name,
+		Version:   metadata.Version,
+		Locations: file.NewLocationSet(kmLocation.WithAnnotation(pkg.EvidenceAnnotationKey, pkg.PrimaryEvidenceAnnotation)),
+		Licenses:  pkg.NewLicenseSet(pkg.NewLicensesFromLocation(kmLocation, metadata.License)...),
+		PURL:      packageURL(metadata.Name, metadata.Version),
+		Type:      pkg.LinuxKernelModulePkg,
+		Metadata:  metadata,
 	}

 	p.SetID()
@@ -42,7 +42,7 @@ func parseLinuxKernelFile(_ file.Resolver, _ *generic.Environment, reader file.L
 	}, nil, nil
 }

-func parseLinuxKernelMetadata(magicType []string) (p pkg.LinuxKernelMetadata) {
+func parseLinuxKernelMetadata(magicType []string) (p pkg.LinuxKernel) {
 	// Linux kernel x86 boot executable bzImage,
 	// version 5.10.121-linuxkit (root@buildkitsandbox) #1 SMP Fri Dec 2 10:35:42 UTC 2022,
 	// RO-rootFS,
@@ -37,7 +37,7 @@ func parseLinuxKernelModuleFile(_ file.Resolver, _ *generic.Environment, reader
 	}, nil, nil
 }

-func parseLinuxKernelModuleMetadata(r unionreader.UnionReader) (p *pkg.LinuxKernelModuleMetadata, err error) {
+func parseLinuxKernelModuleMetadata(r unionreader.UnionReader) (p *pkg.LinuxKernelModule, err error) {
 	// filename:       /lib/modules/5.15.0-1031-aws/kernel/zfs/zzstd.ko
 	// version:        1.4.5a
 	// license:        Dual BSD/GPL
@@ -64,7 +64,7 @@ func parseLinuxKernelModuleMetadata(r unionreader.UnionReader) (p *pkg.LinuxKern
 	// retpoline:      Y
 	// name:           8821cu
 	// vermagic:       5.10.121-linuxkit SMP mod_unload
-	p = &pkg.LinuxKernelModuleMetadata{
+	p = &pkg.LinuxKernelModule{
 		Parameters: make(map[string]pkg.LinuxKernelModuleParameter),
 	}
 	f, err := elf.NewFile(r)
@@ -100,7 +100,7 @@ func parseLinuxKernelModuleMetadata(r unionreader.UnionReader) (p *pkg.LinuxKern
 	return p, nil
 }

-func addLinuxKernelModuleEntry(k *pkg.LinuxKernelModuleMetadata, entry []byte) error {
+func addLinuxKernelModuleEntry(k *pkg.LinuxKernelModule, entry []byte) error {
 	if len(entry) == 0 {
 		return nil
 	}