caddy_trusted_cloudfront

README

trusted_proxies cloudfront module for Caddy

The module auto trusted_proxies AWS CloudFront EDGE servers from https://d7uri8nf7uskq.cloudfront.net/tools/list-cloudfront-ips

Requirements

• Go installed
• xcaddy

Install

The simplest, cross-platform way to get started is to download Caddy from GitHub Releases and place the executable file in your PATH.

Build from source

Requirements:

• Go installed
• xcaddy

Build:

$ xcaddy build --with github.com/xcaddyplugins/caddy-trusted-cloudfront

Caddyfile Syntax

trusted_proxies cloudfront {
	interval <duration>
}

• interval How often to fetch the latest IP list. format is caddy.Duration. For example 12h represents 12 hours, and "1d" represents one day. default value 1d.

Caddyfile Example

trusted_proxies cloudfront {
	interval 1d
}

Caddyfile Use Default Settings Example

trusted_proxies cloudfront

Caddyfile Global Trusted Example

Insert the following configuration of Caddyfile to apply it globally.

{
	servers {
		trusted_proxies cloudfront
	}
}

Documentation

Index

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

Constants

const (
	FETCH_URL = "https://d7uri8nf7uskq.cloudfront.net/tools/list-cloudfront-ips"
)

Types

type CaddyTrustedCloudFront

type CaddyTrustedCloudFront struct {
	// Interval to update the trusted proxies list. default: 1d
	Interval caddy.Duration `json:"interval,omitempty"`
	// contains filtered or unexported fields
}

The module that auto trusted_proxies `AWS CloudFront EDGE servers` from CloudFront. Doc: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/LocationsOfEdgeServers.html Range from: https://d7uri8nf7uskq.cloudfront.net/tools/list-cloudfront-ips

func (CaddyTrustedCloudFront) CaddyModule

func (CaddyTrustedCloudFront) CaddyModule() caddy.ModuleInfo

func (*CaddyTrustedCloudFront) GetIPRanges

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

func (*CaddyTrustedCloudFront) Provision

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

func (*CaddyTrustedCloudFront) UnmarshalCaddyfile

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

UnmarshalCaddyfile implements caddyfile.Unmarshaler. Syntax:

cloudfront {
   interval <duration>
}

type CloudFrontIPSource

type CloudFrontIPSource struct {
	CloudFrontGlobalIPList       []string `json:"CLOUDFRONT_GLOBAL_IP_LIST"`
	CloudFrontRegionalEdgeIPList []string `json:"CLOUDFRONT_REGIONAL_EDGE_IP_LIST"`
}