@agentforge-ai/sandbox 0.6.0

package/LICENSE

@@ -0,0 +1,197 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)
+
+      Copyright [yyyy] [name of copyright owner]
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.

package/README.md

@@ -0,0 +1,108 @@
+# @agentforge-ai/sandbox
+
+Docker-based sandbox provider for AgentForge agent tool execution isolation.
+
+## Overview
+
+This package implements container-based isolation for agent tool execution using Docker. It provides:
+
+- **`DockerSandbox`** — a container-backed `SandboxProvider` that manages the full lifecycle of a Docker container
+- **`ContainerPool`** — a warm-container pool to amortise Docker cold-start latency (LRU eviction, idle timeout)
+- **`SandboxManager`** — factory that creates the right sandbox type (Docker vs E2B) based on config, with graceful shutdown on process exit
+
+## Installation
+
+```bash
+pnpm add @agentforge-ai/sandbox dockerode
+```
+
+## Quick Start
+
+```typescript
+import { SandboxManager } from '@agentforge-ai/sandbox';
+
+const manager = new SandboxManager({ provider: 'docker' });
+await manager.initialize();
+
+const sb = await manager.create({ scope: 'agent', workspaceAccess: 'none' });
+
+const { stdout, exitCode } = await sb.exec('node --version');
+console.log(stdout); // v22.x.x
+
+await sb.writeFile('/tmp/hello.js', 'console.log("hello from container")');
+const result = await sb.exec('node /tmp/hello.js');
+console.log(result.stdout); // hello from container
+
+await manager.destroy(sb);
+await manager.shutdown();
+```
+
+## Configuration
+
+### `DockerSandboxConfig`
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `scope` | `'session' \| 'agent' \| 'shared'` | required | Lifecycle scope |
+| `workspaceAccess` | `'none' \| 'ro' \| 'rw'` | required | Host workspace mount mode |
+| `image` | `string` | `'node:22-slim'` | Docker image |
+| `workspacePath` | `string` | — | Host workspace directory |
+| `containerWorkspacePath` | `string` | `'/workspace'` | Mount point inside container |
+| `resourceLimits.cpuShares` | `number` | Docker default | CPU weight |
+| `resourceLimits.memoryMb` | `number` | unlimited | Memory cap in MB |
+| `resourceLimits.pidsLimit` | `number` | `256` | Max PIDs in container |
+| `resourceLimits.networkDisabled` | `boolean` | `false` | Disable networking |
+| `binds` | `string[]` | `[]` | Extra bind mounts (`host:container:mode`) |
+| `env` | `Record<string, string>` | `{}` | Environment variables |
+| `timeout` | `number` | none | Auto-kill after N seconds |
+
+### `PoolConfig`
+
+```typescript
+const pool = new ContainerPool({
+  image: 'node:22-slim',
+  scope: 'agent',
+  maxSize: 3,             // warm containers to keep ready (default: 3)
+  idleTimeoutSeconds: 300 // evict after 5 min idle (default: 300)
+});
+
+await pool.warmUp();
+const sb = await pool.acquire();
+// ... use sandbox ...
+await pool.release(sb);
+await pool.drain(); // cleanup
+```
+
+### Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `DOCKER_HOST` | Docker daemon host (default: Unix socket) |
+| `DOCKER_IMAGE` | Default image for agent sandboxes |
+| `AGENTFORGE_ALLOWED_IMAGES` | Comma-separated image prefixes allowed in production |
+
+## Security
+
+- **Blocked bind mounts**: `/var/run/docker.sock`, `/etc`, `/proc`, `/sys`, `/dev`, `/boot`, `/root`
+- **Capabilities**: All Linux capabilities dropped by default (`CapDrop: ALL`)
+- **No new privileges**: `SecurityOpt: no-new-privileges:true` applied to every container
+- **PID limit**: Default 256 PIDs per container to prevent fork bombs
+- **Image validation**: In production (`NODE_ENV=production`), only images with approved prefixes are allowed
+- **Command validation**: Defense-in-depth checks block docker.sock access and nsenter attempts
+
+## Docker Connection
+
+Connects to the Docker daemon via:
+- Unix socket (default): `/var/run/docker.sock`
+- TCP: configure via `SandboxManager({ dockerHost: { host, port, protocol } })`
+- Env: `DOCKER_HOST` environment variable
+
+## Requirements
+
+- Node.js ≥ 18
+- Docker Engine installed and running on the host
+- `dockerode` peer dependency
+
+## License
+
+Apache-2.0

