cmd/avb.c

   1
   2 /*
   3  * (C) Copyright 2018, Linaro Limited
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <avb_verify.h>
   9 #include <command.h>
  10 #include <env.h>
  11 #include <image.h>
  12 #include <malloc.h>
  13 #include <mmc.h>
  14
  15 #define AVB_BOOTARGS    "avb_bootargs"
  16 static struct AvbOps *avb_ops;
  17
  18 static const char * const requested_partitions[] = {"boot",
  19                                              "system",
  20                                              "vendor",
  21                                              NULL};
  22
  23 int do_avb_init(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  24 {
  25         unsigned long mmc_dev;
  26
  27         if (argc != 2)
  28                 return CMD_RET_USAGE;
  29
  30         mmc_dev = simple_strtoul(argv[1], NULL, 16);
  31
  32         if (avb_ops)
  33                 avb_ops_free(avb_ops);
  34
  35         avb_ops = avb_ops_alloc(mmc_dev);
  36         if (avb_ops)
  37                 return CMD_RET_SUCCESS;
  38
  39         printf("Failed to initialize avb2\n");
  40
  41         return CMD_RET_FAILURE;
  42 }
  43
  44 int do_avb_read_part(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  45 {
  46         const char *part;
  47         s64 offset;
  48         size_t bytes, bytes_read = 0;
  49         void *buffer;
  50
  51         if (!avb_ops) {
  52                 printf("AVB 2.0 is not initialized, please run 'avb init'\n");
  53                 return CMD_RET_USAGE;
  54         }
  55
  56         if (argc != 5)
  57                 return CMD_RET_USAGE;
  58
  59         part = argv[1];
  60         offset = simple_strtoul(argv[2], NULL, 16);
  61         bytes = simple_strtoul(argv[3], NULL, 16);
  62         buffer = (void *)simple_strtoul(argv[4], NULL, 16);
  63
  64         if (avb_ops->read_from_partition(avb_ops, part, offset, bytes,
  65                                          buffer, &bytes_read) ==
  66                                          AVB_IO_RESULT_OK) {
  67                 printf("Read %zu bytes\n", bytes_read);
  68                 return CMD_RET_SUCCESS;
  69         }
  70
  71         printf("Failed to read from partition\n");
  72
  73         return CMD_RET_FAILURE;
  74 }
  75
  76 int do_avb_read_part_hex(cmd_tbl_t *cmdtp, int flag, int argc,
  77                          char *const argv[])
  78 {
  79         const char *part;
  80         s64 offset;
  81         size_t bytes, bytes_read = 0;
  82         char *buffer;
  83
  84         if (!avb_ops) {
  85                 printf("AVB 2.0 is not initialized, please run 'avb init'\n");
  86                 return CMD_RET_USAGE;
  87         }
  88
  89         if (argc != 4)
  90                 return CMD_RET_USAGE;
  91
  92         part = argv[1];
  93         offset = simple_strtoul(argv[2], NULL, 16);
  94         bytes = simple_strtoul(argv[3], NULL, 16);
  95
  96         buffer = malloc(bytes);
  97         if (!buffer) {
  98                 printf("Failed to tlb_allocate buffer for data\n");
  99                 return CMD_RET_FAILURE;
 100         }
 101         memset(buffer, 0, bytes);
 102
 103         if (avb_ops->read_from_partition(avb_ops, part, offset, bytes, buffer,
 104                                          &bytes_read) == AVB_IO_RESULT_OK) {
 105                 printf("Requested %zu, read %zu bytes\n", bytes, bytes_read);
 106                 printf("Data: ");
 107                 for (int i = 0; i < bytes_read; i++)
 108                         printf("%02X", buffer[i]);
 109
 110                 printf("\n");
 111
 112                 free(buffer);
 113                 return CMD_RET_SUCCESS;
 114         }
 115
 116         printf("Failed to read from partition\n");
 117
 118         free(buffer);
 119         return CMD_RET_FAILURE;
 120 }
 121
 122 int do_avb_write_part(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 123 {
 124         const char *part;
 125         s64 offset;
 126         size_t bytes;
 127         void *buffer;
 128
 129         if (!avb_ops) {
 130                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 131                 return CMD_RET_FAILURE;
 132         }
 133
 134         if (argc != 5)
 135                 return CMD_RET_USAGE;
 136
 137         part = argv[1];
 138         offset = simple_strtoul(argv[2], NULL, 16);
 139         bytes = simple_strtoul(argv[3], NULL, 16);
 140         buffer = (void *)simple_strtoul(argv[4], NULL, 16);
 141
 142         if (avb_ops->write_to_partition(avb_ops, part, offset, bytes, buffer) ==
 143             AVB_IO_RESULT_OK) {
 144                 printf("Wrote %zu bytes\n", bytes);
 145                 return CMD_RET_SUCCESS;
 146         }
 147
 148         printf("Failed to write in partition\n");
 149
 150         return CMD_RET_FAILURE;
 151 }
 152
 153 int do_avb_read_rb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 154 {
 155         size_t index;
 156         u64 rb_idx;
 157
 158         if (!avb_ops) {
 159                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 160                 return CMD_RET_FAILURE;
 161         }
 162
 163         if (argc != 2)
 164                 return CMD_RET_USAGE;
 165
 166         index = (size_t)simple_strtoul(argv[1], NULL, 16);
 167
 168         if (avb_ops->read_rollback_index(avb_ops, index, &rb_idx) ==
 169             AVB_IO_RESULT_OK) {
 170                 printf("Rollback index: %llx\n", rb_idx);
 171                 return CMD_RET_SUCCESS;
 172         }
 173
 174         printf("Failed to read rollback index\n");
 175
 176         return CMD_RET_FAILURE;
 177 }
 178
 179 int do_avb_write_rb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 180 {
 181         size_t index;
 182         u64 rb_idx;
 183
 184         if (!avb_ops) {
 185                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 186                 return CMD_RET_FAILURE;
 187         }
 188
 189         if (argc != 3)
 190                 return CMD_RET_USAGE;
 191
 192         index = (size_t)simple_strtoul(argv[1], NULL, 16);
 193         rb_idx = simple_strtoul(argv[2], NULL, 16);
 194
 195         if (avb_ops->write_rollback_index(avb_ops, index, rb_idx) ==
 196             AVB_IO_RESULT_OK)
 197                 return CMD_RET_SUCCESS;
 198
 199         printf("Failed to write rollback index\n");
 200
 201         return CMD_RET_FAILURE;
 202 }
 203
 204 int do_avb_get_uuid(cmd_tbl_t *cmdtp, int flag,
 205                     int argc, char * const argv[])
 206 {
 207         const char *part;
 208         char buffer[UUID_STR_LEN + 1];
 209
 210         if (!avb_ops) {
 211                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 212                 return CMD_RET_FAILURE;
 213         }
 214
 215         if (argc != 2)
 216                 return CMD_RET_USAGE;
 217
 218         part = argv[1];
 219
 220         if (avb_ops->get_unique_guid_for_partition(avb_ops, part, buffer,
 221                                                    UUID_STR_LEN + 1) ==
 222                                                    AVB_IO_RESULT_OK) {
 223                 printf("'%s' UUID: %s\n", part, buffer);
 224                 return CMD_RET_SUCCESS;
 225         }
 226
 227         printf("Failed to read UUID\n");
 228
 229         return CMD_RET_FAILURE;
 230 }
 231
 232 int do_avb_verify_part(cmd_tbl_t *cmdtp, int flag,
 233                        int argc, char *const argv[])
 234 {
 235         AvbSlotVerifyResult slot_result;
 236         AvbSlotVerifyData *out_data;
 237         char *cmdline;
 238         char *extra_args;
 239
 240         bool unlocked = false;
 241         int res = CMD_RET_FAILURE;
 242
 243         if (!avb_ops) {
 244                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 245                 return CMD_RET_FAILURE;
 246         }
 247
 248         if (argc != 1)
 249                 return CMD_RET_USAGE;
 250
 251         printf("## Android Verified Boot 2.0 version %s\n",
 252                avb_version_string());
 253
 254         if (avb_ops->read_is_device_unlocked(avb_ops, &unlocked) !=
 255             AVB_IO_RESULT_OK) {
 256                 printf("Can't determine device lock state.\n");
 257                 return CMD_RET_FAILURE;
 258         }
 259
 260         slot_result =
 261                 avb_slot_verify(avb_ops,
 262                                 requested_partitions,
 263                                 "",
 264                                 unlocked,
 265                                 AVB_HASHTREE_ERROR_MODE_RESTART_AND_INVALIDATE,
 266                                 &out_data);
 267
 268         switch (slot_result) {
 269         case AVB_SLOT_VERIFY_RESULT_OK:
 270                 /* Until we don't have support of changing unlock states, we
 271                  * assume that we are by default in locked state.
 272                  * So in this case we can boot only when verification is
 273                  * successful; we also supply in cmdline GREEN boot state
 274                  */
 275                 printf("Verification passed successfully\n");
 276
 277                 /* export additional bootargs to AVB_BOOTARGS env var */
 278
 279                 extra_args = avb_set_state(avb_ops, AVB_GREEN);
 280                 if (extra_args)
 281                         cmdline = append_cmd_line(out_data->cmdline,
 282                                                   extra_args);
 283                 else
 284                         cmdline = out_data->cmdline;
 285
 286                 env_set(AVB_BOOTARGS, cmdline);
 287
 288                 res = CMD_RET_SUCCESS;
 289                 break;
 290         case AVB_SLOT_VERIFY_RESULT_ERROR_VERIFICATION:
 291                 printf("Verification failed\n");
 292                 break;
 293         case AVB_SLOT_VERIFY_RESULT_ERROR_IO:
 294                 printf("I/O error occurred during verification\n");
 295                 break;
 296         case AVB_SLOT_VERIFY_RESULT_ERROR_OOM:
 297                 printf("OOM error occurred during verification\n");
 298                 break;
 299         case AVB_SLOT_VERIFY_RESULT_ERROR_INVALID_METADATA:
 300                 printf("Corrupted dm-verity metadata detected\n");
 301                 break;
 302         case AVB_SLOT_VERIFY_RESULT_ERROR_UNSUPPORTED_VERSION:
 303                 printf("Unsupported version avbtool was used\n");
 304                 break;
 305         case AVB_SLOT_VERIFY_RESULT_ERROR_ROLLBACK_INDEX:
 306                 printf("Checking rollback index failed\n");
 307                 break;
 308         case AVB_SLOT_VERIFY_RESULT_ERROR_PUBLIC_KEY_REJECTED:
 309                 printf("Public key was rejected\n");
 310                 break;
 311         default:
 312                 printf("Unknown error occurred\n");
 313         }
 314
 315         return res;
 316 }
 317
 318 int do_avb_is_unlocked(cmd_tbl_t *cmdtp, int flag,
 319                        int argc, char * const argv[])
 320 {
 321         bool unlock;
 322
 323         if (!avb_ops) {
 324                 printf("AVB not initialized, run 'avb init' first\n");
 325                 return CMD_RET_FAILURE;
 326         }
 327
 328         if (argc != 1) {
 329                 printf("--%s(-1)\n", __func__);
 330                 return CMD_RET_USAGE;
 331         }
 332
 333         if (avb_ops->read_is_device_unlocked(avb_ops, &unlock) ==
 334             AVB_IO_RESULT_OK) {
 335                 printf("Unlocked = %d\n", unlock);
 336                 return CMD_RET_SUCCESS;
 337         }
 338
 339         printf("Can't determine device lock state.\n");
 340
 341         return CMD_RET_FAILURE;
 342 }
 343
 344 int do_avb_read_pvalue(cmd_tbl_t *cmdtp, int flag, int argc,
 345                        char * const argv[])
 346 {
 347         const char *name;
 348         size_t bytes;
 349         size_t bytes_read;
 350         void *buffer;
 351         char *endp;
 352
 353         if (!avb_ops) {
 354                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 355                 return CMD_RET_FAILURE;
 356         }
 357
 358         if (argc != 3)
 359                 return CMD_RET_USAGE;
 360
 361         name = argv[1];
 362         bytes = simple_strtoul(argv[2], &endp, 10);
 363         if (*endp && *endp != '\n')
 364                 return CMD_RET_USAGE;
 365
 366         buffer = malloc(bytes);
 367         if (!buffer)
 368                 return CMD_RET_FAILURE;
 369
 370         if (avb_ops->read_persistent_value(avb_ops, name, bytes, buffer,
 371                                            &bytes_read) == AVB_IO_RESULT_OK) {
 372                 printf("Read %zu bytes, value = %s\n", bytes_read,
 373                        (char *)buffer);
 374                 free(buffer);
 375                 return CMD_RET_SUCCESS;
 376         }
 377
 378         printf("Failed to read persistent value\n");
 379
 380         free(buffer);
 381
 382         return CMD_RET_FAILURE;
 383 }
 384
 385 int do_avb_write_pvalue(cmd_tbl_t *cmdtp, int flag, int argc,
 386                         char * const argv[])
 387 {
 388         const char *name;
 389         const char *value;
 390
 391         if (!avb_ops) {
 392                 printf("AVB 2.0 is not initialized, run 'avb init' first\n");
 393                 return CMD_RET_FAILURE;
 394         }
 395
 396         if (argc != 3)
 397                 return CMD_RET_USAGE;
 398
 399         name = argv[1];
 400         value = argv[2];
 401
 402         if (avb_ops->write_persistent_value(avb_ops, name, strlen(value) + 1,
 403                                             (const uint8_t *)value) ==
 404             AVB_IO_RESULT_OK) {
 405                 printf("Wrote %zu bytes\n", strlen(value) + 1);
 406                 return CMD_RET_SUCCESS;
 407         }
 408
 409         printf("Failed to write persistent value\n");
 410
 411         return CMD_RET_FAILURE;
 412 }
 413
 414 static cmd_tbl_t cmd_avb[] = {
 415         U_BOOT_CMD_MKENT(init, 2, 0, do_avb_init, "", ""),
 416         U_BOOT_CMD_MKENT(read_rb, 2, 0, do_avb_read_rb, "", ""),
 417         U_BOOT_CMD_MKENT(write_rb, 3, 0, do_avb_write_rb, "", ""),
 418         U_BOOT_CMD_MKENT(is_unlocked, 1, 0, do_avb_is_unlocked, "", ""),
 419         U_BOOT_CMD_MKENT(get_uuid, 2, 0, do_avb_get_uuid, "", ""),
 420         U_BOOT_CMD_MKENT(read_part, 5, 0, do_avb_read_part, "", ""),
 421         U_BOOT_CMD_MKENT(read_part_hex, 4, 0, do_avb_read_part_hex, "", ""),
 422         U_BOOT_CMD_MKENT(write_part, 5, 0, do_avb_write_part, "", ""),
 423         U_BOOT_CMD_MKENT(verify, 1, 0, do_avb_verify_part, "", ""),
 424 #ifdef CONFIG_OPTEE_TA_AVB
 425         U_BOOT_CMD_MKENT(read_pvalue, 3, 0, do_avb_read_pvalue, "", ""),
 426         U_BOOT_CMD_MKENT(write_pvalue, 3, 0, do_avb_write_pvalue, "", ""),
 427 #endif
 428 };
 429
 430 static int do_avb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 431 {
 432         cmd_tbl_t *cp;
 433
 434         cp = find_cmd_tbl(argv[1], cmd_avb, ARRAY_SIZE(cmd_avb));
 435
 436         argc--;
 437         argv++;
 438
 439         if (!cp || argc > cp->maxargs)
 440                 return CMD_RET_USAGE;
 441
 442         if (flag == CMD_FLAG_REPEAT)
 443                 return CMD_RET_FAILURE;
 444
 445         return cp->cmd(cmdtp, flag, argc, argv);
 446 }
 447
 448 U_BOOT_CMD(
 449         avb, 29, 0, do_avb,
 450         "Provides commands for testing Android Verified Boot 2.0 functionality",
 451         "init <dev> - initialize avb2 for <dev>\n"
 452         "avb read_rb <num> - read rollback index at location <num>\n"
 453         "avb write_rb <num> <rb> - write rollback index <rb> to <num>\n"
 454         "avb is_unlocked - returns unlock status of the device\n"
 455         "avb get_uuid <partname> - read and print uuid of partition <part>\n"
 456         "avb read_part <partname> <offset> <num> <addr> - read <num> bytes from\n"
 457         "    partition <partname> to buffer <addr>\n"
 458         "avb read_part_hex <partname> <offset> <num> - read <num> bytes from\n"
 459         "    partition <partname> and print to stdout\n"
 460         "avb write_part <partname> <offset> <num> <addr> - write <num> bytes to\n"
 461         "    <partname> by <offset> using data from <addr>\n"
 462 #ifdef CONFIG_OPTEE_TA_AVB
 463         "avb read_pvalue <name> <bytes> - read a persistent value <name>\n"
 464         "avb write_pvalue <name> <value> - write a persistent value <name>\n"
 465 #endif
 466         "avb verify - run verification process using hash data\n"
 467         "    from vbmeta structure\n"
 468         );