fedipod-server 0.28.1 → 0.30.0

package/dist/opt-in.js

@@ -0,0 +1,176 @@
+"use strict";
+// opt-in.ts — what a pod owner asks of this server: to run their identity,
+// to stop running it, and to say what their pod would be as an identity
+// here; and reading who the server's own account session belongs to.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webIdsFromSession = webIdsFromSession;
+exports.optInPod = optInPod;
+exports.describePod = describePod;
+exports.optOutPod = optOutPod;
+const store_pod_1 = require("./store-pod");
+const directory_1 = require("./directory");
+const fedipod_1 = require("./fedipod");
+const mounts_1 = require("./mounts");
+const identities_1 = require("./identities");
+/**
+ * The WebIDs behind the account session in the request, or none. The server
+ * keeps that session in a `css-account` cookie; its own account API is what
+ * says which WebIDs the session owns, and it takes the same cookie. Nothing
+ * here trusts the cookie's presence — the account API does the deciding, and
+ * the caller picks the WebID that owns the pod being claimed.
+ */
+async function webIdsFromSession(h, request) {
+    const s = h.internals();
+    const cookie = request.headers.get('cookie');
+    if (!cookie || !/(?:^|;\s*)css-account=/u.test(cookie))
+        return [];
+    const base = s.args.frontOrigin.replace(/\/$/u, '');
+    const asJson = { cookie, accept: 'application/json' };
+    try {
+        const index = await fetch(`${base}/.account/`, { headers: asJson });
+        if (!index.ok)
+            return [];
+        const controls = (await index.json()).controls;
+        const webIdLink = controls?.account?.webId;
+        if (!webIdLink)
+            return [];
+        const linked = await fetch(webIdLink, { headers: asJson });
+        if (!linked.ok)
+            return [];
+        const links = (await linked.json()).webIdLinks ?? {};
+        return Object.keys(links);
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * A pod owner, already proven to control podBase, asks this server to run
+ * their identity. Returns { httpStatus, ...body }; the secret appears in the
+ * reply and nowhere else. Re-opting-in rotates the secret — that is how a
+ * lost one is recovered.
+ */
+async function optInPod(h, { podBase, webId, container = '', createIndex = false }) {
+    const s = h.internals();
+    if (!s.registry)
+        return { httpStatus: 501, error: 'this server does not offer runtime opt-in' };
+    if (s.args.clusterManager && !s.args.clusterManager.isSingleThreaded()) {
+        return { httpStatus: 503, error: 'runtime opt-in needs a single-worker server (--workers 1)' };
+    }
+    const base = podBase.endsWith('/') ? podBase : `${podBase}/`;
+    const handle = (0, mounts_1.deriveHandle)(base);
+    // Already running here from an earlier opt-in: proving pod
+    // control again buys a fresh secret, nothing else.
+    if (s.agentHandles.get(handle) === base) {
+        const door = await (0, identities_1.doorSecretFor)(h, base, undefined, { rotate: true });
+        s.doorSecrets.set(base, door.secret);
+        return { httpStatus: 201, ok: true, handle, host: new URL(base).host.toLowerCase(),
+            doorSecret: door.secret, doorPath: s.uiPath, status: 'rotated' };
+    }
+    let claim;
+    try {
+        claim = (0, mounts_1.validateAgentPod)(h, base);
+    }
+    catch (e) {
+        return { httpStatus: 409, error: e.message };
+    }
+    const { host } = claim;
+    // Where on the pod: the container its owner named holds `fedipod/`. The
+    // place is recorded in their public type index — made only on their yes —
+    // before anything else is written, and read here with the server's own
+    // access to the pod.
+    const place = await (0, fedipod_1.esmImport)(fedipod_1.PLACE);
+    const chosen = place.chosenRoot(base, container);
+    if (chosen.problem || !chosen.root)
+        return { httpStatus: 400, error: `Where to store it: ${chosen.problem}.` };
+    const root = chosen.root;
+    const { PodTransport } = await (0, fedipod_1.esmImport)(fedipod_1.TRANSPORT);
+    const pod = new PodTransport((0, store_pod_1.makeStoreSession)(s.args.resourceStore, base), { webId });
+    if (!createIndex && !await place.hasPublicIndex(pod, base)) {
+        return { httpStatus: 409, code: 'needs-index',
+            error: 'Your pod has no public type index, the list Solid apps use to find your things. '
+                + 'FediPod needs one to record where your account lives.' };
+    }
+    try {
+        await place.recordPlace(pod, base, `${base}${root}ap/actor`, { create: createIndex });
+    }
+    catch (e) {
+        return { httpStatus: 500, error: `could not record where the account lives in your type index (${e.message})` };
+    }
+    s.roots.set(base, root);
+    try {
+        await s.registry.add({ podBase: base, handle, host, webId, root, optedInAt: new Date().toISOString() });
+    }
+    catch (e) {
+        s.logger.error(`opt-in row for ${base} could not be written: ${e.message}`);
+        return { httpStatus: 500, error: 'could not record the opt-in' };
+    }
+    // From this instant the pod's identity routes answer 503 instead of LDP,
+    // until the agent registers its surface.
+    s.claimed.set(base, claim);
+    s.agentHandles.set(handle, base);
+    const door = await (0, identities_1.doorSecretFor)(h, base, undefined, { rotate: true });
+    s.doorSecrets.set(base, door.secret);
+    void (0, identities_1.startIdentity)(h, base);
+    s.logger.info(`runtime opt-in: @${handle} on ${base} (door secret in its pod at ${door.url})`);
+    return { httpStatus: 201, ok: true, handle, host,
+        doorSecret: door.secret, doorPath: s.uiPath, status: 'starting' };
+}
+/**
+ * What a pod would be as an identity here, without changing anything: its
+ * handle, the host its address carries, and whether it runs here already.
+ */
+async function describePod(h, { podBase }) {
+    const s = h.internals();
+    const base = podBase.endsWith('/') ? podBase : `${podBase}/`;
+    const handle = (0, mounts_1.deriveHandle)(base);
+    let host;
+    try {
+        host = (0, mounts_1.validateAgentPod)(h, base).host;
+    }
+    catch {
+        host = new URL(base).host.toLowerCase();
+    }
+    const running = s.agentHandles.get(handle) === base;
+    // The management page's door takes its key once in the address and keeps
+    // the browser in with a cookie. Only the owner's own page ever asks for
+    // this description, so the key rides on the link for a running account.
+    // Read from the pod, where the key always is, rather than from what this
+    // process happens to hold: an account still starting has none in memory.
+    let key;
+    if (running) {
+        try {
+            key = (await (0, identities_1.doorSecretFor)(h, base)).secret;
+        }
+        catch {
+            key = s.doorSecrets.get(base);
+        }
+    }
+    const door = base.replace(/\/$/u, '') + s.uiPath;
+    return { handle, host, address: `@${handle}@${host}`, running,
+        manage: key ? `${door}?dk-token=${encodeURIComponent(key)}` : door };
+}
+/** The reverse: stop the identity and let the pod be plain LDP again. */
+async function optOutPod(h, { podBase }) {
+    const s = h.internals();
+    if (!s.registry)
+        return { httpStatus: 501, error: 'this server does not offer runtime opt-in' };
+    const base = podBase.endsWith('/') ? podBase : `${podBase}/`;
+    const host = new URL(base).host.toLowerCase();
+    const key = (0, directory_1.agentKey)(host, base);
+    const row = await s.registry.get(key);
+    if (!row || row.podBase !== base)
+        return { httpStatus: 404, error: 'this pod has not opted in' };
+    s.claimed.delete(base); // routes fall to LDP now
+    s.startCancelled.add(base); // a pending start stands down
+    const identity = s.identities.get(base);
+    s.identities.delete(base);
+    s.surfaces.delete(base);
+    s.agentHandles.delete(row.handle);
+    s.doorSecrets.delete(base);
+    if (identity)
+        await identity.stop();
+    await s.registry.remove(key);
+    s.logger.info(`runtime opt-out: @${row.handle} on ${base} — the pod serves plain LDP again`);
+    return { httpStatus: 200, ok: true, stopped: Boolean(identity) };
+}

package/dist/store-pod.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeStoreFetch = makeStoreFetch;
 exports.makeStoreSession = makeStoreSession;
+const node_stream_1 = require("node:stream");
 const community_server_1 = require("@solid/community-server");
 /** Header lookup that does not care about case, over either shape fetch accepts. */
 function headerReader(init) {
@@ -131,6 +132,42 @@ function makeStoreFetch(resourceStore, podBase) {
             const written = changes?.get?.(identifier);
             return respond(205, null, written && etags.getETag(written));
         }
+        // An N3 Patch of an RDF document — a profile, a type index — read by the
+        // parser a Solid server reads one with, and applied by the store's own
+        // patching. Only the statements change; the document is never rewritten
+        // around them. A store that cannot patch answers 501, which is the one
+        // answer that sends a caller to writing the whole document instead.
+        if (method === 'PATCH') {
+            stats.writes++;
+            if (!/^text\/n3\b/u.test(header('content-type') ?? ''))
+                return respond(415, 'an N3 Patch is the patch this takes');
+            let patch;
+            try {
+                patch = await new community_server_1.N3PatchBodyParser().handle({
+                    metadata: new community_server_1.RepresentationMetadata(identifier, 'text/n3'),
+                    request: (0, community_server_1.guardStream)(node_stream_1.Readable.from([String(init.body ?? '')])),
+                });
+            }
+            catch (e) {
+                return respond(400, `not a patch this can read: ${e.message}`);
+            }
+            const ifMatch = header('if-match');
+            const conditions = ifMatch
+                ? new community_server_1.BasicConditions(etags, { matchesETag: ifMatch.split(',').map((t) => t.trim()) })
+                : undefined;
+            try {
+                await resourceStore.modifyResource(identifier, patch, conditions);
+            }
+            catch (e) {
+                // What the store said, as the status it said it with: 409 for a
+                // deletion of something not there, 412 for a stale If-Match, 501
+                // for a store with no patching at all.
+                if (community_server_1.HttpError.isInstance(e))
+                    return respond(e.statusCode, e.message);
+                throw e;
+            }
+            return respond(205, null);
+        }
         if (method === 'DELETE') {
             stats.deletes++;
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fedipod-server",
-  "version": "0.28.1",
+  "version": "0.30.0",
   "description": "The FediPod Server: a full ActivityPub server as a Community Solid Server component.",
   "license": "MIT",
   "main": "dist/index.js",
@@ -8,11 +8,6 @@
   "files": [
     "dist",
     "config",
-    "lib",
-    "vendor",
-    "web",
-    "run-agent.mjs",
-    "phanpy",
     "README.md",
     "fedipod-server.svg"
   ],
@@ -20,20 +15,16 @@
     "@solid/community-server": "^7.0.0"
   },
   "dependencies": {
-    "@fedify/fedify": "^2.3.4",
-    "@solid/access-token-verifier": "^2.1.1",
-    "jose": "^6.2.8",
-    "node-forge": "^1.4.0",
-    "rdflib": "^2.4.0",
-    "sanitize-html": "^2.17.6",
-    "undici": "^6.28.0",
-    "web-push": "^3.6.7"
+    "fedipod": "^1.42.0"
   },
   "devDependencies": {
     "typescript": "^5.5.3",
     "componentsjs-generator": "^3.1.2",
     "@types/node": "^20.0.0",
-    "@solid/community-server": "^7.2.0"
+    "@solid/community-server": "^7.2.0",
+    "@fedify/fedify": "^2.3.4",
+    "n3": "^2.1.1",
+    "rdflib": "^2.4.0"
   },
   "overrides": {
     "@opentelemetry/core": "^2.8.0",
@@ -53,11 +44,12 @@
   "scripts": {
     "build": "tsc && npm run build:components",
     "build:components": "componentsjs-generator -s src -c dist/components -r fps",
+    "pretest": "node scripts/link-fedipod.mjs",
     "test": "npm run build && node --test test/*.mjs",
+    "pretest:e2e": "node scripts/link-fedipod.mjs",
     "test:e2e": "node test/e2e/live-agent.mjs",
+    "pretest:e2e:suffix": "node scripts/link-fedipod.mjs",
     "test:e2e:suffix": "node test/e2e/live-suffix.mjs",
-    "prepublishOnly": "npm test",
-    "prepack": "node scripts/pack-tree.mjs copy",
-    "postpack": "node scripts/pack-tree.mjs clean"
+    "prepublishOnly": "npm test"
   }
 }