Rate_limit plugin

pic · November 10, 2020, 10:04pm

Hi,

I’ve seen some discussion about this, for example this:

and especially this:

I’ve taken over the work by sk0g and I’ve published this:

It has to support also Header like the limit_by_header directive of caddy1 plugin.

What do you think? Thanks

matt · November 10, 2020, 10:46pm

Cool! Thanks for publishing that.

I’d recommend making this a caddy.Duration type, if possible, to be consistent with other timeframes in Caddy configuration:

github.com

hundertzehn/caddy-ratelimit/blob/ab1ebc7da43e6156da2334662b6333a4f94f38c1/ratelimit.go#L28

    
      
          	// register a plugin that can load the Caddyfile when Caddy starts
          	httpcaddyfile.RegisterHandlerDirective("rate_limit", parseRateLimit)
          }
          
          
// rateLimitOptions stores options detailing how rate limiting should be applied,
          // as well as the current and previous window's key:requestCount mapping
          type RateLimit struct {
          	ByHeader string `json:"by_header,omitempty"`
          
          
	// window length for request rate checking (>= 1 minute)
          	WindowLength int64 `json:"window_length"`
          
          
	// max request that should be processed per key in a given windowDuration
          	MaxRequests int64 `json:"max_requests"`
          
          
	// current window's request count per key
          	currentWindow *RequestCountTracker
          
          
	// previous window's request count per key
          	previousWindow *RequestCountTracker
          }

Consider expanding on the godoc as that is what users will see when they look for documentation.

(Other than this, I haven’t given it any code review. Just a quick glance.)

Great start!

pic · November 18, 2020, 10:29am

Thanks for the feedback Matt.
Do you have any code sample about using caddy.Duration in a plugin? It would help me a lot. Thanks

francislavoie · November 18, 2020, 11:21am

You just need to use the caddy.Duration type instead of int64:

github.com

caddyserver/caddy/blob/4fc570711e170da2bd1164966d2c47f9dc3d3d6d/modules/caddyhttp/app.go#L109

    
      
          	HTTPPort int `json:"http_port,omitempty"`
          
          
	// HTTPSPort specifies the port to use for HTTPS, which is used when
          	// solving the ACME TLS-ALPN challenges, or whenever HTTPS is needed
          	// but no specific port number is given. Default: 443.
          	HTTPSPort int `json:"https_port,omitempty"`
          
          
	// GracePeriod is how long to wait for active connections when shutting
          	// down the server. Once the grace period is over, connections will
          	// be forcefully closed.
          	GracePeriod caddy.Duration `json:"grace_period,omitempty"`
          
          
	// Servers is the list of servers, keyed by arbitrary names chosen
          	// at your discretion for your own convenience; the keys do not
          	// affect functionality.
          	Servers map[string]*Server `json:"servers,omitempty"`
          
          
	servers     []*http.Server
          	h3servers   []*http3.Server
          	h3listeners []net.PacketConn

And parse it like this for Caddyfile support:

https://github.com/francislavoie/caddy/blob/caddyfile-server-options/caddyconfig/httpcaddyfile/serveroptions.go#L90-L97

Also, I strongly suggest to use ,omitempty in your json tags, because otherwise, running caddy adapt will output "window_length": 0 even if the user never explicitly configured that value.

pic · November 27, 2020, 8:40am

Thanks for the help.

I’ve updated the plugin with your suggestion: Use duration for WindowLength · hundertzehn/caddy-ratelimit@45bd8b1 · GitHub

Best regards

system · December 27, 2020, 8:40am

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.