2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
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"
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
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.
30 static OSSL_FUNC_digest_init_fn keccak_init;
31 static OSSL_FUNC_digest_update_fn keccak_update;
32 static OSSL_FUNC_digest_final_fn keccak_final;
33 static OSSL_FUNC_digest_freectx_fn keccak_freectx;
34 static OSSL_FUNC_digest_dupctx_fn keccak_dupctx;
35 static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params;
36 static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params;
37 static sha3_absorb_fn generic_sha3_absorb;
38 static sha3_final_fn generic_sha3_final;
40 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
44 # include "s390x_arch.h"
46 # define S390_SHA3_CAPABLE(name) \
47 ((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \
48 (OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name)))
52 static int keccak_init(void *vctx)
54 if (!ossl_prov_is_running())
56 /* The newctx() handles most of the ctx fixed setup. */
57 ossl_sha3_reset((KECCAK1600_CTX *)vctx);
61 static int keccak_update(void *vctx, const unsigned char *inp, size_t len)
63 KECCAK1600_CTX *ctx = vctx;
64 const size_t bsz = ctx->block_size;
70 /* Is there anything in the buffer already ? */
71 if ((num = ctx->bufsz) != 0) {
72 /* Calculate how much space is left in the buffer */
74 /* If the new input does not fill the buffer then just add it */
76 memcpy(ctx->buf + num, inp, len);
80 /* otherwise fill up the buffer and absorb the buffer */
81 memcpy(ctx->buf + num, inp, rem);
82 /* Update the input pointer */
85 ctx->meth.absorb(ctx, ctx->buf, bsz);
88 /* Absorb the input - rem = leftover part of the input < blocksize) */
89 rem = ctx->meth.absorb(ctx, inp, len);
90 /* Copy the leftover bit of the input into the buffer */
92 memcpy(ctx->buf, inp + len - rem, rem);
98 static int keccak_final(void *vctx, unsigned char *out, size_t *outl,
102 KECCAK1600_CTX *ctx = vctx;
104 if (!ossl_prov_is_running())
107 ret = ctx->meth.final(out, ctx);
109 *outl = ctx->md_size;
114 * Generic software version of the absorb() and final().
116 static size_t generic_sha3_absorb(void *vctx, const void *inp, size_t len)
118 KECCAK1600_CTX *ctx = vctx;
120 return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
123 static int generic_sha3_final(unsigned char *md, void *vctx)
125 return ossl_sha3_final(md, (KECCAK1600_CTX *)vctx);
128 static PROV_SHA3_METHOD sha3_generic_md =
134 #if defined(S390_SHA3)
136 static sha3_absorb_fn s390x_sha3_absorb;
137 static sha3_final_fn s390x_sha3_final;
138 static sha3_final_fn s390x_shake_final;
141 * The platform specific parts of the absorb() and final() for S390X.
143 static size_t s390x_sha3_absorb(void *vctx, const void *inp, size_t len)
145 KECCAK1600_CTX *ctx = vctx;
146 size_t rem = len % ctx->block_size;
148 s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
152 static int s390x_sha3_final(unsigned char *md, void *vctx)
154 KECCAK1600_CTX *ctx = vctx;
156 if (!ossl_prov_is_running())
158 s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
159 memcpy(md, ctx->A, ctx->md_size);
163 static int s390x_shake_final(unsigned char *md, void *vctx)
165 KECCAK1600_CTX *ctx = vctx;
167 if (!ossl_prov_is_running())
169 s390x_klmd(ctx->buf, ctx->bufsz, md, ctx->md_size, ctx->pad, ctx->A);
173 static PROV_SHA3_METHOD sha3_s390x_md =
179 static PROV_SHA3_METHOD shake_s390x_md =
185 # define SHA3_SET_MD(uname, typ) \
186 if (S390_SHA3_CAPABLE(uname)) { \
187 ctx->pad = S390X_##uname; \
188 ctx->meth = typ##_s390x_md; \
190 ctx->meth = sha3_generic_md; \
193 # define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
194 #endif /* S390_SHA3 */
196 #define SHA3_newctx(typ, uname, name, bitlen, pad) \
197 static OSSL_FUNC_digest_newctx_fn name##_newctx; \
198 static void *name##_newctx(void *provctx) \
200 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
205 ossl_sha3_init(ctx, pad, bitlen); \
206 SHA3_SET_MD(uname, typ) \
210 #define KMAC_newctx(uname, bitlen, pad) \
211 static OSSL_FUNC_digest_newctx_fn uname##_newctx; \
212 static void *uname##_newctx(void *provctx) \
214 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
219 ossl_keccak_kmac_init(ctx, pad, bitlen); \
220 ctx->meth = sha3_generic_md; \
224 #define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \
225 PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \
226 const OSSL_DISPATCH ossl_##name##_functions[] = { \
227 { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \
228 { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \
229 { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \
230 { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \
231 { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \
232 { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \
233 PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
235 #define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \
236 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
237 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
239 #define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \
240 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
241 { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
242 { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \
243 (void (*)(void))shake_settable_ctx_params }, \
244 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
246 static void keccak_freectx(void *vctx)
248 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
250 OPENSSL_clear_free(ctx, sizeof(*ctx));
253 static void *keccak_dupctx(void *ctx)
255 KECCAK1600_CTX *in = (KECCAK1600_CTX *)ctx;
256 KECCAK1600_CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret))
264 static const OSSL_PARAM known_shake_settable_ctx_params[] = {
265 {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
268 static const OSSL_PARAM *shake_settable_ctx_params(ossl_unused void *provctx)
270 return known_shake_settable_ctx_params;
273 static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
276 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
278 if (ctx != NULL && params != NULL) {
279 p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
280 if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
281 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
286 return 0; /* Null Parameter */
289 #define IMPLEMENT_SHA3_functions(bitlen) \
290 SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \
291 PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \
292 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
295 #define IMPLEMENT_SHAKE_functions(bitlen) \
296 SHA3_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f') \
297 PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \
298 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
300 #define IMPLEMENT_KMAC_functions(bitlen) \
301 KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \
302 PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \
303 SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \
306 /* ossl_sha3_224_functions */
307 IMPLEMENT_SHA3_functions(224)
308 /* ossl_sha3_256_functions */
309 IMPLEMENT_SHA3_functions(256)
310 /* ossl_sha3_384_functions */
311 IMPLEMENT_SHA3_functions(384)
312 /* ossl_sha3_512_functions */
313 IMPLEMENT_SHA3_functions(512)
314 /* ossl_shake_128_functions */
315 IMPLEMENT_SHAKE_functions(128)
316 /* ossl_shake_256_functions */
317 IMPLEMENT_SHAKE_functions(256)
318 /* ossl_keccak_kmac_128_functions */
319 IMPLEMENT_KMAC_functions(128)
320 /* ossl_keccak_kmac_256_functions */
321 IMPLEMENT_KMAC_functions(256)