rule

type Factory ¶

type Factory func(config.Config) (Matcher, error)

Factory represents the rule factory function interface.

func GetFactory(name string) Factory

type Field ¶

type Field struct {
	Name        string      `json:"name,omitempty"`
	Type        string      `json:"type,omitempty"`
	Description string      `json:"description,omitempty"`
	Mandatory   bool        `json:"mandatory,omitempty"`
	Examples    []string    `json:"examples,omitempty"`
	Default     interface{} `json:"default,omitempty"`
	Validator   Validator   `json:"-"`
}

Field is used to declare specific config fields supported by rules.

type Info ¶

type Info struct {
	Name        string  `json:"name,omitempty"`
	Description string  `json:"description,omitempty"`
	Params      Params  `json:"params,omitempty"`
	Factory     Factory `json:"-"`
}

Info represents the rule entity fields storing the name, description and factory function used to initialize the fields.

func GetInfo(name string) Info

type Layer ¶

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

Layer represents a rules layer designed to intrument proxies providing plugin based dynamic configuration capabilities, such as register/unregister or enable/disable rules at runtime satefy.

func NewLayer() *Layer

func (l *Layer) All() []Rule

func (l *Layer) Flush()

func (l *Layer) Get(name string) Rule

func (l *Layer) Len() int

func (l *Layer) Match(r *http.Request) bool

func (l *Layer) Remove(id string) bool

func (l *Layer) Use(rule ...Rule)

type Matcher ¶

type Matcher func(*http.Request) bool

Matcher represents the matching function interface used by rules to determine if a given traffic should be filtered or not.

type NewFunc ¶

type NewFunc func(config.Config) (Rule, error)

NewFunc represents the Rule constructor factory function interface.

func Get(name string) NewFunc

type Params ¶

type Params []Field

Params represents the list of supported config fields by rules.

type Rule ¶

type Rule interface {
	// ID returns the rule unique identifier.
	ID() string
	// Name returns the rule semantic alias.
	Name() string
	// Description is used to retrieve the rule semantic description.
	Description() string
	// Config is used to retrieve the rule config.
	Config() config.Config
	// Match is used to determine if a given http.Request
	// passes the rule assertion.
	Match(*http.Request) bool
}

Rule represents the required interface implemented by HTTP traffic rules.

Rule is designed to inspect an incoming HTTP traffic and determine if should trigger the registered plugins if the rule matches.

func Init(name string, opts config.Config) (Rule, error)

func NewWithConfig(info Info, opts config.Config) (Rule, error)

type Validator ¶

type Validator func(interface{}, config.Config) error

Validator represents the rule config field validator function interface.