ipfilter

README

krakend-ipfilter

---

IP filter middleware for KrakenD(lura) framework, base on cidranger

Example

Deny request from 192.168.0.0/16 but allow 192.168.1.1:

...
    "extra_config": {
        "github_com/xiachufang/krakend-ipfilter": {
            "allow": [
                "192.168.1.1"
            ],
            "deny": [
                "192.168.0.0/16"
            ]
        }
    }
...

Test

make test

Documentation

Index

• type CIDRFilter
  • func (f *CIDRFilter) Allow(ip string) bool
  • func (f *CIDRFilter) Deny(ip string) bool
• type Config
• type IPFilter
  • func NewIPFilter(cfg Config) IPFilter
• type NoopFilter
  • func (noop *NoopFilter) Allow(_ string) bool
  • func (noop *NoopFilter) Deny(_ string) bool

Types

type CIDRFilter

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

CIDRFilter is an ip filter base on cidranger

func (*CIDRFilter) Allow

func (f *CIDRFilter) Allow(ip string) bool

Allow implement IPFilter.Allow

func (*CIDRFilter) Deny

func (f *CIDRFilter) Deny(ip string) bool

Deny implement IPFilter.Deny

type Config

type Config struct {
	Deny  []string
	Allow []string
}

Config is config of ipfilter

type IPFilter

type IPFilter interface {
	Allow(ip string) bool
	Deny(ip string) bool
}

IPFilter is a interface for allow or deny an ip

func NewIPFilter

func NewIPFilter(cfg Config) IPFilter

NewIPFilter create a cidranger base ip filter

type NoopFilter

type NoopFilter struct{}

NoopFilter noop, allow always, never deny

func (*NoopFilter) Allow

func (noop *NoopFilter) Allow(_ string) bool

Allow implement IPFilter.Allow

func (*NoopFilter) Deny

func (noop *NoopFilter) Deny(_ string) bool

Deny implement IPFilter.Deny