@remit/auth-service 0.0.11 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/auth-service",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "better-auth identity service for the self-host stack",
   "type": "module",
   "main": "src/index.ts",
@@ -21,7 +21,7 @@
   },
   "scripts": {
     "test:typecheck": "tsgo --noEmit -p tsconfig.json",
-    "test:run": "node --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=94 --test 'src/**/*.test.ts'",
+    "test:run": "node $NODE_TEST_FLAGS --import tsx --experimental-test-coverage --test-coverage-include='src/**' --test-coverage-exclude='src/**/*.test.ts' --test-coverage-exclude='src/**/*.test.tsx' --test-coverage-lines=94 --test 'src/**/*.test.ts'",
     "test": "npm run test:typecheck && npm run test:run",
     "fix": "biome check --write src"
   },

package/src/auth.ts

@@ -41,6 +41,17 @@ const buildAuthAdapter = async (config: AuthConfig) => {
 	});
 };
 
+/**
+ * The header carrying the client address, set by the edge proxy from the
+ * connection it terminates (deploy/vps/caddy/routes.caddy). It is deliberately
+ * not `X-Forwarded-For`: that header arrives with an appended hop per proxy,
+ * which resolves to no single client and collapses rate limiting onto one
+ * shared bucket for everybody. Nothing else in the chain writes this name, and
+ * the edge replaces any value a client sends, so it is single-valued and
+ * trustworthy at the point better-auth reads it.
+ */
+export const CLIENT_IP_HEADER = "x-remit-client-ip";
+
 const intEnv = (name: string, fallback: number): number => {
 	const raw = process.env[name];
 	if (!raw) return fallback;
@@ -77,6 +88,12 @@ export const createAuth = async (
 			autoSignIn: true,
 			disableSignUp: !config.selfSignUpEnabled,
 		},
+		// Listing one header, and not better-auth's `x-forwarded-for` default,
+		// is what keeps the resolved address out of a caller's reach: an
+		// `X-Forwarded-For` a client sends is never read at all.
+		advanced: {
+			ipAddress: { ipAddressHeaders: [CLIENT_IP_HEADER] },
+		},
 		rateLimit: {
 			enabled: true,
 			window: intEnv("BETTER_AUTH_RATE_LIMIT_WINDOW", 60),

package/src/index.ts

@@ -1,5 +1,10 @@
 export { toNodeHandler } from "better-auth/node";
-export { type Auth, type AuthConfig, createAuth } from "./auth.js";
+export {
+	type Auth,
+	type AuthConfig,
+	CLIENT_IP_HEADER,
+	createAuth,
+} from "./auth.js";
 export {
 	AUTH_BASE_PATH,
 	AUTH_JWKS_PATH,

package/src/rate-limit.test.ts

@@ -0,0 +1,106 @@
+import assert from "node:assert/strict";
+import { mkdtempSync, rmSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
+import { after, before, describe, it } from "node:test";
+import type { Auth } from "./auth.js";
+import { CLIENT_IP_HEADER, createAuth } from "./auth.js";
+
+const SIGN_IN_MAX = 2;
+const MIGRATIONS = resolve(
+	import.meta.dirname,
+	"../../../deploy/vps/migrations-sqlite/auth",
+);
+
+const createDatabase = async (dir: string, name: string): Promise<string> => {
+	const path = join(dir, `${name}.db`);
+	const { default: Database } = await import("better-sqlite3");
+	const { drizzle } = await import("drizzle-orm/better-sqlite3");
+	const { migrate } = await import("drizzle-orm/better-sqlite3/migrator");
+	const sqlite = new Database(path);
+	migrate(drizzle(sqlite), { migrationsFolder: MIGRATIONS });
+	sqlite.close();
+	return path;
+};
+
+const signIn = (auth: Auth, headers: Record<string, string>) =>
+	auth.handler(
+		new Request("http://localhost:3000/api/auth/sign-in/email", {
+			method: "POST",
+			headers: { "content-type": "application/json", ...headers },
+			body: JSON.stringify({
+				email: "nobody@example.com",
+				password: "a-sufficiently-long-password",
+			}),
+		}),
+	);
+
+/**
+ * Spend one client's sign-in budget, returning the attempt number that was
+ * turned away. `null` means the budget never ran out.
+ */
+const exhaust = async (
+	auth: Auth,
+	headers: Record<string, string>,
+): Promise<number | null> => {
+	for (let attempt = 0; attempt <= SIGN_IN_MAX; attempt++) {
+		const response = await signIn(auth, headers);
+		if (response.status === 429) return attempt;
+	}
+	return null;
+};
+
+describe("sign-in rate limiting is per client", () => {
+	const previousMax = process.env.BETTER_AUTH_RATE_LIMIT_SIGN_IN_MAX;
+	let dir: string;
+
+	before(() => {
+		process.env.BETTER_AUTH_RATE_LIMIT_SIGN_IN_MAX = String(SIGN_IN_MAX);
+		dir = mkdtempSync(join(tmpdir(), "remit-rate-limit-"));
+	});
+
+	after(() => {
+		if (previousMax === undefined) {
+			delete process.env.BETTER_AUTH_RATE_LIMIT_SIGN_IN_MAX;
+		} else {
+			process.env.BETTER_AUTH_RATE_LIMIT_SIGN_IN_MAX = previousMax;
+		}
+		rmSync(dir, { recursive: true, force: true });
+	});
+
+	const build = async (name: string): Promise<Auth> =>
+		createAuth({
+			connectionString: await createDatabase(dir, name),
+			secret: "rate-limit-test-secret-value-32chars-min",
+			baseURL: "http://localhost:3000",
+			selfSignUpEnabled: true,
+		});
+
+	it("locks out only the client that spent the budget", async () => {
+		const auth = await build("per-client");
+
+		assert.equal(
+			await exhaust(auth, { [CLIENT_IP_HEADER]: "203.0.113.10" }),
+			SIGN_IN_MAX,
+		);
+
+		const other = await signIn(auth, { [CLIENT_IP_HEADER]: "198.51.100.20" });
+		assert.equal(other.status, 401);
+	});
+
+	it("ignores a forwarded address the client supplies itself", async () => {
+		const auth = await build("spoofed");
+		const client = { [CLIENT_IP_HEADER]: "203.0.113.30" };
+
+		assert.equal(
+			await exhaust(auth, { ...client, "x-forwarded-for": "203.0.113.31" }),
+			SIGN_IN_MAX,
+		);
+
+		const spoofed = await signIn(auth, {
+			...client,
+			"x-forwarded-for": "198.51.100.40",
+		});
+		assert.equal(spoofed.status, 429);
+	});
+});