Blame view

common/hash.c 10.5 KB
460408ef9   Simon Glass   Add generic hash API
1
2
3
4
5
6
7
8
9
  /*
   * Copyright (c) 2012 The Chromium OS Authors.
   *
   * (C) Copyright 2011
   * Joe Hershberger, National Instruments, joe.hershberger@ni.com
   *
   * (C) Copyright 2000
   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *
1a4596601   Wolfgang Denk   Add GPL-2.0+ SPDX...
10
   * SPDX-License-Identifier:	GPL-2.0+
460408ef9   Simon Glass   Add generic hash API
11
   */
2dd900271   Ruchika Gupta   Use hash.c in mki...
12
  #ifndef USE_HOSTCC
460408ef9   Simon Glass   Add generic hash API
13
14
  #include <common.h>
  #include <command.h>
bf007ebb6   Hung-ying Tyan   gen: Add progress...
15
  #include <malloc.h>
0eb25b619   Joe Hershberger   common: Make sure...
16
  #include <mapmem.h>
1f9c92808   Akshay Saraswat   gen: Add sha h/w ...
17
  #include <hw_sha.h>
2dd900271   Ruchika Gupta   Use hash.c in mki...
18
  #include <asm/io.h>
1221ce459   Masahiro Yamada   treewide: replace...
19
  #include <linux/errno.h>
2dd900271   Ruchika Gupta   Use hash.c in mki...
20
21
22
23
24
  #else
  #include "mkimage.h"
  #include <time.h>
  #include <image.h>
  #endif /* !USE_HOSTCC*/
460408ef9   Simon Glass   Add generic hash API
25
  #include <hash.h>
2dd900271   Ruchika Gupta   Use hash.c in mki...
26
  #include <u-boot/crc.h>
2b9912e6a   Jeroen Hofstee   includes: move op...
27
28
  #include <u-boot/sha1.h>
  #include <u-boot/sha256.h>
2dd900271   Ruchika Gupta   Use hash.c in mki...
29
  #include <u-boot/md5.h>
460408ef9   Simon Glass   Add generic hash API
30

46fe2c044   Ruchika Gupta   hash: Add functio...
31
  #ifdef CONFIG_SHA1
bf007ebb6   Hung-ying Tyan   gen: Add progress...
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  static int hash_init_sha1(struct hash_algo *algo, void **ctxp)
  {
  	sha1_context *ctx = malloc(sizeof(sha1_context));
  	sha1_starts(ctx);
  	*ctxp = ctx;
  	return 0;
  }
  
  static int hash_update_sha1(struct hash_algo *algo, void *ctx, const void *buf,
  			    unsigned int size, int is_last)
  {
  	sha1_update((sha1_context *)ctx, buf, size);
  	return 0;
  }
  
  static int hash_finish_sha1(struct hash_algo *algo, void *ctx, void *dest_buf,
  			    int size)
  {
  	if (size < algo->digest_size)
  		return -1;
  
  	sha1_finish((sha1_context *)ctx, dest_buf);
  	free(ctx);
  	return 0;
  }
  #endif
  
  #ifdef CONFIG_SHA256
  static int hash_init_sha256(struct hash_algo *algo, void **ctxp)
  {
  	sha256_context *ctx = malloc(sizeof(sha256_context));
  	sha256_starts(ctx);
  	*ctxp = ctx;
  	return 0;
  }
  
  static int hash_update_sha256(struct hash_algo *algo, void *ctx,
  			      const void *buf, unsigned int size, int is_last)
  {
  	sha256_update((sha256_context *)ctx, buf, size);
  	return 0;
  }
  
  static int hash_finish_sha256(struct hash_algo *algo, void *ctx, void
  			      *dest_buf, int size)
  {
  	if (size < algo->digest_size)
  		return -1;
  
  	sha256_finish((sha256_context *)ctx, dest_buf);
  	free(ctx);
  	return 0;
  }
  #endif
  
  static int hash_init_crc32(struct hash_algo *algo, void **ctxp)
  {
  	uint32_t *ctx = malloc(sizeof(uint32_t));
  	*ctx = 0;
  	*ctxp = ctx;
  	return 0;
  }
  
  static int hash_update_crc32(struct hash_algo *algo, void *ctx,
  			     const void *buf, unsigned int size, int is_last)
  {
  	*((uint32_t *)ctx) = crc32(*((uint32_t *)ctx), buf, size);
  	return 0;
  }
  
  static int hash_finish_crc32(struct hash_algo *algo, void *ctx, void *dest_buf,
  			     int size)
  {
  	if (size < algo->digest_size)
  		return -1;
  
  	*((uint32_t *)dest_buf) = *((uint32_t *)ctx);
  	free(ctx);
  	return 0;
  }
