commit 3ed7049cddddc675ea43a2c8b1c925e69230aa43 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2405.section.md

···

       191
       191
        
       

     

       192
       192
        
       - [prometheus-nats-exporter](https://github.com/nats-io/prometheus-nats-exporter), a Prometheus exporter for NATS. Available as [services.prometheus.exporters.nats](#opt-services.prometheus.exporters.nats.enable).

     

       193
       193
        
       

     

       194
       194
       +
       - [isolate](https://github.com/ioi/isolate), a sandbox for securely executing untrusted programs. Available as [security.isolate](#opt-security.isolate.enable).

     

       195
       195
       +
       

     

       194
       196
        
       ## Backward Incompatibilities {#sec-release-24.05-incompatibilities}

     

       195
       197
        
       

     

       196
       198
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

nixos/modules/module-list.nix

···

       325
       325
        
         ./security/duosec.nix

     

       326
       326
        
         ./security/google_oslogin.nix

     

       327
       327
        
         ./security/ipa.nix

     

       328
       328
       +
         ./security/isolate.nix

     

       328
       329
        
         ./security/krb5

     

       329
       330
        
         ./security/lock-kernel-modules.nix

     

       330
       331
        
         ./security/misc.nix

+133

nixos/modules/security/isolate.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (lib) mkEnableOption mkPackageOption mkOption types mkIf maintainers;

     

       5
       5
       +
       

     

       6
       6
       +
         cfg = config.security.isolate;

     

       7
       7
       +
         configFile = pkgs.writeText "isolate-config.cf" ''

     

       8
       8
       +
           box_root=${cfg.boxRoot}

     

       9
       9
       +
           lock_root=${cfg.lockRoot}

     

       10
       10
       +
           cg_root=${cfg.cgRoot}

     

       11
       11
       +
           first_uid=${toString cfg.firstUid}

     

       12
       12
       +
           first_gid=${toString cfg.firstGid}

     

       13
       13
       +
           num_boxes=${toString cfg.numBoxes}

     

       14
       14
       +
           restricted_init=${if cfg.restrictedInit then "1" else "0"}

     

       15
       15
       +
           ${cfg.extraConfig}

     

       16
       16
       +
         '';

     

       17
       17
       +
         isolate = pkgs.symlinkJoin {

     

       18
       18
       +
           name = "isolate-wrapped-${pkgs.isolate.version}";

     

       19
       19
       +
       

     

       20
       20
       +
           paths = [ pkgs.isolate ];

     

       21
       21
       +
       

     

       22
       22
       +
           nativeBuildInputs = [ pkgs.makeWrapper ];

     

       23
       23
       +
       

     

       24
       24
       +
           postBuild = ''

     

       25
       25
       +
             wrapProgram $out/bin/isolate \

     

       26
       26
       +
               --set ISOLATE_CONFIG_FILE ${configFile}

     

       27
       27
       +
       

     

       28
       28
       +
             wrapProgram $out/bin/isolate-cg-keeper \

     

       29
       29
       +
               --set ISOLATE_CONFIG_FILE ${configFile}

     

       30
       30
       +
           '';

     

       31
       31
       +
         };

     

       32
       32
       +
       in

     

       33
       33
       +
       {

     

       34
       34
       +
         options.security.isolate = {

     

       35
       35
       +
           enable = mkEnableOption ''

     

       36
       36
       +
             Sandbox for securely executing untrusted programs

     

       37
       37
       +
           '';

     

       38
       38
       +
       

     

       39
       39
       +
           package = mkPackageOption pkgs "isolate-unwrapped" { };

     

       40
       40
       +
       

     

       41
       41
       +
           boxRoot = mkOption {

     

       42
       42
       +
             type = types.path;

     

       43
       43
       +
             default = "/var/lib/isolate/boxes";

     

       44
       44
       +
             description = ''

     

       45
       45
       +
               All sandboxes are created under this directory.

     

       46
       46
       +
               To avoid symlink attacks, this directory and all its ancestors

     

       47
       47
       +
               must be writeable only by root.

     

       48
       48
       +
             '';

     

       49
       49
       +
           };

     

       50
       50
       +
       

     

       51
       51
       +
           lockRoot = mkOption {

     

       52
       52
       +
             type = types.path;

     

       53
       53
       +
             default = "/run/isolate/locks";

     

       54
       54
       +
             description = ''

     

       55
       55
       +
               Directory where lock files are created.

     

       56
       56
       +
             '';

     

       57
       57
       +
           };

     

       58
       58
       +
       

     

       59
       59
       +
           cgRoot = mkOption {

     

       60
       60
       +
             type = types.str;

     

       61
       61
       +
             default = "auto:/run/isolate/cgroup";

     

       62
       62
       +
             description = ''

     

       63
       63
       +
               Control group which subgroups are placed under.

     

       64
       64
       +
               Either an explicit path to a subdirectory in cgroupfs, or "auto:file" to read

     

       65
       65
       +
               the path from "file", where it is put by `isolate-cg-helper`.

     

       66
       66
       +
             '';

     

       67
       67
       +
           };

     

       68
       68
       +
       

     

       69
       69
       +
           firstUid = mkOption {

     

       70
       70
       +
             type = types.numbers.between 1000 65533;

     

       71
       71
       +
             default = 60000;

     

       72
       72
       +
             description = ''

     

       73
       73
       +
               Start of block of UIDs reserved for sandboxes.

     

       74
       74
       +
             '';

     

       75
       75
       +
           };

     

       76
       76
       +
       

     

       77
       77
       +
           firstGid = mkOption {

     

       78
       78
       +
             type = types.numbers.between 1000 65533;

     

       79
       79
       +
             default = 60000;

     

       80
       80
       +
             description = ''

     

       81
       81
       +
               Start of block of GIDs reserved for sandboxes.

     

       82
       82
       +
             '';

     

       83
       83
       +
           };

     

       84
       84
       +
       

     

       85
       85
       +
           numBoxes = mkOption {

     

       86
       86
       +
             type = types.numbers.between 1000 65533;

     

       87
       87
       +
             default = 1000;

     

       88
       88
       +
             description = ''

     

       89
       89
       +
               Number of UIDs and GIDs to reserve, starting from

     

       90
       90
       +
               {option}`firstUid` and {option}`firstGid`.

     

       91
       91
       +
             '';

     

       92
       92
       +
           };

     

       93
       93
       +
       

     

       94
       94
       +
           restrictedInit = mkOption {

     

       95
       95
       +
             type = types.bool;

     

       96
       96
       +
             default = false;

     

       97
       97
       +
             description = ''

     

       98
       98
       +
               If true, only root can create sandboxes.

     

       99
       99
       +
             '';

     

       100
       100
       +
           };

     

       101
       101
       +
       

     

       102
       102
       +
           extraConfig = mkOption {

     

       103
       103
       +
             type = types.str;

     

       104
       104
       +
             default = "";

     

       105
       105
       +
             description = ''

     

       106
       106
       +
               Extra configuration to append to the configuration file.

     

       107
       107
       +
             '';

     

       108
       108
       +
           };

     

       109
       109
       +
         };

     

       110
       110
       +
       

     

       111
       111
       +
         config = mkIf cfg.enable {

     

       112
       112
       +
           environment.systemPackages = [

     

       113
       113
       +
             isolate

     

       114
       114
       +
           ];

     

       115
       115
       +
       

     

       116
       116
       +
           systemd.services.isolate = {

     

       117
       117
       +
             description = "Isolate control group hierarchy daemon";

     

       118
       118
       +
             wantedBy = [ "multi-user.target" ];

     

       119
       119
       +
             serviceConfig = {

     

       120
       120
       +
               Type = "notify";

     

       121
       121
       +
               ExecStart = "${isolate}/bin/isolate-cg-keeper";

     

       122
       122
       +
               Slice = "isolate.slice";

     

       123
       123
       +
               Delegate = true;

     

       124
       124
       +
             };

     

       125
       125
       +
           };

     

       126
       126
       +
       

     

       127
       127
       +
           systemd.slices.isolate = {

     

       128
       128
       +
             description = "Isolate sandbox slice";

     

       129
       129
       +
           };

     

       130
       130
       +
       

     

       131
       131
       +
           meta.maintainers = with maintainers; [ virchau13 ];

     

       132
       132
       +
         };

     

       133
       133
       +
       }

nixos/tests/all-tests.nix

···

       399
       399
        
         honk = runTest ./honk.nix;

     

       400
       400
        
         installed-tests = pkgs.recurseIntoAttrs (handleTest ./installed-tests {});

     

       401
       401
        
         invidious = handleTest ./invidious.nix {};

     

       402
       402
       +
         isolate = handleTest ./isolate.nix {};

     

       402
       403
        
         livebook-service = handleTest ./livebook-service.nix {};

     

       403
       404
        
         pyload = handleTest ./pyload.nix {};

     

       404
       405
        
         oci-containers = handleTestOn ["aarch64-linux" "x86_64-linux"] ./oci-containers.nix {};

+38

nixos/tests/isolate.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ lib, ... }:

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "isolate";

     

       4
       4
       +
         meta.maintainers = with lib.maintainers; [ virchau13 ];

     

       5
       5
       +
       

     

       6
       6
       +
         nodes.machine =

     

       7
       7
       +
           { ... }:

     

       8
       8
       +
           {

     

       9
       9
       +
             security.isolate = {

     

       10
       10
       +
               enable = true;

     

       11
       11
       +
             };

     

       12
       12
       +
           };

     

       13
       13
       +
       

     

       14
       14
       +
         testScript = ''

     

       15
       15
       +
           bash_path = machine.succeed('realpath $(which bash)').strip()

     

       16
       16
       +
           sleep_path = machine.succeed('realpath $(which sleep)').strip()

     

       17
       17
       +
           def sleep_test(walltime, sleeptime):

     

       18
       18
       +
               return f'isolate --no-default-dirs --wall-time {walltime} ' + \

     

       19
       19
       +
                   f'--dir=/box={box_path} --dir=/nix=/nix --run -- ' + \

     

       20
       20
       +
                   f"{bash_path} -c 'exec -a sleep {sleep_path} {sleeptime}'"

     

       21
       21
       +
       

     

       22
       22
       +
           def sleep_test_cg(walltime, sleeptime):

     

       23
       23
       +
               return f'isolate --cg --no-default-dirs --wall-time {walltime} ' + \

     

       24
       24
       +
                   f'--dir=/box={box_path} --dir=/nix=/nix --processes=2 --run -- ' + \

     

       25
       25
       +
                   f"{bash_path} -c '( exec -a sleep {sleep_path} {sleeptime} )'"

     

       26
       26
       +
       

     

       27
       27
       +
           with subtest("without cgroups"):

     

       28
       28
       +
               box_path = machine.succeed('isolate --init').strip()

     

       29
       29
       +
               machine.succeed(sleep_test(1, 0.5))

     

       30
       30
       +
               machine.fail(sleep_test(0.5, 1))

     

       31
       31
       +
               machine.succeed('isolate --cleanup')

     

       32
       32
       +
           with subtest("with cgroups"):

     

       33
       33
       +
               box_path = machine.succeed('isolate --cg --init').strip()

     

       34
       34
       +
               machine.succeed(sleep_test_cg(1, 0.5))

     

       35
       35
       +
               machine.fail(sleep_test_cg(0.5, 1))

     

       36
       36
       +
               machine.succeed('isolate --cg --cleanup')

     

       37
       37
       +
         '';

     

       38
       38
       +
       })

