ratelimit

README

caddy-rate-limit

a rate limit plugin for caddy

Syntax

Excessive requests will be terminated with an error 429 (Too Many Requests)! And X-RateLimit-RetryAfter header will be returned.

Private IPs will be ignored.

For single resource:

ratelimit path rate burst unit

• path is the file or directory to apply rate limit

• rate is the limited request in every time unit (r/s, r/m, r/h) (e.g. 1)

• burst is the maximum burst size client can exceed; burst >= rate (e.g. 2)

• unit is the time interval (currently support: second, minute, hour)

For multiple resources:

ratelimit rate burst unit {
    resources
}

• resources is a list of files/directories to apply rate limit, one per line

Note: If you don't want to apply rate limit on some special resources, add ^ in front of the path.

Examples

Limit clients to 2 requests per second (bursts of 3) to any resources in /r:

ratelimit /r 2 3 second

For the listed paths, limit clients to 2 requests per minute (bursts of 2) and always ignore /dir/app.js:

ratelimit 2 2 minute {
    /foo.html
    /dir
    ^/dir/app.js
}

Test

docker pull xuqingfeng/caddy-rate-limit
docker run -d -p 2016:2016 --name ratelimit xuqingfeng/caddy-rate-limit

---

Inspired By

http://nginx.org/en/docs/http/ngx_http_limit_req_module.html

https://github.com/didip/tollbooth

Documentation

Index

• func GetRemoteIP(r *http.Request) (string, error)
• func IsLocalIpAddress(address string, localIpNets []*net.IPNet) bool
• type CaddyLimiter
  • func NewCaddyLimiter() *CaddyLimiter
  • func (cl *CaddyLimiter) Allow(keys []string, rule Rule) bool
  • func (cl *CaddyLimiter) AllowN(keys []string, rule Rule, n int) bool
  • func (cl *CaddyLimiter) RetryAfter(keys []string) time.Duration
• type RateLimit
  • func (rl RateLimit) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type Rule

Functions

func GetRemoteIP

func GetRemoteIP(r *http.Request) (string, error)

GetRemoteIP returns the ip of requester Don't care if the ip is real or not

func IsLocalIpAddress

func IsLocalIpAddress(address string, localIpNets []*net.IPNet) bool

IsLocalIpAddress check whether an ip belongs to private network

Types

type CaddyLimiter

type CaddyLimiter struct {
	Keys map[string]*rate.Limiter
	sync.Mutex
}

func NewCaddyLimiter

func NewCaddyLimiter() *CaddyLimiter

func (*CaddyLimiter) Allow

func (cl *CaddyLimiter) Allow(keys []string, rule Rule) bool

Allow is just a shortcut for AllowN

func (*CaddyLimiter) AllowN

func (cl *CaddyLimiter) AllowN(keys []string, rule Rule, n int) bool

AllowN check if n count are allowed for a specific key

func (*CaddyLimiter) RetryAfter

func (cl *CaddyLimiter) RetryAfter(keys []string) time.Duration

RetryAfter return a helper message for client

type RateLimit

type RateLimit struct {
	Next  httpserver.Handler
	Rules []Rule
}

RateLimit is an http.Handler that can limit request rate to specific paths or files

func (RateLimit) ServeHTTP

func (rl RateLimit) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

type Rule

type Rule struct {
	Rate      int64
	Burst     int
	Resources []string
	Unit      string
}

Rule is a configuration for ratelimit