feat(federation): signed /api/federation/epoch endpoint + caller

This commit is contained in:
Jannis Braun
2026-07-01 21:43:02 +02:00
parent 538519fcd2
commit bf74aa8bb2
5 changed files with 360 additions and 1 deletions
@@ -1,10 +1,15 @@
import { describe, it, expect, beforeEach, vi } from 'vitest';
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
import Fastify, { type FastifyInstance } from 'fastify';
import Database from 'better-sqlite3';
import { drizzle } from 'drizzle-orm/better-sqlite3';
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
import * as schema from '../db/schema.js';
import { setWorkerId } from './snowflake.js';
import { buildFederationHeaders, verifySignature } from './federationAuth.js';
setWorkerId(1);
const __dirname = path.dirname(fileURLToPath(import.meta.url));
let sqlite: Database.Database;
@@ -16,6 +21,33 @@ vi.mock('../db/index.js', () => ({
schema,
}));
vi.mock('../utils/auth.js', () => ({
authenticate: async (req: { userId?: string }) => {
req.userId = 'admin-user';
},
requireAdmin: async () => {
// epoch endpoint is HMAC-authenticated, not JWT
},
}));
vi.mock('../ws/handler.js', () => ({
connectionManager: {
sendToAdmins: vi.fn(),
getAllOnlineUserIds: () => [],
sendToUser: vi.fn(),
sendToDmMembers: vi.fn(),
},
}));
vi.mock('../utils/federationPeerActivation.js', () => ({
onPeerActivated: vi.fn(async () => undefined),
onPeerDeactivated: vi.fn(async () => undefined),
}));
const LOCAL_EPOCH = 'local-epoch-abcd';
const PEER_ORIGIN = 'https://remote.example';
const PEER_SECRET = 'peer-shared-secret-0123456789abcdef';
function applyMigrations(db: Database.Database): void {
const dir = path.resolve(__dirname, '../../drizzle');
for (const f of fs.readdirSync(dir).filter(f => f.endsWith('.sql')).sort()) {
@@ -82,3 +114,209 @@ describe('getInstanceId', () => {
expect(() => getInstanceId()).toThrow(/instance_id is not set/);
});
});
function seedInstanceSettings(instanceId: string): void {
testDb.insert(schema.instanceSettings).values({
id: 1,
instanceName: 'Local Backspace',
instanceId,
autoAcceptPeering: 1,
registrationOpen: 1,
updatedAt: Date.now(),
} as typeof schema.instanceSettings.$inferInsert).run();
}
function seedActivePeer(): void {
testDb.insert(schema.federationPeers).values({
id: 'peer-remote',
origin: PEER_ORIGIN,
hmacSecret: PEER_SECRET,
status: 'active',
createdAt: Date.now(),
}).run();
}
async function buildApp(): Promise<FastifyInstance> {
const app = Fastify({ logger: false });
const { federationRoutes } = await import('../routes/federation.js');
await app.register(federationRoutes);
await app.ready();
return app;
}
describe('POST /api/federation/epoch — signed request + signed response', () => {
// The module-level beforeEach already created a fresh in-memory DB and reset
// the instance-id cache; here we only seed rows and build the app.
let app: FastifyInstance;
beforeEach(async () => {
seedInstanceSettings(LOCAL_EPOCH);
seedActivePeer();
app = await buildApp();
});
afterEach(async () => {
await app.close();
vi.restoreAllMocks();
});
it('returns 200 with a signed { instanceId } for a validly-signed request', async () => {
const body = JSON.stringify({});
const headers = buildFederationHeaders(body, PEER_SECRET, PEER_ORIGIN);
const response = await app.inject({
method: 'POST',
url: '/api/federation/epoch',
headers,
payload: body,
});
expect(response.statusCode).toBe(200);
const parsed = response.json() as { instanceId?: string };
expect(parsed.instanceId).toBe(LOCAL_EPOCH);
// The response body must be HMAC-signed with the peer's shared secret.
const sigHeader = response.headers['x-federation-signature'] as string | undefined;
const tsHeader = response.headers['x-federation-timestamp'] as string | undefined;
const nonceHeader = response.headers['x-federation-nonce'] as string | undefined;
expect(sigHeader).toMatch(/^sha256=/);
expect(tsHeader).toBeTruthy();
expect(nonceHeader).toBeTruthy();
const sig = (sigHeader ?? '').replace(/^sha256=/, '');
const ts = Number(tsHeader);
const ok = verifySignature(response.body, sig, PEER_SECRET, ts, nonceHeader ?? null);
expect(ok).toBe(true);
});
it('returns 400 when federation headers are missing', async () => {
const response = await app.inject({
method: 'POST',
url: '/api/federation/epoch',
payload: JSON.stringify({}),
headers: { 'content-type': 'application/json' },
});
expect(response.statusCode).toBe(400);
});
it('returns 401 when the request is signed with the wrong secret', async () => {
const body = JSON.stringify({});
const headers = buildFederationHeaders(body, 'the-wrong-secret', PEER_ORIGIN);
const response = await app.inject({
method: 'POST',
url: '/api/federation/epoch',
headers,
payload: body,
});
expect(response.statusCode).toBe(401);
});
it('returns 403 for an origin that is not a known peer', async () => {
const body = JSON.stringify({});
const headers = buildFederationHeaders(body, PEER_SECRET, 'https://stranger.example');
const response = await app.inject({
method: 'POST',
url: '/api/federation/epoch',
headers,
payload: body,
});
expect(response.statusCode).toBe(403);
});
it('returns 403 for a revoked peer', async () => {
testDb.insert(schema.federationPeers).values({
id: 'peer-revoked',
origin: 'https://revoked.example',
hmacSecret: 'revoked-secret',
status: 'revoked',
createdAt: Date.now(),
}).run();
const body = JSON.stringify({});
const headers = buildFederationHeaders(body, 'revoked-secret', 'https://revoked.example');
const response = await app.inject({
method: 'POST',
url: '/api/federation/epoch',
headers,
payload: body,
});
expect(response.statusCode).toBe(403);
});
});
describe('fetchPeerEpoch — signs request, verifies signed response, fails safe', () => {
afterEach(() => {
vi.unstubAllGlobals();
vi.restoreAllMocks();
});
function signedEpochResponse(instanceId: string, secret: string): Response {
const responseBody = JSON.stringify({ instanceId });
// buildFederationHeaders returns a complete Record<string,string> (signature,
// timestamp, nonce, origin, content-type) — exactly what the real handler sets.
const sigHeaders = buildFederationHeaders(responseBody, secret, PEER_ORIGIN);
return new Response(responseBody, { status: 200, headers: sigHeaders });
}
it('returns the instanceId when the response signature is valid', async () => {
vi.stubGlobal('fetch', vi.fn(async () => signedEpochResponse('remote-epoch-1', PEER_SECRET)));
const { fetchPeerEpoch } = await import('./federationEpoch.js');
const result = await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
expect(result).toBe('remote-epoch-1');
});
it('signs the outbound request with the peer secret', async () => {
const fetchMock = vi.fn(async () => signedEpochResponse('remote-epoch-1', PEER_SECRET));
vi.stubGlobal('fetch', fetchMock);
const { fetchPeerEpoch } = await import('./federationEpoch.js');
await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
const call = fetchMock.mock.calls[0] as unknown as [string, RequestInit];
expect(call[0]).toBe(`${PEER_ORIGIN}/api/federation/epoch`);
const sentHeaders = call[1].headers as Record<string, string>;
const sig = (sentHeaders['X-Federation-Signature'] ?? '').replace(/^sha256=/, '');
const ts = Number(sentHeaders['X-Federation-Timestamp']);
const nonce = sentHeaders['X-Federation-Nonce'] ?? null;
expect(verifySignature(call[1].body as string, sig, PEER_SECRET, ts, nonce)).toBe(true);
});
it('returns null when the response signature is invalid (wrong secret)', async () => {
vi.stubGlobal('fetch', vi.fn(async () => signedEpochResponse('remote-epoch-1', 'a-different-secret')));
const { fetchPeerEpoch } = await import('./federationEpoch.js');
const result = await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
expect(result).toBeNull();
});
it('returns null on 404 (peer not yet upgraded)', async () => {
vi.stubGlobal('fetch', vi.fn(async () => new Response('Not found', { status: 404 })));
const { fetchPeerEpoch } = await import('./federationEpoch.js');
const result = await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
expect(result).toBeNull();
});
it('returns null on a network error (no throw escapes)', async () => {
vi.stubGlobal('fetch', vi.fn(async () => { throw new Error('ECONNREFUSED'); }));
const { fetchPeerEpoch } = await import('./federationEpoch.js');
const result = await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
expect(result).toBeNull();
});
it('returns null when the response omits the signature header', async () => {
vi.stubGlobal('fetch', vi.fn(async () =>
new Response(JSON.stringify({ instanceId: 'remote-epoch-1' }), {
status: 200,
headers: { 'content-type': 'application/json' },
}),
));
const { fetchPeerEpoch } = await import('./federationEpoch.js');
const result = await fetchPeerEpoch({ origin: PEER_ORIGIN, hmacSecret: PEER_SECRET });
expect(result).toBeNull();
});
});