scan

Documentation

Overview

Package scan implements functions and helpers to ensure the proper scan of the specified files

Index

• type Client
  • func NewClient(params *Parameters, proBarBuilder *progress.PbBuilder, ...) (*Client, error)
  • func (c *Client) GetQueryPath() (provider.ExtractedPath, error)
  • func (c *Client) PerformScan(ctx context.Context) error
• type Parameters
• type Results

Types

type Client

type Client struct {
	ScanParams        *Parameters
	ScanStartTime     time.Time
	Tracker           *tracker.CITracker
	Storage           *storage.MemoryStorage
	ExcludeResultsMap map[string]bool
	Printer           *consolePrinter.Printer
	ProBarBuilder     *progress.PbBuilder
}

Client represents a scan client

func NewClient

func NewClient(params *Parameters, proBarBuilder *progress.PbBuilder, customPrint *consolePrinter.Printer) (*Client, error)

NewClient initializes the client with all the required parameters

func (*Client) GetQueryPath

func (c *Client) GetQueryPath() (provider.ExtractedPath, error)

GetQueryPath gets all the queries paths

func (*Client) PerformScan

func (c *Client) PerformScan(ctx context.Context) error

PerformScan executes executeScan and postScan

type Parameters

type Parameters struct {
	CloudProvider               []string
	DisableTelemetry            bool
	ExcludeCategories           []string
	ExcludePaths                []string
	ExcludeQueries              []string
	ExcludeResults              []string
	ExcludeSeverities           []string
	IncludeQueries              []string
	InputData                   string
	OutputName                  string
	OutputPath                  string
	Path                        []string
	PayloadPath                 string
	PreviewLines                int
	QueriesPath                 []string
	LibrariesPath               string
	ReportFormats               []string
	Platform                    []string
	ExcludePlatform             []string
	QueryExecTimeout            int
	LineInfoPayload             bool
	DisableSecrets              bool
	SecretsRegexesPath          string
	ChangedDefaultQueryPath     bool
	ChangedDefaultLibrariesPath bool
	ScanID                      string
	BillOfMaterials             bool
	ExcludeGitIgnore            bool
}

Parameters represents all available scan parameters

type Results

type Results struct {
	Results        []model.Vulnerability
	ExtractedPaths provider.ExtractedPath
	Files          model.FileMetadatas
	FailedQueries  map[string]error
}

Results represents a result generated by a single scan