devsyncwrld/backspace
1
0
Fork 0
Code Issues Pull Requests Actions 26 Packages Projects Releases Wiki Activity

feat(federation): exchange + store peer epoch on handshake

Browse Source
This commit is contained in:
Jannis Braun
2026-07-01 21:35:20 +02:00
parent 7acf48d0a4
commit 538519fcd2
13 changed files with 375 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/server/src/routes/federation.ts
+45 -19
View File
@@ -19,6 +19,7 @@ import { deleteAttachmentFiles, deleteUploadFile } from '../utils/fileCleanup.js
import { tombstoneUser, collectDeletionBroadcastTargets, collectProfileBroadcastTargetIds } from '../utils/userDeletion.js';
import { computeFederatedId, getDmParticipants, sendCallRelay } from '../utils/federationOutbox.js';
import { onPeerActivated, onPeerDeactivated } from '../utils/federationPeerActivation.js';
import { getInstanceId } from '../utils/federationEpoch.js';
import { probePeerReachable, markPeerRecovered } from '../utils/federationRecovery.js';
import { getDmMessageWithUser } from './dm.js';
import type { FederationRelayRequest, FederationRelayResponse, FederationRelayEvent, FederationRelayAttachment, FederationSyncRequest, FederationSyncResponse, DmMessageWithUser, DmChannel, FederationRelayProfileSnapshot, FederationIdentityDeleteS2SRequest, FederationProfileUpdatePayload, ServerEvent, ApprovalRequestSubscriberSummary, PeeringTriggerReason } from '@backspace/shared';
@@ -379,6 +380,7 @@ async function handleInboundApprove(
sourceOrigin: localOrigin,
hmacSecret,
instanceName,
instanceId: getInstanceId(),
// Forward the stored token (issued in our 202 response when the
// remote first sent /peer/accept). Lets the remote verify mutual
// admin approval. Spec §3.7.
@@ -430,21 +432,26 @@ async function handleInboundApprove(
return reply.code(502).send({ error: errorMessage, statusCode: 502 });
}
// Parse the remote's instanceName from the response body so the
// federation panel renders a friendly label. Tolerate omission and
// non-JSON bodies — same pattern as performHandshake and /peer/initiate.
// Parse the remote's instanceName and instanceId (epoch) from the response
// body so the federation panel renders a friendly label and we record the
// peer's authenticated epoch baseline. Tolerate omission and non-JSON
// bodies — same pattern as performHandshake and /peer/initiate.
let remoteInstanceName: string | null = null;
let remoteInstanceId: string | null = null;
try {
const body = (await response.json()) as { instanceName?: string | null };
const body = (await response.json()) as { instanceName?: string | null; instanceId?: string | null };
if (typeof body?.instanceName === 'string' && body.instanceName.length > 0) {
remoteInstanceName = body.instanceName;
}
if (typeof body?.instanceId === 'string' && body.instanceId.length > 0) {
remoteInstanceId = body.instanceId;
}
} catch {
// Non-JSON body — leave null.
}
db.update(schema.federationPeers)
.set({ status: 'active', lastSeenAt: now, instanceName: remoteInstanceName, approvalToken: null })
.set({ status: 'active', lastSeenAt: now, instanceName: remoteInstanceName, peerInstanceId: remoteInstanceId, approvalToken: null })
.where(eq(schema.federationPeers.id, peerId))
.run();
@@ -532,6 +539,7 @@ async function handleOutboundApprove(
sourceOrigin: localOrigin,
hmacSecret,
instanceName,
instanceId: getInstanceId(),
// No approvalToken — outbound rows are admin-initiated locally; we
// hold no prior token from the remote and rely on the remote's own
// autoAcceptPeering setting to decide 200 vs 202.
@@ -612,13 +620,18 @@ async function handleOutboundApprove(
});
}
// 200 — peer activated. Capture remote's instanceName for the friendly label.
// 200 — peer activated. Capture remote's instanceName for the friendly label
// and instanceId (epoch) for the authenticated baseline.
let remoteInstanceName: string | null = approvalReq.instanceName;
let remoteInstanceId: string | null = null;
try {
const body = (await response.json()) as { instanceName?: string | null };
const body = (await response.json()) as { instanceName?: string | null; instanceId?: string | null };
if (typeof body?.instanceName === 'string' && body.instanceName.length > 0) {
remoteInstanceName = body.instanceName;
}
if (typeof body?.instanceId === 'string' && body.instanceId.length > 0) {
remoteInstanceId = body.instanceId;
}
} catch {
// Non-JSON body — keep approvalReq.instanceName (may be null).
}
@@ -628,6 +641,7 @@ async function handleOutboundApprove(
status: 'active',
lastSeenAt: now,
instanceName: remoteInstanceName,
peerInstanceId: remoteInstanceId,
approvalToken: null,
})
.where(eq(schema.federationPeers.id, peerId))
@@ -883,6 +897,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.from(schema.instanceSettings)
.where(eq(schema.instanceSettings.id, 1))
.get()?.name ?? undefined,
instanceId: getInstanceId(),
}),
signal: AbortSignal.timeout(10_000),
});
@@ -940,20 +955,25 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
}
// Remote accepted — activate the peer. Parse the remote's instanceName
// from the response body so the federation panel renders a friendly
// label. Tolerate omission and non-JSON bodies.
// and instanceId (epoch) from the response body so the federation panel
// renders a friendly label and we record the peer's authenticated
// epoch baseline. Tolerate omission and non-JSON bodies.
let remoteInstanceName: string | null = null;
let remoteInstanceId: string | null = null;
try {
const body = (await response.json()) as { instanceName?: string | null };
const body = (await response.json()) as { instanceName?: string | null; instanceId?: string | null };
if (typeof body?.instanceName === 'string' && body.instanceName.length > 0) {
remoteInstanceName = body.instanceName;
}
if (typeof body?.instanceId === 'string' && body.instanceId.length > 0) {
remoteInstanceId = body.instanceId;
}
} catch {
// Non-JSON body — leave null.
}
db.update(schema.federationPeers)
.set({ status: 'active', lastSeenAt: Date.now(), instanceName: remoteInstanceName, approvalToken: null })
.set({ status: 'active', lastSeenAt: Date.now(), instanceName: remoteInstanceName, peerInstanceId: remoteInstanceId, approvalToken: null })
.where(eq(schema.federationPeers.id, peerId))
.run();
connectionManager.sendToAdmins({ type: 'federation_peers_changed' as const });
@@ -994,7 +1014,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
// ─── POST /api/federation/peer/accept ──────────────────────────────────────
// Server-to-server: accept a peering request from a remote instance.
// No JWT auth — this is first contact. Rate-limited by IP.
app.post<{ Body: { sourceOrigin: string; challenge?: string; hmacSecret: string; instanceName?: string; approvalToken?: string } }>(
app.post<{ Body: { sourceOrigin: string; challenge?: string; hmacSecret: string; instanceName?: string; instanceId?: string; approvalToken?: string } }>(
'/api/federation/peer/accept',
async (request, reply) => {
const clientIp = request.ip;
@@ -1005,7 +1025,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
});
}
const { sourceOrigin: rawOrigin, hmacSecret, instanceName: reqInstanceName, approvalToken: inboundToken } = request.body ?? {};
const { sourceOrigin: rawOrigin, hmacSecret, instanceName: reqInstanceName, instanceId: reqInstanceId, approvalToken: inboundToken } = request.body ?? {};
if (!rawOrigin || typeof rawOrigin !== 'string') {
return reply.code(400).send({ error: 'sourceOrigin is required', statusCode: 400 });
@@ -1031,6 +1051,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.get();
const ourInstanceName = settings?.instanceName ?? null;
const ourInstanceId = getInstanceId();
const autoAccept = settings?.autoAcceptPeering ?? 1;
// ── autoAcceptPeering gate ──────────────────────────────────────────
@@ -1099,7 +1120,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
// Legitimate recovery path: local admin clicks "Reset peering" →
// row is deleted → remote's /peer/accept then lands on a
// non-existent row and the normal handshake path runs.
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
}
if (existing.status === 'revoked') {
return reply.code(403).send({
@@ -1114,6 +1135,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.set({
hmacSecret,
instanceName: reqInstanceName ?? null,
peerInstanceId: reqInstanceId ?? null,
status: 'active',
lastSeenAt: Date.now(),
})
@@ -1133,7 +1155,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
console.error('[federation] onPeerActivated from /peer/accept (rejected override) failed:', err)
);
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
}
if (existing.status === 'awaiting_approval') {
// Spec §3.5: token verification gates the awaiting_approval → active
@@ -1153,6 +1175,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.set({
hmacSecret,
instanceName: reqInstanceName ?? null,
peerInstanceId: reqInstanceId ?? null,
status: 'active',
lastSeenAt: Date.now(),
approvalToken: null,
@@ -1176,7 +1199,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
onPeerActivated(existing.id, 'accept_awaiting_approval').catch(err =>
console.error('[federation] onPeerActivated from /peer/accept (awaiting_approval) failed:', err)
);
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
}
// Token absent or mismatched. Cannot prove mutual approval.
@@ -1188,6 +1211,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.set({
hmacSecret,
instanceName: reqInstanceName ?? null,
peerInstanceId: reqInstanceId ?? null,
status: 'active',
lastSeenAt: Date.now(),
approvalToken: null,
@@ -1205,7 +1229,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
onPeerActivated(existing.id, 'accept_awaiting_approval_fallback').catch(err =>
console.error('[federation] onPeerActivated from /peer/accept (awaiting_approval fallback) failed:', err)
);
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
}
// autoAccept=0 + unverifiable inbound → queue as new approval-request.
@@ -1218,6 +1242,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
.set({
hmacSecret,
instanceName: reqInstanceName ?? null,
peerInstanceId: reqInstanceId ?? null,
status: 'active',
lastSeenAt: Date.now(),
})
@@ -1229,7 +1254,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
console.error('[federation] onPeerActivated from /peer/accept (pending) failed:', err)
);
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
}
// New peer — create and activate
@@ -1239,6 +1264,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
origin: sourceOrigin,
hmacSecret,
instanceName: reqInstanceName ?? null,
peerInstanceId: reqInstanceId ?? null,
status: 'active',
lastSeenAt: Date.now(),
createdAt: Date.now(),
@@ -1249,7 +1275,7 @@ export async function federationRoutes(app: FastifyInstance): Promise<void> {
console.error('[federation] onPeerActivated from /peer/accept (new) failed:', err)
);
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName });
return reply.code(200).send({ accepted: true, instanceName: ourInstanceName, instanceId: ourInstanceId });
},
);