Coverage Report

Created: 2025-12-10 06:24

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/providers/implementations/signature/slh_dsa_sig.c
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_names.h>
11
#include <openssl/err.h>
12
#include <openssl/rand.h>
13
#include <openssl/proverr.h>
14
#include <openssl/self_test.h>
15
#include "prov/implementations.h"
16
#include "prov/providercommon.h"
17
#include "prov/provider_ctx.h"
18
#include "prov/der_slh_dsa.h"
19
#include "crypto/slh_dsa.h"
20
#include "internal/cryptlib.h"
21
#include "internal/sizes.h"
22
#include "internal/fips.h"
23
#include "providers/implementations/signature/slh_dsa_sig.inc"
24
25
#define SLH_DSA_MAX_ADD_RANDOM_LEN 32
26
27
#define SLH_DSA_MESSAGE_ENCODE_RAW 0
28
0
#define SLH_DSA_MESSAGE_ENCODE_PURE 1
29
30
static OSSL_FUNC_signature_sign_message_init_fn slh_dsa_sign_msg_init;
31
static OSSL_FUNC_signature_sign_fn slh_dsa_sign;
32
static OSSL_FUNC_signature_verify_message_init_fn slh_dsa_verify_msg_init;
33
static OSSL_FUNC_signature_verify_fn slh_dsa_verify;
34
static OSSL_FUNC_signature_digest_sign_init_fn slh_dsa_digest_signverify_init;
35
static OSSL_FUNC_signature_digest_sign_fn slh_dsa_digest_sign;
36
static OSSL_FUNC_signature_digest_verify_fn slh_dsa_digest_verify;
37
static OSSL_FUNC_signature_freectx_fn slh_dsa_freectx;
38
static OSSL_FUNC_signature_dupctx_fn slh_dsa_dupctx;
39
static OSSL_FUNC_signature_set_ctx_params_fn slh_dsa_set_ctx_params;
40
static OSSL_FUNC_signature_settable_ctx_params_fn slh_dsa_settable_ctx_params;
41
42
#ifdef FIPS_MODULE
43
static FIPS_DEFERRED_TEST slh_sig_deferred_tests[] = {
44
    { "SLH-DSA-SHA2-128f",
45
        FIPS_DEFERRED_KAT_SIGNATURE,
46
        FIPS_DEFERRED_TEST_INIT },
47
    { "SLH-DSA-SHAKE-128f",
48
        FIPS_DEFERRED_KAT_SIGNATURE,
49
        FIPS_DEFERRED_TEST_INIT },
50
    { NULL, 0, 0 },
51
};
52
#endif
53
54
static int slh_dsa_self_check(OSSL_LIB_CTX *libctx)
55
0
{
56
0
    if (!ossl_prov_is_running())
57
0
        return 0;
58
59
#ifdef FIPS_MODULE
60
    return FIPS_deferred_self_tests(libctx, slh_sig_deferred_tests);
61
#else
62
0
    return 1;
63
0
#endif
64
0
}
65
66
/*
67
 * NOTE: Any changes to this structure may require updating slh_dsa_dupctx().
68
 */
