Documentation
¶
Overview ¶
Package scan implements functions and helpers to ensure the proper scan of the specified files
Package scan implements functions and helpers to ensure the proper scan of the specified files
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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
type Parameters ¶
type Parameters struct {
CloudProvider []string
DisableFullDesc bool
ExcludeCategories []string
ExcludePaths []string
ExcludeQueries []string
ExcludeResults []string
ExcludeSeverities []string
ExperimentalQueries bool
IncludeQueries []string
InputData string
OutputName string
OutputPath string
Path []string
PayloadPath string
PreviewLines int
QueriesPath []string
LibrariesPath string
ReportFormats []string
Platform []string
ExcludePlatform []string
TerraformVarsPath string
QueryExecTimeout int
LineInfoPayload bool
DisableSecrets bool
SecretsRegexesPath string
ChangedDefaultQueryPath bool
ChangedDefaultLibrariesPath bool
ScanID string
BillOfMaterials bool
ExcludeGitIgnore bool
OpenAPIResolveReferences bool
ParallelScanFlag int
MaxFileSizeFlag int
UseOldSeverities bool
MaxResolverDepth int
KicsComputeNewSimID 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
Click to show internal directories.
Click to hide internal directories.