Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1npYfS-0001fd-IW for mharc-grub-devel@gnu.org; Fri, 13 May 2022 13:01:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39824) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1npYfP-0001de-2A for grub-devel@gnu.org; Fri, 13 May 2022 13:01:27 -0400 Received: from mail-vs1-xe2f.google.com ([2607:f8b0:4864:20::e2f]:35583) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1npYfI-0004x2-No for grub-devel@gnu.org; Fri, 13 May 2022 13:01:25 -0400 Received: by mail-vs1-xe2f.google.com with SMTP id d22so9031732vsf.2 for ; Fri, 13 May 2022 10:01:20 -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=2mrh1MjmhKm0EFZx5z2b/m0v8d4L7cdfmT3j5QKPfoU=; b=1072I7ILGYt/3rCsC8nsZCf6eQIT4nWm+roKuaPf4wX6WyTmW7E97n3khhfogmr8Vv CmhzARxGwqLLKKiDgXA5csm/7jjyKYGeU6hhcW0HdC/ZeTNDZCucjTqphUDZuZ0ypTTK am0EgZCQ9dVWEjUckpJdIDDL3IeoIgx+DAR1LCPjiUqxpGWCTRYBZn33KNr4WnuzQAm4 hj1jKbfoYwX5I3Ouo1Lm2auyKBOjHDpT8jRtwh9hWscHA5ehKTMRXXB7mspAjKwcfMH5 PvmkwoMjumcraPgIhzkBbCowBDBjVy6jORN0HdB5UsaOmeL91Ya0I14i0LQs1Lfwjgnc PbvA== 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=2mrh1MjmhKm0EFZx5z2b/m0v8d4L7cdfmT3j5QKPfoU=; b=wVK6COTUHsP7hwJ/dChpass0NSKqx2FJn6djTZUtsPVPWQjSBZko+IWpelqmvTKpLn HCgeePDV0rLTdcIUpszX5NQnxwVdTlBq3+XwUaHOZGaAu8fKs6psG0HATjo0RGaFokYH nvHQjKNueKRMBatEsTa8ASCv4lsAGWFaMF5+6eJGdNlOP7HQxMKrtxAxgVp7qPADwpC5 KHwjCsfwCoGLJ8nF0edwbK4JJB1dR9H7e9SnFcEj6IiIsXkVEHbBifS08ddLozBV+PpN 1HSt2X1LN6WlIxby9DC0mzc/SFlcWFZlLKzeWs+xiNJVl5mY4LPPc5yHW36RR/liMQ4X Vy6A== X-Gm-Message-State: AOAM533Z427Kzb4HDCjffPdup8O1Z6mwt+NtD6qOrc4G2dMYWOw++rXG HGzJNL+k4+MRlEYQZpW7uwoYZ9e8S9JZ9q+0 X-Google-Smtp-Source: ABdhPJwt05GQA12TCZOGWn2kIsNNQY3shJSCLUeZYf5Pp9P4v9FGYeJJSoyfpTM2uQXp8011C+6OYA== X-Received: by 2002:a67:df98:0:b0:320:8446:7c6d with SMTP id x24-20020a67df98000000b0032084467c6dmr2447621vsk.16.1652461279547; Fri, 13 May 2022 10:01:19 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id g4-20020a1fe904000000b0034e6f1fd03esm346323vkh.8.2022.05.13.10.01.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 13 May 2022 10:01:18 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH v2 3/5] cryptodisk: Add options to cryptomount to support keyfiles Date: Fri, 13 May 2022 12:00:49 -0500 Message-Id: <34816c2654236ea667ad7e6a29ff08c40050ce2e.1652461132.git.development@efficientek.com> 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::e2f; envelope-from=development@efficientek.com; helo=mail-vs1-xe2f.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, 13 May 2022 17:01:27 -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 | 104 +++++++++++++++++++++++++++++++++++- include/grub/cryptodisk.h | 2 + include/grub/file.h | 2 + 3 files changed, 107 insertions(+), 1 deletion(-) diff --git a/grub-core/disk/cryptodisk.c b/grub-core/disk/cryptodisk.c index 9f5dc7acb..94640b502 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,103 @@ 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 */ + { + char tmp_errmsg[GRUB_MAX_ERRMSG]; + const char *p = NULL; + grub_file_t keyfile; + unsigned long long keyfile_offset = 0, keyfile_size = 0; + + if (state[5].set) /* keyfile-offset */ + { + grub_errno = GRUB_ERR_NONE; + keyfile_offset = grub_strtoull (state[5].arg, &p, 0); + + if (state[5].arg[0] == '\0' || *p != '\0') + { + if (grub_errno != GRUB_ERR_NONE) + { + grub_strncpy (tmp_errmsg, grub_errmsg, GRUB_MAX_ERRMSG); + return grub_error (grub_errno, + N_("non-numeric or invalid keyfile offset `%s': %s"), + state[5].arg, tmp_errmsg); + } + else + return grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("invalid keyfile offset `%s': non-numeric" + " characters at end of number"), + state[5].arg); + } + } + + if (state[6].set) /* keyfile-size */ + { + grub_errno = GRUB_ERR_NONE; + keyfile_size = grub_strtoull (state[6].arg, &p, 0); + + if (state[6].arg[0] == '\0' || *p != '\0') + { + if (grub_errno != GRUB_ERR_NONE) + { + grub_strncpy (tmp_errmsg, grub_errmsg, GRUB_MAX_ERRMSG); + return grub_error (grub_errno, + N_("non-numeric or invalid keyfile offset `%s': %s"), + state[5].arg, tmp_errmsg); + } + else + return grub_error (GRUB_ERR_BAD_ARGUMENT, + N_("invalid keyfile offset `%s': non-numeric" + " characters at end of number"), + state[6].arg); + } + + 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) + return grub_error (GRUB_ERR_OUT_OF_RANGE, + N_("Keyfile offset, %llu, is greater than" + "keyfile size, %" PRIuGRUB_UINT64_T), + 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 left at offset %llu"), + keyfile_size, + (grub_size_t) (keyfile->size - keyfile_offset), + keyfile_offset); + + 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_("failed to read key file"))); + } + if (state[0].set) /* uuid */ { int found_uuid; @@ -1384,7 +1484,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