package/dist/container-pool.d.ts

@@ -0,0 +1,89 @@
+import Dockerode from 'dockerode';
+import { PoolConfig, SandboxProvider } from './types.js';
+
+/**
+ * @module container-pool
+ *
+ * ContainerPool — maintains a pool of warm {@link DockerSandbox} instances
+ * to amortise container cold-start latency.
+ *
+ * Design:
+ * - A fixed-size pool of pre-started containers (warm slots).
+ * - {@link ContainerPool.acquire} returns the least-recently-used idle
+ *   container or starts a new one if the pool has not yet reached capacity.
+ * - {@link ContainerPool.release} marks a container as idle so it can be reused.
+ * - An idle-eviction sweep runs periodically and destroys containers that have
+ *   been idle longer than `idleTimeoutSeconds`.
+ * - LRU eviction is applied when the pool is at capacity and a new container is
+ *   requested but none are idle.
+ */
+
+/**
+ * A pool of warm Docker containers that can be acquired and released for reuse.
+ *
+ * @example
+ * ```ts
+ * const pool = new ContainerPool({ image: 'node:22-slim', scope: 'agent' });
+ * await pool.warmUp();
+ *
+ * const sb = await pool.acquire();
+ * await sb.exec('node -e "console.log(1+1)"');
+ * await pool.release(sb);
+ *
+ * await pool.drain();
+ * ```
+ */
+declare class ContainerPool {
+    private readonly config;
+    private readonly docker?;
+    private readonly entries;
+    private sweepTimer;
+    private draining;
+    constructor(config: PoolConfig, docker?: Dockerode);
+    /**
+     * Pre-warm the pool up to `maxSize` containers.
+     * Resolves once all warm containers are started.
+     */
+    warmUp(): Promise<void>;
+    /**
+     * Acquire an idle sandbox from the pool.
+     *
+     * If an idle entry is available, it is marked in-use and returned immediately.
+     * If the pool is not yet at capacity, a new container is started and returned.
+     * If the pool is at capacity and all containers are in use, the LRU idle
+     * container is evicted and a fresh one is started.
+     *
+     * @throws If the pool is draining.
+     */
+    acquire(): Promise<SandboxProvider>;
+    /**
+     * Release a previously acquired sandbox back to the pool.
+     * The sandbox is reset to an idle state for future reuse.
+     */
+    release(sandbox: SandboxProvider): Promise<void>;
+    /**
+     * Drain the pool: stop acquiring and destroy all containers.
+     * After draining, the pool stays in a drained state and rejects new acquires.
+     */
+    drain(): Promise<void>;
+    /**
+     * Returns the current number of entries (in-use + idle).
+     */
+    get size(): number;
+    /**
+     * Returns the number of idle (available) entries.
+     */
+    get idleCount(): number;
+    private _addEntry;
+    /** Return the idle entry with the smallest lastUsedAt (LRU idle). */
+    private _lruIdle;
+    /** Return the key of the entry with the smallest lastUsedAt (LRU any). */
+    private _lruAnyKey;
+    /** Start periodic idle-eviction sweep. */
+    private _startSweep;
+    private _stopSweep;
+    /** Remove and destroy containers that have been idle past the timeout. */
+    private _sweep;
+}
+
+export { ContainerPool };