1 /*
2 * Copyright 2019-2025 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 /*
11 * All SHA low level APIs are deprecated for public use, but still ok for
12 * internal use.
13 */
14 #include "internal/deprecated.h"
15
16 #include <openssl/sha.h> /* diverse SHA macros */
17 #include "internal/sha3.h" /* KECCAK1600_WIDTH */
18 #include "crypto/evp.h"
19 /* Used by legacy methods */
20 #include "crypto/sha.h"
21 #include "legacy_meth.h"
22 #include "evp_local.h"
23
24 /*-
25 * LEGACY methods for SHA.
26 * These only remain to support engines that can get these methods.
27 * Hardware support for SHA3 has been removed from these legacy cases.
28 */
29 #define IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(nm, fn, tag) \
30 static int nm##_init(EVP_MD_CTX *ctx) \
31 { \
32 return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
33 } \
34 static int nm##_update(EVP_MD_CTX *ctx, const void *data, size_t count) \
35 { \
36 return fn##_update(EVP_MD_CTX_get0_md_data(ctx), data, count); \
37 } \
38 static int nm##_final(EVP_MD_CTX *ctx, unsigned char *md) \
39 { \
40 KECCAK1600_CTX *kctx = EVP_MD_CTX_get0_md_data(ctx); \
41 return fn##_final(kctx, md, kctx->md_size); \
42 }
43 #define IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(nm, fn, tag) \
44 static int nm##_init(EVP_MD_CTX *ctx) \
45 { \
46 return fn##_init(EVP_MD_CTX_get0_md_data(ctx), tag, ctx->digest->md_size * 8); \
47 } \
48
49 #define sha512_224_Init sha512_224_init
50 #define sha512_256_Init sha512_256_init
51
52 #define sha512_224_Update SHA512_Update
53 #define sha512_224_Final SHA512_Final
54 #define sha512_256_Update SHA512_Update
55 #define sha512_256_Final SHA512_Final
56
IMPLEMENT_LEGACY_EVP_MD_METH(sha1,SHA1)57 IMPLEMENT_LEGACY_EVP_MD_METH(sha1, SHA1)
58 IMPLEMENT_LEGACY_EVP_MD_METH(sha224, SHA224)
59 IMPLEMENT_LEGACY_EVP_MD_METH(sha256, SHA256)
60 IMPLEMENT_LEGACY_EVP_MD_METH(sha384, SHA384)
61 IMPLEMENT_LEGACY_EVP_MD_METH(sha512, SHA512)
62 IMPLEMENT_LEGACY_EVP_MD_METH(sha512_224_int, sha512_224)
63 IMPLEMENT_LEGACY_EVP_MD_METH(sha512_256_int, sha512_256)
64 IMPLEMENT_LEGACY_EVP_MD_METH_SHA3(sha3_int, ossl_sha3, '\x06')
65 IMPLEMENT_LEGACY_EVP_MD_METH_SHAKE(shake, ossl_sha3, '\x1f')
66
67 static int sha1_int_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void *p2)
68 {
69 return ossl_sha1_ctrl(ctx != NULL ? EVP_MD_CTX_get0_md_data(ctx) : NULL,
70 cmd, p1, p2);
71 }
72
shake_ctrl(EVP_MD_CTX * evp_ctx,int cmd,int p1,void * p2)73 static int shake_ctrl(EVP_MD_CTX *evp_ctx, int cmd, int p1, void *p2)
74 {
75 KECCAK1600_CTX *ctx;
76
77 if (evp_ctx == NULL)
78 return 0;
79 ctx = evp_ctx->md_data;
80
81 switch (cmd) {
82 case EVP_MD_CTRL_XOF_LEN:
83 ctx->md_size = p1;
84 return 1;
85 default:
86 return 0;
87 }
88 }
89
90
91
92 static const EVP_MD sha1_md = {
93 NID_sha1,
94 NID_sha1WithRSAEncryption,
95 SHA_DIGEST_LENGTH,
96 EVP_MD_FLAG_DIGALGID_ABSENT,
97 EVP_ORIG_GLOBAL,
98 LEGACY_EVP_MD_METH_TABLE(sha1_init, sha1_update, sha1_final, sha1_int_ctrl,
99 SHA_CBLOCK),
100 };
101
EVP_sha1(void)102 const EVP_MD *EVP_sha1(void)
103 {
104 return &sha1_md;
105 }
106
107 static const EVP_MD sha224_md = {
108 NID_sha224,
109 NID_sha224WithRSAEncryption,
110 SHA224_DIGEST_LENGTH,
111 EVP_MD_FLAG_DIGALGID_ABSENT,
112 EVP_ORIG_GLOBAL,
113 LEGACY_EVP_MD_METH_TABLE(sha224_init, sha224_update, sha224_final, NULL,
114 SHA256_CBLOCK),
115 };
116
EVP_sha224(void)117 const EVP_MD *EVP_sha224(void)
118 {
119 return &sha224_md;
120 }
121
122 static const EVP_MD sha256_md = {
123 NID_sha256,
124 NID_sha256WithRSAEncryption,
125 SHA256_DIGEST_LENGTH,
126 EVP_MD_FLAG_DIGALGID_ABSENT,
127 EVP_ORIG_GLOBAL,
128 LEGACY_EVP_MD_METH_TABLE(sha256_init, sha256_update, sha256_final, NULL,
129 SHA256_CBLOCK),
130 };
131
EVP_sha256(void)132 const EVP_MD *EVP_sha256(void)
133 {
134 return &sha256_md;
135 }
136
137 static const EVP_MD sha512_224_md = {
138 NID_sha512_224,
139 NID_sha512_224WithRSAEncryption,
140 SHA224_DIGEST_LENGTH,
141 EVP_MD_FLAG_DIGALGID_ABSENT,
142 EVP_ORIG_GLOBAL,
143 LEGACY_EVP_MD_METH_TABLE(sha512_224_int_init, sha512_224_int_update,
144 sha512_224_int_final, NULL, SHA512_CBLOCK),
145 };
146
EVP_sha512_224(void)147 const EVP_MD *EVP_sha512_224(void)
148 {
149 return &sha512_224_md;
150 }
151
152 static const EVP_MD sha512_256_md = {
153 NID_sha512_256,
154 NID_sha512_256WithRSAEncryption,
155 SHA256_DIGEST_LENGTH,
156 EVP_MD_FLAG_DIGALGID_ABSENT,
157 EVP_ORIG_GLOBAL,
158 LEGACY_EVP_MD_METH_TABLE(sha512_256_int_init, sha512_256_int_update,
159 sha512_256_int_final, NULL, SHA512_CBLOCK),
160 };
161
EVP_sha512_256(void)162 const EVP_MD *EVP_sha512_256(void)
163 {
164 return &sha512_256_md;
165 }
166
167 static const EVP_MD sha384_md = {
168 NID_sha384,
169 NID_sha384WithRSAEncryption,
170 SHA384_DIGEST_LENGTH,
171 EVP_MD_FLAG_DIGALGID_ABSENT,
172 EVP_ORIG_GLOBAL,
173 LEGACY_EVP_MD_METH_TABLE(sha384_init, sha384_update, sha384_final, NULL,
174 SHA512_CBLOCK),
175 };
176
EVP_sha384(void)177 const EVP_MD *EVP_sha384(void)
178 {
179 return &sha384_md;
180 }
181
182 static const EVP_MD sha512_md = {
183 NID_sha512,
184 NID_sha512WithRSAEncryption,
185 SHA512_DIGEST_LENGTH,
186 EVP_MD_FLAG_DIGALGID_ABSENT,
187 EVP_ORIG_GLOBAL,
188 LEGACY_EVP_MD_METH_TABLE(sha512_init, sha512_update, sha512_final, NULL,
189 SHA512_CBLOCK),
190 };
191
EVP_sha512(void)192 const EVP_MD *EVP_sha512(void)
193 {
194 return &sha512_md;
195 }
196
197 #define EVP_MD_SHA3(bitlen) \
198 const EVP_MD *EVP_sha3_##bitlen(void) \
199 { \
200 static const EVP_MD sha3_##bitlen##_md = { \
201 NID_sha3_##bitlen, \
202 NID_RSA_SHA3_##bitlen, \
203 bitlen / 8, \
204 EVP_MD_FLAG_DIGALGID_ABSENT, \
205 EVP_ORIG_GLOBAL, \
206 LEGACY_EVP_MD_METH_TABLE(sha3_int_init, sha3_int_update, \
207 sha3_int_final, NULL, \
208 (KECCAK1600_WIDTH - bitlen * 2) / 8), \
209 }; \
210 return &sha3_##bitlen##_md; \
211 }
212 #define EVP_MD_SHAKE(bitlen) \
213 const EVP_MD *EVP_shake##bitlen(void) \
214 { \
215 static const EVP_MD shake##bitlen##_md = { \
216 NID_shake##bitlen, \
217 0, \
218 bitlen / 8, \
219 EVP_MD_FLAG_XOF | EVP_MD_FLAG_DIGALGID_ABSENT, \
220 EVP_ORIG_GLOBAL, \
221 LEGACY_EVP_MD_METH_TABLE(shake_init, sha3_int_update, sha3_int_final, \
222 shake_ctrl, (KECCAK1600_WIDTH - bitlen * 2) / 8), \
223 }; \
224 return &shake##bitlen##_md; \
225 }
226
227 EVP_MD_SHA3(224)
228 EVP_MD_SHA3(256)
229 EVP_MD_SHA3(384)
230 EVP_MD_SHA3(512)
231
232 EVP_MD_SHAKE(128)
233 EVP_MD_SHAKE(256)
234