Merge pull request #128 from jkaninda/feature/rate-limiting

fix: rate limit middleware
This commit is contained in:
2024-11-25 08:40:47 +01:00
committed by GitHub
15 changed files with 404 additions and 302 deletions

View File

@@ -10,12 +10,34 @@ nav_order: 6
The RateLimit middleware ensures that services will receive a fair number of requests, and allows one to define what fair is. The RateLimit middleware ensures that services will receive a fair number of requests, and allows one to define what fair is.
Example of global rateLimit middleware Example of rate limiting middleware
```yaml
middlewares:
- name: rate-limit
type: ratelimit #or rateLimit
paths:
- /*
rule:
unit: minute # or hour
requestsPerUnit: 10
```
Example of route rate limiting middleware
```yaml
version: 0.1.7
gateway:
routes:
- name: Example
rateLimit: 60 # peer minute
```
Example of global rate limiting middleware
```yaml ```yaml
version: 0.1.7 version: 0.1.7
gateway: gateway:
# Proxy rate limit, it's In-Memory IP based
rateLimit: 60 # peer minute rateLimit: 60 # peer minute
routes: routes:
- name: Example - name: Example

View File

@@ -226,6 +226,25 @@ func (Gateway) Setup(conf string) *Gateway {
} }
// rateLimitMiddleware returns RateLimitRuleMiddleware, error
func rateLimitMiddleware(input interface{}) (RateLimitRuleMiddleware, error) {
rateLimit := new(RateLimitRuleMiddleware)
var bytes []byte
bytes, err := yaml.Marshal(input)
if err != nil {
return RateLimitRuleMiddleware{}, fmt.Errorf("error parsing yaml: %v", err)
}
err = yaml.Unmarshal(bytes, rateLimit)
if err != nil {
return RateLimitRuleMiddleware{}, fmt.Errorf("error parsing yaml: %v", err)
}
if rateLimit.RequestsPerUnit == 0 {
return RateLimitRuleMiddleware{}, fmt.Errorf("requests per unit not defined")
}
return *rateLimit, nil
}
// getJWTMiddleware returns JWTRuleMiddleware,error // getJWTMiddleware returns JWTRuleMiddleware,error
func getJWTMiddleware(input interface{}) (JWTRuleMiddleware, error) { func getJWTMiddleware(input interface{}) (JWTRuleMiddleware, error) {
jWTRuler := new(JWTRuleMiddleware) jWTRuler := new(JWTRuleMiddleware)

View File

@@ -22,6 +22,7 @@ func getMiddleware(rules []string, middlewares []Middleware) (Middleware, error)
func doesExist(tyName string) bool { func doesExist(tyName string) bool {
middlewareList := []string{BasicAuth, JWTAuth, AccessMiddleware} middlewareList := []string{BasicAuth, JWTAuth, AccessMiddleware}
middlewareList = append(middlewareList, RateLimitMiddleware...)
return slices.Contains(middlewareList, tyName) return slices.Contains(middlewareList, tyName)
} }
func GetMiddleware(rule string, middlewares []Middleware) (Middleware, error) { func GetMiddleware(rule string, middlewares []Middleware) (Middleware, error) {

View File

@@ -53,6 +53,12 @@ func isPathBlocked(requestPath, blockedPath string) bool {
} }
return false return false
} }
func isProtectedPath(urlPath, prefix string, paths []string) bool {
for _, path := range paths {
return isPathBlocked(urlPath, util.ParseURLPath(prefix+path))
}
return false
}
// NewRateLimiter creates a new requests limiter with the specified refill requests and token capacity // NewRateLimiter creates a new requests limiter with the specified refill requests and token capacity
func NewRateLimiter(maxTokens int, refillRate time.Duration) *TokenRateLimiter { func NewRateLimiter(maxTokens int, refillRate time.Duration) *TokenRateLimiter {

View File

@@ -29,6 +29,7 @@ import (
// authorization based on the result of backend's response and continue the request when the client is authorized // authorization based on the result of backend's response and continue the request when the client is authorized
func (jwtAuth JwtAuth) AuthMiddleware(next http.Handler) http.Handler { func (jwtAuth JwtAuth) AuthMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if isProtectedPath(r.URL.Path, jwtAuth.Path, jwtAuth.Paths) {
for _, header := range jwtAuth.RequiredHeaders { for _, header := range jwtAuth.RequiredHeaders {
if r.Header.Get(header) == "" { if r.Header.Get(header) == "" {
logger.Error("Proxy error, missing %s header", header) logger.Error("Proxy error, missing %s header", header)
@@ -96,15 +97,17 @@ func (jwtAuth JwtAuth) AuthMiddleware(next http.Handler) http.Handler {
} }
} }
r.URL.RawQuery = query.Encode() r.URL.RawQuery = query.Encode()
}
next.ServeHTTP(w, r) next.ServeHTTP(w, r)
}) })
} }
// AuthMiddleware checks for the Authorization header and verifies the credentials // AuthMiddleware checks for the Authorization header and verifies the credentials
func (basicAuth AuthBasic) AuthMiddleware(next http.Handler) http.Handler { func (basicAuth AuthBasic) AuthMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
logger.Trace("Basic-Auth request headers: %v", r.Header) logger.Trace("Basic-Auth request headers: %v", r.Header)
if isProtectedPath(r.URL.Path, basicAuth.Path, basicAuth.Paths) {
// Get the Authorization header // Get the Authorization header
authHeader := r.Header.Get("Authorization") authHeader := r.Header.Get("Authorization")
if authHeader == "" { if authHeader == "" {
@@ -120,7 +123,6 @@ func (basicAuth AuthBasic) AuthMiddleware(next http.Handler) http.Handler {
return return
} }
// Decode the base64 encoded username:password string // Decode the base64 encoded username:password string
payload, err := base64.StdEncoding.DecodeString(authHeader[len("Basic "):]) payload, err := base64.StdEncoding.DecodeString(authHeader[len("Basic "):])
if err != nil { if err != nil {
@@ -128,7 +130,6 @@ func (basicAuth AuthBasic) AuthMiddleware(next http.Handler) http.Handler {
RespondWithError(w, http.StatusUnauthorized, http.StatusText(http.StatusUnauthorized)) RespondWithError(w, http.StatusUnauthorized, http.StatusText(http.StatusUnauthorized))
return return
} }
// Split the payload into username and password // Split the payload into username and password
pair := strings.SplitN(string(payload), ":", 2) pair := strings.SplitN(string(payload), ":", 2)
if len(pair) != 2 || pair[0] != basicAuth.Username || pair[1] != basicAuth.Password { if len(pair) != 2 || pair[0] != basicAuth.Username || pair[1] != basicAuth.Password {
@@ -137,6 +138,8 @@ func (basicAuth AuthBasic) AuthMiddleware(next http.Handler) http.Handler {
return return
} }
}
// Continue to the next handler if the authentication is successful // Continue to the next handler if the authentication is successful
next.ServeHTTP(w, r) next.ServeHTTP(w, r)
}) })

