/src/openssl/providers/implementations/signature/ml_dsa_sig.c

Source
/*
 * Copyright 2024-2026 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 "internal/deprecated.h"

#include <assert.h>
#include <string.h> /* memset */
#include <openssl/core_names.h>
#include <openssl/err.h>
#include <openssl/rand.h>
#include <openssl/proverr.h>
#include "prov/implementations.h"
#include "prov/providercommon.h"
#include "prov/provider_ctx.h"
#include "prov/der_ml_dsa.h"
#include "crypto/ml_dsa.h"
#include "internal/common.h"
#include "internal/packet.h"
#include "internal/sizes.h"
#include "internal/fips.h"
#include "fips/fipsindicator.h"

#define ml_dsa_set_ctx_params_st ml_dsa_verifymsg_set_ctx_params_st
#define ml_dsa_set_ctx_params_decoder ml_dsa_verifymsg_set_ctx_params_decoder

#include "providers/implementations/signature/ml_dsa_sig.inc"

#define ML_DSA_MESSAGE_ENCODE_RAW 0
#define ML_DSA_MESSAGE_ENCODE_PURE 1

static OSSL_FUNC_signature_sign_message_init_fn ml_dsa_sign_msg_init;
static OSSL_FUNC_signature_sign_message_update_fn ml_dsa_signverify_msg_update;
static OSSL_FUNC_signature_sign_message_final_fn ml_dsa_sign_msg_final;
static OSSL_FUNC_signature_sign_fn ml_dsa_sign;
static OSSL_FUNC_signature_verify_message_init_fn ml_dsa_verify_msg_init;
static OSSL_FUNC_signature_verify_message_update_fn ml_dsa_signverify_msg_update;
static OSSL_FUNC_signature_verify_message_final_fn ml_dsa_verify_msg_final;
static OSSL_FUNC_signature_verify_fn ml_dsa_verify;
static OSSL_FUNC_signature_digest_sign_init_fn ml_dsa_digest_signverify_init;
static OSSL_FUNC_signature_digest_sign_fn ml_dsa_digest_sign;
static OSSL_FUNC_signature_digest_verify_fn ml_dsa_digest_verify;
static OSSL_FUNC_signature_freectx_fn ml_dsa_freectx;
static OSSL_FUNC_signature_set_ctx_params_fn ml_dsa_set_ctx_params;
static OSSL_FUNC_signature_settable_ctx_params_fn ml_dsa_settable_ctx_params;
static OSSL_FUNC_signature_get_ctx_params_fn ml_dsa_get_ctx_params;
static OSSL_FUNC_signature_gettable_ctx_params_fn ml_dsa_gettable_ctx_params;
static OSSL_FUNC_signature_dupctx_fn ml_dsa_dupctx;

typedef struct {
    ML_DSA_KEY *key;
    OSSL_LIB_CTX *libctx;
    uint8_t context_string[ML_DSA_MAX_CONTEXT_STRING_LEN];
    size_t context_string_len;
    uint8_t test_entropy[ML_DSA_ENTROPY_LEN];
    size_t test_entropy_len;
    int msg_encode;
    int deterministic;
    int evp_type;
    /* The Algorithm Identifier of the signature algorithm */
    uint8_t aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
    size_t aid_len;
    int mu; /* Flag indicating we should begin from \mu, not the message */

    int operation;
    EVP_MD_CTX *md_ctx; /* Ctx for msg_init/update/final interface */
    unsigned char *sig; /* Signature, for verification */
    size_t siglen;
} PROV_ML_DSA_CTX;

static void ml_dsa_freectx(void *vctx)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;

    EVP_MD_CTX_free(ctx->md_ctx);
    OPENSSL_cleanse(ctx->test_entropy, ctx->test_entropy_len);
    OPENSSL_free(ctx->sig);
    OPENSSL_free(ctx);
}

static void *ml_dsa_newctx(void *provctx, int evp_type, const char *propq)
{
    PROV_ML_DSA_CTX *ctx;

    if (!ossl_prov_is_running())
        return NULL;

#ifdef FIPS_MODULE
    if (!ossl_deferred_self_test(PROV_LIBCTX_OF(provctx),
            ST_ID_SIG_ML_DSA_65))
        return NULL;
#endif

    ctx = OPENSSL_zalloc(sizeof(PROV_ML_DSA_CTX));
    if (ctx == NULL)
        return NULL;

    ctx->libctx = PROV_LIBCTX_OF(provctx);
    ctx->msg_encode = ML_DSA_MESSAGE_ENCODE_PURE;
    ctx->evp_type = evp_type;
    return ctx;
}

static void *ml_dsa_dupctx(void *vctx)
{
    PROV_ML_DSA_CTX *srcctx = (PROV_ML_DSA_CTX *)vctx;
    PROV_ML_DSA_CTX *dstctx;

    if (!ossl_prov_is_running())
        return NULL;

    /*
     * Note that the ML_DSA_KEY is ref counted via EVP_PKEY so we can just copy
     * the key here.
     */
    dstctx = OPENSSL_memdup(srcctx, sizeof(*srcctx));

    if (dstctx == NULL)
        return NULL;

    if (srcctx->sig != NULL) {
        dstctx->sig = OPENSSL_memdup(srcctx->sig, srcctx->siglen);
        if (dstctx->sig == NULL) {
            /*
             * Can't call ml_dsa_freectx() here, as it would free
             * md_ctx which has not been duplicated yet.
             */
            OPENSSL_free(dstctx);
            return NULL;
        }
    }

    if (srcctx->md_ctx != NULL) {
        dstctx->md_ctx = EVP_MD_CTX_dup(srcctx->md_ctx);
        if (dstctx->md_ctx == NULL) {
            ml_dsa_freectx(dstctx);
            return NULL;
        }
    }

    return dstctx;
}

