detect

Documentation

Index

• func IsNew(finding report.Finding, baseline []report.Finding) bool
• func LoadBaseline(baselinePath string) ([]report.Finding, error)
• type Decoder
  • func NewDecoder() *Decoder
• type Detector
  • func NewDetector(cfg config.Config) *Detector
  • func NewDetectorDefaultConfig() (*Detector, error)
  • func (d *Detector) AddBaseline(baselinePath string, source string) error
  • func (d *Detector) AddGitleaksIgnore(gitleaksIgnorePath string) error
  • func (d *Detector) Detect(fragment Fragment) []report.Finding
  • func (d *Detector) DetectBytes(content []byte) []report.Finding
  • func (d *Detector) DetectFiles(paths <-chan sources.ScanTarget) ([]report.Finding, error)
  • func (d *Detector) DetectGit(gitCmd *sources.GitCmd) ([]report.Finding, error)
  • func (d *Detector) DetectReader(r io.Reader, bufSize int) ([]report.Finding, error)
  • func (d *Detector) DetectString(content string) []report.Finding
• type EncodedSegment
• type Fragment
• type Location

Functions

func IsNew

func IsNew(finding report.Finding, baseline []report.Finding) bool

func LoadBaseline

func LoadBaseline(baselinePath string) ([]report.Finding, error)

Types

type Decoder

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

Decoder decodes various types of data in place

func NewDecoder

func NewDecoder() *Decoder

NewDecoder creates a default decoder struct

type Detector

type Detector struct {
	// Config is the configuration for the detector
	Config config.Config

	// Redact is a flag to redact findings. This is exported
	// so users using gitleaks as a library can set this flag
	// without calling `detector.Start(cmd *cobra.Command)`
	Redact uint

	// verbose is a flag to print findings
	Verbose bool

	// MaxDecodeDepths limits how many recursive decoding passes are allowed
	MaxDecodeDepth int

	// files larger than this will be skipped
	MaxTargetMegaBytes int

	// followSymlinks is a flag to enable scanning symlink files
	FollowSymlinks bool

	// NoColor is a flag to disable color output
	NoColor bool

	// IgnoreGitleaksAllow is a flag to ignore gitleaks:allow comments.
	IgnoreGitleaksAllow bool

	// Sema (https://github.com/fatih/semgroup) controls the concurrency
	Sema *semgroup.Group

	// report-related settings.
	ReportPath string
	Reporter   report.Reporter

	TotalBytes uint64
	// contains filtered or unexported fields
}

Detector is the main detector struct

func NewDetector

func NewDetector(cfg config.Config) *Detector

NewDetector creates a new detector with the given config

func NewDetectorDefaultConfig

func NewDetectorDefaultConfig() (*Detector, error)

NewDetectorDefaultConfig creates a new detector with the default config

func (*Detector) AddBaseline

func (d *Detector) AddBaseline(baselinePath string, source string) error

func (*Detector) AddGitleaksIgnore

func (d *Detector) AddGitleaksIgnore(gitleaksIgnorePath string) error

func (*Detector) Detect

func (d *Detector) Detect(fragment Fragment) []report.Finding

Detect scans the given fragment and returns a list of findings

func (*Detector) DetectBytes

func (d *Detector) DetectBytes(content []byte) []report.Finding

DetectBytes scans the given bytes and returns a list of findings

func (*Detector) DetectFiles

func (d *Detector) DetectFiles(paths <-chan sources.ScanTarget) ([]report.Finding, error)

func (*Detector) DetectGit

func (d *Detector) DetectGit(gitCmd *sources.GitCmd) ([]report.Finding, error)

func (*Detector) DetectReader

func (d *Detector) DetectReader(r io.Reader, bufSize int) ([]report.Finding, error)

DetectReader accepts an io.Reader and a buffer size for the reader in KB

func (*Detector) DetectString

func (d *Detector) DetectString(content string) []report.Finding

DetectString scans the given string and returns a list of findings

type EncodedSegment

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

EncodedSegment represents a portion of text that is encoded in some way. `decode` supports recusive decoding and can result in "segment trees". There can be multiple segments in the original text, so each can be thought of as its own tree with the root being the original segment.

type Fragment

type Fragment struct {
	// Raw is the raw content of the fragment
	Raw string

	Bytes []byte

	// FilePath is the path to the file if applicable
	FilePath    string
	SymlinkFile string

	// CommitSHA is the SHA of the commit if applicable
	CommitSHA string
	// contains filtered or unexported fields
}

Fragment contains the data to be scanned

type Location

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

Location represents a location in a file