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
|
/*
GoToSocial
Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package security
import (
"net"
"net/http"
"time"
"github.com/gin-gonic/gin"
limiter "github.com/ulule/limiter/v3"
mgin "github.com/ulule/limiter/v3/drivers/middleware/gin"
memory "github.com/ulule/limiter/v3/drivers/store/memory"
)
type RateLimitOptions struct {
Period time.Duration
Limit int64
}
func (m *Module) LimitReachedHandler(c *gin.Context) {
code := http.StatusTooManyRequests
c.AbortWithStatusJSON(code, gin.H{"error": "rate limit reached"})
}
// returns a gin middleware that will automatically rate limit caller (by IP address)
// and enrich the response header with the following headers:
// - `x-ratelimit-limit` maximum number of requests allowed per time period (fixed)
// - `x-ratelimit-remaining` number of remaining requests that can still be performed
// - `x-ratelimit-reset` unix timestamp when the rate limit will reset
// if `x-ratelimit-limit` is exceeded an HTTP 429 error is returned
func (m *Module) RateLimit(rateOptions RateLimitOptions) func(c *gin.Context) {
rate := limiter.Rate{
Period: rateOptions.Period,
Limit: rateOptions.Limit,
}
store := memory.NewStore()
limiterInstance := limiter.New(
store,
rate,
// apply /64 mask to IPv6 addresses
limiter.WithIPv6Mask(net.CIDRMask(64, 128)),
)
middleware := mgin.NewMiddleware(
limiterInstance,
// use custom rate limit reached error
mgin.WithLimitReachedHandler(m.LimitReachedHandler),
)
return middleware
}
|