static int set_alg_id_buffer(PROV_ML_DSA_CTX *ctx)
{
    int ret;
    WPACKET pkt;
    uint8_t *aid = NULL;

    /*
     * We do not care about DER writing errors.
     * All it really means is that for some reason, there's no
     * AlgorithmIdentifier to be had, but the operation itself is
     * still valid, just as long as it's not used to construct
     * anything that needs an AlgorithmIdentifier.
     */
    ctx->aid_len = 0;
    ret = WPACKET_init_der(&pkt, ctx->aid_buf, sizeof(ctx->aid_buf));
    ret = ret && ossl_DER_w_algorithmIdentifier_ML_DSA(&pkt, -1, ctx->key);
    if (ret && WPACKET_finish(&pkt)) {
        WPACKET_get_total_written(&pkt, &ctx->aid_len);
        aid = WPACKET_get_curr(&pkt);
    }
    WPACKET_cleanup(&pkt);
    if (aid != NULL && ctx->aid_len != 0)
        memmove(ctx->aid_buf, aid, ctx->aid_len);
    return 1;
}

static int ml_dsa_signverify_msg_init(void *vctx, void *vkey,
    const OSSL_PARAM params[], int operation,
    const char *desc)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;
    ML_DSA_KEY *key = vkey;

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

    if (vkey == NULL && ctx->key == NULL) {
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
        return 0;
    }

    if (key != NULL)
        ctx->key = vkey;
    if (!ossl_ml_dsa_key_matches(ctx->key, ctx->evp_type))
        return 0;

    set_alg_id_buffer(ctx);
    ctx->mu = 0;
    ctx->operation = operation;

    return ml_dsa_set_ctx_params(ctx, params);
}

static int ml_dsa_sign_msg_init(void *vctx, void *vkey, const OSSL_PARAM params[])
{
    return ml_dsa_signverify_msg_init(vctx, vkey, params,
        EVP_PKEY_OP_SIGNMSG, "ML_DSA Sign Init");
}

static int ml_dsa_digest_signverify_init(void *vctx, const char *mdname,
    void *vkey, const OSSL_PARAM params[])
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;

    if (mdname != NULL && mdname[0] != '\0') {
        ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
            "Explicit digest not supported for ML-DSA operations");
        return 0;
    }

    ctx->mu = 0;

    if (vkey == NULL && ctx->key != NULL)
        return ml_dsa_set_ctx_params(ctx, params);

    return ml_dsa_signverify_msg_init(vctx, vkey, params,
        EVP_PKEY_OP_SIGN, "ML_DSA Sign Init");
}

static int ml_dsa_signverify_msg_update(void *vctx,
    const unsigned char *data,
    size_t datalen)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;

    if (ctx == NULL)
        return 0;

    if (!ossl_prov_is_running())
        return 0;

    if (ctx->mu)
        return 0;

    if (ctx->md_ctx == NULL) {
        ctx->md_ctx = ossl_ml_dsa_mu_init(ctx->key, ctx->msg_encode,
            ctx->context_string,
            ctx->context_string_len);
        if (ctx->md_ctx == NULL)
            return 0;
    }

    return ossl_ml_dsa_mu_update(ctx->md_ctx, data, datalen);
}

static int ml_dsa_sign_msg_final(void *vctx, unsigned char *sig,
    size_t *siglen, size_t sigsize)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;
    uint8_t rand_tmp[ML_DSA_ENTROPY_LEN], *rnd = NULL;
    uint8_t mu[ML_DSA_MU_BYTES];
    int ret = 0;

    if (ctx == NULL)
        return 0;

    if (!ossl_prov_is_running())
        return 0;

    if (ctx->md_ctx == NULL)
        return 0;

    if (sig != NULL) {
        if (ctx->test_entropy_len != 0) {
            rnd = ctx->test_entropy;
        } else {
            rnd = rand_tmp;

            if (ctx->deterministic == 1)
                memset(rnd, 0, sizeof(rand_tmp));
            else if (RAND_priv_bytes_ex(ctx->libctx, rnd, sizeof(rand_tmp), 0) <= 0)
                return 0;
        }

        if (!ossl_ml_dsa_mu_finalize(ctx->md_ctx, mu, sizeof(mu))) {
            OPENSSL_cleanse(mu, sizeof(mu));
            return 0;
        }
    }

    ret = ossl_ml_dsa_sign(ctx->key, 1, mu, sizeof(mu), NULL, 0, rnd,
        sizeof(rand_tmp), 0, sig, siglen, sigsize);
    if (rnd != ctx->test_entropy)
        OPENSSL_cleanse(rand_tmp, sizeof(rand_tmp));
    OPENSSL_cleanse(mu, sizeof(mu));
    return ret;
}

