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