69
typedef struct {
70
    SLH_DSA_KEY *key; /* Note that the key is not owned by this object */
71
    SLH_DSA_HASH_CTX *hash_ctx;
72
    uint8_t context_string[SLH_DSA_MAX_CONTEXT_STRING_LEN];
73
    size_t context_string_len;
74
    uint8_t add_random[SLH_DSA_MAX_ADD_RANDOM_LEN];
75
    size_t add_random_len;
76
    int msg_encode;
77
    int deterministic;
78
    OSSL_LIB_CTX *libctx;
79
    char *propq;
80
    const char *alg;
81
    /* The Algorithm Identifier of the signature algorithm */
82
    uint8_t aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
83
    size_t aid_len;
84
} PROV_SLH_DSA_CTX;
85
86
static void slh_dsa_freectx(void *vctx)
87
0
{
88
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
89
90
0
    ossl_slh_dsa_hash_ctx_free(ctx->hash_ctx);
91
0
    OPENSSL_free(ctx->propq);
92
0
    OPENSSL_cleanse(ctx->add_random, ctx->add_random_len);
93
0
    OPENSSL_free(ctx);
94
0
}
95
96
static void *slh_dsa_newctx(void *provctx, const char *alg, const char *propq)
97
0
{
98
0
    PROV_SLH_DSA_CTX *ctx;
99
100
0
    if (!slh_dsa_self_check(PROV_LIBCTX_OF(provctx)))
101
0
        return NULL;
102
103
0
    ctx = OPENSSL_zalloc(sizeof(PROV_SLH_DSA_CTX));
104
0
    if (ctx == NULL)
105
0
        return NULL;
106
107
0
    ctx->libctx = PROV_LIBCTX_OF(provctx);
108
0
    if (propq != NULL && (ctx->propq = OPENSSL_strdup(propq)) == NULL)
109
0
        goto err;
110
0
    ctx->alg = alg;
111
0
    ctx->msg_encode = SLH_DSA_MESSAGE_ENCODE_PURE;
112
0
    return ctx;
113
0
err:
114
0
    slh_dsa_freectx(ctx);
115
0
    return NULL;
116
0
}
117
118
static void *slh_dsa_dupctx(void *vctx)
119
0
{
120
0
    PROV_SLH_DSA_CTX *src = (PROV_SLH_DSA_CTX *)vctx;
121
0
    PROV_SLH_DSA_CTX *ret;
122
123
0
    if (!ossl_prov_is_running())
124
0
        return NULL;
125
126
    /*
127
     * Note that the SLH_DSA_KEY is ref counted via EVP_PKEY so we can just copy
128
     * the key here.
129
     */
130
0
    ret = OPENSSL_memdup(src, sizeof(*src));
131
0
    if (ret == NULL)
132
0
        return NULL;
133
0
    ret->propq = NULL;
134
0
    ret->hash_ctx = NULL;
135
0
    if (src->propq != NULL && (ret->propq = OPENSSL_strdup(src->propq)) == NULL)
136
0
        goto err;
137
0
    ret->hash_ctx = ossl_slh_dsa_hash_ctx_dup(src->hash_ctx);
138
0
    if (ret->hash_ctx == NULL)
139
0
        goto err;
140
141
0
    return ret;
142
0
err:
143
0
    slh_dsa_freectx(ret);
144
0
    return NULL;
145
0
}
146
147
static int slh_dsa_set_alg_id_buffer(PROV_SLH_DSA_CTX *ctx)
148
0
{
149
0
    int ret;
150
0
    WPACKET pkt;
151
0
    uint8_t *aid = NULL;
152
153
    /*
154
     * We do not care about DER writing errors.
155
     * All it really means is that for some reason, there's no
156
     * AlgorithmIdentifier to be had, but the operation itself is
157
     * still valid, just as long as it's not used to construct
158
     * anything that needs an AlgorithmIdentifier.
159
     */
160
0
    ctx->aid_len = 0;
161
0
    ret = WPACKET_init_der(&pkt, ctx->aid_buf, sizeof(ctx->aid_buf));
162
0
    ret = ret && ossl_DER_w_algorithmIdentifier_SLH_DSA(&pkt, -1, ctx->key);
163
0
    if (ret && WPACKET_finish(&pkt)) {
164
0
        WPACKET_get_total_written(&pkt, &ctx->aid_len);
165
0
        aid = WPACKET_get_curr(&pkt);
166
0
    }
167
0
    WPACKET_cleanup(&pkt);
168
0
    if (aid != NULL && ctx->aid_len != 0)
169
0
        memmove(ctx->aid_buf, aid, ctx->aid_len);
170
0
    return 1;
171
0
}
172
173
static int slh_dsa_signverify_msg_init(void *vctx, void *vkey,
174
    const OSSL_PARAM params[], int operation,
175
    const char *desc)
176
0
{
177
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
178
0
    SLH_DSA_KEY *key = vkey;
179
180
0
    if (!ossl_prov_is_running()
181
0
        || ctx == NULL)
182
0
        return 0;
183
184
0
    if (vkey == NULL && ctx->key == NULL) {
185
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
186
0
        return 0;
187
0
    }
188
189
0
    if (key != NULL) {
190
0
        if (!ossl_slh_dsa_key_type_matches(key, ctx->alg))
191
0
            return 0;
192
0
        ctx->hash_ctx = ossl_slh_dsa_hash_ctx_new(key);
193
0
        if (ctx->hash_ctx == NULL)
194
0
            return 0;
195
0
        ctx->key = vkey;
196
0
    }
197
198
0
    slh_dsa_set_alg_id_buffer(ctx);
199
0
    if (!slh_dsa_set_ctx_params(ctx, params))
200
0
        return 0;
201
0
    return 1;
202
0
}
203
204
static int slh_dsa_sign_msg_init(void *vctx, void *vkey, const OSSL_PARAM params[])
205
0
{
206
0
    return slh_dsa_signverify_msg_init(vctx, vkey, params,
207
0
        EVP_PKEY_OP_SIGN, "SLH_DSA Sign Init");
208
0
}
209
210
static int slh_dsa_digest_signverify_init(void *vctx, const char *mdname,
211
    void *vkey, const OSSL_PARAM params[])
