add file contents cataloger

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

internal/config/application.go

@@ -38,6 +38,7 @@ type Application struct {
 	Package            packages           `yaml:"package" json:"package" mapstructure:"package"`
 	FileMetadata       FileMetadata       `yaml:"file-metadata" json:"file-metadata" mapstructure:"file-metadata"`
 	FileClassification fileClassification `yaml:"file-classification" json:"file-classification" mapstructure:"file-classification"`
+	Contents           contents           `yaml:"contents" json:"contents" mapstructure:"contents"`
 	Secrets            secrets            `yaml:"secrets" json:"secrets" mapstructure:"secrets"`
 }
 

internal/config/contents.go

@@ -0,0 +1,24 @@
+package config
+
+import (
+	"github.com/anchore/syft/internal/file"
+	"github.com/anchore/syft/syft/source"
+	"github.com/spf13/viper"
+)
+
+type contents struct {
+	Cataloger          catalogerOptions `yaml:"cataloger" json:"cataloger" mapstructure:"cataloger"`
+	SkipFilesAboveSize int64            `yaml:"skip-files-above-size" json:"skip-files-above-size" mapstructure:"skip-files-above-size"`
+	Globs              []string         `yaml:"globs" json:"globs" mapstructure:"globs"`
+}
+
+func (cfg contents) loadDefaultValues(v *viper.Viper) {
+	v.SetDefault("contents.cataloger.enabled", true)
+	v.SetDefault("contents.cataloger.scope", source.SquashedScope)
+	v.SetDefault("contents.skip-files-above-size", 1*file.MB)
+	v.SetDefault("contents.globs", []string{})
+}
+
+func (cfg *contents) parseConfigValues() error {
+	return cfg.Cataloger.parseConfigValues()
+}

internal/presenter/poweruser/json_document.go

@@ -10,6 +10,7 @@ type JSONDocument struct {
 	// require these fields. As an accepted rule in this repo all collections should still be initialized in the
 	// context of being used in a JSON document.
 	FileClassifications []JSONFileClassifications `json:"fileClassifications,omitempty"` // note: must have omitempty
+	FileContents        []JSONFileContents        `json:"fileContents,omitempty"`        // note: must have omitempty
 	FileMetadata        []JSONFileMetadata        `json:"fileMetadata,omitempty"`        // note: must have omitempty
 	Secrets             []JSONSecrets             `json:"secrets,omitempty"`             // note: must have omitempty
 	packages.JSONDocument
@@ -29,6 +30,7 @@ func NewJSONDocument(config JSONDocumentConfig) (JSONDocument, error) {
 
 	return JSONDocument{
 		FileClassifications: NewJSONFileClassifications(config.FileClassifications),
+		FileContents:        NewJSONFileContents(config.FileContents),
 		FileMetadata:        fileMetadata,
 		Secrets:             NewJSONSecrets(config.Secrets),
 		JSONDocument:        pkgsDoc,

internal/presenter/poweruser/json_document_config.go

@@ -14,6 +14,7 @@ type JSONDocumentConfig struct {
 	FileMetadata        map[source.Location]source.FileMetadata
 	FileDigests         map[source.Location][]file.Digest
 	FileClassifications map[source.Location][]file.Classification
+	FileContents        map[source.Location]string
 	Secrets             map[source.Location][]file.SearchResult
 	Distro              *distro.Distro
 	SourceMetadata      source.Metadata

internal/presenter/poweruser/json_file_contents.go

@@ -0,0 +1,31 @@
+package poweruser
+
+import (
+	"sort"
+
+	"github.com/anchore/syft/syft/source"
+)
+
+type JSONFileContents struct {
+	Location source.Location `json:"location"`
+	Contents string          `json:"contents"`
+}
+
+func NewJSONFileContents(data map[source.Location]string) []JSONFileContents {
+	results := make([]JSONFileContents, 0)
+	for location, contents := range data {
+		results = append(results, JSONFileContents{
+			Location: location,
+			Contents: contents,
+		})
+	}
+
+	// sort by real path then virtual path to ensure the result is stable across multiple runs
+	sort.SliceStable(results, func(i, j int) bool {
+		if results[i].Location.RealPath == results[j].Location.RealPath {
+			return results[i].Location.VirtualPath < results[j].Location.VirtualPath
+		}
+		return results[i].Location.RealPath < results[j].Location.RealPath
+	})
+	return results
+}