caddy_cloudflare_ip

README

trusted_proxy module for caddy

This module retrieves cloudflare ips from their offical website, ipv4 and ipv6. It is supported from caddy v2.6.3 onwards.

Example config

Put following config in global options under corresponding server options

trusted_proxies cloudflare {
    interval 12h
    timeout 15s
}

Defaults

Name	Description	Type	Default
interval	How often cloudflare ip lists are retrieved	duration	1h
timeout	Maximum time to wait to get a response from cloudflare	duration	no timeout

Documentation

Index

• type CloudflareIPRange
  • func (CloudflareIPRange) CaddyModule() caddy.ModuleInfo
  • func (s *CloudflareIPRange) GetIPRanges(_ *http.Request) []netip.Prefix
  • func (s *CloudflareIPRange) Provision(ctx caddy.Context) error
  • func (m *CloudflareIPRange) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type CloudflareIPRange

type CloudflareIPRange struct {
	// refresh Interval
	Interval caddy.Duration `json:"interval,omitempty"`
	// request Timeout
	Timeout caddy.Duration `json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

CloudflareIPRange provides a range of IP address prefixes (CIDRs) retrieved from cloudflare.

func (CloudflareIPRange) CaddyModule

func (CloudflareIPRange) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*CloudflareIPRange) GetIPRanges

func (s *CloudflareIPRange) GetIPRanges(_ *http.Request) []netip.Prefix

func (*CloudflareIPRange) Provision

func (s *CloudflareIPRange) Provision(ctx caddy.Context) error

func (*CloudflareIPRange) UnmarshalCaddyfile

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

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

cloudflare {
   interval val
   timeout val
}