customlists

Documentation

Index

• Variables
• func IsLoaded() bool
• func LookupASN(number uint) bool
• func LookupCountry(countryCode string) bool
• func LookupDomain(fullDomain string, filterSubdomains bool) (bool, string)
• func LookupIP(ip net.IP) bool
• type CustomList
  • func New(instance instance) (*CustomList, error)
  • func (cl *CustomList) Manager() *mgr.Manager
  • func (cl *CustomList) Start() error
  • func (cl *CustomList) States() *mgr.StateMgr
  • func (cl *CustomList) Stop() error

Variables

var (
	// CfgOptionCustomListFileKey is the config key for custom filter list file.
	CfgOptionCustomListFileKey = "filter/customListFile"
)

var (

	// ErrNotConfigured is returned when updating the custom filter list, but it
	// is not configured.
	ErrNotConfigured = errors.New("custom filter list not configured")
)

Functions

func IsLoaded

func IsLoaded() bool

IsLoaded returns whether a custom filter list is loaded.

func LookupASN

func LookupASN(number uint) bool

LookupASN checks if the Autonomous system number is in a custom filter list.

func LookupCountry

func LookupCountry(countryCode string) bool

LookupCountry checks if the country code is in a custom filter list.

func LookupDomain

func LookupDomain(fullDomain string, filterSubdomains bool) (bool, string)

LookupDomain checks if the Domain is in a custom filter list.

func LookupIP

func LookupIP(ip net.IP) bool

LookupIP checks if the IP address is in a custom filter list.

Types

type CustomList

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

func New

func New(instance instance) (*CustomList, error)

New returns a new CustomList module.

func (*CustomList) Manager

func (cl *CustomList) Manager() *mgr.Manager

func (*CustomList) Start

func (cl *CustomList) Start() error

func (*CustomList) States

func (cl *CustomList) States() *mgr.StateMgr

func (*CustomList) Stop

func (cl *CustomList) Stop() error