Skip to content

Commit

Permalink
Revert "External sources configuration (#1158)"
Browse files Browse the repository at this point in the history
This reverts commit 1329688.

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
  • Loading branch information
spiffcs committed Sep 1, 2022
1 parent 1b0cfe7 commit 4011cc5
Show file tree
Hide file tree
Showing 14 changed files with 16 additions and 132 deletions.
9 changes: 0 additions & 9 deletions cmd/syft/cli/options/packages.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ type PackagesOptions struct {
OverwriteExistingImage bool
ImportTimeout uint
Catalogers []string
ExternalSourcesEnabled bool
}

var _ Interface = (*PackagesOptions)(nil)
Expand Down Expand Up @@ -71,13 +70,9 @@ func (o *PackagesOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error {
cmd.Flags().UintVarP(&o.ImportTimeout, "import-timeout", "", 30,
"set a timeout duration (in seconds) for the upload to Anchore Enterprise")

cmd.Flags().BoolVarP(&o.ExternalSourcesEnabled, "external-sources-enabled", "", false,
"shut off any use of external sources during sbom generation (default false")

return bindPackageConfigOptions(cmd.Flags(), v)
}

//nolint:funlen
func bindPackageConfigOptions(flags *pflag.FlagSet, v *viper.Viper) error {
// Formatting & Input options //////////////////////////////////////////////

Expand Down Expand Up @@ -109,10 +104,6 @@ func bindPackageConfigOptions(flags *pflag.FlagSet, v *viper.Viper) error {
return err
}

if err := v.BindPFlag("external_sources.external-sources-enabled", flags.Lookup("external-sources-enabled")); err != nil {
return err
}

// Upload options //////////////////////////////////////////////////////////

if err := v.BindPFlag("anchore.host", flags.Lookup("host")); err != nil {
Expand Down
4 changes: 1 addition & 3 deletions internal/config/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ type Application struct {
Exclusions []string `yaml:"exclude" json:"exclude" mapstructure:"exclude"`
Attest attest `yaml:"attest" json:"attest" mapstructure:"attest"`
Platform string `yaml:"platform" json:"platform" mapstructure:"platform"`
ExternalSources ExternalSources `yaml:"external_sources" json:"external_sources" mapstructure:"external_sources"`
}

func (cfg Application) ToCatalogerConfig() cataloger.Config {
Expand All @@ -67,8 +66,7 @@ func (cfg Application) ToCatalogerConfig() cataloger.Config {
IncludeUnindexedArchives: cfg.Package.SearchUnindexedArchives,
Scope: cfg.Package.Cataloger.ScopeOpt,
},
Catalogers: cfg.Catalogers,
ExternalSourcesEnabled: cfg.ExternalSources.ExternalSourcesEnabled,
Catalogers: cfg.Catalogers,
}
}

Expand Down
11 changes: 0 additions & 11 deletions internal/config/datasources.go

This file was deleted.

5 changes: 0 additions & 5 deletions syft/pkg/cataloger/alpm/cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@ func (c *Cataloger) Name() string {
return catalogerName
}

// UsesExternalSources indicates that the alpmdb cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing rpm db installation.
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
fileMatches, err := resolver.FilesByGlob(pkg.AlpmDBGlob)
Expand Down
45 changes: 7 additions & 38 deletions syft/pkg/cataloger/cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ type Cataloger interface {
Name() string
// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing the catalog source.
Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error)
// UsesExternalSources returns if the cataloger uses external sources, such as querying a database
UsesExternalSources() bool
}

// ImageCatalogers returns a slice of locally implemented catalogers that are fit for detecting installations of packages.
Expand All @@ -60,7 +58,7 @@ func ImageCatalogers(cfg Config) []Cataloger {
golang.NewGoModuleBinaryCataloger(),
dotnet.NewDotnetDepsCataloger(),
portage.NewPortageCataloger(),
}, cfg)
}, cfg.Catalogers)
}

// DirectoryCatalogers returns a slice of locally implemented catalogers that are fit for detecting packages from index files (and select installations)
Expand All @@ -86,7 +84,7 @@ func DirectoryCatalogers(cfg Config) []Cataloger {
cpp.NewConanfileCataloger(),
portage.NewPortageCataloger(),
haskell.NewHackageCataloger(),
}, cfg)
}, cfg.Catalogers)
}

// AllCatalogers returns all implemented catalogers
Expand Down Expand Up @@ -116,20 +114,10 @@ func AllCatalogers(cfg Config) []Cataloger {
cpp.NewConanfileCataloger(),
portage.NewPortageCataloger(),
haskell.NewHackageCataloger(),
}, cfg)
}, cfg.Catalogers)
}

