Mirrors/disko
2
0
Fork 0
mirror of https://github.com/nix-community/disko synced 2024-11-10 06:14:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

Rename keyFile to passwordFile and dedeprecate

Browse source
This commit is contained in:
Florian Engel 2023-08-13 19:32:15 +02:00 committed by mergify[bot]
parent 6388d2859c
commit 3eb703b7bc
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
example/luks-btrfs-subvolumes.nix
View file

@ -29,7 +29,7 @@
extraOpenArgs = [ "--allow-discards" ];
# if you want to use the key for interactive login be sure there is no trailing newline
# for example use `echo -n "password" > /tmp/secret.key`
#keyFile = "/tmp/secret.key"; # Interactive
#passwordFile = "/tmp/secret.key"; # Interactive
settings.keyFile = "/tmp/secret.key";
additionalKeyFiles = [ "/tmp/additionalSecret.key" ];
content = {

12
lib/types/luks.nix
View file

@ -3,8 +3,10 @@ let
keyFile =
if lib.hasAttr "keyFile" config.settings
then config.settings.keyFile
else if config.passwordFile != null
then config.passwordFile
else if config.keyFile != null
then lib.warn "The option `keyFile` is deprecated. See the `settings` option." config.keyFile
then lib.warn "The option `keyFile` is deprecated. Use passwordFile instead" config.keyFile
else null;
keyFileArgs = ''\
${lib.optionalString (keyFile != null) "--key-file ${keyFile}"} \
@ -31,7 +33,13 @@ in
keyFile = lib.mkOption {
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Path to the key for encryption";
description = "Path to the key for encryption (Renamed to passwordFile)";
example = "/tmp/disk.key";
};
passwordFile = lib.mkOption {
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Path to the file which contains the password for initial encryption. Make sure it doesn't contain a trailing newline";
example = "/tmp/disk.key";
};
settings = lib.mkOption {