@jigging/jig 0.1.0-alpha.2 → 0.1.0-alpha.20

package/libexec/linux-rootless-supervisor.js

@@ -1,8 +1,8 @@
 // @bun
 // src/internal/linux-rootless-supervisor.ts
 import { spawn } from "child_process";
-import { randomBytes } from "crypto";
-import { closeSync, readFileSync, statSync, writeSync } from "fs";
+import { createHash, randomBytes } from "crypto";
+import { closeSync, readFileSync, readSync, statSync, writeSync } from "fs";
 import {
   link,
   mkdir,
@@ -13,6 +13,7 @@ import {
   unlink,
   writeFile
 } from "fs/promises";
+import { createRequire } from "module";
 import { connect } from "net";
 import { posix } from "path";
 var POLICY = Object.freeze(["--no-env-file", "--no-install", "--config=/dev/null"]);
@@ -56,12 +57,18 @@ async function superviseConnected(control, startupDeadlineUnixMs) {
   let childExit;
   let stopReason;
   let admitted = false;
+  let continued = false;
+  let readyToContinue = false;
+  let outputDirectory;
   let resolveAdmission;
   let rejectAdmission;
   const admission = new Promise((resolve, reject) => {
     resolveAdmission = resolve;
     rejectAdmission = reject;
   });
+  admission.catch(() => {
+    return;
+  });
   const killRun = async () => {
     if (!cgroupCreated)
       return;
@@ -85,6 +92,12 @@ async function superviseConnected(control, startupDeadlineUnixMs) {
       if (type === "admit" && !admitted) {
         admitted = true;
         resolveAdmission();
+      } else if (type === "continue" && readyToContinue && stopReason === undefined && !continued) {
+        continued = true;
+        const gate = child?.stdio[4];
+        if (gate === undefined)
+          return stop("setup_failed");
+        gate.end(Buffer.from([1]));
       } else if (type === "cancel") {
         stop("cancelled");
       } else {
@@ -113,10 +126,15 @@ async function superviseConnected(control, startupDeadlineUnixMs) {
 `);
     if (stopReason !== undefined)
       throw new Error(`rootless launch stopped during setup: ${stopReason}`);
-    safeSend(control, { type: "prepared", runCgroup, supervisorPid: process.pid });
+    safeSend(control, {
+      type: "prepared",
+      runCgroup,
+      supervisorPid: process.pid
+    });
     await admission;
     if (stopReason !== undefined)
       throw new Error(`rootless launch stopped before spawn: ${stopReason}`);
+    restrictInheritedDescriptors(configuration.bunHostLibraryPath, configuration.capturedInputs.map((file) => file.fd));
     const launched = spawn(configuration.bunPath, [
       ...POLICY,
       configuration.supervisorPath,
@@ -132,16 +150,32 @@ async function superviseConnected(control, startupDeadlineUnixMs) {
       env: {
         LD_LIBRARY_PATH: configuration.bunHostLibraryPath
       },
-      stdio: ["inherit", "inherit", "inherit", "pipe"]
+      stdio: [
+        "inherit",
+        "inherit",
+        "inherit",
+        "pipe",
+        "pipe",
+        configuration.output ? "pipe" : "ignore",
+        ...configuration.capturedInputs.map((file) => file.fd)
+      ]
     });
     childExit = childClose(launched);
     child = launched;
+    launched.stdio[4].on("error", () => stop("setup_failed"));
     const ready = await readReady(launched);
+    if (configuration.output) {
+      const sandboxPid = await readSandboxPid(launched);
+      await outputReady(launched);
+      outputDirectory = await open(`/proc/${sandboxPid}/root/jig-output`, 65536);
+    }
+    readyToContinue = true;
     safeSend(control, {
       type: "ready",
       runCgroup,
       payloadPid: ready,
-      supervisorPid: process.pid
+      supervisorPid: process.pid,
+      ...outputDirectory === undefined ? {} : { outputFd: outputDirectory.fd }
     });
     const exit = await childExit;
     exitCode = exit.code;
@@ -154,6 +188,7 @@ async function superviseConnected(control, startupDeadlineUnixMs) {
 `);
   } finally {
     clearTimeout(deadline);
+    await outputDirectory?.close();
     let cleanupError;
     try {
       child?.kill("SIGKILL");
@@ -216,13 +251,50 @@ async function enterMain(arguments_) {
   writeSync(3, `${process.pid}
 `);
   closeSync(3);
-  const child = spawn(bubblewrap, bubblewrapArguments_, { cwd: "/", env: {}, stdio: "inherit" });
+  const separator = bubblewrapArguments_.indexOf("--");
+  if (separator < 0)
+    throw new Error("missing rootless command boundary");
+  const envelopeArguments = bubblewrapArguments_.slice(0, separator);
+  const output = envelopeArguments.includes("--sync-fd");
+  if (!output) {
+    const gate = Buffer.alloc(1);
+    if (readSync(4, gate, 0, 1, null) !== 1 || gate[0] !== 1) {
+      throw new Error("execution ownership was not acknowledged");
+    }
+    closeSync(4);
+  }
+  const inputDescriptors = envelopeArguments.flatMap((arg, index) => arg === "--file" ? [Number(envelopeArguments[index + 1])] : []);
+  if (inputDescriptors.some((fd, index) => fd !== 6 + index))
+    throw new Error("invalid captured input descriptor order");
+  restrictInheritedDescriptors(process.env.LD_LIBRARY_PATH, [
+    ...output ? [4, 5] : [],
+    ...inputDescriptors
+  ]);
+  const child = spawn(bubblewrap, bubblewrapArguments_, {
+    cwd: "/",
+    env: {},
+    stdio: [
+      "inherit",
+      "inherit",
+      "inherit",
+      "ignore",
+      output ? 4 : "ignore",
+      output ? 5 : "ignore",
+      ...inputDescriptors
+    ]
+  });
+  for (const fd of inputDescriptors)
+    closeSync(fd);
+  if (output) {
+    closeSync(4);
+    closeSync(5);
+  }
   const exit = await childClose(child);
   if (exit.signal !== null)
     process.kill(process.pid, exit.signal);
   process.exitCode = exit.code ?? 1;
 }
-async function innerMain(command) {
+async function innerMain(command, output, capturedInputs) {
   if (command.length === 0 || !absolute(command[0]))
     throw new Error("invalid rootless inner command");
   const nullDevice = statSync("/dev/null");
@@ -230,27 +302,63 @@ async function innerMain(command) {
   if (!nullDevice.isCharacterDevice() || !entropyDevice.isCharacterDevice() || (nullDevice.mode & 511) !== 438 || (entropyDevice.mode & 511) !== 438) {
     throw new Error("rootless private devices do not satisfy the required projection");
   }
-  const child = spawn(command[0], command.slice(1), { cwd: "/work", env: process.env, stdio: "inherit" });
+  for (const file of capturedInputs) {
+    const bytes = readFileSync(file.path);
+    if (bytes.byteLength !== file.bytes || `sha256:${createHash("sha256").update(bytes).digest("hex")}` !== file.digest)
+      throw new Error("captured input projection does not match its admitted identity");
+  }
+  if (output) {
+    writeSync(4, Buffer.from([1]));
+    const gate = Buffer.alloc(1);
+    if (readSync(4, gate, 0, 1, null) !== 1 || gate[0] !== 1) {
+      throw new Error("output ownership was not acquired");
+    }
+    closeSync(4);
+  }
+  restrictInheritedDescriptors(SANDBOX_LIBRARY_PATH, []);
+  const child = spawn(command[0], command.slice(1), {
+    cwd: "/work",
+    env: process.env,
+    stdio: "inherit"
+  });
   const exit = await childClose(child);
   if (exit.signal !== null)
     process.kill(process.pid, exit.signal);
   process.exitCode = exit.code ?? 1;
 }
+function restrictInheritedDescriptors(libraryDirectory, allowed) {
+  if (libraryDirectory === undefined || !absolute(libraryDirectory) || libraryDirectory.includes(":") || allowed.some((fd) => !Number.isSafeInteger(fd) || fd < 3) || new Set(allowed).size !== allowed.length)
+    throw new Error("invalid inherited descriptor policy");
+  const ffi = createRequire(import.meta.url)("bun:ffi");
+  const controls = ffi.dlopen(posix.join(libraryDirectory, "libc.so.6"), {
+    close_range: { args: ["u32", "u32", "u32"], returns: "i32" },
+    fcntl: { args: ["i32", "i32", "i32"], returns: "i32" }
+  });
+  try {
+    if (controls.symbols.close_range(3, 4294967295, 4) !== 0)
+      throw new Error("inherited descriptor restriction is unavailable");
+    for (const fd of allowed) {
+      const flags = controls.symbols.fcntl(fd, 1, 0);
+      if (flags < 0 || controls.symbols.fcntl(fd, 2, flags & ~1) !== 0)
+        throw new Error("required descriptor handoff is unavailable");
+    }
+  } finally {
+    controls.close();
+  }
+}
 function bubblewrapArguments(configuration) {
   const result = [
     "--unshare-all",
     ...configuration.network === "inherited" ? ["--share-net"] : [],
     "--unshare-user",
-    "--disable-userns",
-    "--assert-userns-disabled",
+    ...configuration.nestedUserNamespaces ? [] : ["--disable-userns", "--assert-userns-disabled"],
     "--as-pid-1",
     "--die-with-parent",
     "--new-session",
     "--clearenv",
     "--proc",
     "/proc",
-    "--remount-ro",
-    "/proc",
+    ...configuration.nestedUserNamespaces ? [] : ["--remount-ro", "/proc"],
     "--dev",
     "/dev",
     "--tmpfs",
@@ -274,11 +382,25 @@ function bubblewrapArguments(configuration) {
   ];
   for (const mount of configuration.readOnlyMounts)
     result.push("--ro-bind", mount.source, mount.destination);
+  if (configuration.inputDirectories.length > 0)
+    result.push("--size", String(16 * 1024 * 1024), "--tmpfs", "/jig-input");
+  for (const path of configuration.inputDirectories)
+    result.push("--dir", path);
+  for (const file of configuration.capturedInputs)
+    result.push("--perms", "0444", "--file", String(file.fd), file.destination);
+  if (configuration.inputDirectories.length > 0)
+    result.push("--remount-ro", "/jig-input");
+  if (configuration.output)
+    result.push("--size", String(16 * 1024 * 1024), "--tmpfs", "/jig-output", "--sync-fd", "4", "--json-status-fd", "5");
   result.push("--ro-bind", configuration.supervisorPath, MODULE_DESTINATION);
   for (const [name, value] of Object.entries(configuration.environment).sort(([a], [b]) => a.localeCompare(b))) {
     result.push("--setenv", name, value);
   }
-  result.push("--setenv", "LD_LIBRARY_PATH", SANDBOX_LIBRARY_PATH, "--uid", String(configuration.payloadUid), "--gid", String(configuration.payloadGid), "--cap-drop", "ALL", "--", SANDBOX_BUN, ...POLICY, MODULE_DESTINATION, "--inner", "--", ...configuration.command);
+  result.push("--setenv", "LD_LIBRARY_PATH", SANDBOX_LIBRARY_PATH, "--uid", String(configuration.payloadUid), "--gid", String(configuration.payloadGid), "--cap-drop", "ALL", "--", SANDBOX_BUN, ...POLICY, MODULE_DESTINATION, configuration.output ? "--inner-output" : "--inner", JSON.stringify(configuration.capturedInputs.map(({ destination, bytes, digest }) => ({
+    path: destination,
+    bytes,
+    digest
+  }))), "--", ...configuration.command);
   return result;
 }
 async function claimActive(configuration) {
@@ -363,11 +485,15 @@ function requireStart(value) {
     "bunHostLibraryPath",
     "bunPath",
     "command",
+    "capturedInputs",
     "delegatedCgroup",
     "environment",
     "limits",
+    "inputDirectories",
     "mechanismDigest",
+    "nestedUserNamespaces",
     "network",
+    "output",
     "ownerDigest",
     "ownerStateAllocationDigest",
     "ownerStateDirectory",
@@ -379,7 +505,7 @@ function requireStart(value) {
     "sealedPlanDigest",
     "supervisorPath"
   ];
-  if (configuration === null || typeof configuration !== "object" || Array.isArray(configuration) || Object.keys(configuration).sort().join("\x00") !== keys.sort().join("\x00") || !absolute(configuration.delegatedCgroup) || !absolute(configuration.bunHostLibraryPath) || !absolute(configuration.runCgroup) || posix.dirname(configuration.runCgroup) !== configuration.delegatedCgroup || !/^jig-run-[a-z0-9][a-z0-9-]{0,47}-[0-9a-f]{24}$/.test(posix.basename(configuration.runCgroup)) || !configuration.runCgroup.startsWith("/sys/fs/cgroup/") || !absolute(configuration.ownerStateDirectory) || !absolute(configuration.bunPath) || !absolute(configuration.bubblewrapPath) || !absolute(configuration.supervisorPath) || typeof configuration.mechanismDigest !== "string" || !DIGEST.test(configuration.mechanismDigest) || typeof configuration.ownerDigest !== "string" || !DIGEST.test(configuration.ownerDigest) || typeof configuration.sealedPlanDigest !== "string" || !DIGEST.test(configuration.sealedPlanDigest) || typeof configuration.ownerStateAllocationDigest !== "string" || !DIGEST.test(configuration.ownerStateAllocationDigest) || typeof configuration.ownerToken !== "string" || !OWNER_TOKEN.test(configuration.ownerToken) || configuration.network !== "isolated" && configuration.network !== "inherited" || !positiveInteger(configuration.payloadUid) || !positiveInteger(configuration.payloadGid) || !validLimits(configuration.limits) || !validMounts(configuration.readOnlyMounts) || !validEnvironment(configuration.environment) || !Array.isArray(configuration.command) || configuration.command.length === 0 || !absolute(configuration.command[0]) || configuration.command.some((part) => typeof part !== "string" || part.includes("\x00"))) {
+  if (configuration === null || typeof configuration !== "object" || Array.isArray(configuration) || Object.keys(configuration).sort().join("\x00") !== keys.sort().join("\x00") || !absolute(configuration.delegatedCgroup) || !absolute(configuration.bunHostLibraryPath) || !absolute(configuration.runCgroup) || posix.dirname(configuration.runCgroup) !== configuration.delegatedCgroup || !/^jig-run-[a-z0-9][a-z0-9-]{0,47}-[0-9a-f]{24}$/.test(posix.basename(configuration.runCgroup)) || !configuration.runCgroup.startsWith("/sys/fs/cgroup/") || !absolute(configuration.ownerStateDirectory) || !absolute(configuration.bunPath) || !absolute(configuration.bubblewrapPath) || !absolute(configuration.supervisorPath) || typeof configuration.mechanismDigest !== "string" || !DIGEST.test(configuration.mechanismDigest) || typeof configuration.ownerDigest !== "string" || !DIGEST.test(configuration.ownerDigest) || typeof configuration.sealedPlanDigest !== "string" || !DIGEST.test(configuration.sealedPlanDigest) || typeof configuration.ownerStateAllocationDigest !== "string" || !DIGEST.test(configuration.ownerStateAllocationDigest) || typeof configuration.ownerToken !== "string" || !OWNER_TOKEN.test(configuration.ownerToken) || configuration.network !== "isolated" && configuration.network !== "inherited" || typeof configuration.nestedUserNamespaces !== "boolean" || typeof configuration.output !== "boolean" || !Array.isArray(configuration.capturedInputs) || configuration.capturedInputs.length > 64 || !Array.isArray(configuration.inputDirectories) || configuration.inputDirectories.length > 8 || configuration.inputDirectories.some((path) => typeof path !== "string" || path.length > 75 || !/^\/jig-input\/[a-z0-9]+(?:-[a-z0-9]+)*$/.test(path)) || configuration.capturedInputs.some((file, index) => file === null || typeof file !== "object" || file.fd !== 6 + index || !absolute(file.destination) || !Number.isSafeInteger(file.bytes) || file.bytes < 0 || typeof file.digest !== "string" || !DIGEST.test(file.digest) || !configuration.inputDirectories.some((path) => file.destination.startsWith(`${path}/`))) || !positiveInteger(configuration.payloadUid) || !positiveInteger(configuration.payloadGid) || !validLimits(configuration.limits) || !validMounts(configuration.readOnlyMounts) || !validEnvironment(configuration.environment) || !Array.isArray(configuration.command) || configuration.command.length === 0 || !absolute(configuration.command[0]) || configuration.command.some((part) => typeof part !== "string" || part.includes("\x00"))) {
     throw new Error("invalid rootless supervisor configuration");
   }
   return configuration;
@@ -462,6 +588,39 @@ async function readReady(child) {
     throw new Error("invalid rootless entry readiness receipt");
   return pid;
 }
+async function readSandboxPid(child) {
+  const stream = child.stdio[5];
+  if (stream === undefined)
+    throw new Error("missing Bubblewrap status pipe");
+  let text = "";
+  for await (const chunk of stream.iterator({ destroyOnReturn: false })) {
+    text += String(chunk);
+    if (text.length > 4096)
+      throw new Error("oversized Bubblewrap status");
+    const end = text.indexOf("}");
+    if (end < 0)
+      continue;
+    const record = JSON.parse(text.slice(0, end + 1));
+    if (!positiveInteger(record["child-pid"]))
+      throw new Error("invalid Bubblewrap child identity");
+    stream.resume();
+    return record["child-pid"];
+  }
+  throw new Error("Bubblewrap exited before output handoff");
+}
+function outputReady(child) {
+  const stream = child.stdio[4];
+  return new Promise((resolve, reject) => {
+    stream.once("error", reject);
+    stream.once("end", () => reject(new Error("output launcher ended before handoff")));
+    stream.once("data", (bytes) => {
+      if (bytes.length !== 1 || bytes[0] !== 1)
+        reject(new Error("invalid output readiness"));
+      else
+        resolve();
+    });
+  });
+}
 async function waitUntilEmpty(cgroup, timeoutMs) {
   const deadline = Date.now() + timeoutMs;
   while (Date.now() <= deadline) {
@@ -506,7 +665,11 @@ async function readCounters(path) {
   return result;
 }
 function emptyEvidence() {
-  return Object.freeze({ cpuStat: Object.freeze({}), memoryEvents: Object.freeze({}), pidsEvents: Object.freeze({}) });
+  return Object.freeze({
+    cpuStat: Object.freeze({}),
+    memoryEvents: Object.freeze({}),
+    pidsEvents: Object.freeze({})
+  });
 }
 async function exists(path) {
   try {
@@ -607,10 +770,18 @@ async function main() {
   }
   if (mode === "--enter")
     return await enterMain(arguments_);
-  if (mode === "--inner") {
-    if (arguments_[0] !== "--")
+  if (mode === "--inner" || mode === "--inner-output") {
+    if (arguments_[1] !== "--")
       throw new Error("invalid rootless inner separator");
-    return await innerMain(arguments_.slice(1));
+    let capturedInputs;
+    try {
+      capturedInputs = JSON.parse(arguments_[0]);
+    } catch {
+      throw new Error("invalid rootless captured input identity");
+    }
+    if (!Array.isArray(capturedInputs) || capturedInputs.length > 64 || capturedInputs.some((file) => file === null || typeof file !== "object" || Object.keys(file).sort().join(",") !== "bytes,digest,path" || typeof file.path !== "string" || !file.path.startsWith("/jig-input/") || !Number.isSafeInteger(file.bytes) || file.bytes < 0 || typeof file.digest !== "string" || !DIGEST.test(file.digest)))
+      throw new Error("invalid rootless captured input identity");
+    return await innerMain(arguments_.slice(2), mode === "--inner-output", capturedInputs);
   }
   throw new Error("invalid rootless supervisor mode");
 }