Documentation
¶
Index ¶
- type AuditSeverity
- type Finding
- type FindingSlice
- func (s FindingSlice) ByFile() map[string]FindingSlice
- func (s FindingSlice) FilterByConfidence(min float64) FindingSlice
- func (s FindingSlice) FilterBySeverity(min Severity) FindingSlice
- func (s FindingSlice) FilterBySource(source string) FindingSlice
- func (s FindingSlice) Len() int
- func (s FindingSlice) Less(i, j int) bool
- func (s FindingSlice) Summary() FindingSummary
- func (s FindingSlice) Swap(i, j int)
- type FindingSummary
- type Severity
- type TokenSeverity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditSeverity ¶
type AuditSeverity string
AuditSeverity indicates how dangerous a security audit finding is.
const ( AuditSeverityCritical AuditSeverity = "CRITICAL" AuditSeverityWarning AuditSeverity = "WARNING" AuditSeverityInfo AuditSeverity = "INFO" )
type Finding ¶
type Finding struct {
ID string `json:"id"`
Source string `json:"source"`
Concern string `json:"concern"`
Severity Severity `json:"severity"`
File string `json:"file,omitempty"`
URL string `json:"url,omitempty"`
Line int `json:"line,omitempty"`
EndLine int `json:"end_line,omitempty"`
Message string `json:"message"`
CWE string `json:"cwe,omitempty"`
Confidence float64 `json:"confidence"`
Fix string `json:"fix,omitempty"`
Reasoning string `json:"reasoning,omitempty"`
Tags []string `json:"tags,omitempty"`
Metadata map[string]string `json:"metadata,omitempty"`
CreatedAt time.Time `json:"created_at"`
}
Finding represents a unified analysis concern sourced from Hawk support engines.
func FindingFromInspect ¶
FindingFromInspect constructs a Finding from an inspect analysis result.
type FindingSlice ¶
type FindingSlice []Finding
FindingSlice is sortable by severity descending and confidence descending.
func (FindingSlice) ByFile ¶
func (s FindingSlice) ByFile() map[string]FindingSlice
ByFile groups findings by their File field.
func (FindingSlice) FilterByConfidence ¶
func (s FindingSlice) FilterByConfidence(min float64) FindingSlice
FilterByConfidence returns findings whose Confidence is >= min.
func (FindingSlice) FilterBySeverity ¶
func (s FindingSlice) FilterBySeverity(min Severity) FindingSlice
FilterBySeverity returns findings whose Severity is at least min.
func (FindingSlice) FilterBySource ¶
func (s FindingSlice) FilterBySource(source string) FindingSlice
FilterBySource returns findings whose Source matches the given value.
func (FindingSlice) Len ¶
func (s FindingSlice) Len() int
func (FindingSlice) Less ¶
func (s FindingSlice) Less(i, j int) bool
func (FindingSlice) Summary ¶
func (s FindingSlice) Summary() FindingSummary
Summary returns a FindingSummary for the slice.
func (FindingSlice) Swap ¶
func (s FindingSlice) Swap(i, j int)
type FindingSummary ¶
type FindingSummary struct {
Total int `json:"total"`
BySource map[string]int `json:"by_source"`
BySeverity map[string]int `json:"by_severity"`
AvgConfidence float64 `json:"avg_confidence"`
}
FindingSummary provides aggregate counts over a set of findings.
type Severity ¶
type Severity int
Severity represents the impact level of a finding.
func ParseSeverity ¶
ParseSeverity converts a string to a Severity.
type TokenSeverity ¶
type TokenSeverity string
TokenSeverity defines rule severity for compression error patterns.
const ( TokenSeverityCritical TokenSeverity = "critical" TokenSeverityHigh TokenSeverity = "high" TokenSeverityMedium TokenSeverity = "medium" TokenSeverityLow TokenSeverity = "low" )
Source Files