static int ml_dsa_sign(void *vctx, uint8_t *sig, size_t *siglen, size_t sigsize,
    const uint8_t *msg, size_t msg_len)
{
    int ret = 0;
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;
    uint8_t rand_tmp[ML_DSA_ENTROPY_LEN], *rnd = NULL;

    if (!ossl_prov_is_running())
        return 0;

    if (sig != NULL) {
        if (ctx->test_entropy_len != 0) {
            rnd = ctx->test_entropy;
        } else {
            rnd = rand_tmp;

            if (ctx->deterministic == 1)
                memset(rnd, 0, sizeof(rand_tmp));
            else if (RAND_priv_bytes_ex(ctx->libctx, rnd, sizeof(rand_tmp), 0) <= 0)
                return 0;
        }
    }
    ret = ossl_ml_dsa_sign(ctx->key, ctx->mu, msg, msg_len,
        ctx->context_string, ctx->context_string_len,
        rnd, sizeof(rand_tmp), ctx->msg_encode,
        sig, siglen, sigsize);
    if (rnd != ctx->test_entropy)
        OPENSSL_cleanse(rand_tmp, sizeof(rand_tmp));
    return ret;
}

static int ml_dsa_digest_sign(void *vctx, uint8_t *sig, size_t *siglen, size_t sigsize,
    const uint8_t *tbs, size_t tbslen)
{
    return ml_dsa_sign(vctx, sig, siglen, sigsize, tbs, tbslen);
}

static int ml_dsa_verify_msg_init(void *vctx, void *vkey, const OSSL_PARAM params[])
{
    return ml_dsa_signverify_msg_init(vctx, vkey, params, EVP_PKEY_OP_VERIFYMSG,
        "ML_DSA Verify Init");
}

static int ml_dsa_verify_msg_final(void *vctx)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;
    uint8_t mu[ML_DSA_MU_BYTES];
    int ret = 0;

    if (!ossl_prov_is_running())
        return 0;

    if (ctx->md_ctx == NULL)
        return 0;

    if (ossl_ml_dsa_mu_finalize(ctx->md_ctx, mu, sizeof(mu)))
        ret = ossl_ml_dsa_verify(ctx->key, 1, mu, sizeof(mu), NULL, 0, 0,
            ctx->sig, ctx->siglen);

    OPENSSL_cleanse(mu, sizeof(mu));
    return ret;
}

static int ml_dsa_verify(void *vctx, const uint8_t *sig, size_t siglen,
    const uint8_t *msg, size_t msg_len)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;

    if (!ossl_prov_is_running())
        return 0;
    return ossl_ml_dsa_verify(ctx->key, ctx->mu, msg, msg_len,
        ctx->context_string, ctx->context_string_len,
        ctx->msg_encode, sig, siglen);
}
static int ml_dsa_digest_verify(void *vctx,
    const uint8_t *sig, size_t siglen,
    const uint8_t *tbs, size_t tbslen)
{
    return ml_dsa_verify(vctx, sig, siglen, tbs, tbslen);
}

/*
 * Only need the param list for the signing case.  The decoder and structure
 * are shared between the sign and verify cases.
 */

static int ml_dsa_set_ctx_params(void *vctx, const OSSL_PARAM params[])
{
    PROV_ML_DSA_CTX *pctx = (PROV_ML_DSA_CTX *)vctx;
    struct ml_dsa_verifymsg_set_ctx_params_st p;

    if (pctx == NULL || !ml_dsa_verifymsg_set_ctx_params_decoder(params, &p))
        return 0;

    if (p.ctx != NULL) {
        void *vp = pctx->context_string;

        if (!OSSL_PARAM_get_octet_string(p.ctx, &vp, sizeof(pctx->context_string),
                &(pctx->context_string_len))) {
            pctx->context_string_len = 0;
            return 0;
        }
    }

    if (p.ent != NULL) {
        void *vp = pctx->test_entropy;

        pctx->test_entropy_len = 0;
        if (!OSSL_PARAM_get_octet_string(p.ent, &vp, sizeof(pctx->test_entropy),
                &(pctx->test_entropy_len)))
            return 0;
        if (pctx->test_entropy_len != sizeof(pctx->test_entropy)) {
            pctx->test_entropy_len = 0;
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SEED_LENGTH);
            return 0;
        }
    }

    if (p.det != NULL && !OSSL_PARAM_get_int(p.det, &pctx->deterministic))
        return 0;

    if (p.msgenc != NULL && !OSSL_PARAM_get_int(p.msgenc, &pctx->msg_encode))
        return 0;

    if (p.mu != NULL && !OSSL_PARAM_get_int(p.mu, &pctx->mu))
        return 0;

    if (p.sig != NULL && pctx->operation == EVP_PKEY_OP_VERIFYMSG) {
        OPENSSL_free(pctx->sig);
        pctx->sig = NULL;
        pctx->siglen = 0;
        if (!OSSL_PARAM_get_octet_string(p.sig, (void **)&pctx->sig,
                0, &pctx->siglen))
            return 0;
    }

    return 1;
}

static const OSSL_PARAM *ml_dsa_settable_ctx_params(void *vctx,
    ossl_unused void *provctx)
{
    PROV_ML_DSA_CTX *pctx = (PROV_ML_DSA_CTX *)vctx;

    if (pctx != NULL && pctx->operation == EVP_PKEY_OP_VERIFYMSG)
        return ml_dsa_verifymsg_set_ctx_params_list;
    else
        return ml_dsa_set_ctx_params_list;
}

