hash.c 9.56 KB
Newer Older
Simon Glass's avatar
Simon Glass committed
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.
 *
10
 * SPDX-License-Identifier:	GPL-2.0+
Simon Glass's avatar
Simon Glass committed
11
12
13
14
 */

#include <common.h>
#include <command.h>
Hung-ying Tyan's avatar
Hung-ying Tyan committed
15
#include <malloc.h>
16
#include <hw_sha.h>
Simon Glass's avatar
Simon Glass committed
17
18
19
#include <hash.h>
#include <sha1.h>
#include <sha256.h>
20
#include <asm/io.h>
21
#include <asm/errno.h>
Simon Glass's avatar
Simon Glass committed
22

Hung-ying Tyan's avatar
Hung-ying Tyan committed
23
24
25
26
27
28
29
30
31
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
#ifdef CONFIG_CMD_SHA1SUM
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;
}

Simon Glass's avatar
Simon Glass committed
105
106
/*
 * These are the hash algorithms we support. Chips which support accelerated
107
108
 * crypto could perhaps add named version of these algorithms here. Note that
 * algorithm names must be in lower case.
Simon Glass's avatar
Simon Glass committed
109
110
 */
static struct hash_algo hash_algo[] = {
111
112
113
114
115
116
117
118
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,
	}, {
		"sha256",
		SHA256_SUM_LEN,
		hw_sha256,
		CHUNKSZ_SHA256,
	},
#endif
128
129
130
131
132
133
	/*
	 * This is CONFIG_CMD_SHA1SUM instead of CONFIG_SHA1 since otherwise
	 * it bloats the code for boards which use SHA1 but not the 'hash'
	 * or 'sha1sum' commands.
	 */
#ifdef CONFIG_CMD_SHA1SUM
Simon Glass's avatar
Simon Glass committed
134
	{
135
		"sha1",
Simon Glass's avatar
Simon Glass committed
136
137
138
		SHA1_SUM_LEN,
		sha1_csum_wd,
		CHUNKSZ_SHA1,
Hung-ying Tyan's avatar
Hung-ying Tyan committed
139
140
141
		hash_init_sha1,
		hash_update_sha1,
		hash_finish_sha1,
Simon Glass's avatar
Simon Glass committed
142
	},
143
#define MULTI_HASH
Simon Glass's avatar
Simon Glass committed
144
145
146
#endif
#ifdef CONFIG_SHA256
	{
147
		"sha256",
Simon Glass's avatar
Simon Glass committed
148
149
150
		SHA256_SUM_LEN,
		sha256_csum_wd,
		CHUNKSZ_SHA256,
Hung-ying Tyan's avatar
Hung-ying Tyan committed
151
152
153
		hash_init_sha256,
		hash_update_sha256,
		hash_finish_sha256,
Simon Glass's avatar
Simon Glass committed
154
	},
155
#define MULTI_HASH
Simon Glass's avatar
Simon Glass committed
156
#endif
157
	{
158
		"crc32",
159
160
161
		4,
		crc32_wd_buf,
		CHUNKSZ_CRC32,
Hung-ying Tyan's avatar
Hung-ying Tyan committed
162
163
164
		hash_init_crc32,
		hash_update_crc32,
		hash_finish_crc32,
165
	},
Simon Glass's avatar
Simon Glass committed
166
167
};

168
169
170
171
172
173
174
175
176
177
178
#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

Simon Glass's avatar
Simon Glass committed
179
180
181
182
183
184
/**
 * 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
185
186
187
188
 *			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
Simon Glass's avatar
Simon Glass committed
189
190
 */
static void store_result(struct hash_algo *algo, const u8 *sum,
191
			 const char *dest, int allow_env_vars)
Simon Glass's avatar
Simon Glass committed
192
193
{
	unsigned int i;
194
	int env_var = 0;
Simon Glass's avatar
Simon Glass committed
195

196
197
198
199
200
201
202
203
204
205
206
207
	/*
	 * 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;
	}
Simon Glass's avatar
Simon Glass committed
208

209
	if (env_var) {
Simon Glass's avatar
Simon Glass committed
210
211
212
213
214
215
216
		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;
		}
217
		*str_ptr = '\0';
Simon Glass's avatar
Simon Glass committed
218
		setenv(dest, str_output);
219
	} else {
220
221
		ulong addr;
		void *buf;
222

223
224
225
226
		addr = simple_strtoul(dest, NULL, 16);
		buf = map_sysmem(addr, algo->digest_size);
		memcpy(buf, sum, algo->digest_size);
		unmap_sysmem(buf);
Simon Glass's avatar
Simon Glass committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
	}
}

/**
 * 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)
241
242
243
 * @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.
Simon Glass's avatar
Simon Glass committed
244
245
 * @return 0 if ok, non-zero on error
 */
246
247
static int parse_verify_sum(struct hash_algo *algo, char *verify_str, u8 *vsum,
			    int allow_env_vars)
Simon Glass's avatar
Simon Glass committed
248
{
249
250
251
252
253
254
255
256
257
258
259
	int env_var = 0;

	/* See comment above in store_result() */
	if (allow_env_vars) {
		if (*verify_str == '*')
			verify_str++;
		else
			env_var = 1;
	}

	if (env_var) {
260
261
		ulong addr;
		void *buf;
Simon Glass's avatar
Simon Glass committed
262

263
264
265
		addr = simple_strtoul(verify_str, NULL, 16);
		buf = map_sysmem(addr, algo->digest_size);
		memcpy(vsum, buf, algo->digest_size);
Simon Glass's avatar
Simon Glass committed
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
	} else {
		unsigned int i;
		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\n",
				       digits);
				return 1;
			}
		}

		for (i = 0; i < algo->digest_size; i++) {
			char *nullp = vsum_str + (i + 1) * 2;
			char end = *nullp;

			*nullp = '\0';
			vsum[i] = simple_strtoul(vsum_str + (i * 2), NULL, 16);
			*nullp = end;
		}
	}
	return 0;
}

