1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2012 The Chromium OS Authors.
20 #include <asm/cache.h>
21 #include <asm/global_data.h>
23 #include <linux/errno.h>
24 #include <u-boot/crc.h>
28 #endif /* !USE_HOSTCC*/
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>
38 #if !defined(USE_HOSTCC) && defined(CONFIG_NEEDS_MANUAL_RELOC)
39 DECLARE_GLOBAL_DATA_PTR;
42 static void reloc_update(void);
44 #if defined(CONFIG_SHA1) && !defined(CONFIG_SHA_PROG_HW_ACCEL)
45 static int hash_init_sha1(struct hash_algo *algo, void **ctxp)
47 sha1_context *ctx = malloc(sizeof(sha1_context));
53 static int hash_update_sha1(struct hash_algo *algo, void *ctx, const void *buf,
54 unsigned int size, int is_last)
56 sha1_update((sha1_context *)ctx, buf, size);
60 static int hash_finish_sha1(struct hash_algo *algo, void *ctx, void *dest_buf,
63 if (size < algo->digest_size)
66 sha1_finish((sha1_context *)ctx, dest_buf);
72 #if defined(CONFIG_SHA256) && !defined(CONFIG_SHA_PROG_HW_ACCEL)
73 static int hash_init_sha256(struct hash_algo *algo, void **ctxp)
75 sha256_context *ctx = malloc(sizeof(sha256_context));
81 static int hash_update_sha256(struct hash_algo *algo, void *ctx,
82 const void *buf, unsigned int size, int is_last)
84 sha256_update((sha256_context *)ctx, buf, size);
88 static int hash_finish_sha256(struct hash_algo *algo, void *ctx, void
91 if (size < algo->digest_size)
94 sha256_finish((sha256_context *)ctx, dest_buf);
100 #if defined(CONFIG_SHA384)
101 static int hash_init_sha384(struct hash_algo *algo, void **ctxp)
103 sha512_context *ctx = malloc(sizeof(sha512_context));
109 static int hash_update_sha384(struct hash_algo *algo, void *ctx,
110 const void *buf, unsigned int size, int is_last)
112 sha384_update((sha512_context *)ctx, buf, size);
116 static int hash_finish_sha384(struct hash_algo *algo, void *ctx, void
119 if (size < algo->digest_size)
122 sha384_finish((sha512_context *)ctx, dest_buf);
128 #if defined(CONFIG_SHA512)
129 static int hash_init_sha512(struct hash_algo *algo, void **ctxp)
131 sha512_context *ctx = malloc(sizeof(sha512_context));
137 static int hash_update_sha512(struct hash_algo *algo, void *ctx,
138 const void *buf, unsigned int size, int is_last)
140 sha512_update((sha512_context *)ctx, buf, size);
144 static int hash_finish_sha512(struct hash_algo *algo, void *ctx, void
147 if (size < algo->digest_size)
150 sha512_finish((sha512_context *)ctx, dest_buf);
157 static int hash_init_crc16_ccitt(struct hash_algo *algo, void **ctxp)
159 uint16_t *ctx = malloc(sizeof(uint16_t));
165 static int hash_update_crc16_ccitt(struct hash_algo *algo, void *ctx,
166 const void *buf, unsigned int size,
169 *((uint16_t *)ctx) = crc16_ccitt(*((uint16_t *)ctx), buf, size);
173 static int hash_finish_crc16_ccitt(struct hash_algo *algo, void *ctx,
174 void *dest_buf, int size)
176 if (size < algo->digest_size)
179 *((uint16_t *)dest_buf) = *((uint16_t *)ctx);
184 static int hash_init_crc32(struct hash_algo *algo, void **ctxp)
186 uint32_t *ctx = malloc(sizeof(uint32_t));
192 static int hash_update_crc32(struct hash_algo *algo, void *ctx,
193 const void *buf, unsigned int size, int is_last)
195 *((uint32_t *)ctx) = crc32(*((uint32_t *)ctx), buf, size);
199 static int hash_finish_crc32(struct hash_algo *algo, void *ctx, void *dest_buf,
202 if (size < algo->digest_size)
205 *((uint32_t *)dest_buf) = *((uint32_t *)ctx);
211 * These are the hash algorithms we support. If we have hardware acceleration
212 * is enable we will use that, otherwise a software version of the algorithm.
213 * Note that algorithm names must be in lower case.
215 static struct hash_algo hash_algo[] = {
219 .digest_size = SHA1_SUM_LEN,
220 .chunk_size = CHUNKSZ_SHA1,
221 #ifdef CONFIG_SHA_HW_ACCEL
222 .hash_func_ws = hw_sha1,
224 .hash_func_ws = sha1_csum_wd,
226 #ifdef CONFIG_SHA_PROG_HW_ACCEL
227 .hash_init = hw_sha_init,
228 .hash_update = hw_sha_update,
229 .hash_finish = hw_sha_finish,
231 .hash_init = hash_init_sha1,
232 .hash_update = hash_update_sha1,
233 .hash_finish = hash_finish_sha1,
240 .digest_size = SHA256_SUM_LEN,
241 .chunk_size = CHUNKSZ_SHA256,
242 #ifdef CONFIG_SHA_HW_ACCEL
243 .hash_func_ws = hw_sha256,
245 .hash_func_ws = sha256_csum_wd,
247 #ifdef CONFIG_SHA_PROG_HW_ACCEL
248 .hash_init = hw_sha_init,
249 .hash_update = hw_sha_update,
250 .hash_finish = hw_sha_finish,
252 .hash_init = hash_init_sha256,
253 .hash_update = hash_update_sha256,
254 .hash_finish = hash_finish_sha256,
261 .digest_size = SHA384_SUM_LEN,
262 .chunk_size = CHUNKSZ_SHA384,
263 .hash_func_ws = sha384_csum_wd,
264 .hash_init = hash_init_sha384,
265 .hash_update = hash_update_sha384,
266 .hash_finish = hash_finish_sha384,
272 .digest_size = SHA512_SUM_LEN,
273 .chunk_size = CHUNKSZ_SHA512,
274 .hash_func_ws = sha512_csum_wd,
275 .hash_init = hash_init_sha512,
276 .hash_update = hash_update_sha512,
277 .hash_finish = hash_finish_sha512,
281 .name = "crc16-ccitt",
283 .chunk_size = CHUNKSZ,
284 .hash_func_ws = crc16_ccitt_wd_buf,
285 .hash_init = hash_init_crc16_ccitt,
286 .hash_update = hash_update_crc16_ccitt,
287 .hash_finish = hash_finish_crc16_ccitt,
292 .chunk_size = CHUNKSZ_CRC32,
293 .hash_func_ws = crc32_wd_buf,
294 .hash_init = hash_init_crc32,
295 .hash_update = hash_update_crc32,
296 .hash_finish = hash_finish_crc32,
300 /* Try to minimize code size for boards that don't want much hashing */
301 #if defined(CONFIG_SHA256) || defined(CONFIG_CMD_SHA1SUM) || \
302 defined(CONFIG_CRC32_VERIFY) || defined(CONFIG_CMD_HASH) || \
303 defined(CONFIG_SHA384) || defined(CONFIG_SHA512)
304 #define multi_hash() 1
306 #define multi_hash() 0
309 static void reloc_update(void)
311 #if !defined(USE_HOSTCC) && defined(CONFIG_NEEDS_MANUAL_RELOC)
317 for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
318 hash_algo[i].name += gd->reloc_off;
319 hash_algo[i].hash_func_ws += gd->reloc_off;
320 hash_algo[i].hash_init += gd->reloc_off;
321 hash_algo[i].hash_update += gd->reloc_off;
322 hash_algo[i].hash_finish += gd->reloc_off;
328 int hash_lookup_algo(const char *algo_name, struct hash_algo **algop)
334 for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
335 if (!strcmp(algo_name, hash_algo[i].name)) {
336 *algop = &hash_algo[i];
341 debug("Unknown hash algorithm '%s'\n", algo_name);
342 return -EPROTONOSUPPORT;
345 int hash_progressive_lookup_algo(const char *algo_name,
346 struct hash_algo **algop)
352 for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
353 if (!strcmp(algo_name, hash_algo[i].name)) {
354 if (hash_algo[i].hash_init) {
355 *algop = &hash_algo[i];
361 debug("Unknown hash algorithm '%s'\n", algo_name);
362 return -EPROTONOSUPPORT;
366 int hash_parse_string(const char *algo_name, const char *str, uint8_t *result)
368 struct hash_algo *algo;
372 ret = hash_lookup_algo(algo_name, &algo);
376 for (i = 0; i < algo->digest_size; i++) {
379 strncpy(chr, &str[i * 2], 2);
380 result[i] = simple_strtoul(chr, NULL, 16);
386 int hash_block(const char *algo_name, const void *data, unsigned int len,
387 uint8_t *output, int *output_size)
389 struct hash_algo *algo;
392 ret = hash_lookup_algo(algo_name, &algo);
396 if (output_size && *output_size < algo->digest_size) {
397 debug("Output buffer size %d too small (need %d bytes)",
398 *output_size, algo->digest_size);
402 *output_size = algo->digest_size;
403 algo->hash_func_ws(data, len, output, algo->chunk_size);
408 #if defined(CONFIG_CMD_HASH) || defined(CONFIG_CMD_SHA1SUM) || defined(CONFIG_CMD_CRC32)
410 * store_result: Store the resulting sum to an address or variable
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
420 static void store_result(struct hash_algo *algo, const uint8_t *sum,
421 const char *dest, int allow_env_vars)
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.
432 if (allow_env_vars) {
440 char str_output[HASH_MAX_DIGEST_SIZE * 2 + 1];
441 char *str_ptr = str_output;
443 for (i = 0; i < algo->digest_size; i++) {
444 sprintf(str_ptr, "%02x", sum[i]);
448 env_set(dest, str_output);
453 addr = simple_strtoul(dest, NULL, 16);
454 buf = map_sysmem(addr, algo->digest_size);
455 memcpy(buf, sum, algo->digest_size);
461 * parse_verify_sum: Parse a hash verification parameter
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
476 static int parse_verify_sum(struct hash_algo *algo, char *verify_str,
477 uint8_t *vsum, int allow_env_vars)
481 /* See comment above in store_result() */
482 if (allow_env_vars) {
483 if (*verify_str == '*')
493 addr = simple_strtoul(verify_str, NULL, 16);
494 buf = map_sysmem(addr, algo->digest_size);
495 memcpy(vsum, buf, algo->digest_size);
498 int digits = algo->digest_size * 2;
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.
505 if (strlen(verify_str) == digits)
506 vsum_str = verify_str;
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",
516 hash_parse_string(algo->name, vsum_str, vsum);
521 static void hash_show(struct hash_algo *algo, ulong addr, ulong len, uint8_t *output)
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]);
530 int hash_command(const char *algo_name, int flags, struct cmd_tbl *cmdtp,
531 int flag, int argc, char *const argv[])
535 if ((argc < 2) || ((flags & HASH_FLAG_VERIFY) && (argc < 3)))
536 return CMD_RET_USAGE;
538 addr = simple_strtoul(*argv++, NULL, 16);
539 len = simple_strtoul(*argv++, NULL, 16);
542 struct hash_algo *algo;
544 uint8_t vsum[HASH_MAX_DIGEST_SIZE];
547 if (hash_lookup_algo(algo_name, &algo)) {
548 printf("Unknown hash algorithm '%s'\n", algo_name);
549 return CMD_RET_USAGE;
553 if (algo->digest_size > HASH_MAX_DIGEST_SIZE) {
554 puts("HASH_MAX_DIGEST_SIZE exceeded\n");
558 output = memalign(ARCH_DMA_MINALIGN,
559 sizeof(uint32_t) * HASH_MAX_DIGEST_SIZE);
561 buf = map_sysmem(addr, len);
562 algo->hash_func_ws(buf, len, output, algo->chunk_size);
565 /* Try to avoid code bloat when verify is not needed */
566 #if defined(CONFIG_CRC32_VERIFY) || defined(CONFIG_SHA1SUM_VERIFY) || \
567 defined(CONFIG_HASH_VERIFY)
568 if (flags & HASH_FLAG_VERIFY) {
572 if (parse_verify_sum(algo, *argv, vsum,
573 flags & HASH_FLAG_ENV)) {
574 printf("ERROR: %s does not contain a valid "
575 "%s sum\n", *argv, algo->name);
578 if (memcmp(output, vsum, algo->digest_size) != 0) {
581 hash_show(algo, addr, len, output);
583 for (i = 0; i < algo->digest_size; i++)
584 printf("%02x", vsum[i]);
585 puts(" ** ERROR **\n");
589 hash_show(algo, addr, len, output);
593 store_result(algo, output, *argv,
594 flags & HASH_FLAG_ENV);
596 unmap_sysmem(output);
600 /* Horrible code size hack for boards that just want crc32 */
605 crc = crc32_wd(0, (const uchar *)addr, len, CHUNKSZ_CRC32);
607 printf("CRC32 for %08lx ... %08lx ==> %08lx\n",
608 addr, addr + len - 1, crc);
611 ptr = (ulong *)simple_strtoul(argv[0], NULL, 16);
618 #endif /* CONFIG_CMD_HASH || CONFIG_CMD_SHA1SUM || CONFIG_CMD_CRC32) */
619 #endif /* !USE_HOSTCC */