Skip to content

Repository files navigation

sandtrap ⛳

A local Python sandbox using AST rewriting and compiled bytecode execution. Whitelist-based policies control attribute access, imports, and resource usage. Designed as a walled garden for cooperative code (e.g. agent-generated scripts), not for adversarial inputs.

Three isolation levels via the sandbox() factory:

  • "none" (default) -- in-process, lightweight, shares the host's memory space
  • "process" -- subprocess-backed, crash protection, no kernel restrictions
  • "kernel" -- subprocess + kernel-level isolation (seccomp, Landlock, Seatbelt)

Install

pip install sandtrap

That covers "none" and "process" on every platform, and "kernel" on macOS (Seatbelt ships with the OS). Kernel mode on Linux needs seccomp and Landlock bindings:

pip install sandtrap[kernel]

Quick start

In-process (default)

from sandtrap import Policy, sandbox

policy = Policy(timeout=5.0, tick_limit=100_000)

with sandbox(policy) as sb:
    result = sb.exec("""
total = sum(range(10))
print(f"total = {total}")
""")

print(result.stdout)       # "total = 45\n"
print(result.namespace)    # {"total": 45}
print(result.error)        # None
print(result.ticks)        # 2 (fn calls: sum + print)

Handing code a module

namespace gives code bare names; modules gives it whole modules, for one call only:

with sandbox(policy) as sb:
    result = sb.exec("""
import host
from host import db

rows = db.query("select 1")
""", modules={"host": {"db": db, "VERSION": 3}})

The module resolves for that exec() and is gone when it returns, so the next call sees only the modules it passes. Sandboxed code can read every name you put there and write none of them. See per-exec modules.

In a worker process

from sandtrap import Policy, IsolatedFS, sandbox

policy = Policy(timeout=5.0, tick_limit=100_000)

with sandbox(policy, isolation="process", filesystem=IsolatedFS("/tmp/sandbox")) as sb:
    result = sb.exec("""
total = sum(range(10))
print(f"total = {total}")
""")

print(result.stdout)       # "total = 45\n"
print(result.namespace)    # {"total": 45}

Swap isolation="kernel" for the same thing plus kernel-level restrictions.

Worker-backed isolation

"process" and "kernel" both run code in a separate worker. What that buys, and what it asks of you:

  • A crash stays contained. A segfault or OOM in a C extension costs the call, not your process.
  • The worker inherits nothing — not your memory, not your threads. It is forked from a dedicated broker, so a multi-threaded host can't deadlock it (how workers are created).
  • "kernel" adds a real boundary: filesystem restricted to the IsolatedFS root via Landlock (Linux) or Seatbelt (macOS), syscall filtering via seccomp or Seatbelt, and network blocked at the kernel level unless the policy enables it.
  • Your policy must be serializable, since it is sent rather than inherited. Module grants, module-level functions, and classes cross by name and need nothing; lambdas, closures, bound methods, and classes defined inside a function don't. sandbox() checks at construction and raises StPolicyNotPortable listing every problem at once, rather than surfacing pickle's first failure later from inside a worker — see checking a policy is portable, or pass start_method="fork" to keep inheriting memory and accept the deadlock hazard above.
  • Your entry point must be importable. A worker that inherits no memory re-imports __main__, so module-level work there needs an if __name__ == "__main__": guard — and a host run as python -c, from a REPL, or from a piped heredoc has no importable __main__ at all. Run the example above from a file. Servers are unaffected: an ASGI app is imported, not executed as __main__.
  • Workers cost more than a fork. Each re-imports your granted modules rather than inheriting them: ~18ms for a stdlib policy, but ~235ms and ~113MB once a heavyweight stack is granted. preload_grants=True trades that back to ~14ms and ~29MB where your grants are safe to import in the broker (the numbers).

Kernel mode is defense-in-depth — a second layer that contains accidental or casual escape (a buggy agent's stray network call, a walk outside the root) under the cooperative-code Python sandbox. It is not a boundary against code actively trying to escape: the inner Python layer isn't adversarial-safe, and the worker→host IPC uses pickle. See the security model for the full picture and the roadmap for hardening plans.

The concrete job it does is C extensions. A C library reaches the OS through syscalls, not through the Python functions sandtrap patches, so an open() inside sqlite3 or a C parser never meets the VFS interception — Landlock or Seatbelt is the only thing between it and the real filesystem, and seccomp is the only thing stopping a granted library from spawning a process. That is worth having under cooperative code, and it is still not an adversarial boundary.

If the platform can't apply the requested kernel restrictions (missing sandtrap[kernel] packages, Landlock-less kernel, unsupported OS), isolation="kernel" fails closed — it raises IsolationUnavailable rather than silently running with no protection. Pass allow_degraded=True to proceed anyway; inspect result.isolation to see exactly what took effect.

Part of the agex stack

sandtrap powers sandboxed code execution in agex, where AI agents write and execute Python directly against host libraries. Filesystem interception is provided by monkeyfs.

Documentation

License

MIT

About

Local Python Sandbox

Topics

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages