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

Source (jump to first uncovered line)
/*
 * Copyright 2019-2023 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/numbers.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_squeeze_fn shake_squeeze;
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;
static sha3_squeeze_fn generic_sha3_squeeze;

#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 outlen)
{
    int ret = 1;
    KECCAK1600_CTX *ctx = vctx;

    if (!ossl_prov_is_running())
        return 0;
    if (ctx->md_size == SIZE_MAX) {
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_LENGTH);
        return 0;
    }
    if (outlen > 0)
        ret = ctx->meth.final(ctx, out, ctx->md_size);

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

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

    if (!ossl_prov_is_running())
        return 0;
    if (ctx->meth.squeeze == NULL)
        return 0;
    if (outlen > 0)
        ret = ctx->meth.squeeze(ctx, out, outlen);

    *outl = outlen;
    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;

    if (!(ctx->xof_state == XOF_STATE_INIT ||
          ctx->xof_state == XOF_STATE_ABSORB))
        return 0;
    ctx->xof_state = XOF_STATE_ABSORB;
    return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
}

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

static int generic_sha3_squeeze(void *vctx, unsigned char *out, size_t outlen)
{
    return ossl_sha3_squeeze((KECCAK1600_CTX *)vctx, out, outlen);
}

static PROV_SHA3_METHOD sha3_generic_md = {
    generic_sha3_absorb,
    generic_sha3_final,
    NULL
};

static PROV_SHA3_METHOD shake_generic_md =
{
    generic_sha3_absorb,
    generic_sha3_final,
    generic_sha3_squeeze
};

#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;

    if (!(ctx->xof_state == XOF_STATE_INIT ||
          ctx->xof_state == XOF_STATE_ABSORB))
        return 0;
    ctx->xof_state = XOF_STATE_ABSORB;
    s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
    return rem;
}

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

    if (!ossl_prov_is_running())
        return 0;
    if (!(ctx->xof_state == XOF_STATE_INIT ||
          ctx->xof_state == XOF_STATE_ABSORB))
        return 0;
    ctx->xof_state = XOF_STATE_FINAL;
    s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
    memcpy(out, ctx->A, outlen);
    return 1;
}

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

    if (!ossl_prov_is_running())
        return 0;
    if (!(ctx->xof_state == XOF_STATE_INIT ||
          ctx->xof_state == XOF_STATE_ABSORB))
        return 0;
    ctx->xof_state = XOF_STATE_FINAL;
    s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
    return 1;
}

static int s390x_shake_squeeze(void *vctx, unsigned char *out, size_t outlen)
{
    KECCAK1600_CTX *ctx = vctx;
    size_t len;

    if (!ossl_prov_is_running())
        return 0;
    if (ctx->xof_state == XOF_STATE_FINAL)
        return 0;
    /*
     * On the first squeeze call, finish the absorb process (incl. padding).
     */
    if (ctx->xof_state != XOF_STATE_SQUEEZE) {
        ctx->xof_state = XOF_STATE_SQUEEZE;
        s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
        ctx->bufsz = outlen % ctx->block_size;
        /* reuse ctx->bufsz to count bytes squeezed from current sponge */
        return 1;
    }
    ctx->xof_state = XOF_STATE_SQUEEZE;
    if (ctx->bufsz != 0) {
        len = ctx->block_size - ctx->bufsz;
        if (outlen < len)
            len = outlen;
        memcpy(out, (char *)ctx->A + ctx->bufsz, len);
        out += len;
        outlen -= len;
        ctx->bufsz += len;
        if (ctx->bufsz == ctx->block_size)
            ctx->bufsz = 0;
    }
    if (outlen == 0)
        return 1;
    s390x_klmd(NULL, 0, out, outlen, ctx->pad | S390X_KLMD_PS, ctx->A);
    ctx->bufsz = outlen % ctx->block_size;

    return 1;
}

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

    if (!ossl_prov_is_running())
        return 0;
    if (!(ctx->xof_state == XOF_STATE_INIT ||
          ctx->xof_state == XOF_STATE_ABSORB))
        return 0;
    ctx->xof_state = XOF_STATE_FINAL;
    if (outlen == 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(out, ctx->A, num);
    needed -= num;
    if (needed > 0)
        s390x_klmd(NULL, 0, out + bsz, needed, ctx->pad | S390X_KLMD_PS, ctx->A);

    return 1;
}

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

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