+13 -3

pkgs/tools/security/isolate/default.nix

···

       3
       3
        
       , fetchFromGitHub

     

       4
       4
        
       , asciidoc

     

       5
       5
        
       , libcap

     

       6
       6
       +
       , pkg-config

     

       7
       7
       +
       , systemdLibs

     

       6
       8
        
       , installShellFiles

     

       9
       9
       +
       , nixosTests

     

       7
       10
        
       }:

     

       8
       11
        
       

     

       9
       12
        
       stdenv.mkDerivation rec {

     
···

       20
       23
        
         nativeBuildInputs = [

     

       21
       24
        
           asciidoc

     

       22
       25
        
           installShellFiles

     

       26
       26
       +
           pkg-config

     

       23
       27
        
         ];

     

       24
       28
        
       

     

       25
       29
        
         buildInputs = [

     

       26
       30
        
           libcap.dev

     

       31
       31
       +
           systemdLibs.dev

     

       27
       32
        
         ];

     

       28
       33
        
       

     

       29
       29
       -
         buildFlags = [

     

       30
       30
       -
           "isolate"

     

       31
       31
       -
           "isolate.1"

     

       34
       34
       +
         patches = [

     

       35
       35
       +
           ./take-config-file-from-env.patch

     

       32
       36
        
         ];

     

       33
       37
        
       

     

       34
       38
        
         installPhase = ''

     

       35
       39
        
           runHook preInstall

     

       36
       40
        
       

     

       37
       41
        
           install -Dm755 ./isolate $out/bin/isolate

     

       42
       42
       +
           install -Dm755 ./isolate-cg-keeper $out/bin/isolate-cg-keeper

     

       43
       43
       +
           install -Dm755 ./isolate-check-environment $out/bin/isolate-check-environment

     

       38
       44
        
           installManPage isolate.1

     

       39
       45
        
       

     

       40
       46
        
           runHook postInstall

     

       41
       47
        
         '';

     

       48
       48
       +
       

     

       49
       49
       +
         passthru.tests = {

     

       50
       50
       +
           isolate = nixosTests.isolate;

     

       51
       51
       +
         };

     

       42
       52
        
       

     

       43
       53
        
         meta = {

     

       44
       54
        
           description = "Sandbox for securely executing untrusted programs";

+19

pkgs/tools/security/isolate/take-config-file-from-env.patch

···

       1
       1
       +
       diff --git a/config.c b/config.c

     

       2
       2
       +
       index 6477259..c462ed3 100644

     

       3
       3
       +
       --- a/config.c

     

       4
       4
       +
       +++ b/config.c

     

       5
       5
       +
       @@ -114,9 +114,12 @@ cf_check(void)

     

       6
       6
       +
        void

     

       7
       7
       +
        cf_parse(void)

     

       8
       8
       +
        {

     

       9
       9
       +
       -  FILE *f = fopen(CONFIG_FILE, "r");

     

       10
       10
       +
       +  char *config_file = getenv("ISOLATE_CONFIG_FILE");

     

       11
       11
       +
       +  if(!config_file)

     

       12
       12
       +
       +    die("ISOLATE_CONFIG_FILE environment variable not set");

     

       13
       13
       +
       +  FILE *f = fopen(config_file, "r");

     

       14
       14
       +
          if (!f)

     

       15
       15
       +
       -    die("Cannot open %s: %m", CONFIG_FILE);

     

       16
       16
       +
       +    die("Cannot open %s: %m", config_file);

     

       17
       17
       +
        

     

       18
       18
       +
          char line[MAX_LINE_LEN];

     

       19
       19
       +
          while (fgets(line, sizeof(line), f))