connect.test.ts

12.5 KB · raw

1// Covers connect setup, validation, one-time redemption, rate limits, admin history, and secrecy.23import { Database } from "bun:sqlite";4import { afterAll, describe, expect, setSystemTime, test } from "bun:test";5import { mkdtemp } from "node:fs/promises";6import { tmpdir } from "node:os";7import { join } from "node:path";8import { createApp } from "../src/server/app.ts";9import { makeBackup } from "../src/server/backup.ts";10import { type Config, parseConfig } from "../src/server/config.ts";11import { openKeprDb } from "../src/server/db.ts";12import { Browser, PASSWORD } from "./browser.ts";1314const ORIGIN = "https://kepr.example";15const WRITE = { accessKeyId: "WRITE-ID", secretAccessKey: "WRITE-SECRET" };16// One argon2 hash for the whole file: every instance shares it, so the suite stays quick.17const HASH = await Bun.password.hash(PASSWORD, "argon2id");18let clock = Date.parse("2026-09-27T12:00:00Z");19setSystemTime(clock);20afterAll(() => setSystemTime());2122async function build(write = true, folder = false) {23	const dataDir = await mkdtemp(join(tmpdir(), "kepr-connect-"));24	const kepr = openKeprDb(dataDir);25	const bucket: Config["bucket"] = folder26		? { kind: "folder", path: dataDir }27		: {28				kind: "s3",29				endpoint: "https://s3.fr-par.scw.cloud",30				name: "my-bucket",31				region: "fr-par",32				accessKeyId: "read-id",33				secretAccessKey: "read-secret",34				...(write ? { write: WRITE } : {}),35			};36	const config: Config = {37		domain: "kepr.example",38		dataDir,39		adminPasswordHash: HASH,40		bucket,41	};42	return { app: createApp(config, kepr), kepr, config };43}4445async function connected(write = true) {46	const built = await build(write);47	const browser = new Browser(built.app, `198.51.100.${Math.floor(Math.random() * 200) + 1}`);48	await browser.signIn();49	return { ...built, browser };50}5152async function issue(browser: Browser, machine = "laptop") {53	await browser.get(`/connect?machine=${encodeURIComponent(machine)}`);54	const page = await browser.post("/connect", { machine });55	const body = await page.text();56	const match = /class="mono code">([^<]+)/.exec(body);57	const code = match?.[1]?.trim() ?? "";58	return { page, body, code };59}6061async function redeem(app: ReturnType<typeof createApp>, code: string, address = "203.0.113.77") {62	const browser = new Browser(app, address);63	return browser.post("/api/connect", { code });64}6566describe.serial("connect configuration and page", () => {67	test("parseConfig rejects write keys beside a folder bucket and empty write values", () => {68		const hash = "$argon2id$v=19$m=65536,t=2,p=1$abc$abc";69		expect(() =>70			parseConfig(71				`domain = "kepr.example"\nadmin_password_hash = "${hash}"\n[bucket]\nfolder = "/tmp/x"\n[bucket.write]\naccess_key_id = "x"\nsecret_access_key = "y"`,72			),73		).toThrow();74		expect(() =>75			parseConfig(76				`domain = "kepr.example"\nadmin_password_hash = "${hash}"\n[bucket]\nendpoint = "https://x"\nname = "n"\nregion = "r"\naccess_key_id = "a"\nsecret_access_key = "s"\n[bucket.write]\naccess_key_id = ""\nsecret_access_key = "y"`,77			),78		).toThrow();79	});8081	test("folder buckets and S3 buckets without write keys hide all connect routes", async () => {82		for (const built of [await build(false), await build(false, true)]) {83			const browser = new Browser(built.app);84			expect((await browser.get("/connect?machine=x")).status).toBe(404);85			expect((await browser.post("/connect", { machine: "x" })).status).toBe(404);86			expect((await browser.post("/api/connect", { code: "ABCDEFGH" })).status).toBe(404);87		}88	});8990	test("a disabled connect route is an unknown path, byte for byte", async () => {91		const { app } = await build(false);92		const browser = new Browser(app);93		for (const [method, path] of [94			["GET", "/connect?machine=x"],95			["POST", "/connect"],96			["POST", "/api/connect"],97		] as const) {98			const asked = method === "GET" ? browser.get(path) : browser.post(path, {});99			const unknown =100				method === "GET" ? browser.get("/nothing/here") : browser.post("/nothing/here", {});101			const [found, absent] = await Promise.all([asked, unknown]);102			expect(`${found.status} ${await found.text()}`).toBe(103				`${absent.status} ${await absent.text()}`,104			);105			expect(found.headers.get("cache-control")).toBe(absent.headers.get("cache-control"));106		}107	});108109	test("a signed-out request redirects before the machine name is judged", async () => {110		const { app } = await build();111		const browser = new Browser(app);112		const response = await browser.get(`/connect?machine=${encodeURIComponent("x".repeat(65))}`);113		expect(response.status).toBe(302);114		expect(response.headers.get("location")).toBe("/sign-in?next=%2Fconnect");115	});116117	test("connect redirects signed out, preserves next, and rejects unsafe next values", async () => {118		const built = await build();119		const browser = new Browser(built.app);120		const response = await browser.get("/connect?machine=desk%20%26%20rack");121		expect(response.status).toBe(302);122		for (const next of ["https://evil.example", "//evil.example", "/bad\n"]) {123			const sign = await browser.get(`/sign-in?next=${encodeURIComponent(next)}`);124			const html = await sign.text();125			expect(html).toContain('name="next" value="/admin"');126		}127		const sign = await browser.get("/sign-in?next=%2Fconnect%3Fmachine%3Ddesk");128		const form = /name="form" value="([^"]+)"/.exec(await sign.text())?.[1] ?? "";129		const wrong = await browser.request("/sign-in", {130			method: "POST",131			headers: { origin: ORIGIN },132			body: new URLSearchParams({ form, next: "/connect?machine=desk", password: "wrong" }),133		});134		expect(wrong.status).toBe(401);135		expect(await wrong.text()).toContain('name="next" value="/connect?machine=desk"');136		const good = await browser.request("/sign-in", {137			method: "POST",138			headers: { origin: ORIGIN },139			body: new URLSearchParams({ form, next: "/connect?machine=desk", password: PASSWORD }),140		});141		expect(good.status).toBe(303);142		expect(good.headers.get("location")).toBe("/connect?machine=desk");143	});144145	test("connect validates and escapes machine names, and never caches or exposes secrets", async () => {146		const { browser } = await connected();147		for (const machine of ["", "x".repeat(65), "bad\nname", "bad\u0085name"])148			expect((await browser.get(`/connect?machine=${encodeURIComponent(machine)}`)).status).toBe(149				400,150			);151		const result = await issue(browser, "<img src=x onerror=alert(1)>");152		expect(result.page.status).toBe(200);153		expect(result.body).toContain("&lt;img src=x onerror=alert(1)&gt;");154		expect(result.body).not.toContain("WRITE-SECRET");155		expect(result.page.headers.get("cache-control")).toBe("no-store");156	});157});158159describe.serial("connect redemption", () => {160	test("stores only a hash, redeems once with exact credentials, normalizes code, and gives identical failures", async () => {161		const { app, browser, kepr, config } = await connected();162		const { code, body } = await issue(browser, "office");163		expect(code).toMatch(/^[A-Z2-9]{4}-[A-Z2-9]{4}$/);164		expect(body).not.toContain("WRITE-SECRET");165		const row = kepr.query("SELECT code_hash, machine FROM connect_codes").get() as {166			code_hash: string;167			machine: string;168		};169		expect(row.code_hash).toMatch(/^[0-9a-f]{64}$/);170		expect(row.code_hash).not.toContain(code.replace("-", ""));171		expect(row.machine).toBe("office");172		const success = await redeem(app, code.toLowerCase(), "203.0.113.88");173		expect(success.status).toBe(200);174		expect(await success.json()).toEqual({175			endpoint: config.bucket.kind === "s3" ? config.bucket.endpoint : "",176			bucket: "my-bucket",177			region: "fr-par",178			access_key_id: "WRITE-ID",179			secret_access_key: "WRITE-SECRET",180		});181		expect(success.headers.get("cache-control")).toBe("no-store");182		const used = await redeem(app, code, "203.0.113.89");183		const unknown = await redeem(app, "ZZZZ-ZZZZ", "203.0.113.90");184		expect(used.status).toBe(404);185		expect(await used.text()).toBe(await unknown.text());186		expect(used.headers.get("cache-control")).toBe("no-store");187	});188189	test("connect POST requires session, origin and fresh form token", async () => {190		const built = await build();191		const browser = new Browser(built.app);192		expect((await browser.post("/connect", { machine: "x" })).status).toBe(401);193		await browser.signIn();194		expect((await browser.post("/connect", { machine: "x" }, "https://evil.example")).status).toBe(195			403,196		);197		expect((await browser.post("/connect", { machine: "x", form: "stale" })).status).toBe(403);198	});199200	test("expired, malformed and missing codes all return the same no-code response", async () => {201		const { app, browser } = await connected();202		const { code } = await issue(browser);203		clock += 601_000;204		setSystemTime(clock);205		const expired = await redeem(app, code, "198.51.100.201");206		const malformed = await redeem(app, "bad", "198.51.100.202");207		const missing = await new Browser(app, "198.51.100.203").request("/api/connect", {208			method: "POST",209			body: "not-a-form",210		});211		expect(expired.status).toBe(404);212		const expected = await expired.text();213		expect(expected).toBe('{"error":"no_code","message":"no code"}');214		expect(await malformed.text()).toBe(expected);215		expect(await missing.text()).toBe(expected);216	});217218	test("rate limits ten attempts per peer while another peer succeeds", async () => {219		const { app, browser } = await connected();220		const { code } = await issue(browser);221		for (let i = 0; i < 10; i++) await redeem(app, "bad", "192.0.2.40");222		const limited = await redeem(app, code, "192.0.2.40");223		expect(limited.status).toBe(404);224		const other = await redeem(app, code, "192.0.2.41");225		expect(other.status).toBe(200);226		// The window is an hour: once it has passed the same peer is served again.227		clock += 3_601_000;228		setSystemTime(clock);229		const { code: fresh } = await issue(browser, "later");230		expect((await redeem(app, fresh, "192.0.2.40")).status).toBe(200);231	});232233	test("a forged X-Forwarded-For does not buy another bucketful", async () => {234		const { app, browser } = await connected();235		const { code } = await issue(browser);236		for (let i = 0; i < 10; i++) await redeem(app, "bad", "192.0.2.50");237		const forged = await new Browser(app, "192.0.2.50").request("/api/connect", {238			method: "POST",239			headers: {240				"x-forwarded-for": "198.51.100.99",241				"content-type": "application/x-www-form-urlencoded",242			},243			body: new URLSearchParams({ code }),244		});245		expect(forged.status).toBe(404);246	});247248	test("two redemptions at once: exactly one wins", async () => {249		const { app, browser } = await connected();250		const { code } = await issue(browser, "race");251		const [first, second] = await Promise.all([252			redeem(app, code, "203.0.113.101"),253			redeem(app, code, "203.0.113.102"),254		]);255		expect([first.status, second.status].sort()).toEqual([200, 404]);256	});257258	test("an oversized redemption is refused with the same no-code body", async () => {259		const { app } = await connected();260		const response = await new Browser(app, "192.0.2.60").post("/api/connect", {261			code: "x".repeat(70_000),262		});263		expect(response.status).toBe(404);264		expect(await response.text()).toBe('{"error":"no_code","message":"no code"}');265		expect(response.headers.get("cache-control")).toBe("no-store");266	});267268	test("a backup carries the hashed code and never the write key", async () => {269		const { browser, kepr, config } = await connected();270		const { code } = await issue(browser, "laptop");271		const name = makeBackup(kepr, config.dataDir);272		const file = join(config.dataDir, "backups", name, "kepr.db");273		const copy = new Database(file, { readonly: true });274		const rows = copy.query("SELECT machine, code_hash FROM connect_codes").all();275		copy.close();276		expect(rows.length).toBe(1);277		expect(JSON.stringify(rows)).not.toContain(code.replace("-", ""));278		// The write key is read from kepr.toml alone, so no copy of kepr.db can hold it.279		const bytes = await Bun.file(file).bytes();280		expect(new TextDecoder().decode(bytes)).not.toContain("WRITE-SECRET");281	});282});283284describe.serial("connected machines in admin", () => {285	test("lists redeemed machines newest first, at most twenty, with revocation guidance", async () => {286		const { app, browser } = await connected();287		for (let i = 0; i < 22; i++) {288			const { code } = await issue(browser, `machine-${i}`);289			const response = await redeem(app, code, `10.0.0.${i + 1}`);290			expect(response.status).toBe(200);291			clock += 1000;292			setSystemTime(clock);293		}294		const admin = await browser.get("/admin");295		const html = await admin.text();296		expect(html).toContain("Machines connected");297		expect(html).toContain("rotate the write key in Scaleway");298		expect(html).not.toContain("machine-0 ");299		expect(html).toContain("machine-21");300		expect(html.indexOf("machine-21")).toBeLessThan(html.indexOf("machine-20"));301	});302});