families

Documentation

Index

• type Config
  • func NewConfig() *Config
  • func SetMountPointsForFamiliesInput(mountPoints []string, familiesConfig *Config) *Config
  • func SetOciArchiveForFamiliesInput(archives []string, familiesConfig *Config) *Config
• type FamilyNotifier
• type FamilyResult
• type Manager
  • func New(config *Config) *Manager
  • func (m *Manager) Run(ctx context.Context, notifier FamilyNotifier) []error
• type RunErrors

Types

type Config

type Config struct {
	// Analyzers
	SBOM sbom.Config `json:"sbom" yaml:"sbom" mapstructure:"sbom"`

	// Scanners
	Vulnerabilities  vulnerabilities.Config       `json:"vulnerabilities" yaml:"vulnerabilities" mapstructure:"vulnerabilities"`
	Secrets          secrets.Config               `json:"secrets" yaml:"secrets" mapstructure:"secrets"`
	Rootkits         rootkits.Config              `json:"rootkits" yaml:"rootkits" mapstructure:"rootkits"`
	Malware          malware.Config               `json:"malware" yaml:"malware" mapstructure:"malware"`
	Misconfiguration misconfigurationTypes.Config `json:"misconfiguration" yaml:"misconfiguration" mapstructure:"misconfiguration"`
	InfoFinder       infofinderTypes.Config       `json:"infofinder" yaml:"infofinder" mapstructure:"infofinder"`

	// Enrichers
	Exploits exploits.Config `json:"exploits" yaml:"exploits" mapstructure:"exploits"`

	// Plugins
	Plugins plugins.Config `json:"plugins" yaml:"plugins" mapstructure:"plugins"`
}

func NewConfig

func NewConfig() *Config

func SetMountPointsForFamiliesInput

func SetMountPointsForFamiliesInput(mountPoints []string, familiesConfig *Config) *Config

func SetOciArchiveForFamiliesInput

func SetOciArchiveForFamiliesInput(archives []string, familiesConfig *Config) *Config

TODO(sambetts) Refactor this and the function above.

type FamilyNotifier

type FamilyNotifier interface {
	FamilyStarted(context.Context, types.FamilyType) error
	FamilyFinished(ctx context.Context, res FamilyResult) error
}

type FamilyResult

type FamilyResult struct {
	Result     interfaces.IsResults
	FamilyType types.FamilyType
	Err        error
}

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func New

func New(config *Config) *Manager

func (*Manager) Run

func (m *Manager) Run(ctx context.Context, notifier FamilyNotifier) []error

type RunErrors

type RunErrors map[types.FamilyType]error