Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1jE76B-0008Db-UE for mharc-grub-devel@gnu.org; Tue, 17 Mar 2020 03:57:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:48951) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jE768-00088D-1p for grub-devel@gnu.org; Tue, 17 Mar 2020 03:57:13 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jE766-00008o-AS for grub-devel@gnu.org; Tue, 17 Mar 2020 03:57:11 -0400 Received: from cyberdimension.org ([80.67.179.20]:46844 helo=gnutoo.cyberdimension.org) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jE765-00085d-VQ for grub-devel@gnu.org; Tue, 17 Mar 2020 03:57:10 -0400 Received: from gnutoo.cyberdimension.org (localhost [127.0.0.1]) by cyberdimension.org (OpenSMTPD) with ESMTP id b6c647e7; Tue, 17 Mar 2020 07:55:01 +0000 (UTC) Received: from primarylaptop.localdomain (localhost.localdomain [::1]) by gnutoo.cyberdimension.org (OpenSMTPD) with ESMTP id f5ed7259; Tue, 17 Mar 2020 07:55:00 +0000 (UTC) From: Denis 'GNUtoo' Carikli To: Patrick Steinhardt , Daniel Kiper Cc: The development of GNU GRUB , John Lane , Denis 'GNUtoo' Carikli Subject: [PATCHv2][ 5/6] cryptodisk: enable the backends to implement key files Date: Tue, 17 Mar 2020 08:57:39 +0100 Message-Id: <20200317075740.5430-5-GNUtoo@cyberdimension.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200317075740.5430-1-GNUtoo@cyberdimension.org> References: <20200317075740.5430-1-GNUtoo@cyberdimension.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 80.67.179.20 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 17 Mar 2020 07:57:13 -0000 From: John Lane Signed-off-by: John Lane GNUtoo@cyberdimension.org: rebase, patch split, small fixes, commit message Signed-off-by: Denis 'GNUtoo' Carikli --- grub-core/disk/cryptodisk.c | 71 ++++++++++++++++++++++++++++++++++++- grub-core/disk/geli.c | 4 ++- grub-core/disk/luks.c | 4 ++- grub-core/disk/luks2.c | 4 ++- include/grub/cryptodisk.h | 5 ++- include/grub/file.h | 2 ++ 6 files changed, 85 insertions(+), 5 deletions(-) diff --git a/grub-core/disk/cryptodisk.c b/grub-core/disk/cryptodisk.c index fa342fe44..2adb224d0 100644 --- a/grub-core/disk/cryptodisk.c +++ b/grub-core/disk/cryptodisk.c @@ -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,70 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) hdr = NULL; have_it = 0; + key = NULL; + + if (state[4].set) /* keyfile */ + { + 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, 0, 0); + + if (grub_errno != GRUB_ERR_NONE) + return grub_errno; + } + else + { + keyfile_offset = 0; + } + + if (state[6].set) /* keyfile-size */ + { + requested_keyfile_size = grub_strtoul(state[6].arg, 0, 0); + + 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 (%llu)\n"), \ + (unsigned long long) GRUB_CRYPTODISK_MAX_KEYFILE_SIZE); + } + + + 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 (state[6].set) /* keyfile-size */ + { + if (requested_keyfile_size > (keyfile->size - keyfile_offset)) + return grub_error (GRUB_ERR_FILE_READ_ERROR, + N_("Cannot read %llu bytes for key file (read %llu bytes)\n"), + (unsigned long long) requested_keyfile_size, + (unsigned long long) 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; diff --git a/grub-core/disk/geli.c b/grub-core/disk/geli.c index bec0bb877..7b3f3e721 100644 --- a/grub-core/disk/geli.c +++ b/grub-core/disk/geli.c @@ -401,7 +401,9 @@ geli_scan (grub_disk_t disk, const char *check_uuid, int boot_only, static grub_err_t recover_key (grub_disk_t source, grub_cryptodisk_t dev, - grub_file_t hdr __attribute__ ((unused))) + grub_file_t hdr __attribute__ ((unused)), + grub_uint8_t *key __attribute__ ((unused)), + grub_size_t keyfile_size __attribute__ ((unused))) { grub_size_t keysize; grub_uint8_t digest[GRUB_CRYPTO_MAX_MDLEN]; diff --git a/grub-core/disk/luks.c b/grub-core/disk/luks.c index 0b20908ac..d0f65700d 100644 --- a/grub-core/disk/luks.c +++ b/grub-core/disk/luks.c @@ -161,7 +161,9 @@ 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 __attribute__ ((unused)), + grub_size_t keyfile_bytes_size __attribute__ ((unused))) { struct grub_luks_phdr header; grub_size_t keysize; diff --git a/grub-core/disk/luks2.c b/grub-core/disk/luks2.c index 562208e05..48fa93eb2 100644 --- a/grub-core/disk/luks2.c +++ b/grub-core/disk/luks2.c @@ -525,7 +525,9 @@ 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 __attribute__ ((unused))) + grub_file_t hdr_file __attribute__ ((unused)), + grub_uint8_t *key __attribute__ ((unused)), + grub_size_t keyfile_size __attribute__ ((unused))) { grub_uint8_t candidate_key[GRUB_CRYPTODISK_MAX_KEYLEN]; char passphrase[MAX_PASSPHRASE], cipher[32]; diff --git a/include/grub/cryptodisk.h b/include/grub/cryptodisk.h index e24b1b8cb..6d2610f93 100644 --- a/include/grub/cryptodisk.h +++ b/include/grub/cryptodisk.h @@ -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_dev grub_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; diff --git a/include/grub/file.h b/include/grub/file.h index a7d7be853..97678aa45 100644 --- a/include/grub/file.h +++ b/include/grub/file.h @@ -92,6 +92,8 @@ enum grub_file_type GRUB_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. */ -- 2.25.1