blob: dc21678045e8df71eb30fbb01d72a28c8c92e17e [file] [log] [blame]
Simon Glass460408e2012-12-05 14:46:36 +00001/*
2 * Copyright (c) 2012 The Chromium OS Authors.
Wolfgang Denk1a459662013-07-08 09:37:19 +02003 * SPDX-License-Identifier: GPL-2.0+
Simon Glass460408e2012-12-05 14:46:36 +00004 */
5
6#ifndef _HASH_H
7#define _HASH_H
8
Simon Glassd20a40d2013-02-24 20:30:22 +00009#if defined(CONFIG_SHA1SUM_VERIFY) || defined(CONFIG_CRC32_VERIFY)
Simon Glass460408e2012-12-05 14:46:36 +000010#define CONFIG_HASH_VERIFY
11#endif
12
13struct hash_algo {
14 const char *name; /* Name of algorithm */
15 int digest_size; /* Length of digest */
16 /**
17 * hash_func_ws: Generic hashing function
18 *
19 * This is the generic prototype for a hashing function. We only
20 * have the watchdog version at present.
21 *
22 * @input: Input buffer
23 * @ilen: Input buffer length
24 * @output: Checksum result (length depends on algorithm)
25 * @chunk_sz: Trigger watchdog after processing this many bytes
26 */
27 void (*hash_func_ws)(const unsigned char *input, unsigned int ilen,
28 unsigned char *output, unsigned int chunk_sz);
29 int chunk_size; /* Watchdog chunk size */
Hung-ying Tyanbf007eb2014-03-03 12:19:28 +010030 /*
31 * hash_init: Create the context for progressive hashing
32 *
33 * @algo: Pointer to the hash_algo struct
34 * @ctxp: Pointer to the pointer of the context for hashing
35 * @return 0 if ok, -1 on error
36 */
37 int (*hash_init)(struct hash_algo *algo, void **ctxp);
38 /*
39 * hash_update: Perform hashing on the given buffer
40 *
41 * The context is freed by this function if an error occurs.
42 *
43 * @algo: Pointer to the hash_algo struct
44 * @ctx: Pointer to the context for hashing
45 * @buf: Pointer to the buffer being hashed
46 * @size: Size of the buffer being hashed
47 * @is_last: 1 if this is the last update; 0 otherwise
48 * @return 0 if ok, -1 on error
49 */
50 int (*hash_update)(struct hash_algo *algo, void *ctx, const void *buf,
51 unsigned int size, int is_last);
52 /*
53 * hash_finish: Write the hash result to the given buffer
54 *
55 * The context is freed by this function.
56 *
57 * @algo: Pointer to the hash_algo struct
58 * @ctx: Pointer to the context for hashing
59 * @dest_buf: Pointer to the buffer for the result
60 * @size: Size of the buffer for the result
61 * @return 0 if ok, -ENOSPC if size of the result buffer is too small
62 * or -1 on other errors
63 */
64 int (*hash_finish)(struct hash_algo *algo, void *ctx, void *dest_buf,
65 int size);
Simon Glass460408e2012-12-05 14:46:36 +000066};
67
68/*
69 * Maximum digest size for all algorithms we support. Having this value
70 * avoids a malloc() or C99 local declaration in common/cmd_hash.c.
71 */
72#define HASH_MAX_DIGEST_SIZE 32
73
Simon Glassd5b76672013-02-24 17:33:26 +000074enum {
75 HASH_FLAG_VERIFY = 1 << 0, /* Enable verify mode */
76 HASH_FLAG_ENV = 1 << 1, /* Allow env vars */
77};
78
Simon Glass460408e2012-12-05 14:46:36 +000079/**
80 * hash_command: Process a hash command for a particular algorithm
81 *
82 * This common function is used to implement specific hash commands.
83 *
Simon Glass218da0f2013-02-24 17:33:32 +000084 * @algo_name: Hash algorithm being used (lower case!)
Simon Glassd5b76672013-02-24 17:33:26 +000085 * @flags: Flags value (HASH_FLAG_...)
Simon Glass460408e2012-12-05 14:46:36 +000086 * @cmdtp: Pointer to command table entry
87 * @flag: Some flags normally 0 (see CMD_FLAG_.. above)
88 * @argc: Number of arguments (arg 0 must be the command text)
89 * @argv: Arguments
90 */
Simon Glassd5b76672013-02-24 17:33:26 +000091int hash_command(const char *algo_name, int flags, cmd_tbl_t *cmdtp, int flag,
Simon Glass460408e2012-12-05 14:46:36 +000092 int argc, char * const argv[]);
93
Simon Glass6f907b42013-05-07 06:11:47 +000094/**
95 * hash_block() - Hash a block according to the requested algorithm
96 *
97 * The caller probably knows the hash length for the chosen algorithm, but
98 * in order to provide a general interface, and output_size parameter is
99 * provided.
100 *
101 * @algo_name: Hash algorithm to use
102 * @data: Data to hash
103 * @len: Lengh of data to hash in bytes
104 * @output: Place to put hash value
105 * @output_size: On entry, pointer to the number of bytes available in
106 * output. On exit, pointer to the number of bytes used.
107 * If NULL, then it is assumed that the caller has
108 * allocated enough space for the hash. This is possible
109 * since the caller is selecting the algorithm.
110 * @return 0 if ok, -ve on error: -EPROTONOSUPPORT for an unknown algorithm,
111 * -ENOSPC if the output buffer is not large enough.
112 */
113int hash_block(const char *algo_name, const void *data, unsigned int len,
114 uint8_t *output, int *output_size);
115
Hung-ying Tyanbf007eb2014-03-03 12:19:28 +0100116/**
117 * hash_lookup_algo() - Look up the hash_algo struct for an algorithm
118 *
119 * The function returns the pointer to the struct or -EPROTONOSUPPORT if the
120 * algorithm is not available.
121 *
122 * @algo_name: Hash algorithm to look up
123 * @algop: Pointer to the hash_algo struct if found
124 *
125 * @return 0 if ok, -EPROTONOSUPPORT for an unknown algorithm.
126 */
127int hash_lookup_algo(const char *algo_name, struct hash_algo **algop);
Simon Glass460408e2012-12-05 14:46:36 +0000128#endif