Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrAPIFailed = models.ErrAPIFailed
ErrAPIFailed is kept in scanner for compatibility; the canonical sentinel lives in models.
View Source
var NoDirectoryPathsFoundErr = errors.New("no directory paths provided to scan")
NoDirectoryPathsFoundErr for when no directory paths are provided to scan.
View Source
var NoPackagesFoundErr = errors.New("no packages found in scan")
NoPackagesFoundErr for when no packages are found during a scan.
View Source
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)
DoScan Perform datadog-sbom-generator scan action, with optional reporter to output information
Types ¶
type ScannerActions ¶
type ScannerActions struct {
DirectoryPaths []string
ExcludePaths []string
Recursive bool
NoIgnore bool
Reachability bool
Debug bool
EnableParsers []string
ManifestParsers bool
DDEnvVars DDEnvVars
ExitOnConfigFailure bool
// ExtractMavenPomArtifactIds controls whether Maven pom.xml artifact IDs
// and parent dependency relationships are extracted and included in the SBOM.
// When false, ScannedArtifact entries are never produced.
ExtractMavenPomArtifactIds bool
}
Click to show internal directories.
Click to hide internal directories.