report

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

type ComponentFinding struct {
	// contains a subset of the Finding fields
	// only used for reporting
	RuleID      string
	Optional    bool
	StartLine   int
	EndLine     int
	StartColumn int
	EndColumn   int
	Line        string `json:"-"`
	Match       string
	Secret      string
	// CaptureGroups holds named regex capture groups from the component match.
	CaptureGroups   map[string]string `json:",omitempty"`
	RuleSpecificity int               `json:"-"`
}

type ComponentSet struct {
	Components       []*ComponentFinding `json:"components"`
	ValidationStatus ValidationStatus    `json:"validationStatus,omitempty"`
	ValidationReason string              `json:"validationReason,omitempty"`
}

type ContextRegion struct {
	Snippet Snippet `json:"snippet"`
}

type CredentialComponentReport struct {
	RuleID   string `json:"rule_id"`
	Optional bool   `json:"optional,omitempty"`
}

type CredentialComponentSetReport struct {
	Status     ValidationStatus            `json:"status,omitempty"`
	Reason     string                      `json:"reason,omitempty"`
	Components []CredentialComponentReport `json:"components"`
}

type CredentialReport struct {
	SchemaVersion int                        `json:"schema_version"`
	RuleID        string                     `json:"rule_id"`
	Attributes    map[string]string          `json:"attributes,omitempty"`
	Validation    CredentialValidationReport `json:"validation"`
}

type CredentialReportFormat string

type CredentialReporter struct {
	Format  CredentialReportFormat
	NoColor bool
	Simple  bool
}

type CredentialRuleList struct {
	SchemaVersion int                     `json:"schema_version"`
	Rules         []CredentialRuleSummary `json:"rules"`
}

type CredentialRuleSummary struct {
	RuleID      string                      `json:"rule_id"`
	Description string                      `json:"description,omitempty"`
	Components  []CredentialComponentReport `json:"components,omitempty"`
	Captures    []string                    `json:"captures,omitempty"`
}

type CredentialValidationReport struct {
	Status        ValidationStatus               `json:"status"`
	Reason        string                         `json:"reason,omitempty"`
	Metadata      map[string]any                 `json:"metadata,omitempty"`
	ComponentSets []CredentialComponentSetReport `json:"component_sets,omitempty"`
}

type CsvReporter struct {
}

type Driver struct {
	Name            string  `json:"name"`
	SemanticVersion string  `json:"semanticVersion"`
	InformationUri  string  `json:"informationUri"`
	Rules           []Rules `json:"rules"`
}

type Failure struct {
	XMLName xml.Name `xml:"failure"`
	Data    string   `xml:",chardata"`
	Message string   `xml:"message,attr"`
	Type    string   `xml:"type,attr"`
}

type Finding struct {
	// Rule is the name of the rule that was matched
	RuleID      string
	Description string

	StartLine   int
	EndLine     int
	StartColumn int
	EndColumn   int

	// Regex match that triggered the finding
	Match string

	// Captured secret
	Secret string

	// MatchContext contains surrounding lines around the match
	MatchContext string `json:",omitempty"`

	Line string `json:"-"`

	// CaptureGroups holds named regex capture groups from the match.
	CaptureGroups map[string]string `json:",omitempty"`

	// Fragment used for multi-part rule checking and CEL filtering
	Fragment *sources.Fragment `json:",omitempty"`

	// Attributes holds additional metadata about the finding.
	// Keys are defined in sources.Attr* constants (subject to change), but this is extensible for custom use cases.
	// Attributes are initially populated from the source's Fragment attributes and can be added to in the Detector or ValidationPool.
	// Deprecated "attribute" fields (File, Commit, etc.) are synced from Attributes for compatibility.
	Attributes map[string]string `json:",omitempty"`

	Tags []string

	RuleSpecificity int `json:"-"`

	// ComponentSets holds the Cartesian-product combinations of component findings.
	// Each set is one complete group of components that can be validated independently.
	ComponentSets []ComponentSet `json:",omitempty"`

	ValidationStatus ValidationStatus `json:",omitempty"`
	ValidationReason string           `json:",omitempty"`
	// TODO maybe just use the Attribute map
	ValidationMeta map[string]any `json:",omitempty"`

	// unique identifier
	Fingerprint string

	// Deprecated
	// File is the name of the file containing the finding
	// Deprecated
	File string
	// Deprecated
	SymlinkFile string
	// Deprecated
	Commit string
	// Deprecated
	Link string `json:",omitempty"`

	// Entropy is the shannon entropy of Value
	// Deprecated
	Entropy float32

	// Deprecated
	Author string
	// Deprecated
	Email string
	// Deprecated
	Date string
	// Deprecated
	Message string
	// contains filtered or unexported fields
}

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

type JsonReporter struct {
}

type JunitReporter struct {
}

type Locations struct {
	PhysicalLocation PhysicalLocation `json:"physicalLocation"`
}

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

type PartialFingerPrints struct {
	CommitSha     string `json:"commitSha"`
	Email         string `json:"email"`
	Author        string `json:"author"`
	Date          string `json:"date"`
	CommitMessage string `json:"commitMessage"`
}

type PhysicalLocation struct {
	ArtifactLocation ArtifactLocation `json:"artifactLocation"`
	Region           Region           `json:"region"`
	ContextRegion    *ContextRegion   `json:"contextRegion,omitempty"`
}

type Properties struct {
	Tags []string `json:"tags"`
}

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

type Reporter interface {
	Write(w io.WriteCloser, findings []Finding) error
}

type Results struct {
	Message             Message     `json:"message"`
	RuleId              string      `json:"ruleId"`
	Locations           []Locations `json:"locations"`
	PartialFingerPrints `json:"partialFingerprints"`
	Properties          Properties `json:"properties"`
}

type Rules struct {
	ID          string           `json:"id"`
	Description ShortDescription `json:"shortDescription"`
}

type Runs struct {
	Tool    Tool      `json:"tool"`
	Results []Results `json:"results"`
}

type Sarif struct {
	Schema  string `json:"$schema"`
	Version string `json:"version"`
	Runs    []Runs `json:"runs"`
}

type SarifReporter struct {
	OrderedRules []config.Rule
}

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

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

type TemplateReporter struct {
	// contains filtered or unexported fields
}

type TestCase struct {
	XMLName   xml.Name `xml:"testcase"`
	Classname string   `xml:"classname,attr"`
	Failure   Failure  `xml:"failure"`
	File      string   `xml:"file,attr"`
	Name      string   `xml:"name,attr"`
	Time      string   `xml:"time,attr"`
}

type TestSuite struct {
	XMLName   xml.Name   `xml:"testsuite"`
	Failures  string     `xml:"failures,attr"`
	Name      string     `xml:"name,attr"`
	Tests     string     `xml:"tests,attr"`
	TestCases []TestCase `xml:"testcase"`
	Time      string     `xml:"time,attr"`
}

type TestSuites struct {
	XMLName    xml.Name `xml:"testsuites"`
	TestSuites []TestSuite
}

type Tool struct {
	Driver Driver `json:"driver"`
}

type ValidationStatus string