/src/openssl31/providers/implementations/kdfs/sskdf.c

Source (jump to first uncovered line)
/*
 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
 * Copyright (c) 2019, Oracle and/or its affiliates.  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
 */

/*
 * Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
 * Section 4.1.
 *
 * The Single Step KDF algorithm is given by:
 *
 * Result(0) = empty bit string (i.e., the null string).
 * For i = 1 to reps, do the following:
 *   Increment counter by 1.
 *   Result(i) = Result(i - 1) || H(counter || Z || FixedInfo).
 * DKM = LeftmostBits(Result(reps), L))
 *
 * NOTES:
 *   Z is a shared secret required to produce the derived key material.
 *   counter is a 4 byte buffer.
 *   FixedInfo is a bit string containing context specific data.
 *   DKM is the output derived key material.
 *   L is the required size of the DKM.
 *   reps = [L / H_outputBits]
 *   H(x) is the auxiliary function that can be either a hash, HMAC or KMAC.
 *   H_outputBits is the length of the output of the auxiliary function H(x).
 *
 * Currently there is not a comprehensive list of test vectors for this
 * algorithm, especially for H(x) = HMAC and H(x) = KMAC.
 * Test vectors for H(x) = Hash are indirectly used by CAVS KAS tests.
 */
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <openssl/hmac.h>
#include <openssl/evp.h>
#include <openssl/kdf.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/proverr.h>
#include "internal/cryptlib.h"
#include "internal/numbers.h"
#include "crypto/evp.h"
#include "prov/provider_ctx.h"
#include "prov/providercommon.h"
#include "prov/implementations.h"
#include "prov/provider_util.h"

typedef struct {
    void *provctx;
    EVP_MAC_CTX *macctx;         /* H(x) = HMAC_hash OR H(x) = KMAC */
    PROV_DIGEST digest;          /* H(x) = hash(x) */
    unsigned char *secret;
    size_t secret_len;
    unsigned char *info;
    size_t info_len;
    unsigned char *salt;
    size_t salt_len;
    size_t out_len; /* optional KMAC parameter */
    int is_kmac;
} KDF_SSKDF;

#define SSKDF_MAX_INLEN (1<<30)
#define SSKDF_KMAC128_DEFAULT_SALT_SIZE (168 - 4)
#define SSKDF_KMAC256_DEFAULT_SALT_SIZE (136 - 4)

/* KMAC uses a Customisation string of 'KDF' */
static const unsigned char kmac_custom_str[] = { 0x4B, 0x44, 0x46 };

static OSSL_FUNC_kdf_newctx_fn sskdf_new;
static OSSL_FUNC_kdf_dupctx_fn sskdf_dup;
static OSSL_FUNC_kdf_freectx_fn sskdf_free;
static OSSL_FUNC_kdf_reset_fn sskdf_reset;
static OSSL_FUNC_kdf_derive_fn sskdf_derive;
static OSSL_FUNC_kdf_derive_fn x963kdf_derive;
static OSSL_FUNC_kdf_settable_ctx_params_fn sskdf_settable_ctx_params;
static OSSL_FUNC_kdf_set_ctx_params_fn sskdf_set_ctx_params;
static OSSL_FUNC_kdf_gettable_ctx_params_fn sskdf_gettable_ctx_params;
static OSSL_FUNC_kdf_get_ctx_params_fn sskdf_get_ctx_params;

/*
 * Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
 * Section 4. One-Step Key Derivation using H(x) = hash(x)
 * Note: X9.63 also uses this code with the only difference being that the
 * counter is appended to the secret 'z'.
 * i.e.
 *   result[i] = Hash(counter || z || info) for One Step OR
 *   result[i] = Hash(z || counter || info) for X9.63.
 */
static int SSKDF_hash_kdm(const EVP_MD *kdf_md,
                          const unsigned char *z, size_t z_len,
                          const unsigned char *info, size_t info_len,
                          unsigned int append_ctr,
                          unsigned char *derived_key, size_t derived_key_len)
{
    int ret = 0, hlen;
    size_t counter, out_len, len = derived_key_len;
    unsigned char c[4];
    unsigned char mac[EVP_MAX_MD_SIZE];
    unsigned char *out = derived_key;
    EVP_MD_CTX *ctx = NULL, *ctx_init = NULL;

    if (z_len > SSKDF_MAX_INLEN || info_len > SSKDF_MAX_INLEN
            || derived_key_len > SSKDF_MAX_INLEN
            || derived_key_len == 0)
        return 0;

    hlen = EVP_MD_get_size(kdf_md);
    if (hlen <= 0)
        return 0;
    out_len = (size_t)hlen;

    ctx = EVP_MD_CTX_create();
    ctx_init = EVP_MD_CTX_create();
    if (ctx == NULL || ctx_init == NULL)
        goto end;

    if (!EVP_DigestInit(ctx_init, kdf_md))
        goto end;

    for (counter = 1;; counter++) {
        c[0] = (unsigned char)((counter >> 24) & 0xff);
        c[1] = (unsigned char)((counter >> 16) & 0xff);
        c[2] = (unsigned char)((counter >> 8) & 0xff);
        c[3] = (unsigned char)(counter & 0xff);

        if (!(EVP_MD_CTX_copy_ex(ctx, ctx_init)
                && (append_ctr || EVP_DigestUpdate(ctx, c, sizeof(c)))
                && EVP_DigestUpdate(ctx, z, z_len)
                && (!append_ctr || EVP_DigestUpdate(ctx, c, sizeof(c)))
                && EVP_DigestUpdate(ctx, info, info_len)))
            goto end;
        if (len >= out_len) {
            if (!EVP_DigestFinal_ex(ctx, out, NULL))
                goto end;
            out += out_len;
            len -= out_len;
            if (len == 0)
                break;
        } else {
            if (!EVP_DigestFinal_ex(ctx, mac, NULL))
                goto end;
            memcpy(out, mac, len);
            break;
        }
    }
    ret = 1;
end:
    EVP_MD_CTX_destroy(ctx);
    EVP_MD_CTX_destroy(ctx_init);
    OPENSSL_cleanse(mac, sizeof(mac));
    return ret;
}

