Imported Upstream version 2.3.3
[platform/upstream/cryptsetup.git] / src / veritysetup.c
index 8f45be4..e29b75d 100644 (file)
@@ -1,8 +1,8 @@
 /*
  * veritysetup - setup cryptographic volumes for dm-verity
  *
- * Copyright (C) 2012-2013, Red Hat, Inc. All rights reserved.
- * Copyright (C) 2012-2013, Milan Broz
+ * Copyright (C) 2012-2020 Red Hat, Inc. All rights reserved.
+ * Copyright (C) 2012-2020 Milan Broz
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -25,6 +25,8 @@
 
 static int use_superblock = 1;
 
+static const char *fec_device = NULL;
+static int fec_roots = DEFAULT_VERITY_FEC_ROOTS;
 static const char *hash_algorithm = NULL;
 static int hash_type = 1;
 static int data_block_size = DEFAULT_VERITY_DATA_BLOCK;
@@ -32,9 +34,13 @@ static int hash_block_size = DEFAULT_VERITY_HASH_BLOCK;
 static uint64_t data_blocks = 0;
 static const char *salt_string = NULL;
 static uint64_t hash_offset = 0;
+static uint64_t fec_offset = 0;
 static const char *opt_uuid = NULL;
-
-static int opt_version_mode = 0;
+static int opt_restart_on_corruption = 0;
+static int opt_ignore_corruption = 0;
+static int opt_ignore_zero_blocks = 0;
+static int opt_check_at_most_once = 0;
+static const char *opt_root_hash_signature = NULL;
 
 static const char **action_argv;
 static int action_argc;
@@ -48,6 +54,8 @@ static int _prepare_format(struct crypt_params_verity *params,
 
        params->hash_name = hash_algorithm ?: DEFAULT_VERITY_HASH;
        params->data_device = data_device;
+       params->fec_device = fec_device;
+       params->fec_roots = fec_roots;
 
        if (salt_string && !strcmp(salt_string, "-")) {
                params->salt_size = 0;
@@ -55,7 +63,7 @@ static int _prepare_format(struct crypt_params_verity *params,
        } else if (salt_string) {
                len = crypt_hex_to_bytes(salt_string, &salt, 0);
                if (len < 0) {
-                       log_err(_("Invalid salt string specified.\n"));
+                       log_err(_("Invalid salt string specified."));
                        return -EINVAL;
                }
                params->salt_size = len;
@@ -69,6 +77,7 @@ static int _prepare_format(struct crypt_params_verity *params,
        params->hash_block_size = hash_block_size;
        params->data_size = data_blocks;
        params->hash_area_offset = hash_offset;
+       params->fec_area_offset = fec_offset;
        params->hash_type = hash_type;
        params->flags = flags;
 
@@ -85,12 +94,23 @@ static int action_format(int arg)
        /* Try to create hash image if doesn't exist */
        r = open(action_argv[1], O_WRONLY | O_EXCL | O_CREAT, S_IRUSR | S_IWUSR);
        if (r < 0 && errno != EEXIST) {
-               log_err(_("Cannot create hash image %s for writing.\n"), action_argv[1]);
+               log_err(_("Cannot create hash image %s for writing."), action_argv[1]);
                return -EINVAL;
        } else if (r >= 0) {
                log_dbg("Created hash image %s.", action_argv[1]);
                close(r);
        }
+       /* Try to create FEC image if doesn't exist */
+       if (fec_device) {
+               r = open(fec_device, O_WRONLY | O_EXCL | O_CREAT, S_IRUSR | S_IWUSR);
+               if (r < 0 && errno != EEXIST) {
+                       log_err(_("Cannot create FEC image %s for writing."), fec_device);
+                       return -EINVAL;
+               } else if (r >= 0) {
+                       log_dbg("Created FEC image %s.", fec_device);
+                       close(r);
+               }
+       }
 
        if ((r = crypt_init(&cd, action_argv[1])))
                goto out;
@@ -122,14 +142,28 @@ static int _activate(const char *dm_device,
        uint32_t activate_flags = CRYPT_ACTIVATE_READONLY;
        char *root_hash_bytes = NULL;
        ssize_t hash_size;
-       int r;
+       struct stat st;
+       char *signature = NULL;
+       int signature_size = 0, r;
 
-       if ((r = crypt_init(&cd, hash_device)))
+       if ((r = crypt_init_data_device(&cd, hash_device, data_device)))
                goto out;
 
+       if (opt_ignore_corruption)
+               activate_flags |= CRYPT_ACTIVATE_IGNORE_CORRUPTION;
+       if (opt_restart_on_corruption)
+               activate_flags |= CRYPT_ACTIVATE_RESTART_ON_CORRUPTION;
+       if (opt_ignore_zero_blocks)
+               activate_flags |= CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS;
+       if (opt_check_at_most_once)
+               activate_flags |= CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE;
+
        if (use_superblock) {
                params.flags = flags;
                params.hash_area_offset = hash_offset;
+               params.fec_area_offset = fec_offset;
+               params.fec_device = fec_device;
+               params.fec_roots = fec_roots;
                r = crypt_load(cd, CRYPT_VERITY, &params);
        } else {
                r = _prepare_format(&params, data_device, flags | CRYPT_VERITY_NO_HEADER);
@@ -139,33 +173,48 @@ static int _activate(const char *dm_device,
        }
        if (r < 0)
                goto out;
-       r = crypt_set_data_device(cd, data_device);
-       if (r < 0)
-               goto out;
 
        hash_size = crypt_get_volume_key_size(cd);
        if (crypt_hex_to_bytes(root_hash, &root_hash_bytes, 0) != hash_size) {
-               log_err(_("Invalid root hash string specified.\n"));
+               log_err(_("Invalid root hash string specified."));
                r = -EINVAL;
                goto out;
        }
-       r = crypt_activate_by_volume_key(cd, dm_device,
+
+       if (opt_root_hash_signature) {
+               // FIXME: check max file size
+               if (stat(opt_root_hash_signature, &st) || !S_ISREG(st.st_mode) || !st.st_size) {
+                       log_err(_("Invalid signature file %s."), opt_root_hash_signature);
+                       r = -EINVAL;
+                       goto out;
+               }
+               signature_size = st.st_size;
+               r = tools_read_mk(opt_root_hash_signature, &signature, signature_size);
+               if (r < 0) {
+                       log_err(_("Cannot read signature file %s."), opt_root_hash_signature);
+                       goto out;
+               }
+       }
+       r = crypt_activate_by_signed_key(cd, dm_device,
                                         root_hash_bytes,
                                         hash_size,
+                                        signature, signature_size,
                                         activate_flags);
 out:
+       crypt_safe_free(signature);
        crypt_free(cd);
        free(root_hash_bytes);
        free(CONST_CAST(char*)params.salt);
        return r;
 }
 
-static int action_create(int arg)
+static int action_open(int arg)
 {
-       return _activate(action_argv[0],
-                        action_argv[1],
+       return _activate(action_argv[1],
+                        action_argv[0],
                         action_argv[2],
-                        action_argv[3], 0);
+                        action_argv[3],
+                        opt_root_hash_signature ? CRYPT_VERITY_ROOT_HASH_SIGNATURE : 0);
 }
 
 static int action_verify(int arg)
@@ -177,7 +226,7 @@ static int action_verify(int arg)
                         CRYPT_VERITY_CHECK_HASH);
 }
 
-static int action_remove(int arg)
+static int action_close(int arg)
 {
        struct crypt_device *cd = NULL;
        int r;
@@ -197,7 +246,8 @@ static int action_status(int arg)
        struct crypt_params_verity vp = {};
        struct crypt_device *cd = NULL;
        struct stat st;
-       char *backing_file;
+       char *backing_file, *root_hash;
+       size_t root_hash_size;
        unsigned i, path = 0;
        int r = 0;
 
@@ -227,22 +277,24 @@ static int action_status(int arg)
                                ci == CRYPT_BUSY ? " and is in use" : "");
 
                r = crypt_init_by_name_and_header(&cd, action_argv[0], NULL);
-               if (r < 0 || !crypt_get_type(cd))
+               if (r < 0)
                        goto out;
 
-               log_std("  type:        %s\n", crypt_get_type(cd));
+               log_std("  type:        %s\n", crypt_get_type(cd) ?: "n/a");
 
                r = crypt_get_active_device(cd, action_argv[0], &cad);
                if (r < 0)
                        goto out;
 
