@fedify/fedify 2.4.0-dev.2084 → 2.4.0-dev.2099

package/dist/federation/portable-inbox.test.mjs

@@ -8,14 +8,15 @@ import { t as assertFalse } from "../assert_false-CPdRnc3E.mjs";
 import { t as assertThrows } from "../assert_throws-BYITOvPO.mjs";
 import "../std__assert-DvMDRPes.mjs";
 import { t as assert } from "../assert-D1Eafmd_.mjs";
-import { p as signJsonLd } from "../ld-BmFz5NLA.mjs";
-import { r as signObject } from "../proof-ozG4HfcQ.mjs";
-import { s as signRequest, u as verifyRequestDetailed } from "../http-B0VRNipE.mjs";
+import { p as signJsonLd } from "../ld-B00wWHzc.mjs";
+import { i as signObject } from "../proof-ChjBwnep.mjs";
+import { f as verifyRequestDetailed, l as signRequest } from "../http-DsgawTd8.mjs";
 import { a as rsaPrivateKey3, c as rsaPublicKey3, i as rsaPrivateKey2, n as ed25519PrivateKey, r as ed25519PublicKey, s as rsaPublicKey2 } from "../keys-DIJNHW-Y.mjs";
-import { c as forwardPortableInboxActivity, l as resolvePortableInboxForwardingOptions, o as createFederation } from "../middleware-BKeQYPm0.mjs";
-import { Create, Follow, Note, Person, Tombstone } from "@fedify/vocab";
+import { _ as coversDelivery, o as createFederation, v as forwardPortableInboxActivity, y as resolvePortableInboxForwardingOptions } from "../middleware-Br1_d-Ga.mjs";
+import { Create, CryptographicKey, Follow, Note, Person, Tombstone } from "@fedify/vocab";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 import { exportDidKey, formatIri, parseIri } from "@fedify/vocab-runtime";
+import { encodeBase64 } from "byte-encodings/base64";
 //#region src/federation/portable-inbox.test.ts
 const did = await exportDidKey(ed25519PublicKey.publicKey);
 const keyId = new URL(`${did}#${did.substring(8)}`);
@@ -522,6 +523,118 @@ test("forwardPortableInboxActivity() does not wait for slow gateways", async ()
 		esm_default.hardReset();
 	}
 });