static int kmac_init(EVP_MAC_CTX *ctx, const unsigned char *custom,
                     size_t custom_len, size_t kmac_out_len,
                     size_t derived_key_len, unsigned char **out)
{
    OSSL_PARAM params[2];

    /* Only KMAC has custom data - so return if not KMAC */
    if (custom == NULL)
        return 1;

    params[0] = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_CUSTOM,
                                                  (void *)custom, custom_len);
    params[1] = OSSL_PARAM_construct_end();

    if (!EVP_MAC_CTX_set_params(ctx, params))
        return 0;

    /* By default only do one iteration if kmac_out_len is not specified */
    if (kmac_out_len == 0)
        kmac_out_len = derived_key_len;
    /* otherwise check the size is valid */
    else if (!(kmac_out_len == derived_key_len
            || kmac_out_len == 20
            || kmac_out_len == 28
            || kmac_out_len == 32
            || kmac_out_len == 48
            || kmac_out_len == 64))
        return 0;

    params[0] = OSSL_PARAM_construct_size_t(OSSL_MAC_PARAM_SIZE,
                                            &kmac_out_len);

    if (EVP_MAC_CTX_set_params(ctx, params) <= 0)
        return 0;

    /*
     * For kmac the output buffer can be larger than EVP_MAX_MD_SIZE: so
     * alloc a buffer for this case.
     */
    if (kmac_out_len > EVP_MAX_MD_SIZE) {
        *out = OPENSSL_zalloc(kmac_out_len);
        if (*out == NULL)
            return 0;
    }
    return 1;
}

/*
 * Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
 * Section 4. One-Step Key Derivation using MAC: i.e either
 *     H(x) = HMAC-hash(salt, x) OR
 *     H(x) = KMAC#(salt, x, outbits, CustomString='KDF')
 */
static int SSKDF_mac_kdm(EVP_MAC_CTX *ctx_init,
                         const unsigned char *kmac_custom,
                         size_t kmac_custom_len, size_t kmac_out_len,
                         const unsigned char *salt, size_t salt_len,
                         const unsigned char *z, size_t z_len,
                         const unsigned char *info, size_t info_len,
                         unsigned char *derived_key, size_t derived_key_len)
{
    int ret = 0;
    size_t counter, out_len, len;
    unsigned char c[4];
    unsigned char mac_buf[EVP_MAX_MD_SIZE];
    unsigned char *out = derived_key;
    EVP_MAC_CTX *ctx = NULL;
    unsigned char *mac = mac_buf, *kmac_buffer = NULL;

    if (z_len > SSKDF_MAX_INLEN || info_len > SSKDF_MAX_INLEN
            || derived_key_len > SSKDF_MAX_INLEN
            || derived_key_len == 0)
        return 0;

    if (!kmac_init(ctx_init, kmac_custom, kmac_custom_len, kmac_out_len,
                   derived_key_len, &kmac_buffer))
        goto end;
    if (kmac_buffer != NULL)
        mac = kmac_buffer;

    if (!EVP_MAC_init(ctx_init, salt, salt_len, NULL))
        goto end;

    out_len = EVP_MAC_CTX_get_mac_size(ctx_init); /* output size */
    if (out_len <= 0 || (mac == mac_buf && out_len > sizeof(mac_buf)))
        goto end;
    len = derived_key_len;

    for (counter = 1;; counter++) {
        c[0] = (unsigned char)((counter >> 24) & 0xff);
        c[1] = (unsigned char)((counter >> 16) & 0xff);
        c[2] = (unsigned char)((counter >> 8) & 0xff);
        c[3] = (unsigned char)(counter & 0xff);

        ctx = EVP_MAC_CTX_dup(ctx_init);
        if (!(ctx != NULL
                && EVP_MAC_update(ctx, c, sizeof(c))
                && EVP_MAC_update(ctx, z, z_len)
                && EVP_MAC_update(ctx, info, info_len)))
            goto end;
        if (len >= out_len) {
            if (!EVP_MAC_final(ctx, out, NULL, len))
                goto end;
            out += out_len;
            len -= out_len;
            if (len == 0)
                break;
        } else {
            if (!EVP_MAC_final(ctx, mac, NULL, out_len))
                goto end;
            memcpy(out, mac, len);
            break;
        }
        EVP_MAC_CTX_free(ctx);
        ctx = NULL;
    }
    ret = 1;
end:
    if (kmac_buffer != NULL)
        OPENSSL_clear_free(kmac_buffer, kmac_out_len);
    else
        OPENSSL_cleanse(mac_buf, sizeof(mac_buf));

    EVP_MAC_CTX_free(ctx);
    return ret;
}

static void *sskdf_new(void *provctx)
{
    KDF_SSKDF *ctx;

    if (!ossl_prov_is_running())
        return NULL;

    if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
        ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
    ctx->provctx = provctx;
    return ctx;
}

static void sskdf_reset(void *vctx)
{
    KDF_SSKDF *ctx = (KDF_SSKDF *)vctx;
    void *provctx = ctx->provctx;

    EVP_MAC_CTX_free(ctx->macctx);
    ossl_prov_digest_reset(&ctx->digest);
    OPENSSL_clear_free(ctx->secret, ctx->secret_len);
    OPENSSL_clear_free(ctx->info, ctx->info_len);
    OPENSSL_clear_free(ctx->salt, ctx->salt_len);
    memset(ctx, 0, sizeof(*ctx));
    ctx->provctx = provctx;
}

