Cryptomount support key files
authorJohn Lane <john@lane.uk.net>
Fri, 26 Jun 2015 12:37:10 +0000 (13:37 +0100)
committerTJ <grub-devel@iam.tj>
Thu, 22 Mar 2018 12:21:42 +0000 (12:21 +0000)
Enable reading keys from files and/or removable devices.

grub-core/disk/cryptodisk.c
grub-core/disk/geli.c
grub-core/disk/luks.c
include/grub/cryptodisk.h

index 831b17e..81d7a6c 100644 (file)
@@ -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 LUKS 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}
   };
 
@@ -811,6 +814,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 *keyfile_buffer;
+static grub_size_t keyfile_size;
 
 static void
 cryptodisk_close (grub_cryptodisk_t dev)
@@ -841,7 +846,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, keyfile_buffer, keyfile_size);
     if (err)
     {
       cryptodisk_close (dev);
@@ -949,6 +954,72 @@ grub_cmd_cryptomount (grub_extcmd_context_t ctxt, int argc, char **args)
     hdr = NULL;
 
   have_it = 0;
+  keyfile_buffer = NULL;
+  keyfile_size = 0;
+
+  if (state[4].set) /* Key file; fails back to passphrase entry */
+    {
+      grub_file_t keyfile;
+      int keyfile_offset;
+      grub_size_t requested_keyfile_size;
+
+      requested_keyfile_size = state[6].set ? grub_strtoul(state[6].arg, 0, 0) : 0;
+
+      if (requested_keyfile_size > GRUB_CRYPTODISK_MAX_KEYFILE_SIZE)
+        grub_printf (N_("Key file size exceeds maximum (%llu)\n"), \
+                            (unsigned long long) GRUB_CRYPTODISK_MAX_KEYFILE_SIZE);
+      else
+        {
+          keyfile_offset = state[5].set ? grub_strtoul (state[5].arg, 0, 0) : 0;
+          keyfile_size = requested_keyfile_size ? requested_keyfile_size : \
+                                            GRUB_CRYPTODISK_MAX_KEYFILE_SIZE;
+
+          keyfile = grub_file_open (state[4].arg);
+          if (!keyfile)
+            {
+              grub_printf (N_("Unable to open key file %s\n"), state[4].arg);
+              goto keyfile_fail;
+            }
+          keyfile_buffer = grub_malloc(GRUB_CRYPTODISK_MAX_KEYFILE_SIZE);
+          if (!keyfile_buffer)
+            {
+              grub_printf (N_("keyfile memory allocation failed for %s\n"), state[4].arg);
+              goto keyfile_fail;
+            }
+          if (grub_file_seek (keyfile, keyfile_offset) == (grub_off_t)-1)
+            {
+              grub_printf (N_("Unable to seek to offset %d in key file %s\n"),
+                            keyfile_offset,
+                            state[4].arg);
+              goto keyfile_fail;
+            }
+          keyfile_size = grub_file_read (keyfile, keyfile_buffer, keyfile_size);
+          if (keyfile_size == (grub_size_t)-1)
+            {
+              grub_printf (N_("Error reading key file %s\n"), state[4].arg);
+              goto keyfile_fail;
+            }
+             if (requested_keyfile_size && (keyfile_size != requested_keyfile_size))
+            {
+              grub_printf (N_("Cannot read %llu bytes for key file %s (read %llu bytes)\n"),
+                           (unsigned long long) requested_keyfile_size,
+                           state[4].arg,
+                           (unsigned long long) keyfile_size);
+              goto keyfile_fail;
+            }
+          goto keyfile_success;
+        }
+    }
+  keyfile_fail:
+  if (keyfile_buffer)
+    {
+      grub_free (keyfile_buffer);
+      keyfile_buffer = NULL;
+    }
+  keyfile_success:
+  if (keyfile)
+      grub_file_close (keyfile);
+
   if (state[0].set)
     {
       grub_cryptodisk_t dev;
index f4394eb..da6aa6a 100644 (file)
@@ -401,7 +401,9 @@ configure_ciphers (grub_disk_t disk, const char *check_uuid,
 
 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];
index 790cafa..6fbd32e 100644 (file)
@@ -322,12 +322,15 @@ configure_ciphers (grub_disk_t disk, const char *check_uuid,
 static grub_err_t
 luks_recover_key (grub_disk_t source,
                  grub_cryptodisk_t dev,
-                 grub_file_t hdr)
+                 grub_file_t hdr,
+                 grub_uint8_t *keyfile_bytes,
+                 grub_size_t keyfile_bytes_size)
 {
   struct grub_luks_phdr header;
   grub_size_t keysize;
   grub_uint8_t *split_key = NULL;
-  char passphrase[MAX_PASSPHRASE] = "";
+  grub_uint8_t *passphrasei = NULL;
+  grub_size_t passphrase_length;
   grub_uint8_t candidate_digest[sizeof (header.mkDigest)];
   unsigned i;
   grub_size_t length;
@@ -337,8 +340,6 @@ luks_recover_key (grub_disk_t source,
   char *tmp;
   grub_uint32_t sector;
 
-  err = GRUB_ERR_NONE;
-
   if (hdr)
   {
     grub_file_seek (hdr, 0);
@@ -372,14 +373,29 @@ luks_recover_key (grub_disk_t source,
          goto fail;
     }
 
+  if (keyfile_bytes)
+    {
+      /* Use bytestring from key file as passphrase */
+      passphrase = keyfile_bytes;
+      passphrase_length = keyfile_bytes_size;
+      goto passphrase_got;
+    }
+
   /* Get the passphrase from the user.  */
   tmp = NULL;
   if (source->partition)
-    tmp = grub_partition_get_name (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);
+                   source->partition ? "," : "", tmp ? : "",
+                       dev->uuid);
   grub_free (tmp);
+  passphrase = grub_malloc (MAX_PASSPHRASE);
+  if (!passphrase)
+    {
+      err = GRUB_ERR_OUT_OF_MEMORY;
+      err_msg = "Cannot allocate memory for passphrase";
+      goto fail;
+    }
   if (!grub_password_get (passphrase, MAX_PASSPHRASE))
     {
       err = GRUB_ERR_BAD_ARGUMENT;
@@ -387,6 +403,8 @@ luks_recover_key (grub_disk_t source,
       goto fail;
     }
 
+passphrase_got:
+
   /* Try to recover master key from each active keyslot.  */
   for (i = 0; i < ARRAY_SIZE (header.keyblock); i++)
     {
@@ -402,7 +420,7 @@ luks_recover_key (grub_disk_t source,
 
       /* 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].
@@ -497,6 +515,7 @@ luks_recover_key (grub_disk_t source,
     }
 
 fail:
+  grub_free (passphrase);
   grub_free (split_key);
   if(err && err_msg)
          grub_error (err, errmsg);
index 4e6e89a..67f6b0b 100644 (file)
@@ -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
@@ -109,7 +111,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_err_t (*recover_key) (grub_disk_t disk, grub_cryptodisk_t dev,
+                           grub_file_t hdr, grub_uint8_t *key, grub_size_t keyfile_size);
 };
 typedef struct grub_cryptodisk_dev *grub_cryptodisk_dev_t;