Add compliance policy for empty name and version (#3257)

* add policy for empty name and version

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

* default stub version

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

* modifying ids requires augmenting relationships

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

---------

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

syft/cataloging/compliance.go

@@ -0,0 +1,47 @@
+package cataloging
+
+import (
+	"strings"
+)
+
+const (
+	ComplianceActionKeep ComplianceAction = "keep"
+	ComplianceActionDrop ComplianceAction = "drop"
+	ComplianceActionStub ComplianceAction = "stub"
+)
+
+const UnknownStubValue = "UNKNOWN"
+
+type ComplianceAction string
+
+type ComplianceConfig struct {
+	MissingName    ComplianceAction `yaml:"missing-name" json:"missing-name" mapstructure:"missing-name"`
+	MissingVersion ComplianceAction `yaml:"missing-version" json:"missing-version" mapstructure:"missing-version"`
+}
+
+func DefaultComplianceConfig() ComplianceConfig {
+	// Note: name and version are required minimum SBOM elements by NTIA, thus should be the API default
+	return ComplianceConfig{
+		MissingName:    ComplianceActionDrop,
+		MissingVersion: ComplianceActionStub,
+	}
+}
+
+func (c ComplianceConfig) Parse() ComplianceConfig {
+	return ComplianceConfig{
+		MissingName:    c.MissingName.Parse(),
+		MissingVersion: c.MissingVersion.Parse(),
+	}
+}
+
+func (c ComplianceAction) Parse() ComplianceAction {
+	switch strings.ToLower(string(c)) {
+	case string(ComplianceActionKeep), "include":
+		return ComplianceActionKeep
+	case string(ComplianceActionDrop), "exclude":
+		return ComplianceActionDrop
+	case string(ComplianceActionStub), "replace":
+		return ComplianceActionStub
+	}
+	return ComplianceActionKeep
+}

syft/create_sbom_config.go

@@ -19,6 +19,7 @@ import (
 // CreateSBOMConfig specifies all parameters needed for creating an SBOM.
 type CreateSBOMConfig struct {
 	// required configuration input to specify how cataloging should be performed
+	Compliance         cataloging.ComplianceConfig
 	Search             cataloging.SearchConfig
 	Relationships      cataloging.RelationshipsConfig
 	DataGeneration     cataloging.DataGenerationConfig
@@ -38,6 +39,7 @@ type CreateSBOMConfig struct {
 
 func DefaultCreateSBOMConfig() *CreateSBOMConfig {
 	return &CreateSBOMConfig{
+		Compliance:           cataloging.DefaultComplianceConfig(),
 		Search:               cataloging.DefaultSearchConfig(),
 		Relationships:        cataloging.DefaultRelationshipsConfig(),
 		DataGeneration:       cataloging.DefaultDataGenerationConfig(),
@@ -93,6 +95,12 @@ func (c *CreateSBOMConfig) WithParallelism(p int) *CreateSBOMConfig {
 	return c
 }
 
+// WithComplianceConfig allows for setting the specific compliance configuration for cataloging.
+func (c *CreateSBOMConfig) WithComplianceConfig(cfg cataloging.ComplianceConfig) *CreateSBOMConfig {
+	c.Compliance = cfg
+	return c
+}
+
 // WithSearchConfig allows for setting the specific search configuration for cataloging.
 func (c *CreateSBOMConfig) WithSearchConfig(cfg cataloging.SearchConfig) *CreateSBOMConfig {
 	c.Search = cfg
@@ -225,6 +233,7 @@ func (c *CreateSBOMConfig) packageTasks(src source.Description) ([]task.Task, *t
 		RelationshipsConfig:  c.Relationships,
 		DataGenerationConfig: c.DataGeneration,
 		PackagesConfig:       c.Packages,
+		ComplianceConfig:     c.Compliance,
 	}
 
 	persistentTasks, selectableTasks, err := c.allPackageTasks(cfg)

syft/pkg/cataloger/ocaml/parse_opam_test.go

@@ -3,11 +3,12 @@ package ocaml
 import (
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+
 	"github.com/anchore/syft/syft/artifact"
 	"github.com/anchore/syft/syft/file"
 	"github.com/anchore/syft/syft/pkg"
 	"github.com/anchore/syft/syft/pkg/cataloger/internal/pkgtest"
-	"github.com/stretchr/testify/assert"
 )
 
 func TestParseOpamPackage(t *testing.T) {