diff options
Diffstat (limited to 'nixpkgs/nixos/modules/system/boot/luksroot.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/system/boot/luksroot.nix | 167 |
1 files changed, 117 insertions, 50 deletions
diff --git a/nixpkgs/nixos/modules/system/boot/luksroot.nix b/nixpkgs/nixos/modules/system/boot/luksroot.nix index f0d3170dc5ac..78301a57bd97 100644 --- a/nixpkgs/nixos/modules/system/boot/luksroot.nix +++ b/nixpkgs/nixos/modules/system/boot/luksroot.nix @@ -1,10 +1,11 @@ -{ config, lib, pkgs, ... }: +{ config, options, lib, pkgs, ... }: with lib; let luks = config.boot.initrd.luks; kernelPackages = config.boot.kernelPackages; + defaultPrio = (mkOptionDefault {}).priority; commonFunctions = '' die() { @@ -432,7 +433,7 @@ let echo "Please move your mouse to create needed randomness." ''} echo "Waiting for your FIDO2 device..." - fido2luks open ${dev.device} ${dev.name} ${dev.fido2.credential} --await-dev ${toString dev.fido2.gracePeriod} --salt string:$passphrase + fido2luks open${optionalString dev.allowDiscards " --allow-discards"} ${dev.device} ${dev.name} ${dev.fido2.credential} --await-dev ${toString dev.fido2.gracePeriod} --salt string:$passphrase if [ $? -ne 0 ]; then echo "No FIDO2 key found, falling back to normal open procedure" open_normally @@ -474,6 +475,16 @@ let preLVM = filterAttrs (n: v: v.preLVM) luks.devices; postLVM = filterAttrs (n: v: !v.preLVM) luks.devices; + stage1Crypttab = pkgs.writeText "initrd-crypttab" (lib.concatStringsSep "\n" (lib.mapAttrsToList (n: v: let + opts = v.crypttabExtraOpts + ++ optional v.allowDiscards "discard" + ++ optionals v.bypassWorkqueues [ "no-read-workqueue" "no-write-workqueue" ] + ++ optional (v.header != null) "header=${v.header}" + ++ optional (v.keyFileOffset != null) "keyfile-offset=${v.keyFileOffset}" + ++ optional (v.keyFileSize != null) "keyfile-size=${v.keyFileSize}" + ; + in "${n} ${v.device} ${if v.keyFile == null then "-" else v.keyFile} ${lib.concatStringsSep "," opts}") luks.devices)); + in { imports = [ @@ -485,10 +496,10 @@ in boot.initrd.luks.mitigateDMAAttacks = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Unless enabled, encryption keys can be easily recovered by an attacker with physical access to any machine with PCMCIA, ExpressCard, ThunderBolt or FireWire port. - More information is available at <link xlink:href="http://en.wikipedia.org/wiki/DMA_attack"/>. + More information is available at <http://en.wikipedia.org/wiki/DMA_attack>. This option blacklists FireWire drivers, but doesn't remove them. You can manually load the drivers if you need to use a FireWire device, but don't forget to unload them! @@ -502,7 +513,7 @@ in "serpent" "cbc" "xts" "lrw" "sha1" "sha256" "sha512" "af_alg" "algif_skcipher" ]; - description = '' + description = lib.mdDoc '' A list of cryptographic kernel modules needed to decrypt the root device(s). The default includes all common modules. ''; @@ -537,11 +548,11 @@ in boot.initrd.luks.devices = mkOption { default = { }; example = { luksroot.device = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; }; - description = '' + description = lib.mdDoc '' The encrypted disk that should be opened before the root filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM setups are supported. The unencrypted devices can be accessed as - <filename>/dev/mapper/<replaceable>name</replaceable></filename>. + {file}`/dev/mapper/«name»`. ''; type = with types; attrsOf (submodule ( @@ -558,14 +569,14 @@ in device = mkOption { example = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; type = types.str; - description = "Path of the underlying encrypted block device."; + description = lib.mdDoc "Path of the underlying encrypted block device."; }; header = mkOption { default = null; example = "/root/header.img"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of the file or block device that should be used as header for the encrypted device. ''; @@ -575,7 +586,7 @@ in default = null; example = "/dev/sdb1"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The name of the file (can be a raw device or a partition) that should be used as the decryption key for the encrypted device. If not specified, you will be prompted for a passphrase instead. @@ -586,12 +597,12 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The size of the key file. Use this if only the beginning of the key file should be used as a key (often the case if a raw device or partition is used as key file). If not specified, the whole - <literal>keyFile</literal> will be used decryption, instead of just - the first <literal>keyFileSize</literal> bytes. + `keyFile` will be used decryption, instead of just + the first `keyFileSize` bytes. ''; }; @@ -599,12 +610,12 @@ in default = null; example = 4096; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' The offset of the key file. Use this in combination with - <literal>keyFileSize</literal> to use part of a file as key file + `keyFileSize` to use part of a file as key file (often the case if a raw device or partition is used as a key file). If not specified, the key begins at the first byte of - <literal>keyFile</literal>. + `keyFile`. ''; }; @@ -612,13 +623,13 @@ in preLVM = mkOption { default = true; type = types.bool; - description = "Whether the luksOpen will be attempted before LVM scan or after it."; + description = lib.mdDoc "Whether the luksOpen will be attempted before LVM scan or after it."; }; allowDiscards = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to allow TRIM requests to the underlying device. This option has security implications; please read the LUKS documentation before activating it. @@ -630,10 +641,10 @@ in bypassWorkqueues = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to bypass dm-crypt's internal read and write workqueues. Enabling this should improve performance on SSDs; see - <link xlink:href="https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance">here</link> + [here](https://wiki.archlinux.org/index.php/Dm-crypt/Specialties#Disable_workqueue_for_increased_solid_state_drive_(SSD)_performance) for more information. Needs Linux 5.9 or later. ''; }; @@ -641,7 +652,7 @@ in fallbackToPassword = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to fallback to interactive passphrase prompt if the keyfile cannot be found. This will prevent unattended boot should the keyfile go missing. @@ -650,7 +661,7 @@ in gpgCard = mkOption { default = null; - description = '' + description = lib.mdDoc '' The option to use this LUKS device with a GPG encrypted luks password by the GPG Smartcard. If null (the default), GPG-Smartcard will be disabled for this device. ''; @@ -660,17 +671,17 @@ in gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the GPG Smartcard."; + description = lib.mdDoc "Time in seconds to wait for the GPG Smartcard."; }; encryptedPass = mkOption { type = types.path; - description = "Path to the GPG encrypted passphrase."; + description = lib.mdDoc "Path to the GPG encrypted passphrase."; }; publicKey = mkOption { type = types.path; - description = "Path to the Public Key."; + description = lib.mdDoc "Path to the Public Key."; }; }; }); @@ -681,29 +692,29 @@ in default = null; example = "f1d00200d8dc783f7fb1e10ace8da27f8312d72692abfca2f7e4960a73f48e82e1f7571f6ebfcee9fb434f9886ccc8fcc52a6614d8d2"; type = types.nullOr types.str; - description = "The FIDO2 credential ID."; + description = lib.mdDoc "The FIDO2 credential ID."; }; gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the FIDO2 key."; + description = lib.mdDoc "Time in seconds to wait for the FIDO2 key."; }; passwordLess = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Defines whatever to use an empty string as a default salt. - Enable only when your device is PIN protected, such as <link xlink:href="https://trezor.io/">Trezor</link>. + Enable only when your device is PIN protected, such as [Trezor](https://trezor.io/). ''; }; }; yubikey = mkOption { default = null; - description = '' + description = lib.mdDoc '' The options to use for this LUKS device in YubiKey-PBA. If null (the default), YubiKey-PBA will be disabled for this device. ''; @@ -713,37 +724,37 @@ in twoFactor = mkOption { default = true; type = types.bool; - description = "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; + description = lib.mdDoc "Whether to use a passphrase and a YubiKey (true), or only a YubiKey (false)."; }; slot = mkOption { default = 2; type = types.int; - description = "Which slot on the YubiKey to challenge."; + description = lib.mdDoc "Which slot on the YubiKey to challenge."; }; saltLength = mkOption { default = 16; type = types.int; - description = "Length of the new salt in byte (64 is the effective maximum)."; + description = lib.mdDoc "Length of the new salt in byte (64 is the effective maximum)."; }; keyLength = mkOption { default = 64; type = types.int; - description = "Length of the LUKS slot key derived with PBKDF2 in byte."; + description = lib.mdDoc "Length of the LUKS slot key derived with PBKDF2 in byte."; }; iterationStep = mkOption { default = 0; type = types.int; - description = "How much the iteration count for PBKDF2 is increased at each successful authentication."; + description = lib.mdDoc "How much the iteration count for PBKDF2 is increased at each successful authentication."; }; gracePeriod = mkOption { default = 10; type = types.int; - description = "Time in seconds to wait for the YubiKey."; + description = lib.mdDoc "Time in seconds to wait for the YubiKey."; }; /* TODO: Add to the documentation of the current module: @@ -754,7 +765,7 @@ in device = mkOption { default = "/dev/sda1"; type = types.path; - description = '' + description = lib.mdDoc '' An unencrypted device that will temporarily be mounted in stage-1. Must contain the current salt to create the challenge for this LUKS device. ''; @@ -763,13 +774,13 @@ in fsType = mkOption { default = "vfat"; type = types.str; - description = "The filesystem of the unencrypted device."; + description = lib.mdDoc "The filesystem of the unencrypted device."; }; path = mkOption { default = "/crypt-storage/default"; type = types.str; - description = '' + description = lib.mdDoc '' Absolute path of the salt on the unencrypted device with that device's root directory as "/". ''; @@ -786,7 +797,7 @@ in mkdir -p /tmp/persistent mount -t zfs rpool/safe/persistent /tmp/persistent ''; - description = '' + description = lib.mdDoc '' Commands that should be run right before we try to mount our LUKS device. This can be useful, if the keys needed to open the drive is on another partion. ''; @@ -798,10 +809,22 @@ in example = '' umount /tmp/persistent ''; - description = '' + description = lib.mdDoc '' Commands that should be run right after we have mounted our LUKS device. ''; }; + + crypttabExtraOpts = mkOption { + type = with types; listOf singleLineStr; + default = []; + example = [ "_netdev" ]; + visible = false; + description = '' + Only used with systemd stage 1. + + Extra options to append to the last column of the generated crypttab file. + ''; + }; }; })); }; @@ -809,7 +832,7 @@ in boot.initrd.luks.gpgSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with a GPG encrypted password. ''; }; @@ -817,7 +840,7 @@ in boot.initrd.luks.yubikeySupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with a YubiKey on LUKS devices. See the NixOS wiki for information on how to properly setup a LUKS device and a YubiKey to work with this feature. @@ -827,7 +850,7 @@ in boot.initrd.luks.fido2Support = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enables support for authenticating with FIDO2 devices. ''; }; @@ -853,6 +876,31 @@ in -> versionAtLeast kernelPackages.kernel.version "5.9"; message = "boot.initrd.luks.devices.<name>.bypassWorkqueues is not supported for kernels older than 5.9"; } + + { assertion = config.boot.initrd.systemd.enable -> all (dev: !dev.fallbackToPassword) (attrValues luks.devices); + message = "boot.initrd.luks.devices.<name>.fallbackToPassword is implied by systemd stage 1."; + } + { assertion = config.boot.initrd.systemd.enable -> all (dev: dev.preLVM) (attrValues luks.devices); + message = "boot.initrd.luks.devices.<name>.preLVM is not used by systemd stage 1."; + } + { assertion = config.boot.initrd.systemd.enable -> options.boot.initrd.luks.reusePassphrases.highestPrio == defaultPrio; + message = "boot.initrd.luks.reusePassphrases has no effect with systemd stage 1."; + } + { assertion = config.boot.initrd.systemd.enable -> all (dev: dev.preOpenCommands == "" && dev.postOpenCommands == "") (attrValues luks.devices); + message = "boot.initrd.luks.devices.<name>.preOpenCommands and postOpenCommands is not supported by systemd stage 1. Please bind a service to cryptsetup.target or cryptsetup-pre.target instead."; + } + # TODO + { assertion = config.boot.initrd.systemd.enable -> !luks.gpgSupport; + message = "systemd stage 1 does not support GPG smartcards yet."; + } + # TODO + { assertion = config.boot.initrd.systemd.enable -> !luks.fido2Support; + message = "systemd stage 1 does not support FIDO2 yet."; + } + # TODO + { assertion = config.boot.initrd.systemd.enable -> !luks.yubikeySupport; + message = "systemd stage 1 does not support Yubikeys yet."; + } ]; # actually, sbp2 driver is the one enabling the DMA attack, but this needs to be tested @@ -867,7 +915,7 @@ in ++ (if builtins.elem "xts" luks.cryptoModules then ["ecb"] else []); # copy the cryptsetup binary and it's dependencies - boot.initrd.extraUtilsCommands = '' + boot.initrd.extraUtilsCommands = mkIf (!config.boot.initrd.systemd.enable) '' copy_bin_and_libs ${pkgs.cryptsetup}/bin/cryptsetup copy_bin_and_libs ${askPass}/bin/cryptsetup-askpass sed -i s,/bin/sh,$out/bin/sh, $out/bin/cryptsetup-askpass @@ -877,7 +925,7 @@ in copy_bin_and_libs ${pkgs.yubikey-personalization}/bin/ykinfo copy_bin_and_libs ${pkgs.openssl.bin}/bin/openssl - cc -O3 -I${pkgs.openssl.dev}/include -L${pkgs.openssl.out}/lib ${./pbkdf2-sha512.c} -o pbkdf2-sha512 -lcrypto + cc -O3 -I${pkgs.openssl.dev}/include -L${lib.getLib pkgs.openssl}/lib ${./pbkdf2-sha512.c} -o pbkdf2-sha512 -lcrypto strip -s pbkdf2-sha512 copy_bin_and_libs pbkdf2-sha512 @@ -915,7 +963,7 @@ in ''} ''; - boot.initrd.extraUtilsCommandsTest = '' + boot.initrd.extraUtilsCommandsTest = mkIf (!config.boot.initrd.systemd.enable) '' $out/bin/cryptsetup --version ${optionalString luks.yubikeySupport '' $out/bin/ykchalresp -V @@ -932,9 +980,28 @@ in ''} ''; - boot.initrd.preFailCommands = postCommands; - boot.initrd.preLVMCommands = commonFunctions + preCommands + concatStrings (mapAttrsToList openCommand preLVM) + postCommands; - boot.initrd.postDeviceCommands = commonFunctions + preCommands + concatStrings (mapAttrsToList openCommand postLVM) + postCommands; + boot.initrd.systemd = { + contents."/etc/crypttab".source = stage1Crypttab; + + extraBin.systemd-cryptsetup = "${config.boot.initrd.systemd.package}/lib/systemd/systemd-cryptsetup"; + + additionalUpstreamUnits = [ + "cryptsetup-pre.target" + "cryptsetup.target" + "remote-cryptsetup.target" + ]; + storePaths = [ + "${config.boot.initrd.systemd.package}/lib/systemd/systemd-cryptsetup" + "${config.boot.initrd.systemd.package}/lib/systemd/system-generators/systemd-cryptsetup-generator" + ]; + + }; + # We do this because we need the udev rules from the package + boot.initrd.services.lvm.enable = true; + + boot.initrd.preFailCommands = mkIf (!config.boot.initrd.systemd.enable) postCommands; + boot.initrd.preLVMCommands = mkIf (!config.boot.initrd.systemd.enable) (commonFunctions + preCommands + concatStrings (mapAttrsToList openCommand preLVM) + postCommands); + boot.initrd.postDeviceCommands = mkIf (!config.boot.initrd.systemd.enable) (commonFunctions + preCommands + concatStrings (mapAttrsToList openCommand postLVM) + postCommands); environment.systemPackages = [ pkgs.cryptsetup ]; }; |