rules

Documentation

Index

• func SaveResults()
• type MatchResult
• type Rule
  • func (c *Rule) ProcessLineMatch(destination string) error
  • func (c *Rule) ProcessStartEndMarker(destination string) error
• type RulesSpec
  • func (c *RulesSpec) Parse(specFile string) *RulesSpec

Functions

func SaveResults

func SaveResults()

Types

type MatchResult

type MatchResult struct {
	Filename string `json:"filename"`
	Results  string `json:"results"`
	Rule     string `json:"rule"`
	Name     string `json:"name"`
}

type Rule

type Rule struct {
	Id          string `yaml:"id"`
	Description string `yaml:"description"`
	LineMatch   string `yaml:"line_match,omitempty"`
	StartMarker string `yaml:"start_marker,omitempty"`
	EndMarker   string `yaml:"end_marker,omitempty"`
}

func (*Rule) ProcessLineMatch

func (c *Rule) ProcessLineMatch(destination string) error

Processes a single line match printing the result if found

func (*Rule) ProcessStartEndMarker

func (c *Rule) ProcessStartEndMarker(destination string) error

Processes a start and end marker match printing the result if found

type RulesSpec

type RulesSpec struct {
	Rules []Rule `yaml:"rules"`
}

func (*RulesSpec) Parse

func (c *RulesSpec) Parse(specFile string) *RulesSpec