No description
  • Nix 50.8%
  • Haskell 49.1%
Find a file
Alex David 09edd097b9 Clean up combinator/permission naming
The term `combinator` was overloaded before, being used to refer both to
the functions that are exposed to help build a jail, and their return
value to be passed into `jail`/`basePermissions`. This commit renames
the latter to `Permission`.
2025-08-07 15:42:36 -07:00
tests Allow overriding jail base permissions 2025-08-07 15:29:16 -07:00
website Clean up combinator/permission naming 2025-08-07 15:42:36 -07:00
base-permissions.nix Allow overriding jail base permissions 2025-08-07 15:29:16 -07:00
combinators.nix Clean up combinator/permission naming 2025-08-07 15:42:36 -07:00
flake.nix Make combinators available at jail.combinators 2025-07-11 11:44:12 -07:00
helpers.nix Allow overriding jail base permissions 2025-08-07 15:29:16 -07:00
lib.nix Allow overriding jail base permissions 2025-08-07 15:29:16 -07:00
LICENSE Add initial spike 2025-04-27 12:07:03 -07:00
README.md Make combinators available at jail.combinators 2025-07-11 11:44:12 -07:00

jail.nix

A helper to make it easy and ergonomic to wrap your derivations in bubblewrap.

Please send patches, questions and discussions to my general mailing list.

Example

# flake.nix
{
  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
  inputs.jail-nix.url = "sourcehut:~alexdavid/jail.nix";

  outputs = { nixpkgs, jail-nix, ... }: let
    pkgs = import nixpkgs { system = "x86_64-linux"; };
    jail = jail-nix.lib.init pkgs;

    untrusted-package = pkgs.writeScriptBin "untrusted" ''
      ls -la $HOME
    '';
  in {
    packages.x86_64-linux.jailed = jail "my-jail" untrusted-package (with jail.combinators; [
      # See combinators section below for more functions that can go here

      # Give program access to the network
      network

      # Allow program to create windows
      gui

      # Give program access to the GPU
      gpu

      # Give program read-only access to /var/log/journal
      (readonly "/var/log/journal")

      # Mount ~/foo to /bar in the jail as read-write
      # (noescape due to `~` — all arguments are shell escaped by default)
      (rw-bind (noescape "~/foo") "/bar")
    ]);
  };
}

Combinators

By default, only the bare minimum permissions are exposed. By passing combinators into the jail you can modify the jail to expose more permissions.

Click here for a full list of combinators and their documentation.