scope

Documentation

Overview

Package scope evaluates target-scope rules: which flows are "in scope" for an engagement. It focuses the history view, the intercept gate, and the scanner without affecting capture. Safe for concurrent use and live-reloadable.

Index

• type Engine
  • func New() *Engine
  • func (e *Engine) HasIncludes() bool
  • func (e *Engine) InScope(f *store.Flow) bool
  • func (e *Engine) SetRules(rules []store.ScopeRule)

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine holds a compiled, reloadable rule set.

func New

func New() *Engine

New returns an empty engine (everything in scope until rules are set).

func (*Engine) HasIncludes

func (e *Engine) HasIncludes() bool

HasIncludes reports whether any active include rule exists — i.e. whether the scope is a real allow-list rather than the default "everything is in scope".

func (*Engine) InScope

func (e *Engine) InScope(f *store.Flow) bool

InScope reports whether a flow is in scope: it matches no exclude rule, and (if any include rules exist) matches at least one include rule.

func (*Engine) SetRules

func (e *Engine) SetRules(rules []store.ScopeRule)

SetRules recompiles the active (enabled) rules.