Make combinators available at jail.combinators

Instead of requiring the third argument to be a function that passes in
combinators, this exposes all combinators on `jail.combinators` and
allows the third argument to just be a list (or even null!). This may be
more ergonomic in some contexts (like nixpkgs overlays).

This isn't a breaking change, the third argument can still be a function
and will receive the combinators if it is.
This commit is contained in:
Alex David 2025-07-11 11:44:12 -07:00
commit c5ba72dc5a
4 changed files with 110 additions and 98 deletions

View file

@ -22,7 +22,7 @@ list](https://lists.sr.ht/~alexdavid/general).
ls -la $HOME ls -la $HOME
''; '';
in { in {
packages.x86_64-linux.jailed = jail "my-jail" untrusted-package (combinators: with combinators; [ packages.x86_64-linux.jailed = jail "my-jail" untrusted-package (with jail.combinators; [
# See combinators section below for more functions that can go here # See combinators section below for more functions that can go here
# Give program access to the network # Give program access to the network

View file

@ -1,16 +1,10 @@
{ {
outputs = _: { outputs = _: {
lib = let lib = let
runJail = import ./lib.nix; jailLib = import ./lib.nix;
in { in {
init = pkgs: name: exe: applyCombinators: runJail { init = pkgs: jailLib { inherit pkgs; };
inherit pkgs name exe applyCombinators; extend = jailLib;
};
extend = { pkgs, additionalCombinators }: name: exe: applyCombinators: runJail {
inherit pkgs name exe;
applyCombinators = combinators: applyCombinators (combinators // additionalCombinators combinators);
};
}; };
}; };
} }

35
lib.nix
View file

@ -1,14 +1,22 @@
{ pkgs, name, exe, applyCombinators }: let { pkgs
, additionalCombinators ? _: {}
}: let
inherit (pkgs) lib; inherit (pkgs) lib;
helpers = rec { helpers = rec {
dataDir = "~/.local/share/jail.nix"; dataDir = "~/.local/share/jail.nix";
dataDirSubPath = subPath: "${dataDir}/${combinators.escape subPath}"; dataDirSubPath = subPath: "${dataDir}/${builtinCombinators.escape subPath}";
}; };
combinators = import ./combinators.nix { inherit pkgs lib helpers; }; builtinCombinators = import ./combinators.nix { inherit pkgs lib helpers; };
initial-state = { allCombinators = builtinCombinators // additionalCombinators builtinCombinators;
in {
combinators = allCombinators;
__functor = _: name: exe: combinatorsToApply: let
initialState = {
name = name; name = name;
cmd = "${lib.getExe pkgs.bubblewrap}"; cmd = "${lib.getExe pkgs.bubblewrap}";
entry = if builtins.typeOf exe == "string" then lib.escapeShellArg exe else lib.getExe exe; entry = if builtins.typeOf exe == "string" then lib.escapeShellArg exe else lib.getExe exe;
@ -22,9 +30,17 @@
included-once = []; # See include-once combinator included-once = []; # See include-once combinator
cleanup = []; # See cleanup combinator cleanup = []; # See cleanup combinator
}; };
in lib.pipe initial-state (
userCombinators =
let t = builtins.typeOf combinatorsToApply; in
if t == "lambda" then combinatorsToApply allCombinators else
if t == "list" then combinatorsToApply else
if t == "null" then []
else throw "Unknown combinator type ${t}. Must be a function, list, or null";
in lib.pipe initialState (
# apply pre-user combinators # apply pre-user combinators
(with combinators; [ (with builtinCombinators; [
(unsafe-add-raw-args "--proc /proc") (unsafe-add-raw-args "--proc /proc")
(unsafe-add-raw-args "--dev /dev") (unsafe-add-raw-args "--dev /dev")
(unsafe-add-raw-args "--tmpfs /tmp") (unsafe-add-raw-args "--tmpfs /tmp")
@ -51,10 +67,10 @@ in lib.pipe initial-state (
]) ])
# apply user combinators # apply user combinators
++ applyCombinators combinators ++ userCombinators
# apply post-user combinators # apply post-user combinators
++ (with combinators; [ ++ (with builtinCombinators; [
(s: (s:
# See `--unshare-*` in BWRAP(1) # See `--unshare-*` in BWRAP(1)
lib.pipe ["user" "ipc" "pid" "net" "uts" "cgroup"] [ lib.pipe ["user" "ipc" "pid" "net" "uts" "cgroup"] [
@ -90,4 +106,5 @@ in lib.pipe initial-state (
# forward man pages # forward man pages
(jailed: if exe ? man then jailed // { inherit (exe) man; } else jailed) (jailed: if exe ? man then jailed // { inherit (exe) man; } else jailed)
] ]
) );
}

View file

@ -70,11 +70,12 @@ following positional arguments:
be a derivation like `pkgs.hello`, or a string like be a derivation like `pkgs.hello`, or a string like
`"${pkgs.hello}/bin/hello"`. If a derivation is passed it will call `"${pkgs.hello}/bin/hello"`. If a derivation is passed it will call
`nixpkgs.lib.getExe` on it to get the entrypoint. `nixpkgs.lib.getExe` on it to get the entrypoint.
* **combinators**: (Function returning a list of **Combinators**) - The third * **combinators**: (List of **Combinators**) - The third argument allows you to
argument allows you to control the permissions of the jail. By default, the control the permissions of the jail. By default, the wrapped program runs
wrapped program runs with very few permissions and to get it to even work you with very few permissions and to get it to even work you will need to define
will need to define what you want it to have access to here. For convenience, what you want it to have access to here. For convenience, if this argument is
this is a function that passes all the available combinators. a function, jail.combinators will be passed in, and the return value will be
used.
## Examples ## Examples
@ -97,7 +98,7 @@ your Nixos configurations:
# Now all modules have `jail` passed into them: # Now all modules have `jail` passed into them:
({ jail, ... }: { ({ jail, ... }: {
environment.systemPackages = [ environment.systemPackages = [
(jail "jailed-hello" pkgs.hello (c: [])) (jail "jailed-hello" pkgs.hello [])
]; ];
}) })
]; ];
@ -118,7 +119,7 @@ your Nixos configurations:
pkgs = import nixpkgs { system = "x86_64-linux"; }; pkgs = import nixpkgs { system = "x86_64-linux"; };
jail = jail-nix.lib.init pkgs; jail = jail-nix.lib.init pkgs;
in { in {
my-jailed-package = jail "jailed-hello" pkgs.hello (c: []); my-jailed-package = jail "jailed-hello" pkgs.hello [];
}; };
}; };
} }