gitleaks

Documentation

Overview

Package gitleaks provides data model, decoder, and validator for Gitleaks secret detection report

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"

ConfigFieldName field name for config map

const ConfigType = "Gitleaks Config"

ConfigType in plain text

const ReportType = "Gitleaks Scan Report"

ReportType in plain text

Functions

func NewValidator

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

NewValidator implementation of the generic validator

func NoSecretsRule

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

NoSecretsRule deny if no secrets are allowed and count of secrets > 0

Types

type Config

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

Config data model

type Finding

type Finding report.Finding

Finding data model alias

type ReportDecoder

type ReportDecoder struct {
	bytes.Buffer
}

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

func NewReportDecoder

func NewReportDecoder() *ReportDecoder

NewReportDecoder custom decoder with specific rules to handle empty findings reports

func (*ReportDecoder) Decode

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

Decode from internal buffer

func (*ReportDecoder) DecodeFrom

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

DecodeFrom ...

func (*ReportDecoder) FileType

func (d *ReportDecoder) FileType() string

FileType in plain text

type ScanReport

type ScanReport []Finding

ScanReport a slice of findings

func (ScanReport) String

func (r ScanReport) String() string

String a formatted table of detected secrets