static void sskdf_free(void *vctx)
{
    KDF_SSKDF *ctx = (KDF_SSKDF *)vctx;

    if (ctx != NULL) {
        sskdf_reset(ctx);
        OPENSSL_free(ctx);
    }
}

static void *sskdf_dup(void *vctx)
{
    const KDF_SSKDF *src = (const KDF_SSKDF *)vctx;
    KDF_SSKDF *dest;

    dest = sskdf_new(src->provctx);
    if (dest != NULL) {
        if (src->macctx != NULL) {
            dest->macctx = EVP_MAC_CTX_dup(src->macctx);
            if (dest->macctx == NULL)
                goto err;
        }
        if (!ossl_prov_memdup(src->info, src->info_len,
                              &dest->info, &dest->info_len)
                || !ossl_prov_memdup(src->salt, src->salt_len,
                                     &dest->salt , &dest->salt_len)
                || !ossl_prov_memdup(src->secret, src->secret_len,
                                     &dest->secret, &dest->secret_len)
                || !ossl_prov_digest_copy(&dest->digest, &src->digest))
            goto err;
        dest->out_len = src->out_len;
        dest->is_kmac = src->is_kmac;
    }
    return dest;

 err:
    sskdf_free(dest);
    return NULL;
}

static int sskdf_set_buffer(unsigned char **out, size_t *out_len,
                            const OSSL_PARAM *p)
{
    if (p->data == NULL || p->data_size == 0)
        return 1;
    OPENSSL_free(*out);
    *out = NULL;
    return OSSL_PARAM_get_octet_string(p, (void **)out, 0, out_len);
}

static size_t sskdf_size(KDF_SSKDF *ctx)
{
    int len;
    const EVP_MD *md = NULL;

    if (ctx->is_kmac)
        return SIZE_MAX;

    md = ossl_prov_digest_md(&ctx->digest);
    if (md == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
        return 0;
    }
    len = EVP_MD_get_size(md);
    return (len <= 0) ? 0 : (size_t)len;
}

static int sskdf_derive(void *vctx, unsigned char *key, size_t keylen,
                        const OSSL_PARAM params[])
{
    KDF_SSKDF *ctx = (KDF_SSKDF *)vctx;
    const EVP_MD *md;

    if (!ossl_prov_is_running() || !sskdf_set_ctx_params(ctx, params))
        return 0;
    if (ctx->secret == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
        return 0;
    }
    md = ossl_prov_digest_md(&ctx->digest);

    if (ctx->macctx != NULL) {
        /* H(x) = KMAC or H(x) = HMAC */
        int ret;
        const unsigned char *custom = NULL;
        size_t custom_len = 0;
        int default_salt_len;
        EVP_MAC *mac = EVP_MAC_CTX_get0_mac(ctx->macctx);

        if (EVP_MAC_is_a(mac, OSSL_MAC_NAME_HMAC)) {
            /* H(x) = HMAC(x, salt, hash) */
            if (md == NULL) {
                ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
                return 0;
            }
            default_salt_len = EVP_MD_get_size(md);
            if (default_salt_len <= 0)
                return 0;
        } else if (ctx->is_kmac) {
            /* H(x) = KMACzzz(x, salt, custom) */
            custom = kmac_custom_str;
            custom_len = sizeof(kmac_custom_str);
            if (EVP_MAC_is_a(mac, OSSL_MAC_NAME_KMAC128))
                default_salt_len = SSKDF_KMAC128_DEFAULT_SALT_SIZE;
            else
                default_salt_len = SSKDF_KMAC256_DEFAULT_SALT_SIZE;
        } else {
            ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_MAC_TYPE);
            return 0;
        }
        /* If no salt is set then use a default_salt of zeros */
        if (ctx->salt == NULL || ctx->salt_len <= 0) {
            ctx->salt = OPENSSL_zalloc(default_salt_len);
            if (ctx->salt == NULL) {
                ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
                return 0;
            }
            ctx->salt_len = default_salt_len;
        }
        ret = SSKDF_mac_kdm(ctx->macctx,
                            custom, custom_len, ctx->out_len,
                            ctx->salt, ctx->salt_len,
                            ctx->secret, ctx->secret_len,
                            ctx->info, ctx->info_len, key, keylen);
        return ret;
    } else {
        /* H(x) = hash */
        if (md == NULL) {
            ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
            return 0;
        }
        return SSKDF_hash_kdm(md, ctx->secret, ctx->secret_len,
                              ctx->info, ctx->info_len, 0, key, keylen);
    }
}

static int x963kdf_derive(void *vctx, unsigned char *key, size_t keylen,
                          const OSSL_PARAM params[])
{
    KDF_SSKDF *ctx = (KDF_SSKDF *)vctx;
    const EVP_MD *md;

    if (!ossl_prov_is_running() || !sskdf_set_ctx_params(ctx, params))
        return 0;

    if (ctx->secret == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
        return 0;
    }

    if (ctx->macctx != NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_NOT_SUPPORTED);
        return 0;
    }

    /* H(x) = hash */
    md = ossl_prov_digest_md(&ctx->digest);
    if (md == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
        return 0;
    }

    return SSKDF_hash_kdm(md, ctx->secret, ctx->secret_len,
                          ctx->info, ctx->info_len, 1, key, keylen);
}

