sandlock 0.1.0__tar.gz

sandlock-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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
+
+   Copyright 2026 Multikernel Technologies, Inc.
+
+   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.

sandlock-0.1.0/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: sandlock
+Version: 0.1.0
+Summary: Lightweight process sandbox using Landlock, seccomp, and seccomp user notification
+Author-email: Cong Wang <cwang@multikernel.io>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/multikernel/sandlock
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tomli>=1.0; python_version < "3.11"
+Dynamic: license-file
+
+# Sandlock
+
+Lightweight process sandbox for Linux. Confines untrusted code using
+**Landlock** (filesystem + network + IPC), **seccomp-bpf** (syscall filtering),
+and **seccomp user notification** (resource limits, IP enforcement, /proc
+virtualization). No root, no cgroups, no containers.
+
+```
+sandlock run -w /tmp -r /usr -m 512M -- python3 untrusted.py
+```
+
+## Why Sandlock?
+
+Containers and VMs are powerful but heavy. Sandlock targets the gap: strict
+confinement without image builds, overlay filesystems, or root privileges.
+
+| Feature | Sandlock | Container | MicroVM (Firecracker) | gVisor |
+|---|---|---|---|---|
+| Root required | No | Yes* | Yes (KVM) | Yes |
+| Image build | No | Yes | Yes | Yes |
+| Startup time | ~1 ms (fork) | ~200 ms | ~100 ms | ~100 ms |
+| Kernel | Shared | Shared | Separate guest | Shared (sentry) |
+| Filesystem isolation | Landlock | Overlay | Block-level (QCOW2) | ptrace/KVM |
+| Network isolation | Landlock + seccomp notif | Network namespace | TAP device | Sentry kernel |
+| Syscall filtering | seccomp-bpf | seccomp | N/A (full kernel) | Sentry kernel |
+| Resource limits | seccomp notif + rlimit | cgroup v2 | VM config | cgroup v2 |
+| Memory sharing | COW (fork), zero-copy | Bind-mount + re-init | Shared mem (explicit) | N/A |
+| Nesting | Native (fork) | Complex (DinD/DooD) | Not supported | Supported |
+| Checkpoint/restore | ptrace + BranchFS | CRIU | VM snapshot | N/A |
+
+\* Rootless containers exist but require user namespace support, `/etc/subuid` configuration, and `fuse-overlayfs`.
+
+## Requirements
+
+- **Linux 5.13+** (Landlock ABI v1), **Python 3.10+**
+- No root, no cgroups, no C compiler (all kernel interfaces via ctypes)
+
+| Feature | Minimum kernel |
+|---|---|
+| seccomp user notification | 5.6 |
+| Landlock filesystem rules | 5.13 |
+| Landlock TCP port rules | 6.7 (ABI v4) |
+| Landlock IPC scoping | 6.12 (ABI v6) |
+
+## Quick Start
+
+### CLI
+
+```bash
+# Basic confinement
+sandlock run -r /usr -r /lib -w /tmp -- ls /tmp
+
+# Interactive shell
+sandlock run -i -r /usr -r /lib -r /lib64 -r /bin -r /etc -w /tmp -- /bin/sh
+
+# Resource limits + timeout
+sandlock run -m 512M -P 20 -t 30 -- ./compute.sh
+
+# Domain-based network isolation
+sandlock run --net-allow-host api.openai.com -r /usr -r /lib -r /etc -- python3 agent.py
+
+# TCP port restrictions (Landlock)
+sandlock run --net-bind 8080 --net-connect 443 -r /usr -r /lib -r /etc -- python3 server.py
+
+# IPC scoping + clean environment
+sandlock run --isolate-ipc --isolate-signals --clean-env --env CC=gcc \
+  -r /usr -r /lib -w /tmp -- make
+
+# Use a saved profile (CLI flags override profile values)
+sandlock run -p build -- make -j4
+sandlock run -p build --max-memory 1G -- make
+
+# Profile management
+sandlock profile list
+sandlock profile show build
+```
+
+### Profiles
+
+Save reusable policies as TOML files in `~/.config/sandlock/profiles/`:
+
+```toml
+# ~/.config/sandlock/profiles/build.toml
+fs_writable = ["/tmp/work"]
+fs_readable = ["/usr", "/lib", "/lib64", "/bin", "/etc"]
+clean_env = true
+isolate_ipc = true
+max_memory = "512M"
+max_processes = 50
+
+[env]
+CC = "gcc"
+LANG = "C.UTF-8"
+```
+
+Field names match `Policy` exactly. Unknown fields are rejected. CLI flags override profile values.
+
+### Python API
+
+```python
+from sandlock import Sandbox, Policy
+
+policy = Policy(
+    fs_writable=["/tmp/sandbox"],
+    fs_readable=["/usr", "/lib", "/etc"],
+    max_memory="256M",
+    max_processes=10,
+    isolate_ipc=True,
+    clean_env=True,
+    env={"LANG": "C.UTF-8"},
+)
+
+# Run a command
+result = Sandbox(policy).run(["python3", "-c", "print('hello')"])
+
+# Run a Python function
+result = Sandbox(policy).call(lambda: sum(range(1_000_000)))
+print(result.value)  # 499999500000
+
+# Use a saved TOML profile
+result = Sandbox("build").run(["make", "-j4"])
+```
+
+Long-lived and nested sandboxes:
+
+```python
+with Sandbox(policy) as sb:
+    sb.exec(["python3", "server.py"])
+    sb.pause()       # Freeze all processes atomically
+    sb.resume()
+    sb.update(max_memory="128M")  # Adjust limits live
+    exit_code = sb.wait(timeout=30)
+
+# Nested: child inherits parent's constraints
+with Sandbox(parent_policy) as parent:
+    result = parent.sandbox(child_policy).call(untrusted_fn)
+```
+
+## Architecture
+
+Sandlock applies confinement in sequence after `fork()`:
+
+```
+Parent                              Child
+  │  fork()                           │
+  │──────────────────────────────────>│
+  │                                   ├─ 1. setpgid(0,0)
+  │                                   ├─ 2. unshare(NEWUSER) (if privileged)
+  │                                   ├─ 3. RLIMIT_CPU (if max_cpu)
+  │                                   ├─ 4. chroot (optional)
+  │                                   ├─ 5. Landlock (fs + net + IPC, irreversible)
+  │                                   ├─ 6. Combined seccomp filter (irreversible)
+  │                                   │     └─ send notify fd ──────> Parent
+  │  receive notify fd                ├─ 7. Close fds 3+
+  │  start supervisor thread          ├─ 8. Environment (clean_env + env)
+  │  pidfd_open() + poll()            └─ 9. exec(cmd) or target()
+```
+
+Each layer is **defense-in-depth**: bypassing one doesn't defeat the others.
+
+### Landlock: Filesystem + Network + IPC
+
+[Landlock](https://landlock.io) restricts filesystem, network, and IPC
+access without root. Rules are applied via `landlock_restrict_self()` and
+are **irreversible**.
+
+```python
+Policy(
+    fs_writable=["/tmp/work"],
+    fs_readable=["/usr", "/lib"],        # ABI v1+: filesystem
+    net_bind=[8080],                      # ABI v4+: TCP ports
+    net_connect=[443, "5432"],
+    isolate_ipc=True,                     # ABI v6+: block abstract UNIX sockets to host
+    isolate_signals=True,                 # ABI v6+: block signals to host processes
+)
+```
+
+### seccomp-bpf: Syscall Filtering
+
+A cBPF filter blocks dangerous syscalls at the kernel entry point:
+`ptrace`, `mount`, `unshare`, `setns`, `kexec_load`, `bpf`, `perf_event_open`,
+`ioperm`/`iopl`, and more. Argument-level filtering blocks namespace flags
+in `clone`/`clone3` and `TIOCSTI` in `ioctl`. Supports **x86_64** and **aarch64**.
+
+### Resource Limits
+
+Enforced via **seccomp user notification** and **rlimit** — no cgroups or root required.
+
+| Resource | Mechanism | Enforcement |
+|---|---|---|
+| Memory | seccomp notif on `mmap`/`munmap`/`brk`/`mremap` | `ENOMEM` when over budget |
+| Processes | seccomp notif on `clone`/`fork`/`vfork` | `EAGAIN` when at limit |
+| CPU | `RLIMIT_CPU` per-process | `SIGXCPU` → `SIGKILL` |
+
+### Network: Domain-Based Access Control
+
+Specify allowed hostnames — everything else is blocked:
+
+```python
+Policy(net_allow_hosts=["api.openai.com", "github.com"])
+```
+
+Two cooperating layers: (1) `/etc/hosts` virtualization via seccomp notif
+(programs see clean "host not found" for unlisted domains), and (2) `connect()`/`sendto()`
+IP enforcement (blocks hardcoded IPs, raw DNS over UDP, etc.).
+
+### /proc and /sys Virtualization
+
+Seccomp user notification intercepts `open()`/`openat()` for path-based rules.
+Three actions: **ALLOW** (continue), **DENY** (return `-EACCES`), **VIRTUALIZE**
+(inject `memfd` with fake content). Auto-enabled when `-r /proc` is passed.
+
+Denies: `/proc/kcore`, `/proc/kallsyms`, `/proc/keys`, `/sys/kernel/`, `/sys/firmware/`.
+Virtualizes: `/proc/self/mounts`, `/proc/self/mountinfo`.
+PID isolation: blocks access to `/proc/<foreign_pid>/`.
+
+### BranchFS: Copy-on-Write Filesystem
+
+With `fs_isolation=BRANCHFS`, sandbox writes go to an isolated COW branch
+on a [BranchFS](https://github.com/user/branchfs) FUSE mount. Writes are
+committed on success, discarded on failure. Nested sandboxes create child branches.
+
+```python
+Policy(
+    fs_isolation=FsIsolation.BRANCHFS,
+    fs_mount="/mnt/workspace",
+    on_exit=BranchAction.COMMIT,
+    on_error=BranchAction.ABORT,
+)
+```
+
+### Checkpoint/Restore
+
+Two-layer checkpoint without CRIU or root:
+
+1. **OS-level**: ptrace + `/proc` dumps registers, memory, and file descriptors (transparent to child)
+2. **App-level**: optional `save_fn` callback for application state
+
+Combined with BranchFS O(1) snapshots for full checkpoint/restore.
+
+```python
+with Sandbox(policy) as sb:
+    sb.exec(["python3", "server.py"], save_fn=lambda: serialize_state())
+    cp = sb.checkpoint()
+    cp.save("my-env")       # persist to disk
+
+# Later: restore
+cp = Checkpoint.load("my-env")
+Sandbox.from_checkpoint(cp, restore_fn=lambda state: load_state(state))
+```
+
+### Privileged Mode
+
+`privileged=True` maps UID 0 inside a user namespace. The child appears as
+root but Landlock + seccomp still apply — "root" cannot escape confinement.
+
+## Policy Reference
+
+```python
+@dataclass(frozen=True)
+class Policy:
+    # Filesystem (Landlock)
+    fs_writable: Sequence[str] = []     # Read/write access
+    fs_readable: Sequence[str] = []     # Read-only access
+    fs_denied: Sequence[str] = []       # Explicitly denied
+
+    # Syscall filtering (seccomp)
+    deny_syscalls: Sequence[str] | None = None   # None = default blocklist
+    allow_syscalls: Sequence[str] | None = None  # Allowlist mode (stricter)
+
+    # Network
+    net_allow_hosts: Sequence[str] = []     # Domain allowlist (seccomp notif)
+    net_bind: Sequence[int | str] = []      # TCP bind ports (Landlock ABI v4+)
+    net_connect: Sequence[int | str] = []   # TCP connect ports (Landlock ABI v4+)
+
+    # IPC scoping (Landlock ABI v6+)
+    isolate_ipc: bool = False       # Block abstract UNIX sockets to host
+    isolate_signals: bool = False   # Block signals to host processes
+
+    # Resources (seccomp notif + rlimit)
+    max_memory: str | int | None = None  # '512M'
+    max_processes: int | None = None     # per-sandbox fork count
+    max_cpu: str | None = None           # '50%' per-process
+
+    # Environment
+    clean_env: bool = False              # Minimal env (PATH, HOME, TERM, LANG, USER, SHELL)
+    env: Mapping[str, str] = {}          # Set/override env vars
+
+    # BranchFS COW isolation
+    fs_isolation: FsIsolation = NONE     # NONE | BRANCHFS
+    fs_mount: str | None = None          # BranchFS mount point
+    on_exit: BranchAction = COMMIT       # COMMIT | ABORT | KEEP
+    on_error: BranchAction = ABORT
+
+    # Misc
+    chroot: str | None = None
+    close_fds: bool = True
+    strict: bool = True          # Abort on confinement failure
+    privileged: bool = False     # UID 0 inside user namespace
+    notif_policy: NotifPolicy | None = None
+```
+
+`strict=False` degrades gracefully when Landlock or seccomp is unavailable.