rules

package

Go to main page

Versions in this module

v0

v0.6.0

Aug 15, 2026

v0.5.2

Aug 13, 2026

v0.5.1

Aug 13, 2026

v0.5.0

Aug 12, 2026

v0.4.2

Aug 9, 2026

v0.4.1

Aug 9, 2026

Changes in this version

type EvalContext

+ Origins []string

v0.4.0

Aug 9, 2026

Changes in this version

+ type Args struct

+ Names [][]byte

+ Values [][]byte

type EvalContext

+ Host []byte

+ Method []byte

+ RequestURI []byte

+ Siblings Args

+ func (c *EvalContext) SiblingValue(name string) ([]byte, bool)

v0.3.0

Aug 9, 2026

v0.2.1

Aug 7, 2026

Changes in this version

type Ruleset

+ func (rs *Ruleset) Reads(k types.TargetKind) bool

v0.2.0

Aug 7, 2026

v0.1.0

Aug 6, 2026

Changes in this version

+ var ErrDuplicateID = errors.New("duplicate rule id")

+ var ErrExceptionTooBroad = errors.New("rules: exception matches everything; set at least RuleID")

+ var ErrInvalidRule = errors.New("invalid rule")

+ var ErrReservedID = errors.New("rule id in reserved range")

+ type Action interface

+ Name func() string

+ Run func(ctx *EvalContext, m Match) Outcome

+ var Allow Action = fixedAction{}

+ var Block Action = fixedAction{}

+ var Log Action = fixedAction{}

+ var Score Action = fixedAction{}

+ func BlockWithStatus(status int) Action

+ func ScoreBy(n int) Action

+ type ActionKind uint8

+ const ActionAllow

+ const ActionBlock

+ const ActionLog

+ const ActionScore

+ func (k ActionKind) String() string

+ type ChainGroup struct

+ Automaton *prefilter.Automaton

+ Rules []*CompiledRule

+ Transforms []Transform

+ Unconditional []int

+ func (g *ChainGroup) Reads(k types.TargetKind) bool

+ type CompiledRule struct

+ Rule *Rule

+ func (c *CompiledRule) Actions() []Action

+ func (c *CompiledRule) Unconditional() bool

+ type EvalContext struct

+ Key string

+ Target types.Target

+ type Exception struct

+ Key string

+ Note string

+ Path string

+ RuleID types.RuleID

+ Target types.TargetKind

+ func (e Exception) Matches(rule, derivedFrom types.RuleID, path string, target types.Target, key string) bool

+ func (e Exception) Validate() error

+ type Exceptions []Exception

+ func (xs Exceptions) Suppresses(rule, derivedFrom types.RuleID, path string, target types.Target, key string) (Exception, bool)

+ type Match struct

+ Span types.Span

+ func WholeValue(value []byte) Match

+ type Operator interface

+ Cost func() types.Fuel

+ Eval func(ctx *EvalContext, value []byte) (Match, bool)

+ Literals func() ([]string, bool)

+ Name func() string

+ type Options struct

+ UserRulesOnly bool

+ type Outcome struct

+ Kind ActionKind

+ Score int

+ Status int

+ func (o Outcome) Terminal() bool

+ type Report struct

+ AutomatonStates int

+ ChainGroups int

+ Literals int

+ Prefiltered int

+ Rules int

+ Unconditional []UnconditionalRule

+ type Resolver interface

+ Name func() string

+ Resolve func() iter.Seq2[string, []byte]

+ type Rule struct

+ Actions []Action

+ Confidence types.Confidence

+ DerivedFrom types.RuleID

+ ID types.RuleID

+ Msg string

+ Op Operator

+ Phase types.Phase

+ Severity types.Severity

+ Tags []string

+ Targets []types.Target

+ Transforms []Transform

+ func (r *Rule) HasTag(tag string) bool

+ type RuleError struct

+ Err error

+ Field string

+ Hint string

+ ID types.RuleID

+ func (e *RuleError) Error() string

+ func (e *RuleError) Unwrap() error

+ type Ruleset struct

+ func Compile(set Set, opts Options) (*Ruleset, error)

+ func (rs *Ruleset) All() []*CompiledRule

+ func (rs *Ruleset) ByID(id types.RuleID) (*CompiledRule, bool)

+ func (rs *Ruleset) Groups(p types.Phase) []*ChainGroup

+ func (rs *Ruleset) Len() int

+ func (rs *Ruleset) MaxChainLen(p types.Phase) int

+ func (rs *Ruleset) MaxGroupRules(p types.Phase) int

+ func (rs *Ruleset) MirrorsOnly(p types.Phase) bool

+ func (rs *Ruleset) NeedsResolver(p types.Phase, name string) bool

+ func (rs *Ruleset) PhaseRules(p types.Phase) []*CompiledRule

+ func (rs *Ruleset) Report() Report

+ type Set []Rule

+ func Concat(sets ...Set) Set

+ type Transform interface

+ Apply func(dst, src []byte) ([]byte, bool)

+ MaxOutputLen func(srcLen int) int

+ Name func() string

+ type UnconditionalRule struct

+ ID types.RuleID

+ Operator string

+ Phase types.Phase

+ Reason string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL