krunbox 2.0.0__tar.gz

krunbox-2.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Tim Eismar
+
+   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.

krunbox-2.0.0/NOTICE

@@ -0,0 +1,16 @@
+krunbox
+Copyright 2026 Tim Eismar
+
+This product includes software developed for the krunbox project.
+
+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 file for the specific language governing permissions and
+limitations under the License.

krunbox-2.0.0/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: krunbox
+Version: 2.0.0
+Summary: Podman & microVM Sandboxing Engine with GTK4 Console
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/teismar/krunbox
+Project-URL: Documentation, https://github.com/teismar/krunbox#readme
+Project-URL: Repository, https://github.com/teismar/krunbox.git
+Project-URL: Issues, https://github.com/teismar/krunbox/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Environment :: X11 Applications :: GTK
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# krunbox
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Platform: Linux](https://img.shields.io/badge/Platform-Linux-FCC624?logo=linux&logoColor=black)](https://kernel.org)
+[![Python: 3.10+](https://img.shields.io/badge/Python-3.10+-3776AB?logo=python&logoColor=white)](pyproject.toml)
+[![Hypervisor: Linux_KVM](https://img.shields.io/badge/Hypervisor-Linux_KVM-E95420?logo=linux&logoColor=white)](https://www.linux-kvm.org)
+[![Engine: crun--krun](https://img.shields.io/badge/Engine-crun--krun-3584e4)](https://github.com/containers/crun)
+[![UI: GTK4_/_Libadwaita](https://img.shields.io/badge/UI-GTK4_%2F_Libadwaita-3584e4?logo=gnome&logoColor=white)](https://gnome.pages.gitlab.gnome.org/libadwaita/)
+[![Tests](https://github.com/teismar/krunbox/actions/workflows/ci.yml/badge.svg)](https://github.com/teismar/krunbox/actions/workflows/ci.yml)
+[![AI-DECLARATION: pair](https://img.shields.io/badge/䷼%20AI--DECLARATION-pair-ffedd5?labelColor=ffedd5)](https://ai-declaration.md)
+
+**krunbox** gives you fast, hardware-isolated Linux microVM sandboxes for running AI coding agents, untrusted scripts, and messy development workloads without putting your host machine at risk.
+
+Under the hood, it pairs **crun-krun** (Linux KVM hardware virtualization) and rootless **Podman** with an outbound egress firewall, workspace git guardrails, instant IDE connectivity, and a native **GTK4 / Libadwaita** desktop console.
+
+---
+
+## Why krunbox?
+
+Autonomous AI coding agents (Claude Code, OpenDevin, Aider, custom LLM loops) are incredibly useful, but giving an AI agent free rein in a terminal on your host machine is risky:
+
+- **What if it executes a bad command?** A runaway script or hallucinated cleanup command can wipe directories or corrupt system configs.
+- **What if a malicious prompt injection occurs?** If an agent reads a poisoned README, issue, or dependency that instructs it to inspect `~/.ssh`, `~/.aws`, or environment variables and send them to an external server, your credentials are gone.
+- **What if it poisons your `.git/hooks`?** A rogue agent can modify `.git/hooks/pre-commit` inside your repository. The next time you commit on your host machine, that script executes with your full host privileges.
+
+### Why not just use Docker?
+Standard Docker and Podman containers share the **host Linux kernel**. If an agent has root access in the container (common when tools need to install packages or run daemons) or hits a kernel vulnerability, it can escape to the host.
+
+### Why not traditional virtual machines?
+Full VMs (VirtualBox, VMware, heavy QEMU) are slow to boot (30+ seconds), consume gigabytes of idle memory, and are awkward to wire into your daily workflow.
+
+### The krunbox sweet spot
+`krunbox` uses **crun-krun** and **libkrun** to boot an actual independent Linux kernel inside a lightweight microVM via `/dev/kvm` in **~100 milliseconds**. You get the speed and convenience of containers with the true hardware boundary of a hypervisor.
+
+---
+
+## Architecture Overview
+
+```mermaid
+flowchart TD
+    UI["GTK4 Libadwaita Console & CLI"] --> Manager["Sandbox Manager"]
+    Manager --> Net["Host-Boundary Egress Firewall (nftables / pasta)"]
+    Manager --> Images["Image System (Base, Node, Python, Reversing)"]
+    Manager --> Snapshots["Workspace Snapshots & Diff Engine"]
+    Manager --> Ports["Port Forwarding & Dynamic SSH Tunnels"]
+    Manager --> VM["crun-krun MicroVM (Linux KVM Hardware Isolation)"]
+```
+
+---
+
+## Desktop Console in Action
+
+![krunbox GTK4 Libadwaita Console](docs/screenshots/main-window.png)
+
+*The native GTK4 / Libadwaita console showing active microVMs, real-time CPU/RAM LevelBars, and 1-click IDE split buttons.*
+
+<p align="center">
+  <img src="docs/screenshots/create-dialog.png" width="48%" alt="Create Sandbox Dialog" />
+  &nbsp;
+  <img src="docs/screenshots/traffic-dialog.png" width="48%" alt="Egress Traffic Dialog" />
+</p>
+
+---
+
+## Highlights
+
+### ⚡ Sub-Second MicroVM Boots
+- Boots in ~100ms with real Linux KVM hardware virtualization.
+- Run multiple sandboxes simultaneously; each gets its own independent microVM kernel, private network namespace, and dedicated volume storage.
+- Ephemeral by default (`--rm`): stops cleanly and discards temporary state while keeping your host project files safe. Turn on persistent mode (`-P`) when you want to keep installed packages across reboots.
+
+### 🛡️ Outbound Network Lockdown & Traffic Inspector
+- Keep agents on a leash so they can't exfiltrate your secrets or scan your home network:
+  - **`offline`**: Completely airgapped. Zero outbound access.
+  - **`ai-only`**: Only permits connections to major AI provider APIs (Anthropic, OpenAI, Gemini, Mistral, Ollama, HuggingFace).
+  - **`dev-common`**: AI endpoints plus package registries (GitHub, PyPI, npm, Docker Hub, Cargo).
+  - **`full`**: Standard outbound internet access with blacklist support.
+  - **`custom`**: Hand-picked whitelist of domains.
+- **Host-boundary enforcement**: The egress firewall is applied outside the guest VM. Even if an agent runs `sudo` inside the sandbox, it cannot bypass or flush the firewall rules.
+- **Live traffic monitor**: Inspect domain requests in real time via `krunbox traffic <name>` or the GUI traffic dialog. See exactly what your agent tried to contact.
+
+### 🔒 Workspace Git Guardrails
+- **Protected Git Hooks**: By default, `/workspace/.git/hooks` is mounted read-only (`:ro`). Untrusted code cannot plant malicious hooks that execute outside the sandbox.
+- **Dotfile Protection**: Optionally mask `.git/config` and `.env` files (`--protect-git-config`, `--protect-env`) to keep local keys and remotes private.
+
+### 📸 Snapshots, Diff & 1-Click Rollback
+- Automatically captures a clean workspace baseline snapshot before each run.
+- Inspect everything the agent modified with colorized unified diff previews (`krunbox diff <name>`).
+- If things went sideways, restore your workspace back to its pre-run state with a single click (`krunbox rollback <name>`).
+
+### 💻 1-Click IDE & Terminal Integration
+- Jump directly into your running microVM with **VS Code**, **Cursor**, **Zed**, **JetBrains Gateway**, or your native desktop terminal emulator (Ptyxis, GNOME Terminal, Alacritty, Kitty, WezTerm, Ghostty).
+- Dynamic SSH integration generates clean `~/.ssh/config.d/` entries with zero-configuration port forwarding.
+
+### 🐧 Native GNOME & Libadwaita Desktop App
+- Fast, responsive desktop console built with GTK4 and Libadwaita (`krunbox ui`).
+- Uses ~30 MB of RAM (no heavy Electron wrapper).
+- Real-time CPU and memory meters, modal dialogs for port forwarding and traffic monitoring, dark/light theme switching, and desktop notifications.
+
+---
+
+## Ready-to-Use Images
+
+| Image | Description | Typical Use Case |
+|---|---|---|
+| **`agent-box:latest`** | Debian Bookworm (on krunbox-base), nested Docker daemon, Node.js, Python, Chrome headless | Autonomous coding agents (Claude Code, OpenDevin, Aider) |
+| **`python-data`** | Python 3.12, `uv`, NumPy, pandas, PyTorch, Jupyter | Data science, machine learning, and script testing |
+| **`node-fullstack`** | Node.js 22 LTS, npm, pnpm, Playwright | Web development and frontend testing |
+| **`reversing`** | Ghidra, Rizin, GDB, Wabt, Patchelf, Python binary analysis | Safe binary analysis and reverse engineering |
+| **`debian-minimal`** | Debian Bookworm minimal rootfs | Lightweight, resource-constrained tasks |
+
+---
+
+## Getting Started
+
+### Prerequisites
+- A modern Linux distribution (Fedora, Ubuntu, Debian, Arch, etc.).
+- KVM access (`/dev/kvm` readable and writable by your user).
+- `podman`, `crun-krun`, and `passt`.
+
+Check your system with:
+```bash
+# Verify your KVM group permissions
+ls -la /dev/kvm
+```
+
+### Installation
+
+Install via `pipx` (recommended) or editable pip:
+
+```bash
+# Install with pipx
+pipx install .
+
+# Or editable install for local development
+pip install -e .
+
+# Install the GNOME desktop launcher and icon
+krunbox install-desktop
+```
+
+### Verify Your Environment
+
+Run the built-in diagnostic tool to make sure hardware virtualization and runtimes are good to go:
+
+```bash
+krunbox doctor
+```
+
+---
+
+## Quick Examples
+
+### 1. Run a sandbox in your current project
+```bash
+# Start an ephemeral microVM mounted to current directory
+krunbox run .
+
+# Or start it in the background
+krunbox run . -d
+```
+
+### 2. Lock down networking for an AI agent
+```bash
+# Only allow connections to AI APIs, with git hooks protected
+krunbox run . --network ai-only --protect-git-hooks -d
+```
+
+### 3. Connect from your terminal or editor
+```bash
+# Open an interactive SSH terminal
+krunbox connect my-project
+
+# Launch directly in VS Code
+krunbox code my-project
+```
+
+### 4. Check what changed and roll back if needed
+```bash
+# See which files were touched
+krunbox diff my-project
+
+# Revert a bad file
+krunbox rollback my-project --file messy_script.py
+
+# Or roll back all workspace changes
+krunbox rollback my-project
+```
+
+### 5. Launch the desktop GUI
+```bash
+krunbox ui
+```
+
+---
+
+## CLI Cheat Sheet
+
+| Command | Description |
+|---|---|
+| `krunbox run [dir]` | Start a new sandbox for a directory |
+| `krunbox ls` | List running and stopped sandboxes with CPU/RAM |
+| `krunbox connect [name]` | Open an interactive SSH session in your terminal |
+| `krunbox code [name]` | Open sandbox workspace in VS Code / Cursor |
+| `krunbox diff [name]` | Inspect changes made to the workspace |
+| `krunbox rollback [name]` | Roll back changes to pre-run snapshot |
+| `krunbox traffic [name]` | Inspect outbound domain requests and policy hits |
+| `krunbox edit [name]` | Live-edit CPU, RAM, or network policy on a running sandbox |
+| `krunbox pause [name]` | Freeze microVM to save battery and RAM |
+| `krunbox unpause [name]` | Instantly resume a frozen microVM |
+| `krunbox stop [name]` | Stop a running sandbox |
+| `krunbox rm [name]` | Delete a sandbox |
+| `krunbox doctor` | Run system and virtualization diagnostics |
+| `krunbox ui` | Launch the native GTK4 / Libadwaita console |
+
+---
+
+## Contributing & Community
+
+Contributions are warmly welcome! Whether you want to add new base images, improve the GTK4 UI, or help with documentation, check out:
+
+- [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup and guidelines.
+- [SECURITY.md](SECURITY.md) for vulnerability reporting.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE) for details.