1 /*
2 * Copyright 2019-2022 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 #include <string.h>
11 #include <openssl/core_names.h>
12 #include <openssl/crypto.h>
13 #include <openssl/evp.h>
14 #include <openssl/params.h>
15 #include <openssl/err.h>
16 #include <openssl/proverr.h>
17 #include "internal/sha3.h"
18 #include "prov/digestcommon.h"
19 #include "prov/implementations.h"
20
21 #define SHA3_FLAGS PROV_DIGEST_FLAG_ALGID_ABSENT
22 #define SHAKE_FLAGS PROV_DIGEST_FLAG_XOF
23 #define KMAC_FLAGS PROV_DIGEST_FLAG_XOF
24
25 /*
26 * Forward declaration of any unique methods implemented here. This is not strictly
27 * necessary for the compiler, but provides an assurance that the signatures
28 * of the functions in the dispatch table are correct.
29 */
30 static OSSL_FUNC_digest_init_fn keccak_init;
31 static OSSL_FUNC_digest_init_fn keccak_init_params;
32 static OSSL_FUNC_digest_update_fn keccak_update;
33 static OSSL_FUNC_digest_final_fn keccak_final;
34 static OSSL_FUNC_digest_freectx_fn keccak_freectx;
35 static OSSL_FUNC_digest_dupctx_fn keccak_dupctx;
36 static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params;
37 static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params;
38 static sha3_absorb_fn generic_sha3_absorb;
39 static sha3_final_fn generic_sha3_final;
40
41 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
42 /*
43 * IBM S390X support
44 */
45 # include "s390x_arch.h"
46 # define S390_SHA3 1
47 # define S390_SHA3_CAPABLE(name) \
48 ((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \
49 (OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name)))
50
51 #endif
52
keccak_init(void * vctx,ossl_unused const OSSL_PARAM params[])53 static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[])
54 {
55 if (!ossl_prov_is_running())
56 return 0;
57 /* The newctx() handles most of the ctx fixed setup. */
58 ossl_sha3_reset((KECCAK1600_CTX *)vctx);
59 return 1;
60 }
61
keccak_init_params(void * vctx,const OSSL_PARAM params[])62 static int keccak_init_params(void *vctx, const OSSL_PARAM params[])
63 {
64 return keccak_init(vctx, NULL)
65 && shake_set_ctx_params(vctx, params);
66 }
67
keccak_update(void * vctx,const unsigned char * inp,size_t len)68 static int keccak_update(void *vctx, const unsigned char *inp, size_t len)
69 {
70 KECCAK1600_CTX *ctx = vctx;
71 const size_t bsz = ctx->block_size;
72 size_t num, rem;
73
74 if (len == 0)
75 return 1;
76
77 /* Is there anything in the buffer already ? */
78 if ((num = ctx->bufsz) != 0) {
79 /* Calculate how much space is left in the buffer */
80 rem = bsz - num;
81 /* If the new input does not fill the buffer then just add it */
82 if (len < rem) {
83 memcpy(ctx->buf + num, inp, len);
84 ctx->bufsz += len;
85 return 1;
86 }
87 /* otherwise fill up the buffer and absorb the buffer */
88 memcpy(ctx->buf + num, inp, rem);
89 /* Update the input pointer */
90 inp += rem;
91 len -= rem;
92 ctx->meth.absorb(ctx, ctx->buf, bsz);
93 ctx->bufsz = 0;
94 }
95 /* Absorb the input - rem = leftover part of the input < blocksize) */
96 rem = ctx->meth.absorb(ctx, inp, len);
97 /* Copy the leftover bit of the input into the buffer */
98 if (rem) {
99 memcpy(ctx->buf, inp + len - rem, rem);
100 ctx->bufsz = rem;
101 }
102 return 1;
103 }
104
keccak_final(void * vctx,unsigned char * out,size_t * outl,size_t outsz)105 static int keccak_final(void *vctx, unsigned char *out, size_t *outl,
106 size_t outsz)
107 {
108 int ret = 1;
109 KECCAK1600_CTX *ctx = vctx;
110
111 if (!ossl_prov_is_running())
112 return 0;
113 if (outsz > 0)
114 ret = ctx->meth.final(out, ctx);
115
116 *outl = ctx->md_size;
117 return ret;
118 }
119
120 /*-
121 * Generic software version of the absorb() and final().
122 */
generic_sha3_absorb(void * vctx,const void * inp,size_t len)123 static size_t generic_sha3_absorb(void *vctx, const void *inp, size_t len)
124 {
125 KECCAK1600_CTX *ctx = vctx;
126
127 return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
128 }
129
generic_sha3_final(unsigned char * md,void * vctx)130 static int generic_sha3_final(unsigned char *md, void *vctx)
131 {
132 return ossl_sha3_final(md, (KECCAK1600_CTX *)vctx);
133 }
134
135 static PROV_SHA3_METHOD sha3_generic_md =
136 {
137 generic_sha3_absorb,
138 generic_sha3_final
139 };
140
141 #if defined(S390_SHA3)
142
143 static sha3_absorb_fn s390x_sha3_absorb;
144 static sha3_final_fn s390x_sha3_final;
145 static sha3_final_fn s390x_shake_final;
146
147 /*-
148 * The platform specific parts of the absorb() and final() for S390X.
149 */
s390x_sha3_absorb(void * vctx,const void * inp,size_t len)150 static size_t s390x_sha3_absorb(void *vctx, const void *inp, size_t len)
151 {
152 KECCAK1600_CTX *ctx = vctx;
153 size_t rem = len % ctx->block_size;
154
155 s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
156 return rem;
157 }
158
s390x_sha3_final(unsigned char * md,void * vctx)159 static int s390x_sha3_final(unsigned char *md, void *vctx)
160 {
161 KECCAK1600_CTX *ctx = vctx;
162
163 if (!ossl_prov_is_running())
164 return 0;
165 s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
166 memcpy(md, ctx->A, ctx->md_size);
167 return 1;
168 }
169
s390x_shake_final(unsigned char * md,void * vctx)170 static int s390x_shake_final(unsigned char *md, void *vctx)
171 {
172 KECCAK1600_CTX *ctx = vctx;
173
174 if (!ossl_prov_is_running())
175 return 0;
176 s390x_klmd(ctx->buf, ctx->bufsz, md, ctx->md_size, ctx->pad, ctx->A);
177 return 1;
178 }
179
s390x_keccakc_final(unsigned char * md,void * vctx,int padding)180 static int s390x_keccakc_final(unsigned char *md, void *vctx, int padding)
181 {
182 KECCAK1600_CTX *ctx = vctx;
183 size_t bsz = ctx->block_size;
184 size_t num = ctx->bufsz;
185
186 if (!ossl_prov_is_running())
187 return 0;
188 if (ctx->md_size == 0)
189 return 1;
190 memset(ctx->buf + num, 0, bsz - num);
191 ctx->buf[num] = padding;
192 ctx->buf[bsz - 1] |= 0x80;
193 s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
194 memcpy(md, ctx->A, ctx->md_size);
195 return 1;
196 }
197
s390x_keccak_final(unsigned char * md,void * vctx)198 static int s390x_keccak_final(unsigned char *md, void *vctx)
199 {
200 return s390x_keccakc_final(md, vctx, 0x01);
201 }
202
s390x_kmac_final(unsigned char * md,void * vctx)203 static int s390x_kmac_final(unsigned char *md, void *vctx)
204 {
205 return s390x_keccakc_final(md, vctx, 0x04);
206 }
207
208 static PROV_SHA3_METHOD sha3_s390x_md =
209 {
210 s390x_sha3_absorb,
211 s390x_sha3_final
212 };
213
214 static PROV_SHA3_METHOD keccak_s390x_md =
215 {
216 s390x_sha3_absorb,
217 s390x_keccak_final
218 };
219
220 static PROV_SHA3_METHOD shake_s390x_md =
221 {
222 s390x_sha3_absorb,
223 s390x_shake_final
224 };
225
226 static PROV_SHA3_METHOD kmac_s390x_md =
227 {
228 s390x_sha3_absorb,
229 s390x_kmac_final
230 };
231
232 # define SHA3_SET_MD(uname, typ) \
233 if (S390_SHA3_CAPABLE(uname)) { \
234 ctx->pad = S390X_##uname; \
235 ctx->meth = typ##_s390x_md; \
236 } else { \
237 ctx->meth = sha3_generic_md; \
238 }
239 # define KMAC_SET_MD(bitlen) \
240 if (S390_SHA3_CAPABLE(SHAKE_##bitlen)) { \
241 ctx->pad = S390X_SHAKE_##bitlen; \
242 ctx->meth = kmac_s390x_md; \
243 } else { \
244 ctx->meth = sha3_generic_md; \
245 }
246 #else
247 # define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
248 # define KMAC_SET_MD(bitlen) ctx->meth = sha3_generic_md;
249 #endif /* S390_SHA3 */
250
251 #define SHA3_newctx(typ, uname, name, bitlen, pad) \
252 static OSSL_FUNC_digest_newctx_fn name##_newctx; \
253 static void *name##_newctx(void *provctx) \
254 { \
255 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
256 : NULL; \
257 \
258 if (ctx == NULL) \
259 return NULL; \
260 ossl_sha3_init(ctx, pad, bitlen); \
261 SHA3_SET_MD(uname, typ) \
262 return ctx; \
263 }
264
265 #define KMAC_newctx(uname, bitlen, pad) \
266 static OSSL_FUNC_digest_newctx_fn uname##_newctx; \
267 static void *uname##_newctx(void *provctx) \
268 { \
269 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
270 : NULL; \
271 \
272 if (ctx == NULL) \
273 return NULL; \
274 ossl_keccak_kmac_init(ctx, pad, bitlen); \
275 KMAC_SET_MD(bitlen) \
276 return ctx; \
277 }
278
279 #define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \
280 PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \
281 const OSSL_DISPATCH ossl_##name##_functions[] = { \
282 { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \
283 { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \
284 { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \
285 { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \
286 { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \
287 PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
288
289 #define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \
290 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
291 { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \
292 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
293
294 #define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \
295 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
296 { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params }, \
297 { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
298 { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \
299 (void (*)(void))shake_settable_ctx_params }, \
300 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
301
keccak_freectx(void * vctx)302 static void keccak_freectx(void *vctx)
303 {
304 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
305
306 OPENSSL_clear_free(ctx, sizeof(*ctx));
307 }
308
keccak_dupctx(void * ctx)309 static void *keccak_dupctx(void *ctx)
310 {
311 KECCAK1600_CTX *in = (KECCAK1600_CTX *)ctx;
312 KECCAK1600_CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret))
313 : NULL;
314
315 if (ret != NULL)
316 *ret = *in;
317 return ret;
318 }
319
320 static const OSSL_PARAM known_shake_settable_ctx_params[] = {
321 {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
322 OSSL_PARAM_END
323 };
shake_settable_ctx_params(ossl_unused void * ctx,ossl_unused void * provctx)324 static const OSSL_PARAM *shake_settable_ctx_params(ossl_unused void *ctx,
325 ossl_unused void *provctx)
326 {
327 return known_shake_settable_ctx_params;
328 }
329
shake_set_ctx_params(void * vctx,const OSSL_PARAM params[])330 static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
331 {
332 const OSSL_PARAM *p;
333 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
334
335 if (ctx == NULL)
336 return 0;
337 if (params == NULL)
338 return 1;
339
340 p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
341 if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
342 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
343 return 0;
344 }
345 return 1;
346 }
347
348 #define IMPLEMENT_SHA3_functions(bitlen) \
349 SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \
350 PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \
351 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
352 SHA3_FLAGS)
353
354 #define IMPLEMENT_KECCAK_functions(bitlen) \
355 SHA3_newctx(keccak, KECCAK_##bitlen, keccak_##bitlen, bitlen, '\x01') \
356 PROV_FUNC_SHA3_DIGEST(keccak_##bitlen, bitlen, \
357 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
358 SHA3_FLAGS)
359
360 #define IMPLEMENT_SHAKE_functions(bitlen) \
361 SHA3_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f') \
362 PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \
363 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
364 SHAKE_FLAGS)
365 #define IMPLEMENT_KMAC_functions(bitlen) \
366 KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \
367 PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \
368 SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \
369 KMAC_FLAGS)
370
371 /* ossl_sha3_224_functions */
372 IMPLEMENT_SHA3_functions(224)
373 /* ossl_sha3_256_functions */
374 IMPLEMENT_SHA3_functions(256)
375 /* ossl_sha3_384_functions */
376 IMPLEMENT_SHA3_functions(384)
377 /* ossl_sha3_512_functions */
378 IMPLEMENT_SHA3_functions(512)
379 /* ossl_keccak_224_functions */
380 IMPLEMENT_KECCAK_functions(224)
381 /* ossl_keccak_256_functions */
382 IMPLEMENT_KECCAK_functions(256)
383 /* ossl_keccak_384_functions */
384 IMPLEMENT_KECCAK_functions(384)
385 /* ossl_keccak_512_functions */
386 IMPLEMENT_KECCAK_functions(512)
387 /* ossl_shake_128_functions */
388 IMPLEMENT_SHAKE_functions(128)
389 /* ossl_shake_256_functions */
390 IMPLEMENT_SHAKE_functions(256)
391 /* ossl_keccak_kmac_128_functions */
392 IMPLEMENT_KMAC_functions(128)
393 /* ossl_keccak_kmac_256_functions */
394 IMPLEMENT_KMAC_functions(256)
395