Let the login throttle see real client IPs behind Cloudflare

Behind a proxy REMOTE_ADDR is the proxy, so the per-IP limit would lump
every visitor together. New optional CLIENT_IP_HEADER in config.php
(e.g. 'CF-Connecting-IP') tells the throttle which header carries the
real address; invalid or absent values fall back to REMOTE_ADDR, and
configs that predate the setting behave as before. Only for origins
unreachable except through the proxy — documented in the README, which
also covers the mod_remoteip/real_ip alternative.

Claude-Session: https://claude.ai/code/session_01SePf61iazhCLJBefdRLBDm
This commit is contained in:
Harwinder Sekhon
2026-07-30 21:17:46 -04:00
parent 2e15bdc8cb
commit 66e4905796
4 changed files with 35 additions and 1 deletions
+7
View File
@@ -251,6 +251,13 @@ returned as JSON, with detail gated behind `DEBUG`.
IP, inside 15 minutes answer `429` until 15 minutes have passed since the
last failure. A successful login clears the username's failures; stale rows
are purged as new ones are recorded.
- **Behind Cloudflare** (or any proxy that hides the visitor), the IP the
throttle sees is the proxy's. Either restore real client IPs at the web
server (Apache `mod_remoteip` / Nginx `real_ip` with `CF-Connecting-IP` —
the better fix, it also corrects your logs), or set
`CLIENT_IP_HEADER` to `'CF-Connecting-IP'` in `config.php`. Only do either
if the origin is unreachable except through the proxy; otherwise the header
can be spoofed to dodge the per-IP limit.
- The shipped `.htaccess` (Apache) denies direct access to `videos/`,
`includes/`, `config.php` and `schema.sql` — without it, video URLs would
bypass login entirely. Nginx setups need the equivalent `location` blocks,
+1 -1
View File
@@ -27,7 +27,7 @@ verifyCsrfApi($data);
$action = $data['action'] ?? '';
$username = trim($data['username'] ?? '');
$password = $data['password'] ?? '';
$ip = $_SERVER['REMOTE_ADDR'] ?? '';
$ip = clientIp();
switch ($action) {
case 'login':
+8
View File
@@ -19,6 +19,14 @@ define('COMPLETE_THRESHOLD', 0.95);
// Allow new users to self-register from the login page.
define('ALLOW_REGISTRATION', true);
// Only when the app sits behind a proxy that hides the visitor's address
// (Cloudflare): the header carrying the real client IP, used by the login
// brute-force throttle. Set this ONLY if the origin cannot be reached except
// through that proxy — a directly reachable origin lets anyone spoof the
// header and dodge the per-IP limit. Leave '' to use the connection address.
// define('CLIENT_IP_HEADER', 'CF-Connecting-IP');
define('CLIENT_IP_HEADER', '');
// Return the exception type, file:line and stack trace in API error responses.
// Errors are written to the PHP error log either way — this only controls what
// the browser is told, so leave it false on anything publicly reachable.
+19
View File
@@ -102,6 +102,25 @@ const LOGIN_FAIL_WINDOW = 900; // seconds
const LOGIN_MAX_USER_FAILS = 5;
const LOGIN_MAX_IP_FAILS = 20;
/**
* The client's IP for the throttle. Behind a proxy that hides the visitor
* (Cloudflare), REMOTE_ADDR is the proxy — set CLIENT_IP_HEADER in
* config.php to the header carrying the real address instead. Optional and
* off by default: installs whose config.php predates the setting keep using
* REMOTE_ADDR.
*/
function clientIp(): string
{
if (defined('CLIENT_IP_HEADER') && CLIENT_IP_HEADER !== '') {
$key = 'HTTP_' . strtoupper(str_replace('-', '_', CLIENT_IP_HEADER));
$ip = trim(explode(',', $_SERVER[$key] ?? '')[0]);
if ($ip !== '' && filter_var($ip, FILTER_VALIDATE_IP)) {
return $ip;
}
}
return $_SERVER['REMOTE_ADDR'] ?? '';
}
/** Seconds until this username/IP may try again — 0 means go ahead. */
function loginRetryAfter(string $username, string $ip): int
{