2 * veritysetup - setup cryptographic volumes for dm-verity
4 * Copyright (C) 2012, Red Hat, Inc. All rights reserved.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * version 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include "cryptsetup.h"
32 #define PACKAGE_VERITY "veritysetup"
34 static int use_superblock = 1;
36 static const char *hash_algorithm = NULL;
37 static int hash_type = 1;
38 static int data_block_size = DEFAULT_VERITY_DATA_BLOCK;
39 static int hash_block_size = DEFAULT_VERITY_HASH_BLOCK;
40 static uint64_t data_blocks = 0;
41 static const char *salt_string = NULL;
42 static uint64_t hash_start = 0;
43 static const char *opt_uuid = NULL;
45 static int opt_verbose = 0;
46 static int opt_debug = 0;
47 static int opt_version_mode = 0;
49 static const char **action_argv;
50 static int action_argc;
52 static size_t hex_to_bytes(const char *hex, char *result)
54 char buf[3] = "xx\0", *endp;
57 len = strlen(hex) / 2;
58 for (i = 0; i < len; i++) {
59 memcpy(buf, &hex[i * 2], 2);
60 result[i] = strtoul(buf, &endp, 16);
67 __attribute__((format(printf, 5, 6)))
68 static void clogger(struct crypt_device *cd, int level, const char *file,
69 int line, const char *format, ...)
74 va_start(argp, format);
76 if (vasprintf(&target, format, argp) > 0) {
78 crypt_log(cd, level, target);
81 printf("# %s:%d %s\n", file ?: "?", line, target);
84 printf("# %s\n", target);
92 static void _log(int level, const char *msg, void *usrptr __attribute__((unused)))
96 case CRYPT_LOG_NORMAL:
99 case CRYPT_LOG_VERBOSE:
103 case CRYPT_LOG_ERROR:
106 case CRYPT_LOG_DEBUG:
108 printf("# %s\n", msg);
111 fprintf(stderr, "Internal error on logging class for msg: %s", msg);
116 static int _prepare_format(struct crypt_params_verity *params,
117 const char *data_device,
120 static char salt_bytes[512];
122 params->hash_name = hash_algorithm ?: DEFAULT_VERITY_HASH;
123 params->data_device = data_device;
125 if (salt_string && !strcmp(salt_string, "-")) {
126 params->salt_size = 0;
128 } else if (salt_string) {
129 params->salt_size = strlen(salt_string) / 2;
130 if (hex_to_bytes(salt_string, salt_bytes) != params->salt_size)
132 params->salt = salt_bytes;
134 params->salt_size = DEFAULT_VERITY_SALT_SIZE;
136 params->data_block_size = data_block_size;
137 params->hash_block_size = hash_block_size;
138 params->data_size = data_blocks;
139 params->hash_area_offset = hash_start;
140 params->hash_type = hash_type;
141 params->flags = flags;
146 static int action_format(int arg)
148 struct crypt_device *cd = NULL;
149 struct crypt_params_verity params = {};
150 uint32_t flags = CRYPT_VERITY_CREATE_HASH;
153 if ((r = crypt_init(&cd, action_argv[1])))
157 flags |= CRYPT_VERITY_NO_HEADER;
159 r = _prepare_format(¶ms, action_argv[0], flags);
163 r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, opt_uuid, NULL, 0, ¶ms);
171 static int _activate(const char *dm_device,
172 const char *data_device,
173 const char *hash_device,
174 const char *root_hash,
177 struct crypt_device *cd = NULL;
178 struct crypt_params_verity params = {};
179 uint32_t activate_flags = CRYPT_ACTIVATE_READONLY;
180 char root_hash_bytes[128];
184 if ((r = crypt_init(&cd, hash_device)))
187 if (use_superblock) {
188 params.flags = flags;
189 params.hash_area_offset = hash_start;
190 r = crypt_load(cd, CRYPT_VERITY, ¶ms);
192 r = _prepare_format(¶ms, data_device, flags | CRYPT_VERITY_NO_HEADER);
195 r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, NULL, NULL, 0, ¶ms);
199 r = crypt_set_data_device(cd, data_device);
203 hash_size = crypt_get_volume_key_size(cd);
204 if (hex_to_bytes(root_hash, root_hash_bytes) != hash_size) {
208 r = crypt_activate_by_volume_key(cd, dm_device,
217 static int action_create(int arg)
219 return _activate(action_argv[0],
225 static int action_verify(int arg)
227 return _activate(NULL,
231 CRYPT_VERITY_CHECK_HASH);
234 static int action_remove(int arg)
236 struct crypt_device *cd = NULL;
239 r = crypt_init_by_name(&cd, action_argv[0]);
241 r = crypt_deactivate(cd, action_argv[0]);
247 static int action_status(int arg)
249 crypt_status_info ci;
250 struct crypt_active_device cad;
251 struct crypt_params_verity vp = {};
252 struct crypt_device *cd = NULL;
255 unsigned i, path = 0;
258 /* perhaps a path, not a dm device name */
259 if (strchr(action_argv[0], '/') && !stat(action_argv[0], &st))
262 ci = crypt_status(NULL, action_argv[0]);
269 log_std("%s is inactive.\n", action_argv[0]);
271 log_std("%s/%s is inactive.\n", crypt_get_dir(), action_argv[0]);
277 log_std("%s is active%s.\n", action_argv[0],
278 ci == CRYPT_BUSY ? " and is in use" : "");
280 log_std("%s/%s is active%s.\n", crypt_get_dir(), action_argv[0],
281 ci == CRYPT_BUSY ? " and is in use" : "");
283 r = crypt_init_by_name_and_header(&cd, action_argv[0], NULL);
284 if (r < 0 || !crypt_get_type(cd))
287 log_std(" type: %s\n", crypt_get_type(cd));
289 r = crypt_get_active_device(cd, action_argv[0], &cad);
293 log_std(" status: %s\n",
294 cad.flags & CRYPT_ACTIVATE_CORRUPTED ? "corrupted" : "verified");
296 r = crypt_get_verity_info(cd, &vp);
300 log_std(" hash type: %u\n", vp.hash_type);
301 log_std(" data block: %u\n", vp.data_block_size);
302 log_std(" hash block: %u\n", vp.hash_block_size);
303 log_std(" hash name: %s\n", vp.hash_name);
306 for(i = 0; i < vp.salt_size; i++)
307 log_std("%02hhx", (const char)vp.salt[i]);
312 log_std(" data device: %s\n", vp.data_device);
313 if (crypt_loop_device(vp.data_device)) {
314 backing_file = crypt_loop_backing_file(vp.data_device);
315 log_std(" data loop: %s\n", backing_file);
318 log_std(" size: %" PRIu64 " sectors\n", cad.size);
319 log_std(" mode: %s\n", cad.flags & CRYPT_ACTIVATE_READONLY ?
320 "readonly" : "read/write");
322 log_std(" hash device: %s\n", vp.hash_device);
323 if (crypt_loop_device(vp.hash_device)) {
324 backing_file = crypt_loop_backing_file(vp.hash_device);
325 log_std(" hash loop: %s\n", backing_file);
328 log_std(" hash offset: %" PRIu64 " sectors\n",
329 vp.hash_area_offset * vp.hash_block_size / 512);
338 static int action_dump(int arg)
340 struct crypt_device *cd = NULL;
341 struct crypt_params_verity params = {};
344 if ((r = crypt_init(&cd, action_argv[0])))
347 params.hash_area_offset = hash_start;
348 r = crypt_load(cd, CRYPT_VERITY, ¶ms);
355 static __attribute__ ((noreturn)) void usage(poptContext popt_context,
356 int exitcode, const char *error,
359 poptPrintUsage(popt_context, stderr, 0);
361 log_err("%s: %s\n", more, error);
362 poptFreeContext(popt_context);
366 static void _dbg_version_and_cmd(int argc, const char **argv)
370 log_std("# %s %s processing \"", PACKAGE_VERITY, PACKAGE_VERSION);
371 for (i = 0; i < argc; i++) {
374 log_std("%s", argv[i]);
379 static struct action_type {
382 int required_action_argc;
383 const char *arg_desc;
386 { "format", action_format, 2, N_("<data_device> <hash_device>"),N_("format device") },
387 { "verify", action_verify, 3, N_("<data_device> <hash_device> <root_hash>"),N_("verify device") },
388 { "create", action_create, 4, N_("<name> <data_device> <hash_device> <root_hash>"),N_("create active device") },
389 { "remove", action_remove, 1, N_("<name>"),N_("remove (deactivate) device") },
390 { "status", action_status, 1, N_("<name>"),N_("show active device status") },
391 { "dump", action_dump, 1, N_("<hash_device>"),N_("show on-disk information") },
392 { NULL, NULL, 0, NULL, NULL }
395 static void help(poptContext popt_context,
396 enum poptCallbackReason reason __attribute__((unused)),
397 struct poptOption *key,
398 const char *arg __attribute__((unused)),
399 void *data __attribute__((unused)))
401 struct action_type *action;
403 if (key->shortName == '?') {
404 log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
405 poptPrintHelp(popt_context, stdout, 0);
407 "<action> is one of:\n"));
408 for(action = action_types; action->type; action++)
409 log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc));
411 "<name> is the device to create under %s\n"
412 "<data_device> is the data device\n"
413 "<hash_device> is the device containing verification data\n"
414 "<root_hash> hash of the root node on <hash_device>\n"),
417 log_std(_("\nDefault compiled-in dm-verity parameters:\n"
418 "\tHash: %s, Data block (bytes): %u, "
419 "Hash block (bytes): %u, Salt size: %u, Hash format: %u\n"),
420 DEFAULT_VERITY_HASH, DEFAULT_VERITY_DATA_BLOCK,
421 DEFAULT_VERITY_HASH_BLOCK, DEFAULT_VERITY_SALT_SIZE,
425 usage(popt_context, EXIT_SUCCESS, NULL, NULL);
428 static void show_status(int errcode)
430 char error[256], *error_;
436 log_std(_("Command successful.\n"));
440 crypt_get_error(error, sizeof(error));
443 error_ = strerror_r(-errcode, error, sizeof(error));
444 if (error_ != error) {
445 strncpy(error, error_, sizeof(error));
446 error[sizeof(error) - 1] = '\0';
450 log_err(_("Command failed with code %i"), -errcode);
452 log_err(": %s\n", error);
457 static int run_action(struct action_type *action)
461 log_dbg("Running command %s.", action->type);
463 r = action->handler(0);
467 /* Translate exit code to simple codes */
469 case 0: r = EXIT_SUCCESS; break;
471 case -EBUSY: r = 5; break;
473 case -ENODEV: r = 4; break;
474 case -ENOMEM: r = 3; break;
475 case -EPERM: r = 2; break;
479 default: r = EXIT_FAILURE;
484 int main(int argc, const char **argv)
486 static char *popt_tmp;
487 static const char *null_action_argv[] = {NULL};
488 static struct poptOption popt_help_options[] = {
489 { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL },
490 { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL },
491 { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL },
494 static struct poptOption popt_options[] = {
495 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL },
496 { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), NULL },
497 { "verbose", 'v', POPT_ARG_NONE, &opt_verbose, 0, N_("Shows more detailed error messages"), NULL },
498 { "debug", '\0', POPT_ARG_NONE, &opt_debug, 0, N_("Show debug messages"), NULL },
499 { "no-superblock", 0, POPT_ARG_VAL, &use_superblock, 0, N_("Do not use verity superblock"), NULL },
500 { "format", 0, POPT_ARG_INT, &hash_type, 0, N_("Format type (1 - normal, 0 - original Chrome OS)"), N_("number") },
501 { "data-block-size", 0, POPT_ARG_INT, &data_block_size, 0, N_("Block size on the data device"), N_("bytes") },
502 { "hash-block-size", 0, POPT_ARG_INT, &hash_block_size, 0, N_("Block size on the hash device"), N_("bytes") },
503 { "data-blocks", 0, POPT_ARG_STRING, &popt_tmp, 1, N_("The number of blocks in the data file"), N_("blocks") },
504 { "hash-start", 0, POPT_ARG_STRING, &popt_tmp, 2, N_("Starting block on the hash device"), N_("512-byte sectors") },
505 { "hash", 'h', POPT_ARG_STRING, &hash_algorithm, 0, N_("Hash algorithm"), N_("string") },
506 { "salt", 's', POPT_ARG_STRING, &salt_string, 0, N_("Salt"), N_("hex string") },
507 { "uuid", '\0', POPT_ARG_STRING, &opt_uuid, 0, N_("UUID for device to use."), NULL },
511 poptContext popt_context;
512 struct action_type *action;
516 crypt_set_log_callback(NULL, _log, NULL);
518 setlocale(LC_ALL, "");
519 bindtextdomain(PACKAGE, LOCALEDIR);
522 popt_context = poptGetContext("verity", argc, argv, popt_options, 0);
523 poptSetOtherOptionHelp(popt_context,
524 N_("[OPTION...] <action> <action-specific>"));
526 while((r = poptGetNextOpt(popt_context)) > 0) {
527 unsigned long long ull_value;
531 ull_value = strtoull(popt_tmp, &endp, 0);
532 if (*endp || !*popt_tmp ||
533 (errno == ERANGE && ull_value == ULLONG_MAX) ||
534 (errno != 0 && ull_value == 0))
535 r = POPT_ERROR_BADNUMBER;
539 data_blocks = ull_value;
542 hash_start = ull_value * 512;
551 usage(popt_context, EXIT_FAILURE, poptStrerror(r),
552 poptBadOption(popt_context, POPT_BADOPTION_NOALIAS));
554 if (opt_version_mode) {
555 log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
556 poptFreeContext(popt_context);
560 if (!(aname = poptGetArg(popt_context)))
561 usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."),
562 poptGetInvocationName(popt_context));
563 for(action = action_types; action->type; action++)
564 if (strcmp(action->type, aname) == 0)
567 usage(popt_context, EXIT_FAILURE, _("Unknown action."),
568 poptGetInvocationName(popt_context));
571 action_argv = poptGetArgs(popt_context);
572 /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */
574 action_argv = null_action_argv;
576 /* Count args, somewhat unnice, change? */
577 while(action_argv[action_argc] != NULL)
580 if(action_argc < action->required_action_argc) {
582 snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc);
583 usage(popt_context, EXIT_FAILURE, buf,
584 poptGetInvocationName(popt_context));
589 crypt_set_debug_level(-1);
590 _dbg_version_and_cmd(argc, argv);
593 r = run_action(action);
594 poptFreeContext(popt_context);