scanner

Documentation

Index

• type Scanner
  • func New(pluginName, configPath, reportFormat string, additionalArgs []string, ...) *Scanner
  • func (s *Scanner) PrepareScanArgs(cfg *config.Config, repos []shared.RepositoryParams, ...) ([]shared.ScannerScanRequest, error)
  • func (s *Scanner) ScanRepos(cfg *config.Config, scanArgs []shared.ScannerScanRequest) (shared.GenericLaunchesResult, error)

Types

type Scanner

type Scanner struct {
	PluginName     string   // Name of the scanner plugin to use
	ConfigPath     string   // Path to the configuration file for the scanner
	ReportFormat   string   // Format of the report to generate (e.g., JSON, Sarif)
	AdditionalArgs []string // Additional arguments for the scanner
	ConcurrentJobs int      // Number of concurrent jobs to run
	// contains filtered or unexported fields
}

Scanner represents the configuration and behavior of a scanner.

func New

func New(pluginName, configPath, reportFormat string, additionalArgs []string, concurrentJobs int, logger hclog.Logger) *Scanner

New creates a new Scanner instance with the provided configuration.

func (*Scanner) PrepareScanArgs

func (s *Scanner) PrepareScanArgs(cfg *config.Config, repos []shared.RepositoryParams, targetPath, outputPath string) ([]shared.ScannerScanRequest, error)

PrepareScanArgs prepares the arguments needed for the scan operation with the provided configuration.

func (*Scanner) ScanRepos

func (s *Scanner) ScanRepos(cfg *config.Config, scanArgs []shared.ScannerScanRequest) (shared.GenericLaunchesResult, error)

ScanRepos scans multiple repositories concurrently and returns the aggregated results.