212
0
{
213
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
214
215
0
    if (mdname != NULL && mdname[0] != '\0') {
216
0
        ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
217
0
            "Explicit digest not supported for SLH-DSA operations");
218
0
        return 0;
219
0
    }
220
221
0
    if (vkey == NULL && ctx->key != NULL)
222
0
        return slh_dsa_set_ctx_params(ctx, params);
223
224
0
    return slh_dsa_signverify_msg_init(vctx, vkey, params,
225
0
        EVP_PKEY_OP_SIGN, "SLH_DSA Sign Init");
226
0
}
227
228
static int slh_dsa_sign(void *vctx, unsigned char *sig, size_t *siglen,
229
    size_t sigsize, const unsigned char *msg, size_t msg_len)
230
0
{
231
0
    int ret = 0;
232
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
233
0
    uint8_t add_rand[SLH_DSA_MAX_ADD_RANDOM_LEN], *opt_rand = NULL;
234
0
    size_t n = 0;
235
236
0
    if (!ossl_prov_is_running())
237
0
        return 0;
238
239
0
    if (sig != NULL) {
240
0
        if (ctx->add_random_len != 0) {
241
0
            opt_rand = ctx->add_random;
242
0
        } else if (ctx->deterministic == 0) {
243
0
            n = ossl_slh_dsa_key_get_n(ctx->key);
244
0
            if (RAND_priv_bytes_ex(ctx->libctx, add_rand, n, 0) <= 0)
245
0
                return 0;
246
0
            opt_rand = add_rand;
247
0
        }
248
0
    }
249
0
    ret = ossl_slh_dsa_sign(ctx->hash_ctx, msg, msg_len,
250
0
        ctx->context_string, ctx->context_string_len,
251
0
        opt_rand, ctx->msg_encode,
252
0
        sig, siglen, sigsize);
253
0
    if (opt_rand != add_rand)
254
0
        OPENSSL_cleanse(opt_rand, n);
255
0
    return ret;
256
0
}
257
258
static int slh_dsa_digest_sign(void *vctx, uint8_t *sig, size_t *siglen, size_t sigsize,
259
    const uint8_t *tbs, size_t tbslen)
260
0
{
261
0
    return slh_dsa_sign(vctx, sig, siglen, sigsize, tbs, tbslen);
262
0
}
263
264
static int slh_dsa_verify_msg_init(void *vctx, void *vkey, const OSSL_PARAM params[])
265
0
{
266
0
    return slh_dsa_signverify_msg_init(vctx, vkey, params, EVP_PKEY_OP_VERIFY,
267
0
        "SLH_DSA Verify Init");
268
0
}
269
270
static int slh_dsa_verify(void *vctx, const uint8_t *sig, size_t siglen,
271
    const uint8_t *msg, size_t msg_len)
272
0
{
273
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
274
275
0
    if (!ossl_prov_is_running())
276
0
        return 0;
277
0
    return ossl_slh_dsa_verify(ctx->hash_ctx, msg, msg_len,
278
0
        ctx->context_string, ctx->context_string_len,
279
0
        ctx->msg_encode, sig, siglen);
280
0
}
281
static int slh_dsa_digest_verify(void *vctx, const uint8_t *sig, size_t siglen,
282
    const uint8_t *tbs, size_t tbslen)
283
0
{
284
0
    return slh_dsa_verify(vctx, sig, siglen, tbs, tbslen);
285
0
}
286
287
static int slh_dsa_set_ctx_params(void *vctx, const OSSL_PARAM params[])
288
0
{
289
0
    PROV_SLH_DSA_CTX *pctx = (PROV_SLH_DSA_CTX *)vctx;
290
0
    struct slh_dsa_set_ctx_params_st p;
291
292
0
    if (pctx == NULL || !slh_dsa_set_ctx_params_decoder(params, &p))
293
0
        return 0;
294
295
0
    if (p.context != NULL) {
296
0
        void *vp = pctx->context_string;
297
298
0
        if (!OSSL_PARAM_get_octet_string(p.context, &vp,
299
0
                sizeof(pctx->context_string),
300
0
                &(pctx->context_string_len))) {
301
0
            pctx->context_string_len = 0;
302
0
            return 0;
303
0
        }
304
0
    }
305
306
0
    if (p.entropy != NULL) {
307
0
        void *vp = pctx->add_random;
308
0
        size_t n = ossl_slh_dsa_key_get_n(pctx->key);
309
310
0
        if (!OSSL_PARAM_get_octet_string(p.entropy, &vp, n, &(pctx->add_random_len))
311
0
            || pctx->add_random_len != n) {
312
0
            pctx->add_random_len = 0;
313
0
            return 0;
314
0
        }
315
0
    }
316
317
0
    if (p.det != NULL && !OSSL_PARAM_get_int(p.det, &pctx->deterministic))
318
0
        return 0;
319
320
0
    if (p.msgenc != NULL && !OSSL_PARAM_get_int(p.msgenc, &pctx->msg_encode))
321
0
        return 0;
322
0
    return 1;
323
0
}
324
325
static const OSSL_PARAM *slh_dsa_settable_ctx_params(void *vctx,
326
    ossl_unused void *provctx)
