gitleaks

Documentation

Index

• Constants
• func NewValidator() gcv.Validator[Finding, Config]
• func NoSecretsRule(findings []Finding, config Config) error
• type Config
• type Finding
• type ReportDecoder
  • func NewReportDecoder() *ReportDecoder
  • func (d *ReportDecoder) Decode() (any, error)
  • func (d *ReportDecoder) DecodeFrom(r io.Reader) (any, error)
  • func (d *ReportDecoder) FileType() string
• type ScanReport
  • func (r ScanReport) String() string

Constants

const ConfigFieldName = "gitleaks"

const ConfigType = "Gitleaks Config"

const ReportType = "Gitleaks Scan Report"

Functions

func NewValidator

func NewValidator() gcv.Validator[Finding, Config]

func NoSecretsRule

func NoSecretsRule(findings []Finding, config Config) error

Types

type Config

type Config struct {
	SecretsAllowed bool `yaml:"secretsAllowed" json:"secretsAllowed"`
}

type Finding

type Finding report.Finding

type ReportDecoder

type ReportDecoder struct {
	bytes.Buffer
}

Gitleaks reports are just an array of findings. No findings is '[]' literally

func NewReportDecoder

func NewReportDecoder() *ReportDecoder

func (*ReportDecoder) Decode

func (d *ReportDecoder) Decode() (any, error)

func (*ReportDecoder) DecodeFrom

func (d *ReportDecoder) DecodeFrom(r io.Reader) (any, error)

func (*ReportDecoder) FileType

func (d *ReportDecoder) FileType() string

type ScanReport

type ScanReport []Finding

func (ScanReport) String

func (r ScanReport) String() string