Cockatrice/servatrice/src/ratelimiter.cpp
BruebachL 456d9d9e70
Some checks are pending
CodeQL / Analyze (cpp) (push) Waiting to run
CodeQL / Analyze (actions) (push) Waiting to run
Build Desktop / Configure (push) Waiting to run
Build Desktop / Debian 13 (push) Blocked by required conditions
Build Desktop / Debian 12 (push) Blocked by required conditions
Build Desktop / Fedora 44 (push) Blocked by required conditions
Build Desktop / Fedora 43 (push) Blocked by required conditions
Build Desktop / Servatrice_Debian 12 (push) Blocked by required conditions
Build Desktop / Ubuntu 24.04 (push) Blocked by required conditions
Build Desktop / Ubuntu 26.04 (push) Blocked by required conditions
Build Desktop / Arch (push) Blocked by required conditions
Build Desktop / Ubuntu 26.04 cover (push) Blocked by required conditions
Build Desktop / macOS 13 Intel (push) Blocked by required conditions
Build Desktop / macOS 14 (push) Blocked by required conditions
Build Desktop / macOS 15 (push) Blocked by required conditions
Build Desktop / macOS 26 Debug (push) Blocked by required conditions
Build Desktop / Windows 10 (push) Blocked by required conditions
Build Desktop / Prune caches (push) Waiting to run
Build Docker / Servatrice (arm) (push) Waiting to run
Build Docker / Servatrice (x86) (push) Waiting to run
Build Docker / Publish multi-platform Servatrice image (push) Blocked by required conditions
[Server] Inform client of login/registration rate limit timeout (#7468)
* [Security] Add per-address rate limiting for auth endpoints

Introduce a thread-safe RateLimiter that tracks attempts per key
(IP address) within a sliding time window, and wire it into the
authentication endpoints:

- Login: failed login attempts from an address are counted; once the
  configured maximum is exceeded within the window, further logins
  from that address are rejected with RespTooManyRequests. A
  successful login clears the failed attempts for that address.
- Registration: implement the previously stubbed
  tooManyRegistrationAttempts, limiting how many accounts can be
  created per address per window.
- Forgot-password: throttle both the email-request and the
  email-challenge paths per address.

New [security] settings with defaults:
  max_login_attempts_per_ip=5 / login_attempt_window_seconds=900
  max_registrations_per_ip=2 / registration_window_seconds=3600
  max_forgot_password_requests_per_ip=3 / forgot_password_window_seconds=3600

Adds unit tests for the RateLimiter (window limit, over-limit
blocking, clearing, per-key independence).

Took 3 minutes

* [Server] Fix rate limiter: disable semantics, draining window, bounded keys, pre-work login gate

- recordAttempt()/isBlocked() return false when maxAttempts <= 0 or windowSeconds <= 0, so the documented 'set to 0 to disable' actually disables instead of blocking every address permanently
- Keys at their limit are rejected without recording, so repeated attempts at the attacker's pace cannot keep sliding the window and holding the lockout open; a block now clears once the recorded attempts age out of windowSeconds
- Attempts map is bounded: an opportunistic prune (every 60s) erases keys whose attempts have fully aged out
- Login is throttled before the work: isLoginRateLimited() (a new virtual on Server, backed by isBlocked()) gates loginUser(), so a locked-out address no longer burns a database round trip and password verification per attempt
- recordAttemptAt()/isBlockedAt() time seams make the sliding-window behaviour deterministically testable; tests rewritten for the real semantics (no reliance on the maxAttempts=0 bug, no sleeps)

* [Server] Inform client of login/registration rate limit timeout

- Add retryAfterSeconds/retryAfterSecondsAt to RateLimiter to compute
  seconds until oldest attempt exits the sliding window
- Expose loginRateLimitRemainingSeconds via Server/Servatrice
- Include denied_end_time (absolute epoch) in RespTooManyRequests for
  login pre-auth and when transitioning to lockout after failed attempt
- Include denied_end_time in registration rate limit response
- Client: show retry time for login RespTooManyRequests
- Client: simplify registration RespTooManyRequests message to show
  retry time when provided
- Add test for retryAfterSecondsAt

* [Client] Restore registration guidance and drop duplicated rate limit reason

The registration RespTooManyRequests case now only shows the retry-after
copy when the server actually sent a denied_end_time; the per-email account
cap path (no end time) falls back to the previous guidance about already
having an account and contacting the server operator.

Drop the canned denied_reason_str from the new login rate limit branches so
the client no longer prints the same sentence twice.

* [Server] Exempt trusted_sources from auth rate limits

Addresses in security/trusted_sources bypass per-address limits, matching
the existing max_users_per_address bypass in initSession. Without this,
Webatrice behind local nginx (all clients as 127.0.0.1) would lock out
every web user after 5 mistyped passwords, and cap the whole server at
2 registrations / 3 forgot-password requests per window.

Adds Servatrice::isRateLimitExempt helper; recordFailedLogin,
isLoginRateLimited, recordRegistrationAttempt and
recordForgotPasswordAttempt all check it.

# Conflicts:
#	servatrice/src/servatrice.cpp

* [Server] Key login rate limit by (address, username)

A successful login cleared the whole per-IP failure history, so 4 bad
guesses plus 1 self-login (or guest UnknownUser login) from the same
address bypassed the limiter. Failures are now bucketed per
(address, lowercase username) and a success clears only its own pair.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
2026-10-16 05:47:43 +02:00

125 lines
3.4 KiB
C++

#include "ratelimiter.h"
#include <QDateTime>
bool RateLimiter::recordAttempt(const QString &key, int maxAttempts, int windowSeconds)
{
return recordAttemptAt(key, maxAttempts, windowSeconds, QDateTime::currentSecsSinceEpoch());
}
bool RateLimiter::recordAttemptAt(const QString &key, int maxAttempts, int windowSeconds, qint64 now)
{
if (maxAttempts <= 0 || windowSeconds <= 0) {
return false; // rate limiting disabled for this endpoint
}
QMutexLocker locker(&mutex);
pruneLocked(now);
AttemptHistory &history = attempts[key];
history.windowSeconds = windowSeconds;
QList<qint64> &timestamps = history.timestamps;
while (!timestamps.isEmpty() && timestamps.first() <= now - windowSeconds) {
timestamps.removeFirst();
}
if (timestamps.size() >= maxAttempts) {
// Already at the limit: reject without appending so repeated attempts
// at the attacker's own pace cannot keep sliding the window forward
// and hold the lockout open forever.
return true;
}
timestamps.append(now);
return false;
}
bool RateLimiter::isBlocked(const QString &key, int maxAttempts, int windowSeconds) const
{
return isBlockedAt(key, maxAttempts, windowSeconds, QDateTime::currentSecsSinceEpoch());
}
bool RateLimiter::isBlockedAt(const QString &key, int maxAttempts, int windowSeconds, qint64 now) const
{
if (maxAttempts <= 0 || windowSeconds <= 0) {
return false;
}
QMutexLocker locker(&mutex);
const auto it = attempts.constFind(key);
if (it == attempts.constEnd()) {
return false;
}
int count = 0;
for (const qint64 &timestamp : it.value().timestamps) {
if (timestamp > now - windowSeconds) {
++count;
}
}
return count >= maxAttempts;
}
void RateLimiter::clearAttempts(const QString &key)
{
QMutexLocker locker(&mutex);
attempts.remove(key);
}
int RateLimiter::retryAfterSeconds(const QString &key, int maxAttempts, int windowSeconds) const
{
return retryAfterSecondsAt(key, maxAttempts, windowSeconds, QDateTime::currentSecsSinceEpoch());
}
int RateLimiter::retryAfterSecondsAt(const QString &key, int maxAttempts, int windowSeconds, qint64 now) const
{
if (maxAttempts <= 0 || windowSeconds <= 0) {
return 0;
}
QMutexLocker locker(&mutex);
const auto it = attempts.constFind(key);
if (it == attempts.constEnd()) {
return 0;
}
QList<qint64> timestamps = it.value().timestamps;
while (!timestamps.isEmpty() && timestamps.first() <= now - windowSeconds) {
timestamps.removeFirst();
}
if (timestamps.size() < maxAttempts) {
return 0;
}
if (timestamps.isEmpty()) {
return 0;
}
qint64 oldest = timestamps.first();
qint64 retryAt = oldest + windowSeconds;
if (retryAt <= now) {
return 0;
}
return static_cast<int>(retryAt - now);
}
void RateLimiter::pruneLocked(qint64 now)
{
if (lastPruneSecs + PruneIntervalSeconds > now) {
return;
}
lastPruneSecs = now;
auto it = attempts.begin();
while (it != attempts.end()) {
QList<qint64> &timestamps = it.value().timestamps;
while (!timestamps.isEmpty() && timestamps.first() <= now - it.value().windowSeconds) {
timestamps.removeFirst();
}
if (timestamps.isEmpty()) {
it = attempts.erase(it);
} else {
++it;
}
}
}