stream

Documentation

Index

• Constants
• func AddCdxComponent(component cyclonedx.Component)
• func AddComponent(component types.Component)
• func AddFile(file string)
• func AddOSRelease(release types.OSRelease)
• func AddSecret(secret types.Secret)
• func AggregateSBOM() types.SBOM
• func AggregateSecrets() []types.Secret
• func AggrerateSoftwareManifest() types.SoftwareManifest
• func Attach(event string, handler grove.Handler)
• func CheckIfComponentExists(component types.Component) bool
• func Emit(event string, data interface{})
• func Get(key string) (interface{}, bool)
• func GetComponents() []types.Component
• func GetConfig() types.Config
• func GetFiles() []string
• func GetImageInfo() types.ImageInfo
• func GetImageInstance() v1.Image
• func GetOSReleases() []types.OSRelease
• func GetParameterAllowFileListing() bool
• func GetParameterInput() string
• func GetParameterMaxFileSize() int64
• func GetParameterOutputFormat() string
• func GetParameterQuiet() bool
• func GetParameterScanType() string
• func GetParameterScanners() []string
• func GetParameters() types.Parameters
• func GetRegistryConfig() *types.RegistryConfig
• func GetScanStart() time.Time
• func Set(key string, value interface{})
• func SetConfig(config types.Config)
• func SetDefaultValues()
• func SetImageInstance(image v1.Image)
• func SetParameters(params types.Parameters)
• func SetScanElapsed(duration float64)
• func Watch(key string, handler grove.Handler)

Constants

const (
	ImageScanEvent      string = "image.scan"
	TarballScanEvent    string = "tarball.scan"
	FilesystemScanEvent string = "filesystem.scan"
	FileListEvent       string = "file.list"
	ErrorOccurredEvent  string = "error.occurred"
)

const (
	ParametersStoreKey    string = "parameters"
	ConfigStoreKey        string = "config"
	ImageInstanceStoreKey string = "image-instance"
	FileListStoreKey      string = "file-list"

	ParameterScanTypeStoreKey         string = "parameter.scan-type"
	ParameterInputStoreKey            string = "parameter.input"
	ParameterOutputFormatStoreKey     string = "parameter.output-format"
	ParameterQuietStoreKey            string = "parameter.quiet"
	ParameterMaxFileSizeStoreKey      string = "parameter.max-file-size"
	ParameterScannersStoreKey         string = "parameter.scanners"
	ParameterAllowFileListingStoreKey string = "parameter.allow-file-listing"

	SBOMStoreKey             string = "software-manifest.sbom"
	ComponentsStoreKey       string = "software-manifest.sbom.components"
	DistroStoreKey           string = "software-manifest.distro"
	ImageInfoStoreKey        string = "software-manifest.image-manifest"
	SecretParametersStoreKey string = "software-manifest.secret.parameters"
	SecretsStoreKey          string = "software-manifest.secrets"
	OSReleasesStoreKey       string = "software-manifest.os-releases"

	ScanStartStoreKey   string = "scan.start"
	ScanElapsedStoreKey string = "scan.elapsed"

	CycloneDXComponentsStoreKey string = "cyclonedx.components"
	CycloneDXBOMStoreKey        string = "cyclonedx.bom"
)

Functions

func AddCdxComponent

func AddCdxComponent(component cyclonedx.Component)

func AddComponent

func AddComponent(component types.Component)

func AddFile

func AddFile(file string)

func AddOSRelease

func AddOSRelease(release types.OSRelease)

func AddSecret

func AddSecret(secret types.Secret)

func AggregateSBOM

func AggregateSBOM() types.SBOM

func AggregateSecrets

func AggregateSecrets() []types.Secret

func AggrerateSoftwareManifest

func AggrerateSoftwareManifest() types.SoftwareManifest

func Attach

func Attach(event string, handler grove.Handler)

func CheckIfComponentExists

func CheckIfComponentExists(component types.Component) bool

func Emit

func Emit(event string, data interface{})

func Get

func Get(key string) (interface{}, bool)

func GetComponents

func GetComponents() []types.Component

func GetConfig

func GetConfig() types.Config

func GetFiles

func GetFiles() []string

func GetImageInfo

func GetImageInfo() types.ImageInfo

func GetImageInstance

func GetImageInstance() v1.Image

func GetOSReleases

func GetOSReleases() []types.OSRelease

func GetParameterAllowFileListing

func GetParameterAllowFileListing() bool

func GetParameterInput

func GetParameterInput() string

func GetParameterMaxFileSize

func GetParameterMaxFileSize() int64

func GetParameterOutputFormat

func GetParameterOutputFormat() string

func GetParameterQuiet

func GetParameterQuiet() bool

func GetParameterScanType

func GetParameterScanType() string

func GetParameterScanners

func GetParameterScanners() []string

func GetParameters

func GetParameters() types.Parameters

func GetRegistryConfig

func GetRegistryConfig() *types.RegistryConfig

func GetScanStart

func GetScanStart() time.Time

func Set

func Set(key string, value interface{})

func SetConfig

func SetConfig(config types.Config)

func SetDefaultValues

func SetDefaultValues()

func SetImageInstance

func SetImageInstance(image v1.Image)

func SetParameters

func SetParameters(params types.Parameters)

func SetScanElapsed

func SetScanElapsed(duration float64)

func Watch

func Watch(key string, handler grove.Handler)