osvscanner

Documentation

Index

• Variables
• func DoScan(actions ScannerActions, r reporter.Reporter) (models.VulnerabilityResults, error)
• func PURLToPackage(purl string) (models.PackageInfo, error)
• type ExperimentalScannerActions
• type ScannerActions

Variables

var ErrAPIFailed = errors.New("API query failed")

ErrAPIFailed describes errors related to querying API endpoints.

var NoPackagesFoundErr = errors.New("no packages found in scan")

NoPackagesFoundErr for when no packages are found during a scan.

var OnlyUncalledVulnerabilitiesFoundErr = errors.New("only uncalled vulnerabilities found")

Deprecated: This error is no longer returned, check the results to determine if this is the case

var VulnerabilitiesFoundErr = errors.New("vulnerabilities found")

VulnerabilitiesFoundErr includes both vulnerabilities being found or license violations being found, however, will not be raised if only uncalled vulnerabilities are found.

Functions

func DoScan

func DoScan(actions ScannerActions, r reporter.Reporter) (models.VulnerabilityResults, error)

Perform osv scanner action, with optional reporter to output information

func PURLToPackage

func PURLToPackage(purl string) (models.PackageInfo, error)

PURLToPackage converts a Package URL string to models.PackageInfo

Deprecated: Use the PURLToPackage in the models package instead.

Types

type ExperimentalScannerActions

type ExperimentalScannerActions struct {
	CompareOffline        bool
	DownloadDatabases     bool
	ShowAllPackages       bool
	ScanLicensesSummary   bool
	ScanLicensesAllowlist []string
	ScanOCIImage          string

	LocalDBPath string
}

type ScannerActions

type ScannerActions struct {
	LockfilePaths        []string
	SBOMPaths            []string
	DirectoryPaths       []string
	GitCommits           []string
	Recursive            bool
	SkipGit              bool
	NoIgnore             bool
	DockerContainerNames []string
	ConfigOverridePath   string
	CallAnalysisStates   map[string]bool

	ExperimentalScannerActions
}