ipfilter

Documentation

Index

• Variables
• func ParseIPRange(startIP, endIP string) ([]netip.Prefix, error)
• func ParsePrefix(ip string) (pfx netip.Prefix, err error)
• func ToPrefixes(start netip.Addr, end netip.Addr) ([]netip.Prefix, error)
• func Validate(ip string) error
• func ValidateRange(startIP, endIP string) error
• func ValidateRows(ctx echo.Context, iplist string) error
• type Factory
  • func NewFactory[UK com.Number, GK com.Number]() *Factory[UK, GK]
  • func (f *Factory[UK, GK]) DeleteGroup(groupID GK) *Factory[UK, GK]
  • func (f *Factory[UK, GK]) DeleteUser(userID UK) *Factory[UK, GK]
  • func (f *Factory[UK, GK]) IsAllowed(ctx echo.Context, userID UK, groupID GK, ipBlacklist string, ...) bool
  • func (f *Factory[UK, GK]) SetGroupGetter(...) *Factory[UK, GK]
• type IPFilter
  • func New() *IPFilter
  • func NewWithIP(ipBlacklist, ipWhitelist string) *IPFilter
  • func (a *IPFilter) AddBlacklist(ips ...string) error
  • func (a *IPFilter) AddWhitelist(ips ...string) error
  • func (a *IPFilter) Allowed(ip string) error
  • func (a *IPFilter) Blocked(ip string) error
  • func (a *IPFilter) IsAllowed(realIP string) bool
  • func (a *IPFilter) IsAllowedAddr(ip netip.Addr) bool
  • func (a *IPFilter) SetDisallow(dfl bool) *IPFilter

Variables

var (
	ErrStartAndEndIPMismatchType = errors.New(`inconsistency between start and end ip types`)
	ErrParseIPAddress            = errors.New(`failed to parse ip`)
	ErrParseStartIPAddress       = errors.New(`failed to parse ip`)
	ErrParseEndIPAddress         = errors.New(`failed to parse ip`)
)

Functions

func ParseIPRange

func ParseIPRange(startIP, endIP string) ([]netip.Prefix, error)

func ParsePrefix

func ParsePrefix(ip string) (pfx netip.Prefix, err error)

func ToPrefixes

func ToPrefixes(start netip.Addr, end netip.Addr) ([]netip.Prefix, error)

func Validate

func Validate(ip string) error

func ValidateRange

func ValidateRange(startIP, endIP string) error

func ValidateRows

func ValidateRows(ctx echo.Context, iplist string) error

Types

type Factory

type Factory[UK com.Number, GK com.Number] struct {
	// contains filtered or unexported fields
}

func NewFactory

func NewFactory[UK com.Number, GK com.Number]() *Factory[UK, GK]

func (*Factory[UK, GK]) DeleteGroup

func (f *Factory[UK, GK]) DeleteGroup(groupID GK) *Factory[UK, GK]

func (*Factory[UK, GK]) DeleteUser

func (f *Factory[UK, GK]) DeleteUser(userID UK) *Factory[UK, GK]

func (*Factory[UK, GK]) IsAllowed

func (f *Factory[UK, GK]) IsAllowed(ctx echo.Context, userID UK, groupID GK, ipBlacklist string, ipWhitelist string, ip netip.Addr) bool

func (*Factory[UK, GK]) SetGroupGetter

func (f *Factory[UK, GK]) SetGroupGetter(fn func(ctx echo.Context, groupID GK) (ipBlacklist string, ipWhitelist string, err error)) *Factory[UK, GK]

type IPFilter

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

func New

func New() *IPFilter

func NewWithIP

func NewWithIP(ipBlacklist, ipWhitelist string) *IPFilter

func (*IPFilter) AddBlacklist

func (a *IPFilter) AddBlacklist(ips ...string) error

func (*IPFilter) AddWhitelist

func (a *IPFilter) AddWhitelist(ips ...string) error

func (*IPFilter) Allowed

func (a *IPFilter) Allowed(ip string) error

func (*IPFilter) Blocked

func (a *IPFilter) Blocked(ip string) error

func (*IPFilter) IsAllowed

func (a *IPFilter) IsAllowed(realIP string) bool

func (*IPFilter) IsAllowedAddr

func (a *IPFilter) IsAllowedAddr(ip netip.Addr) bool

func (*IPFilter) SetDisallow

func (a *IPFilter) SetDisallow(dfl bool) *IPFilter