Commit | Line | Data |
---|---|---|
80a47a2c TK |
1 | /** |
2 | * \file sha2.h | |
3 | * | |
62d3e98d TK |
4 | * Copyright (C) 2006-2010, Brainspark B.V. |
5 | * | |
6 | * This file is part of PolarSSL (http://www.polarssl.org) | |
7 | * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org> | |
80a47a2c | 8 | * |
62d3e98d | 9 | * All rights reserved. |
80a47a2c TK |
10 | * |
11 | * This program is free software; you can redistribute it and/or modify | |
12 | * it under the terms of the GNU General Public License as published by | |
13 | * the Free Software Foundation; either version 2 of the License, or | |
14 | * (at your option) any later version. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU General Public License along | |
22 | * with this program; if not, write to the Free Software Foundation, Inc., | |
23 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
24 | */ | |
80a47a2c TK |
25 | #ifndef POLARSSL_SHA2_H |
26 | #define POLARSSL_SHA2_H | |
27 | ||
28 | /** | |
29 | * \brief SHA-256 context structure | |
30 | */ | |
31 | #ifndef HAVE_SHA2_CONTEXT | |
32 | #define HAVE_SHA2_CONTEXT | |
33 | typedef struct sha2_context sha2_context; | |
34 | #endif | |
35 | ||
36 | struct sha2_context | |
37 | { | |
38 | unsigned long total[2]; /*!< number of bytes processed */ | |
39 | unsigned long state[8]; /*!< intermediate digest state */ | |
40 | unsigned char buffer[64]; /*!< data block being processed */ | |
41 | ||
42 | unsigned char ipad[64]; /*!< HMAC: inner padding */ | |
43 | unsigned char opad[64]; /*!< HMAC: outer padding */ | |
44 | int is224; /*!< 0 => SHA-256, else SHA-224 */ | |
45 | }; | |
46 | ||
47 | #ifdef __cplusplus | |
48 | extern "C" { | |
49 | #endif | |
50 | ||
51 | /** | |
52 | * \brief SHA-256 context setup | |
53 | * | |
54 | * \param ctx context to be initialized | |
55 | * \param is224 0 = use SHA256, 1 = use SHA224 | |
56 | */ | |
57 | void sha2_starts( sha2_context *ctx, int is224 ); | |
58 | ||
59 | /** | |
60 | * \brief SHA-256 process buffer | |
61 | * | |
62 | * \param ctx SHA-256 context | |
63 | * \param input buffer holding the data | |
64 | * \param ilen length of the input data | |
65 | */ | |
62d3e98d | 66 | void sha2_update( sha2_context *ctx, const unsigned char *input, int ilen ); |
80a47a2c TK |
67 | |
68 | /** | |
69 | * \brief SHA-256 final digest | |
70 | * | |
71 | * \param ctx SHA-256 context | |
72 | * \param output SHA-224/256 checksum result | |
73 | */ | |
74 | void sha2_finish( sha2_context *ctx, unsigned char output[32] ); | |
75 | ||
76 | /** | |
77 | * \brief Output = SHA-256( input buffer ) | |
78 | * | |
79 | * \param input buffer holding the data | |
80 | * \param ilen length of the input data | |
81 | * \param output SHA-224/256 checksum result | |
82 | * \param is224 0 = use SHA256, 1 = use SHA224 | |
83 | */ | |
62d3e98d | 84 | void sha2( const unsigned char *input, int ilen, |
80a47a2c TK |
85 | unsigned char output[32], int is224 ); |
86 | ||
87 | /** | |
88 | * \brief Output = SHA-256( file contents ) | |
89 | * | |
90 | * \param path input file name | |
91 | * \param output SHA-224/256 checksum result | |
92 | * \param is224 0 = use SHA256, 1 = use SHA224 | |
93 | * | |
94 | * \return 0 if successful, 1 if fopen failed, | |
95 | * or 2 if fread failed | |
96 | */ | |
62d3e98d | 97 | int sha2_file( const char *path, unsigned char output[32], int is224 ); |
80a47a2c TK |
98 | |
99 | /** | |
100 | * \brief SHA-256 HMAC context setup | |
101 | * | |
102 | * \param ctx HMAC context to be initialized | |
103 | * \param key HMAC secret key | |
104 | * \param keylen length of the HMAC key | |
105 | * \param is224 0 = use SHA256, 1 = use SHA224 | |
106 | */ | |
62d3e98d | 107 | void sha2_hmac_starts( sha2_context *ctx, const unsigned char *key, int keylen, |
80a47a2c TK |
108 | int is224 ); |
109 | ||
110 | /** | |
111 | * \brief SHA-256 HMAC process buffer | |
112 | * | |
113 | * \param ctx HMAC context | |
114 | * \param input buffer holding the data | |
115 | * \param ilen length of the input data | |
116 | */ | |
62d3e98d | 117 | void sha2_hmac_update( sha2_context *ctx, const unsigned char *input, int ilen ); |
80a47a2c TK |
118 | |
119 | /** | |
120 | * \brief SHA-256 HMAC final digest | |
121 | * | |
122 | * \param ctx HMAC context | |
123 | * \param output SHA-224/256 HMAC checksum result | |
124 | */ | |
125 | void sha2_hmac_finish( sha2_context *ctx, unsigned char output[32] ); | |
126 | ||
62d3e98d TK |
127 | /** |
128 | * \brief SHA-256 HMAC context reset | |
129 | * | |
130 | * \param ctx HMAC context to be reset | |
131 | */ | |
132 | void sha2_hmac_reset( sha2_context *ctx ); | |
133 | ||
80a47a2c TK |
134 | /** |
135 | * \brief Output = HMAC-SHA-256( hmac key, input buffer ) | |
136 | * | |
137 | * \param key HMAC secret key | |
138 | * \param keylen length of the HMAC key | |
139 | * \param input buffer holding the data | |
140 | * \param ilen length of the input data | |
141 | * \param output HMAC-SHA-224/256 result | |
142 | * \param is224 0 = use SHA256, 1 = use SHA224 | |
143 | */ | |
62d3e98d TK |
144 | void sha2_hmac( const unsigned char *key, int keylen, |
145 | const unsigned char *input, int ilen, | |
80a47a2c TK |
146 | unsigned char output[32], int is224 ); |
147 | ||
ac3ad426 AM |
148 | /** |
149 | * \brief Checkup routine | |
150 | * | |
151 | * \return 0 if successful, or 1 if the test failed | |
152 | */ | |
153 | int sha2_self_test( int verbose ); | |
154 | ||
80a47a2c TK |
155 | #ifdef __cplusplus |
156 | } | |
157 | #endif | |
158 | ||
159 | #endif /* sha2.h */ |