460408ef9   Simon Glass   Add generic hash API
112
113
  /*
   * These are the hash algorithms we support. Chips which support accelerated
218da0f35   Simon Glass   hash: Use lower c...
114
115
   * crypto could perhaps add named version of these algorithms here. Note that
   * algorithm names must be in lower case.
460408ef9   Simon Glass   Add generic hash API
116
117
   */
  static struct hash_algo hash_algo[] = {
d20a40de9   Simon Glass   Roll crc32 into h...
118
  	/*
1f9c92808   Akshay Saraswat   gen: Add sha h/w ...
119
120
121
122
123
124
125
126
127
  	 * CONFIG_SHA_HW_ACCEL is defined if hardware acceleration is
  	 * available.
  	 */
  #ifdef CONFIG_SHA_HW_ACCEL
  	{
  		"sha1",
  		SHA1_SUM_LEN,
  		hw_sha1,
  		CHUNKSZ_SHA1,
94e3c8c4f   gaurav rana   crypto/fsl - Add ...
128
129
130
131
132
  #ifdef CONFIG_SHA_PROG_HW_ACCEL
  		hw_sha_init,
  		hw_sha_update,
  		hw_sha_finish,
  #endif
1f9c92808   Akshay Saraswat   gen: Add sha h/w ...
133
134
135
136
137
  	}, {
  		"sha256",
  		SHA256_SUM_LEN,
  		hw_sha256,
  		CHUNKSZ_SHA256,
94e3c8c4f   gaurav rana   crypto/fsl - Add ...
138
139
140
141
142
  #ifdef CONFIG_SHA_PROG_HW_ACCEL
  		hw_sha_init,
  		hw_sha_update,
  		hw_sha_finish,
  #endif
1f9c92808   Akshay Saraswat   gen: Add sha h/w ...
143
144
  	},
  #endif
46fe2c044   Ruchika Gupta   hash: Add functio...
145
  #ifdef CONFIG_SHA1
460408ef9   Simon Glass   Add generic hash API
146
  	{
218da0f35   Simon Glass   hash: Use lower c...
147
  		"sha1",
460408ef9   Simon Glass   Add generic hash API
148
149
150
  		SHA1_SUM_LEN,
  		sha1_csum_wd,
  		CHUNKSZ_SHA1,
bf007ebb6   Hung-ying Tyan   gen: Add progress...
151
152
153
  		hash_init_sha1,
  		hash_update_sha1,
  		hash_finish_sha1,
460408ef9   Simon Glass   Add generic hash API
154
155
156
157
  	},
  #endif
  #ifdef CONFIG_SHA256
  	{
218da0f35   Simon Glass   hash: Use lower c...
158
  		"sha256",
460408ef9   Simon Glass   Add generic hash API
159
160
161
  		SHA256_SUM_LEN,
  		sha256_csum_wd,
  		CHUNKSZ_SHA256,
bf007ebb6   Hung-ying Tyan   gen: Add progress...
162
163
164
  		hash_init_sha256,
  		hash_update_sha256,
  		hash_finish_sha256,
460408ef9   Simon Glass   Add generic hash API
165
166
  	},
  #endif
d20a40de9   Simon Glass   Roll crc32 into h...
167
  	{
218da0f35   Simon Glass   hash: Use lower c...
168
  		"crc32",
d20a40de9   Simon Glass   Roll crc32 into h...
169
170
171
  		4,
  		crc32_wd_buf,
  		CHUNKSZ_CRC32,
bf007ebb6   Hung-ying Tyan   gen: Add progress...
172
173
174
  		hash_init_crc32,
  		hash_update_crc32,
  		hash_finish_crc32,
d20a40de9   Simon Glass   Roll crc32 into h...
175
  	},
460408ef9   Simon Glass   Add generic hash API
176
  };
