Split combinators into files

The `lib/combinators.nix` file was getting quite long and some ideas I
have for future combinators may even require ancillary files. To help
scale these changes, this commit breaks each combinator into its own
file under the `lib/combinators` directory.
This commit is contained in:
Alex David 2025-10-04 09:34:19 -07:00
commit 6181276ae1
54 changed files with 1531 additions and 1260 deletions

View file

@ -0,0 +1,101 @@
{ combinators, pkgs, ... }:
let
inherit (combinators)
add-cleanup
add-pkg-deps
add-runtime
compose
include-once
noescape
ro-bind
;
in
{
sig = "String -> String -> Combinator";
doc = ''
Allows programs in the jail to execute and pass messages to a
specific handler that runs outside of the jail.
The first parameter specifies a name of a program that is exposed
to the jail that, when called, sends its first argument to the
script passed to the second parameter. The script runs *outside*
of the jail. Any stdout generated by the script is relayed back
as stdout from the program in the jail.
Current limitations:
* Only a single argument is supported. For more arguments you
will need to use an encoding like JSON.
* Only stdout is relayed back to the jail, stderr will be
visible in your terminal but the jail won't be able to read
it.
* The first parameter must be a valid POSIX variable name.
Example:
```nix
jail-to-host-channel "getHostFileSize" ${"''"}
# This runs *outside* of the jail
if [ -f "$1" ]; then
wc -c < "$1"
else
echo "$1 is not a file on the host"
fi
${"''"}
```
This exposes a program inside the jail called `getHostFileSize`
that returns the size of the file passed in without needing to
give the jail read access to any files.
'';
impl =
jailTxName: hostRxHandler:
assert pkgs.lib.isValidPosixName jailTxName;
let
varPrefix = "J2H_CHAN_${pkgs.lib.toUpper jailTxName}";
in
include-once "jail-to-host-channel-${jailTxName}" (compose [
(add-runtime ''
# Set up jail-to-host channel "${jailTxName}"
${varPrefix}_TMP=$(mktemp -d)
mkfifo "''$${varPrefix}_TMP/fifo"
(
while true; do
MSG=$(<"''$${varPrefix}_TMP/fifo")
${
pkgs.lib.getExe (
pkgs.writeShellApplication {
name = "${jailTxName}-host-rx-handler";
text = hostRxHandler;
}
)
} "$MSG" > "''$${varPrefix}_TMP/fifo" || break
done
) &
${varPrefix}_RX_PID=$!
'')
(add-cleanup ''
kill "''$${varPrefix}_RX_PID"
rm -rf "''$${varPrefix}_TMP"
'')
(ro-bind (noescape "\"\$${varPrefix}_TMP/fifo\"") "/run/j2hc-${jailTxName}")
(add-pkg-deps [
(pkgs.writeShellApplication {
name = jailTxName;
runtimeInputs = [ pkgs.util-linux ];
text = ''
flock /run/j2hc.lock ${
pkgs.lib.getExe (
pkgs.writeShellApplication {
name = "${jailTxName}-locked";
text = ''
echo "$1" > /run/j2hc-${jailTxName}
echo "$(< /run/j2hc-${jailTxName})"
'';
}
)
} "$1"
'';
})
])
]);
}