View File

@@ -26,6 +26,7 @@ import (
func (oauth Oauth) AuthMiddleware(next http.Handler) http.Handler { func (oauth Oauth) AuthMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if isProtectedPath(r.URL.Path, oauth.Path, oauth.Paths) {
oauthConf := oauth2Config(oauth) oauthConf := oauth2Config(oauth)
// Check if the user is authenticated // Check if the user is authenticated
token, err := r.Cookie("goma.oauth") token, err := r.Cookie("goma.oauth")
@@ -48,6 +49,7 @@ func (oauth Oauth) AuthMiddleware(next http.Handler) http.Handler {
http.Redirect(w, r, url, http.StatusTemporaryRedirect) http.Redirect(w, r, url, http.StatusTemporaryRedirect)
return return
} }
}
// Token exists, proceed with request // Token exists, proceed with request
next.ServeHTTP(w, r) next.ServeHTTP(w, r)
}) })

View File

@@ -45,17 +45,19 @@ func (rl *TokenRateLimiter) RateLimitMiddleware() mux.MiddlewareFunc {
// RateLimitMiddleware limits request based on the number of requests peer minutes. // RateLimitMiddleware limits request based on the number of requests peer minutes.
func (rl *RateLimiter) RateLimitMiddleware() mux.MiddlewareFunc { func (rl *RateLimiter) RateLimitMiddleware() mux.MiddlewareFunc {
window := time.Minute // requests per minute
if len(rl.unit) != 0 && rl.unit == "hour" {
window = time.Hour
}
return func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
clientIP := getRealIP(r) clientIP := getRealIP(r)
clientID := fmt.Sprintf("%s-%s", rl.id, clientIP) // Generate client Id, ID+ route ID clientID := fmt.Sprintf("%s-%s", rl.id, clientIP) // Generate client Id, ID+ route ID
logger.Debug("requests limiter: clientIP: %s, clientID: %s", clientIP, clientID)
if rl.redisBased { if rl.redisBased {
err := redisRateLimiter(clientID, rl.requests) err := redisRateLimiter(clientID, rl.unit, rl.requests)
if err != nil { if err != nil {
logger.Error("Redis Rate limiter error: %s", err.Error()) logger.Error("Redis Rate limiter error: %s", err.Error())
logger.Error("Too many requests from IP: %s %s %s", clientIP, r.URL, r.UserAgent()) logger.Error("Too many requests from IP: %s %s %s", clientIP, r.URL, r.UserAgent())
RespondWithError(w, http.StatusTooManyRequests, fmt.Sprintf("%d Too many requests, API requests limit exceeded. Please try again later", http.StatusTooManyRequests))
return return
} }
} else { } else {
@@ -64,7 +66,7 @@ func (rl *RateLimiter) RateLimitMiddleware() mux.MiddlewareFunc {
if !exists || time.Now().After(client.ExpiresAt) { if !exists || time.Now().After(client.ExpiresAt) {
client = &Client{ client = &Client{
RequestCount: 0, RequestCount: 0,
ExpiresAt: time.Now().Add(rl.window), ExpiresAt: time.Now().Add(window),
} }
rl.clientMap[clientID] = client rl.clientMap[clientID] = client
} }
@@ -78,8 +80,10 @@ func (rl *RateLimiter) RateLimitMiddleware() mux.MiddlewareFunc {
w.Header().Set("Access-Control-Allow-Origin", r.Header.Get("Origin")) w.Header().Set("Access-Control-Allow-Origin", r.Header.Get("Origin"))
} }
RespondWithError(w, http.StatusTooManyRequests, fmt.Sprintf("%d Too many requests, API requests limit exceeded. Please try again later", http.StatusTooManyRequests)) RespondWithError(w, http.StatusTooManyRequests, fmt.Sprintf("%d Too many requests, API requests limit exceeded. Please try again later", http.StatusTooManyRequests))
return
} }
} }
// Proceed to the next handler if the request limit is not exceeded // Proceed to the next handler if the request limit is not exceeded
next.ServeHTTP(w, r) next.ServeHTTP(w, r)
}) })

