/src/openssl/providers/implementations/digests/sha3_prov.c

Source (jump to first uncovered line)
/*
 * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <string.h>
#include <openssl/core_names.h>
#include <openssl/crypto.h>
#include <openssl/evp.h>
#include <openssl/params.h>
#include <openssl/err.h>
#include <openssl/proverr.h>
#include "internal/sha3.h"
#include "prov/digestcommon.h"
#include "prov/implementations.h"

#define SHA3_FLAGS PROV_DIGEST_FLAG_ALGID_ABSENT
#define SHAKE_FLAGS PROV_DIGEST_FLAG_XOF
#define KMAC_FLAGS PROV_DIGEST_FLAG_XOF

/*
 * Forward declaration of any unique methods implemented here. This is not strictly
 * necessary for the compiler, but provides an assurance that the signatures
 * of the functions in the dispatch table are correct.
 */
static OSSL_FUNC_digest_init_fn keccak_init;
static OSSL_FUNC_digest_init_fn keccak_init_params;
static OSSL_FUNC_digest_update_fn keccak_update;
static OSSL_FUNC_digest_final_fn keccak_final;
static OSSL_FUNC_digest_freectx_fn keccak_freectx;
static OSSL_FUNC_digest_dupctx_fn keccak_dupctx;
static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params;
static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params;
static sha3_absorb_fn generic_sha3_absorb;
static sha3_final_fn generic_sha3_final;

#if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
/*
 * IBM S390X support
 */
# include "s390x_arch.h"
# define S390_SHA3 1
# define S390_SHA3_CAPABLE(name) \
    ((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \
     (OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name)))

#endif

static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[])
{
    if (!ossl_prov_is_running())
        return 0;
    /* The newctx() handles most of the ctx fixed setup. */
    ossl_sha3_reset((KECCAK1600_CTX *)vctx);
    return 1;
}

static int keccak_init_params(void *vctx, const OSSL_PARAM params[])
{
    return keccak_init(vctx, NULL)
            && shake_set_ctx_params(vctx, params);
}

static int keccak_update(void *vctx, const unsigned char *inp, size_t len)
{
    KECCAK1600_CTX *ctx = vctx;
    const size_t bsz = ctx->block_size;
    size_t num, rem;

    if (len == 0)
        return 1;

    /* Is there anything in the buffer already ? */
    if ((num = ctx->bufsz) != 0) {
        /* Calculate how much space is left in the buffer */
        rem = bsz - num;
        /* If the new input does not fill the buffer then just add it */
        if (len < rem) {
            memcpy(ctx->buf + num, inp, len);
            ctx->bufsz += len;
            return 1;
        }
        /* otherwise fill up the buffer and absorb the buffer */
        memcpy(ctx->buf + num, inp, rem);
        /* Update the input pointer */
        inp += rem;
        len -= rem;
        ctx->meth.absorb(ctx, ctx->buf, bsz);
        ctx->bufsz = 0;
    }
    /* Absorb the input - rem = leftover part of the input < blocksize) */
    rem = ctx->meth.absorb(ctx, inp, len);
    /* Copy the leftover bit of the input into the buffer */
    if (rem) {
        memcpy(ctx->buf, inp + len - rem, rem);
        ctx->bufsz = rem;
    }
    return 1;
}

static int keccak_final(void *vctx, unsigned char *out, size_t *outl,
                        size_t outsz)
{
    int ret = 1;
    KECCAK1600_CTX *ctx = vctx;

    if (!ossl_prov_is_running())
        return 0;
    if (outsz > 0)
        ret = ctx->meth.final(out, ctx);

    *outl = ctx->md_size;
    return ret;
}

/*-
 * Generic software version of the absorb() and final().
 */
static size_t generic_sha3_absorb(void *vctx, const void *inp, size_t len)
{
    KECCAK1600_CTX *ctx = vctx;

    return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
}

static int generic_sha3_final(unsigned char *md, void *vctx)
{
    return ossl_sha3_final(md, (KECCAK1600_CTX *)vctx);
}

static PROV_SHA3_METHOD sha3_generic_md =
{
    generic_sha3_absorb,
    generic_sha3_final
};

#if defined(S390_SHA3)

static sha3_absorb_fn s390x_sha3_absorb;
static sha3_final_fn s390x_sha3_final;
static sha3_final_fn s390x_shake_final;

/*-
 * The platform specific parts of the absorb() and final() for S390X.
 */
static size_t s390x_sha3_absorb(void *vctx, const void *inp, size_t len)
{
    KECCAK1600_CTX *ctx = vctx;
    size_t rem = len % ctx->block_size;

    s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
    return rem;
}

static int s390x_sha3_final(unsigned char *md, void *vctx)
{
    KECCAK1600_CTX *ctx = vctx;

    if (!ossl_prov_is_running())
        return 0;
    s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
    memcpy(md, ctx->A, ctx->md_size);
    return 1;
}

static int s390x_shake_final(unsigned char *md, void *vctx)
{
    KECCAK1600_CTX *ctx = vctx;

    if (!ossl_prov_is_running())
        return 0;
    s390x_klmd(ctx->buf, ctx->bufsz, md, ctx->md_size, ctx->pad, ctx->A);
    return 1;
}

static int s390x_keccakc_final(unsigned char *md, void *vctx, int padding)
{
    KECCAK1600_CTX *ctx = vctx;
    size_t bsz = ctx->block_size;
    size_t num = ctx->bufsz;
    size_t needed = ctx->md_size;

    if (!ossl_prov_is_running())
        return 0;
    if (ctx->md_size == 0)
        return 1;
    memset(ctx->buf + num, 0, bsz - num);
    ctx->buf[num] = padding;
    ctx->buf[bsz - 1] |= 0x80;
    s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
    num = needed > bsz ? bsz : needed;
    memcpy(md, ctx->A, num);
    needed -= num;
    if (needed > 0)
        s390x_klmd(NULL, 0, md + bsz, needed, ctx->pad | S390X_KLMD_PS, ctx->A);

    return 1;
}

static int s390x_keccak_final(unsigned char *md, void *vctx)
{
    return s390x_keccakc_final(md, vctx, 0x01);
}

static int s390x_kmac_final(unsigned char *md, void *vctx)
{
    return s390x_keccakc_final(md, vctx, 0x04);
}

static PROV_SHA3_METHOD sha3_s390x_md =
{
    s390x_sha3_absorb,
    s390x_sha3_final
};

static PROV_SHA3_METHOD keccak_s390x_md =
{
    s390x_sha3_absorb,
    s390x_keccak_final
};

static PROV_SHA3_METHOD shake_s390x_md =
{
    s390x_sha3_absorb,
    s390x_shake_final
};

static PROV_SHA3_METHOD kmac_s390x_md =
{
    s390x_sha3_absorb,
    s390x_kmac_final
};

# define SHA3_SET_MD(uname, typ)                                               \
    if (S390_SHA3_CAPABLE(uname)) {                                            \
        ctx->pad = S390X_##uname;                                              \
        ctx->meth = typ##_s390x_md;                                            \
    } else {                                                                   \
        ctx->meth = sha3_generic_md;                                           \
    }