static int sskdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    const OSSL_PARAM *p;
    KDF_SSKDF *ctx = vctx;
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
    size_t sz;

    if (params == NULL)
        return 1;

    if (!ossl_prov_macctx_load_from_params(&ctx->macctx, params,
                                           NULL, NULL, NULL, libctx))
        return 0;
   if (ctx->macctx != NULL) {
        if (EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->macctx),
                         OSSL_MAC_NAME_KMAC128)
            || EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->macctx),
                            OSSL_MAC_NAME_KMAC256)) {
            ctx->is_kmac = 1;
        }
   }

   if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
       return 0;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SECRET)) != NULL
        || (p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL)
        if (!sskdf_set_buffer(&ctx->secret, &ctx->secret_len, p))
            return 0;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO)) != NULL)
        if (!sskdf_set_buffer(&ctx->info, &ctx->info_len, p))
            return 0;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL)
        if (!sskdf_set_buffer(&ctx->salt, &ctx->salt_len, p))
            return 0;

    if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MAC_SIZE))
        != NULL) {
        if (!OSSL_PARAM_get_size_t(p, &sz) || sz == 0)
            return 0;
        ctx->out_len = sz;
    }
    return 1;
}

static const OSSL_PARAM *sskdf_settable_ctx_params(ossl_unused void *ctx,
                                                   ossl_unused void *provctx)
{
    static const OSSL_PARAM known_settable_ctx_params[] = {
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SECRET, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
        OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
        OSSL_PARAM_size_t(OSSL_KDF_PARAM_MAC_SIZE, NULL),
        OSSL_PARAM_END
    };
    return known_settable_ctx_params;
}

static int sskdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
{
    KDF_SSKDF *ctx = (KDF_SSKDF *)vctx;
    OSSL_PARAM *p;

    if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
        return OSSL_PARAM_set_size_t(p, sskdf_size(ctx));
    return -2;
}

static const OSSL_PARAM *sskdf_gettable_ctx_params(ossl_unused void *ctx,
                                                   ossl_unused void *provctx)
{
    static const OSSL_PARAM known_gettable_ctx_params[] = {
        OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
        OSSL_PARAM_END
    };
    return known_gettable_ctx_params;
}

const OSSL_DISPATCH ossl_kdf_sskdf_functions[] = {
    { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))sskdf_new },
    { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))sskdf_dup },
    { OSSL_FUNC_KDF_FREECTX, (void(*)(void))sskdf_free },
    { OSSL_FUNC_KDF_RESET, (void(*)(void))sskdf_reset },
    { OSSL_FUNC_KDF_DERIVE, (void(*)(void))sskdf_derive },
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
      (void(*)(void))sskdf_settable_ctx_params },
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))sskdf_set_ctx_params },
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
      (void(*)(void))sskdf_gettable_ctx_params },
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))sskdf_get_ctx_params },
    { 0, NULL }
};

const OSSL_DISPATCH ossl_kdf_x963_kdf_functions[] = {
    { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))sskdf_new },
    { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))sskdf_dup },
    { OSSL_FUNC_KDF_FREECTX, (void(*)(void))sskdf_free },
    { OSSL_FUNC_KDF_RESET, (void(*)(void))sskdf_reset },
    { OSSL_FUNC_KDF_DERIVE, (void(*)(void))x963kdf_derive },
    { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
      (void(*)(void))sskdf_settable_ctx_params },
    { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))sskdf_set_ctx_params },
    { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
      (void(*)(void))sskdf_gettable_ctx_params },
    { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))sskdf_get_ctx_params },
    { 0, NULL }
};

Coverage Report

