/src/openssl-3.5.4/providers/implementations/keymgmt/slh_dsa_kmgmt.c

Source
/*
 * Copyright 2024-2025 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 <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/param_build.h>
#include <openssl/self_test.h>
#include <openssl/proverr.h>
#include "crypto/slh_dsa.h"
#include "internal/fips.h"
#include "internal/param_build_set.h"
#include "prov/implementations.h"
#include "prov/providercommon.h"
#include "prov/provider_ctx.h"

#ifdef FIPS_MODULE
static int slh_dsa_fips140_pairwise_test(const SLH_DSA_KEY *key,
                                         SLH_DSA_HASH_CTX *ctx);
#endif  /* FIPS_MODULE */

static OSSL_FUNC_keymgmt_free_fn slh_dsa_free_key;
static OSSL_FUNC_keymgmt_has_fn slh_dsa_has;
static OSSL_FUNC_keymgmt_match_fn slh_dsa_match;
static OSSL_FUNC_keymgmt_import_fn slh_dsa_import;
static OSSL_FUNC_keymgmt_export_fn slh_dsa_export;
static OSSL_FUNC_keymgmt_import_types_fn slh_dsa_imexport_types;
static OSSL_FUNC_keymgmt_export_types_fn slh_dsa_imexport_types;
static OSSL_FUNC_keymgmt_load_fn slh_dsa_load;
static OSSL_FUNC_keymgmt_get_params_fn slh_dsa_get_params;
static OSSL_FUNC_keymgmt_gettable_params_fn slh_dsa_gettable_params;
static OSSL_FUNC_keymgmt_validate_fn slh_dsa_validate;
static OSSL_FUNC_keymgmt_gen_init_fn slh_dsa_gen_init;
static OSSL_FUNC_keymgmt_gen_cleanup_fn slh_dsa_gen_cleanup;
static OSSL_FUNC_keymgmt_gen_set_params_fn slh_dsa_gen_set_params;
static OSSL_FUNC_keymgmt_gen_settable_params_fn slh_dsa_gen_settable_params;
static OSSL_FUNC_keymgmt_dup_fn slh_dsa_dup_key;

#define SLH_DSA_POSSIBLE_SELECTIONS (OSSL_KEYMGMT_SELECT_KEYPAIR)

struct slh_dsa_gen_ctx {
    SLH_DSA_HASH_CTX *ctx;
    OSSL_LIB_CTX *libctx;
    char *propq;
    uint8_t entropy[SLH_DSA_MAX_N * 3];
    size_t entropy_len;
};

static void *slh_dsa_new_key(void *provctx, const char *alg)
{
    if (!ossl_prov_is_running())
        return 0;

    return ossl_slh_dsa_key_new(PROV_LIBCTX_OF(provctx), NULL, alg);
}

static void slh_dsa_free_key(void *keydata)
{
    ossl_slh_dsa_key_free((SLH_DSA_KEY *)keydata);
}

static void *slh_dsa_dup_key(const void *keydata_from, int selection)
{
    if (ossl_prov_is_running())
        return ossl_slh_dsa_key_dup(keydata_from, selection);
    return NULL;
}

static int slh_dsa_has(const void *keydata, int selection)
{
    const SLH_DSA_KEY *key = keydata;

    if (!ossl_prov_is_running() || key == NULL)
        return 0;
    if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
        return 1; /* the selection is not missing */

    return ossl_slh_dsa_key_has(key, selection);
}

static int slh_dsa_match(const void *keydata1, const void *keydata2, int selection)
{
    const SLH_DSA_KEY *key1 = keydata1;
    const SLH_DSA_KEY *key2 = keydata2;

    if (!ossl_prov_is_running())
        return 0;
    if (key1 == NULL || key2 == NULL)
        return 0;
    return ossl_slh_dsa_key_equal(key1, key2, selection);
}

static int slh_dsa_validate(const void *key_data, int selection, int check_type)
{
    const SLH_DSA_KEY *key = key_data;

    if (!slh_dsa_has(key, selection))
        return 0;

    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == OSSL_KEYMGMT_SELECT_KEYPAIR)
        return ossl_slh_dsa_key_pairwise_check(key);
    return 1;
}

static int slh_dsa_import(void *keydata, int selection, const OSSL_PARAM params[])
{
    SLH_DSA_KEY *key = keydata;
    int include_priv;

    if (!ossl_prov_is_running() || key == NULL)
        return 0;

    if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
        return 0;

    include_priv = ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0);
    return ossl_slh_dsa_key_fromdata(key, params, include_priv);
}

#define SLH_DSA_IMEXPORTABLE_PARAMETERS \
    OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0), \
    OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)

