proxy_ip_parser

README

proxy_ip_parser

X-Forwarded-*, Forwarded, True-Client-IP, X-Real-Ip parser http middleware

Documentation

Index

• type Cidrs
  • func ParseCIDRs(subnets []string) (Cidrs, error)
  • func (c *Cidrs) IsTrusted(ip string) bool
• type Config
  • func (c *Config) InitDefaults() error
• type Plugin
  • func (p *Plugin) Init(cfg config.Configurer, l *zap.Logger) error
  • func (p *Plugin) Middleware(next http.Handler) http.Handler
  • func (p *Plugin) Name() string

Types

type Cidrs

type Cidrs []*net.IPNet

Cidrs is a slice of IPNet addresses

func ParseCIDRs

func ParseCIDRs(subnets []string) (Cidrs, error)

ParseCIDRs parse IPNet addresses and return slice of its

func (*Cidrs) IsTrusted

func (c *Cidrs) IsTrusted(ip string) bool

IsTrusted checks if the ip address exists in the provided in the config addresses

type Config

type Config struct {
	// TrustedSubnets declare IP subnets which are allowed to set ip using X-Real-Ip and X-Forwarded-For
	TrustedSubnets []string `mapstructure:"trusted_subnets"`
}

func (*Config) InitDefaults

func (c *Config) InitDefaults() error

type Plugin

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

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, l *zap.Logger) error

func (*Plugin) Middleware

func (p *Plugin) Middleware(next http.Handler) http.Handler

func (*Plugin) Name

func (p *Plugin) Name() string