gin

Documentation

Index

• Variables
• func IPTokenExtractor(c *gin.Context) string
• func NewRateLimiterMw(logger logging.Logger, next krakendgin.HandlerFactory) krakendgin.HandlerFactory
• func RateLimiterWrapperFromCfg(logger logging.Logger, logPrefix string, cfg router.Config, ...) gin.HandlerFunc
• type EndpointMw
  • func NewEndpointRateLimiterMw(tb *krakendrate.TokenBucket) EndpointMw
  • func NewHeaderLimiterMw(header string, maxRate float64, capacity uint64) EndpointMw
  • func NewHeaderLimiterMwFromCfg(cfg router.Config) EndpointMw
  • func NewIpLimiterMw(maxRate float64, capacity uint64) EndpointMw
  • func NewIpLimiterWithKeyMw(header string, maxRate float64, capacity uint64) EndpointMw
  • func NewIpLimiterWithKeyMwFromCfg(cfg router.Config) EndpointMw
  • func NewTokenLimiterMw(tokenExtractor TokenExtractor, limiterStore krakendrate.LimiterStore) EndpointMw
• type TokenExtractor
  • func HeaderTokenExtractor(header string) TokenExtractor
  • func NewIPTokenExtractor(header string) TokenExtractor
  • func ParamTokenExtractor(param string) TokenExtractor
  • func TokenExtractorFromCfg(cfg router.Config) (TokenExtractor, error)

Variables

var ErrNotFound = errors.New("not found")

var HandlerFactory = NewRateLimiterMw(logging.NoOp, krakendgin.EndpointHandler)

HandlerFactory is the out-of-the-box basic ratelimit handler factory using the default krakend endpoint handler for the gin router

Functions

func IPTokenExtractor

func IPTokenExtractor(c *gin.Context) string

IPTokenExtractor extracts the IP of the request

func NewRateLimiterMw

func NewRateLimiterMw(logger logging.Logger, next krakendgin.HandlerFactory) krakendgin.HandlerFactory

NewRateLimiterMw builds a rate limiting wrapper over the received handler factory.

func RateLimiterWrapperFromCfg

func RateLimiterWrapperFromCfg(logger logging.Logger, logPrefix string, cfg router.Config,
	handler gin.HandlerFunc,
) gin.HandlerFunc

Types

type EndpointMw

type EndpointMw func(gin.HandlerFunc) gin.HandlerFunc

EndpointMw is a function that decorates the received handlerFunc with some rateliming logic

func NewEndpointRateLimiterMw

func NewEndpointRateLimiterMw(tb *krakendrate.TokenBucket) EndpointMw

NewEndpointRateLimiterMw creates a simple ratelimiter for a given handlerFunc

func NewHeaderLimiterMw

func NewHeaderLimiterMw(header string, maxRate float64, capacity uint64) EndpointMw

NewHeaderLimiterMw creates a token ratelimiter using the value of a header as a token

Deprecated: Use NewHeaderLimiterMwFromCfg instead

func NewHeaderLimiterMwFromCfg

func NewHeaderLimiterMwFromCfg(cfg router.Config) EndpointMw

NewHeaderLimiterMwFromCfg creates a token ratelimiter using the value of a header as a token

func NewIpLimiterMw

func NewIpLimiterMw(maxRate float64, capacity uint64) EndpointMw

NewIpLimiterMw creates a token ratelimiter using the IP of the request as a token

func NewIpLimiterWithKeyMw

func NewIpLimiterWithKeyMw(header string, maxRate float64, capacity uint64) EndpointMw

NewIpLimiterWithKeyMw creates a token ratelimiter using the IP of the request as a token

Deprecated: Use NewIpLimiterWithKeyMwFromCfg instead

func NewIpLimiterWithKeyMwFromCfg

func NewIpLimiterWithKeyMwFromCfg(cfg router.Config) EndpointMw

NewIpLimiterWithKeyMwFromCfg creates a token ratelimiter using the IP of the request as a token

func NewTokenLimiterMw

func NewTokenLimiterMw(tokenExtractor TokenExtractor, limiterStore krakendrate.LimiterStore) EndpointMw

NewTokenLimiterMw returns a token based ratelimiting endpoint middleware with the received TokenExtractor and LimiterStore

type TokenExtractor

type TokenExtractor func(*gin.Context) string

TokenExtractor defines the interface of the functions to use in order to extract a token for each request

func HeaderTokenExtractor

func HeaderTokenExtractor(header string) TokenExtractor

HeaderTokenExtractor returns a TokenExtractor that looks for the value of the designed header

func NewIPTokenExtractor

func NewIPTokenExtractor(header string) TokenExtractor

NewIPTokenExtractor generates an IP TokenExtractor checking first for the contents of the passed header. If nothing is found there, the regular IPTokenExtractor function is called.

func ParamTokenExtractor

func ParamTokenExtractor(param string) TokenExtractor

ParamTokenExtractor returns a TokenExtractor that uses a param a token

func TokenExtractorFromCfg

func TokenExtractorFromCfg(cfg router.Config) (TokenExtractor, error)

TokenExtractorFromCfg selects the token extractor to use from the input config