# define KMAC_SET_MD(bitlen)                                                   \
    if (S390_SHA3_CAPABLE(SHAKE_##bitlen)) {                                   \
        ctx->pad = S390X_SHAKE_##bitlen;                                       \
        ctx->meth = kmac_s390x_md;                                             \
    } else {                                                                   \
        ctx->meth = sha3_generic_md;                                           \
    }
#else
# define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
# define KMAC_SET_MD(bitlen) ctx->meth = sha3_generic_md;
#endif /* S390_SHA3 */

#define SHA3_newctx(typ, uname, name, bitlen, pad)                             \
static OSSL_FUNC_digest_newctx_fn name##_newctx;                               \
static void *name##_newctx(void *provctx)                                      \
{                                                                              \
    KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
                                                : NULL;                        \
                                                                               \
    if (ctx == NULL)                                                           \
        return NULL;                                                           \
    ossl_sha3_init(ctx, pad, bitlen);                                          \
    SHA3_SET_MD(uname, typ)                                                    \
    return ctx;                                                                \
}

#define KMAC_newctx(uname, bitlen, pad)                                        \
static OSSL_FUNC_digest_newctx_fn uname##_newctx;                              \
static void *uname##_newctx(void *provctx)                                     \
{                                                                              \
    KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
                                                : NULL;                        \
                                                                               \
    if (ctx == NULL)                                                           \
        return NULL;                                                           \
    ossl_keccak_kmac_init(ctx, pad, bitlen);                                   \
    KMAC_SET_MD(bitlen)                                                        \
    return ctx;                                                                \
}

#define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags)   \
PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags)                     \
const OSSL_DISPATCH ossl_##name##_functions[] = {                              \
    { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx },                \
    { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update },                \
    { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final },                  \
    { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx },              \
    { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx },                \
    PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)

#define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags)          \
    PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags),      \
    { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init },                    \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

#define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags)         \
    PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags),      \
    { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params },             \
    { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
    { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS,                                    \
     (void (*)(void))shake_settable_ctx_params },                              \
    PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END

static void keccak_freectx(void *vctx)
{
    KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;

    OPENSSL_clear_free(ctx,  sizeof(*ctx));
}

static void *keccak_dupctx(void *ctx)
{
    KECCAK1600_CTX *in = (KECCAK1600_CTX *)ctx;
    KECCAK1600_CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret))
                                                 : NULL;

    if (ret != NULL)
        *ret = *in;
    return ret;
}

static const OSSL_PARAM known_shake_settable_ctx_params[] = {
    {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
    OSSL_PARAM_END
};
static const OSSL_PARAM *shake_settable_ctx_params(ossl_unused void *ctx,
                                                   ossl_unused void *provctx)
{
    return known_shake_settable_ctx_params;
}

static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    const OSSL_PARAM *p;
    KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;

    if (ctx == NULL)
        return 0;
    if (params == NULL)
        return 1;

    p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
    if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
        return 0;
    }
    return 1;
}

#define IMPLEMENT_SHA3_functions(bitlen)                                       \
    SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06')            \
    PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen,                               \
                          SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen),         \
                          SHA3_FLAGS)

#define IMPLEMENT_KECCAK_functions(bitlen)                                     \
    SHA3_newctx(keccak, KECCAK_##bitlen, keccak_##bitlen, bitlen, '\x01')      \
    PROV_FUNC_SHA3_DIGEST(keccak_##bitlen, bitlen,                             \
                          SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen),         \
                          SHA3_FLAGS)

#define IMPLEMENT_SHAKE_functions(bitlen)                                      \
    SHA3_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f')         \
    PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen,                             \
                          SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen),         \
                          SHAKE_FLAGS)
#define IMPLEMENT_KMAC_functions(bitlen)                                       \
    KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04')                          \
    PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen,                       \
                           SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen),        \
                           KMAC_FLAGS)

/* ossl_sha3_224_functions */
IMPLEMENT_SHA3_functions(224)
/* ossl_sha3_256_functions */
IMPLEMENT_SHA3_functions(256)
/* ossl_sha3_384_functions */
IMPLEMENT_SHA3_functions(384)
/* ossl_sha3_512_functions */
IMPLEMENT_SHA3_functions(512)
/* ossl_keccak_224_functions */
IMPLEMENT_KECCAK_functions(224)
/* ossl_keccak_256_functions */
IMPLEMENT_KECCAK_functions(256)
/* ossl_keccak_384_functions */
IMPLEMENT_KECCAK_functions(384)
/* ossl_keccak_512_functions */
IMPLEMENT_KECCAK_functions(512)
/* ossl_shake_128_functions */
IMPLEMENT_SHAKE_functions(128)
/* ossl_shake_256_functions */
IMPLEMENT_SHAKE_functions(256)
/* ossl_keccak_kmac_128_functions */
IMPLEMENT_KMAC_functions(128)
/* ossl_keccak_kmac_256_functions */
IMPLEMENT_KMAC_functions(256)

