blob: 7120ecb17a668df3e3ca9e930c7188b88b47187d [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/* sha.h
2 *
3 * Copyright (C) 2006-2021 wolfSSL Inc.
4 *
5 * This file is part of wolfSSL.
6 *
7 * wolfSSL is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * wolfSSL is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
20 */
21
22/* sha.h for openssl */
23
24
25#ifndef WOLFSSL_SHA_H_
26#define WOLFSSL_SHA_H_
27
28#include <wolfssl/wolfcrypt/settings.h>
29#include <wolfssl/wolfcrypt/types.h>
30
31#ifdef WOLFSSL_PREFIX
32#include "prefix_sha.h"
33#endif
34
35#ifdef __cplusplus
36 extern "C" {
37#endif
38
39
40typedef struct WOLFSSL_SHA_CTX {
41 /* big enough to hold wolfcrypt Sha, but check on init */
42#if defined(STM32_HASH)
43 void* holder[(112 + WC_ASYNC_DEV_SIZE + sizeof(STM32_HASH_Context)) / sizeof(void*)];
44#else
45 void* holder[(112 + WC_ASYNC_DEV_SIZE) / sizeof(void*)];
46#endif
47 #ifdef WOLF_CRYPTO_CB
48 void* cryptocb_holder[(sizeof(int) + sizeof(void*) + 4) / sizeof(void*)];
49 #endif
50} WOLFSSL_SHA_CTX;
51
52WOLFSSL_API int wolfSSL_SHA_Init(WOLFSSL_SHA_CTX*);
53WOLFSSL_API int wolfSSL_SHA_Update(WOLFSSL_SHA_CTX*, const void*, unsigned long);
54WOLFSSL_API int wolfSSL_SHA_Final(unsigned char*, WOLFSSL_SHA_CTX*);
55WOLFSSL_API int wolfSSL_SHA_Transform(WOLFSSL_SHA_CTX*,
56 const unsigned char *data);
57/* SHA1 points to above, shouldn't use SHA0 ever */
58WOLFSSL_API int wolfSSL_SHA1_Init(WOLFSSL_SHA_CTX*);
59WOLFSSL_API int wolfSSL_SHA1_Update(WOLFSSL_SHA_CTX*, const void*, unsigned long);
60WOLFSSL_API int wolfSSL_SHA1_Final(unsigned char*, WOLFSSL_SHA_CTX*);
61WOLFSSL_API int wolfSSL_SHA1_Transform(WOLFSSL_SHA_CTX*,
62 const unsigned char *data);
63enum {
64 SHA_DIGEST_LENGTH = 20
65};
66
67
68typedef WOLFSSL_SHA_CTX SHA_CTX;
69
70#define SHA_Init wolfSSL_SHA_Init
71#define SHA_Update wolfSSL_SHA_Update
72#define SHA_Final wolfSSL_SHA_Final
73#define SHA_Transform wolfSSL_SHA_Transform
74
75#if defined(NO_OLD_SHA_NAMES) && !defined(HAVE_SELFTEST) && \
76 (!defined(HAVE_FIPS) || \
77 (defined(HAVE_FIPS_VERSION) && HAVE_FIPS_VERSION > 2))
78 /* SHA is only available in non-fips mode or fips version > 2 mode
79 * because of SHA enum in FIPS build. */
80 #define SHA wolfSSL_SHA1
81#endif
82
83#define SHA1_Init wolfSSL_SHA1_Init
84#define SHA1_Update wolfSSL_SHA1_Update
85#define SHA1_Final wolfSSL_SHA1_Final
86#define SHA1_Transform wolfSSL_SHA1_Transform
87
88#ifdef WOLFSSL_SHA224
89
90/* Using ALIGN16 because when AES-NI is enabled digest and buffer in Sha256
91 * struct are 16 byte aligned. Any dereference to those elements after casting
92 * to Sha224, is expected to also be 16 byte aligned addresses. */
93typedef struct WOLFSSL_SHA224_CTX {
94 /* big enough to hold wolfcrypt Sha224, but check on init */
95 ALIGN16 void* holder[(272 + WC_ASYNC_DEV_SIZE) / sizeof(void*)];
96} WOLFSSL_SHA224_CTX;
97
98WOLFSSL_API int wolfSSL_SHA224_Init(WOLFSSL_SHA224_CTX*);
99WOLFSSL_API int wolfSSL_SHA224_Update(WOLFSSL_SHA224_CTX*, const void*,
100 unsigned long);
101WOLFSSL_API int wolfSSL_SHA224_Final(unsigned char*, WOLFSSL_SHA224_CTX*);
102
103enum {
104 SHA224_DIGEST_LENGTH = 28
105};
106
107
108typedef WOLFSSL_SHA224_CTX SHA224_CTX;
109
110#define SHA224_Init wolfSSL_SHA224_Init
111#define SHA224_Update wolfSSL_SHA224_Update
112#define SHA224_Final wolfSSL_SHA224_Final
113#if defined(NO_OLD_SHA_NAMES) && !defined(HAVE_SELFTEST) && \
114 (!defined(HAVE_FIPS) || \
115 (defined(HAVE_FIPS_VERSION) && HAVE_FIPS_VERSION > 2))
116 /* SHA224 is only available in non-fips mode or fips version > 2 mode
117 * because of SHA224 enum in FIPS build. */
118 #define SHA224 wolfSSL_SHA224
119#endif
120
121#endif /* WOLFSSL_SHA224 */
122
123
124/* Using ALIGN16 because when AES-NI is enabled digest and buffer in Sha256
125 * struct are 16 byte aligned. Any dereference to those elements after casting
126 * to Sha256, is expected to also be 16 byte aligned addresses. */
127typedef struct WOLFSSL_SHA256_CTX {
128 /* big enough to hold wolfcrypt Sha256, but check on init */
129 ALIGN16 void* holder[(272 + WC_ASYNC_DEV_SIZE) / sizeof(void*)];
130} WOLFSSL_SHA256_CTX;
131
132WOLFSSL_API int wolfSSL_SHA256_Init(WOLFSSL_SHA256_CTX*);
133WOLFSSL_API int wolfSSL_SHA256_Update(WOLFSSL_SHA256_CTX*, const void*,
134 unsigned long);
135WOLFSSL_API int wolfSSL_SHA256_Final(unsigned char*, WOLFSSL_SHA256_CTX*);
136WOLFSSL_API int wolfSSL_SHA256_Transform(WOLFSSL_SHA256_CTX*,
137 const unsigned char *data);
138enum {
139 SHA256_DIGEST_LENGTH = 32
140};
141
142
143typedef WOLFSSL_SHA256_CTX SHA256_CTX;
144
145#define SHA256_Init wolfSSL_SHA256_Init
146#define SHA256_Update wolfSSL_SHA256_Update
147#define SHA256_Final wolfSSL_SHA256_Final
148#define SHA256_Transform wolfSSL_SHA256_Transform
149
150#if defined(NO_OLD_SHA_NAMES) && !defined(HAVE_FIPS) && !defined(HAVE_SELFTEST)
151 /* SHA256 is only available in non-fips mode because of SHA256 enum in FIPS
152 * build. */
153 #define SHA256 wolfSSL_SHA256
154#endif
155
156
157#ifdef WOLFSSL_SHA384
158
159typedef struct WOLFSSL_SHA384_CTX {
160 /* big enough to hold wolfCrypt Sha384, but check on init */
161 void* holder[(256 + WC_ASYNC_DEV_SIZE) / sizeof(void*)];
162} WOLFSSL_SHA384_CTX;
163
164WOLFSSL_API int wolfSSL_SHA384_Init(WOLFSSL_SHA384_CTX*);
165WOLFSSL_API int wolfSSL_SHA384_Update(WOLFSSL_SHA384_CTX*, const void*,
166 unsigned long);
167WOLFSSL_API int wolfSSL_SHA384_Final(unsigned char*, WOLFSSL_SHA384_CTX*);
168
169enum {
170 SHA384_DIGEST_LENGTH = 48
171};
172
173
174typedef WOLFSSL_SHA384_CTX SHA384_CTX;
175
176#define SHA384_Init wolfSSL_SHA384_Init
177#define SHA384_Update wolfSSL_SHA384_Update
178#define SHA384_Final wolfSSL_SHA384_Final
179#if defined(NO_OLD_SHA_NAMES) && !defined(HAVE_FIPS) && !defined(HAVE_SELFTEST)
180 /* SHA384 is only available in non-fips mode because of SHA384 enum in FIPS
181 * build. */
182 #define SHA384 wolfSSL_SHA384
183#endif
184#endif /* WOLFSSL_SHA384 */
185
186#ifdef WOLFSSL_SHA512
187
188typedef struct WOLFSSL_SHA512_CTX {
189 /* big enough to hold wolfCrypt Sha384, but check on init */
190 void* holder[(288 + WC_ASYNC_DEV_SIZE) / sizeof(void*)];
191} WOLFSSL_SHA512_CTX;
192
193WOLFSSL_API int wolfSSL_SHA512_Init(WOLFSSL_SHA512_CTX*);
194WOLFSSL_API int wolfSSL_SHA512_Update(WOLFSSL_SHA512_CTX*, const void*,
195 unsigned long);
196WOLFSSL_API int wolfSSL_SHA512_Final(unsigned char*, WOLFSSL_SHA512_CTX*);
197WOLFSSL_API int wolfSSL_SHA512_Transform(WOLFSSL_SHA512_CTX*,
198 const unsigned char*);
199enum {
200 SHA512_DIGEST_LENGTH = 64
201};
202
203
204typedef WOLFSSL_SHA512_CTX SHA512_CTX;
205
206#define SHA512_Init wolfSSL_SHA512_Init
207#define SHA512_Update wolfSSL_SHA512_Update
208#define SHA512_Final wolfSSL_SHA512_Final
209#define SHA512_Transform wolfSSL_SHA512_Transform
210#if defined(NO_OLD_SHA_NAMES) && !defined(HAVE_FIPS) && !defined(HAVE_SELFTEST)
211 /* SHA512 is only available in non-fips mode because of SHA512 enum in FIPS
212 * build. */
213 #define SHA512 wolfSSL_SHA512
214#endif
215#endif /* WOLFSSL_SHA512 */
216
217
218
219
220#ifdef __cplusplus
221 } /* extern "C" */
222#endif
223
224
225#endif /* WOLFSSL_SHA_H_ */
226