View File

@@ -25,10 +25,13 @@ import (
) )
// redisRateLimiter, handle rateLimit // redisRateLimiter, handle rateLimit
func redisRateLimiter(clientIP string, rate int) error { func redisRateLimiter(clientIP, unit string, rate int) error {
limit := redis_rate.PerMinute(rate)
if len(unit) != 0 && unit == "hour" {
limit = redis_rate.PerHour(rate)
}
ctx := context.Background() ctx := context.Background()
res, err := limiter.Allow(ctx, clientIP, limit)
res, err := limiter.Allow(ctx, clientIP, redis_rate.PerMinute(rate))
if err != nil { if err != nil {
return err return err
} }

View File

@@ -27,12 +27,14 @@ import (
// RateLimiter defines requests limit properties. // RateLimiter defines requests limit properties.
type RateLimiter struct { type RateLimiter struct {
requests int requests int
unit string
id string id string
window time.Duration
clientMap map[string]*Client clientMap map[string]*Client
mu sync.Mutex mu sync.Mutex
origins []string origins []string
redisBased bool redisBased bool
pathBased bool
paths []string
} }
// Client stores request count and window expiration for each client. // Client stores request count and window expiration for each client.
@@ -42,22 +44,26 @@ type Client struct {
} }
type RateLimit struct { type RateLimit struct {
Id string Id string
Unit string
Requests int Requests int
Window time.Duration
Origins []string Origins []string
Hosts []string Hosts []string
RedisBased bool RedisBased bool
PathBased bool
Paths []string
} }
// NewRateLimiterWindow creates a new RateLimiter. // NewRateLimiterWindow creates a new RateLimiter.
func (rateLimit RateLimit) NewRateLimiterWindow() *RateLimiter { func (rateLimit RateLimit) NewRateLimiterWindow() *RateLimiter {
return &RateLimiter{ return &RateLimiter{
id: rateLimit.Id, id: rateLimit.Id,
unit: rateLimit.Unit,
requests: rateLimit.Requests, requests: rateLimit.Requests,
window: rateLimit.Window,
clientMap: make(map[string]*Client), clientMap: make(map[string]*Client),
origins: rateLimit.Origins, origins: rateLimit.Origins,
redisBased: rateLimit.RedisBased, redisBased: rateLimit.RedisBased,
pathBased: rateLimit.PathBased,
paths: rateLimit.Paths,
} }
} }
@@ -79,6 +85,8 @@ type ProxyResponseError struct {
// JwtAuth stores JWT configuration // JwtAuth stores JWT configuration
type JwtAuth struct { type JwtAuth struct {
Path string
Paths []string
AuthURL string AuthURL string
RequiredHeaders []string RequiredHeaders []string
Headers map[string]string Headers map[string]string
@@ -101,6 +109,9 @@ type AccessListMiddleware struct {
// AuthBasic contains Basic auth configuration // AuthBasic contains Basic auth configuration
type AuthBasic struct { type AuthBasic struct {
// Route path
Path string
Paths []string
Username string Username string
Password string Password string
Headers map[string]string Headers map[string]string
@@ -120,6 +131,10 @@ type responseRecorder struct {
body *bytes.Buffer body *bytes.Buffer
} }
type Oauth struct { type Oauth struct {
// Route path
Path string
// Route protected path
Paths []string
// ClientID is the application's ID. // ClientID is the application's ID.
ClientID string ClientID string
// ClientSecret is the application's secret. // ClientSecret is the application's secret.

View File

@@ -42,7 +42,7 @@ type Route struct {
HealthCheck RouteHealthCheck `yaml:"healthCheck"` HealthCheck RouteHealthCheck `yaml:"healthCheck"`
// Cors contains the route cors headers // Cors contains the route cors headers
Cors Cors `yaml:"cors"` Cors Cors `yaml:"cors"`
RateLimit int `yaml:"rateLimit"` RateLimit int `yaml:"rateLimit,omitempty"`
// DisableHostFording Disable X-forwarded header. // DisableHostFording Disable X-forwarded header.
// //
// [X-Forwarded-Host, X-Forwarded-For, Host, Scheme ] // [X-Forwarded-Host, X-Forwarded-For, Host, Scheme ]

View File

@@ -23,7 +23,7 @@ import (
"github.com/jkaninda/goma-gateway/util" "github.com/jkaninda/goma-gateway/util"
"github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp" "github.com/prometheus/client_golang/prometheus/promhttp"
"time" "slices"
) )
// init initializes prometheus metrics // init initializes prometheus metrics
@@ -61,8 +61,6 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
if err != nil { if err != nil {
logger.Fatal("Error: %v", err) logger.Fatal("Error: %v", err)
} }
m := dynamicMiddlewares
redisBased := false
if len(gateway.Redis.Addr) != 0 { if len(gateway.Redis.Addr) != 0 {
redisBased = true redisBased = true
} }
@@ -97,8 +95,8 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
// Add rate limit middlewares to all routes, if defined // Add rate limit middlewares to all routes, if defined
rateLimit := middlewares.RateLimit{ rateLimit := middlewares.RateLimit{
Id: "global_rate", // Generate a unique ID for routes Id: "global_rate", // Generate a unique ID for routes
Unit: "minute",
Requests: gateway.RateLimit, Requests: gateway.RateLimit,
Window: time.Minute, // requests per minute
Origins: gateway.Cors.Origins, Origins: gateway.Cors.Origins,
Hosts: []string{}, Hosts: []string{},
RedisBased: redisBased, RedisBased: redisBased,
@@ -108,44 +106,15 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
r.Use(limiter.RateLimitMiddleware()) r.Use(limiter.RateLimitMiddleware())
} }
for rIndex, route := range dynamicRoutes { for rIndex, route := range dynamicRoutes {
// create route
router := r.PathPrefix(route.Path).Subrouter()
if len(route.Path) != 0 { if len(route.Path) != 0 {
// Checks if route destination and backend are empty // Checks if route destination and backend are empty
if len(route.Destination) == 0 && len(route.Backends) == 0 { if len(route.Destination) == 0 && len(route.Backends) == 0 {
logger.Fatal("Route %s : destination or backends should not be empty", route.Name) logger.Fatal("Route %s : destination or backends should not be empty", route.Name)
} }
// Apply middlewares to the route
for _, middleware := range route.Middlewares {
if middleware != "" {
// Get Access middlewares if it does exist
accessMiddleware, err := getMiddleware([]string{middleware}, m)
if err != nil {
logger.Error("Error: %v", err.Error())
} else {
// Apply access middlewares
if accessMiddleware.Type == AccessMiddleware {
blM := middlewares.AccessListMiddleware{
Path: route.Path,
List: accessMiddleware.Paths,
}
r.Use(blM.AccessMiddleware)
}
}
// Get route authentication middlewares if it does exist
routeMiddleware, err := getMiddleware([]string{middleware}, m)
if err != nil {
// Error: middlewares not found
logger.Error("Error: %v", err.Error())
} else {
attachAuthMiddlewares(route, routeMiddleware, gateway, r)
}
} else {
logger.Error("Error, middlewares path is empty")
logger.Error("Middleware ignored")
}
}
proxyRoute := ProxyRoute{ proxyRoute := ProxyRoute{
path: route.Path, path: route.Path,
rewrite: route.Rewrite, rewrite: route.Rewrite,
@@ -156,42 +125,9 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
cors: route.Cors, cors: route.Cors,
insecureSkipVerify: route.InsecureSkipVerify, insecureSkipVerify: route.InsecureSkipVerify,
} }
// create route attachMiddlewares(rIndex, route, gateway, router)
router := r.PathPrefix(route.Path).Subrouter()
// Apply common exploits to the route
// Enable common exploits
if route.BlockCommonExploits {
logger.Info("Block common exploits enabled")
router.Use(middlewares.BlockExploitsMiddleware)
}
id := string(rune(rIndex))
if len(route.Name) != 0 {
// Use route name as ID
id = util.Slug(route.Name)
}
// Apply route rate limit
if route.RateLimit != 0 {
rateLimit := middlewares.RateLimit{
Id: id, // Use route index as ID
Requests: route.RateLimit,
Window: time.Minute, // requests per minute
Origins: route.Cors.Origins,
Hosts: route.Hosts,
RedisBased: redisBased,
}
limiter := rateLimit.NewRateLimiterWindow()
// Add rate limit middlewares
router.Use(limiter.RateLimitMiddleware())
}
// Apply route Cors // Apply route Cors
router.Use(CORSHandler(route.Cors)) router.Use(CORSHandler(route.Cors))
if len(route.Hosts) > 0 {
for _, host := range route.Hosts {
router.Host(host).PathPrefix("").Handler(proxyRoute.ProxyHandler())
}
} else {
router.PathPrefix("").Handler(proxyRoute.ProxyHandler())
}
if gateway.EnableMetrics { if gateway.EnableMetrics {
pr := metrics.PrometheusRoute{ pr := metrics.PrometheusRoute{
Name: route.Name, Name: route.Name,
@@ -208,11 +144,19 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
} }
router.Use(interceptErrors.ErrorInterceptor) router.Use(interceptErrors.ErrorInterceptor)
} }
if len(route.Hosts) != 0 {
for _, host := range route.Hosts {
router.Host(host).PathPrefix("").Handler(proxyRoute.ProxyHandler())
}
} else {
router.PathPrefix("").Handler(proxyRoute.ProxyHandler())
}
} else { } else {
logger.Error("Error, path is empty in route %s", route.Name) logger.Error("Error, path is empty in route %s", route.Name)
logger.Error("Route path ignored: %s", route.Path) logger.Error("Route path ignored: %s", route.Path)
} }
}
// Apply global Cors middlewares // Apply global Cors middlewares
r.Use(CORSHandler(gateway.Cors)) // Apply CORS middlewares r.Use(CORSHandler(gateway.Cors)) // Apply CORS middlewares
// Apply errorInterceptor middlewares // Apply errorInterceptor middlewares
@@ -224,23 +168,99 @@ func (gatewayServer GatewayServer) Initialize() *mux.Router {
r.Use(interceptErrors.ErrorInterceptor) r.Use(interceptErrors.ErrorInterceptor)
} }
}
return r return r
} }
func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gateway, r *mux.Router) { // attachMiddlewares attach middlewares to the route
for _, middlewarePath := range routeMiddleware.Paths { func attachMiddlewares(rIndex int, route Route, gateway Gateway, router *mux.Router) {
proxyRoute := ProxyRoute{ // Apply middlewares to the route
path: route.Path, for _, middleware := range route.Middlewares {
rewrite: route.Rewrite, // Apply common exploits to the route
destination: route.Destination, // Enable common exploits
backends: route.Backends, if route.BlockCommonExploits {
disableHostFording: route.DisableHostFording, logger.Info("Block common exploits enabled")
methods: route.Methods, router.Use(middlewares.BlockExploitsMiddleware)
cors: route.Cors,
insecureSkipVerify: route.InsecureSkipVerify,
} }
secureRouter := r.PathPrefix(util.ParseRoutePath(route.Path, middlewarePath)).Subrouter() id := string(rune(rIndex))
if len(route.Name) != 0 {
// Use route name as ID
id = util.Slug(route.Name)
}
// Apply route rate limit
if route.RateLimit != 0 {
rateLimit := middlewares.RateLimit{
Unit: "minute",
Id: id, // Use route index as ID
Requests: route.RateLimit,
Origins: route.Cors.Origins,
Hosts: route.Hosts,
RedisBased: redisBased,
}
limiter := rateLimit.NewRateLimiterWindow()
// Add rate limit middlewares
router.Use(limiter.RateLimitMiddleware())
}
if len(middleware) != 0 {
// Get Access middlewares if it does exist
accessMiddleware, err := getMiddleware([]string{middleware}, dynamicMiddlewares)
if err != nil {
logger.Error("Error: %v", err.Error())
} else {
// Apply access middlewares
if accessMiddleware.Type == AccessMiddleware {
blM := middlewares.AccessListMiddleware{
Path: route.Path,
List: accessMiddleware.Paths,
}
router.Use(blM.AccessMiddleware)
}
// Apply Rate limit middleware
if slices.Contains(RateLimitMiddleware, accessMiddleware.Type) {
rateLimitMid, err := rateLimitMiddleware(accessMiddleware.Rule)
if err != nil {
logger.Error("Error: %v", err.Error())
}
if rateLimitMid.RequestsPerUnit != 0 && route.RateLimit == 0 {
rateLimit := middlewares.RateLimit{
Unit: rateLimitMid.Unit,
Id: id, // Use route index as ID
Requests: rateLimitMid.RequestsPerUnit,
Origins: route.Cors.Origins,
Hosts: route.Hosts,
RedisBased: redisBased,
PathBased: true,
Paths: util.AddPrefixPath(route.Path, accessMiddleware.Paths),
}
limiter := rateLimit.NewRateLimiterWindow()
// Add rate limit middlewares
router.Use(limiter.RateLimitMiddleware())
}
}
}
// Get route authentication middlewares if it does exist
routeMiddleware, err := getMiddleware([]string{middleware}, dynamicMiddlewares)
if err != nil {
// Error: middlewares not found
logger.Error("Error: %v", err.Error())
} else {
attachAuthMiddlewares(route, routeMiddleware, gateway, router)
}
} else {
logger.Error("Error, middlewares path is empty")
logger.Error("Middleware ignored")
}
}
}
func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gateway, r *mux.Router) {
// Check Authentication middleware types // Check Authentication middleware types
switch routeMiddleware.Type { switch routeMiddleware.Type {
case BasicAuth: case BasicAuth:
@@ -249,16 +269,16 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
logger.Error("Error: %s", err.Error()) logger.Error("Error: %s", err.Error())
} else { } else {
authBasic := middlewares.AuthBasic{ authBasic := middlewares.AuthBasic{
Path: route.Path,
Paths: routeMiddleware.Paths,
Username: basicAuth.Username, Username: basicAuth.Username,
Password: basicAuth.Password, Password: basicAuth.Password,
Headers: nil, Headers: nil,
Params: nil, Params: nil,
} }
// Apply JWT authentication middlewares // Apply JWT authentication middlewares
secureRouter.Use(authBasic.AuthMiddleware) r.Use(authBasic.AuthMiddleware)
secureRouter.Use(CORSHandler(route.Cors)) r.Use(CORSHandler(route.Cors))
secureRouter.PathPrefix("/").Handler(proxyRoute.ProxyHandler()) // Proxy handler
secureRouter.PathPrefix("").Handler(proxyRoute.ProxyHandler()) // Proxy handler
} }
case JWTAuth: case JWTAuth:
jwt, err := getJWTMiddleware(routeMiddleware.Rule) jwt, err := getJWTMiddleware(routeMiddleware.Rule)
@@ -266,6 +286,8 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
logger.Error("Error: %s", err.Error()) logger.Error("Error: %s", err.Error())
} else { } else {
jwtAuth := middlewares.JwtAuth{ jwtAuth := middlewares.JwtAuth{
Path: route.Path,
Paths: routeMiddleware.Paths,
AuthURL: jwt.URL, AuthURL: jwt.URL,
RequiredHeaders: jwt.RequiredHeaders, RequiredHeaders: jwt.RequiredHeaders,
Headers: jwt.Headers, Headers: jwt.Headers,
@@ -273,10 +295,8 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
Origins: gateway.Cors.Origins, Origins: gateway.Cors.Origins,
} }
// Apply JWT authentication middlewares // Apply JWT authentication middlewares
secureRouter.Use(jwtAuth.AuthMiddleware) r.Use(jwtAuth.AuthMiddleware)
secureRouter.Use(CORSHandler(route.Cors)) r.Use(CORSHandler(route.Cors))
secureRouter.PathPrefix("/").Handler(proxyRoute.ProxyHandler()) // Proxy handler
secureRouter.PathPrefix("").Handler(proxyRoute.ProxyHandler()) // Proxy handler
} }
case OAuth: case OAuth:
@@ -289,6 +309,8 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
redirectURL = oauth.RedirectURL redirectURL = oauth.RedirectURL
} }
amw := middlewares.Oauth{ amw := middlewares.Oauth{
Path: route.Path,
Paths: routeMiddleware.Paths,
ClientID: oauth.ClientID, ClientID: oauth.ClientID,
ClientSecret: oauth.ClientSecret, ClientSecret: oauth.ClientSecret,
RedirectURL: redirectURL, RedirectURL: redirectURL,
@@ -310,16 +332,13 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
} }
// Check if a RedirectPath is defined // Check if a RedirectPath is defined
if oauthRuler.RedirectPath == "" { if oauthRuler.RedirectPath == "" {
oauthRuler.RedirectPath = util.ParseRoutePath(route.Path, middlewarePath) oauthRuler.RedirectPath = util.ParseRoutePath(route.Path, routeMiddleware.Paths[0])
} }
if oauthRuler.Provider == "" { if oauthRuler.Provider == "" {
oauthRuler.Provider = "custom" oauthRuler.Provider = "custom"
} }
secureRouter.Use(amw.AuthMiddleware) r.Use(amw.AuthMiddleware)
secureRouter.Use(CORSHandler(route.Cors)) r.Use(CORSHandler(route.Cors))
secureRouter.PathPrefix("/").Handler(proxyRoute.ProxyHandler()) // Proxy handler
secureRouter.PathPrefix("").Handler(proxyRoute.ProxyHandler()) // Proxy handler
// Callback route
r.HandleFunc(util.UrlParsePath(redirectURL), oauthRuler.callbackHandler).Methods("GET") r.HandleFunc(util.UrlParsePath(redirectURL), oauthRuler.callbackHandler).Methods("GET")
} }
default: default:
@@ -330,4 +349,3 @@ func attachAuthMiddlewares(route Route, routeMiddleware Middleware, gateway Gate
} }
} }
}

