No description
  • Nix 50.8%
  • Haskell 49.1%
Find a file
Alex David f55483fb38 Forward override to jailed derivations
On Nixos, it may be desirable to install some software using
`programs.*.enable = true`. Jail.nix mostly supports this because you
can either use `jail-nix.mkOverlay`, or just use Nixos
`programs.*.package = jail ...` to inject a jailed version of the
package.

However, for some modules, like Firefox, the Nixos module calls
`override` on the package. Normally, you would just call `override` on
the package passed into jail, but this is not possible to do within a
Nixos module.

To address this, this patch will check to see if a package passed into
jail has an `override` field, and if so will add an `override` on the
jailed derivation that passes the override function to the entrypoint.

Thanks to ~juanjakobo for reporting this!

Fixes https://todo.sr.ht/~alexdavid/jail.nix/1
2025-10-13 16:06:29 -07:00
lib Forward override to jailed derivations 2025-10-13 16:06:29 -07:00
tests Forward override to jailed derivations 2025-10-13 16:06:29 -07:00
website Pull remaining default perms into base combinator 2025-10-10 16:28:45 -07:00
.build.yml Fix time-zone combinator 2025-09-15 22:26:44 -07:00
default.nix Allow consuming jail.nix without flakes 2025-08-15 08:06:02 -07:00
flake.nix Restructure source 2025-08-07 15:54:50 -07:00
LICENSE Add initial spike 2025-04-27 12:07:03 -07:00
README.md Add link to issue tracker 2025-10-11 17:41:40 -07:00

jail.nix

builds.sr.ht status

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

Please report bugs and feature requests to the issue tracker. Please send patches, questions and discussions to my general mailing list.

Getting Started

Documentation to install and get started can be found here.

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.