46fe2c044   Ruchika Gupta   hash: Add functio...
177
178
179
  #if defined(CONFIG_SHA256) || defined(CONFIG_CMD_SHA1SUM)
  #define MULTI_HASH
  #endif
d20a40de9   Simon Glass   Roll crc32 into h...
180
181
182
183
184
185
186
187
188
189
  #if defined(CONFIG_HASH_VERIFY) || defined(CONFIG_CMD_HASH)
  #define MULTI_HASH
  #endif
  
  /* Try to minimize code size for boards that don't want much hashing */
  #ifdef MULTI_HASH
  #define multi_hash()	1
  #else
  #define multi_hash()	0
  #endif
2dd900271   Ruchika Gupta   Use hash.c in mki...
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
  int hash_lookup_algo(const char *algo_name, struct hash_algo **algop)
  {
  	int i;
  
  	for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
  		if (!strcmp(algo_name, hash_algo[i].name)) {
  			*algop = &hash_algo[i];
  			return 0;
  		}
  	}
  
  	debug("Unknown hash algorithm '%s'
  ", algo_name);
  	return -EPROTONOSUPPORT;
  }
  
  int hash_progressive_lookup_algo(const char *algo_name,
  				 struct hash_algo **algop)
  {
  	int i;
  
  	for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
  		if (!strcmp(algo_name, hash_algo[i].name)) {
  			if (hash_algo[i].hash_init) {
  				*algop = &hash_algo[i];
  				return 0;
  			}
  		}
  	}
  
  	debug("Unknown hash algorithm '%s'
  ", algo_name);
  	return -EPROTONOSUPPORT;
  }
  
  #ifndef USE_HOSTCC
8f0b1e24e   Stefan Roese   autoboot.c: Add f...
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  int hash_parse_string(const char *algo_name, const char *str, uint8_t *result)
  {
  	struct hash_algo *algo;
  	int ret;
  	int i;
  
  	ret = hash_lookup_algo(algo_name, &algo);
  	if (ret)
  		return ret;
  
  	for (i = 0; i < algo->digest_size; i++) {
  		char chr[3];
  
  		strncpy(chr, &str[i * 2], 2);
  		result[i] = simple_strtoul(chr, NULL, 16);
  	}
  
  	return 0;
  }
48ad68deb   Tom Rini   hash.c: Condition...
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
  int hash_block(const char *algo_name, const void *data, unsigned int len,
  	       uint8_t *output, int *output_size)
  {
  	struct hash_algo *algo;
  	int ret;
  
  	ret = hash_lookup_algo(algo_name, &algo);
  	if (ret)
  		return ret;
  
  	if (output_size && *output_size < algo->digest_size) {
  		debug("Output buffer size %d too small (need %d bytes)",
  		      *output_size, algo->digest_size);
  		return -ENOSPC;
  	}
  	if (output_size)
  		*output_size = algo->digest_size;
  	algo->hash_func_ws(data, len, output, algo->chunk_size);
  
  	return 0;
  }
  
  #if defined(CONFIG_CMD_HASH) || defined(CONFIG_CMD_SHA1SUM) || defined(CONFIG_CMD_CRC32)
