provider

Documentation

Index

• Variables
• func ConvertMain(args []string)
• func ConvertToMrs(buf []byte, behavior P.RuleBehavior, format P.RuleFormat, w io.Writer) (err error)
• func NewClassicalStrategy(...) *classicalStrategy
• func NewDomainStrategy() *domainStrategy
• func NewIPCidrStrategy() *ipcidrStrategy
• func NewRuleSetProvider(name string, behavior P.RuleBehavior, format P.RuleFormat, ...) P.RuleProvider
• func ParseRuleProvider(name string, mapping map[string]interface{}, ...) (P.RuleProvider, error)
• func SetTunnel(t P.Tunnel)
• type RulePayload
• type RuleSet
  • func NewRuleSet(ruleProviderName string, adapter string, isSrc bool, noResolveIP bool) (*RuleSet, error)
  • func (rs *RuleSet) Adapter() string
  • func (rs *RuleSet) Match(metadata *C.Metadata) (bool, string)
  • func (rs *RuleSet) MatchDomain(domain string) bool
  • func (rs *RuleSet) MatchIp(ip netip.Addr) bool
  • func (rs *RuleSet) Payload() string
  • func (rs *RuleSet) ProviderNames() []string
  • func (rs *RuleSet) RuleType() C.RuleType
  • func (rs *RuleSet) ShouldFindProcess() bool
  • func (rs *RuleSet) ShouldResolveIP() bool
• type RuleSetProvider
  • func (rp RuleSetProvider) Behavior() P.RuleBehavior
  • func (rp *RuleSetProvider) Close() error
  • func (rp RuleSetProvider) Count() int
  • func (rp RuleSetProvider) Initial() error
  • func (rp RuleSetProvider) MarshalJSON() ([]byte, error)
  • func (rp RuleSetProvider) Match(metadata *C.Metadata) bool
  • func (rp RuleSetProvider) ShouldFindProcess() bool
  • func (rp RuleSetProvider) ShouldResolveIP() bool
  • func (rp RuleSetProvider) Strategy() any
  • func (rp RuleSetProvider) Type() P.ProviderType
  • func (rp RuleSetProvider) Update() error

Variables

var ErrInvalidFormat = errors.New("invalid format")

var ErrNoPayload = errors.New("file must have a `payload` field")

var MrsMagicBytes = [4]byte{'M', 'R', 'S', 1} // MRSv1

Functions

func ConvertMain

func ConvertMain(args []string)

func ConvertToMrs

func ConvertToMrs(buf []byte, behavior P.RuleBehavior, format P.RuleFormat, w io.Writer) (err error)

func NewClassicalStrategy

func NewClassicalStrategy(parse func(tp, payload, target string, params []string, subRules map[string][]C.Rule) (parsed C.Rule, parseErr error)) *classicalStrategy

func NewDomainStrategy

func NewDomainStrategy() *domainStrategy

func NewIPCidrStrategy

func NewIPCidrStrategy() *ipcidrStrategy

func NewRuleSetProvider

func NewRuleSetProvider(name string, behavior P.RuleBehavior, format P.RuleFormat, interval time.Duration, vehicle P.Vehicle,
	parse func(tp, payload, target string, params []string, subRules map[string][]C.Rule) (parsed C.Rule, parseErr error)) P.RuleProvider

func ParseRuleProvider

func ParseRuleProvider(name string, mapping map[string]interface{}, parse func(tp, payload, target string, params []string, subRules map[string][]C.Rule) (parsed C.Rule, parseErr error)) (P.RuleProvider, error)

func SetTunnel

func SetTunnel(t P.Tunnel)

Types

type RulePayload

type RulePayload struct {
	/**
	key: Domain or IP Cidr
	value: Rule type or is empty
	*/
	Payload []string `yaml:"payload"`
	Rules   []string `yaml:"rules"`
}

type RuleSet

type RuleSet struct {
	*common.Base
	// contains filtered or unexported fields
}

func NewRuleSet

func NewRuleSet(ruleProviderName string, adapter string, isSrc bool, noResolveIP bool) (*RuleSet, error)

func (*RuleSet) Adapter

func (rs *RuleSet) Adapter() string

func (*RuleSet) Match

func (rs *RuleSet) Match(metadata *C.Metadata) (bool, string)

func (*RuleSet) MatchDomain

func (rs *RuleSet) MatchDomain(domain string) bool

MatchDomain implements C.DomainMatcher

func (*RuleSet) MatchIp

func (rs *RuleSet) MatchIp(ip netip.Addr) bool

MatchIp implements C.IpMatcher

func (*RuleSet) Payload

func (rs *RuleSet) Payload() string

func (*RuleSet) ProviderNames

func (rs *RuleSet) ProviderNames() []string

func (*RuleSet) RuleType

func (rs *RuleSet) RuleType() C.RuleType

func (*RuleSet) ShouldFindProcess

func (rs *RuleSet) ShouldFindProcess() bool

func (*RuleSet) ShouldResolveIP

func (rs *RuleSet) ShouldResolveIP() bool

type RuleSetProvider

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

func (RuleSetProvider) Behavior

func (rp RuleSetProvider) Behavior() P.RuleBehavior

func (*RuleSetProvider) Close

func (rp *RuleSetProvider) Close() error

func (RuleSetProvider) Count

func (rp RuleSetProvider) Count() int

func (RuleSetProvider) Initial

func (rp RuleSetProvider) Initial() error

func (RuleSetProvider) MarshalJSON

func (rp RuleSetProvider) MarshalJSON() ([]byte, error)

func (RuleSetProvider) Match

func (rp RuleSetProvider) Match(metadata *C.Metadata) bool

func (RuleSetProvider) ShouldFindProcess

func (rp RuleSetProvider) ShouldFindProcess() bool

func (RuleSetProvider) ShouldResolveIP

func (rp RuleSetProvider) ShouldResolveIP() bool

func (RuleSetProvider) Strategy

func (rp RuleSetProvider) Strategy() any

func (RuleSetProvider) Type

func (rp RuleSetProvider) Type() P.ProviderType

func (RuleSetProvider) Update

func (rp RuleSetProvider) Update() error