static const OSSL_PARAM slh_dsa_key_types[] = {
    SLH_DSA_IMEXPORTABLE_PARAMETERS,
    OSSL_PARAM_END
};
static const OSSL_PARAM *slh_dsa_imexport_types(int selection)
{
    if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
        return NULL;
    return slh_dsa_key_types;
}

static const OSSL_PARAM slh_dsa_params[] = {
    OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
    OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_MANDATORY_DIGEST, NULL, 0),
    SLH_DSA_IMEXPORTABLE_PARAMETERS,
    OSSL_PARAM_END
};
static const OSSL_PARAM *slh_dsa_gettable_params(void *provctx)
{
    return slh_dsa_params;
}

static int key_to_params(SLH_DSA_KEY *key, OSSL_PARAM_BLD *tmpl,
                         int selection)
{
    /* Error if there is no key or public key */
    if (key == NULL || ossl_slh_dsa_key_get_pub(key) == NULL)
        return 0;

    if (((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
        && ossl_slh_dsa_key_get_priv(key) != NULL)
        if (ossl_param_build_set_octet_string(tmpl, NULL,
                                              OSSL_PKEY_PARAM_PRIV_KEY,
                                              ossl_slh_dsa_key_get_priv(key),
                                              ossl_slh_dsa_key_get_priv_len(key)) != 1)
            return 0;

    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) == 0)
        return 1;

    return ossl_param_build_set_octet_string(tmpl, NULL,
                                             OSSL_PKEY_PARAM_PUB_KEY,
                                             ossl_slh_dsa_key_get_pub(key),
                                             ossl_slh_dsa_key_get_pub_len(key));
}

static int slh_dsa_get_params(void *keydata, OSSL_PARAM params[])
{
    SLH_DSA_KEY *key = keydata;
    OSSL_PARAM *p;
    const uint8_t *pub, *priv;

    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
            && !OSSL_PARAM_set_int(p, 8 * ossl_slh_dsa_key_get_pub_len(key)))
        return 0;
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
            && !OSSL_PARAM_set_int(p, 8 * ossl_slh_dsa_key_get_n(key)))
        return 0;
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
            && !OSSL_PARAM_set_int(p, ossl_slh_dsa_key_get_sig_len(key)))
        return 0;

    priv = ossl_slh_dsa_key_get_priv(key);
    if (priv != NULL) {
        p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_PRIV_KEY);
        /* Note: ossl_slh_dsa_key_get_priv_len() includes the public key */
        if (p != NULL
            && !OSSL_PARAM_set_octet_string(p, priv,
                                            ossl_slh_dsa_key_get_priv_len(key)))
            return 0;
    }
    pub = ossl_slh_dsa_key_get_pub(key);
    if (pub != NULL) {
        p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_PUB_KEY);
        if (p != NULL
            && !OSSL_PARAM_set_octet_string(p, pub,
                                            ossl_slh_dsa_key_get_pub_len(key)))
            return 0;
    }
    /*
     * This allows apps to use an empty digest, so that the old API
     * for digest signing can be used.
     */
    p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MANDATORY_DIGEST);
    if (p != NULL && !OSSL_PARAM_set_utf8_string(p, ""))
        return 0;
    return 1;
}

static int slh_dsa_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
                          void *cbarg)
{
    SLH_DSA_KEY *key = keydata;
    OSSL_PARAM_BLD *tmpl;
    OSSL_PARAM *params = NULL;
    int ret = 0;

    if (!ossl_prov_is_running() || key == NULL)
        return 0;

    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
        return 0;

    tmpl = OSSL_PARAM_BLD_new();
    if (tmpl == NULL)
        return 0;

    if (!key_to_params(key, tmpl, selection))
        goto err;

    params = OSSL_PARAM_BLD_to_param(tmpl);
    if (params == NULL)
        goto err;

    ret = param_cb(params, cbarg);
    OSSL_PARAM_free(params);
err:
    OSSL_PARAM_BLD_free(tmpl);
    return ret;
}

static void *slh_dsa_load(const void *reference, size_t reference_sz)
{
    SLH_DSA_KEY *key = NULL;

    if (ossl_prov_is_running() && reference_sz == sizeof(key)) {
        /* The contents of the reference is the address to our object */
        key = *(SLH_DSA_KEY **)reference;
        /* We grabbed, so we detach it */
        *(SLH_DSA_KEY **)reference = NULL;
        return key;
    }
    return NULL;
}

