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.
20 #include "cryptsetup.h"
22 #define PACKAGE_VERITY "veritysetup"
24 static int use_superblock = 1;
26 static const char *hash_algorithm = NULL;
27 static int hash_type = 1;
28 static int data_block_size = DEFAULT_VERITY_DATA_BLOCK;
29 static int hash_block_size = DEFAULT_VERITY_HASH_BLOCK;
30 static uint64_t data_blocks = 0;
31 static const char *salt_string = NULL;
32 static uint64_t hash_offset = 0;
33 static const char *opt_uuid = NULL;
35 static int opt_version_mode = 0;
37 static const char **action_argv;
38 static int action_argc;
40 static int _prepare_format(struct crypt_params_verity *params,
41 const char *data_device,
47 params->hash_name = hash_algorithm ?: DEFAULT_VERITY_HASH;
48 params->data_device = data_device;
50 if (salt_string && !strcmp(salt_string, "-")) {
51 params->salt_size = 0;
53 } else if (salt_string) {
54 len = crypt_hex_to_bytes(salt_string, &salt, 0);
56 log_err(_("Invalid salt string specified.\n"));
59 params->salt_size = len;
62 params->salt_size = DEFAULT_VERITY_SALT_SIZE;
66 params->data_block_size = data_block_size;
67 params->hash_block_size = hash_block_size;
68 params->data_size = data_blocks;
69 params->hash_area_offset = hash_offset;
70 params->hash_type = hash_type;
71 params->flags = flags;
76 static int action_format(int arg)
78 struct crypt_device *cd = NULL;
79 struct crypt_params_verity params = {};
80 uint32_t flags = CRYPT_VERITY_CREATE_HASH;
84 /* Try to create hash image if doesn't exist */
85 if (stat(action_argv[1], &st) < 0) {
86 log_dbg("Creating hash image %s.", action_argv[1]);
87 r = open(action_argv[1], O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR);
89 log_err(_("Cannot create hash image %s for writing.\n"), action_argv[1]);
95 if ((r = crypt_init(&cd, action_argv[1])))
99 flags |= CRYPT_VERITY_NO_HEADER;
101 r = _prepare_format(¶ms, action_argv[0], flags);
105 r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, opt_uuid, NULL, 0, ¶ms);
110 free(CONST_CAST(char*)params.salt);
114 static int _activate(const char *dm_device,
115 const char *data_device,
116 const char *hash_device,
117 const char *root_hash,
120 struct crypt_device *cd = NULL;
121 struct crypt_params_verity params = {};
122 uint32_t activate_flags = CRYPT_ACTIVATE_READONLY;
123 char *root_hash_bytes = NULL;
127 if ((r = crypt_init(&cd, hash_device)))
130 if (use_superblock) {
131 params.flags = flags;
132 params.hash_area_offset = hash_offset;
133 r = crypt_load(cd, CRYPT_VERITY, ¶ms);
135 r = _prepare_format(¶ms, data_device, flags | CRYPT_VERITY_NO_HEADER);
138 r = crypt_format(cd, CRYPT_VERITY, NULL, NULL, NULL, NULL, 0, ¶ms);
142 r = crypt_set_data_device(cd, data_device);
146 hash_size = crypt_get_volume_key_size(cd);
147 if (crypt_hex_to_bytes(root_hash, &root_hash_bytes, 0) != hash_size) {
148 log_err(_("Invalid root hash string specified.\n"));
152 r = crypt_activate_by_volume_key(cd, dm_device,
158 free(root_hash_bytes);
159 free(CONST_CAST(char*)params.salt);
163 static int action_create(int arg)
165 return _activate(action_argv[0],
171 static int action_verify(int arg)
173 return _activate(NULL,
177 CRYPT_VERITY_CHECK_HASH);
180 static int action_remove(int arg)
182 struct crypt_device *cd = NULL;
185 r = crypt_init_by_name(&cd, action_argv[0]);
187 r = crypt_deactivate(cd, action_argv[0]);
193 static int action_status(int arg)
195 crypt_status_info ci;
196 struct crypt_active_device cad;
197 struct crypt_params_verity vp = {};
198 struct crypt_device *cd = NULL;
201 unsigned i, path = 0;
204 /* perhaps a path, not a dm device name */
205 if (strchr(action_argv[0], '/') && !stat(action_argv[0], &st))
208 ci = crypt_status(NULL, action_argv[0]);
215 log_std("%s is inactive.\n", action_argv[0]);
217 log_std("%s/%s is inactive.\n", crypt_get_dir(), action_argv[0]);
223 log_std("%s is active%s.\n", action_argv[0],
224 ci == CRYPT_BUSY ? " and is in use" : "");
226 log_std("%s/%s is active%s.\n", crypt_get_dir(), action_argv[0],
227 ci == CRYPT_BUSY ? " and is in use" : "");
229 r = crypt_init_by_name_and_header(&cd, action_argv[0], NULL);
230 if (r < 0 || !crypt_get_type(cd))
233 log_std(" type: %s\n", crypt_get_type(cd));
235 r = crypt_get_active_device(cd, action_argv[0], &cad);
239 log_std(" status: %s\n",
240 cad.flags & CRYPT_ACTIVATE_CORRUPTED ? "corrupted" : "verified");
242 r = crypt_get_verity_info(cd, &vp);
246 log_std(" hash type: %u\n", vp.hash_type);
247 log_std(" data block: %u\n", vp.data_block_size);
248 log_std(" hash block: %u\n", vp.hash_block_size);
249 log_std(" hash name: %s\n", vp.hash_name);
252 for(i = 0; i < vp.salt_size; i++)
253 log_std("%02hhx", (const char)vp.salt[i]);
258 log_std(" data device: %s\n", vp.data_device);
259 if (crypt_loop_device(vp.data_device)) {
260 backing_file = crypt_loop_backing_file(vp.data_device);
261 log_std(" data loop: %s\n", backing_file);
264 log_std(" size: %" PRIu64 " sectors\n", cad.size);
265 log_std(" mode: %s\n", cad.flags & CRYPT_ACTIVATE_READONLY ?
266 "readonly" : "read/write");
268 log_std(" hash device: %s\n", vp.hash_device);
269 if (crypt_loop_device(vp.hash_device)) {
270 backing_file = crypt_loop_backing_file(vp.hash_device);
271 log_std(" hash loop: %s\n", backing_file);
274 log_std(" hash offset: %" PRIu64 " sectors\n",
275 vp.hash_area_offset * vp.hash_block_size / 512);
284 static int action_dump(int arg)
286 struct crypt_device *cd = NULL;
287 struct crypt_params_verity params = {};
290 if ((r = crypt_init(&cd, action_argv[0])))
293 params.hash_area_offset = hash_offset;
294 r = crypt_load(cd, CRYPT_VERITY, ¶ms);
301 static struct action_type {
304 int required_action_argc;
305 const char *arg_desc;
308 { "format", action_format, 2, N_("<data_device> <hash_device>"),N_("format device") },
309 { "verify", action_verify, 3, N_("<data_device> <hash_device> <root_hash>"),N_("verify device") },
310 { "create", action_create, 4, N_("<name> <data_device> <hash_device> <root_hash>"),N_("create active device") },
311 { "remove", action_remove, 1, N_("<name>"),N_("remove (deactivate) device") },
312 { "status", action_status, 1, N_("<name>"),N_("show active device status") },
313 { "dump", action_dump, 1, N_("<hash_device>"),N_("show on-disk information") },
314 { NULL, NULL, 0, NULL, NULL }
317 static void help(poptContext popt_context,
318 enum poptCallbackReason reason __attribute__((unused)),
319 struct poptOption *key,
320 const char *arg __attribute__((unused)),
321 void *data __attribute__((unused)))
323 struct action_type *action;
325 if (key->shortName == '?') {
326 log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
327 poptPrintHelp(popt_context, stdout, 0);
329 "<action> is one of:\n"));
330 for(action = action_types; action->type; action++)
331 log_std("\t%s %s - %s\n", action->type, _(action->arg_desc), _(action->desc));
333 "<name> is the device to create under %s\n"
334 "<data_device> is the data device\n"
335 "<hash_device> is the device containing verification data\n"
336 "<root_hash> hash of the root node on <hash_device>\n"),
339 log_std(_("\nDefault compiled-in dm-verity parameters:\n"
340 "\tHash: %s, Data block (bytes): %u, "
341 "Hash block (bytes): %u, Salt size: %u, Hash format: %u\n"),
342 DEFAULT_VERITY_HASH, DEFAULT_VERITY_DATA_BLOCK,
343 DEFAULT_VERITY_HASH_BLOCK, DEFAULT_VERITY_SALT_SIZE,
347 usage(popt_context, EXIT_SUCCESS, NULL, NULL);
350 static int run_action(struct action_type *action)
354 log_dbg("Running command %s.", action->type);
356 r = action->handler(0);
359 return translate_errno(r);
362 int main(int argc, const char **argv)
364 static char *popt_tmp;
365 static const char *null_action_argv[] = {NULL};
366 static struct poptOption popt_help_options[] = {
367 { NULL, '\0', POPT_ARG_CALLBACK, help, 0, NULL, NULL },
368 { "help", '?', POPT_ARG_NONE, NULL, 0, N_("Show this help message"), NULL },
369 { "usage", '\0', POPT_ARG_NONE, NULL, 0, N_("Display brief usage"), NULL },
372 static struct poptOption popt_options[] = {
373 { NULL, '\0', POPT_ARG_INCLUDE_TABLE, popt_help_options, 0, N_("Help options:"), NULL },
374 { "version", '\0', POPT_ARG_NONE, &opt_version_mode, 0, N_("Print package version"), NULL },
375 { "verbose", 'v', POPT_ARG_NONE, &opt_verbose, 0, N_("Shows more detailed error messages"), NULL },
376 { "debug", '\0', POPT_ARG_NONE, &opt_debug, 0, N_("Show debug messages"), NULL },
377 { "no-superblock", 0, POPT_ARG_VAL, &use_superblock, 0, N_("Do not use verity superblock"), NULL },
378 { "format", 0, POPT_ARG_INT, &hash_type, 0, N_("Format type (1 - normal, 0 - original Chrome OS)"), N_("number") },
379 { "data-block-size", 0, POPT_ARG_INT, &data_block_size, 0, N_("Block size on the data device"), N_("bytes") },
380 { "hash-block-size", 0, POPT_ARG_INT, &hash_block_size, 0, N_("Block size on the hash device"), N_("bytes") },
381 { "data-blocks", 0, POPT_ARG_STRING, &popt_tmp, 1, N_("The number of blocks in the data file"), N_("blocks") },
382 { "hash-offset", 0, POPT_ARG_STRING, &popt_tmp, 2, N_("Starting offset on the hash device"), N_("bytes") },
383 { "hash", 'h', POPT_ARG_STRING, &hash_algorithm, 0, N_("Hash algorithm"), N_("string") },
384 { "salt", 's', POPT_ARG_STRING, &salt_string, 0, N_("Salt"), N_("hex string") },
385 { "uuid", '\0', POPT_ARG_STRING, &opt_uuid, 0, N_("UUID for device to use."), NULL },
389 poptContext popt_context;
390 struct action_type *action;
394 crypt_set_log_callback(NULL, tool_log, NULL);
396 setlocale(LC_ALL, "");
397 bindtextdomain(PACKAGE, LOCALEDIR);
400 popt_context = poptGetContext("verity", argc, argv, popt_options, 0);
401 poptSetOtherOptionHelp(popt_context,
402 _("[OPTION...] <action> <action-specific>"));
404 while((r = poptGetNextOpt(popt_context)) > 0) {
405 unsigned long long ull_value;
409 ull_value = strtoull(popt_tmp, &endp, 10);
410 if (*endp || !*popt_tmp || !isdigit(*popt_tmp) ||
411 (errno == ERANGE && ull_value == ULLONG_MAX) ||
412 (errno != 0 && ull_value == 0))
413 r = POPT_ERROR_BADNUMBER;
417 data_blocks = ull_value;
420 hash_offset = ull_value;
429 usage(popt_context, EXIT_FAILURE, poptStrerror(r),
430 poptBadOption(popt_context, POPT_BADOPTION_NOALIAS));
432 if (opt_version_mode) {
433 log_std("%s %s\n", PACKAGE_VERITY, PACKAGE_VERSION);
434 poptFreeContext(popt_context);
438 if (!(aname = poptGetArg(popt_context)))
439 usage(popt_context, EXIT_FAILURE, _("Argument <action> missing."),
440 poptGetInvocationName(popt_context));
441 for(action = action_types; action->type; action++)
442 if (strcmp(action->type, aname) == 0)
445 usage(popt_context, EXIT_FAILURE, _("Unknown action."),
446 poptGetInvocationName(popt_context));
449 action_argv = poptGetArgs(popt_context);
450 /* Make return values of poptGetArgs more consistent in case of remaining argc = 0 */
452 action_argv = null_action_argv;
454 /* Count args, somewhat unnice, change? */
455 while(action_argv[action_argc] != NULL)
458 if(action_argc < action->required_action_argc) {
460 snprintf(buf, 128,_("%s: requires %s as arguments"), action->type, action->arg_desc);
461 usage(popt_context, EXIT_FAILURE, buf,
462 poptGetInvocationName(popt_context));
465 if (data_block_size < 0 || hash_block_size < 0 || hash_type < 0) {
466 usage(popt_context, EXIT_FAILURE,
467 _("Negative number for option not permitted."),
468 poptGetInvocationName(popt_context));
473 crypt_set_debug_level(-1);
474 dbg_version_and_cmd(argc, argv);
477 r = run_action(action);
478 poptFreeContext(popt_context);