File size: 3,330 Bytes
20f83d9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
// Trusted client-IP derivation, extracted from rate-limit.ts (#5231).
//
// This module MUST stay free of npm imports (node: builtins and repo-relative
// imports only). It sits in the static import closure of server/_shared/redis.ts
// -> usage.ts, which Railway seeders load through the tsx loader in containers
// that install no npm packages beyond tsx itself. A bare npm specifier
// reachable from here crashes those crons with ERR_MODULE_NOT_FOUND at module
// resolution time — that is how #5229 took down seed-bundle-resilience-
// validation by importing this logic's previous home (rate-limit.ts, which
// pulls @upstash/ratelimit). tests/resilience-validation-import-graph.test.mjs
// enforces the invariant.

// Sentinel returned when no trusted client-IP header is present. Routed
// through the Upstash limiter as a single shared bucket so the entire
// "no trusted identity" population is naturally rate-limited together —
// an attacker who strips cf-connecting-ip / x-real-ip can no longer rotate
// identities by toggling x-forwarded-for. See getClientIp / #3531.
export const UNKNOWN_CLIENT_IP = 'unknown';

// Header a Cloudflare Transform Rule injects on every proxied request to prove
// the request actually transited CF. Keep in sync with api/_client-ip.js.
const CF_EDGE_PROOF_HEADER = 'x-wm-edge-proof';

// Compare the edge-proof secret without an early exit on length mismatch.
// Synchronous so getClientIp stays sync (per-request rate-limit hot path,
// several non-awaiting callers). Keep in sync with api/_client-ip.js.
function constantTimeEqual(a: string, b: string): boolean {
  const len = b.length;
  let diff = a.length ^ b.length;
  for (let i = 0; i < len; i += 1) diff |= (a.charCodeAt(i) || 0) ^ b.charCodeAt(i);
  return diff === 0;
}

// True only when the request proves it transited Cloudflare. If
// CF_EDGE_PROOF_SECRET is unset, do not trust cf-connecting-ip; fall back to
// x-real-ip/UNKNOWN so a missing deployment secret cannot silently reopen
// GHSA-c267.
export function hasCloudflareTransitProof(request: Request): boolean {
  const secret = (process.env.CF_EDGE_PROOF_SECRET ?? '').trim();
  if (!secret) return false;
  return constantTimeEqual((request.headers.get(CF_EDGE_PROOF_HEADER) ?? '').trim(), secret);
}

export function getClientIp(request: Request): string {
  // cf-connecting-ip is only unforgeable for traffic that actually transited
  // Cloudflare (x-real-ip is then the CF edge IP, shared across users). On a
  // direct-to-origin hit (bypassing CF) cf-connecting-ip is fully client-
  // controlled, so a caller sending a fresh value per request rotates the
  // per-IP window and neutralises the limit (GHSA-c267). Trust it only with
  // proof of CF transit. Otherwise fall back to x-real-ip (the real peer IP)
  // then the UNKNOWN_CLIENT_IP sentinel — the spoofable cf-connecting-ip and
  // the client-settable x-forwarded-for (#3531) are deliberately NOT fallbacks.
  //
  // Trim each header value before falling through — a whitespace-only
  // cf-connecting-ip would otherwise short-circuit past x-real-ip.
  const cf = (request.headers.get('cf-connecting-ip') ?? '').trim();
  const xr = (request.headers.get('x-real-ip') ?? '').trim();
  if (cf && hasCloudflareTransitProof(request)) return cf;
  return xr || UNKNOWN_CLIENT_IP;
}