scan

package
v1.21.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetScaScansStatusCode

func GetScaScansStatusCode(err error, results ...services.ScanResponse) int

Infer the status code of SCA Xray scan, if err occurred or any of the results is `failed` return 1, otherwise return 0.

func RunScaScan

func RunScaScan(strategy SbomScanStrategy, params ScaScanParams) (generalError error)

Types

type SbomScanOption

type SbomScanOption func(sss SbomScanStrategy)

type SbomScanStrategy

type SbomScanStrategy interface {
	// WithOptions allows to set options for the SBOM scan strategy.
	WithOptions(options ...SbomScanOption) SbomScanStrategy
	// PrepareStrategy prepares the strategy for SBOM scanning, should be called once before scanning SBOMs.
	PrepareStrategy() error
	// DeprecatedScanTask scans the given SBOM using the specified technology returning the scan response.
	// TODO: This method is deprecated and only used for backward compatibility until the new BOM can contain all the information scanResponse contains.
	// Missing attributes:
	// - ExtendedInformation (JfrogResearchInformation): ShortDescription, FullDescription, frogResearchSeverityReasons, Remediation
	// - Binary (Docker) indexer attributes (needed for Scan Graph)
	DeprecatedScanTask(target *cyclonedx.BOM) (services.ScanResponse, error)
	// Perform a Scan on the given SBOM and return the enriched CycloneDX BOM and calculated violations. (Violations will be moved at the future to the end of command)
	SbomEnrichTask(target *cyclonedx.BOM) (*cyclonedx.BOM, []services.Violation, error)
}

SbomScanStrategy is an interface for scanning SBOMs using different strategies.

type ScaScanParams

type ScaScanParams struct {
	// The TargetResults contains the Sbom target for scan.
	ScanResults *results.TargetResults
	// Params to decide if the scan should be performed.
	ScansToPerform []utils.SubScanType
	ConfigProfile  *xscServices.ConfigProfile
	// If true and error occur, the error will not end the scan.
	AllowPartialResults bool
	// If provided, the raw scan results will be saved to this directory.
	ResultsOutputDir string
	// For Source-Code (Audit), scans are performed in parallel, thus we need to pass the security parallel runner.
	Runner   *utils.SecurityParallelRunner
	ThreadId int
	// TODO: remove this field once the new flow is fully implemented.
	IsNewFlow bool
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL