model

type AnalyzedPaths struct {
	Types        []string
	Exc          []string
	ExpectedLOC  int
	FilePlatform map[string]string
	Inventory    []string
	ChartRoots   []string
	TotalFiles   int
	ContentCache map[string][]byte
}

type ArgumentControl uint8

type ArtifactChange struct {
	ArtifactLocation ArtifactLocation `json:"artifactLocation"`
	Replacements     []FixReplacement `json:"replacements"`
}

type ArtifactLocation struct {
	URI string `json:"uri"`
}

type CodeLine struct {
	Position int
	Line     string
}

type CommentCommand string

type CommentsCommands map[string]string

type Counters struct {
	ScannedFiles           int `json:"files_scanned"`
	ScannedFilesLines      int `json:"lines_scanned"`
	ParsedFiles            int `json:"files_parsed"`
	ParsedFilesLines       int `json:"lines_parsed"`
	IgnoredFilesLines      int `json:"lines_ignored"`
	FailedToScanFiles      int `json:"files_failed_to_scan"`
	TotalQueries           int `json:"queries_total"`
	FailedToExecuteQueries int `json:"queries_failed_to_execute"`
	FoundResources         int `json:"resources_found"`
}

type DiffAware struct {
	Enabled      bool   `json:"enabled"`
	ConfigDigest string `json:"config_digest"`
	BaseSha      string `json:"base_sha"`
	Files        string `json:"files"`
}

type Document map[string]interface{}

type Documents struct {
	Documents []Document `json:"document"`
}

type Extensions map[string]struct{}

type ExtractedPathObject struct {
	Path      string
	LocalPath bool
}

type FileKind string

type FileMetadata struct {
	ID               string `db:"id"`
	ScanID           string `db:"scan_id"`
	Document         Document
	LineInfoDocument map[string]interface{}

	OriginalData      string   `db:"orig_data"`
	Kind              FileKind `db:"kind"`
	FilePath          string   `db:"file_path"`
	HelmID            string
	IDInfo            map[int]interface{}
	Commands          CommentsCommands
	LinesIgnore       []int
	ResolvedFiles     map[string]ResolvedFile
	LinesOriginalData *[]string

	IsMinified bool

	// HelmAttribution says which source actions emitted a rendered Helm
	// resource whose YAML lives in named templates; nil when none is known.
	HelmAttribution *HelmAttribution
	// Reported, when set, is where this file's findings are reported instead of
	// FilePath (see ResolvedHelm.Reported).
	Reported *ReportedLocation
	// Archive is the chart archive the file was rendered from, if any (see
	// ResolvedHelm.Archive).
	Archive string
	// ModuleCallChain: synthetic rows for instantiated local modules; used in SARIF fingerprint (Terraform only).
	ModuleCallChain string
	// ModuleAttributions maps resourceType.resourceName to attribution when a synthetic
	// document groups multiple module resources from the same file.
	ModuleAttributions map[string]*ModuleAttribution
	// Platform is the lowercased platform the file was classified as (e.g.
	// "ansible", "kubernetes", "terraform"); "" when undetermined. Used by the
	// engine to evaluate each query only against documents of its own platform.
	Platform string
	// contains filtered or unexported fields
}

type FileMetadatas []*FileMetadata

type FixContent struct {
	Text string `json:"text"`
}

type FixMessage struct {
	Text string `json:"text"`
}

type FixReplacement struct {
	DeletedRegion   SarifRegion `json:"deletedRegion"`
	InsertedContent FixContent  `json:"insertedContent,omitempty"`
}

type Framework struct {
	Framework        string `json:"framework"`
	FrameworkVersion string `json:"framework_version"`
	Requirement      string `json:"requirement"`
	Control          string `json:"control"`
}

type HelmAttribution struct {
	Invocations HelmInvocations
	// RenderedContent is the rendered document the invocations' lines refer
	// to, to find which rendered line a finding is on.
	RenderedContent string
}

type HelmIDLineRange struct {
	Start int
	End   int
}

type HelmInvocationAt struct {
	// RenderedLine is a 1-based line of the rendered document as stored, ID
	// stamps included.
	RenderedLine int
	// RenderedEnd is the rendered line after the last one the action emitted,
	// or 0 when unknown: the output then runs up to an unknown later line.
	RenderedEnd int
	// Position is in the template as written, without ID stamps: a 1-based
	// line and a 0-based byte column.
	Position ResourceLine
}

type HelmInvocations []HelmInvocationAt

type Ignore struct {
	// Lines is the lines to ignore
	Lines []int
}

type LineObject struct {
	Line int                      `json:"_dd_line"`
	Arr  []map[string]*LineObject `json:"_dd_arr,omitempty"`
}

type ModuleArgument struct {
	LineStart int
	LineEnd   int
	Control   ArgumentControl
	CallSite  SourceLocation
}

type ModuleAttribution struct {
	Source             string           `json:"source,omitempty"`
	SourceType         string           `json:"source_type,omitempty"`
	Version            string           `json:"version,omitempty"`
	DependencyType     string           `json:"dependency_type,omitempty"`
	CallSite           SourceLocation   `json:"call_site,omitempty"`
	ModuleCodeLocation SourceLocation   `json:"code_location,omitempty"`
	ModulePath         []ModulePathHop  `json:"module_path,omitempty"`
	ModuleCodeOwned    bool             `json:"-"`
	Arguments          []ModuleArgument `json:"-"`
	ArgumentControl    ArgumentControl  `json:"-"`
}

type ModuleAttributionSARIF struct {
	Source             string          `json:"source,omitempty"`
	SourceType         string          `json:"source_type,omitempty"`
	Version            string          `json:"version,omitempty"`
	DependencyType     string          `json:"dependency_type,omitempty"`
	ModuleCodeLocation SourceLocation  `json:"code_location,omitempty"`
	ModulePath         []ModulePathHop `json:"module_path"`
}

type ModulePathHop struct {
	Name         string         `json:"name,omitempty"`
	Source       string         `json:"source,omitempty"`
	SourceType   string         `json:"source_type,omitempty"`
	Version      string         `json:"version,omitempty"`
	CodeLocation SourceLocation `json:"code_location,omitempty"`
}

type PathParameters struct {
	ScannedPaths      []string
	PathExtractionMap map[string]ExtractedPathObject
}

type QueryConfig struct {
	FileKind []FileKind
	Platform string
}

type QueryMetadata struct {
	InputData string
	Query     string
	Content   string
	Metadata  map[string]interface{}
	Platform  string
	CWE       string
	// special field for generic queries
	// represents how many queries are aggregated into a single rego file
	Aggregation  int
	Experimental bool
}

type QueryResult struct {
	QueryName                   string           `json:"query_name"`
	QueryID                     string           `json:"query_id"`
	LegacyQueryID               string           `json:"legacy_query_id"`
	QueryURI                    string           `json:"query_url"`
	Severity                    Severity         `json:"severity"`
	Platform                    string           `json:"platform"`
	CWE                         string           `json:"cwe,omitempty"`
	CloudProvider               string           `json:"cloud_provider,omitempty"`
	Category                    string           `json:"category"`
	Experimental                bool             `json:"experimental"`
	Description                 string           `json:"description"`
	DescriptionID               string           `json:"description_id"`
	CISDescriptionIDFormatted   string           `json:"cis_description_id,omitempty"`
	CISDescriptionTitle         string           `json:"cis_description_title,omitempty"`
	CISDescriptionTextFormatted string           `json:"cis_description_text,omitempty"`
	CISDescriptionID            string           `json:"cis_description_id_raw,omitempty"`
	CISDescriptionText          string           `json:"cis_description_text_raw,omitempty"`
	CISRationaleText            string           `json:"cis_description_rationale,omitempty"`
	CISBenchmarkName            string           `json:"cis_benchmark_name,omitempty"`
	CISBenchmarkVersion         string           `json:"cis_benchmark_version,omitempty"`
	Frameworks                  []Framework      `json:"frameworks,omitempty"`
	Files                       []VulnerableFile `json:"files"`
}

type QueryResultSlice []QueryResult

type ReportedLocation struct {
	Path string
	Line int
	// LineText and Snippet are the content around Line in Path.
	LineText string
	Snippet  []CodeLine
}

type RepositoryCommitInfo struct {
	RepositoryUrl string `json:"repository_url,omitempty"`
	Branch        string `json:"branch,omitempty"`
	CommitSHA     string `json:"sha,omitempty"`
}

type ResolvedFile struct {
	Path         string
	Content      []byte
	LinesContent *[]string
}

type ResolvedFileSplit struct {
	Path  string
	Lines []string
}

type ResolvedFiles struct {
	File     []ResolvedHelm
	Excluded []string
	// Covered lists the Helm template files the render loaded, at the paths they
	// are reported at, including those that rendered to nothing. A raw copy of one
	// is not scanned: the render already covered it.
	Covered []string
}

type ResolvedHelm struct {
	FileName string
	// Reported is where findings are reported when FileName is not a place in
	// the repository: a dependency packaged as an archive renders from unpacked
	// file names that exist only inside the archive.
	Reported *ReportedLocation
	// Archive is the chart archive in the repository the file was rendered from,
	// when it is a packaged dependency, so that path filters can name it.
	Archive             string
	Content             []byte
	OriginalData        []byte
	SplitID             string
	SourceDocumentIndex int
	// HelmInvocations lists every invocation that emitted part of Content, in
	// order, at their positions in the template as written.
	HelmInvocations HelmInvocations
	IDInfo          map[int]interface{}
	IsCRD           bool
}

type ResourceLine struct {
	Col  int
	Line int
}

type ResourceLocation struct {
	Start ResourceLine
	End   ResourceLine
}

type SCIInfo struct {
	DiffAware            DiffAware
	RepositoryDir        string
	RepositoryCommitInfo RepositoryCommitInfo `json:"repository_commit_info"`
	OrgId                int64                `json:"org_id"`
}

type SarifFix struct {
	ArtifactChanges []ArtifactChange `json:"artifactChanges"`
	Description     FixMessage       `json:"description"`
}

type SarifRegion struct {
	StartLine   int `json:"startLine"`
	EndLine     int `json:"endLine"`
	StartColumn int `json:"startColumn"`
	EndColumn   int `json:"endColumn"`
}

type SarifResourceLocation struct {
	Line int `json:"line"`
	Col  int `json:"col"`
}

type Severity string

type SeveritySummary struct {
	ScanID            string           `json:"scan_id"`
	SeverityCounters  map[Severity]int `json:"severity_counters"`
	TotalCounter      int              `json:"total_counter"`
	TotalBOMResources int              `json:"total_bom_resources"`
}

type SourceLocation struct {
	Filename    string `json:"filename,omitempty"`
	LineStart   int    `json:"line_start,omitempty"`
	LineEnd     int    `json:"line_end,omitempty"`
	ColumnStart int    `json:"column_start,omitempty"`
	ColumnEnd   int    `json:"column_end,omitempty"`
}

type Summary struct {
	Version string `json:"kics_version,omitempty"`
	Counters
	SeveritySummary
	Times
	ScannedPaths []string          `json:"paths"`
	Queries      QueryResultSlice  `json:"queries"`
	Bom          QueryResultSlice  `json:"bill_of_materials,omitempty"`
	FilePaths    map[string]string `json:"-"`
}

type Times struct {
	Start time.Time `json:"start"`
	End   time.Time `json:"end"`
}

type Vulnerability struct {
	ID                    int              `json:"id"`
	ScanID                string           `db:"scan_id" json:"-"`
	FileID                string           `db:"file_id" json:"-"`
	FileName              string           `db:"file_name" json:"fileName"`
	QueryID               string           `db:"query_id" json:"queryID"`
	LegacyQueryID         string           `db:"legacy_query_id" json:"legacyQueryID"`
	QueryName             string           `db:"query_name" json:"queryName"`
	QueryURI              string           `json:"-"`
	Category              string           `json:"category"`
	Experimental          bool             `json:"experimental"`
	Description           string           `json:"description"`
	DescriptionID         string           `json:"descriptionID"`
	Platform              string           `db:"platform" json:"platform"`
	CWE                   string           `db:"cwe" json:"cwe"`
	Severity              Severity         `json:"severity"`
	Line                  int              `json:"line"`
	VulnerabilityLocation ResourceLocation `json:"resourceLocation"`
	VulnLines             *[]CodeLine      `json:"vulnLines"`
	ResourceType          string           `db:"resource_type" json:"resourceType"`
	ResourceName          string           `db:"resource_name" json:"resourceName"`
	SearchKey             string           `db:"search_key" json:"searchKey"`
	SearchLine            int              `db:"search_line" json:"searchLine"`
	SearchValue           string           `db:"search_value" json:"searchValue"`
	Value                 *string          `db:"value" json:"value"`
	CloudProvider         string           `json:"cloud_provider"`
	Remediation           string           `db:"remediation" json:"remediation"`
	RemediationType       string           `db:"remediation_type" json:"remediation_type"`
	RemediationLocation   ResourceLocation `json:"remediationLocation"`
	QueryDuration         time.Duration    `json:"query_duration"`
	LineWithVulnerability string           `json:"lineWithVulnerability"`
	ResourceSource        string           `json:"resourceSource"`
	FileSource            []string         `json:"fileSource"`
	BlockLocation         ResourceLocation `json:"blockLocation"`
	Frameworks            []Framework      `json:"frameworks,omitempty"`
	// IsSuppressed marks a finding as kept-for-SARIF but excluded from
	// severity counters; the kind/justification map directly to SARIF
	// `suppressions[]`.
	IsSuppressed             bool   `json:"isSuppressed,omitempty"`
	SuppressionKind          string `json:"suppressionKind,omitempty"`
	SuppressionJustification string `json:"suppressionJustification,omitempty"`
	// ModuleCallChain: local-module instantiation path; empty for root resources; folded into fingerprint.
	ModuleCallChain string `json:"moduleCallChain,omitempty"`
	// ModuleAttribution: provenance for instantiated module findings, serialized
	// so content-push consumers can anchor them on the call site like SARIF does.
	ModuleAttribution *ModuleAttribution `json:"moduleAttribution,omitempty"`
	// DetectedFileName and DetectedLineWithVulnerability are where the finding
	// was detected when it is reported at another place (see ReportedLocation).
	// They stay its identity: every file of a packaged dependency is reported
	// at one declaration line.
	DetectedFileName              string `json:"-"`
	DetectedLineWithVulnerability string `json:"-"`
}

type VulnerabilityLines struct {
	Line                   int
	VulnLines              *[]CodeLine
	LineWithVulnerability  string
	ResolvedFile           string
	VulnerablilityLocation ResourceLocation
	RemediationLocation    ResourceLocation
	ResourceSource         string
	FileSource             []string
	BlockLocation          ResourceLocation
}

type VulnerableFile struct {
	FileName              string           `json:"file_name"`
	Fingerprint           string           `json:"fingerprint,omitempty"`
	Line                  int              `json:"line"`
	ResourceLocation      ResourceLocation `json:"resource_location"`
	VulnLines             *[]CodeLine      `json:"-"`
	ResourceType          string           `json:"resource_type,omitempty"`
	ResourceName          string           `json:"resource_name,omitempty"`
	SearchKey             string           `json:"search_key"`
	SearchLine            int              `json:"search_line"`
	SearchValue           string           `json:"search_value"`
	Value                 *string          `json:"value,omitempty"`
	Remediation           string           `json:"remediation,omitempty"`
	RemediationType       string           `json:"remediation_type,omitempty"`
	RemediationLocation   ResourceLocation `json:"remediation_location,omitempty"`
	LineWithVulnerability string           `json:"line_content,omitempty"`
	ResourceSource        string           `json:"resource_source,omitempty"`
	FileSource            []string         `json:"file_source,omitempty"`
	BlockLocation         ResourceLocation `json:"block_location,omitempty"`
	// Suppression metadata; see Vulnerability.IsSuppressed.
	IsSuppressed             bool   `json:"is_suppressed,omitempty"`
	SuppressionKind          string `json:"suppression_kind,omitempty"`
	SuppressionJustification string `json:"suppression_justification,omitempty"`
	// ModuleCallChain: local-module call path; empty for root; included in fingerprint.
	ModuleCallChain string `json:"module_call_chain,omitempty"`
	// ModuleAttribution: declaration and body locations for instantiated module findings.
	ModuleAttribution *ModuleAttribution `json:"-"`
}