pi-forge 0.0.0 → 1.1.4

package/dist/server/config-export.js

@@ -0,0 +1,220 @@
+/**
+ * Config export / import as a flat `.tar.gz`.
+ *
+ * What's included (and why):
+ *   - `mcp.json`       — pi-forge-owned MCP server registry
+ *   - `settings.json`  — pi-owned defaults (model, thinking level, skills patterns)
+ *   - `models.json`    — pi-owned custom providers
+ *
+ * What's deliberately EXCLUDED:
+ *   - `auth.json` — provider API keys + OAuth tokens. OAuth tokens are
+ *     installation-bound (a token issued for one pi-forge instance is
+ *     not portable), and inline API keys are sensitive enough that
+ *     bundling them into a download the user might forward by accident
+ *     (Slack, Drive, ticket attachment) outweighs the convenience. The
+ *     import flow tells the user to re-authenticate providers
+ *     afterwards.
+ *   - The auto-generated `jwt-secret` and `password-hash` files —
+ *     installation-bound, intentionally not portable.
+ *
+ * Archive layout: a flat tar with the three files at the top level (no
+ * leading directory). Importing rejects any entry that isn't one of
+ * those three exact names — this is the only validation that matters
+ * for safety, since the names map deterministically to disk targets.
+ *
+ * Atomic writes: each imported file lands in `<dst>.import.tmp` first,
+ * then `rename`s into place — same shape config-manager / project-
+ * manager already use, so a crash mid-import never produces a half-
+ * written config file.
+ */
+import { mkdir, mkdtemp, readFile, rename, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { dirname, join } from "node:path";
+import { Readable } from "node:stream";
+import { create as tarCreate, extract as tarExtract } from "tar";
+import { config } from "./config.js";
+/**
+ * The exact set of filenames we accept on import and emit on export.
+ * Anything else in an uploaded tar is silently ignored (reported in
+ * `skipped`). Defined as a `Set` so the import filter is O(1) per
+ * entry and we can't accidentally accept a near-miss like
+ * `Settings.json` on a case-sensitive filesystem.
+ */
+const ALLOWED_FILES = ["mcp.json", "settings.json", "models.json"];
+const ALLOWED_SET = new Set(ALLOWED_FILES);
+/**
+ * Map each allowed name to its on-disk target. Functions (not
+ * constants) so changes to `config.piConfigDir` /
+ * `config.mcpConfigFile` at test time take effect.
+ */
+const TARGETS = {
+    "mcp.json": () => config.mcpConfigFile,
+    "settings.json": () => join(config.piConfigDir, "settings.json"),
+    "models.json": () => join(config.piConfigDir, "models.json"),
+};
+/**
+ * Hard cap on uploaded tar size. Far above the realistic config size
+ * (the three files together are usually <50 KB) but low enough that a
+ * malicious or accidental large upload can't DoS the import path
+ * (which extracts to a tmp dir before validating). Also matches the
+ * route's multipart `fileSize` cap so the two layers agree.
+ */
+export const MAX_IMPORT_BYTES = 5 * 1024 * 1024;
+/**
+ * Build the export tar. Stages each existing config file into a tmp
+ * directory and tars from there — emitting straight from
+ * `config.piConfigDir` would also pick up `auth.json` and any other
+ * pi-owned files that aren't part of our export contract.
+ *
+ * Returns the gzipped readable stream + a summary of what was
+ * included. Caller pipes the stream to the HTTP response and consumes
+ * `files` for the response header / log line.
+ *
+ * The temp staging dir is cleaned up on stream `end` / `error`. If
+ * the stream is abandoned (caller never reads it), the dir leaks —
+ * acceptable for an interactive download path that completes in ms.
+ */
+export async function buildExportTar() {
+    const stage = await mkdtemp(join(tmpdir(), "pi-config-export-"));
+    const files = [];
+    for (const name of ALLOWED_FILES) {
+        const src = TARGETS[name]();
+        try {
+            const data = await readFile(src);
+            await writeFile(join(stage, name), data);
+            files.push(name);
+        }
+        catch (err) {
+            if (err.code !== "ENOENT") {
+                await rm(stage, { recursive: true, force: true }).catch(() => undefined);
+                throw err;
+            }
+            // Missing on disk — silently skip. An empty tar is valid.
+        }
+    }
+    // tar's `Pack` extends `Minipass`, which is API-compatible with
+    // node:stream Readable but typed independently. Cast at the
+    // boundary so the public return type is the standard one.
+    const pack = tarCreate({ gzip: true, cwd: stage }, files);
+    const stream = pack;
+    const cleanup = () => {
+        void rm(stage, { recursive: true, force: true }).catch(() => undefined);
+    };
+    stream.once("end", cleanup);
+    stream.once("error", cleanup);
+    stream.once("close", cleanup);
+    return { files, stream };
+}
+/**
+ * Extract a previously-exported tar from a Buffer and write any
+ * allowed files atomically into their on-disk targets.
+ *
+ * Two-phase, by design:
+ *   1. Extract entire archive to a private temp dir, refusing any
+ *      entry name that isn't in `ALLOWED_FILES`.
+ *   2. Validate each accepted file (JSON.parse). Files that fail
+ *      validation never make it to disk.
+ *   3. Atomic rename per file from temp into target.
+ *
+ * The "validate before any disk write" ordering matters: a partial
+ * import (e.g. `mcp.json` good, `settings.json` corrupt) would leave
+ * the pi-forge in worse shape than before the user clicked Import.
+ * Either everything valid lands, or nothing does — per file, ALL
+ * pass validation before ANY rename runs.
+ *
+ * Caller is responsible for the upload size cap on the route side;
+ * we double-check here against `MAX_IMPORT_BYTES` so a direct caller
+ * (test, future route) can't bypass the limit.
+ */
+export async function importConfigFromBuffer(buf) {
+    if (buf.byteLength > MAX_IMPORT_BYTES) {
+        throw new Error(`tar exceeds ${MAX_IMPORT_BYTES} bytes (got ${buf.byteLength}); refusing to import`);
+    }
+    const stage = await mkdtemp(join(tmpdir(), "pi-config-import-"));
+    try {
+        const accepted = [];
+        const skipped = [];
+        // tar.extract consumes a stream. Wrap the buffer as a Readable.
+        // The `filter` callback fires per-entry BEFORE bytes are written,
+        // so a rejected entry never touches disk.
+        await new Promise((resolve, reject) => {
+            const extractStream = tarExtract({
+                cwd: stage,
+                // Reject absolute paths and `..` segments at the tar layer;
+                // belt-and-suspenders since our filter also enforces it.
+                strict: true,
+                filter: (path, entry) => {
+                    // path comes through as the entry name verbatim; reject
+                    // anything that smells like a directory traversal or a
+                    // non-file. Matching against the exact ALLOWED_SET is the
+                    // primary safety boundary.
+                    //
+                    // `entry` is typed as `ReadEntry | Stats` because `tar` reuses
+                    // this filter for both pack and unpack; on extract it's
+                    // always a `ReadEntry` carrying `.type`. Narrow defensively.
+                    const entryType = entry.type;
+                    if (entryType !== undefined && entryType !== "File") {
+                        skipped.push(path);
+                        return false;
+                    }
+                    if (path.includes("/") ||
+                        path.includes("\\") ||
+                        path.includes("..") ||
+                        path.startsWith(".")) {
+                        skipped.push(path);
+                        return false;
+                    }
+                    if (!ALLOWED_SET.has(path)) {
+                        skipped.push(path);
+                        return false;
+                    }
+                    accepted.push(path);
+                    return true;
+                },
+            });
+            extractStream.on("error", reject);
+            extractStream.on("finish", () => resolve());
+            Readable.from(buf).pipe(extractStream);
+        });
+        // Validate every accepted file before ANY rename. JSON.parse is
+        // the contract — pi's loaders all assume parseable JSON, and an
+        // import that lands invalid JSON would brick the next agent
+        // session create.
+        const errors = [];
+        const valid = [];
+        for (const name of accepted) {
+            try {
+                const raw = await readFile(join(stage, name), "utf8");
+                JSON.parse(raw);
+                valid.push(name);
+            }
+            catch (err) {
+                errors.push({ file: name, reason: err instanceof Error ? err.message : String(err) });
+            }
+        }
+        if (errors.length > 0) {
+            // Fail the whole import on any per-file validation error so the
+            // user gets a single clear failure, not "imported half, broke
+            // half." The summary still surfaces every error so the user
+            // knows which file was bad.
+            return { imported: [], skipped, errors };
+        }
+        // Atomic move. mkdir parent dirs since pi config dir might not
+        // exist on a fresh deploy that's only setting these via import.
+        const imported = [];
+        for (const name of valid) {
+            const src = join(stage, name);
+            const dst = TARGETS[name]();
+            await mkdir(dirname(dst), { recursive: true });
+            const tmpDst = `${dst}.${Date.now()}.import.tmp`;
+            await rename(src, tmpDst);
+            await rename(tmpDst, dst);
+            imported.push(name);
+        }
+        return { imported, skipped, errors };
+    }
+    finally {
+        await rm(stage, { recursive: true, force: true }).catch(() => undefined);
+    }
+}
+//# sourceMappingURL=config-export.js.map

package/dist/server/config-export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-export.js","sourceRoot":"","sources":["../src/config-export.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACnF,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,KAAK,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,aAAa,CAAU,CAAC;AAE5E,MAAM,WAAW,GAAwB,IAAI,GAAG,CAAS,aAAa,CAAC,CAAC;AAExE;;;;GAIG;AACH,MAAM,OAAO,GAAsC;IACjD,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,aAAa;IACtC,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC;IAChE,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC;CAC7D,CAAC;AA4BF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACrD,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBACzE,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,0DAA0D;QAC5D,CAAC;IACH,CAAC;IACD,gEAAgE;IAChE,4DAA4D;IAC5D,0DAA0D;IAC1D,MAAM,IAAI,GAAG,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,IAA2B,CAAC;IAC3C,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC1E,CAAC,CAAC;IACF,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,GAAW;IACtD,IAAI,GAAG,CAAC,UAAU,GAAG,gBAAgB,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,eAAe,gBAAgB,eAAe,GAAG,CAAC,UAAU,uBAAuB,CACpF,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACjE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,gEAAgE;QAChE,kEAAkE;QAClE,0CAA0C;QAC1C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,aAAa,GAAG,UAAU,CAAC;gBAC/B,GAAG,EAAE,KAAK;gBACV,4DAA4D;gBAC5D,yDAAyD;gBACzD,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;oBACtB,wDAAwD;oBACxD,uDAAuD;oBACvD,0DAA0D;oBAC1D,2BAA2B;oBAC3B,EAAE;oBACF,+DAA+D;oBAC/D,wDAAwD;oBACxD,6DAA6D;oBAC7D,MAAM,SAAS,GAAI,KAA2B,CAAC,IAAI,CAAC;oBACpD,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;wBACpD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACf,CAAC;oBACD,IACE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;wBAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACnB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EACpB,CAAC;wBACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACf,CAAC;oBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC3B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACnB,OAAO,KAAK,CAAC;oBACf,CAAC;oBACD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACpB,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CAAC;YACH,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAClC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5C,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,gEAAgE;QAChE,4DAA4D;QAC5D,kBAAkB;QAClB,MAAM,MAAM,GAAuC,EAAE,CAAC;QACtD,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;gBACtD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAChB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,gEAAgE;YAChE,8DAA8D;YAC9D,4DAA4D;YAC5D,4BAA4B;YAC5B,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;QAC3C,CAAC;QAED,+DAA+D;QAC/D,gEAAgE;QAChE,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAmB,CAAC,EAAE,CAAC;YAC3C,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC;YACjD,MAAM,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAC1B,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACvC,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC"}