-               log_std("  status:      %s\n",
-                       cad.flags & CRYPT_ACTIVATE_CORRUPTED ? "corrupted" : "verified");
-
+               /* Print only VERITY type devices */
                r = crypt_get_verity_info(cd, &vp);
                if (r < 0)
                        goto out;
 
+               log_std("  status:      %s%s\n",
+                       cad.flags & CRYPT_ACTIVATE_CORRUPTED ? "corrupted" : "verified",
+                       vp.flags & CRYPT_VERITY_ROOT_HASH_SIGNATURE ? " (with signature)" : "");
+
                log_std("  hash type:   %u\n", vp.hash_type);
                log_std("  data block:  %u\n", vp.data_block_size);
                log_std("  hash block:  %u\n", vp.hash_block_size);
@@ -256,8 +308,7 @@ static int action_status(int arg)
                log_std("\n");
 
                log_std("  data device: %s\n", vp.data_device);
-               if (crypt_loop_device(vp.data_device)) {
-                       backing_file = crypt_loop_backing_file(vp.data_device);
+               if ((backing_file = crypt_loop_backing_file(vp.data_device))) {
                        log_std("  data loop:   %s\n", backing_file);
                        free(backing_file);
                }
@@ -266,13 +317,45 @@ static int action_status(int arg)
                                           "readonly" : "read/write");
 
                log_std("  hash device: %s\n", vp.hash_device);
-               if (crypt_loop_device(vp.hash_device)) {
-                       backing_file = crypt_loop_backing_file(vp.hash_device);
+               if ((backing_file = crypt_loop_backing_file(vp.hash_device))) {
                        log_std("  hash loop:   %s\n", backing_file);
                        free(backing_file);
                }
                log_std("  hash offset: %" PRIu64 " sectors\n",
                        vp.hash_area_offset * vp.hash_block_size / 512);
+
+               if (vp.fec_device) {
+                       log_std("  FEC device:  %s\n", vp.fec_device);
+                       if ((backing_file = crypt_loop_backing_file(vp.fec_device))) {
+                               log_std("  FEC loop:    %s\n", backing_file);
+                               free(backing_file);
+                       }
+                       log_std("  FEC offset:  %" PRIu64 " sectors\n",
+                               vp.fec_area_offset * vp.hash_block_size / 512);
+                       log_std("  FEC roots:   %u\n", vp.fec_roots);
+               }
+
+               root_hash_size = crypt_get_volume_key_size(cd);
+               if (root_hash_size > 0 && (root_hash = malloc(root_hash_size))) {
+                       r = crypt_volume_key_get(cd, CRYPT_ANY_SLOT, root_hash, &root_hash_size, NULL, 0);
+                       if (!r) {
+                               log_std("  root hash:   ");
+                               for (i = 0; i < root_hash_size; i++)
+                                       log_std("%02hhx", (const char)root_hash[i]);
+                               log_std("\n");
+                       }
+                       free(root_hash);
+               }
+
+               if (cad.flags & (CRYPT_ACTIVATE_IGNORE_CORRUPTION|
+                                CRYPT_ACTIVATE_RESTART_ON_CORRUPTION|
+                                CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS|
+                                CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE))
+                       log_std("  flags:       %s%s%s%s\n",
+                               (cad.flags & CRYPT_ACTIVATE_IGNORE_CORRUPTION) ? "ignore_corruption " : "",
+                               (cad.flags & CRYPT_ACTIVATE_RESTART_ON_CORRUPTION) ? "restart_on_corruption " : "",
+                               (cad.flags & CRYPT_ACTIVATE_IGNORE_ZERO_BLOCKS) ? "ignore_zero_blocks " : "",
+                               (cad.flags & CRYPT_ACTIVATE_CHECK_AT_MOST_ONCE) ? "check_at_most_once" : "");
        }
 out:
        crypt_free(cd);
@@ -291,6 +374,7 @@ static int action_dump(int arg)
                return r;
 
        params.hash_area_offset = hash_offset;
+       params.fec_area_offset = fec_offset;
        r = crypt_load(cd, CRYPT_VERITY, &params);
        if (!r)
                crypt_dump(cd);
