common/hash.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2012 The Chromium OS Authors.
   4  *
   5  * (C) Copyright 2011
   6  * Joe Hershberger, National Instruments, [email protected]
   7  *
   8  * (C) Copyright 2000
   9  * Wolfgang Denk, DENX Software Engineering, [email protected].
  10  */
  11
  12 #ifndef USE_HOSTCC
  13 #include <command.h>
  14 #include <env.h>
  15 #include <log.h>
  16 #include <malloc.h>
  17 #include <mapmem.h>
  18 #include <hw_sha.h>
  19 #include <asm/cache.h>
  20 #include <asm/global_data.h>
  21 #include <asm/io.h>
  22 #include <linux/errno.h>
  23 #else
  24 #include "mkimage.h"
  25 #include <linux/compiler_attributes.h>
  26 #include <time.h>
  27 #include <linux/kconfig.h>
  28 #endif /* !USE_HOSTCC*/
  29
  30 #include <hash.h>
  31 #include <image.h>
  32 #include <u-boot/crc.h>
  33 #include <u-boot/sha1.h>
  34 #include <u-boot/sha256.h>
  35 #include <u-boot/sha512.h>
  36 #include <u-boot/md5.h>
  37
  38 static int __maybe_unused hash_init_sha1(struct hash_algo *algo, void **ctxp)
  39 {
  40         sha1_context *ctx = malloc(sizeof(sha1_context));
  41         sha1_starts(ctx);
  42         *ctxp = ctx;
  43         return 0;
  44 }
  45
  46 static int __maybe_unused hash_update_sha1(struct hash_algo *algo, void *ctx,
  47                                            const void *buf, unsigned int size,
  48                                            int is_last)
  49 {
  50         sha1_update((sha1_context *)ctx, buf, size);
  51         return 0;
  52 }
  53
  54 static int __maybe_unused hash_finish_sha1(struct hash_algo *algo, void *ctx,
  55                                            void *dest_buf, int size)
  56 {
  57         if (size < algo->digest_size)
  58                 return -1;
  59
  60         sha1_finish((sha1_context *)ctx, dest_buf);
  61         free(ctx);
  62         return 0;
  63 }
  64
  65 static int __maybe_unused hash_init_sha256(struct hash_algo *algo, void **ctxp)
  66 {
  67         sha256_context *ctx = malloc(sizeof(sha256_context));
  68         sha256_starts(ctx);
  69         *ctxp = ctx;
  70         return 0;
  71 }
  72
  73 static int __maybe_unused hash_update_sha256(struct hash_algo *algo, void *ctx,
  74                                              const void *buf, uint size,
  75                                              int is_last)
  76 {
  77         sha256_update((sha256_context *)ctx, buf, size);
  78         return 0;
  79 }
  80
  81 static int __maybe_unused hash_finish_sha256(struct hash_algo *algo, void *ctx,
  82                                              void *dest_buf, int size)
  83 {
  84         if (size < algo->digest_size)
  85                 return -1;
  86
  87         sha256_finish((sha256_context *)ctx, dest_buf);
  88         free(ctx);
  89         return 0;
  90 }
  91
  92 static int __maybe_unused hash_init_sha384(struct hash_algo *algo, void **ctxp)
  93 {
  94         sha512_context *ctx = malloc(sizeof(sha512_context));
  95         sha384_starts(ctx);
  96         *ctxp = ctx;
  97         return 0;
  98 }
  99
 100 static int __maybe_unused hash_update_sha384(struct hash_algo *algo, void *ctx,
 101                                              const void *buf, uint size,
 102                                              int is_last)
 103 {
 104         sha384_update((sha512_context *)ctx, buf, size);
 105         return 0;
 106 }
 107
 108 static int __maybe_unused hash_finish_sha384(struct hash_algo *algo, void *ctx,
 109                                              void *dest_buf, int size)
 110 {
 111         if (size < algo->digest_size)
 112                 return -1;
 113
 114         sha384_finish((sha512_context *)ctx, dest_buf);
 115         free(ctx);
 116         return 0;
 117 }
 118
 119 static int __maybe_unused hash_init_sha512(struct hash_algo *algo, void **ctxp)
 120 {
 121         sha512_context *ctx = malloc(sizeof(sha512_context));
 122         sha512_starts(ctx);
 123         *ctxp = ctx;
 124         return 0;
 125 }
 126
 127 static int __maybe_unused hash_update_sha512(struct hash_algo *algo, void *ctx,
 128                                              const void *buf, uint size,
 129                                              int is_last)
 130 {
 131         sha512_update((sha512_context *)ctx, buf, size);
 132         return 0;
 133 }
 134
 135 static int __maybe_unused hash_finish_sha512(struct hash_algo *algo, void *ctx,
 136                                              void *dest_buf, int size)
 137 {
 138         if (size < algo->digest_size)
 139                 return -1;
 140
 141         sha512_finish((sha512_context *)ctx, dest_buf);
 142         free(ctx);
 143         return 0;
 144 }
 145
 146 static int hash_init_crc16_ccitt(struct hash_algo *algo, void **ctxp)
 147 {
 148         uint16_t *ctx = malloc(sizeof(uint16_t));
 149         *ctx = 0;
 150         *ctxp = ctx;
 151         return 0;
 152 }
 153
 154 static int hash_update_crc16_ccitt(struct hash_algo *algo, void *ctx,
 155                                    const void *buf, unsigned int size,
 156                                    int is_last)
 157 {
 158         *((uint16_t *)ctx) = crc16_ccitt(*((uint16_t *)ctx), buf, size);
 159         return 0;
 160 }
 161
 162 static int hash_finish_crc16_ccitt(struct hash_algo *algo, void *ctx,
 163                                    void *dest_buf, int size)
 164 {
 165         if (size < algo->digest_size)
 166                 return -1;
 167
 168         *((uint16_t *)dest_buf) = *((uint16_t *)ctx);
 169         free(ctx);
 170         return 0;
 171 }
 172
 173 static int __maybe_unused hash_init_crc32(struct hash_algo *algo, void **ctxp)
 174 {
 175         uint32_t *ctx = malloc(sizeof(uint32_t));
 176         *ctx = 0;
 177         *ctxp = ctx;
 178         return 0;
 179 }
 180
 181 static int __maybe_unused hash_update_crc32(struct hash_algo *algo, void *ctx,
 182                                             const void *buf, unsigned int size,
 183                                             int is_last)
 184 {
 185         *((uint32_t *)ctx) = crc32(*((uint32_t *)ctx), buf, size);
 186         return 0;
 187 }
 188
 189 static int __maybe_unused hash_finish_crc32(struct hash_algo *algo, void *ctx,
 190                                             void *dest_buf, int size)
 191 {
 192         if (size < algo->digest_size)
 193                 return -1;
 194
 195         *((uint32_t *)dest_buf) = *((uint32_t *)ctx);
 196         free(ctx);
 197         return 0;
 198 }
 199
 200 /*
 201  * These are the hash algorithms we support.  If we have hardware acceleration
 202  * is enable we will use that, otherwise a software version of the algorithm.
 203  * Note that algorithm names must be in lower case.
 204  */
 205 static struct hash_algo hash_algo[] = {
 206 #if CONFIG_IS_ENABLED(MD5)
 207         {
 208                 .name           = "md5",
 209                 .digest_size    = MD5_SUM_LEN,
 210                 .chunk_size     = CHUNKSZ_MD5,
 211                 .hash_func_ws   = md5_wd,
 212         },
 213 #endif
 214 #if CONFIG_IS_ENABLED(SHA1)
 215         {
 216                 .name           = "sha1",
 217                 .digest_size    = SHA1_SUM_LEN,
 218                 .chunk_size     = CHUNKSZ_SHA1,
 219 #if CONFIG_IS_ENABLED(SHA_HW_ACCEL)
 220                 .hash_func_ws   = hw_sha1,
 221 #else
 222                 .hash_func_ws   = sha1_csum_wd,
 223 #endif
 224 #if CONFIG_IS_ENABLED(SHA_PROG_HW_ACCEL)
 225                 .hash_init      = hw_sha_init,
 226                 .hash_update    = hw_sha_update,
 227                 .hash_finish    = hw_sha_finish,
 228 #else
 229                 .hash_init      = hash_init_sha1,
 230                 .hash_update    = hash_update_sha1,
 231                 .hash_finish    = hash_finish_sha1,
 232 #endif
 233         },
 234 #endif
 235 #if CONFIG_IS_ENABLED(SHA256)
 236         {
 237                 .name           = "sha256",
 238                 .digest_size    = SHA256_SUM_LEN,
 239                 .chunk_size     = CHUNKSZ_SHA256,
 240 #if CONFIG_IS_ENABLED(SHA_HW_ACCEL)
 241                 .hash_func_ws   = hw_sha256,
 242 #else
 243                 .hash_func_ws   = sha256_csum_wd,
 244 #endif
 245 #if CONFIG_IS_ENABLED(SHA_PROG_HW_ACCEL)
 246                 .hash_init      = hw_sha_init,
 247                 .hash_update    = hw_sha_update,
 248                 .hash_finish    = hw_sha_finish,
 249 #else
 250                 .hash_init      = hash_init_sha256,
 251                 .hash_update    = hash_update_sha256,
 252                 .hash_finish    = hash_finish_sha256,
 253 #endif
 254         },
 255 #endif
 256 #if CONFIG_IS_ENABLED(SHA384)
 257         {
 258                 .name           = "sha384",
 259                 .digest_size    = SHA384_SUM_LEN,
 260                 .chunk_size     = CHUNKSZ_SHA384,
 261 #if CONFIG_IS_ENABLED(SHA512_HW_ACCEL)
 262                 .hash_func_ws   = hw_sha384,
 263 #else
 264                 .hash_func_ws   = sha384_csum_wd,
 265 #endif
 266 #if CONFIG_IS_ENABLED(SHA512_HW_ACCEL) && CONFIG_IS_ENABLED(SHA_PROG_HW_ACCEL)
 267                 .hash_init      = hw_sha_init,
 268                 .hash_update    = hw_sha_update,
 269                 .hash_finish    = hw_sha_finish,
 270 #else
 271                 .hash_init      = hash_init_sha384,
 272                 .hash_update    = hash_update_sha384,
 273                 .hash_finish    = hash_finish_sha384,
 274 #endif
 275         },
 276 #endif
 277 #if CONFIG_IS_ENABLED(SHA512)
 278         {
 279                 .name           = "sha512",
 280                 .digest_size    = SHA512_SUM_LEN,
 281                 .chunk_size     = CHUNKSZ_SHA512,
 282 #if CONFIG_IS_ENABLED(SHA512_HW_ACCEL)
 283                 .hash_func_ws   = hw_sha512,
 284 #else
 285                 .hash_func_ws   = sha512_csum_wd,
 286 #endif
 287 #if CONFIG_IS_ENABLED(SHA512_HW_ACCEL) && CONFIG_IS_ENABLED(SHA_PROG_HW_ACCEL)
 288                 .hash_init      = hw_sha_init,
 289                 .hash_update    = hw_sha_update,
 290                 .hash_finish    = hw_sha_finish,
 291 #else
 292                 .hash_init      = hash_init_sha512,
 293                 .hash_update    = hash_update_sha512,
 294                 .hash_finish    = hash_finish_sha512,
 295 #endif
 296         },
 297 #endif
 298         {
 299                 .name           = "crc16-ccitt",
 300                 .digest_size    = 2,
 301                 .chunk_size     = CHUNKSZ,
 302                 .hash_func_ws   = crc16_ccitt_wd_buf,
 303                 .hash_init      = hash_init_crc16_ccitt,
 304                 .hash_update    = hash_update_crc16_ccitt,
 305                 .hash_finish    = hash_finish_crc16_ccitt,
 306         },
 307 #if CONFIG_IS_ENABLED(CRC32)
 308         {
 309                 .name           = "crc32",
 310                 .digest_size    = 4,
 311                 .chunk_size     = CHUNKSZ_CRC32,
 312                 .hash_func_ws   = crc32_wd_buf,
 313                 .hash_init      = hash_init_crc32,
 314                 .hash_update    = hash_update_crc32,
 315                 .hash_finish    = hash_finish_crc32,
 316         },
 317 #endif
 318 };
 319
 320 /* Try to minimize code size for boards that don't want much hashing */
 321 #if CONFIG_IS_ENABLED(SHA256) || IS_ENABLED(CONFIG_CMD_SHA1SUM) || \
 322         CONFIG_IS_ENABLED(CRC32_VERIFY) || IS_ENABLED(CONFIG_CMD_HASH) || \
 323         CONFIG_IS_ENABLED(SHA384) || CONFIG_IS_ENABLED(SHA512) || \
 324         IS_ENABLED(CONFIG_CMD_MD5SUM)
 325 #define multi_hash()    1
 326 #else
 327 #define multi_hash()    0
 328 #endif
 329
 330 int hash_lookup_algo(const char *algo_name, struct hash_algo **algop)
 331 {
 332         int i;
 333
 334         for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
 335                 if (!strcmp(algo_name, hash_algo[i].name)) {
 336                         *algop = &hash_algo[i];
 337                         return 0;
 338                 }
 339         }
 340
 341         debug("Unknown hash algorithm '%s'\n", algo_name);
 342         return -EPROTONOSUPPORT;
 343 }
 344
 345 int hash_progressive_lookup_algo(const char *algo_name,
 346                                  struct hash_algo **algop)
 347 {
 348         int i;
 349
 350         for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
 351                 if (!strcmp(algo_name, hash_algo[i].name)) {
 352                         if (hash_algo[i].hash_init) {
 353                                 *algop = &hash_algo[i];
 354                                 return 0;
 355                         }
 356                 }
 357         }
 358
 359         debug("Unknown hash algorithm '%s'\n", algo_name);
 360         return -EPROTONOSUPPORT;
 361 }
 362
 363 #ifndef USE_HOSTCC
 364 int hash_parse_string(const char *algo_name, const char *str, uint8_t *result)
 365 {
 366         struct hash_algo *algo;
 367         int ret;
 368         int i;
 369
 370         ret = hash_lookup_algo(algo_name, &algo);
 371         if (ret)
 372                 return ret;
 373
 374         for (i = 0; i < algo->digest_size; i++) {
 375                 char chr[3];
 376
 377                 strlcpy(chr, &str[i * 2], 3);
 378                 result[i] = hextoul(chr, NULL);
 379         }
 380
 381         return 0;
 382 }
 383
 384 int hash_block(const char *algo_name, const void *data, unsigned int len,
 385                uint8_t *output, int *output_size)
 386 {
 387         struct hash_algo *algo;
 388         int ret;
 389
 390         ret = hash_lookup_algo(algo_name, &algo);
 391         if (ret)
 392                 return ret;
 393
 394         if (output_size && *output_size < algo->digest_size) {
 395                 debug("Output buffer size %d too small (need %d bytes)",
 396                       *output_size, algo->digest_size);
 397                 return -ENOSPC;
 398         }
 399         if (output_size)
 400                 *output_size = algo->digest_size;
 401         algo->hash_func_ws(data, len, output, algo->chunk_size);
 402
 403         return 0;
 404 }
 405
 406 #if !defined(CONFIG_SPL_BUILD) && (defined(CONFIG_CMD_HASH) || \
 407         defined(CONFIG_CMD_SHA1SUM) || defined(CONFIG_CMD_CRC32)) || \
 408         defined(CONFIG_CMD_MD5SUM)
 409 /**
 410  * store_result: Store the resulting sum to an address or variable
 411  *
 412  * @algo:               Hash algorithm being used
 413  * @sum:                Hash digest (algo->digest_size bytes)
 414  * @dest:               Destination, interpreted as a hex address if it starts
 415  *                      with * (or allow_env_vars is 0) or otherwise as an
 416  *                      environment variable.
 417  * @allow_env_vars:     non-zero to permit storing the result to an
 418  *                      variable environment
 419  */
 420 static void store_result(struct hash_algo *algo, const uint8_t *sum,
 421                          const char *dest, int allow_env_vars)
 422 {
 423         unsigned int i;
 424         int env_var = 0;
 425
 426         /*
 427          * If environment variables are allowed, then we assume that 'dest'
 428          * is an environment variable, unless it starts with *, in which
 429          * case we assume it is an address. If not allowed, it is always an
 430          * address. This is to support the crc32 command.
 431          */
 432         if (allow_env_vars) {
 433                 if (*dest == '*')
 434                         dest++;
 435                 else
 436                         env_var = 1;
 437         }
 438
 439         if (env_var) {
 440                 char str_output[HASH_MAX_DIGEST_SIZE * 2 + 1];
 441                 char *str_ptr = str_output;
 442
 443                 for (i = 0; i < algo->digest_size; i++) {
 444                         sprintf(str_ptr, "%02x", sum[i]);
 445                         str_ptr += 2;
 446                 }
 447                 *str_ptr = '\0';
 448                 env_set(dest, str_output);
 449         } else {
 450                 ulong addr;
 451                 void *buf;
 452
 453                 addr = hextoul(dest, NULL);
 454                 buf = map_sysmem(addr, algo->digest_size);
 455                 memcpy(buf, sum, algo->digest_size);
 456                 unmap_sysmem(buf);
 457         }
 458 }
 459
 460 /**
 461  * parse_verify_sum: Parse a hash verification parameter
 462  *
 463  * @algo:               Hash algorithm being used
 464  * @verify_str:         Argument to parse. If it starts with * then it is
 465  *                      interpreted as a hex address containing the hash.
 466  *                      If the length is exactly the right number of hex digits
 467  *                      for the digest size, then we assume it is a hex digest.
 468  *                      Otherwise we assume it is an environment variable, and
 469  *                      look up its value (it must contain a hex digest).
 470  * @vsum:               Returns binary digest value (algo->digest_size bytes)
 471  * @allow_env_vars:     non-zero to permit storing the result to an environment
 472  *                      variable. If 0 then verify_str is assumed to be an
 473  *                      address, and the * prefix is not expected.
 474  * Return: 0 if ok, non-zero on error
 475  */
 476 static int parse_verify_sum(struct hash_algo *algo, char *verify_str,
 477                             uint8_t *vsum, int allow_env_vars)
 478 {
 479         int env_var = 0;
 480
 481         /* See comment above in store_result() */
 482         if (allow_env_vars) {
 483                 if (*verify_str == '*')
 484                         verify_str++;
 485                 else
 486                         env_var = 1;
 487         }
 488
 489         if (!env_var) {
 490                 ulong addr;
 491                 void *buf;
 492
 493                 addr = hextoul(verify_str, NULL);
 494                 buf = map_sysmem(addr, algo->digest_size);
 495                 memcpy(vsum, buf, algo->digest_size);
 496         } else {
 497                 char *vsum_str;
 498                 int digits = algo->digest_size * 2;
 499
 500                 /*
 501                  * As with the original code from sha1sum.c, we assume that a
 502                  * string which matches the digest size exactly is a hex
 503                  * string and not an environment variable.
 504                  */
 505                 if (strlen(verify_str) == digits)
 506                         vsum_str = verify_str;
 507                 else {
 508                         vsum_str = env_get(verify_str);
 509                         if (vsum_str == NULL || strlen(vsum_str) != digits) {
 510                                 printf("Expected %d hex digits in env var\n",
 511                                        digits);
 512                                 return 1;
 513                         }
 514                 }
 515
 516                 hash_parse_string(algo->name, vsum_str, vsum);
 517         }
 518         return 0;
 519 }
 520
 521 static void hash_show(struct hash_algo *algo, ulong addr, ulong len, uint8_t *output)
 522 {
 523         int i;
 524
 525         printf("%s for %08lx ... %08lx ==> ", algo->name, addr, addr + len - 1);
 526         for (i = 0; i < algo->digest_size; i++)
 527                 printf("%02x", output[i]);
 528 }
 529
 530 int hash_command(const char *algo_name, int flags, struct cmd_tbl *cmdtp,
 531                  int flag, int argc, char *const argv[])
 532 {
 533         ulong addr, len;
 534
 535         if ((argc < 2) || ((flags & HASH_FLAG_VERIFY) && (argc < 3)))
 536                 return CMD_RET_USAGE;
 537
 538         addr = hextoul(*argv++, NULL);
 539         len = hextoul(*argv++, NULL);
 540
 541         if (multi_hash()) {
 542                 struct hash_algo *algo;
 543                 u8 *output;
 544                 uint8_t vsum[HASH_MAX_DIGEST_SIZE];
 545                 void *buf;
 546
 547                 if (hash_lookup_algo(algo_name, &algo)) {
 548                         printf("Unknown hash algorithm '%s'\n", algo_name);
 549                         return CMD_RET_USAGE;
 550                 }
 551                 argc -= 2;
 552
 553                 if (algo->digest_size > HASH_MAX_DIGEST_SIZE) {
 554                         puts("HASH_MAX_DIGEST_SIZE exceeded\n");
 555                         return 1;
 556                 }
 557
 558                 output = memalign(ARCH_DMA_MINALIGN,
 559                                   sizeof(uint32_t) * HASH_MAX_DIGEST_SIZE);
 560                 if (!output)
 561                         return CMD_RET_FAILURE;
 562
 563                 buf = map_sysmem(addr, len);
 564                 algo->hash_func_ws(buf, len, output, algo->chunk_size);
 565                 unmap_sysmem(buf);
 566
 567                 /* Try to avoid code bloat when verify is not needed */
 568 #if defined(CONFIG_CRC32_VERIFY) || defined(CONFIG_SHA1SUM_VERIFY) || \
 569         defined(CONFIG_MD5SUM_VERIFY) || defined(CONFIG_HASH_VERIFY)
 570                 if (flags & HASH_FLAG_VERIFY) {
 571 #else
 572                 if (0) {
 573 #endif
 574                         if (parse_verify_sum(algo, *argv, vsum,
 575                                         flags & HASH_FLAG_ENV)) {
 576                                 printf("ERROR: %s does not contain a valid "
 577                                         "%s sum\n", *argv, algo->name);
 578                                 free(output);
 579                                 return 1;
 580                         }
 581                         if (memcmp(output, vsum, algo->digest_size) != 0) {
 582                                 int i;
 583
 584                                 hash_show(algo, addr, len, output);
 585                                 printf(" != ");
 586                                 for (i = 0; i < algo->digest_size; i++)
 587                                         printf("%02x", vsum[i]);
 588                                 puts(" ** ERROR **\n");
 589                                 free(output);
 590                                 return 1;
 591                         }
 592                 } else {
 593                         hash_show(algo, addr, len, output);
 594                         printf("\n");
 595
 596                         if (argc) {
 597                                 store_result(algo, output, *argv,
 598                                         flags & HASH_FLAG_ENV);
 599                         }
 600                 }
 601
 602                 free(output);
 603
 604         /* Horrible code size hack for boards that just want crc32 */
 605         } else {
 606                 ulong crc;
 607                 ulong *ptr;
 608
 609                 crc = crc32_wd(0, (const uchar *)addr, len, CHUNKSZ_CRC32);
 610
 611                 printf("CRC32 for %08lx ... %08lx ==> %08lx\n",
 612                                 addr, addr + len - 1, crc);
 613
 614                 if (argc >= 3) {
 615                         ptr = (ulong *)hextoul(argv[0], NULL);
 616                         *ptr = crc;
 617                 }
 618         }
 619
 620         return 0;
 621 }
 622 #endif /* CONFIG_CMD_HASH || CONFIG_CMD_SHA1SUM || CONFIG_CMD_CRC32) */
 623 #endif /* !USE_HOSTCC */