rule

Documentation

Index

• func IsComplex(ruleText string) bool
• func ParseLine(line string) string
• type ComplexRule
• type Match
• type Store
  • func CreateStore(storeRoot string, conf *config.GudgeonConfig) (Store, []uint64)

Functions

func IsComplex

func IsComplex(ruleText string) bool

func ParseLine

func ParseLine(line string) string

parse a line, as from a file, and return the part that represents the rule

Types

type ComplexRule

type ComplexRule interface {
	IsMatch(sample string) bool
	Text() string
}

type Match

type Match uint8

a match can be: allow (don't block, override/bypass block) block (explicit block) none (no reason found to block or allow)

const (
	MatchAllow Match = 2
	MatchBlock Match = 1
	MatchNone  Match = 0
)

type Store

type Store interface {
	Init(sessionRoot string, config *config.GudgeonConfig, lists []*config.GudgeonList)

	Load(list *config.GudgeonList, rule string)

	Clear(config *config.GudgeonConfig, list *config.GudgeonList)

	Finalize(sessionRoot string, lists []*config.GudgeonList)

	FindMatch(lists []*config.GudgeonList, domain string) (Match, *config.GudgeonList, string)

	Close()
}

func CreateStore

func CreateStore(storeRoot string, conf *config.GudgeonConfig) (Store, []uint64)

stores are created from lists of files inside a configuration