Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1nmtbp-0005D0-P6 for mharc-grub-devel@gnu.org; Fri, 06 May 2022 04:46:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59348) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nmtbn-00056z-Vk for grub-devel@gnu.org; Fri, 06 May 2022 04:46:44 -0400 Received: from mail-vk1-xa2c.google.com ([2607:f8b0:4864:20::a2c]:43797) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nmtbm-0003xR-5Q for grub-devel@gnu.org; Fri, 06 May 2022 04:46:43 -0400 Received: by mail-vk1-xa2c.google.com with SMTP id q136so3260390vke.10 for ; Fri, 06 May 2022 01:46:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=3JObjcWmbJcKdhSTSFMla8UtlagdsQDDGM7ZsuUbKGY=; b=Cz676UhUn8Ku7Jd1qv1PR1s0J/ZZVbPkdx5rS1gvIMEPJJ7RZ5AtqJjFiK81FD0d1I wBnL4CBX4lZku9DFx3eD3EanPdShhJFQpfp+Jp0l16rufxtcLclM2r9OB2Iwmn6IvX/d 5aL+ZWpiVCWg6dxVZWiH/8iS9AU0rCCPfJtKjC024easYdsU9CW/mhThX2O+mlVateJP GE02K09tc/pJmu3HDye0cYdxt83EmgJodRJLffwQRv4rO1gMAzmK3CF4NkrdScA1xNMp LzulTgNxfpYTjI755PRDWLvxL/7ZzmKFs3MUAqX9iRhgfR63kEeKHR3J9aX2ZKuUFnQl LpgQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=3JObjcWmbJcKdhSTSFMla8UtlagdsQDDGM7ZsuUbKGY=; b=tihFvdR9gKlcAwBXuLjDtHon0k0cUD0FmCG0zV93hjXMlQ0hj9h7So0iJ33o7Vwr1k CGhq5WdkiS+kyfsA1DMvNYX+gXzYhoCYDpTa9k+rahY4x5YULpiCaGznsXzzLniXey69 GglmFxX7bYNSfNX/OIHz++mFHpqEIHVYtv3h6p1niOY+bVzRBs0BmxCMKZX6YqTtbBXb lKGIRtK07LOZCmpC07yeJlFaResyzpiKMfRHkQRAMVb/UaJOTaOMvxGkMx+yK7TGlCF3 SIa2SdiJERrn72Vdy17rMHcDQwOsMH+iMANA8AEk62+adYh4O+fFxuv5ogHdTEwVHUB0 umYQ== X-Gm-Message-State: AOAM532hX8HbnbVcBDzO/mZ77TaA42Y0reRigeIUZWLCj+W1w3aLu9u+ vHb79trWjvh3E9DgyG19wta4gjKEajxhtaww X-Google-Smtp-Source: ABdhPJx08iDabwkjuyyLCpB9vgDxyR2rzqjQgxkK5HS87LpOkfM7CNZ5QYzCqELZFb7IsfqfwrrRrg== X-Received: by 2002:a1f:9f90:0:b0:34e:c9bd:cffe with SMTP id i138-20020a1f9f90000000b0034ec9bdcffemr645162vke.22.1651826801021; Fri, 06 May 2022 01:46:41 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id t19-20020ab06993000000b00362c5d5a021sm657136uaq.32.2022.05.06.01.46.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 May 2022 01:46:40 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH 3/4] cryptodisk: Add options to cryptomount to support keyfiles Date: Fri, 6 May 2022 03:45:59 -0500 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::a2c; envelope-from=development@efficientek.com; helo=mail-vk1-xa2c.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 06 May 2022 08:46:44 -0000 From: John Lane Add the options --key-file, --keyfile-offset, and --keyfile-size to cryptomount and code to put read the requested key file data and pass via the cargs struct. Note, key file data is for all intents and purposes equivalent to a password given to cryptomount. So there is no need to enable support for key files in the various crypto backends (eg. LUKS1) because the key data is passed just as if it were a password. Signed-off-by: John Lane GNUtoo@cyberdimension.org: rebase, patch split, small fixes, commit message Signed-off-by: Denis 'GNUtoo' Carikli development@efficientek.com: rebase and rework to use cryptomount arg passing, minor fixes, improve commit message Signed-off-by: Glenn Washburn --- grub-core/disk/cryptodisk.c | 86 ++++++++++++++++++++++++++++++++++++- include/grub/cryptodisk.h | 2 + include/grub/file.h | 2 + 3 files changed, 89 insertions(+), 1 deletion(-) diff --git a/grub-core/disk/cryptodisk.c b/grub-core/disk/cryptodisk.c index 9f5dc7acb..19af4fa49 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}, {"password", 'p', 0, N_("Password to open volumes."), 0, ARG_TYPE_STRING}, + {"key-file", '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} }; @@ -1172,6 +1175,85 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args) cargs.key_len = grub_strlen (state[3].arg); } + if (state[4].set) /* keyfile */ + { + const char *p = NULL; + grub_file_t keyfile; + unsigned long long keyfile_offset = 0, keyfile_size = 0; + + if (state[5].set) /* keyfile-offset */ + { + keyfile_offset = grub_strtoull (state[5].arg, &p, 0); + + if (grub_errno != GRUB_ERR_NONE) + return grub_errno; + + if (state[5].arg[0] == '\0' || *p != '\0') + return grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("non-numeric or invalid keyfile offset `%s'"), + state[5].arg); + } + + if (state[6].set) /* keyfile-size */ + { + keyfile_size = grub_strtoul (state[6].arg, &p, 0); + + if (state[6].arg[0] == '\0' || *p != '\0') + return grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("non-numeric or invalid keyfile size `%s'"), + state[6].arg); + + if (grub_errno != GRUB_ERR_NONE) + return grub_errno; + + if (keyfile_size > GRUB_CRYPTODISK_MAX_KEYFILE_SIZE) + return grub_error (GRUB_ERR_OUT_OF_RANGE, + N_("key file size exceeds maximum (%d)"), + GRUB_CRYPTODISK_MAX_KEYFILE_SIZE); + + if (keyfile_size == 0) + return grub_error (GRUB_ERR_OUT_OF_RANGE, N_("key file size is 0")); + } + + keyfile = grub_file_open (state[4].arg, + GRUB_FILE_TYPE_CRYPTODISK_ENCRYPTION_KEY); + if (keyfile == NULL) + return grub_errno; + + if (keyfile_offset > keyfile->size) + { + keyfile_offset = keyfile->size; + grub_dprintf ("cryptodisk","Keyfile offset, %llu, is greater than" + "keyfile size, %" PRIuGRUB_UINT64_T "\n", + keyfile_offset, keyfile->size); + } + + if (grub_file_seek (keyfile, (grub_off_t) keyfile_offset) == (grub_off_t) -1) + return grub_errno; + + if (keyfile_size > 0) + { + if (keyfile_size > (keyfile->size - keyfile_offset)) + return grub_error (GRUB_ERR_FILE_READ_ERROR, + N_("keyfile is too small: requested %llu bytes," + " but the file only has %" PRIuGRUB_UINT64_T + " bytes"), + keyfile_size, + keyfile->size); + + cargs.key_len = keyfile_size; + } + else + cargs.key_len = keyfile->size - keyfile_offset; + + cargs.key_data = grub_malloc (cargs.key_len); + if (cargs.key_data == NULL) + return GRUB_ERR_OUT_OF_MEMORY; + + if (grub_file_read (keyfile, cargs.key_data, cargs.key_len) != (grub_ssize_t) cargs.key_len) + return grub_error (GRUB_ERR_FILE_READ_ERROR, (N_("reading key file"))); + } + if (state[0].set) /* uuid */ { int found_uuid; @@ -1384,7 +1466,9 @@ GRUB_MOD_INIT (cryptodisk) { grub_disk_dev_register (&grub_cryptodisk_dev); cmd = grub_register_extcmd ("cryptomount", grub_cmd_cryptomount, 0, - N_("[-p password] "), + N_("[ [-p password] | [-k keyfile" + " [-O keyoffset] [-S keysize] ] ]" + " "), N_("Mount a crypto device."), options); grub_procfs_register ("luks_script", &luks_script); } diff --git a/include/grub/cryptodisk.h b/include/grub/cryptodisk.h index c6524c9ea..467065f00 100644 --- a/include/grub/cryptodisk.h +++ b/include/grub/cryptodisk.h @@ -61,6 +61,8 @@ typedef enum #define GRUB_CRYPTODISK_MAX_KEYLEN 128 #define GRUB_CRYPTODISK_MAX_PASSPHRASE 256 +#define GRUB_CRYPTODISK_MAX_KEYFILE_SIZE 8192 + struct grub_cryptodisk; typedef gcry_err_code_t diff --git a/include/grub/file.h b/include/grub/file.h index 31567483c..d53ee8edd 100644 --- a/include/grub/file.h +++ b/include/grub/file.h @@ -90,6 +90,8 @@ enum grub_file_type GRUB_FILE_TYPE_FONT, /* File holding encryption key for encrypted ZFS. */ GRUB_FILE_TYPE_ZFS_ENCRYPTION_KEY, + /* File holding 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.34.1