/** * Local sandbox backend. It selects the platform runner chain (Linux bwrap then * Landlock; macOS Seatbelt; Windows the ACL restricted-token runner), functionally probes * competing candidates once, and reports each wrap's enforcement and stderr * classification facts. Missing or unusable confinement fails closed rather * than returning the original argv. * * The windows-acl rung additionally owns the write grants: the write SID is * the per-WORKSPACE identity derived from the canonical workspace path * (`workspaceWriteSid`), while every live session receives a RANDOM private * temp directory and its own derived capability (`tempWriteSid`). The * workspace-root ACE materializes once per workspace per server lifetime * and STANDS (the cross-session reuse cache — the exact-ACE skip makes * every later provision O(1) instead of re-propagating the tree per * session); the private-temp ACEs are revoked on dispose. The runner * receives both SIDs (their presence marks the seam-managed contract) and * stops managing DACLs itself. The rung reports partial enforcement because * WRITE_RESTRICTED must retain Everyone in its * restricting list and NTFS hard links alias one file object across paths. * @module @deepseek-ai/dsh-sandbox-local */ import { spawnSync } from 'node:child_process' import { existsSync, mkdtempSync, rmSync } from 'node:fs' import { tmpdir } from 'node:os' import { join } from 'node:path' import { fileURLToPath } from 'node:url' import { LAUNCHER_BIN, LAUNCHER_FAILURE_EXIT, launcherPath as landlockLauncherPath, probe as defaultProbeLandlock, } from '@deepseek-ai/node-addon-landlock-run' import { Context } from '@deepseek-ai/cordis' import z from '@deepseek-ai/schemastery' import { assertNever } from '@deepseek-ai/dsh-llm' import { SandboxProvider, SandboxUnavailableError } from '@deepseek-ai/dsh-sandbox' import type { ConfinedArgv, ConfinedSandboxMode, RunnerFailureRule, SandboxEnforcement, SandboxPolicy } from '@deepseek-ai/dsh-sandbox' import type { SessionId } from '@deepseek-ai/dsh-session' import { AclWriteGrant, assertTempRootOutsideWorkspace, tempWriteSid, workspaceWriteSid } from '@deepseek-ai/dsh-sandbox-windows-acl' import { bwrapProfileArgs, landlockProfileArgs, seatbeltProfileArgs } from './profiles.ts' /** Plugin config. All optional — `static Config` supplies the defaults. */ export interface Config { /** * Override the runner argv; bwrap-compatible profile arguments are appended. A * non-empty override asserts full enforcement and skips built-in selection and * probing. A runner that starts but refuses its profile must be identifiable by * {@link runnerFailureSignatures}. Consumers classify a spawn rejection only after * confirming the workdir is usable. `ENOENT` or `EACCES` identifies the runner when * `error.path` equals argv[0] and `error.syscall` is `spawn` or `spawn `, or * when `error.path` is absent and `error.syscall` is exactly `spawn `. */ runnerCommand?: string[] /** * Case-insensitive stderr substrings emitted when a configured * {@link runnerCommand} refuses its profile before executing the wrapped * command. Required and non-empty with `runnerCommand`; rejected without * it. Each entry is a non-empty, single-line, case-insensitive substring * covering the executable runner's own failure dialect. */ runnerFailureSignatures?: string[] /** Positive timeout for each functional probe; zero would mean unbounded to Node. */ probeTimeoutMs?: number } /** Probe whether `bwrap` can create the profile; the provider caches the bounded result. */ function defaultProbeBwrap(timeoutMs: number): boolean { const probe = spawnSync('bwrap', ['--ro-bind', '/', '/', '--dev', '/dev', '--proc', '/proc', '--die-with-parent', '--', 'true'], { timeout: timeoutMs, stdio: 'ignore', }) return probe.status === 0 } /** * Functional Seatbelt probe: apply the real `read-only` profile through * `sandbox-exec -p` and run `true` under it — exit 0 means the kernel * accepted and enforced the profile (`sandbox-exec` exits non-zero when * `sandbox_init` refuses it). A missing `sandbox-exec` (every non-macOS * host) fails the spawn and probes `unusable`, exactly like the other * rungs' absent binaries. Apple marks the CLI deprecated but ships it on * every macOS; if it ever disappears, this probe is what fails closed. */ function defaultProbeSeatbelt(seatbeltExec: string, timeoutMs: number): boolean { const probe = spawnSync(seatbeltExec, [...seatbeltProfileArgs({ mode: 'read-only', workspaceRoot: '/' }), '--', 'true'], { timeout: timeoutMs, stdio: 'ignore', }) return probe.status === 0 } /** * Functional windows-acl probe: run the runner in read-only mode (zero grants, * no ACL mutation) around `cmd /c exit 0` — exit 0 means the runner created * the restricted token and spawned the child under it. The win32 chain is a * sole candidate, so the product never probes; the probe exists for override * chains and mirrors the other rungs' shape. */ function defaultProbeWindowsAcl(runnerInvocation: string[], timeoutMs: number): boolean { const program = runnerInvocation[0] if (program === undefined) return false const probe = spawnSync(program, [ ...runnerInvocation.slice(1), '--workspace', tmpdir(), '--temp', tmpdir(), '--mode', 'read-only', '--', 'cmd', '/c', 'exit', '0', ], { timeout: timeoutMs, stdio: 'ignore', }) return probe.status === 0 } /** Test hook: inject probe verdicts / a fake launcher / a platform without real runners. */ export interface SandboxInternals { /** Replaces `process.platform` for chain selection (exercise any platform's chain from any host). */ platform?: string /** Replaces the platform's chain wholesale (walk mechanics — e.g. probing a rung the product chains only reach unprobed). */ chain?: readonly SelectedRunner['runner'][] /** Replaces the functional `bwrap` probe (the Linux chain's first rung). */ probeBwrap?: () => boolean /** Replaces the functional Landlock launcher probe (the Linux chain's second rung). */ probeLandlock?: (launcher: string) => SandboxEnforcement | 'unusable' /** Replaces the functional Seatbelt probe (the darwin chain's sole rung — only consulted if that chain ever grows). */ probeSeatbelt?: (seatbeltExec: string) => boolean /** Replaces the resolved `landlock-run` launcher path (a fake launcher script). */ landlockLauncher?: string /** Replaces the `sandbox-exec` executable the probe and wraps invoke (a fake script). */ seatbeltExec?: string /** Replaces the resolved windows-acl runner argv prefix (a fake runner). */ windowsAclRunnerArgs?: string[] /** Replaces the resolved windows-acl runner built entry path (a fake lib/runner.js location). */ windowsAclRunnerEntry?: string /** Replaces the functional windows-acl probe (the win32 chain's sole rung — only consulted if that chain ever grows). */ probeWindowsAcl?: () => boolean /** Replaces the private-temp-directory removal at provider dispose (a throwing fake exercises the cleanup-failure path). */ rmTempDir?: (path: string) => void } /** The chain's verdict: which runner confines, and how completely it enforces. */ type SelectedRunner = { runner: 'bwrap' | 'landlock' | 'seatbelt' | 'windows-acl'; enforcement: SandboxEnforcement } /** One live session/workspace pair's private temp directory and capability. */ interface AclTempCapability { dir: string writeSid: string grant: AclWriteGrant } /** * The runner chain per platform — selection is BY PLATFORM first, probes * second: a platform's chain is probed in preference order only when it has * MORE than one candidate (probing arbitrates; it does not re-validate a * choice that has no alternative). A platform with no chain fails closed at * `confine()`. Linux prefers `bwrap` (its mount profile is closest to the * mode vocabulary) over the Landlock launcher; darwin has exactly one * candidate, selected without any probe. */ const PLATFORM_CHAINS: Record = { linux: ['bwrap', 'landlock'], darwin: ['seatbelt'], // The Windows restricted-token runner (@deepseek-ai/dsh-sandbox-windows-acl): // a sole candidate, selected without a probe — its execution-time refusal // fails closed through its stderr signature (windows-acl-run:) and exit 127. win32: ['windows-acl'], } /** * Enforcement completeness a rung claims when selected WITHOUT a probe (a * chain of one). `bwrap` and Seatbelt govern every promised file effect by * construction, so the claim is a profile fact; `landlock` is listed for the * table's totality but is unreachable unprobed today (the Linux chain has * two rungs, so it is only ever selected through its probe, whose report is * what distinguishes full from per-ABI-partial — and the launcher additionally * self-reports partial enforcement on stderr at every confined run). */ const STATIC_ENFORCEMENT: Record = { bwrap: 'full', landlock: 'full', seatbelt: 'full', // WRITE_RESTRICTED needs Everyone in both restricting lists for process // initialization. An external object that grants Everyone write access // therefore remains writable, and NTFS hard links can alias a granted // workspace file to a path outside it. The backend enforces the remaining // ACL-addressable surface but must not advertise the absolute promise. 'windows-acl': 'partial', } /** * A probe bound must be a positive finite number: Node treats * `spawnSync({ timeout: 0 })` as NO timeout, so an unvalidated 0 would * silently mean "unbounded" — the opposite of what the field promises. */ function assertPositiveFinite(name: string, value: number): void { if (!Number.isFinite(value) || value <= 0) { throw new Error(`sandbox-local: ${name} must be a positive finite number`) } } /** * The denial dialect each runner's kernel speaks — the case-insensitive stderr substrings a * denied file effect produces under it, carried on every wrap (the seam's * `ConfinedArgv.denialSignatures`). */ const DENIAL_SIGNATURES = { bwrap: ['read-only file system'], landlock: ['permission denied'], seatbelt: ['operation not permitted'], // pwsh/.NET: "Access to the path '...' is denied."; cmd: "Access is denied."; // node EACCES: "permission denied". 'windows-acl': ['access is denied', 'access to the path', 'permission denied'], runnerCommand: ['read-only file system', 'permission denied'], } as const satisfies Record /** The windows-acl runner's documented failure exit (its own RUNNER_FAILURE_EXIT contract, distinct from Landlock's 125). */ const WINDOWS_ACL_RUNNER_FAILURE_EXIT = 127 /** * Runner-owned fatal diagnostics. Landlock has a versioned exit-125 plus * fatal-line launcher-failure contract. Bubblewrap's current fatal paths exit * 1 but its public contract does not reserve that status, while sandbox-exec * publishes no launcher-failure status; those backends remain signature-only. * The windows-acl runner prints `windows-acl-run: ` on every * runner-side failure and exits 127 — the rule is exit-gated on that status * so a confined command that merely PRINTS the signature (or a runner * cleanup failure reported on a non-zero child exit) is never misclassified * as "the command did not run". Keep the Landlock tuple aligned with the * assembled snapshot fixture at * `examples/acp-agent/tests/fixtures/partial-landlock-sandbox.ts`. */ const RUNNER_FAILURE_RULES = { bwrap: [{ fatalSignatures: ['bwrap: '] }], landlock: [{ allowedExitCodes: [LAUNCHER_FAILURE_EXIT], fatalSignatures: [`${LAUNCHER_BIN}: `], informationalLines: [`${LAUNCHER_BIN}: partial enforcement (older Landlock ABI)`], }], seatbelt: [{ fatalSignatures: ['sandbox-exec: '] }], 'windows-acl': [{ allowedExitCodes: [WINDOWS_ACL_RUNNER_FAILURE_EXIT], fatalSignatures: ['windows-acl-run: '] }], } as const satisfies Record /** * Local process-sandbox provider. Registers as `ctx.sandbox`. Caches the * chain verdict and, on the windows-acl rung, the write grants * ({@link AclWriteGrant}: the standing workspace-root grant per workspace * and the revocable private-temp grant per live session/workspace pair, the * latter revoked on provider dispose); the one-time probes spawn nothing * else. */ export class LocalSandboxProvider extends SandboxProvider { // Inline schema call: the config catalog walks `static Config` statically. static Config: z = z.object({ runnerCommand: z.array(z.string()).default([]), runnerFailureSignatures: z.array(z.string()).default([]), probeTimeoutMs: z.natural().default(5_000), }) /** Test hook (mirrors the bash executors' `internals`). */ internals: SandboxInternals = {} private readonly runnerCommand: string[] | undefined private readonly configuredRunnerFailureSignatures: string[] private readonly probeTimeoutMs: number /** Cached chain verdict; undefined until the first confined wrap needs it. */ private selectedRunner: SelectedRunner | 'unavailable' | undefined /** * Server-lifetime write grants (windows-acl rung): the STANDING * workspace-root grant per workspace (its ACE is the cross-session reuse * cache and outlives the provider — never revoked) and the REVOCABLE * private-temp grant per live session/workspace pair (revoked on provider * dispose). */ private readonly workspaceGrants = new Map() private readonly tempCapabilities = new Map() constructor(ctx: Context, config: Config) { super(ctx) // The schema (static Config) defaults every field — the casts record // those runtime facts. An empty runnerCommand means "not configured": // use the platform chain. const runner = config.runnerCommand as string[] const runnerFailureSignatures = config.runnerFailureSignatures as string[] if (runner.length === 0 && runnerFailureSignatures.length > 0) { throw new Error('sandbox-local: runnerFailureSignatures requires runnerCommand') } if (runner.length > 0 && runnerFailureSignatures.length === 0) { throw new Error('sandbox-local: runnerCommand requires at least one runnerFailureSignatures entry') } if (runnerFailureSignatures.some(signature => signature.trim().length === 0 || /[\r\n]/u.test(signature))) { throw new Error('sandbox-local: runnerFailureSignatures entries must be non-empty single-line strings') } this.runnerCommand = runner.length > 0 ? runner : undefined this.configuredRunnerFailureSignatures = runnerFailureSignatures this.probeTimeoutMs = config.probeTimeoutMs as number assertPositiveFinite('probeTimeoutMs', this.probeTimeoutMs) // The temp grants are revoked with the provider: a clean server // shutdown leaves no temp ACEs behind (workspace ACEs stand by design — // the reuse cache; an unclean shutdown leaves them for the next // provision's exact-ACE skip). ctx.effect(() => () => { this.revokeAclGrants() }) } /** * Wrap `argv` in the selected runner's invocation for `policy` — the configured * `runnerCommand` when present (the operator's assertion, no probe), else the platform * chain's runner speaking its own profile dialect. * * @param argv - the exact argv the caller is about to spawn. * @param policy - the file-effect policy this execution runs under. * @returns the wrapped argv plus the selected backend's enforcement completeness, denial * signatures, and structured runner-failure rules; throws the fail-closed * `SANDBOX_UNAVAILABLE` error when the platform has no usable runner. */ confine(argv: readonly string[], policy: SandboxPolicy): ConfinedArgv { if (this.runnerCommand !== undefined) { return { argv: [...this.runnerCommand, ...bwrapProfileArgs(policy), '--', ...argv], enforcement: 'full', denialSignatures: DENIAL_SIGNATURES.runnerCommand, runnerFailureRules: [{ fatalSignatures: this.configuredRunnerFailureSignatures }], } } const selected = this.selectRunner(policy.mode) const runnerArgv = this.runnerArgv(selected.runner, policy) return { argv: [...runnerArgv, '--', ...argv], enforcement: selected.enforcement, denialSignatures: DENIAL_SIGNATURES[selected.runner], runnerFailureRules: RUNNER_FAILURE_RULES[selected.runner], } } /** The selected rung's runner invocation (program + profile arguments) for one policy. */ private runnerArgv(runner: SelectedRunner['runner'], policy: SandboxPolicy): string[] { switch (runner) { case 'bwrap': return ['bwrap', ...bwrapProfileArgs(policy)] case 'landlock': return [this.landlockLauncher(), ...landlockProfileArgs(policy)] case 'seatbelt': return [this.seatbeltExec(), ...seatbeltProfileArgs(policy)] case 'windows-acl': return this.windowsAclRunnerArgv(policy) default: return assertNever(runner) } } /** * The windows-acl runner argv for one policy. With a calling session (the * policy's `sessionId`) under workspace-write, the grants are materialized * once per provider lifetime — the standing workspace-root grant per * workspace and a revocable, RANDOM private-temp capability per live * session/workspace pair. The runner receives `--write-sid` plus * `--temp-write-sid` and grants nothing itself. Agentless workspace-write * calls pass the ambient temp ROOT and no SID flags: the runner creates and * removes a random private child directory for that one invocation. * @param policy - the resolved per-call policy. * @returns the runner invocation. */ private windowsAclRunnerArgv(policy: SandboxPolicy): string[] { const sessionId = policy.sessionId if (sessionId === undefined || policy.mode === 'read-only') { return [ ...this.windowsAclRunnerInvocation(), '--workspace', policy.workspaceRoot, '--temp', tmpdir(), '--mode', policy.mode, ] } const temp = this.materializeAclGrant(sessionId, policy.workspaceRoot) return [ ...this.windowsAclRunnerInvocation(), '--workspace', policy.workspaceRoot, '--temp', temp.dir, '--mode', policy.mode, '--write-sid', workspaceWriteSid(policy.workspaceRoot), '--temp-write-sid', temp.writeSid, ] } /** * Materialize one workspace-write policy's ACEs once per provider * lifetime. The workspace SID and standing root grant are shared by the * workspace. The temp directory is random and carries a distinct SID, so * another session on the same workspace cannot use the shared workspace * SID to enter it. A fresh provider always chooses a new path; crash * residue therefore cannot collide with or authorize a resumed session. * Fail-closed: a half-materialized temp grant is revoked and its directory * removed before the error propagates. * @param sessionId - the policy's calling-session identity. * @param workspaceRoot - the resolved policy root. * @returns the pair's private temp directory and write capability. */ private materializeAclGrant(sessionId: SessionId, workspaceRoot: string): AclTempCapability { assertTempRootOutsideWorkspace(workspaceRoot, tmpdir()) const writeSid = workspaceWriteSid(workspaceRoot) if (!this.workspaceGrants.has(workspaceRoot)) { const grant = AclWriteGrant.create(writeSid) try { grant.add(workspaceRoot, true) } catch (error) { // Free the SID; a standing ACE (if the apply succeeded before a // post-apply throw) is the intended end state, not an error // artifact — nothing to revoke. try { grant.dispose() } catch (cleanupError) { throw new AggregateError([error, cleanupError], 'sandbox-local windows-acl workspace grant failed and its cleanup also failed') } throw error } this.workspaceGrants.set(workspaceRoot, grant) } const key = JSON.stringify([String(sessionId), workspaceRoot]) const existing = this.tempCapabilities.get(key) if (existing !== undefined) return existing const tempDir = mkdtempSync(join(tmpdir(), 'dsh-')) const tempSid = tempWriteSid(tempDir) let grant: AclWriteGrant | undefined try { grant = AclWriteGrant.create(tempSid) grant.add(tempDir) } catch (error) { const cleanupFailures: unknown[] = [] if (grant !== undefined) { try { grant.dispose() } catch (cleanupError) { cleanupFailures.push(cleanupError) } } try { this.removeTempDir(tempDir) } catch (cleanupError) { cleanupFailures.push(cleanupError) } if (cleanupFailures.length > 0) { throw new AggregateError([error, ...cleanupFailures], 'sandbox-local windows-acl temp grant materialization failed and its cleanup also failed') } throw error } const capability = { dir: tempDir, writeSid: tempSid, grant } this.tempCapabilities.set(key, capability) return capability } /** * Dispose every write grant (provider dispose): the revocable temp ACEs * are revoked, the private temp directories this provider created are * removed, and every SID allocation is freed; the standing workspace ACEs * stay (the reuse cache). Cleanup failures are reported, not thrown: * cordis teardown must not be aborted by grant cleanup. A crash skips all * of it, but a new provider never reuses the residue's random path or SID; * OS temp hygiene (or manual removal) eventually reclaims it. */ private revokeAclGrants(): void { if (this.workspaceGrants.size === 0 && this.tempCapabilities.size === 0) return const failures: unknown[] = [] for (const grant of [...this.workspaceGrants.values(), ...[...this.tempCapabilities.values()].map(capability => capability.grant)]) { try { grant.dispose() } catch (error) { failures.push(error) } } for (const { dir } of this.tempCapabilities.values()) { try { this.removeTempDir(dir) } catch (error) { failures.push(error) } } this.workspaceGrants.clear() this.tempCapabilities.clear() if (failures.length > 0) { this.ctx.logger.warn(`sandbox-local: windows-acl grant cleanup completed with ${failures.length} failure(s)`) for (const error of failures) this.ctx.logger.warn(error) } } /** Remove one provider-owned private temp directory (injectable for cleanup tests). */ private removeTempDir(dir: string): void { const remove = this.internals.rmTempDir ?? ((path: string) => { rmSync(path, { recursive: true, force: true }) }) remove(dir) } /** * Resolve which runner confines commands, once, for the provider's * lifetime: this platform's chain ({@link PLATFORM_CHAINS}), its sole * candidate selected directly, multiple candidates arbitrated by * functional probes in chain order. Fail closed when the platform has no * chain or no candidate passes — the command never runs. */ private selectRunner(mode: ConfinedSandboxMode): SelectedRunner { this.selectedRunner ??= this.chainVerdict() if (this.selectedRunner === 'unavailable') throw new SandboxUnavailableError(mode) return this.selectedRunner } /** Walk this platform's chain: sole candidate unprobed, several probed in order, none usable → unavailable. */ private chainVerdict(): SelectedRunner | 'unavailable' { const chain = this.internals.chain ?? PLATFORM_CHAINS[this.internals.platform ?? process.platform] ?? [] const [first, ...rest] = chain if (first === undefined) return 'unavailable' // A sole candidate needs no arbitration; its execution-time refusal still fails closed. if (rest.length === 0) return { runner: first, enforcement: STATIC_ENFORCEMENT[first] } for (const runner of chain) { const enforcement = this.probeRunner(runner) if (enforcement !== 'unusable') return { runner, enforcement } } return 'unavailable' } /** One rung's functional probe (each at most once, via the chain walk). */ private probeRunner(runner: SelectedRunner['runner']): SandboxEnforcement | 'unusable' { // bwrap's mount profile and Seatbelt's deny-file-write* profile govern // every promised file effect by construction, so their passing probes // are always full enforcement; the Landlock launcher's probe report // distinguishes full from per-ABI-partial, while windows-acl is always // partial for its documented Everyone and hard-link boundaries. switch (runner) { case 'bwrap': { const probe = this.internals.probeBwrap ?? (() => defaultProbeBwrap(this.probeTimeoutMs)) return probe() ? 'full' : 'unusable' } case 'landlock': { const probe = this.internals.probeLandlock ?? (launcher => defaultProbeLandlock(launcher, { timeoutMs: this.probeTimeoutMs })) return probe(this.landlockLauncher()) } case 'seatbelt': { const probe = this.internals.probeSeatbelt ?? (exec => defaultProbeSeatbelt(exec, this.probeTimeoutMs)) return probe(this.seatbeltExec()) ? 'full' : 'unusable' } case 'windows-acl': { const probe = this.internals.probeWindowsAcl ?? (() => defaultProbeWindowsAcl(this.windowsAclRunnerInvocation(), this.probeTimeoutMs)) return probe() ? 'partial' : 'unusable' } default: return assertNever(runner) } } /** The Landlock launcher to probe and exec (test hook over the resolved one). */ private landlockLauncher(): string { return this.internals.landlockLauncher ?? landlockLauncherPath() } /** The `sandbox-exec` executable to probe and exec (test hook over the system one). */ private seatbeltExec(): string { return this.internals.seatbeltExec ?? 'sandbox-exec' } /** * The windows-acl runner argv prefix: the built lib/runner.js entry when * present (production), else the package source through tsx (development). * The prefix stays `[node, runner, ...]` — a future native-exe runner keeps * the same argv contract and only swaps these entries. */ private windowsAclRunnerInvocation(): string[] { const override = this.internals.windowsAclRunnerArgs if (override !== undefined) return override const builtEntry = this.internals.windowsAclRunnerEntry ?? fileURLToPath(import.meta.resolve('@deepseek-ai/dsh-sandbox-windows-acl/runner')) if (existsSync(builtEntry)) return [process.execPath, builtEntry] const sourceEntry = fileURLToPath(import.meta.resolve('@deepseek-ai/dsh-sandbox-windows-acl/src/runner.ts')) return [process.execPath, '--import', 'tsx/esm', sourceEntry] } } export default LocalSandboxProvider