scanner

Documentation

Index

• func GetAllPluginConstructors() map[string]plugin_package.PluginConstructor
• func GetAllPluginNames() []string
• func GetPluginConstructorsFromNames(names []string) ([]plugin_package.PluginConstructor, error)
• func NewBOMWithMetadata() *cdx.BOM
• func ReadFilesAndRunScan(params ScannerParameterStruct) error
• func RunScan(bom *cdx.BOM, plugins []plugin_package.Plugin, fs filesystem.Filesystem, ...) error
• type ScannerParameterStruct

Functions

func GetAllPluginConstructors

func GetAllPluginConstructors() map[string]plugin_package.PluginConstructor

func GetAllPluginNames

func GetAllPluginNames() []string

func GetPluginConstructorsFromNames

func GetPluginConstructorsFromNames(names []string) ([]plugin_package.PluginConstructor, error)

func NewBOMWithMetadata

func NewBOMWithMetadata() *cdx.BOM

func ReadFilesAndRunScan

func ReadFilesAndRunScan(params ScannerParameterStruct) error

High-level function to do most heavy lifting for scanning a filesystem with a BOM. Output is written to target.

func RunScan

func RunScan(bom *cdx.BOM, plugins []plugin_package.Plugin, fs filesystem.Filesystem, target io.Writer) error

Types

type ScannerParameterStruct

type ScannerParameterStruct struct {
	dig.In

	Fs            filesystem.Filesystem
	Target        io.Writer
	BomFilePath   string                  `name:"bomFilePath"`
	BomSchemaPath string                  `name:"bomSchemaPath"`
	Plugins       []plugin_package.Plugin `group:"plugins"`
}