Documentation
¶
Index ¶
- Constants
- func Write(findings []Finding, cfg config.Config, ext string, reportPath string) error
- type ArtifactLocation
- type Driver
- type Finding
- type FullDescription
- type Locations
- type Message
- type PartialFingerPrints
- type PhysicalLocation
- type Region
- type Results
- type Rules
- type Runs
- type Sarif
- type ShortDescription
- type Snippet
- type Tool
Constants ¶
View Source
const ( // https://cwe.mitre.org/data/definitions/798.html CWE = "CWE-798" CWE_DESCRIPTION = "Use of Hard-coded Credentials" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ArtifactLocation ¶
type ArtifactLocation struct {
URI string `json:"uri"`
}
type Finding ¶
type Finding struct {
Description string
StartLine int
EndLine int
StartColumn int
EndColumn int
Line string `json:"-"`
Match string
// Secret contains the full content of what is matched in
// the tree-sitter query.
Secret string
// File is the name of the file containing the finding
File string
SymlinkFile string
Commit string
// Entropy is the shannon entropy of Value
Entropy float32
Author string
Email string
Date string
Message string
Tags []string
// Rule is the name of the rule that was matched
RuleID string
// unique identifer
Fingerprint string
}
Finding contains information about strings that have been captured by a tree-sitter query.
type FullDescription ¶
type FullDescription struct {
Text string `json:"text"`
}
type Locations ¶
type Locations struct {
PhysicalLocation PhysicalLocation `json:"physicalLocation"`
}
type PartialFingerPrints ¶
type PhysicalLocation ¶
type PhysicalLocation struct {
ArtifactLocation ArtifactLocation `json:"artifactLocation"`
Region Region `json:"region"`
}
type Results ¶
type Results struct {
Message Message `json:"message"`
RuleId string `json:"ruleId"`
Locations []Locations `json:"locations"`
PartialFingerPrints `json:"partialFingerprints"`
}
type Rules ¶
type Rules struct {
ID string `json:"id"`
Name string `json:"name"`
Description ShortDescription `json:"shortDescription"`
}
type ShortDescription ¶
type ShortDescription struct {
Text string `json:"text"`
}
Click to show internal directories.
Click to hide internal directories.