waf

Documentation

Index

• func Health() error
• func Version() string
• type AtomicU64
  • func (a *AtomicU64) Add(v uint64)
  • func (a *AtomicU64) Inc()
  • func (a *AtomicU64) Load() uint64
• type Context
  • func NewContext(*Handle) *Context
  • func (*Context) Close()
  • func (*Context) Run(map[string]interface{}, time.Duration) ([]byte, error)
  • func (*Context) TotalRuntime() (uint64, uint64)
  • func (*Context) TotalTimeouts() uint64
• type Handle
  • func NewHandle([]byte, string, string) (*Handle, error)
  • func (*Handle) Addresses() []string
  • func (*Handle) Close()
  • func (waf *Handle) RulesetInfo() RulesetInfo
• type RulesetInfo
• type RunError
  • func (e RunError) Error() string

Functions

func Health

func Health() error

Health allows knowing if the WAF can be used. It returns a nil error when the WAF library is healthy. Otherwise, it returns an error describing the issue.

func Version

func Version() string

Version returns the current version of the WAF

Types

type AtomicU64

type AtomicU64 uint64

AtomicU64 can be used to perform atomic operations on an uint64 type

func (*AtomicU64) Add

func (a *AtomicU64) Add(v uint64)

Add atomically sums the current atomic value with the provided value `v`.

func (*AtomicU64) Inc

func (a *AtomicU64) Inc()

Inc atomically increments the atomic value by 1

func (*AtomicU64) Load

func (a *AtomicU64) Load() uint64

Load atomically loads the value.

type Context

type Context struct{}

Context is a WAF execution context.

func NewContext

func NewContext(*Handle) *Context

NewContext a new WAF context and increase the number of references to the WAF handle. A nil value is returned when the WAF handle can no longer be used or the WAF context couldn't be created.

func (*Context) Close

func (*Context) Close()

Close the WAF context by releasing its C memory and decreasing the number of references to the WAF handle.

func (*Context) Run

func (*Context) Run(map[string]interface{}, time.Duration) ([]byte, error)

Run the WAF with the given Go values and timeout.

func (*Context) TotalRuntime

func (*Context) TotalRuntime() (uint64, uint64)

TotalRuntime returns the cumulated waf runtime across various run calls within the same WAF context. Returned time is in nanoseconds.

func (*Context) TotalTimeouts

func (*Context) TotalTimeouts() uint64

TotalTimeouts returns the cumulated amount of WAF timeouts across various run calls within the same WAF context.

type Handle

type Handle struct{}

Handle represents an instance of the WAF for a given ruleset.

func NewHandle

func NewHandle([]byte, string, string) (*Handle, error)

NewHandle creates a new instance of the WAF with the given JSON rule.

func (*Handle) Addresses

func (*Handle) Addresses() []string

Addresses returns the list of addresses the WAF rule is expecting.

func (*Handle) Close

func (*Handle) Close()

Close the WAF and release the underlying C memory as soon as there are no more WAF contexts using the rule.

func (*Handle) RulesetInfo

func (waf *Handle) RulesetInfo() RulesetInfo

RulesetInfo returns the rules initialization metrics for the current WAF handle

type RulesetInfo

type RulesetInfo struct {
	// Number of rules successfully loaded
	Loaded uint16
	// Number of rules which failed to parse
	Failed uint16
	// Map from an error string to an array of all the rule ids for which
	// that error was raised. {error: [rule_ids]}
	Errors map[string]interface{}
	// Ruleset version
	Version string
}

RulesetInfo stores the information - provided by the WAF - about WAF rules initialization.

type RunError

type RunError int

RunError the WAF can return when running it.

const (
	ErrInternal RunError = iota + 1
	ErrInvalidObject
	ErrInvalidArgument
	ErrTimeout
	ErrOutOfMemory
	ErrEmptyRuleAddresses
)

Errors the WAF can return when running it.

func (RunError) Error

func (e RunError) Error() string

Error returns the string representation of the RunError.