// RequestedAllCatalogers returns true if all Catalogers have been requested. Takes into account cfg.ExternalSourcesEnabled
func RequestedAllCatalogers(cfg Config) bool {
// if external sources are disabled, only return false if there actually are any catalogers that use external sources
if !cfg.ExternalSourcesEnabled {
for _, cat := range AllCatalogers(Config{Catalogers: []string{"all"}, ExternalSourcesEnabled: true}) {
if cat.UsesExternalSources() {
return false
}
}
}

for _, enableCatalogerPattern := range cfg.Catalogers {
if enableCatalogerPattern == AllCatalogersPattern {
return true
Expand All @@ -138,33 +126,14 @@ func RequestedAllCatalogers(cfg Config) bool {
return false
}

func filterForExternalSources(catalogers []Cataloger, cfg Config) []Cataloger {
if cfg.ExternalSourcesEnabled {
return catalogers
}

var enabledCatalogers []Cataloger
for _, cataloger := range catalogers {
if !cataloger.UsesExternalSources() {
enabledCatalogers = append(enabledCatalogers, cataloger)
} else {
log.Infof("cataloger %v will not be used because external sources are disabled", cataloger.Name())
}
}

return enabledCatalogers
}

func filterCatalogers(catalogers []Cataloger, cfg Config) []Cataloger {
enabledCatalogerPatterns := cfg.Catalogers

func filterCatalogers(catalogers []Cataloger, enabledCatalogerPatterns []string) []Cataloger {
// if cataloger is not set, all applicable catalogers are enabled by default
if len(enabledCatalogerPatterns) == 0 {
return filterForExternalSources(catalogers, cfg)
return catalogers
}
for _, enableCatalogerPattern := range enabledCatalogerPatterns {
if enableCatalogerPattern == AllCatalogersPattern {
return filterForExternalSources(catalogers, cfg)
return catalogers
}
}
var keepCatalogers []Cataloger
Expand All @@ -175,7 +144,7 @@ func filterCatalogers(catalogers []Cataloger, cfg Config) []Cataloger {
}
log.Infof("skipping cataloger %q", cataloger.Name())
}
return filterForExternalSources(keepCatalogers, cfg)
return keepCatalogers
}

func contains(enabledPartial []string, catalogerName string) bool {
Expand Down
34 changes: 6 additions & 28 deletions syft/pkg/cataloger/cataloger_test.go
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package cataloger

import (
"testing"

"github.com/anchore/syft/syft/artifact"
"github.com/anchore/syft/syft/pkg"
"github.com/anchore/syft/syft/source"
"github.com/stretchr/testify/assert"
"testing"
)

var _ Cataloger = (*dummy)(nil)
Expand All @@ -23,17 +22,12 @@ func (d dummy) Catalog(_ source.FileResolver) ([]pkg.Package, []artifact.Relatio
panic("not implemented")
}

func (d dummy) UsesExternalSources() bool {
return false
}

func Test_filterCatalogers(t *testing.T) {
tests := []struct {
name string
patterns []string
ExternalSourcesEnabled bool
catalogers []string
want []string
name string
patterns []string
catalogers []string
want []string
}{
{
name: "no filtering",
Expand Down Expand Up @@ -148,30 +142,14 @@ func Test_filterCatalogers(t *testing.T) {
"go-module-binary-cataloger",
},
},
{ // Note: no catalogers with external sources are currently implemented
name: "external sources enabled",
patterns: []string{"all"},
ExternalSourcesEnabled: true,
catalogers: []string{
"ruby-gemspec-cataloger",
"python-package-cataloger",
"rekor-cataloger",
},
want: []string{
"ruby-gemspec-cataloger",
"python-package-cataloger",
"rekor-cataloger",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
var catalogers []Cataloger
for _, n := range tt.catalogers {
catalogers = append(catalogers, dummy{name: n})
}
cfg := Config{Catalogers: tt.patterns, ExternalSourcesEnabled: tt.ExternalSourcesEnabled}
got := filterCatalogers(catalogers, cfg)
got := filterCatalogers(catalogers, tt.patterns)
var gotNames []string
for _, g := range got {
gotNames = append(gotNames, g.Name())
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/common/generic_cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@ func (c *GenericCataloger) Name() string {
return c.upstreamCataloger
}

// UsesExternalSources indicates that any GenericCatalogor does not use external sources
func (c *GenericCataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing the catalog source.
func (c *GenericCataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
var packages []pkg.Package
Expand Down
5 changes: 2 additions & 3 deletions syft/pkg/cataloger/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ import (
)

type Config struct {
Search SearchConfig
Catalogers []string
ExternalSourcesEnabled bool
Search SearchConfig
Catalogers []string
}

func DefaultConfig() Config {
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/deb/cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,6 @@ func (c *Cataloger) Name() string {
return "dpkgdb-cataloger"
}

// UsesExternalSources indicates that the dpkgdb cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing dpkg support files.
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
dbFileMatches, err := resolver.FilesByGlob(pkg.DpkgDBGlob)
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/golang/binary_cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,6 @@ func (c *Cataloger) Name() string {
return catalogerName
}

// UsesExternalSources indicates that the golang binary cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing rpm db installation.
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
var pkgs []pkg.Package
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/portage/cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,6 @@ func (c *Cataloger) Name() string {
return "portage-cataloger"
}

// UsesExternalSources indicates that the portage cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing portage support files.
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
dbFileMatches, err := resolver.FilesByGlob(pkg.PortageDBGlob)
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/python/package_cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ func (c *PackageCataloger) Name() string {
return "python-package-cataloger"
}

// UsesExternalSources indicates that the python package cataloger does not use external sources
func (c *PackageCataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing python egg and wheel installations.
func (c *PackageCataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
var fileMatches []source.Location
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/rpmdb/cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ func (c *Cataloger) Name() string {
return catalogerName
}

// UsesExternalSources indicates that the rpmdb cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog is given an object to resolve file references and content, this function returns any discovered Packages after analyzing rpm db installation.
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
fileMatches, err := resolver.FilesByGlob(pkg.RpmDBGlob)
Expand Down
5 changes: 0 additions & 5 deletions syft/pkg/cataloger/rust/audit_binary_cataloger.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ func (c *Cataloger) Name() string {
return catalogerName
}

// UsesExternalSources indicates that the audit binary cataloger does not use external sources
func (c *Cataloger) UsesExternalSources() bool {
return false
}

// Catalog identifies executables then attempts to read Rust dependency information from them
func (c *Cataloger) Catalog(resolver source.FileResolver) ([]pkg.Package, []artifact.Relationship, error) {
var pkgs []pkg.Package
Expand Down

0 comments on commit 4011cc5

Please sign in to comment.