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 NewInlineProvider(name string, behavior P.RuleBehavior, payload []string, ...) P.RuleProvider
• func NewRuleSetProvider(name string, behavior P.RuleBehavior, format P.RuleFormat, ...) P.RuleProvider
• func ParseRuleProvider(name string, mapping map[string]any, parse common.ParseRuleFunc) (P.RuleProvider, error)
• func SetTunnel(t P.Tunnel)
• type InlineProvider
  • func (i InlineProvider) Initial() error
  • func (i InlineProvider) MarshalJSON() ([]byte, error)
  • func (i InlineProvider) Name() string
  • func (i InlineProvider) Update() error
  • func (i InlineProvider) VehicleType() P.VehicleType
• 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) Close() error
  • func (rp RuleSetProvider) Initial() error
  • func (rp RuleSetProvider) MarshalJSON() ([]byte, error)
  • func (rp RuleSetProvider) Update() error

Variables

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

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 NewInlineProvider

func NewInlineProvider(name string, behavior P.RuleBehavior, payload []string, parse common.ParseRuleFunc) P.RuleProvider

func NewRuleSetProvider

func NewRuleSetProvider(name string, behavior P.RuleBehavior, format P.RuleFormat, interval time.Duration, vehicle P.Vehicle, parse common.ParseRuleFunc) P.RuleProvider

func ParseRuleProvider

func ParseRuleProvider(name string, mapping map[string]any, parse common.ParseRuleFunc) (P.RuleProvider, error)

func SetTunnel

func SetTunnel(t P.Tunnel)

Types

type InlineProvider

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

func (InlineProvider) Initial

func (i InlineProvider) Initial() error

func (InlineProvider) MarshalJSON

func (i InlineProvider) MarshalJSON() ([]byte, error)

func (InlineProvider) Name

func (i InlineProvider) Name() string

func (InlineProvider) Update

func (i InlineProvider) Update() error

func (InlineProvider) VehicleType

func (i InlineProvider) VehicleType() P.VehicleType

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) Close

func (rp *RuleSetProvider) Close() error

func (RuleSetProvider) Initial

func (rp RuleSetProvider) Initial() error

func (RuleSetProvider) MarshalJSON

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

func (RuleSetProvider) Update

func (rp RuleSetProvider) Update() error