baseline

Documentation

Index

• type Baseline
  • func Load(path string) (*Baseline, error)
  • func (b *Baseline) CheckRequired(findings []core.Finding) []string
  • func (b *Baseline) Suppress(findings []core.Finding) ([]core.Finding, int)
• type RequireEntry
• type SuppressEntry

Types

type Baseline

type Baseline struct {
	Suppressions []SuppressEntry `yaml:"suppress"`
	Require      []RequireEntry  `yaml:"require"`
}

func Load

func Load(path string) (*Baseline, error)

func (*Baseline) CheckRequired

func (b *Baseline) CheckRequired(findings []core.Finding) []string

CheckRequired returns descriptions of required findings that are absent from findings.

func (*Baseline) Suppress

func (b *Baseline) Suppress(findings []core.Finding) ([]core.Finding, int)

Suppress removes findings that match a suppress entry. Returns filtered slice and count.

type RequireEntry

type RequireEntry struct {
	Fingerprint string `yaml:"fingerprint,omitempty"`
	RuleID      string `yaml:"rule_id,omitempty"`
	File        string `yaml:"file,omitempty"`
	Reason      string `yaml:"reason"`
}

type SuppressEntry

type SuppressEntry struct {
	Fingerprint string `yaml:"fingerprint"`
	Reason      string `yaml:"reason"`
}