dynamic_ip_matcher

README

Dynamic Client IP matcher for Caddy

The dynamic_client_ip module is a clone of the client_ip matcher with one key difference: instead of providing IP ranges upfront, you specify an IPRangeSource. This allows IP ranges to be dynamically loaded per request.

Installation

Build Caddy using xcaddy:

xcaddy build --with github.com/tuzzmaniandevil/caddy-dynamic-clientip

Usage

:8880 {
	@denied dynamic_client_ip my_dynamic_provider
	abort @denied

    reverse_proxy localhost:8080
}

Example using the built-in static provider (But why though?)

:8880 {
	@denied dynamic_client_ip static 12.34.56.0/24 1200:ab00::/32
	abort @denied

    reverse_proxy localhost:8080
}

Development

Before diving into development, make sure to follow the Extending Caddy guide. This ensures you're familiar with the Caddy development process and that your environment is set up correctly.

To run Caddy with this module:

xcaddy run

License

The project is licensed under the Apache License.

Documentation

Index

• type MatchDynamicClientIP
  • func (MatchDynamicClientIP) CaddyModule() caddy.ModuleInfo
  • func (m MatchDynamicClientIP) Match(r *http.Request) bool
  • func (m *MatchDynamicClientIP) Provision(ctx caddy.Context) error
  • func (m *MatchDynamicClientIP) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type MatchDynamicClientIP

type MatchDynamicClientIP struct {
	// A module which provides a source of IP ranges, from which
	// requests are matched.
	ProvidersRaw json.RawMessage         `json:"providers,omitempty" caddy:"namespace=http.ip_sources inline_key=source"`
	Providers    caddyhttp.IPRangeSource `json:"-"`
	// contains filtered or unexported fields
}

MatchDynamicClientIP matchers the requests by the client IP address. The IP ranges are provided by modules to allow for dynamic ranges.

func (MatchDynamicClientIP) CaddyModule

func (MatchDynamicClientIP) CaddyModule() caddy.ModuleInfo

func (MatchDynamicClientIP) Match

func (m MatchDynamicClientIP) Match(r *http.Request) bool

func (*MatchDynamicClientIP) Provision

func (m *MatchDynamicClientIP) Provision(ctx caddy.Context) error

func (*MatchDynamicClientIP) UnmarshalCaddyfile

func (m *MatchDynamicClientIP) UnmarshalCaddyfile(d *caddyfile.Dispenser) error