convergence-sandbox 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. convergence_sandbox-0.1.0/LICENSE +201 -0
  2. convergence_sandbox-0.1.0/PKG-INFO +262 -0
  3. convergence_sandbox-0.1.0/README.md +235 -0
  4. convergence_sandbox-0.1.0/pyproject.toml +125 -0
  5. convergence_sandbox-0.1.0/pyproject.toml.orig +106 -0
  6. convergence_sandbox-0.1.0/src/convergence/__init__.py +15 -0
  7. convergence_sandbox-0.1.0/src/convergence/__main__.py +5 -0
  8. convergence_sandbox-0.1.0/src/convergence/api.py +74 -0
  9. convergence_sandbox-0.1.0/src/convergence/cli.py +558 -0
  10. convergence_sandbox-0.1.0/src/convergence/generate/__init__.py +1 -0
  11. convergence_sandbox-0.1.0/src/convergence/generate/elf.py +53 -0
  12. convergence_sandbox-0.1.0/src/convergence/generate/explain.py +305 -0
  13. convergence_sandbox-0.1.0/src/convergence/generate/policy.py +591 -0
  14. convergence_sandbox-0.1.0/src/convergence/importers/__init__.py +1 -0
  15. convergence_sandbox-0.1.0/src/convergence/importers/divergence.py +224 -0
  16. convergence_sandbox-0.1.0/src/convergence/kernel/__init__.py +6 -0
  17. convergence_sandbox-0.1.0/src/convergence/kernel/_libc.py +74 -0
  18. convergence_sandbox-0.1.0/src/convergence/kernel/landlock.py +335 -0
  19. convergence_sandbox-0.1.0/src/convergence/kernel/seccomp.py +309 -0
  20. convergence_sandbox-0.1.0/src/convergence/mcp/__init__.py +1 -0
  21. convergence_sandbox-0.1.0/src/convergence/mcp/helper.py +196 -0
  22. convergence_sandbox-0.1.0/src/convergence/mcp/server.py +366 -0
  23. convergence_sandbox-0.1.0/src/convergence/observe/__init__.py +1 -0
  24. convergence_sandbox-0.1.0/src/convergence/observe/driver.py +182 -0
  25. convergence_sandbox-0.1.0/src/convergence/observe/model.py +102 -0
  26. convergence_sandbox-0.1.0/src/convergence/observe/trace.py +256 -0
  27. convergence_sandbox-0.1.0/src/convergence/policy/__init__.py +1 -0
  28. convergence_sandbox-0.1.0/src/convergence/policy/baseline.py +149 -0
  29. convergence_sandbox-0.1.0/src/convergence/policy/enforce.py +597 -0
  30. convergence_sandbox-0.1.0/src/convergence/policy/load.py +191 -0
  31. convergence_sandbox-0.1.0/src/convergence/policy/model.py +274 -0
  32. convergence_sandbox-0.1.0/src/convergence/policy/paths.py +148 -0
  33. convergence_sandbox-0.1.0/src/convergence/policy/rights.py +68 -0
  34. convergence_sandbox-0.1.0/src/convergence/policy/validate.py +386 -0
  35. convergence_sandbox-0.1.0/src/convergence/probe/__init__.py +48 -0
  36. convergence_sandbox-0.1.0/src/convergence/probe/child.py +119 -0
  37. convergence_sandbox-0.1.0/src/convergence/probe/facts.py +156 -0
  38. convergence_sandbox-0.1.0/src/convergence/probe/live.py +566 -0
  39. convergence_sandbox-0.1.0/src/convergence/probe/report.py +449 -0
  40. convergence_sandbox-0.1.0/src/convergence/py.typed +0 -0
  41. convergence_sandbox-0.1.0/src/convergence/runtime/__init__.py +1 -0
  42. convergence_sandbox-0.1.0/src/convergence/runtime/child.py +262 -0
  43. convergence_sandbox-0.1.0/src/convergence/runtime/denials.py +212 -0
  44. convergence_sandbox-0.1.0/src/convergence/runtime/filters.py +264 -0
  45. convergence_sandbox-0.1.0/src/convergence/runtime/plan.py +381 -0
  46. convergence_sandbox-0.1.0/src/convergence/runtime/record.py +140 -0
  47. convergence_sandbox-0.1.0/src/convergence/runtime/supervisor.py +472 -0
  48. convergence_sandbox-0.1.0/src/convergence/runtime/tracer.py +158 -0
  49. convergence_sandbox-0.1.0/src/convergence/schemas.py +108 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Vignesh Chaturvedi
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,262 @@
1
+ Metadata-Version: 2.4
2
+ Name: convergence-sandbox
3
+ Version: 0.1.0
4
+ Summary: Least-privilege sandboxing for AI agent tools on Linux: Landlock and seccomp policies generated from observed behaviour.
5
+ Keywords: sandbox,landlock,seccomp,mcp,agent,security,least-privilege
6
+ Author: Vignesh Chaturvedi
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Environment :: Console
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Operating System :: POSIX :: Linux
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Security
17
+ Classifier: Typing :: Typed
18
+ Requires-Dist: pydantic>=2.12,<3
19
+ Requires-Dist: pyyaml>=6.0.2,<7
20
+ Requires-Dist: mcp>=2.3.0 ; extra == 'mcp'
21
+ Requires-Python: >=3.12
22
+ Project-URL: Homepage, https://github.com/vignesh-chaturvedi/convergence
23
+ Project-URL: Repository, https://github.com/vignesh-chaturvedi/convergence
24
+ Project-URL: Changelog, https://github.com/vignesh-chaturvedi/convergence/blob/main/CHANGELOG.md
25
+ Provides-Extra: mcp
26
+ Description-Content-Type: text/markdown
27
+
28
+ # Convergence
29
+
30
+ Convergence runs AI agent tools (MCP servers, agent skills, model-generated scripts) under a
31
+ least-privilege policy that the Linux kernel enforces. It uses Landlock, seccomp-bpf,
32
+ `no_new_privs`, and resource limits, needs no root and no namespaces, and runs on a stock
33
+ Ubuntu 24.04 kernel.
34
+
35
+ It can also write the policy for you from what a tool actually did, the way SELinux's
36
+ `audit2allow` does. Every rule says which observed event justified it.
37
+
38
+ It is the companion to [Divergence](https://github.com/vignesh-chaturvedi/divergence).
39
+ Divergence reports the gap between what an MCP server declares and what it does;
40
+ Convergence contains what it does.
41
+
42
+ > **Status: 0.1.0, the first release.** Every claim below comes from tests and measurements
43
+ > in this repository, on real kernels. Nothing here has been independently audited. Do not
44
+ > make it your only protection for code you do not trust.
45
+
46
+ ## Quickstart
47
+
48
+ ```bash
49
+ pip install convergence-sandbox # add [mcp] for the MCP server
50
+ convergence doctor # what this kernel can enforce, proven live
51
+ ```
52
+
53
+ A policy lists what a tool may do; everything else is denied
54
+ ([reference](docs/policy.md), [examples](examples/policies/)):
55
+
56
+ ```yaml
57
+ version: 1
58
+ filesystem:
59
+ read: [/usr, /etc/ld.so.cache, "${CWD}"]
60
+ write: ["${SCRATCH}"]
61
+ execute: [/usr/bin/python3.12, /lib64/ld-linux-x86-64.so.2]
62
+ network: {tcp_connect: [443]}
63
+ resources: {wall_clock_seconds: 60}
64
+ environment: {set: {PATH: /usr/bin, HOME: "${SCRATCH}"}}
65
+ ```
66
+
67
+ ```bash
68
+ convergence explain --policy policy.yaml # how this kernel enforces each rule
69
+ convergence run --policy policy.yaml -- python3 tool.py
70
+ ```
71
+
72
+ Or let Convergence write the policy:
73
+
74
+ ```bash
75
+ convergence observe --out obs.json -- python3 tool.py # NOT a sandbox: use a disposable VM
76
+ convergence generate --from obs.json --out policy.yaml
77
+ convergence run --trace --policy policy.yaml -- python3 tool.py
78
+ convergence explain --run <run id> # why something was denied, and the fix
79
+ ```
80
+
81
+ ## What is enforced
82
+
83
+ | Mechanism | What it does |
84
+ |---|---|
85
+ | **Landlock** | Files: read, write, and execute only where granted. TCP ports from ABI 4, UDP from ABI 10, signals and abstract unix sockets scoped to the sandbox from ABI 6 |
86
+ | **seccomp-bpf** | Denies escape- and tamper-prone syscalls: `ptrace`, `process_vm_*`, `mount`, `unshare`, namespace flags on `clone`, `io_uring`, `bpf`, `perf_event_open`, `userfaultfd`, keyrings, `TIOCSTI`, and more. Allows only the socket families, types, and protocols the policy grants. Not user notification, which is never used as a boundary |
87
+ | **`no_new_privs`** | setuid and file-capability binaries gain nothing |
88
+ | **rlimits** | CPU, memory, file size, open files, processes; core dumps off |
89
+ | **The supervisor** | Builds the environment from the policy alone and closes inherited descriptors. When the tool's first process exits, or at the wall clock, it kills everything the tool started, including daemons that left the session |
90
+
91
+ Convergence refuses a policy the running kernel cannot fully enforce, unless you pass
92
+ `--allow-degraded`, and then it lists exactly what is degraded. Each run leaves a JSON
93
+ record. Design: [THREAT_MODEL.md](THREAT_MODEL.md) and the [ADRs](docs/adr/).
94
+
95
+ ## What is not enforced
96
+
97
+ These are documented, measured where possible, and not hidden:
98
+
99
+ - **Hosts.** Landlock filters by port, not host: `tcp_connect: [443]` allows HTTPS to every
100
+ host.
101
+ - **Code the tool can read.** Execute grants limit which programs the kernel starts. They
102
+ do not stop the dynamic loader running a file the tool can only read. This is the one
103
+ escape the matrix found, in development and in the holdout; whatever runs that way stays
104
+ inside the sandbox.
105
+ - **Older kernels.** Below Landlock ABI 6, the tool can signal other processes of the same
106
+ user. Below ABI 9, unix sockets cannot be limited to the sandbox, so they are denied
107
+ altogether.
108
+ - **File metadata.** `stat`, `chmod`, `chown`, and `utime` are outside Landlock's control.
109
+ - **A supervisor killed with `SIGKILL`.** The tool dies with it, but processes it started
110
+ can outlive it.
111
+ - **Kernel exploits, side channels, and misuse of what the policy grants.**
112
+ - **`observe` and `--trace`** run strace with your access. `observe` is not a sandbox at
113
+ all.
114
+
115
+ ## Results
116
+
117
+ All measured on real kernels, with no mocks. Rates carry Wilson 95% intervals.
118
+
119
+ **The escape matrix** ([report](escape/results/README.md)). Attacks are judged by external
120
+ oracles: canary files, network sinks, sentinel processes, the process table. Every attack is
121
+ first proven to escape with no sandbox.
122
+
123
+ | Set | Kernel | Escape rate | Other outcomes |
124
+ |---|---|---|---|
125
+ | 47 development attacks | stock Ubuntu 24.04, 6.8 (ABI 4) | 1/44 (2.3%; 0.4–11.8%) | 1 needs ABI 6; 2 not testable on that host |
126
+ | 47 development attacks | Linux 7.0 (ABI 8), 3 CI runners | 1/45 (2.2%; 0.4–11.6%) | 2 not testable |
127
+ | **26 holdout attacks**, sealed, written independently, run once | stock Ubuntu 24.04, 6.8 | **1/22 (4.5%; 0.8–21.8%)** | 1 needs ABI 6; 3 proved nothing either way |
128
+
129
+ Every escape is the dynamic-loader limitation above.
130
+
131
+ **False denials**, on 10 benign workloads: git, tar, sqlite, an HTTP client and server,
132
+ shell pipelines, and more.
133
+
134
+ | Policy | False-denial rate |
135
+ |---|---|
136
+ | Hand-written | 0/10 (0.0%; 0.0–27.8%) |
137
+ | Generated from one observation, same input | 0/10 (0.0%; 0.0–27.8%) |
138
+ | Generated from one observation, different input | 3/10 (30%; 10.8–60.3%) |
139
+
140
+ The last row is how incomplete a single observation is. Observe a tool on the inputs it will
141
+ really get.
142
+
143
+ ## What it costs
144
+
145
+ <!-- benchmarks:start -->
146
+ Generated from [`benchmarks/results/lima-ubuntu-24.04-ga-aarch64.json`](benchmarks/results/lima-ubuntu-24.04-ga-aarch64.json) by `benchmarks/bench.py`: development VM (Apple M2, Lima vz), 4 CPUs, kernel 6.8.0-134-generic (aarch64). Wall-clock time to start the workload and see it exit; p50 (p95) in milliseconds over 200 runs.
147
+
148
+ | Configuration | `true` p50 (p95) ms | `python` p50 (p95) ms | `wordcount` p50 (p95) ms |
149
+ |---|---:|---:|---:|
150
+ | no sandbox (`subprocess`) | 0.21 (0.27) | 7.72 (8.91) | 16.65 (18.48) |
151
+ | `sudo -n true` (inside every Docker row) | 2.64 (3.74) | 2.6 (3.19) | 2.66 (3.84) |
152
+ | Convergence, library API, warm | 7.89 (10.62) | 16.41 (21.06) | 26.83 (32.78) |
153
+ | Convergence, library API, warm, `--trace` | 23.09 (26.58) | 67.03 (74.55) | 82.47 (92.23) |
154
+ | Convergence, one MCP `run_sandboxed` call | 8.64 (11.03) | 16.84 (20.41) | 26.6 (34.02) |
155
+ | Convergence CLI, cold process | 114.37 (127.58) | 122.65 (135.06) | 132.79 (147.29) |
156
+ | bubblewrap | n/a | n/a | n/a |
157
+ | `docker run --rm`, warm | 106.64 (139.13) | 116.17 (139.36) | 138.15 (171.59) |
158
+ | `docker run --rm`, cold daemon and cache | 151.08 (200.74) | 161.39 (193.82) | 195.47 (348.86) |
159
+
160
+ n/a: bwrap cannot run here: bwrap: loopback: Failed RTM_NEWADDR: Operation not permitted
161
+ <!-- benchmarks:end -->
162
+
163
+ - **What the rows include.** Each Docker row includes `sudo`, which has its own row. The
164
+ cold CLI row includes starting Python.
165
+ - **A warm call**, through the library API or MCP, costs one fork and the sandbox setup.
166
+ - **bubblewrap** cannot run unprivileged on stock Ubuntu 24.04, on the VM or on GitHub's
167
+ runner: AppArmor restricts the user namespaces it needs.
168
+ - **Method:** [ADR 0011](docs/adr/0011-benchmark-method.md). An x86_64 run on a GitHub
169
+ runner is in [benchmarks/](benchmarks/README.md).
170
+
171
+ ## Commands
172
+
173
+ | Command | Does |
174
+ |---|---|
175
+ | `doctor` | Proves what this kernel can enforce, using each feature in a throwaway child |
176
+ | `validate POLICY` | Checks the schema, the paths, the syscall names, and risky grants |
177
+ | `explain --policy POLICY` | Shows how this kernel enforces each rule: `enforced`, `partial`, or `unenforceable` |
178
+ | `run --policy POLICY -- CMD` | Runs CMD sandboxed. `--trace` records which rule denied each failed operation |
179
+ | `observe -- CMD` | Records what CMD does under strace. **Not a sandbox** |
180
+ | `generate --from OBS` | Writes the smallest policy for an observation, with a reason per rule |
181
+ | `explain --run ID` | For each denial: the cause, the rule, the smallest fix as a YAML diff, and the risk |
182
+ | `import divergence REPORT` | Turns a Divergence dynamic-tier report into a partial observation |
183
+ | `mcp --policies DIR` | Serves `run_sandboxed`, `check_policy`, `generate_policy`, and `explain_denials` over MCP |
184
+
185
+ `run` exits with the tool's own status, or 128+N for signal N, 124 at the wall clock, 125
186
+ when the tool was not started, 126 when it could not execute, and 127 when it was not found.
187
+
188
+ ### For agents: `convergence mcp`
189
+
190
+ ```bash
191
+ pip install 'convergence-sandbox[mcp]'
192
+ convergence mcp --policies ./policies
193
+ ```
194
+
195
+ - **The operator chooses the policies, not the agent.** A client can only name a policy in
196
+ `--policies`, unless the server is started with `--allow-inline-policy`.
197
+ - **Commands are argv lists**, never shell strings.
198
+ - **`observe`**, which runs commands unconfined, exists only with `--allow-observe`
199
+ ([ADR 0010](docs/adr/0010-mcp-server.md)).
200
+
201
+ From Python, `convergence.api.Sandbox` runs commands through the same warm helper.
202
+
203
+ ## Prior art
204
+
205
+ Checked against each project's own repository on 2026-11-12:
206
+
207
+ - **[sandlock](https://github.com/multikernel/sandlock)** (Apache-2.0) is the closest. It
208
+ uses Landlock, seccomp-bpf, and seccomp user notification. It needs Linux 6.12 or later
209
+ (Landlock ABI 6). It has `sandlock learn`, which turns observed behaviour into a profile,
210
+ and an MCP integration. Convergence differs in four ways:
211
+ - it runs on the stock 24.04 kernel (ABI 4);
212
+ - it never relies on user notification for enforcement, because of time-of-check races on
213
+ pointer arguments;
214
+ - every generated rule cites the observations behind it;
215
+ - it publishes an escape matrix with a sealed holdout.
216
+ - **[bubblewrap](https://github.com/containers/bubblewrap)** isolates with namespaces. It
217
+ needs unprivileged user namespaces, which stock Ubuntu 24.04 restricts through AppArmor
218
+ (measured above).
219
+ - **OpenAI [Codex CLI](https://github.com/openai/codex)** sandboxes commands with bubblewrap
220
+ and seccomp on Linux, keeping a legacy Landlock path, and with Seatbelt on macOS. It warns
221
+ when bubblewrap cannot create user namespaces.
222
+ - **Anthropic's [sandbox-runtime](https://github.com/anthropic-experimental/sandbox-runtime)**
223
+ is used by Claude Code and can also wrap MCP servers. It uses bubblewrap on Linux and
224
+ `sandbox-exec` on macOS, with proxy-based network filtering.
225
+
226
+ ## With Divergence
227
+
228
+ [Divergence](https://github.com/vignesh-chaturvedi/divergence) runs an MCP server or skill
229
+ inside its own sandbox and reports what it touched. `convergence import divergence` turns
230
+ that report into an observation, so a policy can be generated without ever running the tool
231
+ unconfined:
232
+
233
+ ```bash
234
+ convergence observe --out runtime.json -- python3 -c pass # the interpreter's own needs
235
+ convergence import divergence report.json --baseline runtime.json --out obs.json
236
+ convergence generate --from obs.json --out policy.yaml
237
+ ```
238
+
239
+ - **Decoys, secrets, and blocked attempts** are never granted.
240
+ - **The import is always partial.** Divergence drops runtime noise on purpose, which is why
241
+ the runtime baseline is merged in.
242
+
243
+ ## Development
244
+
245
+ Enforcement is Linux-only, and every security test runs against a real kernel. On macOS,
246
+ development uses a [Lima](https://lima-vm.io) VM with Ubuntu 24.04, never Docker Desktop
247
+ ([ADR 0001](docs/adr/0001-python-on-kernel-primitives-tested-on-real-kernels.md)). CI runs
248
+ everything on GitHub's x86_64 and arm64 runners, and on the stock 24.04 kernel in a nested
249
+ VM.
250
+
251
+ ```bash
252
+ scripts/vm.sh create # macOS only: create and start the VM
253
+ scripts/vm.sh provision # install the pinned toolchain (uv) inside Linux
254
+ scripts/vm.sh check # lint, format check, type check, and tests inside Linux
255
+ ```
256
+
257
+ How the project was built, phase by phase: [PLAN.md](PLAN.md).
258
+ Changes: [CHANGELOG.md](CHANGELOG.md).
259
+
260
+ ## License
261
+
262
+ [Apache License 2.0](LICENSE).