460408ef9   Simon Glass   Add generic hash API
268
269
270
271
272
273
  /**
   * store_result: Store the resulting sum to an address or variable
   *
   * @algo:		Hash algorithm being used
   * @sum:		Hash digest (algo->digest_size bytes)
   * @dest:		Destination, interpreted as a hex address if it starts
d5b76673a   Simon Glass   hash: Add a flag ...
274
275
276
277
   *			with * (or allow_env_vars is 0) or otherwise as an
   *			environment variable.
   * @allow_env_vars:	non-zero to permit storing the result to an
   *			variable environment
460408ef9   Simon Glass   Add generic hash API
278
   */
04819a4ff   Simon Glass   hash: Use uint8_t...
279
  static void store_result(struct hash_algo *algo, const uint8_t *sum,
d5b76673a   Simon Glass   hash: Add a flag ...
280
  			 const char *dest, int allow_env_vars)
460408ef9   Simon Glass   Add generic hash API
281
282
  {
  	unsigned int i;
d5b76673a   Simon Glass   hash: Add a flag ...
283
  	int env_var = 0;
460408ef9   Simon Glass   Add generic hash API
284

d5b76673a   Simon Glass   hash: Add a flag ...
285
286
287
288
289
290
291
292
293
294
295
296
  	/*
  	 * If environment variables are allowed, then we assume that 'dest'
  	 * is an environment variable, unless it starts with *, in which
  	 * case we assume it is an address. If not allowed, it is always an
  	 * address. This is to support the crc32 command.
  	 */
  	if (allow_env_vars) {
  		if (*dest == '*')
  			dest++;
  		else
  			env_var = 1;
  	}
460408ef9   Simon Glass   Add generic hash API
297

d5b76673a   Simon Glass   hash: Add a flag ...
298
  	if (env_var) {
460408ef9   Simon Glass   Add generic hash API
299
300
301
302
303
304
305
  		char str_output[HASH_MAX_DIGEST_SIZE * 2 + 1];
  		char *str_ptr = str_output;
  
  		for (i = 0; i < algo->digest_size; i++) {
  			sprintf(str_ptr, "%02x", sum[i]);
  			str_ptr += 2;
  		}
8b9cc866c   Jeroen Hofstee   common: hash: zer...
306
  		*str_ptr = '\0';
460408ef9   Simon Glass   Add generic hash API
307
  		setenv(dest, str_output);
d5b76673a   Simon Glass   hash: Add a flag ...
308
  	} else {
bd091b67d   Simon Glass   sandbox: Allow ha...
309
310
  		ulong addr;
  		void *buf;
d5b76673a   Simon Glass   hash: Add a flag ...
311

bd091b67d   Simon Glass   sandbox: Allow ha...
312
313
314
315
  		addr = simple_strtoul(dest, NULL, 16);
  		buf = map_sysmem(addr, algo->digest_size);
  		memcpy(buf, sum, algo->digest_size);
  		unmap_sysmem(buf);
460408ef9   Simon Glass   Add generic hash API
316
317
318
319
320
321
322
323
324
325
326
327
328
329
  	}
  }
  
  /**
   * parse_verify_sum: Parse a hash verification parameter
   *
   * @algo:		Hash algorithm being used
   * @verify_str:		Argument to parse. If it starts with * then it is
   *			interpreted as a hex address containing the hash.
   *			If the length is exactly the right number of hex digits
   *			for the digest size, then we assume it is a hex digest.
   *			Otherwise we assume it is an environment variable, and
   *			look up its value (it must contain a hex digest).
   * @vsum:		Returns binary digest value (algo->digest_size bytes)
d5b76673a   Simon Glass   hash: Add a flag ...
330
331
332
   * @allow_env_vars:	non-zero to permit storing the result to an environment
   *			variable. If 0 then verify_str is assumed to be an
   *			address, and the * prefix is not expected.
460408ef9   Simon Glass   Add generic hash API
333
334
   * @return 0 if ok, non-zero on error
   */
04819a4ff   Simon Glass   hash: Use uint8_t...
335
336
  static int parse_verify_sum(struct hash_algo *algo, char *verify_str,
  			    uint8_t *vsum, int allow_env_vars)