Created: 2024-07-27 06:39

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
3		* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
4		*
5		* Licensed under the Apache License 2.0 (the "License"). You may not use
6		* this file except in compliance with the License. You can obtain a copy
7		* in the file LICENSE in the source distribution or at
8		* https://www.openssl.org/source/license.html
9		*/
10
11		/*
12		* Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
13		* Section 4.1.
14		*
15		* The Single Step KDF algorithm is given by:
16		*
17		* Result(0) = empty bit string (i.e., the null string).
18		* For i = 1 to reps, do the following:
19		* Increment counter by 1.
20		* Result(i) = Result(i - 1) \|\| H(counter \|\| Z \|\| FixedInfo).
21		* DKM = LeftmostBits(Result(reps), L))
22		*
23		* NOTES:
24		* Z is a shared secret required to produce the derived key material.
25		* counter is a 4 byte buffer.
26		* FixedInfo is a bit string containing context specific data.
27		* DKM is the output derived key material.
28		* L is the required size of the DKM.
29		* reps = [L / H_outputBits]
30		* H(x) is the auxiliary function that can be either a hash, HMAC or KMAC.
31		* H_outputBits is the length of the output of the auxiliary function H(x).
32		*
33		* Currently there is not a comprehensive list of test vectors for this
34		* algorithm, especially for H(x) = HMAC and H(x) = KMAC.
35		* Test vectors for H(x) = Hash are indirectly used by CAVS KAS tests.
36		*/
37		#include <stdlib.h>
38		#include <stdarg.h>
39		#include <string.h>
40		#include <openssl/hmac.h>
41		#include <openssl/evp.h>
42		#include <openssl/kdf.h>
43		#include <openssl/core_names.h>
44		#include <openssl/params.h>
45		#include <openssl/proverr.h>
46		#include "internal/cryptlib.h"
47		#include "internal/numbers.h"
48		#include "crypto/evp.h"
49		#include "prov/provider_ctx.h"
50		#include "prov/providercommon.h"
51		#include "prov/implementations.h"
52		#include "prov/provider_util.h"
53
54		typedef struct {
55		void *provctx;
56		EVP_MAC_CTX macctx; / H(x) = HMAC_hash OR H(x) = KMAC */
57		PROV_DIGEST digest; /* H(x) = hash(x) */
58		unsigned char *secret;
59		size_t secret_len;
60		unsigned char *info;
61		size_t info_len;
62		unsigned char *salt;
63		size_t salt_len;
64		size_t out_len; /* optional KMAC parameter */
65		int is_kmac;
66		} KDF_SSKDF;
67
68	144	#define SSKDF_MAX_INLEN (1<<30)
69	4	#define SSKDF_KMAC128_DEFAULT_SALT_SIZE (168 - 4)
70	6	#define SSKDF_KMAC256_DEFAULT_SALT_SIZE (136 - 4)
71
72		/* KMAC uses a Customisation string of 'KDF' */
73		static const unsigned char kmac_custom_str[] = { 0x4B, 0x44, 0x46 };
74
75		static OSSL_FUNC_kdf_newctx_fn sskdf_new;
76		static OSSL_FUNC_kdf_dupctx_fn sskdf_dup;
77		static OSSL_FUNC_kdf_freectx_fn sskdf_free;
78		static OSSL_FUNC_kdf_reset_fn sskdf_reset;
79		static OSSL_FUNC_kdf_derive_fn sskdf_derive;
80		static OSSL_FUNC_kdf_derive_fn x963kdf_derive;
81		static OSSL_FUNC_kdf_settable_ctx_params_fn sskdf_settable_ctx_params;
82		static OSSL_FUNC_kdf_set_ctx_params_fn sskdf_set_ctx_params;
83		static OSSL_FUNC_kdf_gettable_ctx_params_fn sskdf_gettable_ctx_params;
84		static OSSL_FUNC_kdf_get_ctx_params_fn sskdf_get_ctx_params;
85
86		/*
87		* Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
88		* Section 4. One-Step Key Derivation using H(x) = hash(x)
89		* Note: X9.63 also uses this code with the only difference being that the
90		* counter is appended to the secret 'z'.
91		* i.e.
92		* result[i] = Hash(counter \|\| z \|\| info) for One Step OR
93		* result[i] = Hash(z \|\| counter \|\| info) for X9.63.
94		*/
95		static int SSKDF_hash_kdm(const EVP_MD *kdf_md,
96		const unsigned char *z, size_t z_len,
97		const unsigned char *info, size_t info_len,
98		unsigned int append_ctr,
99		unsigned char *derived_key, size_t derived_key_len)
100	0	{
101	0	int ret = 0, hlen;
102	0	size_t counter, out_len, len = derived_key_len;
103	0	unsigned char c[4];
104	0	unsigned char mac[EVP_MAX_MD_SIZE];
105	0	unsigned char *out = derived_key;
106	0	EVP_MD_CTX ctx = NULL, ctx_init = NULL;
107
108	0	if (z_len > SSKDF_MAX_INLEN \|\| info_len > SSKDF_MAX_INLEN
109	0	\|\| derived_key_len > SSKDF_MAX_INLEN
110	0	\|\| derived_key_len == 0)
111	0	return 0;
112
113	0	hlen = EVP_MD_get_size(kdf_md);
114	0	if (hlen <= 0)
115	0	return 0;
116	0	out_len = (size_t)hlen;
117
118	0	ctx = EVP_MD_CTX_create();
119	0	ctx_init = EVP_MD_CTX_create();
120	0	if (ctx == NULL \|\| ctx_init == NULL)
121	0	goto end;
122
123	0	if (!EVP_DigestInit(ctx_init, kdf_md))
124	0	goto end;
125
126	0	for (counter = 1;; counter++) {
127	0	c[0] = (unsigned char)((counter >> 24) & 0xff);
128	0	c[1] = (unsigned char)((counter >> 16) & 0xff);
129	0	c[2] = (unsigned char)((counter >> 8) & 0xff);
130	0	c[3] = (unsigned char)(counter & 0xff);
131
132	0	if (!(EVP_MD_CTX_copy_ex(ctx, ctx_init)
133	0	&& (append_ctr \|\| EVP_DigestUpdate(ctx, c, sizeof(c)))
134	0	&& EVP_DigestUpdate(ctx, z, z_len)
135	0	&& (!append_ctr \|\| EVP_DigestUpdate(ctx, c, sizeof(c)))
136	0	&& EVP_DigestUpdate(ctx, info, info_len)))
137	0	goto end;
138	0	if (len >= out_len) {
139	0	if (!EVP_DigestFinal_ex(ctx, out, NULL))
140	0	goto end;
141	0	out += out_len;
142	0	len -= out_len;
143	0	if (len == 0)
144	0	break;
145	0	} else {
146	0	if (!EVP_DigestFinal_ex(ctx, mac, NULL))
147	0	goto end;
148	0	memcpy(out, mac, len);
149	0	break;
150	0	}
151	0	}
152	0	ret = 1;
153	0	end:
154	0	EVP_MD_CTX_destroy(ctx);
155	0	EVP_MD_CTX_destroy(ctx_init);
156	0	OPENSSL_cleanse(mac, sizeof(mac));
157	0	return ret;
158	0	}
159
160		static int kmac_init(EVP_MAC_CTX ctx, const unsigned char custom,
161		size_t custom_len, size_t kmac_out_len,
162		size_t derived_key_len, unsigned char **out)
163	24	{
164	24	OSSL_PARAM params[2];
165
166		/* Only KMAC has custom data - so return if not KMAC */
167	24	if (custom == NULL)
168	14	return 1;
169
170	10	params[0] = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_CUSTOM,
171	10	(void *)custom, custom_len);
172	10	params[1] = OSSL_PARAM_construct_end();
173
174	10	if (!EVP_MAC_CTX_set_params(ctx, params))
175	0	return 0;
176
177		/* By default only do one iteration if kmac_out_len is not specified */
178	10	if (kmac_out_len == 0)
179	0	kmac_out_len = derived_key_len;
180		/* otherwise check the size is valid */
181	10	else if (!(kmac_out_len == derived_key_len
182	10	\|\| kmac_out_len == 20
183	10	\|\| kmac_out_len == 28
184	10	\|\| kmac_out_len == 32
185	10	\|\| kmac_out_len == 48
186	10	\|\| kmac_out_len == 64))
187	5	return 0;
188
189	5	params[0] = OSSL_PARAM_construct_size_t(OSSL_MAC_PARAM_SIZE,
190	5	&kmac_out_len);
191
192	5	if (EVP_MAC_CTX_set_params(ctx, params) <= 0)
193	0	return 0;
194
195		/*
196		* For kmac the output buffer can be larger than EVP_MAX_MD_SIZE: so
197		* alloc a buffer for this case.
198		*/
199	5	if (kmac_out_len > EVP_MAX_MD_SIZE) {
200	0	*out = OPENSSL_zalloc(kmac_out_len);
201	0	if (*out == NULL)
202	0	return 0;
203	0	}
204	5	return 1;
205	5	}
206
207		/*
208		* Refer to https://csrc.nist.gov/publications/detail/sp/800-56c/rev-1/final
209		* Section 4. One-Step Key Derivation using MAC: i.e either
210		* H(x) = HMAC-hash(salt, x) OR
211		* H(x) = KMAC#(salt, x, outbits, CustomString='KDF')
212		*/
213		static int SSKDF_mac_kdm(EVP_MAC_CTX *ctx_init,
214		const unsigned char *kmac_custom,
215		size_t kmac_custom_len, size_t kmac_out_len,
216		const unsigned char *salt, size_t salt_len,
217		const unsigned char *z, size_t z_len,
218		const unsigned char *info, size_t info_len,
219		unsigned char *derived_key, size_t derived_key_len)
220	24	{
221	24	int ret = 0;
222	24	size_t counter, out_len, len;
223	24	unsigned char c[4];
224	24	unsigned char mac_buf[EVP_MAX_MD_SIZE];
225	24	unsigned char *out = derived_key;
226	24	EVP_MAC_CTX *ctx = NULL;
227	24	unsigned char mac = mac_buf, kmac_buffer = NULL;
228
229	24	if (z_len > SSKDF_MAX_INLEN \|\| info_len > SSKDF_MAX_INLEN
230	24	\|\| derived_key_len > SSKDF_MAX_INLEN
231	24	\|\| derived_key_len == 0)
232	0	return 0;
233
234	24	if (!kmac_init(ctx_init, kmac_custom, kmac_custom_len, kmac_out_len,
235	24	derived_key_len, &kmac_buffer))
236	5	goto end;
237	19	if (kmac_buffer != NULL)
238	0	mac = kmac_buffer;
239
240	19	if (!EVP_MAC_init(ctx_init, salt, salt_len, NULL))
241	0	goto end;
242
243	19	out_len = EVP_MAC_CTX_get_mac_size(ctx_init); /* output size */
244	19	if (out_len <= 0 \|\| (mac == mac_buf && out_len > sizeof(mac_buf)))
245	0	goto end;
246	19	len = derived_key_len;
247
248	32	for (counter = 1;; counter++) {
249	32	c[0] = (unsigned char)((counter >> 24) & 0xff);
250	32	c[1] = (unsigned char)((counter >> 16) & 0xff);
251	32	c[2] = (unsigned char)((counter >> 8) & 0xff);
252	32	c[3] = (unsigned char)(counter & 0xff);
253
254	32	ctx = EVP_MAC_CTX_dup(ctx_init);
255	32	if (!(ctx != NULL
256	32	&& EVP_MAC_update(ctx, c, sizeof(c))
257	32	&& EVP_MAC_update(ctx, z, z_len)
258	32	&& EVP_MAC_update(ctx, info, info_len)))
259	0	goto end;
260	32	if (len >= out_len) {
261	17	if (!EVP_MAC_final(ctx, out, NULL, len))
262	0	goto end;
263	17	out += out_len;
264	17	len -= out_len;
265	17	if (len == 0)
266	4	break;
267	17	} else {
268	15	if (!EVP_MAC_final(ctx, mac, NULL, out_len))
269	0	goto end;
270	15	memcpy(out, mac, len);
271	15	break;
272	15	}
273	13	EVP_MAC_CTX_free(ctx);
274	13	ctx = NULL;
275	13	}
276	19	ret = 1;
277	24	end:
278	24	if (kmac_buffer != NULL)
279	0	OPENSSL_clear_free(kmac_buffer, kmac_out_len);
280	24	else
281	24	OPENSSL_cleanse(mac_buf, sizeof(mac_buf));
282
283	24	EVP_MAC_CTX_free(ctx);
284	24	return ret;
285	19	}
286
287		static void sskdf_new(void provctx)
288		{
289		KDF_SSKDF *ctx;
290
291		if (!ossl_prov_is_running())
292		return NULL;
293
294		if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
295		ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
296		ctx->provctx = provctx;
297		return ctx;
298		}
299
300		static void sskdf_reset(void *vctx)
301	48	{
302	48	KDF_SSKDF ctx = (KDF_SSKDF )vctx;
303	48	void *provctx = ctx->provctx;
304
305	48	EVP_MAC_CTX_free(ctx->macctx);
306	48	ossl_prov_digest_reset(&ctx->digest);
307	48	OPENSSL_clear_free(ctx->secret, ctx->secret_len);
308	48	OPENSSL_clear_free(ctx->info, ctx->info_len);
309	48	OPENSSL_clear_free(ctx->salt, ctx->salt_len);
310	48	memset(ctx, 0, sizeof(*ctx));
311	48	ctx->provctx = provctx;
312	48	}
313
314		static void sskdf_free(void *vctx)
315	48	{
316	48	KDF_SSKDF ctx = (KDF_SSKDF )vctx;
317
318	48	if (ctx != NULL) {
319	48	sskdf_reset(ctx);
320	48	OPENSSL_free(ctx);
321	48	}
322	48	}
323
324		static void sskdf_dup(void vctx)
325	0	{
326	0	const KDF_SSKDF src = (const KDF_SSKDF )vctx;
327	0	KDF_SSKDF *dest;
328
329	0	dest = sskdf_new(src->provctx);
330	0	if (dest != NULL) {
331	0	if (src->macctx != NULL) {
332	0	dest->macctx = EVP_MAC_CTX_dup(src->macctx);
333	0	if (dest->macctx == NULL)
334	0	goto err;
335	0	}
336	0	if (!ossl_prov_memdup(src->info, src->info_len,
337	0	&dest->info, &dest->info_len)
338	0	\|\| !ossl_prov_memdup(src->salt, src->salt_len,
339	0	&dest->salt , &dest->salt_len)
340	0	\|\| !ossl_prov_memdup(src->secret, src->secret_len,
341	0	&dest->secret, &dest->secret_len)
342	0	\|\| !ossl_prov_digest_copy(&dest->digest, &src->digest))
343	0	goto err;
344	0	dest->out_len = src->out_len;
345	0	dest->is_kmac = src->is_kmac;
346	0	}
347	0	return dest;
348
349	0	err:
350	0	sskdf_free(dest);
351	0	return NULL;
352	0	}
353
354		static int sskdf_set_buffer(unsigned char *out, size_t out_len,
355		const OSSL_PARAM *p)
356	0	{
357	0	if (p->data == NULL \|\| p->data_size == 0)
358	0	return 1;
359	0	OPENSSL_free(*out);
360	0	*out = NULL;
361	0	return OSSL_PARAM_get_octet_string(p, (void **)out, 0, out_len);
362	0	}
363
364		static size_t sskdf_size(KDF_SSKDF *ctx)
365	0	{
366	0	int len;
367	0	const EVP_MD *md = NULL;
368
369	0	if (ctx->is_kmac)
370	0	return SIZE_MAX;
371
372	0	md = ossl_prov_digest_md(&ctx->digest);
373	0	if (md == NULL) {
374	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
375	0	return 0;
376	0	}
377	0	len = EVP_MD_get_size(md);
378	0	return (len <= 0) ? 0 : (size_t)len;
379	0	}
380
381		static int sskdf_derive(void vctx, unsigned char key, size_t keylen,
382		const OSSL_PARAM params[])
383	26	{
384	26	KDF_SSKDF ctx = (KDF_SSKDF )vctx;
385	26	const EVP_MD *md;
386
387	26	if (!ossl_prov_is_running() \|\| !sskdf_set_ctx_params(ctx, params))
388	0	return 0;
389	26	if (ctx->secret == NULL) {
390	1	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
391	1	return 0;
392	1	}
393	25	md = ossl_prov_digest_md(&ctx->digest);
394
395	25	if (ctx->macctx != NULL) {
396		/* H(x) = KMAC or H(x) = HMAC */
397	25	int ret;
398	25	const unsigned char *custom = NULL;
399	25	size_t custom_len = 0;
400	25	int default_salt_len;
401	25	EVP_MAC *mac = EVP_MAC_CTX_get0_mac(ctx->macctx);
402
403	25	if (EVP_MAC_is_a(mac, OSSL_MAC_NAME_HMAC)) {
404		/* H(x) = HMAC(x, salt, hash) */
405	14	if (md == NULL) {
406	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
407	0	return 0;
408	0	}
409	14	default_salt_len = EVP_MD_get_size(md);
410	14	if (default_salt_len <= 0)
411	0	return 0;
412	14	} else if (ctx->is_kmac) {
413		/* H(x) = KMACzzz(x, salt, custom) */
414	10	custom = kmac_custom_str;
415	10	custom_len = sizeof(kmac_custom_str);
416	10	if (EVP_MAC_is_a(mac, OSSL_MAC_NAME_KMAC128))
417	4	default_salt_len = SSKDF_KMAC128_DEFAULT_SALT_SIZE;
418	6	else
419	6	default_salt_len = SSKDF_KMAC256_DEFAULT_SALT_SIZE;
420	10	} else {
421	1	ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_MAC_TYPE);
422	1	return 0;
423	1	}
424		/* If no salt is set then use a default_salt of zeros */
425	24	if (ctx->salt == NULL \|\| ctx->salt_len <= 0) {
426	13	ctx->salt = OPENSSL_zalloc(default_salt_len);
427	13	if (ctx->salt == NULL) {
428	0	ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
429	0	return 0;
430	0	}
431	13	ctx->salt_len = default_salt_len;
432	13	}
433	24	ret = SSKDF_mac_kdm(ctx->macctx,
434	24	custom, custom_len, ctx->out_len,
435	24	ctx->salt, ctx->salt_len,
436	24	ctx->secret, ctx->secret_len,
437	24	ctx->info, ctx->info_len, key, keylen);
438	24	return ret;
439	24	} else {
440		/* H(x) = hash */
441	0	if (md == NULL) {
442	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
443	0	return 0;
444	0	}
445	0	return SSKDF_hash_kdm(md, ctx->secret, ctx->secret_len,
446	0	ctx->info, ctx->info_len, 0, key, keylen);
447	0	}
448	25	}
449
450		static int x963kdf_derive(void vctx, unsigned char key, size_t keylen,
451		const OSSL_PARAM params[])
452	3	{
453	3	KDF_SSKDF ctx = (KDF_SSKDF )vctx;
454	3	const EVP_MD *md;
455
456	3	if (!ossl_prov_is_running() \|\| !sskdf_set_ctx_params(ctx, params))
457	0	return 0;
458
459	3	if (ctx->secret == NULL) {
460	2	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
461	2	return 0;
462	2	}
463
464	1	if (ctx->macctx != NULL) {
465	1	ERR_raise(ERR_LIB_PROV, PROV_R_NOT_SUPPORTED);
466	1	return 0;
467	1	}
468
469		/* H(x) = hash */
470	0	md = ossl_prov_digest_md(&ctx->digest);
471	0	if (md == NULL) {
472	0	ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
473	0	return 0;
474	0	}
475
476	0	return SSKDF_hash_kdm(md, ctx->secret, ctx->secret_len,
477	0	ctx->info, ctx->info_len, 1, key, keylen);
478	0	}
479
480		static int sskdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
481		{
482		const OSSL_PARAM *p;
483		KDF_SSKDF *ctx = vctx;
484		OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
485		size_t sz;
486
487		if (params == NULL)
488		return 1;
489
490		if (!ossl_prov_macctx_load_from_params(&ctx->macctx, params,
491		NULL, NULL, NULL, libctx))
492		return 0;
493		if (ctx->macctx != NULL) {
494		if (EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->macctx),
495		OSSL_MAC_NAME_KMAC128)
496		\|\| EVP_MAC_is_a(EVP_MAC_CTX_get0_mac(ctx->macctx),
497		OSSL_MAC_NAME_KMAC256)) {
498		ctx->is_kmac = 1;
499		}
500		}
501
502		if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
503		return 0;
504
505		if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SECRET)) != NULL
506		\|\| (p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL)
507		if (!sskdf_set_buffer(&ctx->secret, &ctx->secret_len, p))
508		return 0;
509
510		if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO)) != NULL)
511		if (!sskdf_set_buffer(&ctx->info, &ctx->info_len, p))
512		return 0;
513
514		if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL)
515		if (!sskdf_set_buffer(&ctx->salt, &ctx->salt_len, p))
516		return 0;
517
518		if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MAC_SIZE))
519		!= NULL) {
520		if (!OSSL_PARAM_get_size_t(p, &sz) \|\| sz == 0)
521		return 0;
522		ctx->out_len = sz;
523		}
524		return 1;
525		}
526
527		static const OSSL_PARAM sskdf_settable_ctx_params(ossl_unused void ctx,
528		ossl_unused void *provctx)
529	39	{
530	39	static const OSSL_PARAM known_settable_ctx_params[] = {
531	39	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SECRET, NULL, 0),
532	39	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
533	39	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
534	39	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
535	39	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
536	39	OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC, NULL, 0),
537	39	OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
538	39	OSSL_PARAM_size_t(OSSL_KDF_PARAM_MAC_SIZE, NULL),
539	39	OSSL_PARAM_END
540	39	};
541	39	return known_settable_ctx_params;
542	39	}
543
544		static int sskdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
545	0	{
546	0	KDF_SSKDF ctx = (KDF_SSKDF )vctx;
547	0	OSSL_PARAM *p;
548
549	0	if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
550	0	return OSSL_PARAM_set_size_t(p, sskdf_size(ctx));
551	0	return -2;
552	0	}
553
554		static const OSSL_PARAM sskdf_gettable_ctx_params(ossl_unused void ctx,
555		ossl_unused void *provctx)
556	0	{
557	0	static const OSSL_PARAM known_gettable_ctx_params[] = {
558	0	OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
559	0	OSSL_PARAM_END
560	0	};
561	0	return known_gettable_ctx_params;
562	0	}
563
564		const OSSL_DISPATCH ossl_kdf_sskdf_functions[] = {
565		{ OSSL_FUNC_KDF_NEWCTX, (void(*)(void))sskdf_new },
566		{ OSSL_FUNC_KDF_DUPCTX, (void(*)(void))sskdf_dup },
567		{ OSSL_FUNC_KDF_FREECTX, (void(*)(void))sskdf_free },
568		{ OSSL_FUNC_KDF_RESET, (void(*)(void))sskdf_reset },
569		{ OSSL_FUNC_KDF_DERIVE, (void(*)(void))sskdf_derive },
570		{ OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
571		(void(*)(void))sskdf_settable_ctx_params },
572		{ OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))sskdf_set_ctx_params },
573		{ OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
574		(void(*)(void))sskdf_gettable_ctx_params },
575		{ OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))sskdf_get_ctx_params },
576		{ 0, NULL }
577		};
578
579		const OSSL_DISPATCH ossl_kdf_x963_kdf_functions[] = {
580		{ OSSL_FUNC_KDF_NEWCTX, (void(*)(void))sskdf_new },
581		{ OSSL_FUNC_KDF_DUPCTX, (void(*)(void))sskdf_dup },
582		{ OSSL_FUNC_KDF_FREECTX, (void(*)(void))sskdf_free },
583		{ OSSL_FUNC_KDF_RESET, (void(*)(void))sskdf_reset },
584		{ OSSL_FUNC_KDF_DERIVE, (void(*)(void))x963kdf_derive },
585		{ OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
586		(void(*)(void))sskdf_settable_ctx_params },
587		{ OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))sskdf_set_ctx_params },
588		{ OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
589		(void(*)(void))sskdf_gettable_ctx_params },
590		{ OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))sskdf_get_ctx_params },
591		{ 0, NULL }
592		};