Hung-ying Tyan's avatar
Hung-ying Tyan committed
299
int hash_lookup_algo(const char *algo_name, struct hash_algo **algop)
Simon Glass's avatar
Simon Glass committed
300
301
302
303
{
	int i;

	for (i = 0; i < ARRAY_SIZE(hash_algo); i++) {
Hung-ying Tyan's avatar
Hung-ying Tyan committed
304
305
306
307
		if (!strcmp(algo_name, hash_algo[i].name)) {
			*algop = &hash_algo[i];
			return 0;
		}
Simon Glass's avatar
Simon Glass committed
308
309
	}

Hung-ying Tyan's avatar
Hung-ying Tyan committed
310
311
	debug("Unknown hash algorithm '%s'\n", algo_name);
	return -EPROTONOSUPPORT;
Simon Glass's avatar
Simon Glass committed
312
313
}

314
void hash_show(struct hash_algo *algo, ulong addr, ulong len, u8 *output)
Simon Glass's avatar
Simon Glass committed
315
316
317
318
319
320
321
322
{
	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]);
}

323
324
325
326
int hash_block(const char *algo_name, const void *data, unsigned int len,
	       uint8_t *output, int *output_size)
{
	struct hash_algo *algo;
Hung-ying Tyan's avatar
Hung-ying Tyan committed
327
328
329
330
331
	int ret;

	ret = hash_lookup_algo(algo_name, &algo);
	if (ret)
		return ret;
332
333
334
335
336
337
338
339
340
341
342
343
344

	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;
}

345
int hash_command(const char *algo_name, int flags, cmd_tbl_t *cmdtp, int flag,
Simon Glass's avatar
Simon Glass committed
346
347
348
349
350
351
352
		 int argc, char * const argv[])
{
	ulong addr, len;

	if (argc < 2)
		return CMD_RET_USAGE;

353
354
355
	addr = simple_strtoul(*argv++, NULL, 16);
	len = simple_strtoul(*argv++, NULL, 16);

356
357
358
359
	if (multi_hash()) {
		struct hash_algo *algo;
		u8 output[HASH_MAX_DIGEST_SIZE];
		u8 vsum[HASH_MAX_DIGEST_SIZE];
360
		void *buf;
Simon Glass's avatar
Simon Glass committed
361

Hung-ying Tyan's avatar
Hung-ying Tyan committed
362
		if (hash_lookup_algo(algo_name, &algo)) {
363
364
365
366
367
368
369
370
371
			printf("Unknown hash algorithm '%s'\n", algo_name);
			return CMD_RET_USAGE;
		}
		argc -= 2;

		if (algo->digest_size > HASH_MAX_DIGEST_SIZE) {
			puts("HASH_MAX_DIGEST_SIZE exceeded\n");
			return 1;
		}
Simon Glass's avatar
Simon Glass committed
372

373
374
375
		buf = map_sysmem(addr, len);
		algo->hash_func_ws(buf, len, output, algo->chunk_size);
		unmap_sysmem(buf);
Simon Glass's avatar
Simon Glass committed
376

377
		/* Try to avoid code bloat when verify is not needed */
Simon Glass's avatar
Simon Glass committed
378
#ifdef CONFIG_HASH_VERIFY
379
		if (flags & HASH_FLAG_VERIFY) {
Simon Glass's avatar
Simon Glass committed
380
#else
381
		if (0) {
Simon Glass's avatar
Simon Glass committed
382
#endif
383
384
385
			if (!argc)
				return CMD_RET_USAGE;
			if (parse_verify_sum(algo, *argv, vsum,
386
					flags & HASH_FLAG_ENV)) {
387
388
389
390
391
392
				printf("ERROR: %s does not contain a valid "
					"%s sum\n", *argv, algo->name);
				return 1;
			}
			if (memcmp(output, vsum, algo->digest_size) != 0) {
				int i;
Simon Glass's avatar
Simon Glass committed
393

394
				hash_show(algo, addr, len, output);
395
396
397
398
399
400
401
				printf(" != ");
				for (i = 0; i < algo->digest_size; i++)
					printf("%02x", vsum[i]);
				puts(" ** ERROR **\n");
				return 1;
			}
		} else {
402
			hash_show(algo, addr, len, output);
403
404
405
406
407
408
			printf("\n");

			if (argc) {
				store_result(algo, output, *argv,
					flags & HASH_FLAG_ENV);
			}
Simon Glass's avatar
Simon Glass committed
409
		}
410
411

	/* Horrible code size hack for boards that just want crc32 */
Simon Glass's avatar
Simon Glass committed
412
	} else {
413
414
415
416
417
418
419
		ulong crc;
		ulong *ptr;

		crc = crc32_wd(0, (const uchar *)addr, len, CHUNKSZ_CRC32);

		printf("CRC32 for %08lx ... %08lx ==> %08lx\n",
				addr, addr + len - 1, crc);
Simon Glass's avatar
Simon Glass committed
420

421
422
		if (argc >= 3) {
			ptr = (ulong *)simple_strtoul(argv[0], NULL, 16);
423
			*ptr = crc;
424
		}
Simon Glass's avatar
Simon Glass committed
425
426
427
428
	}

	return 0;
}