mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 09:32:25 -05:00
5e2bf0bdca* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
66 lines
2.3 KiB
Go
66 lines
2.3 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// 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 middleware
|
|
|
|
import (
|
|
"net"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/ulule/limiter/v3"
|
|
limitergin "github.com/ulule/limiter/v3/drivers/middleware/gin"
|
|
"github.com/ulule/limiter/v3/drivers/store/memory"
|
|
)
|
|
|
|
const rateLimitPeriod = 5 * time.Minute
|
|
|
|
// RateLimit 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, the request is aborted and an HTTP 429 TooManyRequests
|
|
// status is returned.
|
|
//
|
|
// If the config AdvancedRateLimitRequests value is <= 0, then a noop handler will be returned,
|
|
// which performs no rate limiting.
|
|
func RateLimit(limit int) gin.HandlerFunc {
|
|
if limit <= 0 {
|
|
// use noop middleware if ratelimiting is disabled
|
|
return func(ctx *gin.Context) {}
|
|
}
|
|
|
|
limiter := limiter.New(
|
|
memory.NewStore(),
|
|
limiter.Rate{Period: rateLimitPeriod, Limit: int64(limit)},
|
|
limiter.WithIPv6Mask(net.CIDRMask(64, 128)), // apply /64 mask to IPv6 addresses
|
|
)
|
|
|
|
// use custom rate limit reached error
|
|
handler := func(c *gin.Context) {
|
|
c.AbortWithStatusJSON(http.StatusTooManyRequests, gin.H{"error": "rate limit reached"})
|
|
}
|
|
|
|
return limitergin.NewMiddleware(
|
|
limiter,
|
|
limitergin.WithLimitReachedHandler(handler),
|
|
)
|
|
}
|