460408ef9   Simon Glass   Add generic hash API
337
  {
d5b76673a   Simon Glass   hash: Add a flag ...
338
339
340
341
342
343
344
345
346
  	int env_var = 0;
  
  	/* See comment above in store_result() */
  	if (allow_env_vars) {
  		if (*verify_str == '*')
  			verify_str++;
  		else
  			env_var = 1;
  	}
3ef46a998   Nikolay Dimitrov   Fix hash verifica...
347
  	if (!env_var) {
bd091b67d   Simon Glass   sandbox: Allow ha...
348
349
  		ulong addr;
  		void *buf;
460408ef9   Simon Glass   Add generic hash API
350

bd091b67d   Simon Glass   sandbox: Allow ha...
351
352
353
  		addr = simple_strtoul(verify_str, NULL, 16);
  		buf = map_sysmem(addr, algo->digest_size);
  		memcpy(vsum, buf, algo->digest_size);
460408ef9   Simon Glass   Add generic hash API
354
  	} else {
460408ef9   Simon Glass   Add generic hash API
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  		char *vsum_str;
  		int digits = algo->digest_size * 2;
  
  		/*
  		 * As with the original code from sha1sum.c, we assume that a
  		 * string which matches the digest size exactly is a hex
  		 * string and not an environment variable.
  		 */
  		if (strlen(verify_str) == digits)
  			vsum_str = verify_str;
  		else {
  			vsum_str = getenv(verify_str);
  			if (vsum_str == NULL || strlen(vsum_str) != digits) {
  				printf("Expected %d hex digits in env var
  ",
  				       digits);
  				return 1;
  			}
  		}
8f0b1e24e   Stefan Roese   autoboot.c: Add f...
374
  		hash_parse_string(algo->name, vsum_str, vsum);
460408ef9   Simon Glass   Add generic hash API
375
376
377
  	}
  	return 0;
  }
48ad68deb   Tom Rini   hash.c: Condition...
378
  static void hash_show(struct hash_algo *algo, ulong addr, ulong len, uint8_t *output)
460408ef9   Simon Glass   Add generic hash API
379
380
381
382
383
384
385
  {
  	int i;
  
  	printf("%s for %08lx ... %08lx ==> ", algo->name, addr, addr + len - 1);
  	for (i = 0; i < algo->digest_size; i++)
  		printf("%02x", output[i]);
  }
