sbom

Documentation

Overview

Package sbom holds sbom related files

Index

• Constants
• type Report
• type ScanOptions
  • func ScanOptionsFromConfig(cfg config.Component, containers bool) (scanOpts ScanOptions)
• type ScanRequest
• type ScanResult

Constants

const (
	ScanFilesystemType = "filesystem" // ScanFilesystemType defines the type for file-system scan
	ScanDaemonType     = "daemon"     // ScanDaemonType defines the type for daemon scan
)

Types

type Report

type Report interface {
	ToCycloneDX() (*cyclonedxgo.BOM, error)
	ID() string
}

Report defines the report interface

type ScanOptions

type ScanOptions struct {
	Analyzers        []string
	CheckDiskUsage   bool
	MinAvailableDisk uint64
	Timeout          time.Duration
	WaitAfter        time.Duration
	Fast             bool
	CollectFiles     bool
	UseMount         bool
	OverlayFsScan    bool
}

ScanOptions defines the scan options

func ScanOptionsFromConfig

func ScanOptionsFromConfig(cfg config.Component, containers bool) (scanOpts ScanOptions)

ScanOptionsFromConfig loads the scanning options from the configuration

type ScanRequest

type ScanRequest interface {
	Collector() string
	Type(ScanOptions) string
	ID() string
}

ScanRequest defines the scan request interface

type ScanResult

type ScanResult struct {
	Error     error
	Report    Report
	CreatedAt time.Time
	Duration  time.Duration
	ImgMeta   *workloadmeta.ContainerImageMetadata
}

ScanResult defines the scan result