@anthropic-ai/sandbox-runtime 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Anthropic
+
+   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

@@ -11,7 +11,7 @@ A lightweight sandboxing tool for enforcing filesystem and network restrictions
 ## Installation
 
 ```bash
-npm install @anthropic-ai/sandbox-runtime
+npm install -g @anthropic-ai/sandbox-runtime
 ```
 
 ## Basic Usage
@@ -76,13 +76,17 @@ A key use case is sandboxing Model Context Protocol (MCP) servers to restrict th
 }
 ```
 
-Then configure restrictions in `~/.claude/settings.json`:
+Then configure restrictions in `~/.srt-settings.json`:
 ```json
 {
-  "permissions": {
-    "deny": [
-      "Edit(~/sensitive-folder)"
-    ]
+  "filesystem": {
+    "denyRead": [],
+    "allowWrite": ["."],
+    "denyWrite": ["~/sensitive-folder"]
+  },
+  "network": {
+    "allowedDomains": [],
+    "deniedDomains": []
   }
 }
 ```
@@ -160,17 +164,30 @@ srt echo "hello world"
 srt --debug curl https://example.com
 
 # Specify custom settings file
-srt --settings /path/to/settings.json npm install
+srt --settings /path/to/srt-settings.json npm install
 ```
 
 ### As a library
 
 ```typescript
-import { SandboxManager } from '@anthropic-ai/sandbox-runtime'
+import { SandboxManager, type SandboxRuntimeConfig } from '@anthropic-ai/sandbox-runtime'
 import { spawn } from 'child_process'
 
+// Define your sandbox configuration
+const config: SandboxRuntimeConfig = {
+  network: {
+    allowedDomains: ['example.com', 'api.github.com'],
+    deniedDomains: []
+  },
+  filesystem: {
+    denyRead: ['~/.ssh'],
+    allowWrite: ['.', '/tmp'],
+    denyWrite: ['.env']
+  }
+}
+
 // Initialize the sandbox (starts proxy servers, etc.)
-await SandboxManager.initialize()
+await SandboxManager.initialize(config)
 
 // Wrap a command with sandbox restrictions
 const sandboxedCommand = await SandboxManager.wrapWithSandbox('curl https://example.com')
@@ -198,8 +215,11 @@ export { SandboxViolationStore } from '@anthropic-ai/sandbox-runtime'
 
 // TypeScript types
 export type {
-  SandboxAskCallback,
+  SandboxRuntimeConfig,
+  NetworkConfig,
+  FilesystemConfig,
   IgnoreViolationsConfig,
+  SandboxAskCallback,
   FsReadRestrictionConfig,
   FsWriteRestrictionConfig,
   NetworkRestrictionConfig,
@@ -208,70 +228,71 @@ export type {
 
 ## Configuration
 
-**NOTE: Configuration format is provisional and subject to change.** The current configuration system is borrowed from Claude Code's permission model and uses Claude Code settings files. This format may evolve as the sandbox runtime matures as a standalone tool.
-
-### Settings File Locations
+### Settings File Location
 
-Settings are loaded and merged in priority order from:
+By default, the sandbox runtime looks for configuration at `~/.srt-settings.json`. You can specify a custom path using the `--settings` flag:
 
-1. **User settings**: `~/.claude/settings.json`
-2. **Project settings**: `$CWD/.claude/settings.json`
-3. **Local settings**: `$CWD/.claude/settings.local.json`
-4. **Policy settings**: Platform-specific managed settings
-   - macOS: `/Library/Application Support/ClaudeCode/managed-settings.json`
-   - Linux: `/etc/claude-code/managed-settings.json`
-5. **Flag settings**: Custom path via `--settings` flag
+```bash
+srt --settings /path/to/srt-settings.json <command>
+```
 
 ### Complete Configuration Example
 
 ```json
 {
-  "sandbox": {
-    "enabled": true,
-    "network": {
-      "allowUnixSockets": ["/var/run/docker.sock"],
-      "allowLocalBinding": false,
-      "httpProxyPort": 8888,
-      "socksProxyPort": 1080
-    }
+  "network": {
+    "allowedDomains": [
+      "github.com",
+      "*.github.com",
+      "lfs.github.com",
+      "api.github.com",
+      "npmjs.org",
+      "*.npmjs.org"
+    ],
+    "deniedDomains": [
+      "malicious.com"
+    ],
+    "allowUnixSockets": ["/var/run/docker.sock"],
+    "allowLocalBinding": false
   },
-  "permissions": {
-    "allow": [
-      "WebFetch(domain:github.com)",
-      "WebFetch(domain:lfs.github.com)",
-      "WebFetch(domain:api.github.com)",
-      "WebFetch(domain:npmjs.org)",
-      "Edit(src/)",
-      "Edit(test/)",
-      "Read(.)"
+  "filesystem": {
+    "denyRead": [
+      "~/.ssh"
     ],
-    "deny": [
-      "Edit(.env)",
-      "Edit(config/production.json)",
-      "Read(~/.ssh)",
-      "WebFetch(domain:malicious.com)"
+    "allowWrite": [
+      ".",
+      "src/",
+      "test/",
+      "/tmp"
+    ],
+    "denyWrite": [
+      ".env",
+      "config/production.json"
     ]
-  }
+  },
+  "ignoreViolations": {
+    "*": ["/usr/bin", "/System"],
+    "git push": ["/usr/bin/nc"],
+    "npm": ["/private/tmp"]
+  },
+  "enableWeakerNestedSandbox": false
 }
 ```
 
 ### Configuration Options
 
-#### Sandbox Settings
+#### Network Configuration
 
-- `sandbox.enabled` - Enable/disable sandboxing (boolean)
-- `sandbox.network.allowUnixSockets` - Unix sockets that can be accessed (array of paths)
-- `sandbox.network.allowLocalBinding` - Allow binding to local ports (boolean)
-- `sandbox.network.httpProxyPort` - Port for your own HTTP proxy (default: uses built-in proxy)
-- `sandbox.network.socksProxyPort` - Port for your own SOCKS5 proxy (default: uses built-in proxy)
+- `network.allowedDomains` - Array of allowed domains (supports wildcards like `*.example.com`)
+- `network.deniedDomains` - Array of denied domains (takes precedence over allowedDomains)
+- `network.allowUnixSockets` - Array of Unix socket paths that can be accessed (macOS only)
+- `network.allowLocalBinding` - Allow binding to local ports (boolean, default: false)
 
-#### Permission Rules
+#### Filesystem Configuration
 
-Permission rules provide fine-grained control and use Claude Code's permission syntax:
-
-- `WebFetch(domain:example.com)` - Allow/deny network access to a domain
-- `Edit(path)` - Allow/deny file write access
-- `Read(path)` - Allow/deny file read access
+- `filesystem.denyRead` - Array of paths to deny read access
+- `filesystem.allowWrite` - Array of paths to allow write access (default: current working directory only)
+- `filesystem.denyWrite` - Array of paths to deny write access (takes precedence over allowWrite)
 
 **Path Syntax (macOS):**
 
@@ -283,32 +304,44 @@ Paths support git-style glob patterns on macOS, similar to `.gitignore` syntax:
 - `[abc]` - Matches any character in the set (e.g., `file[0-9].txt` matches `file3.txt`)
 
 Examples:
-- `Edit(src/)` - Allow write to entire `src/` directory
-- `Edit(src/**/*.ts)` - Allow write to all `.ts` files in `src/` and subdirectories
-- `Read(~/.ssh)` - Deny read to SSH directory
-- `Edit(.env)` - Deny write to `.env` file (even if current directory is allowed)
+- `"allowWrite": ["src/"]` - Allow write to entire `src/` directory
+- `"allowWrite": ["src/**/*.ts"]` - Allow write to all `.ts` files in `src/` and subdirectories
+- `"denyRead": ["~/.ssh"]` - Deny read to SSH directory
+- `"denyWrite": [".env"]` - Deny write to `.env` file (even if current directory is allowed)
 
 **Path Syntax (Linux):**
 
 **Linux currently does not support glob matching.** Use literal paths only:
-- `Edit(src/)` - Allow write to `src/` directory
-- `Read(/home/user/.ssh)` - Deny read to SSH directory
+- `"allowWrite": ["src/"]` - Allow write to `src/` directory
+- `"denyRead": ["/home/user/.ssh"]` - Deny read to SSH directory
 
 **All platforms:**
 - Paths can be absolute (e.g., `/home/user/.ssh`) or relative to the current working directory (e.g., `./src`)
 - `~` expands to the user's home directory
 
+#### Other Configuration
+
+- `ignoreViolations` - Object mapping command patterns to arrays of paths where violations should be ignored
+- `enableWeakerNestedSandbox` - Enable weaker sandbox mode for Docker environments (boolean, default: false)
+
 ### Common Configuration Recipes
 
 **Allow GitHub access** (all necessary endpoints):
 ```json
 {
-  "permissions": {
-    "allow": [
-      "WebFetch(domain:github.com)",
-      "WebFetch(domain:lfs.github.com)",
-      "WebFetch(domain:api.github.com)"
-    ]
+  "network": {
+    "allowedDomains": [
+      "github.com",
+      "*.github.com",
+      "lfs.github.com",
+      "api.github.com"
+    ],
+    "deniedDomains": []
+  },
+  "filesystem": {
+    "denyRead": [],
+    "allowWrite": ["."],
+    "denyWrite": []
   }
 }
 ```
@@ -316,17 +349,14 @@ Examples:
 **Restrict to specific directories:**
 ```json
 {
-  "permissions": {
-    "allow": [
-      "Edit(src/)",
-      "Edit(test/)",
-      "Read(.)"
-    ],
-    "deny": [
-      "Edit(.env)",
-      "Edit(secrets/)",
-      "Read(~/.ssh)"
-    ]
+  "network": {
+    "allowedDomains": [],
+    "deniedDomains": []
+  },
+  "filesystem": {
+    "denyRead": ["~/.ssh"],
+    "allowWrite": [".", "src/", "test/"],
+    "denyWrite": [".env", "secrets/"]
   }
 }
 ```
@@ -357,11 +387,25 @@ Watchman accesses files outside the sandbox boundaries, which will trigger permi
   - Ubuntu/Debian: `apt-get install socat`
   - Fedora: `dnf install socat`
   - Arch: `pacman -S socat`
+- **`python3` - REQUIRED for applying seccomp filters** (typically pre-installed on Linux)
+  - Ubuntu/Debian: `apt-get install python3`
+  - Fedora: `dnf install python3`
+  - Arch: `pacman -S python`
+  - **Note:** Python 3 is mandatory for Unix socket blocking security. To disable this security feature, set `allowAllUnixSockets: true` in your configuration.
 - `ripgrep` - Fast search tool for deny path detection
   - Ubuntu/Debian: `apt-get install ripgrep`
   - Fedora: `dnf install ripgrep`
   - Arch: `pacman -S ripgrep`
 
+**Optional Linux dependencies (for seccomp fallback):**
+
+The package includes pre-generated seccomp BPF filters for x86-64 and arm architectures. These dependencies are only needed if you are on a different architecture where pre-generated filters are not available:
+- `gcc` or `clang` - C compiler
+- `libseccomp-dev` - Seccomp library development files
+  - Ubuntu/Debian: `apt-get install gcc libseccomp-dev`
+  - Fedora: `dnf install gcc libseccomp-devel`
+  - Arch: `pacman -S gcc libseccomp`
+
 **macOS requires:**
 - `ripgrep` - Fast search tool for deny path detection
   - Install via Homebrew: `brew install ripgrep`
@@ -376,6 +420,15 @@ npm install
 # Build the project
 npm run build
 
+# Build seccomp binaries (requires Docker)
+npm run build:seccomp
+
+# Run tests
+npm test
+
+# Run integration tests
+npm run test:integration
+
 # Type checking
 npm run typecheck
 
@@ -386,6 +439,20 @@ npm run lint
 npm run format
 ```
 
+### Building Seccomp Binaries
+
+The pre-generated BPF filters are included in the repository, but you can rebuild them if needed:
+
+```bash
+npm run build:seccomp
+```
+
+This script uses Docker to cross-compile seccomp binaries for multiple architectures:
+- x64 (x86-64)
+- arm64 (aarch64)
+
+The script builds static generator binaries, generates the BPF filters (~104 bytes each), and stores them in `vendor/seccomp/x64/` and `vendor/seccomp/arm64/`. The generator binaries are removed to keep the package size small.
+
 ## Implementation Details
 
 ### Network Isolation Architecture
@@ -420,6 +487,31 @@ Filesystem restrictions are enforced at the OS level:
 
 This model lets you start with broad read access but tightly controlled write access, then refine both as needed.
 
+### Unix Socket Restrictions (Linux)
+
+On Linux, the sandbox uses **seccomp BPF (Berkeley Packet Filter)** to block Unix domain socket creation at the syscall level. This provides an additional layer of security to prevent processes from creating new Unix domain sockets for local IPC (unless explicitly allowed).
+
+**How it works:**
+
+1. **Pre-generated BPF filters**: The package includes pre-compiled BPF filters for different architectures (x64, ARM64). These are ~104 bytes each and stored in `vendor/seccomp/`. The filters are architecture-specific but libc-independent, so they work with both glibc and musl.
+
+2. **Runtime detection**: The sandbox automatically detects your system's architecture and loads the appropriate pre-generated BPF filter.
+
+3. **Syscall filtering**: The BPF filter intercepts the `socket()` syscall and blocks creation of `AF_UNIX` sockets by returning `EPERM`. This prevents sandboxed code from creating new Unix domain sockets.
+
+4. **Two-stage application using Python helper script**:
+   - Outer bwrap creates the sandbox with filesystem, network, and PID namespace restrictions
+   - Network bridging processes (socat) start inside the sandbox (need Unix sockets)
+   - Python helper script (apply-seccomp-and-exec.py) applies the seccomp filter via `prctl()`
+   - Python script execs the user command with seccomp active
+   - User command runs with all sandbox restrictions plus Unix socket creation blocking
+
+**Security limitations**: The filter only blocks `socket(AF_UNIX, ...)` syscalls. It does not prevent operations on Unix socket file descriptors inherited from parent processes or passed via `SCM_RIGHTS`. For most sandboxing scenarios, blocking socket creation is sufficient to prevent unauthorized IPC.
+
+**Minimal runtime dependencies**: Unlike traditional seccomp implementations that require `gcc`, `clang`, and `libseccomp-dev` at runtime, this approach bundles pre-generated BPF filters and uses a Python helper script with standard library `ctypes` to apply them via `prctl()`, eliminating compilation dependencies for end users. Requires Python 3 (typically already installed on Linux systems).
+
+**Fallback mechanism**: If a pre-generated filter isn't available for your platform, the sandbox can fall back to runtime compilation (requires `gcc/clang` and `libseccomp-dev`).
+
 ### Violation Detection and Monitoring
 
 When a sandboxed process attempts to access a restricted resource:
@@ -461,17 +553,10 @@ For more sophisticated network filtering, you can configure the sandbox to use y
 ```bash
 # Start mitmproxy with custom filtering script
 mitmproxy -s custom_filter.py --listen-port 8888
-
-# Configure sandbox to use your proxy
-{
-  "sandbox": {
-    "network": {
-      "httpProxyPort": 8888
-    }
-  }
-}
 ```
 
+Note: Custom proxy configuration is not yet supported in the new configuration format. This feature will be added in a future release.
+
 **Important security consideration:** Even with domain allowlists, exfiltration vectors may exist. For example, allowing `github.com` lets a process push to any repository. With a custom MITM proxy and proper certificate setup, you can inspect and filter specific API calls to prevent this.
 
 ### Security Limitations