module CombinatorsSpec (spec) where import Data.List.Extra import Data.String.Interpolate.Util import System.Directory.Extra (createDirectoryIfMissing, doesFileExist) import Test.Hspec import TestPrelude spec :: Spec spec = parallel $ inTestM $ do describe "add-cleanup" $ do it "runs arbitrary logic after the jail exits" $ do tmpDir <- getTestDir [i| jail "test" (sh "cat /foo-in-jail") (c: [ (c.ro-bind "foo" "/foo-in-jail") (c.add-runtime "echo hello > foo") (c.add-cleanup "rm foo") ]) |] `shouldOutput` "hello\n" liftIO $ doesFileExist (tmpDir "foo") `shouldReturn` False describe "add-path" $ do it "prepends the passed path to $PATH" $ do output <- runNixDrv [i| jail "test" (sh ''echo "$PATH"'') (c: [ (c.add-path "/some/new/path") ]) |] liftIO $ output `shouldStartWith` "/some/new/path:" describe "add-pkg-deps" $ do it "sets the path" $ do helloPath <- evalNixExpr "toString pkgs.hello" output <- runNixDrv [i| jail "test" (sh ''echo "$PATH"'') (c: [ (c.add-pkg-deps [ pkgs.hello ]) ]) |] liftIO $ output `shouldStartWith` helloPath <> "/bin:" describe "bind-pkg" $ do it "binds the passed nix package at the specified location" $ do [i| jail "test" (sh "cat /foo") (c: [ (c.bind-pkg "/foo" (pkgs.writeText "foo" "bar\n")) ]) |] `shouldOutput` "bar\n" describe "fwd-env" $ do it "forwards the passed environment variable" $ do withEnv "MY_ENV_VAR" "secret" $ do [i| jail "test" (sh ''echo "''${MY_ENV_VAR-unset}"'') (c: [ (c.fwd-env "MY_ENV_VAR") ]) |] `shouldOutput` "secret\n" describe "jail-to-host-channel" $ do it "calls a script on the outside of the jail with an argument and returns its stdout" $ do tmpDir <- getTestDir liftIO $ writeFile (tmpDir "secret") "hunter2" [i| jail "test" (sh ''getsha1 "#{tmpDir "secret"}"'') (c: [ (c.jail-to-host-channel "getsha1" '' echo "this runs outside of the jail" sha1sum < "$1" '') ]) |] `shouldOutput` "this runs outside of the jail\nf3bbbd66a63d4bf1747940578ec3d0103530e21d -\n" describe "network" $ do it "grants network access to the jailed program" $ do out <- runNixDrv [i| jail "test" (sh ''curl https://example.org'') (c: [ (c.add-pkg-deps [ pkgs.curl ]) c.network ]) |] liftIO $ out `shouldContain` "

Example Domain

" it "does not add too many bwrap args" $ do out <- runNixDrv [i| let jail' = jail-nix.extend { inherit pkgs; bubblewrapPackage = pkgs.writeShellApplication { name = "my-bubblewrap"; text = '' # A version of bwrap that just prints how many arguments it # was passed instead of actually running a jail. echo -n "$#" ''; }; basePermissions = null; }; in jail' "test" "unused" (c: [ c.network ]) |] liftIO $ (read out :: Int) `shouldSatisfy` (< 100) describe "open-urls-in-browser" $ do it "exposes a $BROWSER in the jail that calls $BROWSER outside of the jail" $ do tmpDir <- getTestDir void $ runNixDrv [i| let fakeBrowser = sh '' echo "got url: $1" >> #{tmpDir "fake-browser"} ''; jailed = jail "test" (sh ''$BROWSER "$@"'') (c: [ c.open-urls-in-browser ]); in sh '' export BROWSER=${lib.getExe fakeBrowser} ${lib.getExe jailed} "https://example.org" ${lib.getExe jailed} "http://example.org" '' |] liftIO $ readFile (tmpDir "fake-browser") `shouldReturn` unindent [i| got url: https://example.org got url: http://example.org |] it "only allows urs that start with http(s)://" $ do tmpDir <- getTestDir void $ runNixDrv [i| let fakeBrowser = sh '' echo "got url: $1" >> #{tmpDir "fake-browser"} ''; jailed = jail "test" (sh ''$BROWSER "$@"'') (c: [ c.open-urls-in-browser ]); in sh '' export BROWSER=${lib.getExe fakeBrowser} ${lib.getExe jailed} "file:///some/path" ${lib.getExe jailed} "--headless" ${lib.getExe jailed} "" ${lib.getExe jailed} '' |] liftIO $ doesFileExist (tmpDir "fake-browser") `shouldReturn` False describe "readonly-paths-from-var" $ do forM_ [":", " "] $ \separator -> describe ("with separator \"" <> separator <> "\"") $ do it "binds all paths in the specified environment variable as read only" $ do tmpDir <- getTestDir let separator = " " let mkTestPath path = liftIO $ createDirectoryIfMissing True (tmpDir path) >> writeFile (tmpDir path "file") "" mkTestPath "some/path" mkTestPath "some/other/path" mkTestPath "some/final/real/path" mkTestPath "some/not/in/var" let testPaths = intercalate separator $ map (tmpDir ) [ "some/path", "some/non/existent/path", "some/other/path", "some/other/non/existent/path", "some/final/real/path" ] withEnv "TEST_PATHS" testPaths $ do [i| jail "test" (sh "${lib.getExe pkgs.tree} ${#{toNixString (tmpDir "some")}}") (c: [ (c.readonly-paths-from-var "TEST_PATHS" #{toNixString separator}) ]) |] `shouldOutput` unindent [i| #{tmpDir "some"} |-- final | `-- real | `-- path | `-- file |-- other | `-- path | `-- file `-- path `-- file 7 directories, 3 files |] it "doesn't require the var to be set" $ do void $ runNixDrv [i| jail "test" (sh "true") (c: [ (c.readonly-paths-from-var "THIS_VAR_IS_NOT_SET" #{toNixString separator}) ]) |] describe "set-argv" $ do it "overrides argv passed to the jailed program" $ do [i| jail "test" (sh "printf '1=%s,2=%s,3=%s' \\"$@\\"") (c: [ (c.set-argv [ "foo" "bar baz" "foo>'bar'" ]) ]) |] `shouldOutput` "1=foo,2=bar baz,3=foo>'bar'" describe "set-env" $ do it "allows setting arbitrary environment variables" $ do [i| jail "test" (sh ''echo -n "''${MY_ENV_VAR-unset}"'') (c: [ (c.set-env "MY_ENV_VAR" "some-value") ]) |] `shouldOutput` "some-value" describe "time-zone" $ do it "forwards timezones on nixos systems" $ do [i| let tz = "EST"; fakeEtc = pkgs.runCommand "fake-etc" {} '' mkdir -p $out/etc ln -s ${pkgs.tzdata}/share/zoneinfo $out/etc/zoneinfo ''; withFakeTimeZoneOnNixos = program: jail program.name program (c: [ # This is a bit convoluted, but this recreates the symlink chain that is present on nixos systems (c.add-pkg-deps [ fakeEtc ]) (c.unsafe-add-raw-args "--symlink ${fakeEtc}/etc /etc/static") (c.unsafe-add-raw-args "--symlink /etc/static/zoneinfo /etc/zoneinfo") (c.unsafe-add-raw-args "--symlink /etc/zoneinfo/${tz} /etc/localtime") ]); in withFakeTimeZoneOnNixos ( jail "print-time-zone" (sh "date '+%Z'") (c: [ c.time-zone ]) ) |] `shouldOutput` "EST\n" it "forwards timezones on non-nixos systems" $ do [i| let tz = "EST"; withFakeTimeZoneOnNixos = program: jail program.name program (c: [ (c.unsafe-add-raw-args "--ro-bind ${pkgs.tzdata}/share/zoneinfo /etc/zoneinfo") (c.unsafe-add-raw-args "--symlink /etc/zoneinfo/${tz} /etc/localtime") ]); in withFakeTimeZoneOnNixos ( jail "print-time-zone" (sh "date '+%Z'") (c: [ c.time-zone ]) ) |] `shouldOutput` "EST\n" describe "try-readonly" $ do it "binds paths as readonly in the jail" $ do tmpDir <- getTestDir liftIO $ writeFile (tmpDir "my-file") "foo" [i| jail "test" (sh ''cat "#{tmpDir "my-file"}"'') (c: [ (c.try-readonly "#{tmpDir "my-file"}") ]) |] `shouldOutput` "foo" out <- runNixDrv [i| jail "test" (sh ''echo new-contents | tee "#{tmpDir "my-file"}" 2>&1 || true'') (c: [ (c.try-readonly "#{tmpDir "my-file"}") ]) |] liftIO $ out `shouldContain` "my-file: Read-only file system" it "does not error if the file does not exist" $ do [i| jail "test" (sh ''echo ok'') (c: [ (c.try-readonly "/this/path/does/not/exist") ]) |] `shouldOutput` "ok\n" describe "try-readwrite" $ do it "binds paths as readwrite in the jail" $ do tmpDir <- getTestDir liftIO $ writeFile (tmpDir "my-file") "foo" [i| jail "test" (sh ''cat "#{tmpDir "my-file"}"'') (c: [ (c.try-readwrite "#{tmpDir "my-file"}") ]) |] `shouldOutput` "foo" void $ runNixDrv [i| jail "test" (sh ''echo new-contents | tee "#{tmpDir "my-file"}"'') (c: [ (c.try-readwrite "#{tmpDir "my-file"}") ]) |] liftIO $ readFile (tmpDir "my-file") `shouldReturn` "new-contents\n" it "does not error if the file does not exist" $ do [i| jail "test" (sh ''echo ok'') (c: [ (c.try-readwrite "/this/path/does/not/exist") ]) |] `shouldOutput` "ok\n" describe "try-ro-bind" $ do it "binds paths as readonly in the jail" $ do tmpDir <- getTestDir liftIO $ writeFile (tmpDir "my-file") "foo" [i| jail "test" (sh ''cat /path/in/jail'') (c: [ (c.try-ro-bind "#{tmpDir "my-file"}" "/path/in/jail") ]) |] `shouldOutput` "foo" out <- runNixDrv [i| jail "test" (sh ''echo new-contents | tee /path/in/jail 2>&1 || true'') (c: [ (c.try-ro-bind "#{tmpDir "my-file"}" "/path/in/jail") ]) |] liftIO $ out `shouldContain` "/path/in/jail: Read-only file system" it "does not error if the file does not exist" $ do [i| jail "test" (sh ''echo ok'') (c: [ (c.try-ro-bind "/this/path/does/not/exist" "/path/in/jail") ]) |] `shouldOutput` "ok\n" describe "try-rw-bind" $ do it "binds paths as readwrite in the jail" $ do tmpDir <- getTestDir liftIO $ writeFile (tmpDir "my-file") "foo" [i| jail "test" (sh ''cat /path/in/jail'') (c: [ (c.try-rw-bind "#{tmpDir "my-file"}" "/path/in/jail") ]) |] `shouldOutput` "foo" void $ runNixDrv [i| jail "test" (sh ''echo new-contents | tee /path/in/jail'') (c: [ (c.try-rw-bind "#{tmpDir "my-file"}" "/path/in/jail") ]) |] liftIO $ readFile (tmpDir "my-file") `shouldReturn` "new-contents\n" it "does not error if the file does not exist" $ do [i| jail "test" (sh ''echo ok'') (c: [ (c.try-rw-bind "/this/path/does/not/exist" "/path/in/jail") ]) |] `shouldOutput` "ok\n"