View File

@@ -30,7 +30,7 @@ import (
// Start / Start starts the server // Start / Start starts the server
func (gatewayServer GatewayServer) Start() error { func (gatewayServer GatewayServer) Start() error {
logger.Info("Initializing routes...") logger.Info("Initializing routes...")
route := gatewayServer.Initialize() router := gatewayServer.Initialize()
logger.Debug("Routes count=%d, Middlewares count=%d", len(gatewayServer.gateway.Routes), len(gatewayServer.middlewares)) logger.Debug("Routes count=%d, Middlewares count=%d", len(gatewayServer.gateway.Routes), len(gatewayServer.middlewares))
gatewayServer.initRedis() gatewayServer.initRedis()
defer gatewayServer.closeRedis() defer gatewayServer.closeRedis()
@@ -44,8 +44,8 @@ func (gatewayServer GatewayServer) Start() error {
printRoute(dynamicRoutes) printRoute(dynamicRoutes)
} }
httpServer := gatewayServer.createServer(":8080", route, nil) httpServer := gatewayServer.createServer(":8080", router, nil)
httpsServer := gatewayServer.createServer(":8443", route, tlsConfig) httpsServer := gatewayServer.createServer(":8443", router, tlsConfig)
// Start HTTP/HTTPS servers // Start HTTP/HTTPS servers
gatewayServer.startServers(httpServer, httpsServer, listenWithTLS) gatewayServer.startServers(httpServer, httpsServer, listenWithTLS)

View File

@@ -80,13 +80,11 @@ type OauthEndpoint struct {
TokenURL string `yaml:"tokenUrl"` TokenURL string `yaml:"tokenUrl"`
UserInfoURL string `yaml:"userInfoUrl"` UserInfoURL string `yaml:"userInfoUrl"`
} }
type RateLimiter struct {
// ipBased, tokenBased
Type string `yaml:"type"`
Rate float64 `yaml:"rate"`
Rule int `yaml:"rule"`
}
type RateLimitRuleMiddleware struct {
Unit string `yaml:"unit"`
RequestsPerUnit int `yaml:"requestsPerUnit"`
}
type AccessRuleMiddleware struct { type AccessRuleMiddleware struct {
ResponseCode int `yaml:"responseCode"` // HTTP Response code ResponseCode int `yaml:"responseCode"` // HTTP Response code
} }

View File

@@ -9,10 +9,13 @@ const AccessMiddleware = "access" // access middlewares
const BasicAuth = "basic" // basic authentication middlewares const BasicAuth = "basic" // basic authentication middlewares
const JWTAuth = "jwt" // JWT authentication middlewares const JWTAuth = "jwt" // JWT authentication middlewares
const OAuth = "oauth" // OAuth authentication middlewares const OAuth = "oauth" // OAuth authentication middlewares
var ( var (
// Round-robin counter // Round-robin counter
counter uint32 counter uint32
// dynamicRoutes routes // dynamicRoutes routes
dynamicRoutes []Route dynamicRoutes []Route
dynamicMiddlewares []Middleware dynamicMiddlewares []Middleware
RateLimitMiddleware = []string{"ratelimit", "rateLimit"} // Rate Limit middlewares
redisBased = false
) )

View File

@@ -157,3 +157,11 @@ func Slug(text string) string {
return text return text
} }
func AddPrefixPath(prefix string, paths []string) []string {
for i := range paths {
paths[i] = ParseURLPath(prefix + paths[i])
}
return paths
}