static void *slh_dsa_gen_init(void *provctx, int selection,
                              const OSSL_PARAM params[])
{
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
    struct slh_dsa_gen_ctx *gctx = NULL;

    if (!ossl_prov_is_running())
        return NULL;

    if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
        gctx->libctx = libctx;
        if (!slh_dsa_gen_set_params(gctx, params)) {
            OPENSSL_free(gctx);
            gctx = NULL;
        }
    }
    return gctx;
}

#ifdef FIPS_MODULE
/*
 * Refer to FIPS 140-3 IG 10.3.A Additional Comment 1
 * Perform a pairwise test for SLH_DSA by signing and verifying a signature.
 */
static int slh_dsa_fips140_pairwise_test(const SLH_DSA_KEY *key,
                                         SLH_DSA_HASH_CTX *ctx)
{
    int ret = 0;
    OSSL_SELF_TEST *st = NULL;
    OSSL_CALLBACK *cb = NULL;
    void *cb_arg = NULL;
    uint8_t msg[16] = {0};
    size_t msg_len = sizeof(msg);
    uint8_t *sig = NULL;
    size_t sig_len;
    OSSL_LIB_CTX *lib_ctx;
    int alloc_ctx = 0;

    /* During self test, it is a waste to do this test */
    if (ossl_fips_self_testing())
        return 1;

    if (ctx == NULL) {
        ctx = ossl_slh_dsa_hash_ctx_new(key);
        if (ctx == NULL)
            return 0;
        alloc_ctx = 1;
    }
    lib_ctx = ossl_slh_dsa_key_get0_libctx(key);

    OSSL_SELF_TEST_get_callback(lib_ctx, &cb, &cb_arg);
    st = OSSL_SELF_TEST_new(cb, cb_arg);
    if (st == NULL)
        goto err;

    OSSL_SELF_TEST_onbegin(st, OSSL_SELF_TEST_TYPE_PCT,
                           OSSL_SELF_TEST_DESC_PCT_SLH_DSA);

    sig_len = ossl_slh_dsa_key_get_sig_len(key);
    sig = OPENSSL_malloc(sig_len);
    if (sig == NULL)
        goto err;

    if (ossl_slh_dsa_sign(ctx, msg, msg_len, NULL, 0, NULL, 0,
                          sig, &sig_len, sig_len) != 1)
        goto err;

    OSSL_SELF_TEST_oncorrupt_byte(st, sig);

    if (ossl_slh_dsa_verify(ctx, msg, msg_len, NULL, 0, 0, sig, sig_len) != 1)
        goto err;

    ret = 1;
err:
    if (alloc_ctx)
        ossl_slh_dsa_hash_ctx_free(ctx);
    OPENSSL_free(sig);
    OSSL_SELF_TEST_onend(st, ret);
    OSSL_SELF_TEST_free(st);
    return ret;
}
#endif /* FIPS_MODULE */

static void *slh_dsa_gen(void *genctx, const char *alg)
{
    struct slh_dsa_gen_ctx *gctx = genctx;
    SLH_DSA_KEY *key = NULL;
    SLH_DSA_HASH_CTX *ctx = NULL;

    if (!ossl_prov_is_running())
        return NULL;
    key = ossl_slh_dsa_key_new(gctx->libctx, gctx->propq, alg);
    if (key == NULL)
        return NULL;
    ctx = ossl_slh_dsa_hash_ctx_new(key);
    if (ctx == NULL)
        goto err;
    if (!ossl_slh_dsa_generate_key(ctx, key, gctx->libctx,
                                   gctx->entropy, gctx->entropy_len))
        goto err;
#ifdef FIPS_MODULE
    if (!slh_dsa_fips140_pairwise_test(key, ctx)) {
        ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);
        goto err;
    }
#endif /* FIPS_MODULE */
    ossl_slh_dsa_hash_ctx_free(ctx);
    return key;
 err:
    ossl_slh_dsa_hash_ctx_free(ctx);
    ossl_slh_dsa_key_free(key);
    return NULL;
}

static int slh_dsa_gen_set_params(void *genctx, const OSSL_PARAM params[])
{
    struct slh_dsa_gen_ctx *gctx = genctx;
    const OSSL_PARAM *p;

    if (gctx == NULL)
        return 0;

    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_SLH_DSA_SEED);
    if (p != NULL) {
        void *vp = gctx->entropy;
        size_t len = sizeof(gctx->entropy);

        if (!OSSL_PARAM_get_octet_string(p, &vp, len, &(gctx->entropy_len))) {
            gctx->entropy_len = 0;
            return 0;
        }
    }

    p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);
    if (p != NULL) {
        if (p->data_type != OSSL_PARAM_UTF8_STRING)
            return 0;
        OPENSSL_free(gctx->propq);
        gctx->propq = OPENSSL_strdup(p->data);
        if (gctx->propq == NULL)
            return 0;
    }
    return 1;
}

