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