cataloging

Documentation

Index

• Constants
• type ArchiveSearchConfig
  • func DefaultArchiveSearchConfig() ArchiveSearchConfig
  • func (c ArchiveSearchConfig) WithIncludeIndexedArchives(include bool) ArchiveSearchConfig
  • func (c ArchiveSearchConfig) WithIncludeUnindexedArchives(include bool) ArchiveSearchConfig
• type ComplianceAction
  • func (c ComplianceAction) Parse() ComplianceAction
• type ComplianceConfig
  • func DefaultComplianceConfig() ComplianceConfig
  • func (c ComplianceConfig) Parse() ComplianceConfig
• type DataGenerationConfig
  • func DefaultDataGenerationConfig() DataGenerationConfig
  • func (c DataGenerationConfig) WithGenerateCPEs(generate bool) DataGenerationConfig
• type RelationshipsConfig
  • func DefaultRelationshipsConfig() RelationshipsConfig
  • func (c RelationshipsConfig) WithExcludeBinaryPackagesWithFileOwnershipOverlap(exclude bool) RelationshipsConfig
  • func (c RelationshipsConfig) WithPackageFileOwnership(ownership bool) RelationshipsConfig
  • func (c RelationshipsConfig) WithPackageFileOwnershipOverlap(overlap bool) RelationshipsConfig
• type SearchConfig
  • func DefaultSearchConfig() SearchConfig
  • func (c SearchConfig) WithScope(scope source.Scope) SearchConfig
• type UnknownsConfig
  • func DefaultUnknownsConfig() UnknownsConfig

Constants

const UnknownStubValue = "UNKNOWN"

Types

type ArchiveSearchConfig

type ArchiveSearchConfig struct {
	IncludeIndexedArchives   bool `yaml:"include-indexed-archives" json:"include-indexed-archives" mapstructure:"include-indexed-archives"`
	IncludeUnindexedArchives bool `yaml:"include-unindexed-archives" json:"include-unindexed-archives" mapstructure:"include-unindexed-archives"`
}

func DefaultArchiveSearchConfig

func DefaultArchiveSearchConfig() ArchiveSearchConfig

func (ArchiveSearchConfig) WithIncludeIndexedArchives

func (c ArchiveSearchConfig) WithIncludeIndexedArchives(include bool) ArchiveSearchConfig

func (ArchiveSearchConfig) WithIncludeUnindexedArchives

func (c ArchiveSearchConfig) WithIncludeUnindexedArchives(include bool) ArchiveSearchConfig

type ComplianceAction

type ComplianceAction string

const (
	ComplianceActionKeep ComplianceAction = "keep"
	ComplianceActionDrop ComplianceAction = "drop"
	ComplianceActionStub ComplianceAction = "stub"
)

func (ComplianceAction) Parse

func (c ComplianceAction) Parse() ComplianceAction

type ComplianceConfig

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

func DefaultComplianceConfig() ComplianceConfig

func (ComplianceConfig) Parse

func (c ComplianceConfig) Parse() ComplianceConfig

type DataGenerationConfig

type DataGenerationConfig struct {
	GenerateCPEs bool `yaml:"generate-cpes" json:"generate-cpes" mapstructure:"generate-cpes"`
}

func DefaultDataGenerationConfig

func DefaultDataGenerationConfig() DataGenerationConfig

func (DataGenerationConfig) WithGenerateCPEs

func (c DataGenerationConfig) WithGenerateCPEs(generate bool) DataGenerationConfig

type RelationshipsConfig

type RelationshipsConfig struct {
	// PackageFileOwnership will include package-to-file relationships that indicate which files are owned by which packages.
	PackageFileOwnership bool `yaml:"package-file-ownership" json:"package-file-ownership" mapstructure:"package-file-ownership"`

	// PackageFileOwnershipOverlap will include package-to-package relationships that indicate one package is owned by another due to files claimed to be owned by one package are also evidence of another package's existence.
	// For example, if an RPM package is installed and claims to own /etc/app/package.lock and a separate NPM package was discovered by cataloging /etc/app/package.lock, then the two packages will
	// have ownership overlap relationship.
	PackageFileOwnershipOverlap bool `yaml:"package-file-ownership-overlap" json:"package-file-ownership-overlap" mapstructure:"package-file-ownership-overlap"`

	// ExcludeBinaryPackagesWithFileOwnershipOverlap will exclude binary packages from the package catalog that are evident by files also owned by another package.
	// For example, if a binary package representing the /bin/python binary is discovered and there is a python RPM package installed which claims to
	// orn /bin/python, then the binary package will be excluded from the catalog altogether if this configuration is set to true.
	ExcludeBinaryPackagesWithFileOwnershipOverlap bool `` /* 184-byte string literal not displayed */
}

func DefaultRelationshipsConfig

func DefaultRelationshipsConfig() RelationshipsConfig

func (RelationshipsConfig) WithExcludeBinaryPackagesWithFileOwnershipOverlap

func (c RelationshipsConfig) WithExcludeBinaryPackagesWithFileOwnershipOverlap(exclude bool) RelationshipsConfig

func (RelationshipsConfig) WithPackageFileOwnership

func (c RelationshipsConfig) WithPackageFileOwnership(ownership bool) RelationshipsConfig

func (RelationshipsConfig) WithPackageFileOwnershipOverlap

func (c RelationshipsConfig) WithPackageFileOwnershipOverlap(overlap bool) RelationshipsConfig

type SearchConfig

type SearchConfig struct {
	Scope source.Scope `yaml:"scope" json:"scope" mapstructure:"scope"`
}

func DefaultSearchConfig

func DefaultSearchConfig() SearchConfig

func (SearchConfig) WithScope

func (c SearchConfig) WithScope(scope source.Scope) SearchConfig

type UnknownsConfig

type UnknownsConfig struct {
	RemoveWhenPackagesDefined         bool
	IncludeExecutablesWithoutPackages bool
	IncludeUnexpandedArchives         bool
}

func DefaultUnknownsConfig

func DefaultUnknownsConfig() UnknownsConfig