rule

Documentation

Index

• Constants
• func Entropy(s string) float64
• type List
• type Rule
  • func (rule *Rule) Match(text string) (matches []string, found bool)

Constants

const (
	//TARGET_GROUP_NAME regex configuration group name for entropy calculation
	TARGET_GROUP_NAME = "suspect"
)

Functions

func Entropy

func Entropy(s string) float64

Entropy returns the Shanon entropy of the input string

Types

type List

type List struct {
	Rules []Rule
}

List collection of Rule

type Rule

type Rule struct {
	Target    []*regexp.Regexp
	Except    []*regexp.Regexp
	Entropy   float32
	Tag       string
	ExploitFn string
}

Rule represent the conditions that must be met to realize secret detection

func (*Rule) Match

func (rule *Rule) Match(text string) (matches []string, found bool)

Match takes input data and returns one or more string matches when all conditions in Rule are met.