Coverage Report

Created: 2023-06-08 06:41

Line	Count	Source (jump to first uncovered line)
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
53		static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[])
54	0	{
55	0	if (!ossl_prov_is_running())
56	0	return 0;
57		/* The newctx() handles most of the ctx fixed setup. */
58	0	ossl_sha3_reset((KECCAK1600_CTX *)vctx);
59	0	return 1;
60	0	}
61
62		static int keccak_init_params(void *vctx, const OSSL_PARAM params[])
63	0	{
64	0	return keccak_init(vctx, NULL)
65	0	&& shake_set_ctx_params(vctx, params);
66	0	}
67
68		static int keccak_update(void vctx, const unsigned char inp, size_t len)
69	0	{
70	0	KECCAK1600_CTX *ctx = vctx;
71	0	const size_t bsz = ctx->block_size;
72	0	size_t num, rem;
73
74	0	if (len == 0)
75	0	return 1;
76
77		/* Is there anything in the buffer already ? */
78	0	if ((num = ctx->bufsz) != 0) {
79		/* Calculate how much space is left in the buffer */
80	0	rem = bsz - num;
81		/* If the new input does not fill the buffer then just add it */
82	0	if (len < rem) {
83	0	memcpy(ctx->buf + num, inp, len);
84	0	ctx->bufsz += len;
85	0	return 1;
86	0	}
87		/* otherwise fill up the buffer and absorb the buffer */
88	0	memcpy(ctx->buf + num, inp, rem);
89		/* Update the input pointer */
90	0	inp += rem;
91	0	len -= rem;
92	0	ctx->meth.absorb(ctx, ctx->buf, bsz);
93	0	ctx->bufsz = 0;
94	0	}
95		/* Absorb the input - rem = leftover part of the input < blocksize) */
96	0	rem = ctx->meth.absorb(ctx, inp, len);
97		/* Copy the leftover bit of the input into the buffer */
98	0	if (rem) {
99	0	memcpy(ctx->buf, inp + len - rem, rem);
100	0	ctx->bufsz = rem;
101	0	}
102	0	return 1;
103	0	}
104
105		static int keccak_final(void vctx, unsigned char out, size_t *outl,
106		size_t outsz)
107	0	{
108	0	int ret = 1;
109	0	KECCAK1600_CTX *ctx = vctx;
110
111	0	if (!ossl_prov_is_running())
112	0	return 0;
113	0	if (outsz > 0)
114	0	ret = ctx->meth.final(out, ctx);
115
116	0	*outl = ctx->md_size;
117	0	return ret;
118	0	}
119
120		/*-
121		* Generic software version of the absorb() and final().
122		*/
123		static size_t generic_sha3_absorb(void vctx, const void inp, size_t len)
124	0	{
125	0	KECCAK1600_CTX *ctx = vctx;
126
127	0	return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
128	0	}
129
130		static int generic_sha3_final(unsigned char md, void vctx)
131	0	{
132	0	return ossl_sha3_final(md, (KECCAK1600_CTX *)vctx);
133	0	}
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		*/
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
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
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
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		size_t needed = ctx->md_size;
186
187		if (!ossl_prov_is_running())
188		return 0;
189		if (ctx->md_size == 0)
190		return 1;
191		memset(ctx->buf + num, 0, bsz - num);
192		ctx->buf[num] = padding;
193		ctx->buf[bsz - 1] \|= 0x80;
194		s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
195		num = needed > bsz ? bsz : needed;
196		memcpy(md, ctx->A, num);
197		needed -= num;
198		if (needed > 0)
199		s390x_klmd(NULL, 0, md + bsz, needed, ctx->pad \| S390X_KLMD_PS, ctx->A);
200
201		return 1;
202		}
203
204		static int s390x_keccak_final(unsigned char md, void vctx)
205		{
206		return s390x_keccakc_final(md, vctx, 0x01);
207		}
208
209		static int s390x_kmac_final(unsigned char md, void vctx)
210		{
211		return s390x_keccakc_final(md, vctx, 0x04);
212		}
213
214		static PROV_SHA3_METHOD sha3_s390x_md =
215		{
216		s390x_sha3_absorb,
217		s390x_sha3_final
218		};
219
220		static PROV_SHA3_METHOD keccak_s390x_md =
221		{
222		s390x_sha3_absorb,
223		s390x_keccak_final
224		};
225
226		static PROV_SHA3_METHOD shake_s390x_md =
227		{
228		s390x_sha3_absorb,
229		s390x_shake_final
230		};
231
232		static PROV_SHA3_METHOD kmac_s390x_md =
233		{
234		s390x_sha3_absorb,
235		s390x_kmac_final
236		};
237
238		# define SHA3_SET_MD(uname, typ) \
239		if (S390_SHA3_CAPABLE(uname)) { \
240		ctx->pad = S390X_##uname; \
241		ctx->meth = typ##_s390x_md; \
242		} else { \
243		ctx->meth = sha3_generic_md; \
244		}
245		# define KMAC_SET_MD(bitlen) \
246		if (S390_SHA3_CAPABLE(SHAKE_##bitlen)) { \
247		ctx->pad = S390X_SHAKE_##bitlen; \
248		ctx->meth = kmac_s390x_md; \
249		} else { \
250		ctx->meth = sha3_generic_md; \
251		}
252		#else
253	0	# define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
254	0	# define KMAC_SET_MD(bitlen) ctx->meth = sha3_generic_md;
255		#endif /* S390_SHA3 */
256
257		#define SHA3_newctx(typ, uname, name, bitlen, pad) \
258		static OSSL_FUNC_digest_newctx_fn name##_newctx; \
259	0	static void name##_newctx(void provctx) \
260	0	{ \
261	0	KECCAK1600_CTX ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(ctx)) \
262	0	: NULL; \
263	0	\
264	0	if (ctx == NULL) \
265	0	return NULL; \
266	0	ossl_sha3_init(ctx, pad, bitlen); \
267	0	SHA3_SET_MD(uname, typ) \
268	0	return ctx; \
269	0	} Unexecuted instantiation: sha3_prov.c:sha3_224_newctx Unexecuted instantiation: sha3_prov.c:sha3_256_newctx Unexecuted instantiation: sha3_prov.c:sha3_384_newctx Unexecuted instantiation: sha3_prov.c:sha3_512_newctx Unexecuted instantiation: sha3_prov.c:keccak_224_newctx Unexecuted instantiation: sha3_prov.c:keccak_256_newctx Unexecuted instantiation: sha3_prov.c:keccak_384_newctx Unexecuted instantiation: sha3_prov.c:keccak_512_newctx Unexecuted instantiation: sha3_prov.c:shake_128_newctx Unexecuted instantiation: sha3_prov.c:shake_256_newctx
270
271		#define KMAC_newctx(uname, bitlen, pad) \
272		static OSSL_FUNC_digest_newctx_fn uname##_newctx; \
273	0	static void uname##_newctx(void provctx) \
274	0	{ \
275	0	KECCAK1600_CTX ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(ctx)) \
276	0	: NULL; \
277	0	\
278	0	if (ctx == NULL) \
279	0	return NULL; \
280	0	ossl_keccak_kmac_init(ctx, pad, bitlen); \
281	0	KMAC_SET_MD(bitlen) \
282	0	return ctx; \
283	0	} Unexecuted instantiation: sha3_prov.c:keccak_kmac_128_newctx Unexecuted instantiation: sha3_prov.c:keccak_kmac_256_newctx
284
285		#define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \
286		PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \
287		const OSSL_DISPATCH ossl_##name##_functions[] = { \
288		{ OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \
289		{ OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \
290		{ OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \
291		{ OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \
292		{ OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \
293		PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
294
295		#define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \
296		PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
297		{ OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \
298		PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
299
300		#define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \
301		PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
302		{ OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params }, \
303		{ OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
304		{ OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \
305		(void (*)(void))shake_settable_ctx_params }, \
306		PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
307
308		static void keccak_freectx(void *vctx)
309	0	{
310	0	KECCAK1600_CTX ctx = (KECCAK1600_CTX )vctx;
311
312	0	OPENSSL_clear_free(ctx, sizeof(*ctx));
313	0	}
314
315		static void keccak_dupctx(void ctx)
316	0	{
317	0	KECCAK1600_CTX in = (KECCAK1600_CTX )ctx;
318	0	KECCAK1600_CTX ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(ret))
319	0	: NULL;
320
321	0	if (ret != NULL)
322	0	ret = in;
323	0	return ret;
324	0	}
325
326		static const OSSL_PARAM known_shake_settable_ctx_params[] = {
327		{OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
328		OSSL_PARAM_END
329		};
330		static const OSSL_PARAM shake_settable_ctx_params(ossl_unused void ctx,
331		ossl_unused void *provctx)
332	0	{
333	0	return known_shake_settable_ctx_params;
334	0	}
335
336		static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
337	0	{
338	0	const OSSL_PARAM *p;
339	0	KECCAK1600_CTX ctx = (KECCAK1600_CTX )vctx;
340
341	0	if (ctx == NULL)
342	0	return 0;
343	0	if (params == NULL)
344	0	return 1;
345
346	0	p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
347	0	if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
348	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
349	0	return 0;
350	0	}
351	0	return 1;
352	0	}
353
354		#define IMPLEMENT_SHA3_functions(bitlen) \
355		SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \
356		PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \
357		SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
358		SHA3_FLAGS)
359
360		#define IMPLEMENT_KECCAK_functions(bitlen) \
361		SHA3_newctx(keccak, KECCAK_##bitlen, keccak_##bitlen, bitlen, '\x01') \
362		PROV_FUNC_SHA3_DIGEST(keccak_##bitlen, bitlen, \
363		SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
364		SHA3_FLAGS)
365
366		#define IMPLEMENT_SHAKE_functions(bitlen) \
367		SHA3_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f') \
368		PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \
369		SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
370		SHAKE_FLAGS)
371		#define IMPLEMENT_KMAC_functions(bitlen) \
372		KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \
373		PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \
374		SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \
375		KMAC_FLAGS)
376
377		/* ossl_sha3_224_functions */
378		IMPLEMENT_SHA3_functions(224)
379		/* ossl_sha3_256_functions */
380		IMPLEMENT_SHA3_functions(256)
381		/* ossl_sha3_384_functions */
382		IMPLEMENT_SHA3_functions(384)
383		/* ossl_sha3_512_functions */
384		IMPLEMENT_SHA3_functions(512)
385		/* ossl_keccak_224_functions */
386		IMPLEMENT_KECCAK_functions(224)
387		/* ossl_keccak_256_functions */
388		IMPLEMENT_KECCAK_functions(256)
389		/* ossl_keccak_384_functions */
390		IMPLEMENT_KECCAK_functions(384)
391		/* ossl_keccak_512_functions */
392		IMPLEMENT_KECCAK_functions(512)
393		/* ossl_shake_128_functions */
394		IMPLEMENT_SHAKE_functions(128)
395		/* ossl_shake_256_functions */
396		IMPLEMENT_SHAKE_functions(256)
397		/* ossl_keccak_kmac_128_functions */
398		IMPLEMENT_KMAC_functions(128)
399		/* ossl_keccak_kmac_256_functions */
400		IMPLEMENT_KMAC_functions(256)