327
0
{
328
0
    return slh_dsa_set_ctx_params_list;
329
0
}
330
331
static const OSSL_PARAM *slh_dsa_gettable_ctx_params(ossl_unused void *vctx,
332
    ossl_unused void *provctx)
333
0
{
334
0
    return slh_dsa_get_ctx_params_list;
335
0
}
336
337
static int slh_dsa_get_ctx_params(void *vctx, OSSL_PARAM *params)
338
0
{
339
0
    PROV_SLH_DSA_CTX *ctx = (PROV_SLH_DSA_CTX *)vctx;
340
0
    struct slh_dsa_get_ctx_params_st p;
341
342
0
    if (ctx == NULL || !slh_dsa_get_ctx_params_decoder(params, &p))
343
0
        return 0;
344
345
0
    if (p.algid != NULL
346
0
        && !OSSL_PARAM_set_octet_string(p.algid,
347
0
            ctx->aid_len == 0 ? NULL : ctx->aid_buf,
348
0
            ctx->aid_len))
349
0
        return 0;
350
351
0
    return 1;
352
0
}
353
354
#define MAKE_SIGNATURE_FUNCTIONS(alg, fn)                                               \
355
    static OSSL_FUNC_signature_newctx_fn slh_dsa_##fn##_newctx;                         \
356
    static void *slh_dsa_##fn##_newctx(void *provctx, const char *propq)                \
357
0
    {                                                                                   \
358
0
        return slh_dsa_newctx(provctx, alg, propq);                                     \
359
0
    }                                                                                   \
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_128s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_128f_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_192s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_192f_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_256s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_sha2_256f_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_128s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_128f_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_192s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_192f_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_256s_newctx
Unexecuted instantiation: slh_dsa_sig.c:slh_dsa_shake_256f_newctx
360
    const OSSL_DISPATCH ossl_slh_dsa_##fn##_signature_functions[] = {                   \
361
        { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))slh_dsa_##fn##_newctx },          \
362
        { OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_INIT,                                        \
363
            (void (*)(void))slh_dsa_sign_msg_init },                                    \
364
        { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))slh_dsa_sign },                     \
365
        { OSSL_FUNC_SIGNATURE_VERIFY_MESSAGE_INIT,                                      \
366
            (void (*)(void))slh_dsa_verify_msg_init },                                  \
367
        { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))slh_dsa_verify },                 \
368
        { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,                                         \
369
            (void (*)(void))slh_dsa_digest_signverify_init },                           \
370
        { OSSL_FUNC_SIGNATURE_DIGEST_SIGN,                                              \
371
            (void (*)(void))slh_dsa_digest_sign },                                      \
372
        { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,                                       \
373
            (void (*)(void))slh_dsa_digest_signverify_init },                           \
374
        { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY,                                            \
375
            (void (*)(void))slh_dsa_digest_verify },                                    \
376
        { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))slh_dsa_freectx },               \
377
        { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))slh_dsa_dupctx },                 \
378
        { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, (void (*)(void))slh_dsa_set_ctx_params }, \
379
        { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,                                      \
380
            (void (*)(void))slh_dsa_settable_ctx_params },                              \
381
        { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS,                                           \
382
            (void (*)(void))slh_dsa_get_ctx_params },                                   \
383
        { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,                                      \
384
            (void (*)(void))slh_dsa_gettable_ctx_params },                              \
385
        OSSL_DISPATCH_END                                                               \
386
    }
387
388
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-128s", sha2_128s);
389
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-128f", sha2_128f);
390
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-192s", sha2_192s);
391
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-192f", sha2_192f);
392
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-256s", sha2_256s);
393
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHA2-256f", sha2_256f);
394
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-128s", shake_128s);
395
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-128f", shake_128f);
396
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-192s", shake_192s);
397
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-192f", shake_192f);
398
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-256s", shake_256s);
399
MAKE_SIGNATURE_FUNCTIONS("SLH-DSA-SHAKE-256f", shake_256f);