commit c64639b54caa6595f9ef62ed2548593b5fe5db66 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       694
       694
        
         ./services/x11/xserver.nix

     

       695
       695
        
         ./system/activation/activation-script.nix

     

       696
       696
        
         ./system/activation/top-level.nix

     

       697
       697
       +
         ./system/boot/binfmt.nix

     

       697
       698
        
         ./system/boot/coredump.nix

     

       698
       699
        
         ./system/boot/emergency-mode.nix

     

       699
       700
        
         ./system/boot/grow-partition.nix

+139

nixos/modules/system/boot/binfmt.nix

···

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

     

       2
       2
       +
       let

     

       3
       3
       +
         inherit (lib) mkOption types optionalString;

     

       4
       4
       +
       

     

       5
       5
       +
         cfg = config.boot.binfmtMiscRegistrations;

     

       6
       6
       +
       

     

       7
       7
       +
         makeBinfmtLine = name: { recognitionType, offset, magicOrExtension

     

       8
       8
       +
                                , mask, preserveArgvZero, openBinary

     

       9
       9
       +
                                , matchCredentials, fixBinary, ...

     

       10
       10
       +
                                }: let

     

       11
       11
       +
           type = if recognitionType == "magic" then "M" else "E";

     

       12
       12
       +
           offset' = toString offset;

     

       13
       13
       +
           mask' = toString mask;

     

       14
       14
       +
           interpreter = "/run/binfmt/${name}";

     

       15
       15
       +
           flags = if !(matchCredentials -> openBinary)

     

       16
       16
       +
                     then throw "boot.binfmtMiscRegistrations.${name}: you can't specify openBinary = false when matchCredentials = true."

     

       17
       17
       +
                   else optionalString preserveArgvZero "P" +

     

       18
       18
       +
                        optionalString (openBinary && !matchCredentials) "O" +

     

       19
       19
       +
                        optionalString matchCredentials "C" +

     

       20
       20
       +
                        optionalString fixBinary "F";

     

       21
       21
       +
         in ":${name}:${type}:${offset'}:${magicOrExtension}:${mask'}:${interpreter}:${flags}";

     

       22
       22
       +
       

     

       23
       23
       +
         binfmtFile = builtins.toFile "binfmt_nixos.conf"

     

       24
       24
       +
           (lib.concatStringsSep "\n" (lib.mapAttrsToList makeBinfmtLine cfg));

     

       25
       25
       +
       

     

       26
       26
       +
         activationSnippet = name: { interpreter, ... }:

     

       27
       27
       +
           "ln -sf ${interpreter} /run/binfmt/${name}";

     

       28
       28
       +
         activationScript = ''

     

       29
       29
       +
           mkdir -p -m 0755 /run/binfmt

     

       30
       30
       +
           ${lib.concatStringsSep "\n" (lib.mapAttrsToList activationSnippet cfg)}

     

       31
       31
       +
         '';

     

       32
       32
       +
       in {

     

       33
       33
       +
         options = {

     

       34
       34
       +
           boot.binfmtMiscRegistrations = mkOption {

     

       35
       35
       +
             default = {};

     

       36
       36
       +
       

     

       37
       37
       +
             description = ''

     

       38
       38
       +
               Extra binary formats to register with the kernel.

     

       39
       39
       +
               See https://www.kernel.org/doc/html/latest/admin-guide/binfmt-misc.html for more details.

     

       40
       40
       +
             '';

     

       41
       41
       +
       

     

       42
       42
       +
             type = types.attrsOf (types.submodule ({ config, ... }: {

     

       43
       43
       +
               options = {

     

       44
       44
       +
                 recognitionType = mkOption {

     

       45
       45
       +
                   default = "magic";

     

       46
       46
       +
                   description = "Whether to recognize executables by magic number or extension.";

     

       47
       47
       +
                   type = types.enum [ "magic" "extension" ];

     

       48
       48
       +
                 };

     

       49
       49
       +
       

     

       50
       50
       +
                 offset = mkOption {

     

       51
       51
       +
                   default = null;

     

       52
       52
       +
                   description = "The byte offset of the magic number used for recognition.";

     

       53
       53
       +
                   type = types.nullOr types.int;

     

       54
       54
       +
                 };

     

       55
       55
       +
       

     

       56
       56
       +
                 magicOrExtension = mkOption {

     

       57
       57
       +
                   description = "The magic number or extension to match on.";

     

       58
       58
       +
                   type = types.str;

     

       59
       59
       +
                 };

     

       60
       60
       +
       

     

       61
       61
       +
                 mask = mkOption {

     

       62
       62
       +
                   default = null;

     

       63
       63
       +
                   description =

     

       64
       64
       +
                     "A mask to be ANDed with the byte sequence of the file before matching";

     

       65
       65
       +
                   type = types.nullOr types.str;

     

       66
       66
       +
                 };

     

       67
       67
       +
       

     

       68
       68
       +
                 interpreter = mkOption {

     

       69
       69
       +
                   description = ''

     

       70
       70
       +
                     The interpreter to invoke to run the program.

     

       71
       71
       +
       

     

       72
       72
       +
                     Note that the actual registration will point to

     

       73
       73
       +
                     /run/binfmt/''${name}, so the kernel interpreter length

     

       74
       74
       +
                     limit doesn't apply.

     

       75
       75
       +
                   '';

     

       76
       76
       +
                   type = types.path;

     

       77
       77
       +
                 };

     

       78
       78
       +
       

     

       79
       79
       +
                 preserveArgvZero = mkOption {

     

       80
       80
       +
                   default = false;

     

       81
       81
       +
                   description = ''

     

       82
       82
       +
                     Whether to pass the original argv[0] to the interpreter.

     

       83
       83
       +
       

     

       84
       84
       +
                     See the description of the 'P' flag in the kernel docs

     

       85
       85
       +
                     for more details;

     

       86
       86
       +
                   '';

     

       87
       87
       +
                   type = types.bool;

     

       88
       88
       +
                 };

     

       89
       89
       +
       

     

       90
       90
       +
                 openBinary = mkOption {

     

       91
       91
       +
                   default = config.matchCredentials;

     

       92
       92
       +
                   description = ''

     

       93
       93
       +
                     Whether to pass the binary to the interpreter as an open

     

       94
       94
       +
                     file descriptor, instead of a path.

     

       95
       95
       +
                   '';

     

       96
       96
       +
                   type = types.bool;

     

       97
       97
       +
                 };

     

       98
       98
       +
       

     

       99
       99
       +
                 matchCredentials = mkOption {

     

       100
       100
       +
                   default = false;

     

       101
       101
       +
                   description = ''

     

       102
       102
       +
                     Whether to launch with the credentials and security

     

       103
       103
       +
                     token of the binary, not the interpreter (e.g. setuid

     

       104
       104
       +
                     bit).

     

       105
       105
       +
       

     

       106
       106
       +
                     See the description of the 'C' flag in the kernel docs

     

       107
       107
       +
                     for more details.

     

       108
       108
       +
       

     

       109
       109
       +
                     Implies/requires openBinary = true.

     

       110
       110
       +
                   '';

     

       111
       111
       +
                   type = types.bool;

     

       112
       112
       +
                 };

     

       113
       113
       +
       

     

       114
       114
       +
                 fixBinary = mkOption {

     

       115
       115
       +
                   default = false;

     

       116
       116
       +
                   description = ''

     

       117
       117
       +
                     Whether to open the interpreter file as soon as the

     

       118
       118
       +
                     registration is loaded, rather than waiting for a

     

       119
       119
       +
                     relevant file to be invoked.

     

       120
       120
       +
       

     

       121
       121
       +
                     See the description of the 'F' flag in the kernel docs

     

       122
       122
       +
                     for more details.

     

       123
       123
       +
                   '';

     

       124
       124
       +
                   type = types.bool;

     

       125
       125
       +
                 };

     

       126
       126
       +
               };

     

       127
       127
       +
             }));

     

       128
       128
       +
           };

     

       129
       129
       +
         };

     

       130
       130
       +
       

     

       131
       131
       +
         config = lib.mkIf (cfg != {}) {

     

       132
       132
       +
           environment.etc."binfmt.d/nixos.conf".source = binfmtFile;

     

       133
       133
       +
           system.activationScripts.binfmt = activationScript;

     

       134
       134
       +
           systemd.additionalUpstreamSystemUnits =

     

       135
       135
       +
             [ "proc-sys-fs-binfmt_misc.automount"

     

       136
       136
       +
               "proc-sys-fs-binfmt_misc.mount"

     

       137
       137
       +
             ];

     

       138
       138
       +
         };

     

       139
       139
       +
       }