Skip to main content

Isolated project environments with bubblewrap sandboxing

Project description

pwrap

pwrap wraps project shell environments in bubblewrap sandboxes, and aims to limit the blast radius of e.g. supply chain attacks and protect your production infrastructure from your sloppy side project.

Why

I got tired of my ad-hoc fish bwrap scripts, and I'm increasingly worried about supply chain attacks.

If every side project feels like a potential vector — one [npm|pip|cargo] install away from pwned AWS credentials, and custom-wrapping with bwrap and some vault product feels too fragile or too much work, pwrap might help.

Status

pwrap works but has not been tested by anyone but me, and has not been reviewed/audited by anyone except Opus 4.6 and codestral. pwrap comes with absolutely no warranty.

Does:

  • Launches sandboxed shells with per-project filesystem isolation
  • Hides sensitive paths (credentials, configs, SSH keys) via tmpfs overlays
  • Exposes only what each project needs (whitelisting)
  • Mounts gocryptfs encrypted volumes inside isolated namespaces
  • Runs init scripts for venv activation, aliases, setup

Doesn't do:

  • Network filtering (it's all-or-nothing via unshare_net)
  • Container-level isolation (no cgroups, no seccomp, no resource limits)
  • Package management or dependency resolution
  • Protect you from your own misconfiguration
  • Protect you from root

Dependencies: Python 3.11+ (stdlib only, no pip dependencies), bubblewrap for sandboxing, gocryptfs for encrypted volumes.

Design principles:

  • Reviewable — small codebase, no pip dependencies, no magic
  • Fail fast — invalid config is an error, not a warning
  • Explicit over convenient — no implicit defaults that hide security decisions
  • Init scripts as the extension point — venv, aliases, setup

Installation

pwrap has no pip dependencies — only the standard library. Installing from source lets you see what you are running and is preferred:

git clone https://github.com/haard/projectwrap
cd projectwrap
# this is where you can still safely review the code before running
pip install --no-deps .

Or from PyPI if you prefer convenience: pipx install projectwrap

Check optional dependencies with pwrap --check-deps.

Quick Start

pwrap --new ~/projects/myproject    # creates config + init script
# edit ~/.config/pwrap/myproject/project.toml and init script
pwrap myproject                     # launch sandboxed shell

On first run, --new creates editable templates in ~/.config/pwrap/. Edit them to set your defaults, then run --new again.

Examples

Basic sandboxed project

~/.config/pwrap/myproject/project.toml:

[project]
name = "myproject"
dir = "~/projects/myproject"
shell = "/usr/bin/fish"

[sandbox]
enabled = true
blacklist = [  # can't be accessed at all from the sandbox
    "~/.kube",
    "~/.aws",
    "~/.ssh",
    "~/projects/",  # hide all other projects
]
whitelist = [  # exceptions to the blacklist
    "~/.kube/myproject",
    "~/.ssh/myproject_ed25519",
    "~/.ssh/known_hosts",
]

~/.config/pwrap/myproject/init.fish:

source .venv/bin/activate.fish
set -gx KUBECONFIG ~/.kube/myproject/config
set -gx GIT_SSH_COMMAND "ssh -i ~/.ssh/myproject_ed25519 -o IdentitiesOnly=yes"

The config directory (~/.config/pwrap) is always blacklisted automatically — code inside the sandbox cannot read own or other project configs. The project directory is always whitelisted and writable, even if a parent is blacklisted.

Encrypted AI chat history

Keep aichat/Claude chat history encrypted at rest, decrypted only inside the sandbox.

Setup:

mkdir -p ~/.config/pwrap/myproject/encrypted
gocryptfs -init ~/.config/pwrap/myproject/encrypted

Config (project.toml):

[project]
name = "myproject"
dir = "~/projects/myproject"
shell = "/usr/bin/fish"

[sandbox]
enabled = true

[encrypted]
cipherdir = "encrypted"
mountpoint = "~/projects/myproject/vault"

# Big Hammer approach to move history files, nvm envs etc:
# Note: XDG_DATA_HOME can only affect the shell itself if set here
# not in init script
[env]
XDG_DATA_HOME = "vault/.config"

Init script (init.fish):

set -gx AICHAT_CONFIG_DIR vault/aichat
GUI apps in sandbox

To run emacs or other GUI apps inside the sandbox on WSL2:

[sandbox]
writable = [
    "/tmp/.X11-unix",           # X11 display socket
    "/mnt/wslg/runtime-dir",   # Wayland + PulseAudio
]

Configuration

pwrap --new generates a project.toml template with all options documented. The config sections:

Section Purpose
[project] name, dir, shell
[sandbox] blacklist, whitelist, writable, namespace options
[env] environment variables, set before the shell starts
[encrypted] gocryptfs cipherdir, mountpoint, shared mode

[env] values are injected via bwrap --setenv (sandboxed) or os.environ (non-sandboxed), so the shell sees them from the start — unlike init scripts which run after the shell is already up. Values starting with ~/ are expanded. Use [env] for variables that tools read at startup (e.g. XDG_DATA_HOME), and init scripts for everything else.

Init scripts (init.fish or init.sh) run inside the sandbox for venv activation, aliases, and tool version switching.

Encrypted volumes

On launch, gocryptfs prompts for the password, mounts the decrypted volume inside an isolated mount namespace, and launches the sandboxed shell. The decrypted files are invisible to host processes and disappear when the shell exits. If you enter the wrong password, gocryptfs exits immediately (no retry) and pwrap aborts without launching the sandbox. Re-run to try again.

Environment variables: PWRAP_VAULT_DIR is exported inside any sandbox with an [encrypted] section, pointing at the mountpoint. Use it from init scripts or app configs to redirect history/state into the vault without hardcoding paths per project.

You will appear as root. Mounting gocryptfs unprivileged requires unshare --user --map-root-user, so whoami reports root and id -u reports 0 inside the sandbox. This is a user-namespace remapping only — you have no real privileges on the host and cannot escalate. Your files remain owned by your real uid. Scripts that gate on $UID == 0 will misbehave; check $PROJECT_WRAP or $PWRAP_VAULT_DIR instead.

Multiple terminals (shared = false, default): each terminal gets an independent gocryptfs mount. Writes to different files merge on next session; writes to the same file from two sessions may lose one session's changes. pwrap warns and prompts for confirmation when a concurrent session is detected.

Shared mode (shared = true): the first terminal becomes the primary session. It mounts gocryptfs, prints a vault token, and stays in the foreground (no background daemon). Additional terminals prompt for the token and attach as children. $PWRAP_VAULT_TOKEN is available inside the sandbox. When the primary exits, all attached terminals are terminated and the mount is released.

Usage

pwrap                                      # list projects
pwrap myproject                            # launch project
pwrap -v myproject                         # verbose output
pwrap --new ~/projects/myproject           # create config (name from dir)
pwrap --new ~/projects/myproject custom    # create with explicit name
pwrap --new --shell /bin/bash ~/projects/x # specify shell
pwrap --check-deps                         # check optional dependencies
pwrap --version                            # show version

Security Defaults

When sandboxing is enabled:

  • Home is read-only; only the project directory is writable
  • Config directory (~/.config/pwrap) is always blacklisted
  • PID and IPC namespaces are isolated
  • TIOCSTI injection blocked automatically on kernels < 6.2
  • XDG runtime directory isolated
  • Sandbox dies with parent process
  • Encrypted volumes mount in isolated namespace (invisible on host)
  • All paths in shell commands are quoted to prevent injection

Run your editor from inside the sandbox if it has any capacity to run linters, hooks, or anything else from the project environment. A super-protected terminal does nothing if a malicious .pth can escape via your linter.

Shell Completions

# Fish
cp completions/project.fish ~/.config/fish/completions/pwrap.fish
# Bash
cp completions/project.bash /etc/bash_completion.d/pwrap
# Zsh
cp completions/_project ~/.local/share/zsh/site-functions/_pwrap

Development

poetry install              # install with dev dependencies
poetry run pytest           # run tests
poetry run ruff check src/  # lint
poetry run mypy src/        # type check

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

projectwrap-202604.2.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

projectwrap-202604.2-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

Details for the file projectwrap-202604.2.tar.gz.

File metadata

  • Download URL: projectwrap-202604.2.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.12 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for projectwrap-202604.2.tar.gz
Algorithm Hash digest
SHA256 7a00880b9bb247c5d087479d80e1fb1057815ca756a5e2778d018455b18bad24
MD5 d765aecaa89e7e695727397993ab7286
BLAKE2b-256 b26c6241188b1eda7943f5ecdb1a72283aafe3b3efd33994f314cefcec1cf370

See more details on using hashes here.

File details

Details for the file projectwrap-202604.2-py3-none-any.whl.

File metadata

  • Download URL: projectwrap-202604.2-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.12 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for projectwrap-202604.2-py3-none-any.whl
Algorithm Hash digest
SHA256 28cdef571e4047fa14804b97ff916f3d8d1c8d6de2720881bedfe838934692b1
MD5 7f182f34a10176d732ccfecb2e0f7bc9
BLAKE2b-256 ac00e61c30d10ffdc8931bc564bb531eecb6562de39bb42e9dbd485b8aad303d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page