nfqueue

Documentation

Index

• type CbCleanUp
• type CbPacket
• type Hooks
  • func NewHooks() *Hooks
  • func (h *Hooks) CleanUp(fn CbCleanUp)
  • func (h *Hooks) OnPacket(layer gopacket.LayerType, fn CbPacket)
• type Nfqueue
  • func Open(qid int, hooks *Hooks, policy Verdict, opt ...Option) (*Nfqueue, error)
  • func (q *Nfqueue) Close() error
• type Option
  • func SetLogger(l yalogi.Logger) Option
  • func SetOnError(v Verdict) Option
• type Verdict
  • func ToVerdict(s string) (Verdict, error)
  • func (v Verdict) String() string

Types

type CbCleanUp

type CbCleanUp func()

CbCleanUp defines callback for cleanups

type CbPacket

type CbPacket func(gopacket.Packet) (bool, Verdict, error)

CbPacket defines a callback on packet

type Hooks

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

Hooks is responsible for packet processor

func NewHooks

func NewHooks() *Hooks

NewHooks returns a new hooks collection

func (*Hooks) CleanUp

func (h *Hooks) CleanUp(fn CbCleanUp)

CleanUp adds a callback function when cleanup

func (*Hooks) OnPacket

func (h *Hooks) OnPacket(layer gopacket.LayerType, fn CbPacket)

OnPacket adds a callback function on new packet

type Nfqueue

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

Nfqueue is the main class of the component

func Open

func Open(qid int, hooks *Hooks, policy Verdict, opt ...Option) (*Nfqueue, error)

Open netfilter queue with qid and register hooks

func (*Nfqueue) Close

func (q *Nfqueue) Close() error

Close the queue

type Option

type Option func(*options)

Option encapsules options for server

func SetLogger

func SetLogger(l yalogi.Logger) Option

SetLogger option allows set a custom logger

func SetOnError

func SetOnError(v Verdict) Option

SetOnError option allows set verdict for errors in package decoding

type Verdict

type Verdict int

Verdict represents the actions that the firewall can do

const (
	Drop   Verdict = nfq.NfDrop
	Accept Verdict = nfq.NfAccept
)

Action types

func ToVerdict

func ToVerdict(s string) (Verdict, error)

ToVerdict returns action from a string

func (Verdict) String

func (v Verdict) String() string