package
1.7.13
Repository: https://github.com/checkmarx/kics.git
Documentation: pkg.go.dev

# Functions

CreateSummary creates a report for a single scan, based on its scanID.
GetIgnoreLines get the lines to ignore in the KICS results lines ignore can have the lines from the resolved files since inspector secrets only looks to original data, the lines ignore should be replaced in yaml cases.
ProcessCommands processes a slice of commands.
Range returns a slice of lines between the start and end line numbers.
RemoveDuplicates removes duplicate lines from a slice of lines.

# Constants

Constants to describe commands given from comments.
Constants to describe commands given from comments.
Constants to describe commands given from comments.
Constants to describe issue's type.
Constants to describe issue's type.
Constants to describe issue's type.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe what kind of file refers.
Constants to describe vulnerability's severity.
Constants to describe vulnerability's severity.
Constants to describe vulnerability's severity.
Constants to describe vulnerability's severity.
Constants to describe vulnerability's severity.

# Variables

Arrays to group all constants of one type.
Arrays to group all constants of one type.
KICSCommentRgxp is the regexp to identify if a comment is a KICS comment.
KICSCommentRgxpYaml is the regexp to identify if the comment has KICS comment at the end of the comment in YAML.
KICSGetContentCommentRgxp to gets the kics comment on the hel case.
NewIgnore is the ignore struct.

# Structs

AnalyzedPaths is a slice of types and excluded files obtained from the Analyzer.
CodeLine is the lines containing and adjacent to the vulnerability line with their respective positions.
Counters hold information about how many files were scanned, parsed, failed to be scaned, the total of queries and how many queries failed to execute.
Documents (easyjson:json).
ExtractedPathObject is the struct that contains the path location of extracted source and a boolean to check if it is a local source.
FileMetadata is a representation of basic information and content of a file.
Ignore is a struct that holds the lines to ignore.
LineObject is the struct that will hold line information for each key.
PathParameters - structure wraps the required fields for temporary path translation.
QueryConfig is a struct that contains the fileKind and platform of the rego query.
QueryMetadata is a representation of general information about a query.
QueryResult contains a query that tested positive ID, name, severity and a list of files that tested vulnerable.
ResolvedFile is a struct that contains the information of a resolved file, the path and the content in bytes of the file.
ResolvedFiles keeps the information of all file/template resolved.
ResolvedFileSplit is a struct that contains the information of a resolved file, the path and the lines of the file.
ResolvedHelm keeps the information of a file/template resolved.
SeveritySummary contains scans' result numbers, how many vulnerabilities of each severity was detected.
Summary is a report of a single scan.
Times represents an object that contains the start and end time of the scan.
Version - is the model for the version response.
VersionResponse - is the model for the version response.
Vulnerability is a representation of a detected vulnerability in scanned files after running a query.
VulnerabilityLines is the representation of the found line for issue.
VulnerableFile contains information of a vulnerable file and where the vulnerability was found.

# Type aliases

CommentCommand represents a command given from a comment.
CommentsCommands list of commands on a file that will be parsed.
Document (easyjson:json).
Extensions represents a list of supported extensions.
FileKind is the extension of a file.
FileMetadatas is a slice of FileMetadata.
IssueType is the issue's type string representation.
QueryResultSlice is a slice of QueryResult.
Severity of the vulnerability.