static const OSSL_PARAM *slh_dsa_gen_settable_params(ossl_unused void *genctx,
                                                     ossl_unused void *provctx)
{
    static OSSL_PARAM settable[] = {
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
        OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_SLH_DSA_SEED, NULL, 0),
        OSSL_PARAM_END
    };
    return settable;
}

static void slh_dsa_gen_cleanup(void *genctx)
{
    struct slh_dsa_gen_ctx *gctx = genctx;

    if (gctx == NULL)
        return;

    OPENSSL_cleanse(gctx->entropy, gctx->entropy_len);
    OPENSSL_free(gctx->propq);
    OPENSSL_free(gctx);
}

#define MAKE_KEYMGMT_FUNCTIONS(alg, fn)                                        \
    static OSSL_FUNC_keymgmt_new_fn slh_dsa_##fn##_new_key;                    \
    static OSSL_FUNC_keymgmt_gen_fn slh_dsa_##fn##_gen;                        \
    static void *slh_dsa_##fn##_new_key(void *provctx)                         \
    {                                                                          \
        return slh_dsa_new_key(provctx, alg);                                  \
    }                                                                          \
    static void *slh_dsa_##fn##_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)\
    {                                                                          \
        return slh_dsa_gen(genctx, alg);                                       \
    }                                                                          \
    const OSSL_DISPATCH ossl_slh_dsa_##fn##_keymgmt_functions[] = {            \
        { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))slh_dsa_##fn##_new_key },     \
        { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))slh_dsa_free_key },          \
        { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))slh_dsa_dup_key },            \
        { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))slh_dsa_has },                \
        { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))slh_dsa_match },            \
        { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))slh_dsa_import },          \
        { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))slh_dsa_imexport_types },\
        { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))slh_dsa_export },          \
        { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))slh_dsa_imexport_types },\
        { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))slh_dsa_load },              \
        { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))slh_dsa_get_params }, \
        { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))slh_dsa_gettable_params },\
        { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))slh_dsa_validate },      \
        { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))slh_dsa_gen_init },      \
        { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))slh_dsa_##fn##_gen },         \
        { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))slh_dsa_gen_cleanup },\
        { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS,                                    \
          (void (*)(void))slh_dsa_gen_set_params },                            \
        { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,                               \
          (void (*)(void))slh_dsa_gen_settable_params },                       \
        OSSL_DISPATCH_END                                                      \
    }

MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-128s", sha2_128s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-128f", sha2_128f);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-192s", sha2_192s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-192f", sha2_192f);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-256s", sha2_256s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-256f", sha2_256f);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-128s", shake_128s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-128f", shake_128f);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-192s", shake_192s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-192f", shake_192f);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-256s", shake_256s);
MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-256f", shake_256f);

Coverage Report

Created: 2025-12-31 07:12