@@ -307,8 +391,8 @@ static struct action_type {
 } action_types[] = {
        { "format",     action_format, 2, N_("<data_device> <hash_device>"),N_("format device") },
        { "verify",     action_verify, 3, N_("<data_device> <hash_device> <root_hash>"),N_("verify device") },
-       { "create",     action_create, 4, N_("<name> <data_device> <hash_device> <root_hash>"),N_("create active device") },
-       { "remove",     action_remove, 1, N_("<name>"),N_("remove (deactivate) device") },
+       { "open",       action_open,   4, N_("<data_device> <name> <hash_device> <root_hash>"),N_("open device as <name>") },
+       { "close",      action_close,  1, N_("<name>"),N_("close device (remove mapping)") },
        { "status",     action_status, 1, N_("<name>"),N_("show active device status") },
        { "dump",       action_dump,   1, N_("<hash_device>"),N_("show on-disk information") },
        { NULL, NULL, 0, NULL, NULL }
@@ -342,6 +426,11 @@ static void help(poptContext popt_context,
                        DEFAULT_VERITY_HASH, DEFAULT_VERITY_DATA_BLOCK,
                        DEFAULT_VERITY_HASH_BLOCK, DEFAULT_VERITY_SALT_SIZE,
                        1);
+               poptFreeContext(popt_context);
+               exit(EXIT_SUCCESS);
+       } else if (key->shortName == 'V') {
+               log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
+               poptFreeContext(popt_context);
                exit(EXIT_SUCCESS);
        } else
                usage(popt_context, EXIT_SUCCESS, NULL, NULL);
@@ -367,22 +456,30 @@ int main(int argc, const char **argv)
                { NULL,    '\0', POPT_ARG_CALLBACK, help, 0, NULL,                         NULL },
                { "help",  '?',  POPT_ARG_NONE,     NULL, 0, N_("Show this help message"), NULL },
                { "usage", '\0', POPT_ARG_NONE,     NULL, 0, N_("Display brief usage"),    NULL },
+               { "version",'V', POPT_ARG_NONE,     NULL, 0, N_("Print package version"),  NULL },
                POPT_TABLEEND
        };
        static struct poptOption popt_options[] = {
                { NULL,              '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL },
-               { "version",         '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), NULL },
                { "verbose",         'v',  POPT_ARG_NONE, &opt_verbose,      0, N_("Shows more detailed error messages"), NULL },
                { "debug",           '\0', POPT_ARG_NONE, &opt_debug,        0, N_("Show debug messages"), NULL },
                { "no-superblock",   0,    POPT_ARG_VAL,  &use_superblock,   0, N_("Do not use verity superblock"), NULL },
                { "format",          0,    POPT_ARG_INT,  &hash_type,        0, N_("Format type (1 - normal, 0 - original Chrome OS)"), N_("number") },
                { "data-block-size", 0,    POPT_ARG_INT,  &data_block_size,  0, N_("Block size on the data device"), N_("bytes") },
                { "hash-block-size", 0,    POPT_ARG_INT,  &hash_block_size,  0, N_("Block size on the hash device"), N_("bytes") },
+               { "fec-roots",       0,    POPT_ARG_INT,  &fec_roots,        0, N_("FEC parity bytes"), N_("bytes") },
                { "data-blocks",     0,    POPT_ARG_STRING, &popt_tmp,       1, N_("The number of blocks in the data file"), N_("blocks") },
+               { "fec-device",      0,    POPT_ARG_STRING, &fec_device,     0, N_("Path to device with error correction data"), N_("path") },
                { "hash-offset",     0,    POPT_ARG_STRING, &popt_tmp,       2, N_("Starting offset on the hash device"), N_("bytes") },
+               { "fec-offset",      0,    POPT_ARG_STRING, &popt_tmp,       3, N_("Starting offset on the FEC device"), N_("bytes") },
                { "hash",            'h',  POPT_ARG_STRING, &hash_algorithm, 0, N_("Hash algorithm"), N_("string") },
                { "salt",            's',  POPT_ARG_STRING, &salt_string,    0, N_("Salt"), N_("hex string") },
-               { "uuid",            '\0', POPT_ARG_STRING, &opt_uuid,       0, N_("UUID for device to use."), NULL },
+               { "uuid",            '\0', POPT_ARG_STRING, &opt_uuid,       0, N_("UUID for device to use"), NULL },
+               { "root-hash-signature",'\0', POPT_ARG_STRING, &opt_root_hash_signature,  0, N_("Path to root hash signature file"), NULL },
+               { "restart-on-corruption", 0,POPT_ARG_NONE,&opt_restart_on_corruption, 0, N_("Restart kernel if corruption is detected"), NULL },
+               { "ignore-corruption", 0,  POPT_ARG_NONE, &opt_ignore_corruption,  0, N_("Ignore corruption, log it only"), NULL },
+               { "ignore-zero-blocks", 0, POPT_ARG_NONE, &opt_ignore_zero_blocks, 0, N_("Do not verify zeroed blocks"), NULL },
+               { "check-at-most-once", 0, POPT_ARG_NONE, &opt_check_at_most_once, 0, N_("Verify data block only the first time it is read"), NULL },
                POPT_TABLEEND
        };
 
@@ -419,6 +516,9 @@ int main(int argc, const char **argv)
                        case 2:
                                hash_offset = ull_value;
                                break;
+                       case 3:
+                               fec_offset = ull_value;
+                               break;
                }
 
                if (r < 0)
@@ -429,21 +529,9 @@ int main(int argc, const char **argv)
                usage(popt_context, EXIT_FAILURE, poptStrerror(r),
                      poptBadOption(popt_context, POPT_BADOPTION_NOALIAS));
 
-       if (opt_version_mode) {
-               log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
-               poptFreeContext(popt_context);
-               exit(EXIT_SUCCESS);
-       }
-
        if (!(aname = poptGetArg(popt_context)))
                usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."),
                      poptGetInvocationName(popt_context));
