add deprecation notices and split old and new cataloging config

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>

cmd/syft/cli/eventloop/tasks.go

@@ -8,12 +8,15 @@ import (
 	"github.com/anchore/syft/syft"
 	"github.com/anchore/syft/syft/artifact"
 	"github.com/anchore/syft/syft/file"
+	"github.com/anchore/syft/syft/pkg/cataloger"
 	"github.com/anchore/syft/syft/sbom"
 	"github.com/anchore/syft/syft/source"
 )
 
+// Deprecated: will be removed in syft 1.0
 type Task func(*sbom.Artifacts, *source.Source) ([]artifact.Relationship, error)
 
+// Deprecated: will be removed in syft 1.0
 func Tasks(app *config.Application) ([]Task, error) {
 	var tasks []Task
 
@@ -39,13 +42,22 @@ func Tasks(app *config.Application) ([]Task, error) {
 	return tasks, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func generateCatalogPackagesTask(app *config.Application) (Task, error) {
 	if !app.Package.Cataloger.Enabled {
 		return nil, nil
 	}
 
 	task := func(results *sbom.Artifacts, src *source.Source) ([]artifact.Relationship, error) {
-		packageCatalog, relationships, theDistro, err := syft.CatalogPackages(src, app.ToCatalogerConfig())
+		cfg := cataloger.Config{
+			Search: cataloger.SearchConfig{
+				IncludeIndexedArchives:   app.Package.SearchIndexedArchives,
+				IncludeUnindexedArchives: app.Package.SearchUnindexedArchives,
+				Scope:                    app.Package.Cataloger.ScopeOpt,
+			},
+			Catalogers: app.Catalogers,
+		}
+		packageCatalog, relationships, theDistro, err := syft.CatalogPackages(src, cfg)
 		if err != nil {
 			return nil, err
 		}
@@ -59,6 +71,7 @@ func generateCatalogPackagesTask(app *config.Application) (Task, error) {
 	return task, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func generateCatalogFileMetadataTask(app *config.Application) (Task, error) {
 	if !app.FileMetadata.Cataloger.Enabled {
 		return nil, nil
@@ -83,6 +96,7 @@ func generateCatalogFileMetadataTask(app *config.Application) (Task, error) {
 	return task, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func generateCatalogFileDigestsTask(app *config.Application) (Task, error) {
 	if !app.FileMetadata.Cataloger.Enabled {
 		return nil, nil
@@ -126,6 +140,7 @@ func generateCatalogFileDigestsTask(app *config.Application) (Task, error) {
 	return task, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func generateCatalogSecretsTask(app *config.Application) (Task, error) {
 	if !app.Secrets.Cataloger.Enabled {
 		return nil, nil
@@ -158,6 +173,7 @@ func generateCatalogSecretsTask(app *config.Application) (Task, error) {
 	return task, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func generateCatalogContentsTask(app *config.Application) (Task, error) {
 	if !app.FileContents.Cataloger.Enabled {
 		return nil, nil
@@ -185,6 +201,7 @@ func generateCatalogContentsTask(app *config.Application) (Task, error) {
 	return task, nil
 }
 
+// Deprecated: will be removed in syft 1.0
 func RunTask(t Task, a *sbom.Artifacts, src *source.Source, c chan<- artifact.Relationship, errs chan<- error) {
 	defer close(c)
 

cmd/syft/cli/options/packages.go

@@ -8,8 +8,8 @@ import (
 	"github.com/spf13/viper"
 
 	"github.com/anchore/syft/syft"
+	"github.com/anchore/syft/syft/cataloger"
 	"github.com/anchore/syft/syft/formats/table"
-	"github.com/anchore/syft/syft/pkg/cataloger"
 	"github.com/anchore/syft/syft/source"
 )
 

cmd/syft/cli/packages/packages.go

@@ -3,7 +3,6 @@ package packages
 import (
 	"context"
 	"fmt"
-	"strings"
 
 	"github.com/wagoodman/go-partybus"
 
@@ -15,10 +14,11 @@ import (
 	"github.com/anchore/syft/internal/log"
 	"github.com/anchore/syft/internal/ui"
 	"github.com/anchore/syft/syft"
+	"github.com/anchore/syft/syft/artifact"
+	"github.com/anchore/syft/syft/cataloger"
 	"github.com/anchore/syft/syft/event"
 	"github.com/anchore/syft/syft/file"
 	"github.com/anchore/syft/syft/formats/template"
-	"github.com/anchore/syft/syft/pkg/cataloger"
 	"github.com/anchore/syft/syft/sbom"
 	"github.com/anchore/syft/syft/source"
 )
@@ -103,7 +103,7 @@ func GenerateSBOM(src *source.Source, errs chan error, app *config.Application)
 	}
 
 	cfg := syft.DefaultSBOMBuilderConfig().
-		WithCatalogers(src.Metadata,
+		WithDefaultCatalogers(src.Metadata,
 			cataloger.Config{
 				Search: cataloger.SearchConfig{
 					IncludeIndexedArchives:   app.Package.SearchIndexedArchives,
@@ -118,13 +118,14 @@ func GenerateSBOM(src *source.Source, errs chan error, app *config.Application)
 					GenerateCPEs:          true, // TODO: tie to app config
 					GuessLanguageFromPURL: true, // TODO: tie to app config
 				},
-				FileCatalogingSelection: cataloger.OwnedFilesSelection, // TODO: tie to app config
+				// TODO: make default the owned-files selection
+				FileCatalogingSelection: cataloger.NoFilesSelection, // TODO: tie to app config
 				FileHashers:             hashers,
 			},
-			strings.Join(app.Catalogers, ","), // TODO: update app config to just be a string?
+			app.Catalogers...,
 		)
 
-	return syft.BuildSBOM(src, cfg)
+	return syft.CreateSBOM(src, cfg)
 }
 
 func validateOutputOptions(app *config.Application) error {
@@ -142,3 +143,14 @@ func validateOutputOptions(app *config.Application) error {
 
 	return nil
 }
+
+// Deprecated: will be removed in v1.0.0
+func MergeRelationships(cs ...<-chan artifact.Relationship) (relationships []artifact.Relationship) {
+	for _, c := range cs {
+		for n := range c {
+			relationships = append(relationships, n)
+		}
+	}
+
+	return relationships
+}

cmd/syft/cli/poweruser.go

@@ -18,6 +18,7 @@ const powerUserExample = `  {{.appName}} {{.command}} <image>
   All behavior is controlled via application configuration and environment variables (see https://github.com/anchore/syft#configuration)
 `
 
+// Deprecated: will be removed in syft v1.0.0
 func PowerUser(v *viper.Viper, app *config.Application, ro *options.RootOptions) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "power-user [IMAGE]",

cmd/syft/cli/poweruser/poweruser.go

@@ -26,6 +26,7 @@ import (
 	"github.com/anchore/syft/syft/source"
 )
 
+// Deprecated: will be removed in syft v1.0.0
 func Run(ctx context.Context, app *config.Application, args []string) error {
 	writer, err := sbom.NewWriter(sbom.WriterOption{
 		Format: syftjson.Format(),
@@ -65,6 +66,7 @@ func Run(ctx context.Context, app *config.Application, args []string) error {
 	)
 }
 
+// Deprecated: will be removed in syft v1.0.0
 func execWorker(app *config.Application, si source.Input, writer sbom.Writer) <-chan error {
 	errs := make(chan error)
 	go func() {

internal/config/application.go

@@ -16,12 +16,11 @@ import (
 	"github.com/anchore/go-logger"
 	"github.com/anchore/syft/internal"
 	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft/pkg/cataloger"
+	"github.com/anchore/syft/syft/cataloger"
 )
 
 var (
 	ErrApplicationConfigNotFound = fmt.Errorf("application config not found")
-	catalogerEnabledDefault      = false
 )
 
 type defaultValueLoader interface {
@@ -65,7 +64,6 @@ func (cfg Application) ToCatalogerConfig() cataloger.Config {
 			IncludeUnindexedArchives: cfg.Package.SearchUnindexedArchives,
 			Scope:                    cfg.Package.Cataloger.ScopeOpt,
 		},
-		Catalogers: cfg.Catalogers,
 	}
 }
 

internal/config/file_classification.go

@@ -11,7 +11,7 @@ type fileClassification struct {
 }
 
 func (cfg fileClassification) loadDefaultValues(v *viper.Viper) {
-	v.SetDefault("file-classification.cataloger.enabled", catalogerEnabledDefault)
+	v.SetDefault("file-classification.cataloger.enabled", false)
 	v.SetDefault("file-classification.cataloger.scope", source.SquashedScope)
 }
 

internal/config/file_contents.go

@@ -14,7 +14,7 @@ type fileContents struct {
 }
 
 func (cfg fileContents) loadDefaultValues(v *viper.Viper) {
-	v.SetDefault("file-contents.cataloger.enabled", catalogerEnabledDefault)
+	v.SetDefault("file-contents.cataloger.enabled", false)
 	v.SetDefault("file-contents.cataloger.scope", source.SquashedScope)
 	v.SetDefault("file-contents.skip-files-above-size", 1*file.MB)
 	v.SetDefault("file-contents.globs", []string{})

internal/config/file_metadata.go

@@ -12,7 +12,7 @@ type FileMetadata struct {
 }
 
 func (cfg FileMetadata) loadDefaultValues(v *viper.Viper) {
-	v.SetDefault("file-metadata.cataloger.enabled", catalogerEnabledDefault)
+	v.SetDefault("file-metadata.cataloger.enabled", false)
 	v.SetDefault("file-metadata.cataloger.scope", source.SquashedScope)
 	v.SetDefault("file-metadata.digests", []string{"sha256"})
 }

internal/config/pkg.go

@@ -3,7 +3,7 @@ package config
 import (
 	"github.com/spf13/viper"
 
-	"github.com/anchore/syft/syft/pkg/cataloger"
+	"github.com/anchore/syft/syft/cataloger"
 )
 
 type pkg struct {

internal/config/secrets.go

@@ -16,7 +16,7 @@ type secrets struct {
 }
 
 func (cfg secrets) loadDefaultValues(v *viper.Viper) {
-	v.SetDefault("secrets.cataloger.enabled", catalogerEnabledDefault)
+	v.SetDefault("secrets.cataloger.enabled", false)
 	v.SetDefault("secrets.cataloger.scope", source.AllLayersScope)
 	v.SetDefault("secrets.reveal-values", false)
 	v.SetDefault("secrets.skip-files-above-size", 1*file.MB)

syft/cataloger/config.go

@@ -0,0 +1,78 @@
+package cataloger
+
+import (
+	"crypto"
+
+	"github.com/anchore/syft/syft/pkg/cataloger/java"
+	"github.com/anchore/syft/syft/source"
+)
+
+const (
+	NoFilesSelection    FileCatalogingSelection = "no-files"
+	OwnedFilesSelection FileCatalogingSelection = "owned-files"
+	AllFilesSelection   FileCatalogingSelection = "all-files"
+)
+
+type FileCatalogingSelection string
+
+type Config struct {
+	Search                  SearchConfig
+	Relationships           RelationshipsConfig
+	SyntheticData           SyntheticConfig
+	FileCatalogingSelection FileCatalogingSelection
+	FileHashers             []crypto.Hash
+}
+
+type RelationshipsConfig struct {
+	FileOwnership        bool
+	FileOwnershipOverlap bool
+}
+
+type SyntheticConfig struct {
+	GenerateCPEs          bool
+	GuessLanguageFromPURL bool
+}
+
+type SearchConfig struct {
+	IncludeIndexedArchives   bool
+	IncludeUnindexedArchives bool
+	Scope                    source.Scope
+}
+
+func DefaultConfig() Config {
+	return Config{
+		Search:                  DefaultSearchConfig(),
+		Relationships:           DefaultRelationshipsConfig(),
+		SyntheticData:           DefaultSyntheticConfig(),
+		FileCatalogingSelection: OwnedFilesSelection,
+	}
+}
+
+func DefaultSearchConfig() SearchConfig {
+	return SearchConfig{
+		IncludeIndexedArchives:   true,
+		IncludeUnindexedArchives: false,
+		Scope:                    source.SquashedScope,
+	}
+}
+
+func DefaultSyntheticConfig() SyntheticConfig {
+	return SyntheticConfig{
+		GenerateCPEs:          true,
+		GuessLanguageFromPURL: true,
+	}
+}
+
+func DefaultRelationshipsConfig() RelationshipsConfig {
+	return RelationshipsConfig{
+		FileOwnership:        true,
+		FileOwnershipOverlap: true,
+	}
+}
+
+func (c Config) Java() java.Config {
+	return java.Config{
+		SearchUnindexedArchives: c.Search.IncludeUnindexedArchives,
+		SearchIndexedArchives:   c.Search.IncludeIndexedArchives,
+	}
+}