d5b76673a   Simon Glass   hash: Add a flag ...
386
  int hash_command(const char *algo_name, int flags, cmd_tbl_t *cmdtp, int flag,
460408ef9   Simon Glass   Add generic hash API
387
388
  		 int argc, char * const argv[])
  {
460408ef9   Simon Glass   Add generic hash API
389
  	ulong addr, len;
460408ef9   Simon Glass   Add generic hash API
390

3ef46a998   Nikolay Dimitrov   Fix hash verifica...
391
  	if ((argc < 2) || ((flags & HASH_FLAG_VERIFY) && (argc < 3)))
460408ef9   Simon Glass   Add generic hash API
392
  		return CMD_RET_USAGE;
d5b76673a   Simon Glass   hash: Add a flag ...
393
394
  	addr = simple_strtoul(*argv++, NULL, 16);
  	len = simple_strtoul(*argv++, NULL, 16);
d20a40de9   Simon Glass   Roll crc32 into h...
395
396
  	if (multi_hash()) {
  		struct hash_algo *algo;
04819a4ff   Simon Glass   hash: Use uint8_t...
397
398
  		uint8_t output[HASH_MAX_DIGEST_SIZE];
  		uint8_t vsum[HASH_MAX_DIGEST_SIZE];
bd091b67d   Simon Glass   sandbox: Allow ha...
399
  		void *buf;
460408ef9   Simon Glass   Add generic hash API
400

bf007ebb6   Hung-ying Tyan   gen: Add progress...
401
  		if (hash_lookup_algo(algo_name, &algo)) {
d20a40de9   Simon Glass   Roll crc32 into h...
402
403
404
405
406
407
408
409
410
411
412
  			printf("Unknown hash algorithm '%s'
  ", algo_name);
  			return CMD_RET_USAGE;
  		}
  		argc -= 2;
  
  		if (algo->digest_size > HASH_MAX_DIGEST_SIZE) {
  			puts("HASH_MAX_DIGEST_SIZE exceeded
  ");
  			return 1;
  		}
460408ef9   Simon Glass   Add generic hash API
413

bd091b67d   Simon Glass   sandbox: Allow ha...
414
415
416
  		buf = map_sysmem(addr, len);
  		algo->hash_func_ws(buf, len, output, algo->chunk_size);
  		unmap_sysmem(buf);
460408ef9   Simon Glass   Add generic hash API
417

d20a40de9   Simon Glass   Roll crc32 into h...
418
  		/* Try to avoid code bloat when verify is not needed */
460408ef9   Simon Glass   Add generic hash API
419
  #ifdef CONFIG_HASH_VERIFY
d20a40de9   Simon Glass   Roll crc32 into h...
420
  		if (flags & HASH_FLAG_VERIFY) {
460408ef9   Simon Glass   Add generic hash API
421
  #else
d20a40de9   Simon Glass   Roll crc32 into h...
422
  		if (0) {
460408ef9   Simon Glass   Add generic hash API
423
  #endif
d20a40de9   Simon Glass   Roll crc32 into h...
424
  			if (parse_verify_sum(algo, *argv, vsum,
d5b76673a   Simon Glass   hash: Add a flag ...
425
  					flags & HASH_FLAG_ENV)) {
d20a40de9   Simon Glass   Roll crc32 into h...
426
427
428
429
430
431
432
  				printf("ERROR: %s does not contain a valid "
  					"%s sum
  ", *argv, algo->name);
  				return 1;
  			}
  			if (memcmp(output, vsum, algo->digest_size) != 0) {
  				int i;
460408ef9   Simon Glass   Add generic hash API
433

31890ae29   Simon Glass   hash: Export the ...
434
  				hash_show(algo, addr, len, output);
d20a40de9   Simon Glass   Roll crc32 into h...
435
436
437
438
439
440
441
442
  				printf(" != ");
  				for (i = 0; i < algo->digest_size; i++)
  					printf("%02x", vsum[i]);
  				puts(" ** ERROR **
  ");
  				return 1;
  			}
  		} else {
31890ae29   Simon Glass   hash: Export the ...
443
  			hash_show(algo, addr, len, output);
d20a40de9   Simon Glass   Roll crc32 into h...
444
445
446
447
448
449
450
  			printf("
  ");
  
  			if (argc) {
  				store_result(algo, output, *argv,
  					flags & HASH_FLAG_ENV);
  			}
460408ef9   Simon Glass   Add generic hash API
451
  		}
d20a40de9   Simon Glass   Roll crc32 into h...
452
453
  
  	/* Horrible code size hack for boards that just want crc32 */
460408ef9   Simon Glass   Add generic hash API
454
  	} else {
d20a40de9   Simon Glass   Roll crc32 into h...
455
456
457
458
459
460
461
462
  		ulong crc;
  		ulong *ptr;
  
  		crc = crc32_wd(0, (const uchar *)addr, len, CHUNKSZ_CRC32);
  
  		printf("CRC32 for %08lx ... %08lx ==> %08lx
  ",
  				addr, addr + len - 1, crc);
460408ef9   Simon Glass   Add generic hash API
463

4b756b013   Tom Rini   hash.c: Correct n...
464
465
  		if (argc >= 3) {
  			ptr = (ulong *)simple_strtoul(argv[0], NULL, 16);
d20a40de9   Simon Glass   Roll crc32 into h...
466
  			*ptr = crc;
d5b76673a   Simon Glass   hash: Add a flag ...
467
  		}
460408ef9   Simon Glass   Add generic hash API
468
469
470
471
  	}
  
  	return 0;
  }
2dd900271   Ruchika Gupta   Use hash.c in mki...
472
  #endif
48ad68deb   Tom Rini   hash.c: Condition...
473
  #endif