-       for(action = action_types; action->type; action++)
-               if (strcmp(action->type, aname) == 0)
-                       break;
-       if (!action->type)
-               usage(popt_context, EXIT_FAILURE, _("Unknown action."),
-                     poptGetInvocationName(popt_context));
 
        action_argc = 0;
        action_argv = poptGetArgs(popt_context);
@@ -455,7 +543,28 @@ int main(int argc, const char **argv)
        while(action_argv[action_argc] != NULL)
                action_argc++;
 
-       if(action_argc < action->required_action_argc) {
+       /* Handle aliases */
+       if (!strcmp(aname, "create") && action_argc > 1) {
+               /* create command had historically switched arguments */
+               if (action_argv[0] && action_argv[1]) {
+                       const char *tmp = action_argv[0];
+                       action_argv[0] = action_argv[1];
+                       action_argv[1] = tmp;
+               }
+               aname = "open";
+       } else if (!strcmp(aname, "remove")) {
+               aname = "close";
+       }
+
+       for (action = action_types; action->type; action++)
+               if (strcmp(action->type, aname) == 0)
+                       break;
+
+       if (!action->type)
+               usage(popt_context, EXIT_FAILURE, _("Unknown action."),
+                     poptGetInvocationName(popt_context));
+
+       if (action_argc < action->required_action_argc) {
                char buf[128];
                snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc);
                usage(popt_context, EXIT_FAILURE, buf,
@@ -468,6 +577,21 @@ int main(int argc, const char **argv)
                      poptGetInvocationName(popt_context));
        }
 
+       if ((opt_ignore_corruption || opt_restart_on_corruption || opt_ignore_zero_blocks) && strcmp(aname, "open"))
+               usage(popt_context, EXIT_FAILURE,
+               _("Option --ignore-corruption, --restart-on-corruption or --ignore-zero-blocks is allowed only for open operation."),
+               poptGetInvocationName(popt_context));
+
+       if (opt_root_hash_signature && strcmp(aname, "open"))
+               usage(popt_context, EXIT_FAILURE,
+               _("Option --root-hash-signature can be used only for open operation."),
+               poptGetInvocationName(popt_context));
+
+       if (opt_ignore_corruption && opt_restart_on_corruption)
+               usage(popt_context, EXIT_FAILURE,
+               _("Option --ignore-corruption and --restart-on-corruption cannot be used together."),
+               poptGetInvocationName(popt_context));
+
        if (opt_debug) {
                opt_verbose = 1;
                crypt_set_debug_level(-1);