http

Documentation

Index

• func AllowedOrigin(allowedOrigins []string) func(origin string) bool
• func CORSOptions(config CORSConfig) cors.Options
• func RemoteAddr(r *http.Request) (string, error)
• type CORSConfig
• type RateLimit
  • func NewRateLimit(ctx context.Context, cfg RateLimitConfig) (*RateLimit, error)
  • func (r *RateLimit) NewRequest(identifier, ip string) error
• type RateLimitConfig

Functions

func AllowedOrigin

func AllowedOrigin(allowedOrigins []string) func(origin string) bool

func CORSOptions

func CORSOptions(config CORSConfig) cors.Options

func RemoteAddr

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

RemoteAddr collects possible remote addresses from a request.

Types

type CORSConfig

type CORSConfig struct {
	AllowedOrigins []string `description:"Allowed origins for CORS"                 long:"allowed-origins"`
	MaxAge         int      `description:"Max age (in seconds) for preflight cache" long:"max-age"`
}

CORSConfig represents the configuration for CORS.

type RateLimit

type RateLimit struct {
	// contains filtered or unexported fields
}

func NewRateLimit

func NewRateLimit(ctx context.Context, cfg RateLimitConfig) (*RateLimit, error)

func (*RateLimit) NewRequest

func (r *RateLimit) NewRequest(identifier, ip string) error

NewRequest returns nil if the rate has not been exceeded.

type RateLimitConfig

type RateLimitConfig struct {
	CoolDown encoding.Duration `description:"rate-limit duration, e.g. 10s, 1m30s, 24h0m0s" long:"coolDown"`

	AllowList []string `description:"a list of ip/subnets, e.g. 10.0.0.0/8, 192.168.0.0/16" long:"allowList"`
	// contains filtered or unexported fields
}