cataloger

Documentation

Overview

Package cataloger provides the ability to process files from a container image or file system and discover packages (gems, wheels, jars, rpms, debs, etc). Specifically, this package contains both a catalog function to utilize all catalogers defined in child packages as well as the interface definition to implement a cataloger.

Index

• Constants
• func AllCatalogers(cfg Config) []pkg.Cataloger
• func Catalog(resolver file.Resolver, _ *linux.Release, parallelism int, ...) (*pkg.Collection, []artifact.Relationship, error)
• func DirectoryCatalogers(cfg Config) []pkg.Cataloger
• func ExcludeBinaryByFileOwnershipOverlap(r artifact.Relationship, c *pkg.Collection) bool
• func ImageCatalogers(cfg Config) []pkg.Cataloger
• func RequestedAllCatalogers(cfg Config) bool
• type Config
  • func DefaultConfig() Config
  • func (c Config) JavaConfig() java.ArchiveCatalogerConfig
• type Monitor
• type SearchConfig
  • func DefaultSearchConfig() SearchConfig

Constants

const AllCatalogersPattern = "all"

Functions

func AllCatalogers

func AllCatalogers(cfg Config) []pkg.Cataloger

AllCatalogers returns all implemented catalogers

func Catalog

func Catalog(resolver file.Resolver, _ *linux.Release, parallelism int, catalogers ...pkg.Cataloger) (*pkg.Collection, []artifact.Relationship, error)

Catalog a given source (container image or filesystem) with the given catalogers, returning all discovered packages. In order to efficiently retrieve contents from a underlying container image the content fetch requests are done in bulk. Specifically, all files of interest are collected from each catalogers and accumulated into a single request.

func DirectoryCatalogers

func DirectoryCatalogers(cfg Config) []pkg.Cataloger

DirectoryCatalogers returns a slice of locally implemented catalogers that are fit for detecting packages from index files (and select installations)

func ExcludeBinaryByFileOwnershipOverlap

func ExcludeBinaryByFileOwnershipOverlap(r artifact.Relationship, c *pkg.Collection) bool

ExcludeBinaryByFileOwnershipOverlap will remove packages from a collection given the following properties are true 1) the relationship between packages is OwnershipByFileOverlap 2) the parent is an "os" package 3) the child is a synthetic package generated by the binary cataloger 4) the package names are identical This was implemented as a way to help resolve: https://github.com/gsoc2/syft/issues/931

func ImageCatalogers

func ImageCatalogers(cfg Config) []pkg.Cataloger

ImageCatalogers returns a slice of locally implemented catalogers that are fit for detecting installations of packages.

func RequestedAllCatalogers

func RequestedAllCatalogers(cfg Config) bool

Types

type Config

type Config struct {
	Search                          SearchConfig
	Golang                          golang.CatalogerConfig
	LinuxKernel                     kernel.LinuxKernelCatalogerConfig
	Python                          python.CatalogerConfig
	Java                            java.ArchiveCatalogerConfig
	Catalogers                      []string
	Parallelism                     int
	ExcludeBinaryOverlapByOwnership bool
}

TODO: these field naming vs helper function naming schemes are inconsistent.

func DefaultConfig

func DefaultConfig() Config

func (Config) JavaConfig

func (c Config) JavaConfig() java.ArchiveCatalogerConfig

JavaConfig merges relevant config values from Config to return a java.Config struct. Values like IncludeUnindexedArchives and IncludeIndexedArchives are used across catalogers and are not specific to Java requiring this merge.

type Monitor

type Monitor struct {
	FilesProcessed     progress.Monitorable // the number of files selected and contents analyzed from all registered catalogers
	PackagesDiscovered progress.Monitorable // the number of packages discovered from all registered catalogers
}

Monitor provides progress-related data for observing the progress of a Catalog() call (published on the event bus).

type SearchConfig

type SearchConfig struct {
	IncludeIndexedArchives   bool
	IncludeUnindexedArchives bool
	Scope                    source.Scope
}

func DefaultSearchConfig

func DefaultSearchConfig() SearchConfig