v6 for detached headers and key files
PATCH 1/1 v6 for detached headers and key files
Hi,
Here's a new version of this patchset.
The only change with the v5 is that I fixed the issue that Glenn Washburn found (in the 4/6 patch, one of the grub_file_seek return code wasn't properly checked). Thanks for finding the issue.
I also took some time to send it again because I tried to test with the chainload with Coreboot in order to minimize the risk of non-booting computer, and as it took too much time (missing modules, etc), I ended up dedicating a computer with SeaBIOS for the test.
Denis.
PATCH v6 1/6 cryptodisk: luks: unify grub_cryptodisk_dev function names
---
ChangeLog since v4:
- Added Reviewed-by tag
ChangeLog since v5:
- No changes
--- grub-core/disk/luks.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
grub-core/disk/luks.c +2 -3
@@ -65,8 +65,7 @@ gcry_err_code_t AF_merge (const gcry_md_spec_t * hash, grub_uint8_t * src, grub_size_t blocknumbers);static grub_cryptodisk_t -configure_ciphers (grub_disk_t disk,const char *check_uuid, -int check_boot) +luks_scan (grub_disk_t disk,const char *check_uuid,int check_boot) {grub_cryptodisk_t newdev;const char *iptr;
@@ -310,7 +309,7 @@ luks_recover_key (grub_disk_t source, }struct grub_cryptodisk_dev luks_crypto = { - .scan = configure_ciphers, + .scan = luks_scan, .recover_key = luks_recover_key };
Signature · 1 line
2.28.0
PATCH v6 2/6 cryptodisk: geli: unify grub_cryptodisk_dev function names
In reply to Denis 'GNUtoo' Carikli---
ChangeLog since v4:
- Added Reviewed-by tag
ChangeLog since v5:
- No changes
--- grub-core/disk/geli.c | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
grub-core/disk/geli.c +4 -5
@@ -242,8 +242,7 @@ grub_util_get_geli_uuid (const char *dev)#endif static grub_cryptodisk_t -configure_ciphers (grub_disk_t disk,const char *check_uuid, -int boot_only) +geli_scan (grub_disk_t disk,const char *check_uuid,int boot_only) {grub_cryptodisk_t newdev;struct grub_geli_phdr header;
@@ -398,7 +397,7 @@ configure_ciphers (grub_disk_t disk, const char *check_uuid, }static grub_err_t -recover_key (grub_disk_t source,grub_cryptodisk_t dev) +geli_recover_key (grub_disk_t source,grub_cryptodisk_t dev) {grub_size_t keysize;grub_uint8_t digest[GRUB_CRYPTO_MAX_MDLEN ];
@@ -580,8 +579,8 @@ recover_key (grub_disk_t source, grub_cryptodisk_t dev) }struct grub_cryptodisk_dev geli_crypto = { - .scan = configure_ciphers, - .recover_key = recover_key + .scan = geli_scan, + .recover_key = geli_recover_key };GRUB_MOD_INIT (geli)
Signature · 1 line
2.28.0
PATCH v6 3/6 cryptodisk: enable the backends to implement detached headers
In reply to Denis 'GNUtoo' CarikliFrom: John Lane <[email protected]>
[email protected]: rebase, patch split, small fixes, commit message
---
ChangeLog since v4:
- Added Reviewed-by tag
ChangeLog since v5:
- No changes
--- grub-core/disk/cryptodisk.c | 24 ++++++++++++++++++++---- grub-core/disk/geli.c | 15 +++++++++++++-- grub-core/disk/luks.c | 14 +++++++++++--- grub-core/disk/luks2.c | 15 ++++++++++++--- include/grub/cryptodisk.h | 6 ++++-- include/grub/file.h | 2 ++ 6 files changed, 62 insertions(+), 14 deletions(-)
grub-core/disk/cryptodisk.c +20 -4
@@ -41,6 +41,7 @@ static const struct grub_arg_option options[] =/* TRANSLATORS: It's still restricted to cryptodisks only. */ {"all", 'a', 0, N_("Mount all."), 0, 0}, {"boot", 'b', 0, N_("Mount all volumes with `boot' flag set."), 0, 0}, + {"header", 'H', 0, N_("Read header from file"), 0, ARG_TYPE_STRING}, {0, 0, 0, 0, 0, 0} };
@@ -970,6 +971,7 @@ grub_util_cryptodisk_get_uuid (grub_disk_t disk)static int check_boot, have_it;static char *search_uuid; +static grub_file_t hdr;static void cryptodisk_close (grub_cryptodisk_t dev)
@@ -994,13 +996,13 @@ grub_cryptodisk_scan_device_real (const char *name, grub_disk_t source)FOR_CRYPTODISK_DEVS (cr) { - dev = cr->scan (source, search_uuid, check_boot); + dev = cr->scan (source, search_uuid, check_boot, hdr);if (grub_errno)return grub_errno;if (!dev)continue ; - err = cr->recover_key (source, dev); + err = cr->recover_key (source, dev, hdr);if (err) {cryptodisk_close (dev);
@@ -1041,7 +1043,7 @@ grub_cryptodisk_cheat_mount (const char *sourcedev, const char *cheat)FOR_CRYPTODISK_DEVS (cr) { - dev = cr->scan (source, search_uuid, check_boot); + dev = cr->scan (source, search_uuid, check_boot,NULL );if (grub_errno)return grub_errno;if (!dev)
@@ -1095,6 +1097,20 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args)if (argc <1 && !state[1 ].set && !state[2 ].set)return grub_error (GRUB_ERR_BAD_ARGUMENT ,"device name required" ); +if (state[3 ].set)/* Detached header */ + { +if (state[0 ].set) +return grub_error (GRUB_ERR_BAD_ARGUMENT , +N_ ("Cannot use UUID lookup with detached header" )); + + hdr =grub_file_open (state[3 ].arg, +GRUB_FILE_TYPE_CRYPTODISK_DETACHED_HEADER ); +if (!hdr) +return grub_errno; + } +else + hdr =NULL ; + have_it =0 ;if (state[0 ].set) {
@@ -1302,7 +1318,7 @@ GRUB_MOD_INIT (cryptodisk) {grub_disk_dev_register (&grub_cryptodisk_dev); cmd =grub_register_extcmd ("cryptomount" , grub_cmd_cryptomount,0 , -N_ ("SOURCE|-u UUID|-a|-b" ), +N_ ("SOURCE|-u UUID|-a|-b|-H file" ),N_ ("Mount a crypto device." ), options);grub_procfs_register ("luks_script" , &luks_script); }
grub-core/disk/geli.c +13 -2
@@ -52,6 +52,7 @@#include <grub/dl.h> #include <grub/err.h> #include <grub/disk.h> +#include <grub/file.h> #include <grub/crypto.h> #include <grub/partition.h> #include <grub/i18n.h>
@@ -121,6 +122,7 @@ enum/* FIXME: support version 0. */ /* FIXME: support big-endian pre-version-4 volumes. */ +/* FIXME: support for detached headers. */ /* FIXME: support for keyfiles. */ /* FIXME: support for HMAC. */ const char *algorithms[] = {
@@ -242,7 +244,8 @@ grub_util_get_geli_uuid (const char *dev)#endif static grub_cryptodisk_t -geli_scan (grub_disk_t disk,const char *check_uuid,int boot_only) +geli_scan (grub_disk_t disk,const char *check_uuid,int boot_only, +grub_file_t hdr) {grub_cryptodisk_t newdev;struct grub_geli_phdr header;
@@ -254,6 +257,10 @@ geli_scan (grub_disk_t disk, const char *check_uuid, int boot_only)grub_disk_addr_t sector;grub_err_t err; +/* Detached headers are not implemented yet */ +if (hdr) +return NULL ; +if (2 *GRUB_MD_SHA256 ->mdlen +1 >GRUB_CRYPTODISK_MAX_UUID_LENGTH )return NULL ;
@@ -397,7 +404,7 @@ geli_scan (grub_disk_t disk, const char *check_uuid, int boot_only) }static grub_err_t -geli_recover_key (grub_disk_t source,grub_cryptodisk_t dev) +geli_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr) {grub_size_t keysize;grub_uint8_t digest[GRUB_CRYPTO_MAX_MDLEN ];
@@ -413,6 +420,10 @@ geli_recover_key (grub_disk_t source, grub_cryptodisk_t dev)grub_disk_addr_t sector;grub_err_t err; +/* Detached headers are not implemented yet */ +if (hdr) +return GRUB_ERR_NOT_IMPLEMENTED_YET ; +if (dev->cipher->cipher->blocksize >GRUB_CRYPTO_MAX_CIPHER_BLOCKSIZE )return grub_error (GRUB_ERR_BUG ,"cipher block is too long" );
grub-core/disk/luks.c +11 -3
@@ -65,7 +65,8 @@ gcry_err_code_t AF_merge (const gcry_md_spec_t * hash, grub_uint8_t * src, grub_size_t blocknumbers);static grub_cryptodisk_t -luks_scan (grub_disk_t disk,const char *check_uuid,int check_boot) +luks_scan (grub_disk_t disk,const char *check_uuid,int check_boot, +grub_file_t hdr) {grub_cryptodisk_t newdev;const char *iptr;
@@ -77,6 +78,10 @@ luks_scan (grub_disk_t disk, const char *check_uuid, int check_boot)char hashspec[sizeof (header.hashSpec) +1 ];grub_err_t err; +/* Detached headers are not implemented yet */ +if (hdr) +return NULL ; +if (check_boot)return NULL ;
@@ -149,8 +154,7 @@ luks_scan (grub_disk_t disk, const char *check_uuid, int check_boot) }static grub_err_t -luks_recover_key (grub_disk_t source, -grub_cryptodisk_t dev) +luks_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr) {struct grub_luks_phdr header;grub_size_t keysize;
@@ -163,6 +167,10 @@ luks_recover_key (grub_disk_t source,grub_size_t max_stripes =1 ;char *tmp; +/* Detached headers are not implemented yet */ +if (hdr) +return GRUB_ERR_NOT_IMPLEMENTED_YET ; + err =grub_disk_read (source,0 ,0 ,sizeof (header), &header);if (err)return err;
grub-core/disk/luks2.c +12 -3
@@ -342,11 +342,16 @@ luks2_read_header (grub_disk_t disk, grub_luks2_header_t *outhdr) }static grub_cryptodisk_t -luks2_scan (grub_disk_t disk,const char *check_uuid,int check_boot) +luks2_scan (grub_disk_t disk,const char *check_uuid,int check_boot, +grub_file_t hdr_file) {grub_cryptodisk_t cryptodisk;grub_luks2_header_t header; +/* Detached headers are not implemented yet */ +if (hdr_file) +return NULL ; +if (check_boot)return NULL ;
@@ -523,8 +528,8 @@ luks2_decrypt_key (grub_uint8_t *out_key, }static grub_err_t -luks2_recover_key (grub_disk_t disk, -grub_cryptodisk_t crypt) +luks2_recover_key (grub_disk_t disk,grub_cryptodisk_t crypt, +grub_file_t hdr_file) {grub_uint8_t candidate_key[GRUB_CRYPTODISK_MAX_KEYLEN ];char passphrase[MAX_PASSPHRASE ], cipher[32 ];
@@ -538,6 +543,10 @@ luks2_recover_key (grub_disk_t disk,grub_json_t *json =NULL , keyslots;grub_err_t ret; +/* Detached headers are not implemented yet */ +if (hdr_file) +return GRUB_ERR_NOT_IMPLEMENTED_YET ; + ret =luks2_read_header (disk, &header);if (ret)return ret;
include/grub/cryptodisk.h +4 -2
@@ -20,6 +20,7 @@#define GRUB_CRYPTODISK_HEADER 1#include <grub/disk.h> +#include <grub/file.h> #include <grub/crypto.h> #include <grub/list.h> #ifdef GRUB_UTIL
@@ -107,8 +108,9 @@ struct grub_cryptodisk_devstruct grub_cryptodisk_dev **prev;grub_cryptodisk_t (*scan) (grub_disk_t disk,const char *check_uuid, -int boot_only); -grub_err_t (*recover_key) (grub_disk_t disk,grub_cryptodisk_t dev); +int boot_only,grub_file_t hdr); +grub_err_t (*recover_key) (grub_disk_t disk,grub_cryptodisk_t dev, +grub_file_t hdr); };typedef struct grub_cryptodisk_dev *grub_cryptodisk_dev_t ;
include/grub/file.h +2 -0
@@ -90,6 +90,8 @@ enum grub_file_typeGRUB_FILE_TYPE_FONT ,/* File holding encryption key for encrypted ZFS. */ GRUB_FILE_TYPE_ZFS_ENCRYPTION_KEY , +/* File holiding the encryption metadata header */ +GRUB_FILE_TYPE_CRYPTODISK_DETACHED_HEADER ,/* File we open n grub-fstest. */ GRUB_FILE_TYPE_FSTEST,/* File we open n grub-mount. */
Signature · 1 line
2.28.0
PATCH v6 4/6 cryptodisk: add support for LUKS1 detached headers
In reply to Denis 'GNUtoo' CarikliFrom: John Lane <[email protected]>
cryptsetup supports having a detached header through the --header command line argument for both LUKS1 and LUKS2.
This adds support for LUKS1 detached headers.
[email protected]: rebase, small fixes, commit message
---
ChangeLog since v4:
- Added Reviewed-by tag
ChangeLog since v5:
- Fixed missing grub_file_seek return value check
--- grub-core/disk/luks.c | 48 ++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 14 deletions(-)
grub-core/disk/luks.c +34 -14
@@ -23,6 +23,7 @@#include <grub/dl.h> #include <grub/err.h> #include <grub/disk.h> +#include <grub/file.h> #include <grub/crypto.h> #include <grub/partition.h> #include <grub/i18n.h>
@@ -76,17 +77,23 @@ luks_scan (grub_disk_t disk, const char *check_uuid, int check_boot,char ciphername[sizeof (header.cipherName) +1 ];char ciphermode[sizeof (header.cipherMode) +1 ];char hashspec[sizeof (header.hashSpec) +1 ]; -grub_err_t err; - -/* Detached headers are not implemented yet */ -if (hdr) -return NULL ; +grub_err_t err =GRUB_ERR_NONE ;if (check_boot)return NULL ;/* Read the LUKS header. */ - err =grub_disk_read (disk,0 ,0 ,sizeof (header), &header); +if (hdr) + { +if (grub_file_seek (hdr,0 ) == (grub_off_t) -1 ) +return NULL ; + +if (grub_file_read (hdr, &header,sizeof (header)) !=sizeof (header)) +return NULL ; + } +else + err =grub_disk_read (disk,0 ,0 ,sizeof (header), &header); +if (err) {if (err ==GRUB_ERR_OUT_OF_RANGE )
@@ -163,15 +170,22 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr)grub_uint8_t candidate_digest[sizeof (header.mkDigest)];unsigned i;grub_size_t length; -grub_err_t err; +grub_err_t err =GRUB_ERR_NONE ;grub_size_t max_stripes =1 ;char *tmp; +grub_uint32_t sector; -/* Detached headers are not implemented yet */ if (hdr) -return GRUB_ERR_NOT_IMPLEMENTED_YET ; + { +if (grub_file_seek (hdr,0 ) == (grub_off_t) -1 ) +return grub_errno; + +if (grub_file_read (hdr, &header,sizeof (header)) !=sizeof (header)) +return grub_errno; + } +else + err =grub_disk_read (source,0 ,0 ,sizeof (header), &header); - err =grub_disk_read (source,0 ,0 ,sizeof (header), &header);if (err)return err;
@@ -240,13 +254,19 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr)return grub_crypto_gcry_error (gcry_err); } + sector =grub_be_to_cpu32 (header.keyblock[i].keyMaterialOffset); length = (keysize *grub_be_to_cpu32 (header.keyblock[i].stripes));/* Read and decrypt the key material from the disk. */ - err =grub_disk_read (source, -grub_be_to_cpu32 (header.keyblock - [i].keyMaterialOffset),0 , - length, split_key); +if (hdr) + { +if (grub_file_seek (hdr, sector *512 ) == (grub_off_t) -1 ) +return grub_errno; +if (grub_file_read (hdr, split_key, length) != (grub_ssize_t )length) +return grub_errno; + } +else + err =grub_disk_read (source, sector,0 , length, split_key);if (err) {grub_free (split_key);
Signature · 1 line
2.28.0
PATCH v6 5/6 cryptodisk: enable the backends to implement key files
In reply to Denis 'GNUtoo' CarikliFrom: John Lane <[email protected]>
[email protected]: rebase, patch split, small fixes, commit message
---
Changelog since v3:
-------------------
- Fixed the size formating with PRIuGRUB_SIZE
- Added Reviewed-by
ChangeLog since v4:
-------------------
- Style fixes:
- Added missing space between function and '('
- Removed trailing backslashes in split strings
ChangeLog since v5:
-------------------
- No changes
--- grub-core/disk/cryptodisk.c | 87 ++++++++++++++++++++++++++++++++++++- grub-core/disk/geli.c | 7 +-- grub-core/disk/luks.c | 7 ++- grub-core/disk/luks2.c | 7 +-- include/grub/cryptodisk.h | 5 ++- include/grub/file.h | 2 + 6 files changed, 106 insertions(+), 9 deletions(-)
grub-core/disk/cryptodisk.c +86 -1
@@ -42,6 +42,9 @@ static const struct grub_arg_option options[] = {"all", 'a', 0, N_("Mount all."), 0, 0}, {"boot", 'b', 0, N_("Mount all volumes with `boot' flag set."), 0, 0}, {"header", 'H', 0, N_("Read header from file"), 0, ARG_TYPE_STRING}, + {"keyfile", 'k', 0, N_("Key file"), 0, ARG_TYPE_STRING}, + {"keyfile-offset", 'O', 0, N_("Key file offset (bytes)"), 0, ARG_TYPE_INT}, + {"keyfile-size", 'S', 0, N_("Key file data size (bytes)"), 0, ARG_TYPE_INT}, {0, 0, 0, 0, 0, 0} };
@@ -972,6 +975,8 @@ grub_util_cryptodisk_get_uuid (grub_disk_t disk)static int check_boot, have_it;static char *search_uuid;static grub_file_t hdr; +static grub_uint8_t *key, keyfile_buffer[GRUB_CRYPTODISK_MAX_KEYFILE_SIZE ]; +static grub_ssize_t key_size;static void cryptodisk_close (grub_cryptodisk_t dev)
@@ -1002,7 +1007,7 @@ grub_cryptodisk_scan_device_real (const char *name, grub_disk_t source)if (!dev)continue ; - err = cr->recover_key (source, dev, hdr); + err = cr->recover_key (source, dev, hdr, key, key_size);if (err) {cryptodisk_close (dev);
@@ -1112,6 +1117,86 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) hdr =NULL ; have_it =0 ; + key =NULL ; + +if (state[4 ].set)/* keyfile */ + { +const char *p =NULL ; +grub_file_t keyfile; +int keyfile_offset; +grub_size_t requested_keyfile_size =0 ; + + +if (state[5 ].set)/* keyfile-offset */ + { + keyfile_offset =grub_strtoul (state[5 ].arg, &p,0 ); + +if (grub_errno !=GRUB_ERR_NONE ) +return grub_errno; + +if (*p !='\0' ) +return grub_error (GRUB_ERR_BAD_ARGUMENT , +N_ ("unrecognized number" )); + } +else + { + keyfile_offset =0 ; + } + +if (state[6 ].set)/* keyfile-size */ + { + requested_keyfile_size =grub_strtoul (state[6 ].arg, &p,0 ); + +if (*p !='\0' ) +return grub_error (GRUB_ERR_BAD_ARGUMENT , +N_ ("unrecognized number" )); + +if (grub_errno !=GRUB_ERR_NONE ) +return grub_errno; + +if (requested_keyfile_size >GRUB_CRYPTODISK_MAX_KEYFILE_SIZE ) +return grub_error (GRUB_ERR_OUT_OF_RANGE , +N_ ("Key file size exceeds maximum (%" + PRIuGRUB_SIZE")\n" ), +GRUB_CRYPTODISK_MAX_KEYFILE_SIZE ); + +if (requested_keyfile_size ==0 ) +return grub_error (GRUB_ERR_OUT_OF_RANGE , +N_ ("Key file size is 0\n" )); + } + + keyfile =grub_file_open (state[4 ].arg, +GRUB_FILE_TYPE_CRYPTODISK_ENCRYPTION_KEY ); +if (!keyfile) +return grub_errno; + +if (grub_file_seek (keyfile, keyfile_offset) == (grub_off_t)-1 ) +return grub_errno; + +if (requested_keyfile_size) + { +if (requested_keyfile_size > (keyfile->size - keyfile_offset)) +return grub_error (GRUB_ERR_FILE_READ_ERROR , +N_ ("Keyfile is too small: " +"requested %" PRIuGRUB_SIZE" bytes, " +"but the file only has %" PRIuGRUB_SIZE +" bytes.\n" ), + requested_keyfile_size, + keyfile->size); + + key_size = requested_keyfile_size; + } +else + { + key_size = keyfile->size - keyfile_offset; + } + +if (grub_file_read (keyfile, keyfile_buffer, key_size) != key_size) +return grub_error (GRUB_ERR_FILE_READ_ERROR , + (N_ ("Error reading key file\n" ))); + key = keyfile_buffer; + } +if (state[0 ].set) {grub_cryptodisk_t dev;
grub-core/disk/geli.c +4 -3
@@ -404,7 +404,8 @@ geli_scan (grub_disk_t disk, const char *check_uuid, int boot_only, }static grub_err_t -geli_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr) +geli_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr, +grub_uint8_t *key,grub_size_t keyfile_size) {grub_size_t keysize;grub_uint8_t digest[GRUB_CRYPTO_MAX_MDLEN ];
@@ -420,8 +421,8 @@ geli_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr)grub_disk_addr_t sector;grub_err_t err; -/* Detached headers are not implemented yet */ -if (hdr) +/* Detached headers and keyfiles are not implemented yet */ +if (hdr || key || keyfile_size)return GRUB_ERR_NOT_IMPLEMENTED_YET ;if (dev->cipher->cipher->blocksize >GRUB_CRYPTO_MAX_CIPHER_BLOCKSIZE )
grub-core/disk/luks.c +6 -1
@@ -161,7 +161,8 @@ luks_scan (grub_disk_t disk, const char *check_uuid, int check_boot, }static grub_err_t -luks_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr) +luks_recover_key (grub_disk_t source,grub_cryptodisk_t dev,grub_file_t hdr, +grub_uint8_t *keyfile_bytes,grub_size_t keyfile_bytes_size) {struct grub_luks_phdr header;grub_size_t keysize;
@@ -175,6 +176,10 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr)char *tmp;grub_uint32_t sector; +/* Keyfiles are not implemented yet */ +if (keyfile_bytes || keyfile_bytes_size) +return GRUB_ERR_NOT_IMPLEMENTED_YET ; +if (hdr) {if (grub_file_seek (hdr,0 ) == (grub_off_t) -1 )
grub-core/disk/luks2.c +4 -3
@@ -529,7 +529,8 @@ luks2_decrypt_key (grub_uint8_t *out_key,static grub_err_t luks2_recover_key (grub_disk_t disk,grub_cryptodisk_t crypt, -grub_file_t hdr_file) +grub_file_t hdr_file,grub_uint8_t *key, +grub_size_t keyfile_size) {grub_uint8_t candidate_key[GRUB_CRYPTODISK_MAX_KEYLEN ];char passphrase[MAX_PASSPHRASE ], cipher[32 ];
@@ -543,8 +544,8 @@ luks2_recover_key (grub_disk_t disk, grub_cryptodisk_t crypt,grub_json_t *json =NULL , keyslots;grub_err_t ret; -/* Detached headers are not implemented yet */ -if (hdr_file) +/* Detached headers and keyfiles are not implemented yet */ +if (hdr_file || key || keyfile_size)return GRUB_ERR_NOT_IMPLEMENTED_YET ; ret =luks2_read_header (disk, &header);
include/grub/cryptodisk.h +4 -1
@@ -55,6 +55,8 @@ typedef enum#define GRUB_CRYPTODISK_GF_BYTES (1U << GRUB_CRYPTODISK_GF_LOG_BYTES)#define GRUB_CRYPTODISK_MAX_KEYLEN 128 +#define GRUB_CRYPTODISK_MAX_KEYFILE_SIZE 8192 +struct grub_cryptodisk ; typedef gcry_err_code_t
@@ -110,7 +112,8 @@ struct grub_cryptodisk_devgrub_cryptodisk_t (*scan) (grub_disk_t disk,const char *check_uuid,int boot_only,grub_file_t hdr);grub_err_t (*recover_key) (grub_disk_t disk,grub_cryptodisk_t dev, -grub_file_t hdr); +grub_file_t hdr,grub_uint8_t *key, +grub_size_t keyfile_size); };typedef struct grub_cryptodisk_dev *grub_cryptodisk_dev_t ;
include/grub/file.h +2 -0
@@ -92,6 +92,8 @@ enum grub_file_typeGRUB_FILE_TYPE_ZFS_ENCRYPTION_KEY ,/* File holiding the encryption metadata header */ GRUB_FILE_TYPE_CRYPTODISK_DETACHED_HEADER , +/* File holiding the encryption key */ +GRUB_FILE_TYPE_CRYPTODISK_ENCRYPTION_KEY ,/* File we open n grub-fstest. */ GRUB_FILE_TYPE_FSTEST,/* File we open n grub-mount. */
Signature · 1 line
2.28.0
Re: [PATCH v6 5/6] cryptodisk: enable the backends to implement key files
There are a couple issues with format string conversions that do not currently cause building to fail. However, they will when/if my strict format string checking for grub_error is accepted. Its best to fix them anyway.
Quoted 107 lines · On Wed, 19 Aug 2020 17:09:13 +0200 Denis 'GNUtoo' Carikli…
From: John Lane <[email protected]>
Signed-off-by John Lane <[email protected]>[email protected]: rebase, patch split, small fixes, commit message Signed-off-by: Denis 'GNUtoo' Carikli <[email protected]> Reviewed-by: Patrick Steinhardt <[email protected]> ---
Changelog since v3:
-------------------
- Fixed the size formating withPRIuGRUB_SIZE
- Added Reviewed-byChangeLog since v4:
-------------------
- Style fixes:
- Added missing space between function and '('
- Removed trailing backslashes in split stringsChangeLog since v5:
-------------------
- No changes--- grub-core/disk/cryptodisk.c | 87 ++++++++++++++++++++++++++++++++++++- grub-core/disk/geli.c | 7 +-- grub-core/disk/luks.c | 7 ++- grub-core/disk/luks2.c | 7 +-- include/grub/cryptodisk.h | 5 ++- include/grub/file.h | 2 + 6 files changed, 106 insertions(+), 9 deletions(-)grub-core/disk/cryptodisk.c +3
-0@@ -42,6 +42,9 @@ static const struct grub_arg_option options[] = {"all", 'a', 0, N_("Mount all."), 0, 0}, {"boot", 'b', 0, N_("Mount all volumes with `boot' flag set."), 0, 0}, {"header", 'H', 0, N_("Read header from file"), 0, ARG_TYPE_STRING}, + {"keyfile", 'k', 0, N_("Key file"), 0, ARG_TYPE_STRING}, + {"keyfile-offset", 'O', 0, N_("Key file offset (bytes)"), 0, ARG_TYPE_INT}, + {"keyfile-size", 'S', 0, N_("Key file data size (bytes)"), 0, ARG_TYPE_INT}, {0, 0, 0, 0, 0, 0}};grub-core/disk/cryptodisk.c +1
-0@@ -972,6 +975,8 @@ grub_util_cryptodisk_get_uuid (grub_disk_t disk)static int check_boot, have_it;static char *search_uuid;static grub_file_t hdr; +static grub_uint8_t *key,keyfile_buffer[GRUB_CRYPTODISK_MAX_KEYFILE_SIZE]; +static
grub_ssize_tkey_size;
static void
cryptodisk_close(grub_cryptodisk_tdev)grub-core/disk/cryptodisk.c +30
-1@@ -1002,7 +1007,7 @@ grub_cryptodisk_scan_device_real (const char *name, grub_disk_t source) if (!dev)continue ; - err = cr->recover_key (source, dev, hdr); + err = cr->recover_key (source, dev, hdr, key, key_size);if (err) {cryptodisk_close (dev);@@ -1112,6 +1117,86 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) hdr = NULL; have_it =0 ; + key =NULL ; + +if (state[4 ].set)/* keyfile */ + { +const char *p =NULL ; +grub_file_t keyfile; +int keyfile_offset; +grub_size_t requested_keyfile_size =0 ; + + +if (state[5 ].set)/* keyfile-offset */ + { + keyfile_offset =grub_strtoul (state[5 ].arg, &p,0 ); + +if (grub_errno !=GRUB_ERR_NONE ) +return grub_errno; + +if (*p !='\0' ) +return grub_error (GRUB_ERR_BAD_ARGUMENT , +N_ ("unrecognized number" )); + } +else + { + keyfile_offset =0 ; + } + +if (state[6 ].set)/* keyfile-size */ + { + requested_keyfile_size = grub_strtoul (state[6].arg, &p,0); +
grub-core/disk/cryptodisk.c +8
-0+if (*p !='\0' ) +return grub_error (GRUB_ERR_BAD_ARGUMENT , +N_ ("unrecognized number" )); + +if (grub_errno !=GRUB_ERR_NONE ) +return grub_errno; + + if (requested_keyfile_size >
GRUB_CRYPTODISK_MAX_KEYFILE_SIZE)
grub-core/disk/cryptodisk.c grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) · line 1161
Quoted 4 lines
grub-core/disk/cryptodisk.c +4
-0+return grub_error (GRUB_ERR_OUT_OF_RANGE , +N_ ("Key file size exceeds maximum (%" + PRIuGRUB_SIZE")\n" ), +GRUB_CRYPTODISK_MAX_KEYFILE_SIZE );
The macro GRUB_CRYPTODISK_MAX_KEYFILE_SIZE gets expanded to an integer literal which gets type cast as an int, but PRIuGRUB_SIZE expects long or long long. I'd say use "%d" instead of PRIuGRUB_SIZE because GRUB_CRYPTODISK_MAX_KEYFILE_SIZE is a literal and won't change with architecture.
Quoted 24 lines
grub-core/disk/cryptodisk.c +7
-0+if (requested_keyfile_size ==0 ) +return grub_error (GRUB_ERR_OUT_OF_RANGE , +N_ ("Key file size is 0\n" )); + } + + keyfile = grub_file_open (state[4].arg, +
GRUB_FILE_TYPE_CRYPTODISK_ENCRYPTION_KEY);grub-core/disk/cryptodisk.c +9
-0+if (!keyfile) +return grub_errno; + +if (grub_file_seek (keyfile, keyfile_offset) == (grub_off_t)-1 ) +return grub_errno; + +if (requested_keyfile_size) + { + if (requested_keyfile_size > (keyfile->size -
keyfile_offset))grub-core/disk/cryptodisk.c +3
-0+ return grub_error (GRUB_ERR_FILE_READ_ERROR, + N_("Keyfile is too small: " + "requested %" PRIuGRUB_SIZE "bytes, "
grub-core/disk/cryptodisk.c +1
-0+"but the file only has %"
PRIuGRUB_SIZE
grub-core/disk/cryptodisk.c grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) · line 1185
Quoted 3 lines
grub-core/disk/cryptodisk.c +3
-0+ " bytes.\n"), + requested_keyfile_size, + keyfile->size);
The type of keyfile->size is grub_off_t which is typedef'd from grub_uint64_t. There is no problem when building for x86_64 because PRIuGRUB_SIZE expands to %llu, which accepts a 64-bit uint. But when compiling for i386, PRIuGRUB_SIZE expands to %lu, which accepts a 32-bit uint. This will cause the strict format string checking to fail the build. I recommend changing the second PRIuGRUB_SIZE to PRIuGRUB_UINT64_T.
Quoted 18 lines
grub-core/disk/cryptodisk.c +9
-0+ + key_size = requested_keyfile_size; + } +else + { + key_size = keyfile->size - keyfile_offset; + } + + if (grub_file_read (keyfile, keyfile_buffer, key_size) !=
key_size)grub-core/disk/cryptodisk.c +5
-0+return grub_error (GRUB_ERR_FILE_READ_ERROR , + (N_ ("Error reading key file\n" ))); + key = keyfile_buffer; + } +if (state[0 ].set) {grub_cryptodisk_t dev;
PATCH v6 6/6 cryptodisk: Add support for LUKS1 key files
In reply to Denis 'GNUtoo' Cariklicryptsetup supports key files thourh the --key-file --header command line argument for both LUKS1 and LUKS2.
This adds support for LUKS1 key files.
[email protected]: rebase, fixes, commit message
---
ChangeLog since v4:
- Added Reviewed-by tag
ChangeLog since v5:
- No changes
--- grub-core/disk/luks.c | 43 ++++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 17 deletions(-)
grub-core/disk/luks.c +26 -17
@@ -167,7 +167,9 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr,struct grub_luks_phdr header;grub_size_t keysize;grub_uint8_t *split_key =NULL ; -char passphrase[MAX_PASSPHRASE ] ="" ; +char interactive_passphrase[MAX_PASSPHRASE ] ="" ; +grub_uint8_t *passphrase; +grub_size_t passphrase_length;grub_uint8_t candidate_digest[sizeof (header.mkDigest)];unsigned i;grub_size_t length;
@@ -176,10 +178,6 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr,char *tmp;grub_uint32_t sector; -/* Keyfiles are not implemented yet */ -if (keyfile_bytes || keyfile_bytes_size) -return GRUB_ERR_NOT_IMPLEMENTED_YET ; -if (hdr) {if (grub_file_seek (hdr,0 ) == (grub_off_t) -1 )
@@ -208,18 +206,29 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr,if (!split_key)return grub_errno; -/* Get the passphrase from the user. */ - tmp =NULL ; -if (source->partition) - tmp =grub_partition_get_name (source->partition); -grub_printf_ (N_ ("Enter passphrase for %s%s%s (%s): " ), source->name, - source->partition ?"," :"" , tmp ? :"" , - dev->uuid); -grub_free (tmp); -if (!grub_password_get (passphrase,MAX_PASSPHRASE )) +if (keyfile_bytes) { -grub_free (split_key); -return grub_error (GRUB_ERR_BAD_ARGUMENT ,"Passphrase not supplied" ); +/* Use bytestring from key file as passphrase */ + passphrase = keyfile_bytes; + passphrase_length = keyfile_bytes_size; + } +else + { +/* Get the passphrase from the user. */ + tmp =NULL ; +if (source->partition) + tmp =grub_partition_get_name (source->partition); +grub_printf_ (N_ ("Enter passphrase for %s%s%s (%s): " ), source->name, + source->partition ?"," :"" , tmp ? :"" , dev->uuid); +grub_free (tmp); +if (!grub_password_get (interactive_passphrase,MAX_PASSPHRASE )) + { +grub_free (split_key); +return grub_error (GRUB_ERR_BAD_ARGUMENT ,"Passphrase not supplied" ); + } + + passphrase = (grub_uint8_t *)interactive_passphrase; + passphrase_length =grub_strlen (interactive_passphrase); }/* Try to recover master key from each active keyslot. */
@@ -237,7 +246,7 @@ luks_recover_key (grub_disk_t source, grub_cryptodisk_t dev, grub_file_t hdr,/* Calculate the PBKDF2 of the user supplied passphrase. */ gcry_err = grub_crypto_pbkdf2 (dev->hash, (grub_uint8_t *) passphrase, - grub_strlen (passphrase), + passphrase_length, header.keyblock[i].passwordSalt, sizeof (header.keyblock[i].passwordSalt), grub_be_to_cpu32 (header.keyblock[i].
Signature · 1 line
2.28.0
Quoted 8 lines · On Wed, 19 Aug 2020 17:09:08 +0200 Denis 'GNUtoo' Carikli…
Hi,
Here's a new version of this patchset.
The only change with the v5 is that I fixed the issue that Glenn Washburn found (in the 4/6 patch, one of the
grub_file_seekreturn code wasn't properly checked). Thanks for finding the issue.
Quoted 7 lines
I also took some time to send it again because I tried to test with the chainload with Coreboot in order to minimize the risk of non-booting computer, and as it took too much time (missing modules, etc), I ended up dedicating a computer with SeaBIOS for the test.
Denis.
I'm curious, are you using a virtual machine to test grub? If I understand correctly the above, you're using physical machines to test. I'm using qemu and generally testing with x86_64-efi.
Quoted 3 lines · On Wed, 19 Aug 2020 13:59:57 -0500 Glenn Washburn…
I'm curious, are you using a virtual machine to test grub? If I understand correctly the above, you're using physical machines to test. I'm using qemu and generally testing with x86_64-efi.
I don't have a good vm setup for testing yet. I tried to create a self contained test setup with qemu+coreboot+grub as a payload but it ended up being too slow (probably due to my key sizes) and messy as I needed to specify all the modules and I always missed some.
For the v6 I ended up installed grub in /usr/local and then with grub-install + grub-mkconfig on an x86_64 machine running Coreboot and SeaBIOS.
I then created two LVM partitions: one encrypted with the key and the header inside, and another without a header to be opened, and I tested by opening the later and accessing a file inside that I read with cat.
So it was more manual but I could reuse the distribution installation and configuration I already had.
Denis.
Quoted 11 lines · On Sat, 22 Aug 2020 00:25:18 +0200 Denis 'GNUtoo' Carikli…
Quoted 3 lines · On Wed, 19 Aug 2020 13:59:57 -0500 Glenn Washburn…
I'm curious, are you using a virtual machine to test grub? If I understand correctly the above, you're using physical machines to test. I'm using qemu and generally testing with x86_64-efi.
I don't have a good vm setup for testing yet. I tried to create a self contained test setup with qemu+coreboot+grub as a payload but it ended up being too slow (probably due to my key sizes) and messy as I needed to specify all the modules and I always missed some.
I also had issues with things being too slow, like 15min to unlock a luks device. I realized that it was because when cryptosetup adds a key to a luks device it sets the pbkdf iteration count such that it takes '--iter-time' (default 2 seconds) to unlock the master key. The problem was that I was creating the LUKS device outside the VM, but unlocking with the same iteration count inside the VM. And obviously the code running inside the VM is a lot slower. When I created LUKS keys with --pbkdf-force-iterations set to 1000, the minimum, the keys unlocked a lot faster in the VM.
Quoted 7 lines
For the v6 I ended up installed grub in
/usr/localand then with grub-install + grub-mkconfig on anx86_64machine running Coreboot and SeaBIOS.I then created two LVM partitions: one encrypted with the key and the header inside, and another without a header to be opened, and I tested by opening the later and accessing a file inside that I read with cat.
You may find my grub-shell-luks-tester script in my CRYPTOMOUNT-TEST patch set useful in doing tests in a virtual machine as it does a lot of the setup work. Its fairly flexible in that you can pass a cryptsetup script to control what the luks device looks like and a grub script to interact with the luks device. Unfortunately, I'm not sure how to make it interactive yet in the VM (its real intention purpose is headless automated testing).
Quoted 4 lines
So it was more manual but I could reuse the distribution installation and configuration I already had.
Denis.