+function compatibleAlice(path = "/users/alice", { authority = did, origin = LOCAL, gateways = [
+	LOCAL,
+	GATEWAY2,
+	GATEWAY3
+] } = {}) {
+	return {
+		id: new URL(`${origin}/.well-known/apgateway/${authority}${path}`),
+		inbox: new URL(inboxUrl(authority, `${path}/inbox`, origin)),
+		gateways: gateways.map((g) => new URL(g))
+	};
+}
+test("Federation.fetch() delivers to portable inboxes of compatible-ID actors", async (t) => {
+	const apAlice = parseIri(`ap+ef61://${did}/users/alice`);
+	const apInbox = parseIri(`ap+ef61://${did}/users/alice/inbox`);
+	const cases = [
+		[
+			"compatible actor and inbox",
+			compatibleAlice(),
+			""
+		],
+		[
+			"on another gateway",
+			compatibleAlice(void 0, { origin: GATEWAY2 }),
+			""
+		],
+		[
+			"compatible actor and ap: inbox",
+			{
+				...compatibleAlice(),
+				inbox: apInbox
+			},
+			""
+		],
+		[
+			"ap: actor and compatible inbox",
+			{
+				...compatibleAlice(),
+				id: apAlice
+			},
+			""
+		],
+		[
+			"compatible inbox with a query",
+			{
+				...compatibleAlice(),
+				inbox: new URL(inboxUrl() + "?page=1")
+			},
+			"?page=1"
+		]
+	];
+	for (const [name, alice, query] of cases) await t.step(name, async () => {
+		const queue = new RecordingQueue();
+		const { federation, received } = setup({
+			queue,
+			actor: (_ctx, identifier) => identifier === "alice" ? new Person(alice) : null
+		});
+		assertEquals((await federation.fetch(post(inboxUrl(), await signedFollow()), { contextData: void 0 })).status, 202);
+		assertEquals(received.length, 1);
+		assertEquals(received[0].recipient, "alice");
+		assertEquals(queue.outbox.map((m) => m.inbox).sort(), [inboxUrl(did, "/users/alice/inbox", GATEWAY3) + query, inboxUrl(did, "/users/alice/inbox", GATEWAY2) + query]);
+	});
+	const json = await signedFollow();
+	const rejections = [
+		["DID mismatch", new Person(compatibleAlice(void 0, { authority: otherDid }))],
+		["inbox mismatch", new Person({
+			...compatibleAlice(),
+			inbox: new URL(inboxUrl(did, "/users/alice/other-inbox"))
+		})],
+		["this server is not a gateway of the actor", new Person(compatibleAlice(void 0, { gateways: [GATEWAY2] }))],
+		["malformed actor ID", new Person({
+			...compatibleAlice(),
+			id: new URL(compatibleAlice().id.href + "?@gateway=https%3A%2F%2Fexample.com")
+		})],
+		["malformed inbox ID", new Person({
+			...compatibleAlice(),
+			inbox: new URL(inboxUrl() + "?@gateway=https%3A%2F%2Fexample.com")
+		})]
+	];
+	for (const [name, actor] of rejections) await t.step(name, async () => {
+		const { federation, received } = setup({ actor: (_ctx, identifier) => identifier === "alice" ? actor : null });
+		assertEquals((await federation.fetch(post(inboxUrl(), json), { contextData: void 0 })).status, 404);
+		assertEquals(received.length, 0);
+	});
+});
+test("forwardPortableInboxActivity() deduplicates compatible activity IDs", async () => {
+	const kv = new MemoryKvStore();
+	const queue = new RecordingQueue();
+	const forward = (activityId) => forwardPortableInboxActivity({
+		recipient: {
+			actorId: compatibleAlice().id,
+			inboxId: parseIri(`ap+ef61://${did}/users/alice/inbox`),
+			canonicalInboxId: `ap+ef61://${did}/users/alice/inbox`,
+			gateways: [new URL(LOCAL), new URL(GATEWAY2)]
+		},
+		activity: { id: activityId.href },
+		activityId,
+		activityType: "https://www.w3.org/ns/activitystreams#Follow",
+		excludedOrigins: [LOCAL],
+		baseUrl: LOCAL,
+		kv,
+		kvPrefix: ["_fedify", "portableInboxForwarding"],
+		outboxQueue: queue
+	});
+	const path = `${did}/follows/compatible`;
+	assertEquals((await forward(new URL(`${LOCAL}/.well-known/apgateway/${path}`))).length, 1);
+	for (const id of [
+		new URL(`${GATEWAY2}/.well-known/apgateway/${path}`),
+		new URL(`${LOCAL}/.well-known/apgateway/${path}?x=1`),
+		parseIri(`ap://${path}`)
+	]) assertEquals(await forward(id), [], id.href);
+	assertEquals(queue.outbox.length, 1);
+});
 const aliceId = parseIri(`ap+ef61://${did}/users/alice`);
 const rsaGatewayKeyPair = await crypto.subtle.generateKey({
 	name: "RSASSA-PKCS1-v1_5",
@@ -547,12 +660,12 @@ function signatureKeyId(headers) {
 * at {@link LOCAL} does: signed by her DID, and embedding the gateway keys in
 * its `assertionMethod`.
 */
-async function createGatewayLoader(keyPairs) {
+async function createGatewayLoader(keyPairs, origin = LOCAL) {
 	const { federation } = setup({
 		aliceKeyPairs: keyPairs,
 		mapPortableActorId: mapAlice
 	});
-	const keys = await federation.createContext(new URL(LOCAL)).getActorKeyPairs("alice");
+	const keys = await federation.createContext(new URL(origin)).getActorKeyPairs("alice");
 	const document = await (await signObject(new Person({
 		id: aliceId,
 		inbox: parseIri(`${aliceId.href}/inbox`),
@@ -564,7 +677,7 @@ async function createGatewayLoader(keyPairs) {
 		assertionMethods: keys.map((k) => k.multikey)
 	}), ed25519PrivateKey, keyId, { contextLoader: mockDocumentLoader })).toJsonLd({ contextLoader: mockDocumentLoader });
 	return (url) => {
-		if (url.replace(/#.*$/, "") !== compatibleAliceId()) return mockDocumentLoader(url);
+		if (url.replace(/#.*$/, "") !== compatibleAliceId(origin)) return mockDocumentLoader(url);
 		return Promise.resolve({
 			contextUrl: null,
 			documentUrl: url,
@@ -807,14 +920,240 @@ test("A Fedify gateway accepts signed forwarded portable inbox deliveries", asyn
 	}
 	await assertSignedBy(forwarded, `${compatibleAliceId()}#main-key`, await createGatewayLoader([rsaGatewayKeyPair]));
 	const queue = new RecordingQueue();
+	const loader = await createGatewayLoader([rsaGatewayKeyPair]);
 	const { federation, received } = setup({
 		queue,
-		options: { origin: GATEWAY2 }
+		options: {
+			origin: GATEWAY2,
+			documentLoaderFactory: () => loader
+		}
 	});
 	assertEquals((await federation.fetch(toRequest(forwarded), { contextData: void 0 })).status, 202);
 	assertEquals(received.length, 1);
 	assertEquals(received[0].recipient, "alice");
-	assertEquals(queue.outbox.map((m) => m.inbox).sort(), [inboxUrl(did, "/users/alice/inbox", LOCAL), inboxUrl(did, "/users/alice/inbox", GATEWAY3)]);
+	assertEquals(queue.outbox.map((m) => m.inbox), [inboxUrl(did, "/users/alice/inbox", GATEWAY3)]);
+});
+/** Records the URLs that a document loader is asked for. */
+function recordLoader(loader) {
+	const urls = [];
+	return {
+		urls,
+		loader: (url, options) => {
+			urls.push(url);
+			return loader(url, options);
+		}
+	};
+}
+const gateway2KeyId = new URL(`${compatibleAliceId(GATEWAY2)}#main-key`);
+/** Signs a delivery to Alice's inbox on {@link LOCAL}. */
+async function signDelivery(body, { keyId = gateway2KeyId, privateKey = rsaGatewayKeyPair.privateKey, spec = "draft-cavage-http-signatures-12", components, label, headers } = {}) {
+	const signed = await signRequest(post(inboxUrl(), body, headers), privateKey, keyId, {
+		spec,
+		...components == null ? {} : { body: null },
+		rfc9421: {
+			label,
+			components: components?.map((value) => ({
+				value,
+				params: {}
+			}))
+		}
+	});
+	return new Request(signed.url, {
+		method: "POST",
+		headers: signed.headers,
+		body: JSON.stringify(body)
+	});
+}
+async function deliverToGateway(request, { loader, kv, maxTargets }) {
+	const queue = new RecordingQueue();
+	const { federation, received, kv: store } = setup({
+		queue,
+		kv,
+		options: {
+			documentLoaderFactory: () => loader,
+			...maxTargets == null ? {} : { portableInboxForwarding: { maxTargets } }
+		}
+	});
+	const response = await federation.fetch(request, { contextData: void 0 });
+	assert(received.length <= 1);
+	return {
+		response,
+		queue,
+		kv: store
+	};
+}
+function forwardedGateways(queue) {
+	return queue.outbox.map((m) => new URL(m.inbox).origin).sort();
+}
+test("Federation.fetch() does not forward portable inbox deliveries back to the gateway that forwarded them", async (t) => {
+	const gatewayLoader = await createGatewayLoader([rsaGatewayKeyPair], GATEWAY2);
+	for (const spec of ["draft-cavage-http-signatures-12", "rfc9421"]) await t.step(spec, async () => {
+		const { loader, urls } = recordLoader(gatewayLoader);
+		const json = await signedFollow();
+		const { response, queue, kv } = await deliverToGateway(await signDelivery(json, { spec }), { loader });
+		assertEquals(response.status, 202);
+		assertEquals(forwardedGateways(queue), [GATEWAY3]);
+		assertEquals(urls.filter((u) => u.startsWith(GATEWAY2)), [gateway2KeyId.href]);
+		const { queue: queue2 } = await deliverToGateway(post(inboxUrl(), json), {
+			loader,
+			kv
+		});
+		assertEquals(queue2.outbox, []);
+	});
+	await t.step("identified before the targets are capped", async () => {
+		const { queue } = await deliverToGateway(await signDelivery(await signedFollow()), {
+			loader: gatewayLoader,
+			maxTargets: 1
+		});
+		assertEquals(forwardedGateways(queue), [GATEWAY3]);
+	});
+	await t.step("with an unrelated signature first", async () => {
+		const { loader, urls } = recordLoader(gatewayLoader);
+		const json = await signedFollow();
+		const unrelated = await signDelivery(json, {
+			spec: "rfc9421",
+			keyId: new URL("https://unrelated.example/key"),
+			privateKey: rsaPrivateKey3,
+			label: "sig1"
+		});
+		const gateway = await signDelivery(json, {
+			spec: "rfc9421",
+			label: "sig2"
+		});
+		const headers = new Headers(gateway.headers);
+		for (const name of ["Signature-Input", "Signature"]) headers.set(name, `${unrelated.headers.get(name)}, ${gateway.headers.get(name)}`);
+		const { queue } = await deliverToGateway(new Request(gateway.url, {
+			method: "POST",
+			headers,
+			body: JSON.stringify(json)
+		}), { loader });
+		assertEquals(forwardedGateways(queue), [GATEWAY3]);
+		assertFalse(urls.some((u) => u.startsWith("https://unrelated.example/")));
+	});
+	await t.step("activity authenticated by a Linked Data Signature", async () => {
+		const { queue } = await deliverToGateway(await signDelivery(await signJsonLd({
+			"@context": "https://www.w3.org/ns/activitystreams",
+			id: `https://example.com/follows/lds-${++activityCounter}`,
+			type: "Follow",
+			actor: "https://example.com/person2",
+			object: formatIri(aliceId)
+		}, rsaPrivateKey3, rsaPublicKey3.id, { contextLoader: mockDocumentLoader })), { loader: gatewayLoader });
+		assertEquals(forwardedGateways(queue), [GATEWAY3]);
+	});
+});
+test("Federation.fetch() forwards portable inbox deliveries whose sending gateway is not identified", async (t) => {
+	const gatewayLoader = await createGatewayLoader([rsaGatewayKeyPair], GATEWAY2);
+	const bobKeyId = new URL(`${GATEWAY2}/.well-known/apgateway/${did}/users/bob#main-key`);
+	const compatibleId = new URL(compatibleAliceId(GATEWAY2));
+	const unsignedActor = await new Person({
+		id: compatibleId,
+		inbox: new URL(`${compatibleId.href}/inbox`),
+		publicKey: rsaPublicKey2.clone({
+			id: gateway2KeyId,
+			owner: compatibleId
+		})
+	}).toJsonLd({ contextLoader: mockDocumentLoader });
+	const unsignedLoader = (url) => {
+		if (url.replace(/#.*$/, "") !== compatibleId.href) return mockDocumentLoader(url);
+		return Promise.resolve({
+			contextUrl: null,
+			documentUrl: url,
+			document: structuredClone(unsignedActor)
+		});
+	};
+	const json = await signedFollow();
+	const contentDigest = `sha-256=:${encodeBase64(await crypto.subtle.digest("SHA-256", new TextEncoder().encode(JSON.stringify(json))))}:`;
+	const cases = [
+		{
+			name: "unsigned",
+			unsigned: true,
+			fetches: false
+		},
+		{
+			name: "invalid signature",
+			sign: { privateKey: rsaPrivateKey2 },
+			fetches: true
+		},
+		{
+			name: "unknown key",
+			loader: mockDocumentLoader,
+			fetches: true
+		},
+		{
+			name: "gateway not in gateways",
+			sign: { keyId: new URL(`https://unlisted.example/.well-known/apgateway/${did}/users/alice#main-key`) },
+			fetches: false
+		},
+		{
+			name: "key of another actor",
+			sign: { keyId: bobKeyId },
+			fetches: false
+		},
+		{
+			name: "content-digest not covered",
+			sign: {
+				spec: "rfc9421",
+				components: ["@method", "@target-uri"]
+			},
+			fetches: false
+		},
+		{
+			name: "target URI not covered",
+			sign: {
+				spec: "rfc9421",
+				components: [
+					"@method",
+					"@authority",
+					"@path",
+					"content-digest"
+				],
+				headers: { "Content-Digest": contentDigest }
+			},
+			fetches: false
+		},
+		{
+			name: "non-canonical spelling of content-digest",
+			sign: {
+				spec: "rfc9421",
+				components: [
+					"@method",
+					"@target-uri",
+					"Content-Digest"
+				],
+				headers: { "Content-Digest": "sha-256=:AAAA:" }
+			},
+			fetches: false
+		},
+		{
+			name: "key not vouched for by the DID",
+			sign: { privateKey: rsaPrivateKey2 },
+			loader: unsignedLoader,
+			fetches: true
+		}
+	];
+	for (const { name, sign, unsigned, loader, fetches } of cases) await t.step(name, async () => {
+		const recorded = recordLoader(loader ?? gatewayLoader);
+		const { response, queue } = await deliverToGateway(unsigned ? post(inboxUrl(), json) : await signDelivery(json, sign), { loader: recorded.loader });
+		assertEquals(response.status, 202);
+		assertEquals(forwardedGateways(queue), [GATEWAY3, GATEWAY2].sort());
+		assertEquals(recorded.urls.some((u) => u.includes("/.well-known/apgateway/")), fetches);
+	});
+	await t.step("already forwarded to the gateway", async () => {
+		const recorded = recordLoader(gatewayLoader);
+		const kv = new MemoryKvStore();
+		const json = await signedFollow();
+		const { queue } = await deliverToGateway(post(inboxUrl(), json), {
+			loader: recorded.loader,
+			kv
+		});
+		assertEquals(forwardedGateways(queue), [GATEWAY3, GATEWAY2].sort());
+		const { queue: queue2 } = await deliverToGateway(await signDelivery(json), {
+			loader: recorded.loader,
+			kv
+		});
+		assertEquals(queue2.outbox, []);
+		assertEquals(recorded.urls.filter((u) => u.startsWith(GATEWAY2)), []);
+	});
 });
 function forwardingParameters(overrides = {}) {
 	const activityId = parseIri(`ap+ef61://${did}/follows/${++activityCounter}`);
@@ -915,6 +1254,144 @@ test("forwardPortableInboxActivity() does not wait for slow keys", async () => {
 		esm_default.hardReset();
 	}
 });
+function gatewaySignature(keyId, verify) {
+	return {
+		keyId,
+		coversDelivery: true,
+		verify
+	};
+}
+function gatewayKeyOf(keyId, owner = aliceId) {
+	return new CryptographicKey({
+		id: keyId,
+		owner,
+		publicKey: rsaGatewayKeyPair.publicKey
+	});
+}
+test("forwardPortableInboxActivity() skips the gateway that forwarded the activity", async (t) => {
+	const recipient = {
+		actorId: parseIri(`ap://${did}/users/alice`),
+		inboxId: parseIri(`ap+ef61://${did}/users/alice/inbox`),
+		canonicalInboxId: `ap://${did}/users/alice/inbox`,
+		gateways: [
+			new URL(LOCAL),
+			new URL(GATEWAY3),
+			new URL(GATEWAY2)
+		]
+	};
+	const owners = [["identified", aliceId], ["identified by a key of a compatible identifier", new URL(compatibleAliceId())]];
+	for (const [name, owner] of owners) await t.step(name, async () => {
+		const queue = new RecordingQueue();
+		assertEquals((await forwardPortableInboxActivity(forwardingParameters({
+			recipient,
+			outboxQueue: queue,
+			signatures: [gatewaySignature(gateway2KeyId, () => Promise.resolve(gatewayKeyOf(gateway2KeyId, owner)))]
+		}))).map((u) => u.origin), [GATEWAY3]);
+	});
+	const notIdentified = [
+		["verify() rejects", [gatewaySignature(gateway2KeyId, () => Promise.reject(/* @__PURE__ */ new Error("Failed.")))]],
+		["verify() throws", [gatewaySignature(gateway2KeyId, () => {
+			throw new Error("Failed.");
+		})]],
+		["not verified", [gatewaySignature(gateway2KeyId, () => Promise.resolve(null))]],
+		["the key is not owned by a portable actor", [gatewaySignature(gateway2KeyId, () => Promise.resolve(gatewayKeyOf(gateway2KeyId, new URL(`${GATEWAY2}/users/alice`))))]],
+		["the key is owned by another actor", [gatewaySignature(gateway2KeyId, () => Promise.resolve(gatewayKeyOf(gateway2KeyId, parseIri(`ap://${did}/users/bob`))))]],
+		["another key is verified", [gatewaySignature(gateway2KeyId, () => Promise.resolve(gatewayKeyOf(new URL(`${compatibleAliceId(GATEWAY3)}#main-key`))))]],
+		["the signature does not cover the delivery", [{
+			...gatewaySignature(gateway2KeyId, () => Promise.resolve(gatewayKeyOf(gateway2KeyId))),
+			coversDelivery: false
+		}]]
+	];
+	for (const [name, signatures] of notIdentified) await t.step(name, async () => {
+		const queue = new RecordingQueue();
+		assertEquals((await forwardPortableInboxActivity(forwardingParameters({
+			recipient,
+			outboxQueue: queue,
+			signatures
+		}))).map((u) => u.origin), [GATEWAY3, GATEWAY2]);
+	});
+	await t.step("verified only if it may save a request", async (t) => {
+		const cases = [
+			["forwarding is turned off", { options: resolvePortableInboxForwardingOptions({ maxTargets: 0 }) }],
+			["no compare-and-swap", { kv: {
+				...new MemoryKvStore(),
+				cas: void 0
+			} }],
+			["this server", { excludedOrigins: [LOCAL, GATEWAY2] }]
+		];
+		for (const [name, overrides] of cases) await t.step(name, async () => {
+			let calls = 0;
+			await forwardPortableInboxActivity(forwardingParameters({
+				recipient,
+				outboxQueue: new RecordingQueue(),
+				signatures: [gatewaySignature(gateway2KeyId, () => {
+					calls++;
+					return Promise.resolve(gatewayKeyOf(gateway2KeyId));
+				})],
+				...overrides
+			}));
+			assertEquals(calls, 0);
+		});
+	});
+	await t.step("verification does not finish in time", async () => {
+		let release = () => {};
+		const pending = new Promise((resolve) => release = resolve);
+		const kv = new MemoryKvStore();
+		const parameters = forwardingParameters({
+			recipient,
+			kv,
+			outboxQueue: new RecordingQueue(),
+			options: resolvePortableInboxForwardingOptions({
+				maxTargets: 1,
+				deadline: { milliseconds: 10 }
+			}),
+			signatures: [gatewaySignature(gateway2KeyId, () => pending)]
+		});
+		const started = performance.now();
+		const forwarded = await forwardPortableInboxActivity(parameters);
+		assert(performance.now() - started < 5e3);
+		assertEquals(forwarded.map((u) => u.origin), [GATEWAY3]);
+		release(gatewayKeyOf(gateway2KeyId));
+		await new Promise((resolve) => setTimeout(resolve, 20));
+		const claimed = [];
+		for await (const { key } of kv.list(parameters.kvPrefix)) claimed.push(String(key.at(-1)));
+		assertEquals(claimed, [GATEWAY3]);
+	});
+});
+test("coversDelivery()", () => {
+	const signature = (label, ...names) => ({
+		keyId: gateway2KeyId,
+		label,
+		components: names.map((value) => ({
+			value,
+			params: {}
+		}))
+	});
+	assert(coversDelivery(signature("sig1", "@method", "@target-uri", "@authority", "content-digest")));
+	assert(coversDelivery(signature(null, "(request-target)", "host", "date", "digest")));
+	assertFalse(coversDelivery(signature("sig1", "@method", "@target-uri")));
+	assertFalse(coversDelivery(signature("sig1", "@method", "@target-uri", "Content-Digest")));
+	assertFalse(coversDelivery(signature("sig1", "@method", "@authority", "@path", "content-digest")));
+	assertFalse(coversDelivery(signature(null, "(request-target)", "digest")));
+	assertFalse(coversDelivery({
+		keyId: gateway2KeyId,
+		label: "sig1",
+		components: [
+			{
+				value: "@method",
+				params: {}
+			},
+			{
+				value: "@target-uri",
+				params: {}
+			},
+			{
+				value: "content-digest",
+				params: { req: true }
+			}
+		]
+	}));
+});
 test("Context.getPortableInboxUri()", async (t) => {
 	const { federation } = setup();
 	await t.step("Context", () => {