static int s390x_keccakc_squeeze(void *vctx, unsigned char *out, size_t outlen,
                                 int padding)
{
    KECCAK1600_CTX *ctx = vctx;
    size_t len;

    if (!ossl_prov_is_running())
        return 0;
    if (ctx->xof_state == XOF_STATE_FINAL)
        return 0;
    /*
     * On the first squeeze call, finish the absorb process
     * by adding the trailing padding and then doing
     * a final absorb.
     */
    if (ctx->xof_state != XOF_STATE_SQUEEZE) {
        len = ctx->block_size - ctx->bufsz;
        memset(ctx->buf + ctx->bufsz, 0, len);
        ctx->buf[ctx->bufsz] = padding;
        ctx->buf[ctx->block_size - 1] |= 0x80;
        s390x_kimd(ctx->buf, ctx->block_size, ctx->pad, ctx->A);
        ctx->bufsz = 0;
        /* reuse ctx->bufsz to count bytes squeezed from current sponge */
    }
    if (ctx->bufsz != 0 || ctx->xof_state != XOF_STATE_SQUEEZE) {
        len = ctx->block_size - ctx->bufsz;
        if (outlen < len)
            len = outlen;
        memcpy(out, (char *)ctx->A + ctx->bufsz, len);
        out += len;
        outlen -= len;
        ctx->bufsz += len;
        if (ctx->bufsz == ctx->block_size)
            ctx->bufsz = 0;
    }
    ctx->xof_state = XOF_STATE_SQUEEZE;
    if (outlen == 0)
        return 1;
    s390x_klmd(NULL, 0, out, outlen, ctx->pad | S390X_KLMD_PS, ctx->A);
    ctx->bufsz = outlen % ctx->block_size;

    return 1;
}

static int s390x_keccak_squeeze(void *vctx, unsigned char *out, size_t outlen)
{
     return s390x_keccakc_squeeze(vctx, out, outlen, 0x01);
}

static int s390x_kmac_squeeze(void *vctx, unsigned char *out, size_t outlen)
{
     return s390x_keccakc_squeeze(vctx, out, outlen, 0x04);
}

static PROV_SHA3_METHOD sha3_s390x_md = {
    s390x_sha3_absorb,
    s390x_sha3_final,
    NULL,
};

static PROV_SHA3_METHOD keccak_s390x_md = {
    s390x_sha3_absorb,
    s390x_keccak_final,
    s390x_keccak_squeeze,
};

static PROV_SHA3_METHOD shake_s390x_md = {
    s390x_sha3_absorb,
    s390x_shake_final,
    s390x_shake_squeeze,
};

static PROV_SHA3_METHOD kmac_s390x_md = {
    s390x_sha3_absorb,
    s390x_kmac_final,
    s390x_kmac_squeeze,
};

# define SHAKE_SET_MD(uname, typ)                                              \
    if (S390_SHA3_CAPABLE(uname)) {                                            \
        ctx->pad = S390X_##uname;                                              \
        ctx->meth = typ##_s390x_md;                                            \
    } else {                                                                   \
        ctx->meth = shake_generic_md;                                          \
    }

# 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;                                           \
    }
#elif defined(__aarch64__) && defined(KECCAK1600_ASM)
# include "arm_arch.h"

static sha3_absorb_fn armsha3_sha3_absorb;

size_t SHA3_absorb_cext(uint64_t A[5][5], const unsigned char *inp, size_t len,
                        size_t r);
/*-
 * Hardware-assisted ARMv8.2 SHA3 extension version of the absorb()
 */
