limiter

README

Rate Limiter GO

A basic rate limiter module for HTTP servers using the limiter package (based off the token bucket algorithm)

Used in my personal VAS project

Documentation

Index

• Constants
• type CooldownConfig
• type CooldownLimiter
  • func NewCooldownLimiter(name string, config CooldownConfig) *CooldownLimiter
  • func (cl *CooldownLimiter) CleanupLimiters()
  • func (cl *CooldownLimiter) GetLimiter(ip string) *rate.Limiter
  • func (cl *CooldownLimiter) LimiterHandler(next http.HandlerFunc) http.HandlerFunc
• type LimiterConfig
• type LoginIdentifier
• type LoginLimiter
  • func NewLoginLimiter(config CooldownConfig) *LoginLimiter
  • func (ll *LoginLimiter) CleanupLimiters()
  • func (ll *LoginLimiter) GetLimiter(userId uint, ip string) *rate.Limiter
• type RateLimiter
  • func NewLimiter(config LimiterConfig) *RateLimiter
  • func (rl *RateLimiter) CleanupLimiters()
  • func (rl *RateLimiter) GetLimiter(ip string) *rate.Limiter
  • func (rl *RateLimiter) LimiterHandler(next http.HandlerFunc) http.HandlerFunc
• type Visitor

Constants

const CLEANUP_FREQUENCY = 120

const VISITOR_AGE_THRESHOLD = 180

Types

type CooldownConfig

type CooldownConfig struct {
	Requests uint
	Cooldown uint
}

type CooldownLimiter

type CooldownLimiter struct {
	Name     string
	Mutex    sync.Mutex
	Limiters map[string]Visitor
	// Threshold at which old visitors are deleted from the map (in seconds since last visit)
	VisitorAgeThreshold int
	// Frequency of cleanup (in seconds)
	CleanupFrequency int
	Configuration    CooldownConfig
}

func NewCooldownLimiter

func NewCooldownLimiter(name string, config CooldownConfig) *CooldownLimiter

func (*CooldownLimiter) CleanupLimiters

func (cl *CooldownLimiter) CleanupLimiters()

Function that runs periodically in a goroutine to cleanup old visitors (threshold set with const)

func (*CooldownLimiter) GetLimiter

func (cl *CooldownLimiter) GetLimiter(ip string) *rate.Limiter

func (*CooldownLimiter) LimiterHandler

func (cl *CooldownLimiter) LimiterHandler(next http.HandlerFunc) http.HandlerFunc

type LimiterConfig

type LimiterConfig struct {
	MaxRequests uint
	BurstLimit  uint
}

type LoginIdentifier

type LoginIdentifier struct {
	UserId    uint
	IpAddress string
}

type LoginLimiter

type LoginLimiter struct {
	Mutex    sync.Mutex
	Limiters map[LoginIdentifier]Visitor
	// Threshold at which old visitors are deleted from the map (in seconds since last visit)
	VisitorAgeThreshold int
	// Frequency of cleanup (in seconds)
	CleanupFrequency int
	Configuration    CooldownConfig
}

func NewLoginLimiter

func NewLoginLimiter(config CooldownConfig) *LoginLimiter

func (*LoginLimiter) CleanupLimiters

func (ll *LoginLimiter) CleanupLimiters()

Function that runs periodically in a goroutine to cleanup old visitors (threshold set with const)

func (*LoginLimiter) GetLimiter

func (ll *LoginLimiter) GetLimiter(userId uint, ip string) *rate.Limiter

type RateLimiter

type RateLimiter struct {
	Mutex    sync.Mutex
	Limiters map[string]Visitor
	// Threshold at which old visitors are deleted from the map (in seconds since last visit)
	VisitorAgeThreshold int
	// Frequency of cleanup (in seconds)
	CleanupFrequency int
	Configuration    LimiterConfig
}

func NewLimiter

func NewLimiter(config LimiterConfig) *RateLimiter

func (*RateLimiter) CleanupLimiters

func (rl *RateLimiter) CleanupLimiters()

Function that runs periodically in a goroutine to cleanup old visitors (threshold set with const)

func (*RateLimiter) GetLimiter

func (rl *RateLimiter) GetLimiter(ip string) *rate.Limiter

func (*RateLimiter) LimiterHandler

func (rl *RateLimiter) LimiterHandler(next http.HandlerFunc) http.HandlerFunc

type Visitor

type Visitor struct {
	Limiter  *rate.Limiter
	LastSeen time.Time
}