static const OSSL_PARAM *ml_dsa_gettable_ctx_params(ossl_unused void *vctx,
    ossl_unused void *provctx)
{
    return ml_dsa_get_ctx_params_list;
}

static int ml_dsa_get_ctx_params(void *vctx, OSSL_PARAM *params)
{
    PROV_ML_DSA_CTX *ctx = (PROV_ML_DSA_CTX *)vctx;
    struct ml_dsa_get_ctx_params_st p;

    if (ctx == NULL || !ml_dsa_get_ctx_params_decoder(params, &p))
        return 0;

    if (p.id != NULL
        && !OSSL_PARAM_set_octet_string(p.id,
            ctx->aid_len == 0 ? NULL : ctx->aid_buf,
            ctx->aid_len))
        return 0;

    if (!OSSL_FIPS_IND_GET_PARAM_CONDITIONAL(p.ind,
            ctx->test_entropy_len == 0
                && ctx->msg_encode == ML_DSA_MESSAGE_ENCODE_PURE))
        return 0;

    return 1;
}

#define MAKE_SIGNATURE_FUNCTIONS(alg)                                          \
    static OSSL_FUNC_signature_newctx_fn ml_dsa_##alg##_newctx;                \
    static void *ml_dsa_##alg##_newctx(void *provctx, const char *propq)       \
    {                                                                          \
        return ml_dsa_newctx(provctx, EVP_PKEY_ML_DSA_##alg, propq);           \
    }                                                                          \
    const OSSL_DISPATCH ossl_ml_dsa_##alg##_signature_functions[] = {          \
        { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))ml_dsa_##alg##_newctx }, \
        { OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_INIT,                               \
            (void (*)(void))ml_dsa_sign_msg_init },                            \
        { OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_UPDATE,                             \
            (void (*)(void))ml_dsa_signverify_msg_update },                    \
        { OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_FINAL,                              \
            (void (*)(void))ml_dsa_sign_msg_final },                           \
        { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))ml_dsa_sign },             \
        { OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_INIT,                             \
            (void (*)(void))ml_dsa_verify_msg_init },                          \
        { OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_UPDATE,                           \
            (void (*)(void))ml_dsa_signverify_msg_update },                    \
        { OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_FINAL,                            \
            (void (*)(void))ml_dsa_verify_msg_final },                         \
        { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))ml_dsa_verify },         \
        { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,                                \
            (void (*)(void))ml_dsa_digest_signverify_init },                   \
        { OSSL_FUNC_SIGNATURE_DIGEST_SIGN,                                     \
            (void (*)(void))ml_dsa_digest_sign },                              \
        { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,                              \
            (void (*)(void))ml_dsa_digest_signverify_init },                   \
        { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY,                                   \
            (void (*)(void))ml_dsa_digest_verify },                            \
        { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))ml_dsa_freectx },       \
        { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS,                                  \
            (void (*)(void))ml_dsa_set_ctx_params },                           \
        { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,                             \
            (void (*)(void))ml_dsa_settable_ctx_params },                      \
        { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS,                                  \
            (void (*)(void))ml_dsa_get_ctx_params },                           \
        { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,                             \
            (void (*)(void))ml_dsa_gettable_ctx_params },                      \
        { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))ml_dsa_dupctx },         \
        OSSL_DISPATCH_END                                                      \
    }

MAKE_SIGNATURE_FUNCTIONS(44);
MAKE_SIGNATURE_FUNCTIONS(65);
MAKE_SIGNATURE_FUNCTIONS(87);

Coverage Report

Created: 2026-10-16 07:07

Line	Count	Source
1		/*
2		* Copyright 2024-2026 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 "internal/deprecated.h"
11
12		#include <assert.h>
13		#include <string.h> /* memset */
14		#include <openssl/core_names.h>
15		#include <openssl/err.h>
16		#include <openssl/rand.h>
17		#include <openssl/proverr.h>
18		#include "prov/implementations.h"
19		#include "prov/providercommon.h"
20		#include "prov/provider_ctx.h"
21		#include "prov/der_ml_dsa.h"
22		#include "crypto/ml_dsa.h"
23		#include "internal/common.h"
24		#include "internal/packet.h"
25		#include "internal/sizes.h"
26		#include "internal/fips.h"
27		#include "fips/fipsindicator.h"
28
29		#define ml_dsa_set_ctx_params_st ml_dsa_verifymsg_set_ctx_params_st
30		#define ml_dsa_set_ctx_params_decoder ml_dsa_verifymsg_set_ctx_params_decoder
31
32		#include "providers/implementations/signature/ml_dsa_sig.inc"
33
34		#define ML_DSA_MESSAGE_ENCODE_RAW 0
35	0	#define ML_DSA_MESSAGE_ENCODE_PURE 1
36
37		static OSSL_FUNC_signature_sign_message_init_fn ml_dsa_sign_msg_init;
38		static OSSL_FUNC_signature_sign_message_update_fn ml_dsa_signverify_msg_update;
39		static OSSL_FUNC_signature_sign_message_final_fn ml_dsa_sign_msg_final;
40		static OSSL_FUNC_signature_sign_fn ml_dsa_sign;
41		static OSSL_FUNC_signature_verify_message_init_fn ml_dsa_verify_msg_init;
42		static OSSL_FUNC_signature_verify_message_update_fn ml_dsa_signverify_msg_update;
43		static OSSL_FUNC_signature_verify_message_final_fn ml_dsa_verify_msg_final;
44		static OSSL_FUNC_signature_verify_fn ml_dsa_verify;
45		static OSSL_FUNC_signature_digest_sign_init_fn ml_dsa_digest_signverify_init;
46		static OSSL_FUNC_signature_digest_sign_fn ml_dsa_digest_sign;
47		static OSSL_FUNC_signature_digest_verify_fn ml_dsa_digest_verify;
48		static OSSL_FUNC_signature_freectx_fn ml_dsa_freectx;
49		static OSSL_FUNC_signature_set_ctx_params_fn ml_dsa_set_ctx_params;
50		static OSSL_FUNC_signature_settable_ctx_params_fn ml_dsa_settable_ctx_params;
51		static OSSL_FUNC_signature_get_ctx_params_fn ml_dsa_get_ctx_params;
52		static OSSL_FUNC_signature_gettable_ctx_params_fn ml_dsa_gettable_ctx_params;
53		static OSSL_FUNC_signature_dupctx_fn ml_dsa_dupctx;
54
55		typedef struct {
56		ML_DSA_KEY *key;
57		OSSL_LIB_CTX *libctx;
58		uint8_t context_string[ML_DSA_MAX_CONTEXT_STRING_LEN];
59		size_t context_string_len;
60		uint8_t test_entropy[ML_DSA_ENTROPY_LEN];
61		size_t test_entropy_len;
62		int msg_encode;
63		int deterministic;
64		int evp_type;
65		/* The Algorithm Identifier of the signature algorithm */
66		uint8_t aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
67		size_t aid_len;
68		int mu; /* Flag indicating we should begin from \mu, not the message */
69
70		int operation;
71		EVP_MD_CTX md_ctx; / Ctx for msg_init/update/final interface */
72		unsigned char sig; / Signature, for verification */
73		size_t siglen;
74		} PROV_ML_DSA_CTX;
75
76		static void ml_dsa_freectx(void *vctx)
77	0	{
78	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
79
80	0	EVP_MD_CTX_free(ctx->md_ctx);
81	0	OPENSSL_cleanse(ctx->test_entropy, ctx->test_entropy_len);
82	0	OPENSSL_free(ctx->sig);
83	0	OPENSSL_free(ctx);
84	0	}
85
86		static void ml_dsa_newctx(void provctx, int evp_type, const char *propq)
87	0	{
88	0	PROV_ML_DSA_CTX *ctx;
89
90	0	if (!ossl_prov_is_running())
91	0	return NULL;
92
93		#ifdef FIPS_MODULE
94		if (!ossl_deferred_self_test(PROV_LIBCTX_OF(provctx),
95		ST_ID_SIG_ML_DSA_65))
96		return NULL;
97		#endif
98
99	0	ctx = OPENSSL_zalloc(sizeof(PROV_ML_DSA_CTX));
100	0	if (ctx == NULL)
101	0	return NULL;
102
103	0	ctx->libctx = PROV_LIBCTX_OF(provctx);
104	0	ctx->msg_encode = ML_DSA_MESSAGE_ENCODE_PURE;
105	0	ctx->evp_type = evp_type;
106	0	return ctx;
107	0	}
108
109		static void ml_dsa_dupctx(void vctx)
110	0	{
111	0	PROV_ML_DSA_CTX srcctx = (PROV_ML_DSA_CTX )vctx;
112	0	PROV_ML_DSA_CTX *dstctx;
113
114	0	if (!ossl_prov_is_running())
115	0	return NULL;
116
117		/*
118		* Note that the ML_DSA_KEY is ref counted via EVP_PKEY so we can just copy
119		* the key here.
120		*/
121	0	dstctx = OPENSSL_memdup(srcctx, sizeof(*srcctx));
122
123	0	if (dstctx == NULL)
124	0	return NULL;
125
126	0	if (srcctx->sig != NULL) {
127	0	dstctx->sig = OPENSSL_memdup(srcctx->sig, srcctx->siglen);
128	0	if (dstctx->sig == NULL) {
129		/*
130		* Can't call ml_dsa_freectx() here, as it would free
131		* md_ctx which has not been duplicated yet.
132		*/
133	0	OPENSSL_free(dstctx);
134	0	return NULL;
135	0	}
136	0	}
137
138	0	if (srcctx->md_ctx != NULL) {
139	0	dstctx->md_ctx = EVP_MD_CTX_dup(srcctx->md_ctx);
140	0	if (dstctx->md_ctx == NULL) {
141	0	ml_dsa_freectx(dstctx);
142	0	return NULL;
143	0	}
144	0	}
145
146	0	return dstctx;
147	0	}
148
149		static int set_alg_id_buffer(PROV_ML_DSA_CTX *ctx)
150	0	{
151	0	int ret;
152	0	WPACKET pkt;
153	0	uint8_t *aid = NULL;
154
155		/*
156		* We do not care about DER writing errors.
157		* All it really means is that for some reason, there's no
158		* AlgorithmIdentifier to be had, but the operation itself is
159		* still valid, just as long as it's not used to construct
160		* anything that needs an AlgorithmIdentifier.
161		*/
162	0	ctx->aid_len = 0;
163	0	ret = WPACKET_init_der(&pkt, ctx->aid_buf, sizeof(ctx->aid_buf));
164	0	ret = ret && ossl_DER_w_algorithmIdentifier_ML_DSA(&pkt, -1, ctx->key);
165	0	if (ret && WPACKET_finish(&pkt)) {
166	0	WPACKET_get_total_written(&pkt, &ctx->aid_len);
167	0	aid = WPACKET_get_curr(&pkt);
168	0	}
169	0	WPACKET_cleanup(&pkt);
170	0	if (aid != NULL && ctx->aid_len != 0)
171	0	memmove(ctx->aid_buf, aid, ctx->aid_len);
172	0	return 1;
173	0	}
174
175		static int ml_dsa_signverify_msg_init(void vctx, void vkey,
176		const OSSL_PARAM params[], int operation,
177		const char *desc)
178	0	{
179	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
180	0	ML_DSA_KEY *key = vkey;
181
182	0	if (!ossl_prov_is_running()
183	0	\|\| ctx == NULL)
184	0	return 0;
185
186	0	if (vkey == NULL && ctx->key == NULL) {
187	0	ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
188	0	return 0;
189	0	}
190
191	0	if (key != NULL)
192	0	ctx->key = vkey;
193	0	if (!ossl_ml_dsa_key_matches(ctx->key, ctx->evp_type))
194	0	return 0;
195
196	0	set_alg_id_buffer(ctx);
197	0	ctx->mu = 0;
198	0	ctx->operation = operation;
199
200	0	return ml_dsa_set_ctx_params(ctx, params);
201	0	}
202
203		static int ml_dsa_sign_msg_init(void vctx, void vkey, const OSSL_PARAM params[])
204	0	{
205	0	return ml_dsa_signverify_msg_init(vctx, vkey, params,
206	0	EVP_PKEY_OP_SIGNMSG, "ML_DSA Sign Init");
207	0	}
208
209		static int ml_dsa_digest_signverify_init(void vctx, const char mdname,
210		void *vkey, const OSSL_PARAM params[])
211	0	{
212	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
213
214	0	if (mdname != NULL && mdname[0] != '\0') {
215	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
216	0	"Explicit digest not supported for ML-DSA operations");
217	0	return 0;
218	0	}
219
220	0	ctx->mu = 0;
221
222	0	if (vkey == NULL && ctx->key != NULL)
223	0	return ml_dsa_set_ctx_params(ctx, params);
224
225	0	return ml_dsa_signverify_msg_init(vctx, vkey, params,
226	0	EVP_PKEY_OP_SIGN, "ML_DSA Sign Init");
227	0	}
228
229		static int ml_dsa_signverify_msg_update(void *vctx,
230		const unsigned char *data,
231		size_t datalen)
232	0	{
233	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
234
235	0	if (ctx == NULL)
236	0	return 0;
237
238	0	if (!ossl_prov_is_running())
239	0	return 0;
240
241	0	if (ctx->mu)
242	0	return 0;
243
244	0	if (ctx->md_ctx == NULL) {
245	0	ctx->md_ctx = ossl_ml_dsa_mu_init(ctx->key, ctx->msg_encode,
246	0	ctx->context_string,
247	0	ctx->context_string_len);
248	0	if (ctx->md_ctx == NULL)
249	0	return 0;
250	0	}
251
252	0	return ossl_ml_dsa_mu_update(ctx->md_ctx, data, datalen);
253	0	}
254
255		static int ml_dsa_sign_msg_final(void vctx, unsigned char sig,
256		size_t *siglen, size_t sigsize)
257	0	{
258	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
259	0	uint8_t rand_tmp[ML_DSA_ENTROPY_LEN], *rnd = NULL;
260	0	uint8_t mu[ML_DSA_MU_BYTES];
261	0	int ret = 0;
262
263	0	if (ctx == NULL)
264	0	return 0;
265
266	0	if (!ossl_prov_is_running())
267	0	return 0;
268
269	0	if (ctx->md_ctx == NULL)
270	0	return 0;
271
272	0	if (sig != NULL) {
273	0	if (ctx->test_entropy_len != 0) {
274	0	rnd = ctx->test_entropy;
275	0	} else {
276	0	rnd = rand_tmp;
277
278	0	if (ctx->deterministic == 1)
279	0	memset(rnd, 0, sizeof(rand_tmp));
280	0	else if (RAND_priv_bytes_ex(ctx->libctx, rnd, sizeof(rand_tmp), 0) <= 0)
281	0	return 0;
282	0	}
283
284	0	if (!ossl_ml_dsa_mu_finalize(ctx->md_ctx, mu, sizeof(mu))) {
285	0	OPENSSL_cleanse(mu, sizeof(mu));
286	0	return 0;
287	0	}
288	0	}
289
290	0	ret = ossl_ml_dsa_sign(ctx->key, 1, mu, sizeof(mu), NULL, 0, rnd,
291	0	sizeof(rand_tmp), 0, sig, siglen, sigsize);
292	0	if (rnd != ctx->test_entropy)
293	0	OPENSSL_cleanse(rand_tmp, sizeof(rand_tmp));
294	0	OPENSSL_cleanse(mu, sizeof(mu));
295	0	return ret;
296	0	}
297
298		static int ml_dsa_sign(void vctx, uint8_t sig, size_t *siglen, size_t sigsize,
299		const uint8_t *msg, size_t msg_len)
300	0	{
301	0	int ret = 0;
302	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
303	0	uint8_t rand_tmp[ML_DSA_ENTROPY_LEN], *rnd = NULL;
304
305	0	if (!ossl_prov_is_running())
306	0	return 0;
307
308	0	if (sig != NULL) {
309	0	if (ctx->test_entropy_len != 0) {
310	0	rnd = ctx->test_entropy;
311	0	} else {
312	0	rnd = rand_tmp;
313
314	0	if (ctx->deterministic == 1)
315	0	memset(rnd, 0, sizeof(rand_tmp));
316	0	else if (RAND_priv_bytes_ex(ctx->libctx, rnd, sizeof(rand_tmp), 0) <= 0)
317	0	return 0;
318	0	}
319	0	}
320	0	ret = ossl_ml_dsa_sign(ctx->key, ctx->mu, msg, msg_len,
321	0	ctx->context_string, ctx->context_string_len,
322	0	rnd, sizeof(rand_tmp), ctx->msg_encode,
323	0	sig, siglen, sigsize);
324	0	if (rnd != ctx->test_entropy)
325	0	OPENSSL_cleanse(rand_tmp, sizeof(rand_tmp));
326	0	return ret;
327	0	}
328
329		static int ml_dsa_digest_sign(void vctx, uint8_t sig, size_t *siglen, size_t sigsize,
330		const uint8_t *tbs, size_t tbslen)
331	0	{
332	0	return ml_dsa_sign(vctx, sig, siglen, sigsize, tbs, tbslen);
333	0	}
334
335		static int ml_dsa_verify_msg_init(void vctx, void vkey, const OSSL_PARAM params[])
336	0	{
337	0	return ml_dsa_signverify_msg_init(vctx, vkey, params, EVP_PKEY_OP_VERIFYMSG,
338	0	"ML_DSA Verify Init");
339	0	}
340
341		static int ml_dsa_verify_msg_final(void *vctx)
342	0	{
343	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
344	0	uint8_t mu[ML_DSA_MU_BYTES];
345	0	int ret = 0;
346
347	0	if (!ossl_prov_is_running())
348	0	return 0;
349
350	0	if (ctx->md_ctx == NULL)
351	0	return 0;
352
353	0	if (ossl_ml_dsa_mu_finalize(ctx->md_ctx, mu, sizeof(mu)))
354	0	ret = ossl_ml_dsa_verify(ctx->key, 1, mu, sizeof(mu), NULL, 0, 0,
355	0	ctx->sig, ctx->siglen);
356
357	0	OPENSSL_cleanse(mu, sizeof(mu));
358	0	return ret;
359	0	}
360
361		static int ml_dsa_verify(void vctx, const uint8_t sig, size_t siglen,
362		const uint8_t *msg, size_t msg_len)
363	0	{
364	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
365
366	0	if (!ossl_prov_is_running())
367	0	return 0;
368	0	return ossl_ml_dsa_verify(ctx->key, ctx->mu, msg, msg_len,
369	0	ctx->context_string, ctx->context_string_len,
370	0	ctx->msg_encode, sig, siglen);
371	0	}
372		static int ml_dsa_digest_verify(void *vctx,
373		const uint8_t *sig, size_t siglen,
374		const uint8_t *tbs, size_t tbslen)
375	0	{
376	0	return ml_dsa_verify(vctx, sig, siglen, tbs, tbslen);
377	0	}
378
379		/*
380		* Only need the param list for the signing case. The decoder and structure
381		* are shared between the sign and verify cases.
382		*/
383
384		static int ml_dsa_set_ctx_params(void *vctx, const OSSL_PARAM params[])
385	0	{
386	0	PROV_ML_DSA_CTX pctx = (PROV_ML_DSA_CTX )vctx;
387	0	struct ml_dsa_verifymsg_set_ctx_params_st p;
388
389	0	if (pctx == NULL \|\| !ml_dsa_verifymsg_set_ctx_params_decoder(params, &p))
390	0	return 0;
391
392	0	if (p.ctx != NULL) {
393	0	void *vp = pctx->context_string;
394
395	0	if (!OSSL_PARAM_get_octet_string(p.ctx, &vp, sizeof(pctx->context_string),
396	0	&(pctx->context_string_len))) {
397	0	pctx->context_string_len = 0;
398	0	return 0;
399	0	}
400	0	}
401
402	0	if (p.ent != NULL) {
403	0	void *vp = pctx->test_entropy;
404
405	0	pctx->test_entropy_len = 0;
406	0	if (!OSSL_PARAM_get_octet_string(p.ent, &vp, sizeof(pctx->test_entropy),
407	0	&(pctx->test_entropy_len)))
408	0	return 0;
409	0	if (pctx->test_entropy_len != sizeof(pctx->test_entropy)) {
410	0	pctx->test_entropy_len = 0;
411	0	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SEED_LENGTH);
412	0	return 0;
413	0	}
414	0	}
415
416	0	if (p.det != NULL && !OSSL_PARAM_get_int(p.det, &pctx->deterministic))
417	0	return 0;
418
419	0	if (p.msgenc != NULL && !OSSL_PARAM_get_int(p.msgenc, &pctx->msg_encode))
420	0	return 0;
421
422	0	if (p.mu != NULL && !OSSL_PARAM_get_int(p.mu, &pctx->mu))
423	0	return 0;
424
425	0	if (p.sig != NULL && pctx->operation == EVP_PKEY_OP_VERIFYMSG) {
426	0	OPENSSL_free(pctx->sig);
427	0	pctx->sig = NULL;
428	0	pctx->siglen = 0;
429	0	if (!OSSL_PARAM_get_octet_string(p.sig, (void **)&pctx->sig,
430	0	0, &pctx->siglen))
431	0	return 0;
432	0	}
433
434	0	return 1;
435	0	}
436
437		static const OSSL_PARAM ml_dsa_settable_ctx_params(void vctx,
438		ossl_unused void *provctx)
439	0	{
440	0	PROV_ML_DSA_CTX pctx = (PROV_ML_DSA_CTX )vctx;
441
442	0	if (pctx != NULL && pctx->operation == EVP_PKEY_OP_VERIFYMSG)
443	0	return ml_dsa_verifymsg_set_ctx_params_list;
444	0	else
445	0	return ml_dsa_set_ctx_params_list;
446	0	}
447
448		static const OSSL_PARAM ml_dsa_gettable_ctx_params(ossl_unused void vctx,
449		ossl_unused void *provctx)
450	0	{
451	0	return ml_dsa_get_ctx_params_list;
452	0	}
453
454		static int ml_dsa_get_ctx_params(void vctx, OSSL_PARAM params)
455	0	{
456	0	PROV_ML_DSA_CTX ctx = (PROV_ML_DSA_CTX )vctx;
457	0	struct ml_dsa_get_ctx_params_st p;
458
459	0	if (ctx == NULL \|\| !ml_dsa_get_ctx_params_decoder(params, &p))
460	0	return 0;
461
462	0	if (p.id != NULL
463	0	&& !OSSL_PARAM_set_octet_string(p.id,
464	0	ctx->aid_len == 0 ? NULL : ctx->aid_buf,
465	0	ctx->aid_len))
466	0	return 0;
467
468	0	if (!OSSL_FIPS_IND_GET_PARAM_CONDITIONAL(p.ind,
469	0	ctx->test_entropy_len == 0
470	0	&& ctx->msg_encode == ML_DSA_MESSAGE_ENCODE_PURE))
471	0	return 0;
472
473	0	return 1;
474	0	}
475
476		#define MAKE_SIGNATURE_FUNCTIONS(alg) \
477		static OSSL_FUNC_signature_newctx_fn ml_dsa_##alg##_newctx; \
478		static void ml_dsa_##alg##_newctx(void provctx, const char *propq) \
479	0	{ \
480	0	return ml_dsa_newctx(provctx, EVP_PKEY_ML_DSA_##alg, propq); \
481	0	} \ Unexecuted instantiation: ml_dsa_sig.c:ml_dsa_44_newctx Unexecuted instantiation: ml_dsa_sig.c:ml_dsa_65_newctx Unexecuted instantiation: ml_dsa_sig.c:ml_dsa_87_newctx
482		const OSSL_DISPATCH ossl_ml_dsa_##alg##_signature_functions[] = { \
483		{ OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))ml_dsa_##alg##_newctx }, \
484		{ OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_INIT, \
485		(void (*)(void))ml_dsa_sign_msg_init }, \
486		{ OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_UPDATE, \
487		(void (*)(void))ml_dsa_signverify_msg_update }, \
488		{ OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_FINAL, \
489		(void (*)(void))ml_dsa_sign_msg_final }, \
490		{ OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))ml_dsa_sign }, \
491		{ OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_INIT, \
492		(void (*)(void))ml_dsa_verify_msg_init }, \
493		{ OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_UPDATE, \
494		(void (*)(void))ml_dsa_signverify_msg_update }, \
495		{ OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_FINAL, \
496		(void (*)(void))ml_dsa_verify_msg_final }, \
497		{ OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))ml_dsa_verify }, \
498		{ OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT, \
499		(void (*)(void))ml_dsa_digest_signverify_init }, \
500		{ OSSL_FUNC_SIGNATURE_DIGEST_SIGN, \
501		(void (*)(void))ml_dsa_digest_sign }, \
502		{ OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT, \
503		(void (*)(void))ml_dsa_digest_signverify_init }, \
504		{ OSSL_FUNC_SIGNATURE_DIGEST_VERIFY, \
505		(void (*)(void))ml_dsa_digest_verify }, \
506		{ OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))ml_dsa_freectx }, \
507		{ OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, \
508		(void (*)(void))ml_dsa_set_ctx_params }, \
509		{ OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS, \
510		(void (*)(void))ml_dsa_settable_ctx_params }, \
511		{ OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, \
512		(void (*)(void))ml_dsa_get_ctx_params }, \
513		{ OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS, \
514		(void (*)(void))ml_dsa_gettable_ctx_params }, \
515		{ OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))ml_dsa_dupctx }, \
516		OSSL_DISPATCH_END \
517		}
518
519		MAKE_SIGNATURE_FUNCTIONS(44);
520		MAKE_SIGNATURE_FUNCTIONS(65);
521		MAKE_SIGNATURE_FUNCTIONS(87);