checkip

Documentation

Index

• Constants
• func Builder() builder.BuildActionFn
• type Action
  • func New(aname string, c xlist.Checker, cfg Config, l yalogi.Logger) (*Action, error)
  • func (a *Action) Class() string
  • func (a *Action) Name() string
  • func (a *Action) PluginClass() string
  • func (a *Action) Register(hooks *ipp.Hooks)
• type Config
• type Mode
• type Rule

Constants

const (
	NetListedIP   event.Code = 10010
	NetUnlistedIP event.Code = 10011
)

Event registered codes

const ActionClass = "checkip"

ActionClass defines action name

Functions

func Builder

func Builder() builder.BuildActionFn

Builder returns a builder function

Types

type Action

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

Action checks ip addresses against an xlist service

func New

func New(aname string, c xlist.Checker, cfg Config, l yalogi.Logger) (*Action, error)

New returns a new instance

func (*Action) Class

func (a *Action) Class() string

Class implements ipp.Action interface

func (*Action) Name

func (a *Action) Name() string

Name implements ipp.Action interface

func (*Action) PluginClass

func (a *Action) PluginClass() string

PluginClass implements ipp.Action interface

func (*Action) Register

func (a *Action) Register(hooks *ipp.Hooks)

Register implements ipp.Action interface

type Config

type Config struct {
	Mode      Mode
	LocalNets []*net.IPNet
	//rules
	WhenListed   Rule
	WhenUnlisted Rule
	OnError      nfqueue.Verdict
}

Config stores configuration for action

type Mode

type Mode int

Mode sets mode for checking

const (
	CheckBoth Mode = iota
	CheckSrc
	CheckDst
)

Available values

type Rule

type Rule struct {
	Merge      bool
	EventRaise bool
	EventLevel event.Level
	Verdict    nfqueue.Verdict
	Log        bool
}

Rule stores information