forked from zalando/skipper
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ratelimit.go
212 lines (182 loc) · 4.97 KB
/
ratelimit.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
Package ratelimit provides filters to control the rate limitter settings on the route level.
For detailed documentation of the ratelimit, see https://godoc.org/github.com/zalando/skipper/ratelimit.
*/
package ratelimit
import (
"time"
"github.com/zalando/skipper/filters"
"github.com/zalando/skipper/ratelimit"
)
// RouteSettingsKey is used as key in the context state bag
const RouteSettingsKey = "#ratelimitsettings"
type spec struct {
typ ratelimit.Type
filterName string
}
type filter struct {
settings ratelimit.Settings
}
// NewLocalRatelimit creates a local measured rate limiting, that is
// only aware of itself. If you have 5 instances with 20 req/s, then
// it would allow 100 req/s to the backend from the same user. A third
// argument can be used to set which part of the request should be
// used to find the same user. Third argument defaults to
// XForwardedForLookuper, meaning X-Forwarded-For Header.
//
// Example:
//
// backendHealthcheck: Path("/healthcheck")
// -> localRatelimit(20, "1m")
// -> "https://foo.backend.net";
//
// Example rate limit per Authorization Header:
//
// login: Path("/login")
// -> localRatelimit(3, "1m", "auth")
// -> "https://login.backend.net";
func NewLocalRatelimit() filters.Spec {
return &spec{typ: ratelimit.LocalRatelimit, filterName: ratelimit.LocalRatelimitName}
}
// NewRatelimit creates a service rate limiting, that is
// only aware of itself. If you have 5 instances with 20 req/s, then
// it would at max allow 100 req/s to the backend.
//
// Example:
//
// backendHealthcheck: Path("/healthcheck")
// -> ratelimit(20, "1s")
// -> "https://foo.backend.net";
func NewRatelimit() filters.Spec {
return &spec{typ: ratelimit.ServiceRatelimit, filterName: ratelimit.ServiceRatelimitName}
}
// NewDisableRatelimit disables rate limiting
//
// Example:
//
// backendHealthcheck: Path("/healthcheck")
// -> disableRatelimit()
// -> "https://foo.backend.net";
func NewDisableRatelimit() filters.Spec {
return &spec{typ: ratelimit.DisableRatelimit, filterName: ratelimit.DisableRatelimitName}
}
func (s *spec) Name() string {
return s.filterName
}
func serviceRatelimitFilter(args []interface{}) (filters.Filter, error) {
if len(args) != 2 {
return nil, filters.ErrInvalidFilterParameters
}
var err error
var maxHits int
if len(args) > 0 {
maxHits, err = getIntArg(args[0])
if err != nil {
return nil, err
}
}
var timeWindow time.Duration
if len(args) > 1 {
timeWindow, err = getDurationArg(args[1])
if err != nil {
return nil, err
}
}
return &filter{
settings: ratelimit.Settings{
Type: ratelimit.ServiceRatelimit,
MaxHits: maxHits,
TimeWindow: timeWindow,
Lookuper: ratelimit.NewSameBucketLookuper(),
},
}, nil
}
func localRatelimitFilter(args []interface{}) (filters.Filter, error) {
if !(len(args) == 2 || len(args) == 3) {
return nil, filters.ErrInvalidFilterParameters
}
var err error
var maxHits int
if len(args) > 0 {
maxHits, err = getIntArg(args[0])
if err != nil {
return nil, err
}
}
var timeWindow time.Duration
if len(args) > 1 {
timeWindow, err = getDurationArg(args[1])
if err != nil {
return nil, err
}
}
var lookuper ratelimit.Lookuper
if len(args) > 2 {
lookuperName, err := getStringArg(args[2])
if err != nil {
return nil, err
}
switch lookuperName {
case "auth":
lookuper = ratelimit.NewAuthLookuper()
default:
lookuper = ratelimit.NewXForwardedForLookuper()
}
} else {
lookuper = ratelimit.NewXForwardedForLookuper()
}
return &filter{
settings: ratelimit.Settings{
Type: ratelimit.LocalRatelimit,
MaxHits: maxHits,
TimeWindow: timeWindow,
CleanInterval: 10 * timeWindow,
Lookuper: lookuper,
},
}, nil
}
func disableFilter(args []interface{}) (filters.Filter, error) {
return &filter{
settings: ratelimit.Settings{
Type: ratelimit.DisableRatelimit,
},
}, nil
}
func (s *spec) CreateFilter(args []interface{}) (filters.Filter, error) {
switch s.typ {
case ratelimit.ServiceRatelimit:
return serviceRatelimitFilter(args)
case ratelimit.LocalRatelimit:
return localRatelimitFilter(args)
default:
return disableFilter(args)
}
}
func getIntArg(a interface{}) (int, error) {
if i, ok := a.(int); ok {
return i, nil
}
if f, ok := a.(float64); ok {
return int(f), nil
}
return 0, filters.ErrInvalidFilterParameters
}
func getStringArg(a interface{}) (string, error) {
if s, ok := a.(string); ok {
return s, nil
}
return "", filters.ErrInvalidFilterParameters
}
func getDurationArg(a interface{}) (time.Duration, error) {
if s, ok := a.(string); ok {
return time.ParseDuration(s)
}
i, err := getIntArg(a)
return time.Duration(i) * time.Second, err
}
// Request stores the configured ratelimit.Settings in the state bag,
// such that it can be used in the proxy to check ratelimit.
func (f *filter) Request(ctx filters.FilterContext) {
ctx.StateBag()[RouteSettingsKey] = f.settings
}
func (f *filter) Response(filters.FilterContext) {}