static size_t armsha3_sha3_absorb(void *vctx, const void *inp, size_t len)
{
    KECCAK1600_CTX *ctx = vctx;

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

static PROV_SHA3_METHOD sha3_ARMSHA3_md = {
    armsha3_sha3_absorb,
    generic_sha3_final
};
static PROV_SHA3_METHOD shake_ARMSHA3_md =
{
    armsha3_sha3_absorb,
    generic_sha3_final,
    generic_sha3_squeeze
};
# define SHAKE_SET_MD(uname, typ)                                              \
    if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) {                  \
        ctx->meth = shake_ARMSHA3_md;                                          \
    } else {                                                                   \
        ctx->meth = shake_generic_md;                                          \
    }

# define SHA3_SET_MD(uname, typ)                                               \
    if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) {                  \
        ctx->meth = sha3_ARMSHA3_md;                                           \
    } else {                                                                   \
        ctx->meth = sha3_generic_md;                                           \
    }
# define KMAC_SET_MD(bitlen)                                                   \
    if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) {                  \
        ctx->meth = sha3_ARMSHA3_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;
# define SHAKE_SET_MD(uname, typ) ctx->meth = shake_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 SHAKE_newctx(typ, uname, name, bitlen, mdlen, 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_keccak_init(ctx, pad, bitlen, mdlen);                                 \
    if (mdlen == 0)                                                            \
        ctx->md_size = SIZE_MAX;                                               \
    SHAKE_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_init(ctx, pad, bitlen, 2 * 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_SQUEEZE, (void (*)(void))shake_squeeze },               \
    { 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)                                      \
    SHAKE_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen,                \
                 0 /* no default md length */, '\x1f')                         \
    PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen,                             \
                          SHA3_BLOCKSIZE(bitlen), 0,                           \
                          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: 2024-07-27 06:36

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2019-2023 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/numbers.h"
18		#include "internal/sha3.h"
19		#include "prov/digestcommon.h"
20		#include "prov/implementations.h"
21
22		#define SHA3_FLAGS PROV_DIGEST_FLAG_ALGID_ABSENT
23		#define SHAKE_FLAGS PROV_DIGEST_FLAG_XOF
24		#define KMAC_FLAGS PROV_DIGEST_FLAG_XOF
25
26		/*
27		* Forward declaration of any unique methods implemented here. This is not strictly
28		* necessary for the compiler, but provides an assurance that the signatures
29		* of the functions in the dispatch table are correct.
30		*/
31		static OSSL_FUNC_digest_init_fn keccak_init;
32		static OSSL_FUNC_digest_init_fn keccak_init_params;
33		static OSSL_FUNC_digest_update_fn keccak_update;
34		static OSSL_FUNC_digest_final_fn keccak_final;
35		static OSSL_FUNC_digest_freectx_fn keccak_freectx;
36		static OSSL_FUNC_digest_dupctx_fn keccak_dupctx;
37		static OSSL_FUNC_digest_squeeze_fn shake_squeeze;
38		static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params;
39		static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params;
40		static sha3_absorb_fn generic_sha3_absorb;
41		static sha3_final_fn generic_sha3_final;
42		static sha3_squeeze_fn generic_sha3_squeeze;
43
44		#if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
45		/*
46		* IBM S390X support
47		*/
48		# include "s390x_arch.h"
49		# define S390_SHA3 1
50		# define S390_SHA3_CAPABLE(name) \
51		((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \
52		(OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name)))
53
54		#endif
55
56		static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[])
57	0	{
58	0	if (!ossl_prov_is_running())
59	0	return 0;
60		/* The newctx() handles most of the ctx fixed setup. */
61	0	ossl_sha3_reset((KECCAK1600_CTX *)vctx);
62	0	return 1;
63	0	}
64
65		static int keccak_init_params(void *vctx, const OSSL_PARAM params[])
66	0	{
67	0	return keccak_init(vctx, NULL)
68	0	&& shake_set_ctx_params(vctx, params);
69	0	}
70
71		static int keccak_update(void vctx, const unsigned char inp, size_t len)
72	0	{
73	0	KECCAK1600_CTX *ctx = vctx;
74	0	const size_t bsz = ctx->block_size;
75	0	size_t num, rem;
76
77	0	if (len == 0)
78	0	return 1;
79
80		/* Is there anything in the buffer already ? */
81	0	if ((num = ctx->bufsz) != 0) {
82		/* Calculate how much space is left in the buffer */
83	0	rem = bsz - num;
84		/* If the new input does not fill the buffer then just add it */
85	0	if (len < rem) {
86	0	memcpy(ctx->buf + num, inp, len);
87	0	ctx->bufsz += len;
88	0	return 1;
89	0	}
90		/* otherwise fill up the buffer and absorb the buffer */
91	0	memcpy(ctx->buf + num, inp, rem);
92		/* Update the input pointer */
93	0	inp += rem;
94	0	len -= rem;
95	0	ctx->meth.absorb(ctx, ctx->buf, bsz);
96	0	ctx->bufsz = 0;
97	0	}
98		/* Absorb the input - rem = leftover part of the input < blocksize) */
99	0	rem = ctx->meth.absorb(ctx, inp, len);
100		/* Copy the leftover bit of the input into the buffer */
101	0	if (rem) {
102	0	memcpy(ctx->buf, inp + len - rem, rem);
103	0	ctx->bufsz = rem;
104	0	}
105	0	return 1;
106	0	}
107
108		static int keccak_final(void vctx, unsigned char out, size_t *outl,
109		size_t outlen)
110	0	{
111	0	int ret = 1;
112	0	KECCAK1600_CTX *ctx = vctx;
113
114	0	if (!ossl_prov_is_running())
115	0	return 0;
116	0	if (ctx->md_size == SIZE_MAX) {
117	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_LENGTH);
118	0	return 0;
119	0	}
120	0	if (outlen > 0)
121	0	ret = ctx->meth.final(ctx, out, ctx->md_size);
122
123	0	*outl = ctx->md_size;
124	0	return ret;
125	0	}
126
127		static int shake_squeeze(void vctx, unsigned char out, size_t *outl,
128		size_t outlen)
129	0	{
130	0	int ret = 1;
131	0	KECCAK1600_CTX *ctx = vctx;
132
133	0	if (!ossl_prov_is_running())
134	0	return 0;
135	0	if (ctx->meth.squeeze == NULL)
136	0	return 0;
137	0	if (outlen > 0)
138	0	ret = ctx->meth.squeeze(ctx, out, outlen);
139
140	0	*outl = outlen;
141	0	return ret;
142	0	}
143
144		/*-
145		* Generic software version of the absorb() and final().
146		*/
147		static size_t generic_sha3_absorb(void vctx, const void inp, size_t len)
148	0	{
149	0	KECCAK1600_CTX *ctx = vctx;
150
151	0	if (!(ctx->xof_state == XOF_STATE_INIT \|\|
152	0	ctx->xof_state == XOF_STATE_ABSORB))
153	0	return 0;
154	0	ctx->xof_state = XOF_STATE_ABSORB;
155	0	return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
156	0	}
157
158		static int generic_sha3_final(void vctx, unsigned char out, size_t outlen)
159	0	{
160	0	return ossl_sha3_final((KECCAK1600_CTX *)vctx, out, outlen);
161	0	}
162
163		static int generic_sha3_squeeze(void vctx, unsigned char out, size_t outlen)
164	0	{
165	0	return ossl_sha3_squeeze((KECCAK1600_CTX *)vctx, out, outlen);
166	0	}
167
168		static PROV_SHA3_METHOD sha3_generic_md = {
169		generic_sha3_absorb,
170		generic_sha3_final,
171		NULL
172		};
173
174		static PROV_SHA3_METHOD shake_generic_md =
175		{
176		generic_sha3_absorb,
177		generic_sha3_final,
178		generic_sha3_squeeze
179		};
180
181		#if defined(S390_SHA3)
182
183		static sha3_absorb_fn s390x_sha3_absorb;
184		static sha3_final_fn s390x_sha3_final;
185		static sha3_final_fn s390x_shake_final;
186
187		/*-
188		* The platform specific parts of the absorb() and final() for S390X.
189		*/
190		static size_t s390x_sha3_absorb(void vctx, const void inp, size_t len)
191		{
192		KECCAK1600_CTX *ctx = vctx;
193		size_t rem = len % ctx->block_size;
194
195		if (!(ctx->xof_state == XOF_STATE_INIT \|\|
196		ctx->xof_state == XOF_STATE_ABSORB))
197		return 0;
198		ctx->xof_state = XOF_STATE_ABSORB;
199		s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
200		return rem;
201		}
202
203		static int s390x_sha3_final(void vctx, unsigned char out, size_t outlen)
204		{
205		KECCAK1600_CTX *ctx = vctx;
206
207		if (!ossl_prov_is_running())
208		return 0;
209		if (!(ctx->xof_state == XOF_STATE_INIT \|\|
210		ctx->xof_state == XOF_STATE_ABSORB))
211		return 0;
212		ctx->xof_state = XOF_STATE_FINAL;
213		s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
214		memcpy(out, ctx->A, outlen);
215		return 1;
216		}
217
218		static int s390x_shake_final(void vctx, unsigned char out, size_t outlen)
219		{
220		KECCAK1600_CTX *ctx = vctx;
221
222		if (!ossl_prov_is_running())
223		return 0;
224		if (!(ctx->xof_state == XOF_STATE_INIT \|\|
225		ctx->xof_state == XOF_STATE_ABSORB))
226		return 0;
227		ctx->xof_state = XOF_STATE_FINAL;
228		s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
229		return 1;
230		}
231
232		static int s390x_shake_squeeze(void vctx, unsigned char out, size_t outlen)
233		{
234		KECCAK1600_CTX *ctx = vctx;
235		size_t len;
236
237		if (!ossl_prov_is_running())
238		return 0;
239		if (ctx->xof_state == XOF_STATE_FINAL)
240		return 0;
241		/*
242		* On the first squeeze call, finish the absorb process (incl. padding).
243		*/
244		if (ctx->xof_state != XOF_STATE_SQUEEZE) {
245		ctx->xof_state = XOF_STATE_SQUEEZE;
246		s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
247		ctx->bufsz = outlen % ctx->block_size;
248		/* reuse ctx->bufsz to count bytes squeezed from current sponge */
249		return 1;
250		}
251		ctx->xof_state = XOF_STATE_SQUEEZE;
252		if (ctx->bufsz != 0) {
253		len = ctx->block_size - ctx->bufsz;
254		if (outlen < len)
255		len = outlen;
256		memcpy(out, (char *)ctx->A + ctx->bufsz, len);
257		out += len;
258		outlen -= len;
259		ctx->bufsz += len;
260		if (ctx->bufsz == ctx->block_size)
261		ctx->bufsz = 0;
262		}
263		if (outlen == 0)
264		return 1;
265		s390x_klmd(NULL, 0, out, outlen, ctx->pad \| S390X_KLMD_PS, ctx->A);
266		ctx->bufsz = outlen % ctx->block_size;
267
268		return 1;
269		}
270
271		static int s390x_keccakc_final(void vctx, unsigned char out, size_t outlen,
272		int padding)
273		{
274		KECCAK1600_CTX *ctx = vctx;
275		size_t bsz = ctx->block_size;
276		size_t num = ctx->bufsz;
277		size_t needed = outlen;
278
279		if (!ossl_prov_is_running())
280		return 0;
281		if (!(ctx->xof_state == XOF_STATE_INIT \|\|
282		ctx->xof_state == XOF_STATE_ABSORB))
283		return 0;
284		ctx->xof_state = XOF_STATE_FINAL;
285		if (outlen == 0)
286		return 1;
287		memset(ctx->buf + num, 0, bsz - num);
288		ctx->buf[num] = padding;
289		ctx->buf[bsz - 1] \|= 0x80;
290		s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
291		num = needed > bsz ? bsz : needed;
292		memcpy(out, ctx->A, num);
293		needed -= num;
294		if (needed > 0)
295		s390x_klmd(NULL, 0, out + bsz, needed, ctx->pad \| S390X_KLMD_PS, ctx->A);
296
297		return 1;
298		}
299
300		static int s390x_keccak_final(void vctx, unsigned char out, size_t outlen)
301		{
302		return s390x_keccakc_final(vctx, out, outlen, 0x01);
303		}
304
305		static int s390x_kmac_final(void vctx, unsigned char out, size_t outlen)
306		{
307		return s390x_keccakc_final(vctx, out, outlen, 0x04);
308		}
309
310		static int s390x_keccakc_squeeze(void vctx, unsigned char out, size_t outlen,
311		int padding)
312		{
313		KECCAK1600_CTX *ctx = vctx;
314		size_t len;
315
316		if (!ossl_prov_is_running())
317		return 0;
318		if (ctx->xof_state == XOF_STATE_FINAL)
319		return 0;
320		/*
321		* On the first squeeze call, finish the absorb process
322		* by adding the trailing padding and then doing
323		* a final absorb.
324		*/
325		if (ctx->xof_state != XOF_STATE_SQUEEZE) {
326		len = ctx->block_size - ctx->bufsz;
327		memset(ctx->buf + ctx->bufsz, 0, len);
328		ctx->buf[ctx->bufsz] = padding;
329		ctx->buf[ctx->block_size - 1] \|= 0x80;
330		s390x_kimd(ctx->buf, ctx->block_size, ctx->pad, ctx->A);
331		ctx->bufsz = 0;
332		/* reuse ctx->bufsz to count bytes squeezed from current sponge */
333		}
334		if (ctx->bufsz != 0 \|\| ctx->xof_state != XOF_STATE_SQUEEZE) {
335		len = ctx->block_size - ctx->bufsz;
336		if (outlen < len)
337		len = outlen;
338		memcpy(out, (char *)ctx->A + ctx->bufsz, len);
339		out += len;
340		outlen -= len;
341		ctx->bufsz += len;
342		if (ctx->bufsz == ctx->block_size)
343		ctx->bufsz = 0;
344		}
345		ctx->xof_state = XOF_STATE_SQUEEZE;
346		if (outlen == 0)
347		return 1;
348		s390x_klmd(NULL, 0, out, outlen, ctx->pad \| S390X_KLMD_PS, ctx->A);
349		ctx->bufsz = outlen % ctx->block_size;
350
351		return 1;
352		}
353
354		static int s390x_keccak_squeeze(void vctx, unsigned char out, size_t outlen)
355		{
356		return s390x_keccakc_squeeze(vctx, out, outlen, 0x01);
357		}
358
359		static int s390x_kmac_squeeze(void vctx, unsigned char out, size_t outlen)
360		{
361		return s390x_keccakc_squeeze(vctx, out, outlen, 0x04);
362		}
363
364		static PROV_SHA3_METHOD sha3_s390x_md = {
365		s390x_sha3_absorb,
366		s390x_sha3_final,
367		NULL,
368		};
369
370		static PROV_SHA3_METHOD keccak_s390x_md = {
371		s390x_sha3_absorb,
372		s390x_keccak_final,
373		s390x_keccak_squeeze,
374		};
375
376		static PROV_SHA3_METHOD shake_s390x_md = {
377		s390x_sha3_absorb,
378		s390x_shake_final,
379		s390x_shake_squeeze,
380		};
381
382		static PROV_SHA3_METHOD kmac_s390x_md = {
383		s390x_sha3_absorb,
384		s390x_kmac_final,
385		s390x_kmac_squeeze,
386		};
387
388		# define SHAKE_SET_MD(uname, typ) \
389		if (S390_SHA3_CAPABLE(uname)) { \
390		ctx->pad = S390X_##uname; \
391		ctx->meth = typ##_s390x_md; \
392		} else { \
393		ctx->meth = shake_generic_md; \
394		}
395
396		# define SHA3_SET_MD(uname, typ) \
397		if (S390_SHA3_CAPABLE(uname)) { \
398		ctx->pad = S390X_##uname; \
399		ctx->meth = typ##_s390x_md; \
400		} else { \
401		ctx->meth = sha3_generic_md; \
402		}
403		# define KMAC_SET_MD(bitlen) \
404		if (S390_SHA3_CAPABLE(SHAKE_##bitlen)) { \
405		ctx->pad = S390X_SHAKE_##bitlen; \
406		ctx->meth = kmac_s390x_md; \
407		} else { \
408		ctx->meth = sha3_generic_md; \
409		}
410		#elif defined(__aarch64__) && defined(KECCAK1600_ASM)
411		# include "arm_arch.h"
412
413		static sha3_absorb_fn armsha3_sha3_absorb;
414
415		size_t SHA3_absorb_cext(uint64_t A[5][5], const unsigned char *inp, size_t len,
416		size_t r);
417		/*-
418		* Hardware-assisted ARMv8.2 SHA3 extension version of the absorb()
419		*/
420		static size_t armsha3_sha3_absorb(void vctx, const void inp, size_t len)
421		{
422		KECCAK1600_CTX *ctx = vctx;
423
424		return SHA3_absorb_cext(ctx->A, inp, len, ctx->block_size);
425		}
426
427		static PROV_SHA3_METHOD sha3_ARMSHA3_md = {
428		armsha3_sha3_absorb,
429		generic_sha3_final
430		};
431		static PROV_SHA3_METHOD shake_ARMSHA3_md =
432		{
433		armsha3_sha3_absorb,
434		generic_sha3_final,
435		generic_sha3_squeeze
436		};
437		# define SHAKE_SET_MD(uname, typ) \
438		if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
439		ctx->meth = shake_ARMSHA3_md; \
440		} else { \
441		ctx->meth = shake_generic_md; \
442		}
443
444		# define SHA3_SET_MD(uname, typ) \
445		if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
446		ctx->meth = sha3_ARMSHA3_md; \
447		} else { \
448		ctx->meth = sha3_generic_md; \
449		}
450		# define KMAC_SET_MD(bitlen) \
451		if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
452		ctx->meth = sha3_ARMSHA3_md; \
453		} else { \
454		ctx->meth = sha3_generic_md; \
455		}
456		#else
457	0	# define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
458	0	# define KMAC_SET_MD(bitlen) ctx->meth = sha3_generic_md;
459	0	# define SHAKE_SET_MD(uname, typ) ctx->meth = shake_generic_md;
460		#endif /* S390_SHA3 */
461
462		#define SHA3_newctx(typ, uname, name, bitlen, pad) \
463		static OSSL_FUNC_digest_newctx_fn name##_newctx; \
464	0	static void name##_newctx(void provctx) \
465	0	{ \
466	0	KECCAK1600_CTX ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(ctx)) \
467	0	: NULL; \
468	0	\
469	0	if (ctx == NULL) \
470	0	return NULL; \
471	0	ossl_sha3_init(ctx, pad, bitlen); \
472	0	SHA3_SET_MD(uname, typ) \
473	0	return ctx; \
474	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
475
476		#define SHAKE_newctx(typ, uname, name, bitlen, mdlen, pad) \
477		static OSSL_FUNC_digest_newctx_fn name##_newctx; \
478	0	static void name##_newctx(void provctx) \
479	0	{ \
480	0	KECCAK1600_CTX ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(ctx))\
481	0	: NULL; \
482	0	\
483	0	if (ctx == NULL) \
484	0	return NULL; \
485	0	ossl_keccak_init(ctx, pad, bitlen, mdlen); \
486	0	if (mdlen == 0) \
487	0	ctx->md_size = SIZE_MAX; \
488	0	SHAKE_SET_MD(uname, typ) \
489	0	return ctx; \
490	0	} Unexecuted instantiation: sha3_prov.c:shake_128_newctx Unexecuted instantiation: sha3_prov.c:shake_256_newctx
491
492		#define KMAC_newctx(uname, bitlen, pad) \
493		static OSSL_FUNC_digest_newctx_fn uname##_newctx; \
494	0	static void uname##_newctx(void provctx) \
495	0	{ \
496	0	KECCAK1600_CTX ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(ctx)) \
497	0	: NULL; \
498	0	\
499	0	if (ctx == NULL) \
500	0	return NULL; \
501	0	ossl_keccak_init(ctx, pad, bitlen, 2 * bitlen); \
502	0	KMAC_SET_MD(bitlen) \
503	0	return ctx; \
504	0	} Unexecuted instantiation: sha3_prov.c:keccak_kmac_128_newctx Unexecuted instantiation: sha3_prov.c:keccak_kmac_256_newctx
505
506		#define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \
507		PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \
508		const OSSL_DISPATCH ossl_##name##_functions[] = { \
509		{ OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \
510		{ OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \
511		{ OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \
512		{ OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \
513		{ OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \
514		PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
515
516		#define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \
517		PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
518		{ OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \
519		PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
520
521		#define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \
522		PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
523		{ OSSL_FUNC_DIGEST_SQUEEZE, (void (*)(void))shake_squeeze }, \
524		{ OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params }, \
525		{ OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
526		{ OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \
527		(void (*)(void))shake_settable_ctx_params }, \
528		PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
529
530		static void keccak_freectx(void *vctx)
531	0	{
532	0	KECCAK1600_CTX ctx = (KECCAK1600_CTX )vctx;
533
534	0	OPENSSL_clear_free(ctx, sizeof(*ctx));
535	0	}
536
537		static void keccak_dupctx(void ctx)
538	0	{
539	0	KECCAK1600_CTX in = (KECCAK1600_CTX )ctx;
540	0	KECCAK1600_CTX ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(ret))
541	0	: NULL;
542
543	0	if (ret != NULL)
544	0	ret = in;
545	0	return ret;
546	0	}
547
548		static const OSSL_PARAM known_shake_settable_ctx_params[] = {
549		{OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
550		OSSL_PARAM_END
551		};
552		static const OSSL_PARAM shake_settable_ctx_params(ossl_unused void ctx,
553		ossl_unused void *provctx)
554	0	{
555	0	return known_shake_settable_ctx_params;
556	0	}
557
558		static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
559	0	{
560	0	const OSSL_PARAM *p;
561	0	KECCAK1600_CTX ctx = (KECCAK1600_CTX )vctx;
562
563	0	if (ctx == NULL)
564	0	return 0;
565	0	if (params == NULL)
566	0	return 1;
567
568	0	p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
569	0	if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
570	0	ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
571	0	return 0;
572	0	}
573	0	return 1;
574	0	}
575
576		#define IMPLEMENT_SHA3_functions(bitlen) \
577		SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \
578		PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \
579		SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
580		SHA3_FLAGS)
581
582		#define IMPLEMENT_KECCAK_functions(bitlen) \
583		SHA3_newctx(keccak, KECCAK_##bitlen, keccak_##bitlen, bitlen, '\x01') \
584		PROV_FUNC_SHA3_DIGEST(keccak_##bitlen, bitlen, \
585		SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
586		SHA3_FLAGS)
587
588		#define IMPLEMENT_SHAKE_functions(bitlen) \
589		SHAKE_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, \
590		0 /* no default md length */, '\x1f') \
591		PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \
592		SHA3_BLOCKSIZE(bitlen), 0, \
593		SHAKE_FLAGS)
594
595		#define IMPLEMENT_KMAC_functions(bitlen) \
596		KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \
597		PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \
598		SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \
599		KMAC_FLAGS)
600
601		/* ossl_sha3_224_functions */
602		IMPLEMENT_SHA3_functions(224)
603		/* ossl_sha3_256_functions */
604		IMPLEMENT_SHA3_functions(256)
605		/* ossl_sha3_384_functions */
606		IMPLEMENT_SHA3_functions(384)
607		/* ossl_sha3_512_functions */
608		IMPLEMENT_SHA3_functions(512)
609		/* ossl_keccak_224_functions */
610		IMPLEMENT_KECCAK_functions(224)
611		/* ossl_keccak_256_functions */
612		IMPLEMENT_KECCAK_functions(256)
613		/* ossl_keccak_384_functions */
614		IMPLEMENT_KECCAK_functions(384)
615		/* ossl_keccak_512_functions */
616		IMPLEMENT_KECCAK_functions(512)
617		/* ossl_shake_128_functions */
618		IMPLEMENT_SHAKE_functions(128)
619		/* ossl_shake_256_functions */
620		IMPLEMENT_SHAKE_functions(256)
621		/* ossl_keccak_kmac_128_functions */
622		IMPLEMENT_KMAC_functions(128)
623		/* ossl_keccak_kmac_256_functions */
624		IMPLEMENT_KMAC_functions(256)