Line	Count	Source
1		/*
2		* Copyright 2024-2025 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 <openssl/core_dispatch.h>
11		#include <openssl/core_names.h>
12		#include <openssl/param_build.h>
13		#include <openssl/self_test.h>
14		#include <openssl/proverr.h>
15		#include "crypto/slh_dsa.h"
16		#include "internal/fips.h"
17		#include "internal/param_build_set.h"
18		#include "prov/implementations.h"
19		#include "prov/providercommon.h"
20		#include "prov/provider_ctx.h"
21
22		#ifdef FIPS_MODULE
23		static int slh_dsa_fips140_pairwise_test(const SLH_DSA_KEY *key,
24		SLH_DSA_HASH_CTX *ctx);
25		#endif /* FIPS_MODULE */
26
27		static OSSL_FUNC_keymgmt_free_fn slh_dsa_free_key;
28		static OSSL_FUNC_keymgmt_has_fn slh_dsa_has;
29		static OSSL_FUNC_keymgmt_match_fn slh_dsa_match;
30		static OSSL_FUNC_keymgmt_import_fn slh_dsa_import;
31		static OSSL_FUNC_keymgmt_export_fn slh_dsa_export;
32		static OSSL_FUNC_keymgmt_import_types_fn slh_dsa_imexport_types;
33		static OSSL_FUNC_keymgmt_export_types_fn slh_dsa_imexport_types;
34		static OSSL_FUNC_keymgmt_load_fn slh_dsa_load;
35		static OSSL_FUNC_keymgmt_get_params_fn slh_dsa_get_params;
36		static OSSL_FUNC_keymgmt_gettable_params_fn slh_dsa_gettable_params;
37		static OSSL_FUNC_keymgmt_validate_fn slh_dsa_validate;
38		static OSSL_FUNC_keymgmt_gen_init_fn slh_dsa_gen_init;
39		static OSSL_FUNC_keymgmt_gen_cleanup_fn slh_dsa_gen_cleanup;
40		static OSSL_FUNC_keymgmt_gen_set_params_fn slh_dsa_gen_set_params;
41		static OSSL_FUNC_keymgmt_gen_settable_params_fn slh_dsa_gen_settable_params;
42		static OSSL_FUNC_keymgmt_dup_fn slh_dsa_dup_key;
43
44	0	#define SLH_DSA_POSSIBLE_SELECTIONS (OSSL_KEYMGMT_SELECT_KEYPAIR)
45
46		struct slh_dsa_gen_ctx {
47		SLH_DSA_HASH_CTX *ctx;
48		OSSL_LIB_CTX *libctx;
49		char *propq;
50		uint8_t entropy[SLH_DSA_MAX_N * 3];
51		size_t entropy_len;
52		};
53
54		static void slh_dsa_new_key(void provctx, const char *alg)
55	0	{
56	0	if (!ossl_prov_is_running())
57	0	return 0;
58
59	0	return ossl_slh_dsa_key_new(PROV_LIBCTX_OF(provctx), NULL, alg);
60	0	}
61
62		static void slh_dsa_free_key(void *keydata)
63	0	{
64	0	ossl_slh_dsa_key_free((SLH_DSA_KEY *)keydata);
65	0	}
66
67		static void slh_dsa_dup_key(const void keydata_from, int selection)
68	0	{
69	0	if (ossl_prov_is_running())
70	0	return ossl_slh_dsa_key_dup(keydata_from, selection);
71	0	return NULL;
72	0	}
73
74		static int slh_dsa_has(const void *keydata, int selection)
75	0	{
76	0	const SLH_DSA_KEY *key = keydata;
77
78	0	if (!ossl_prov_is_running() \|\| key == NULL)
79	0	return 0;
80	0	if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
81	0	return 1; /* the selection is not missing */
82
83	0	return ossl_slh_dsa_key_has(key, selection);
84	0	}
85
86		static int slh_dsa_match(const void keydata1, const void keydata2, int selection)
87	0	{
88	0	const SLH_DSA_KEY *key1 = keydata1;
89	0	const SLH_DSA_KEY *key2 = keydata2;
90
91	0	if (!ossl_prov_is_running())
92	0	return 0;
93	0	if (key1 == NULL \|\| key2 == NULL)
94	0	return 0;
95	0	return ossl_slh_dsa_key_equal(key1, key2, selection);
96	0	}
97
98		static int slh_dsa_validate(const void *key_data, int selection, int check_type)
99	0	{
100	0	const SLH_DSA_KEY *key = key_data;
101
102	0	if (!slh_dsa_has(key, selection))
103	0	return 0;
104
105	0	if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == OSSL_KEYMGMT_SELECT_KEYPAIR)
106	0	return ossl_slh_dsa_key_pairwise_check(key);
107	0	return 1;
108	0	}
109
110		static int slh_dsa_import(void *keydata, int selection, const OSSL_PARAM params[])
111	0	{
112	0	SLH_DSA_KEY *key = keydata;
113	0	int include_priv;
114
115	0	if (!ossl_prov_is_running() \|\| key == NULL)
116	0	return 0;
117
118	0	if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
119	0	return 0;
120
121	0	include_priv = ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0);
122	0	return ossl_slh_dsa_key_fromdata(key, params, include_priv);
123	0	}
124
125		#define SLH_DSA_IMEXPORTABLE_PARAMETERS \
126		OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0), \
127		OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0)
128
129		static const OSSL_PARAM slh_dsa_key_types[] = {
130		SLH_DSA_IMEXPORTABLE_PARAMETERS,
131		OSSL_PARAM_END
132		};
133		static const OSSL_PARAM *slh_dsa_imexport_types(int selection)
134	0	{
135	0	if ((selection & SLH_DSA_POSSIBLE_SELECTIONS) == 0)
136	0	return NULL;
137	0	return slh_dsa_key_types;
138	0	}
139
140		static const OSSL_PARAM slh_dsa_params[] = {
141		OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
142		OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
143		OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
144		OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_MANDATORY_DIGEST, NULL, 0),
145		SLH_DSA_IMEXPORTABLE_PARAMETERS,
146		OSSL_PARAM_END
147		};
148		static const OSSL_PARAM slh_dsa_gettable_params(void provctx)
149	0	{
150	0	return slh_dsa_params;
151	0	}
152
153		static int key_to_params(SLH_DSA_KEY key, OSSL_PARAM_BLD tmpl,
154		int selection)
155	0	{
156		/* Error if there is no key or public key */
157	0	if (key == NULL \|\| ossl_slh_dsa_key_get_pub(key) == NULL)
158	0	return 0;
159
160	0	if (((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
161	0	&& ossl_slh_dsa_key_get_priv(key) != NULL)
162	0	if (ossl_param_build_set_octet_string(tmpl, NULL,
163	0	OSSL_PKEY_PARAM_PRIV_KEY,
164	0	ossl_slh_dsa_key_get_priv(key),
165	0	ossl_slh_dsa_key_get_priv_len(key)) != 1)
166	0	return 0;
167
168	0	if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) == 0)
169	0	return 1;
170
171	0	return ossl_param_build_set_octet_string(tmpl, NULL,
172	0	OSSL_PKEY_PARAM_PUB_KEY,
173	0	ossl_slh_dsa_key_get_pub(key),
174	0	ossl_slh_dsa_key_get_pub_len(key));
175	0	}
176
177		static int slh_dsa_get_params(void *keydata, OSSL_PARAM params[])
178	0	{
179	0	SLH_DSA_KEY *key = keydata;
180	0	OSSL_PARAM *p;
181	0	const uint8_t pub, priv;
182
183	0	if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
184	0	&& !OSSL_PARAM_set_int(p, 8 * ossl_slh_dsa_key_get_pub_len(key)))
185	0	return 0;
186	0	if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
187	0	&& !OSSL_PARAM_set_int(p, 8 * ossl_slh_dsa_key_get_n(key)))
188	0	return 0;
189	0	if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
190	0	&& !OSSL_PARAM_set_int(p, ossl_slh_dsa_key_get_sig_len(key)))
191	0	return 0;
192
193	0	priv = ossl_slh_dsa_key_get_priv(key);
194	0	if (priv != NULL) {
195	0	p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_PRIV_KEY);
196		/* Note: ossl_slh_dsa_key_get_priv_len() includes the public key */
197	0	if (p != NULL
198	0	&& !OSSL_PARAM_set_octet_string(p, priv,
199	0	ossl_slh_dsa_key_get_priv_len(key)))
200	0	return 0;
201	0	}
202	0	pub = ossl_slh_dsa_key_get_pub(key);
203	0	if (pub != NULL) {
204	0	p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_PUB_KEY);
205	0	if (p != NULL
206	0	&& !OSSL_PARAM_set_octet_string(p, pub,
207	0	ossl_slh_dsa_key_get_pub_len(key)))
208	0	return 0;
209	0	}
210		/*
211		* This allows apps to use an empty digest, so that the old API
212		* for digest signing can be used.
213		*/
214	0	p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MANDATORY_DIGEST);
215	0	if (p != NULL && !OSSL_PARAM_set_utf8_string(p, ""))
216	0	return 0;
217	0	return 1;
218	0	}
219
220		static int slh_dsa_export(void keydata, int selection, OSSL_CALLBACK param_cb,
221		void *cbarg)
222	0	{
223	0	SLH_DSA_KEY *key = keydata;
224	0	OSSL_PARAM_BLD *tmpl;
225	0	OSSL_PARAM *params = NULL;
226	0	int ret = 0;
227
228	0	if (!ossl_prov_is_running() \|\| key == NULL)
229	0	return 0;
230
231	0	if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
232	0	return 0;
233
234	0	tmpl = OSSL_PARAM_BLD_new();
235	0	if (tmpl == NULL)
236	0	return 0;
237
238	0	if (!key_to_params(key, tmpl, selection))
239	0	goto err;
240
241	0	params = OSSL_PARAM_BLD_to_param(tmpl);
242	0	if (params == NULL)
243	0	goto err;
244
245	0	ret = param_cb(params, cbarg);
246	0	OSSL_PARAM_free(params);
247	0	err:
248	0	OSSL_PARAM_BLD_free(tmpl);
249	0	return ret;
250	0	}
251
252		static void slh_dsa_load(const void reference, size_t reference_sz)
253	0	{
254	0	SLH_DSA_KEY *key = NULL;
255
256	0	if (ossl_prov_is_running() && reference_sz == sizeof(key)) {
257		/* The contents of the reference is the address to our object */
258	0	key = (SLH_DSA_KEY *)reference;
259		/* We grabbed, so we detach it */
260	0	(SLH_DSA_KEY *)reference = NULL;
261	0	return key;
262	0	}
263	0	return NULL;
264	0	}
265
266		static void slh_dsa_gen_init(void provctx, int selection,
267		const OSSL_PARAM params[])
268	0	{
269	0	OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
270	0	struct slh_dsa_gen_ctx *gctx = NULL;
271
272	0	if (!ossl_prov_is_running())
273	0	return NULL;
274
275	0	if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
276	0	gctx->libctx = libctx;
277	0	if (!slh_dsa_gen_set_params(gctx, params)) {
278	0	OPENSSL_free(gctx);
279	0	gctx = NULL;
280	0	}
281	0	}
282	0	return gctx;
283	0	}
284
285		#ifdef FIPS_MODULE
286		/*
287		* Refer to FIPS 140-3 IG 10.3.A Additional Comment 1
288		* Perform a pairwise test for SLH_DSA by signing and verifying a signature.
289		*/
290		static int slh_dsa_fips140_pairwise_test(const SLH_DSA_KEY *key,
291		SLH_DSA_HASH_CTX *ctx)
292		{
293		int ret = 0;
294		OSSL_SELF_TEST *st = NULL;
295		OSSL_CALLBACK *cb = NULL;
296		void *cb_arg = NULL;
297		uint8_t msg[16] = {0};
298		size_t msg_len = sizeof(msg);
299		uint8_t *sig = NULL;
300		size_t sig_len;
301		OSSL_LIB_CTX *lib_ctx;
302		int alloc_ctx = 0;
303
304		/* During self test, it is a waste to do this test */
305		if (ossl_fips_self_testing())
306		return 1;
307
308		if (ctx == NULL) {
309		ctx = ossl_slh_dsa_hash_ctx_new(key);
310		if (ctx == NULL)
311		return 0;
312		alloc_ctx = 1;
313		}
314		lib_ctx = ossl_slh_dsa_key_get0_libctx(key);
315
316		OSSL_SELF_TEST_get_callback(lib_ctx, &cb, &cb_arg);
317		st = OSSL_SELF_TEST_new(cb, cb_arg);
318		if (st == NULL)
319		goto err;
320
321		OSSL_SELF_TEST_onbegin(st, OSSL_SELF_TEST_TYPE_PCT,
322		OSSL_SELF_TEST_DESC_PCT_SLH_DSA);
323
324		sig_len = ossl_slh_dsa_key_get_sig_len(key);
325		sig = OPENSSL_malloc(sig_len);
326		if (sig == NULL)
327		goto err;
328
329		if (ossl_slh_dsa_sign(ctx, msg, msg_len, NULL, 0, NULL, 0,
330		sig, &sig_len, sig_len) != 1)
331		goto err;
332
333		OSSL_SELF_TEST_oncorrupt_byte(st, sig);
334
335		if (ossl_slh_dsa_verify(ctx, msg, msg_len, NULL, 0, 0, sig, sig_len) != 1)
336		goto err;
337
338		ret = 1;
339		err:
340		if (alloc_ctx)
341		ossl_slh_dsa_hash_ctx_free(ctx);
342		OPENSSL_free(sig);
343		OSSL_SELF_TEST_onend(st, ret);
344		OSSL_SELF_TEST_free(st);
345		return ret;
346		}
347		#endif /* FIPS_MODULE */
348
349		static void slh_dsa_gen(void genctx, const char *alg)
350	0	{
351	0	struct slh_dsa_gen_ctx *gctx = genctx;
352	0	SLH_DSA_KEY *key = NULL;
353	0	SLH_DSA_HASH_CTX *ctx = NULL;
354
355	0	if (!ossl_prov_is_running())
356	0	return NULL;
357	0	key = ossl_slh_dsa_key_new(gctx->libctx, gctx->propq, alg);
358	0	if (key == NULL)
359	0	return NULL;
360	0	ctx = ossl_slh_dsa_hash_ctx_new(key);
361	0	if (ctx == NULL)
362	0	goto err;
363	0	if (!ossl_slh_dsa_generate_key(ctx, key, gctx->libctx,
364	0	gctx->entropy, gctx->entropy_len))
365	0	goto err;
366		#ifdef FIPS_MODULE
367		if (!slh_dsa_fips140_pairwise_test(key, ctx)) {
368		ossl_set_error_state(OSSL_SELF_TEST_TYPE_PCT);
369		goto err;
370		}
371		#endif /* FIPS_MODULE */
372	0	ossl_slh_dsa_hash_ctx_free(ctx);
373	0	return key;
374	0	err:
375	0	ossl_slh_dsa_hash_ctx_free(ctx);
376	0	ossl_slh_dsa_key_free(key);
377	0	return NULL;
378	0	}
379
380		static int slh_dsa_gen_set_params(void *genctx, const OSSL_PARAM params[])
381	0	{
382	0	struct slh_dsa_gen_ctx *gctx = genctx;
383	0	const OSSL_PARAM *p;
384
385	0	if (gctx == NULL)
386	0	return 0;
387
388	0	p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_SLH_DSA_SEED);
389	0	if (p != NULL) {
390	0	void *vp = gctx->entropy;
391	0	size_t len = sizeof(gctx->entropy);
392
393	0	if (!OSSL_PARAM_get_octet_string(p, &vp, len, &(gctx->entropy_len))) {
394	0	gctx->entropy_len = 0;
395	0	return 0;
396	0	}
397	0	}
398
399	0	p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_PROPERTIES);
400	0	if (p != NULL) {
401	0	if (p->data_type != OSSL_PARAM_UTF8_STRING)
402	0	return 0;
403	0	OPENSSL_free(gctx->propq);
404	0	gctx->propq = OPENSSL_strdup(p->data);
405	0	if (gctx->propq == NULL)
406	0	return 0;
407	0	}
408	0	return 1;
409	0	}
410
411		static const OSSL_PARAM slh_dsa_gen_settable_params(ossl_unused void genctx,
412		ossl_unused void *provctx)
413	0	{
414	0	static OSSL_PARAM settable[] = {
415	0	OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_PROPERTIES, NULL, 0),
416	0	OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_SLH_DSA_SEED, NULL, 0),
417	0	OSSL_PARAM_END
418	0	};
419	0	return settable;
420	0	}
421
422		static void slh_dsa_gen_cleanup(void *genctx)
423	0	{
424	0	struct slh_dsa_gen_ctx *gctx = genctx;
425
426	0	if (gctx == NULL)
427	0	return;
428
429	0	OPENSSL_cleanse(gctx->entropy, gctx->entropy_len);
430	0	OPENSSL_free(gctx->propq);
431	0	OPENSSL_free(gctx);
432	0	}
433
434		#define MAKE_KEYMGMT_FUNCTIONS(alg, fn) \
435		static OSSL_FUNC_keymgmt_new_fn slh_dsa_##fn##_new_key; \
436		static OSSL_FUNC_keymgmt_gen_fn slh_dsa_##fn##_gen; \
437		static void slh_dsa_##fn##_new_key(void provctx) \
438	0	{ \
439	0	return slh_dsa_new_key(provctx, alg); \
440	0	} \ Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_128s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_128f_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_192s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_192f_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_256s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_256f_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_128s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_128f_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_192s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_192f_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_256s_new_key Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_256f_new_key
441		static void slh_dsa_##fn##_gen(void genctx, OSSL_CALLBACK osslcb, void cbarg)\
442	0	{ \
443	0	return slh_dsa_gen(genctx, alg); \
444	0	} \ Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_128s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_128f_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_192s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_192f_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_256s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_sha2_256f_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_128s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_128f_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_192s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_192f_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_256s_gen Unexecuted instantiation: slh_dsa_kmgmt.c:slh_dsa_shake_256f_gen
445		const OSSL_DISPATCH ossl_slh_dsa_##fn##_keymgmt_functions[] = { \
446		{ OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))slh_dsa_##fn##_new_key }, \
447		{ OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))slh_dsa_free_key }, \
448		{ OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))slh_dsa_dup_key }, \
449		{ OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))slh_dsa_has }, \
450		{ OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))slh_dsa_match }, \
451		{ OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))slh_dsa_import }, \
452		{ OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))slh_dsa_imexport_types },\
453		{ OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))slh_dsa_export }, \
454		{ OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))slh_dsa_imexport_types },\
455		{ OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))slh_dsa_load }, \
456		{ OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))slh_dsa_get_params }, \
457		{ OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))slh_dsa_gettable_params },\
458		{ OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))slh_dsa_validate }, \
459		{ OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))slh_dsa_gen_init }, \
460		{ OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))slh_dsa_##fn##_gen }, \
461		{ OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))slh_dsa_gen_cleanup },\
462		{ OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, \
463		(void (*)(void))slh_dsa_gen_set_params }, \
464		{ OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS, \
465		(void (*)(void))slh_dsa_gen_settable_params }, \
466		OSSL_DISPATCH_END \
467		}
468
469		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-128s", sha2_128s);
470		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-128f", sha2_128f);
471		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-192s", sha2_192s);
472		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-192f", sha2_192f);
473		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-256s", sha2_256s);
474		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHA2-256f", sha2_256f);
475		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-128s", shake_128s);
476		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-128f", shake_128f);
477		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-192s", shake_192s);
478		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-192f", shake_192f);
479		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-256s", shake_256s);
480		MAKE_KEYMGMT_FUNCTIONS("SLH-DSA-SHAKE-256f", shake_256f);