]> git.ipfire.org Git - thirdparty/openssl.git/blame - providers/implementations/keymgmt/rsa_kmgmt.c
Add KEM (Key encapsulation mechanism) support to providers
[thirdparty/openssl.git] / providers / implementations / keymgmt / rsa_kmgmt.c
CommitLineData
29be6023 1/*
96ebe52e 2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
29be6023
RL
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
c5f87134
P
10/*
11 * RSA low level APIs are deprecated for public use, but still ok for
12 * internal use.
13 */
14#include "internal/deprecated.h"
15
23c48d94 16#include <openssl/core_dispatch.h>
29be6023
RL
17#include <openssl/core_names.h>
18#include <openssl/bn.h>
8baa49ae 19#include <openssl/err.h>
29be6023 20#include <openssl/rsa.h>
8baa49ae 21#include <openssl/evp.h>
29be6023 22#include "prov/implementations.h"
1640d48c 23#include "prov/providercommon.h"
afb638f1 24#include "prov/provider_ctx.h"
29be6023 25#include "crypto/rsa.h"
1017b8e4 26#include "crypto/cryptlib.h"
96ebe52e 27#include "internal/param_build_set.h"
29be6023 28
363b1e5d
DMSP
29static OSSL_FUNC_keymgmt_new_fn rsa_newdata;
30static OSSL_FUNC_keymgmt_new_fn rsapss_newdata;
31static OSSL_FUNC_keymgmt_gen_init_fn rsa_gen_init;
32static OSSL_FUNC_keymgmt_gen_init_fn rsapss_gen_init;
33static OSSL_FUNC_keymgmt_gen_set_params_fn rsa_gen_set_params;
34static OSSL_FUNC_keymgmt_gen_settable_params_fn rsa_gen_settable_params;
35static OSSL_FUNC_keymgmt_gen_settable_params_fn rsapss_gen_settable_params;
36static OSSL_FUNC_keymgmt_gen_fn rsa_gen;
37static OSSL_FUNC_keymgmt_gen_cleanup_fn rsa_gen_cleanup;
1017b8e4 38static OSSL_FUNC_keymgmt_load_fn rsa_load;
363b1e5d
DMSP
39static OSSL_FUNC_keymgmt_free_fn rsa_freedata;
40static OSSL_FUNC_keymgmt_get_params_fn rsa_get_params;
41static OSSL_FUNC_keymgmt_gettable_params_fn rsa_gettable_params;
42static OSSL_FUNC_keymgmt_has_fn rsa_has;
43static OSSL_FUNC_keymgmt_match_fn rsa_match;
44static OSSL_FUNC_keymgmt_validate_fn rsa_validate;
45static OSSL_FUNC_keymgmt_import_fn rsa_import;
46static OSSL_FUNC_keymgmt_import_types_fn rsa_import_types;
47static OSSL_FUNC_keymgmt_export_fn rsa_export;
48static OSSL_FUNC_keymgmt_export_types_fn rsa_export_types;
80f4fd18 49static OSSL_FUNC_keymgmt_query_operation_name_fn rsa_query_operation_name;
29be6023 50
8baa49ae 51#define RSA_DEFAULT_MD "SHA256"
8a758e96
RL
52#define RSA_PSS_DEFAULT_MD OSSL_DIGEST_NAME_SHA1
53#define RSA_POSSIBLE_SELECTIONS \
8dd5c603 54 (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
8baa49ae 55
29be6023
RL
56DEFINE_STACK_OF(BIGNUM)
57DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
58
8a758e96
RL
59static int pss_params_fromdata(RSA_PSS_PARAMS_30 *pss_params,
60 const OSSL_PARAM params[], int rsa_type,
61 OPENSSL_CTX *libctx)
29be6023 62{
8a758e96
RL
63 if (!rsa_pss_params_30_fromdata(pss_params, params, libctx))
64 return 0;
29be6023 65
8a758e96
RL
66 /* If not a PSS type RSA, sending us PSS parameters is wrong */
67 if (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
68 && !rsa_pss_params_30_is_unrestricted(pss_params))
69 return 0;
29be6023 70
8a758e96 71 return 1;
29be6023
RL
72}
73
8dd5c603 74static void *rsa_newdata(void *provctx)
29be6023 75{
afb638f1 76 OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
422cbcee 77 RSA *rsa;
8a758e96 78
422cbcee
P
79 if (!ossl_prov_is_running())
80 return NULL;
81
82 rsa = rsa_new_with_ctx(libctx);
8a758e96
RL
83 if (rsa != NULL) {
84 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
85 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
86 }
87 return rsa;
88}
89
90static void *rsapss_newdata(void *provctx)
91{
92 OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
422cbcee
P
93 RSA *rsa;
94
95 if (!ossl_prov_is_running())
96 return NULL;
afb638f1 97
422cbcee 98 rsa = rsa_new_with_ctx(libctx);
8a758e96
RL
99 if (rsa != NULL) {
100 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
101 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS);
102 }
103 return rsa;
8dd5c603 104}
29be6023 105
8dd5c603
RL
106static void rsa_freedata(void *keydata)
107{
108 RSA_free(keydata);
29be6023
RL
109}
110
8dd5c603 111static int rsa_has(void *keydata, int selection)
29be6023 112{
8dd5c603
RL
113 RSA *rsa = keydata;
114 int ok = 0;
115
422cbcee 116 if (rsa != NULL && ossl_prov_is_running()) {
adc9f731
RL
117 if ((selection & RSA_POSSIBLE_SELECTIONS) != 0)
118 ok = 1;
119
120 if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
8a758e96
RL
121 /* This will change with OAEP */
122 ok = ok && (RSA_test_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS) != 0);
adc9f731
RL
123 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
124 ok = ok && (RSA_get0_e(rsa) != NULL);
125 if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
126 ok = ok && (RSA_get0_n(rsa) != NULL);
127 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
128 ok = ok && (RSA_get0_d(rsa) != NULL);
129 }
8dd5c603
RL
130 return ok;
131}
132
2888fc15
RL
133static int rsa_match(const void *keydata1, const void *keydata2, int selection)
134{
135 const RSA *rsa1 = keydata1;
136 const RSA *rsa2 = keydata2;
137 int ok = 1;
138
422cbcee
P
139 if (!ossl_prov_is_running())
140 return 0;
141
2888fc15
RL
142 /* There is always an |e| */
143 ok = ok && BN_cmp(RSA_get0_e(rsa1), RSA_get0_e(rsa2)) == 0;
144 if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
145 ok = ok && BN_cmp(RSA_get0_n(rsa1), RSA_get0_n(rsa2)) == 0;
146 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
147 ok = ok && BN_cmp(RSA_get0_d(rsa1), RSA_get0_d(rsa2)) == 0;
148 return ok;
149}
150
8dd5c603
RL
151static int rsa_import(void *keydata, int selection, const OSSL_PARAM params[])
152{
153 RSA *rsa = keydata;
8a758e96 154 int rsa_type;
8dd5c603
RL
155 int ok = 1;
156
422cbcee 157 if (!ossl_prov_is_running() || rsa == NULL)
8dd5c603
RL
158 return 0;
159
8a758e96
RL
160 if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
161 return 0;
162
163 rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
164
165 /* TODO(3.0) OAEP should bring on parameters as well */
8dd5c603 166
8a758e96
RL
167 if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
168 ok = ok && pss_params_fromdata(rsa_get0_pss_params_30(rsa), params,
169 rsa_type, rsa_get0_libctx(rsa));
8dd5c603 170 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
0abae163 171 ok = ok && rsa_fromdata(rsa, params);
8dd5c603
RL
172
173 return ok;
174}
175
176static int rsa_export(void *keydata, int selection,
177 OSSL_CALLBACK *param_callback, void *cbarg)
178{
179 RSA *rsa = keydata;
8a758e96 180 const RSA_PSS_PARAMS_30 *pss_params = rsa_get0_pss_params_30(rsa);
6d4e6009 181 OSSL_PARAM_BLD *tmpl;
1640d48c 182 OSSL_PARAM *params = NULL;
8dd5c603
RL
183 int ok = 1;
184
422cbcee 185 if (!ossl_prov_is_running() || rsa == NULL)
8dd5c603
RL
186 return 0;
187
8a758e96 188 /* TODO(3.0) OAEP should bring on parameters */
1640d48c 189
6d4e6009
P
190 tmpl = OSSL_PARAM_BLD_new();
191 if (tmpl == NULL)
192 return 0;
8dd5c603 193
8a758e96
RL
194 if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
195 ok = ok && (rsa_pss_params_30_is_unrestricted(pss_params)
196 || rsa_pss_params_30_todata(pss_params, NULL, tmpl, NULL));
8dd5c603 197 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
8a758e96 198 ok = ok && rsa_todata(rsa, tmpl, NULL);
8dd5c603
RL
199
200 if (!ok
96ebe52e
SL
201 || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL)
202 goto err;
8dd5c603
RL
203
204 ok = param_callback(params, cbarg);
6d4e6009 205 OSSL_PARAM_BLD_free_params(params);
96ebe52e
SL
206err:
207 OSSL_PARAM_BLD_free(tmpl);
8dd5c603 208 return ok;
29be6023
RL
209}
210
f844f9eb 211#ifdef FIPS_MODULE
96ebe52e
SL
212/* In fips mode there are no multi-primes. */
213# define RSA_KEY_MP_TYPES() \
214OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0), \
215OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0), \
216OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0), \
217OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0), \
218OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0),
219#else
220/*
221 * We allow up to 10 prime factors (starting with p, q).
222 * NOTE: there is only 9 OSSL_PKEY_PARAM_RSA_COEFFICIENT
223 */
224# define RSA_KEY_MP_TYPES() \
225OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0), \
226OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0), \
227OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR3, NULL, 0), \
228OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR4, NULL, 0), \
229OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR5, NULL, 0), \
230OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR6, NULL, 0), \
231OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR7, NULL, 0), \
232OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR8, NULL, 0), \
233OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR9, NULL, 0), \
234OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR10, NULL, 0), \
235OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0), \
236OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0), \
237OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT3, NULL, 0), \
238OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT4, NULL, 0), \
239OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT5, NULL, 0), \
240OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT6, NULL, 0), \
241OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT7, NULL, 0), \
242OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT8, NULL, 0), \
243OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT9, NULL, 0), \
244OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT10, NULL, 0), \
245OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0), \
246OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT2, NULL, 0), \
247OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT3, NULL, 0), \
248OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT4, NULL, 0), \
249OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT5, NULL, 0), \
250OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT6, NULL, 0), \
251OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT7, NULL, 0), \
252OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT8, NULL, 0), \
253OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT9, NULL, 0),
254#endif
255
256#define RSA_KEY_TYPES() \
257OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_N, NULL, 0), \
258OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0), \
259OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_D, NULL, 0), \
260RSA_KEY_MP_TYPES()
261
29be6023
RL
262/*
263 * This provider can export everything in an RSA key, so we use the exact
264 * same type description for export as for import. Other providers might
265 * choose to import full keys, but only export the public parts, and will
266 * therefore have the importkey_types and importkey_types functions return
267 * different arrays.
268 */
269static const OSSL_PARAM rsa_key_types[] = {
96ebe52e
SL
270 RSA_KEY_TYPES()
271 OSSL_PARAM_END
29be6023
RL
272};
273/*
274 * We lied about the amount of factors, exponents and coefficients, the
275 * export and import functions can really deal with an infinite amount
276 * of these numbers. However, RSA keys with too many primes are futile,
277 * so we at least pretend to have some limits.
278 */
279
273a67e3 280static const OSSL_PARAM *rsa_imexport_types(int selection)
29be6023 281{
273a67e3 282 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
8dd5c603
RL
283 return rsa_key_types;
284 return NULL;
29be6023
RL
285}
286
8dd5c603 287static const OSSL_PARAM *rsa_import_types(int selection)
29be6023 288{
273a67e3
RL
289 return rsa_imexport_types(selection);
290}
291
273a67e3
RL
292static const OSSL_PARAM *rsa_export_types(int selection)
293{
294 return rsa_imexport_types(selection);
29be6023
RL
295}
296
8dd5c603 297static int rsa_get_params(void *key, OSSL_PARAM params[])
9e5aaf78
RL
298{
299 RSA *rsa = key;
8a758e96
RL
300 const RSA_PSS_PARAMS_30 *pss_params = rsa_get0_pss_params_30(rsa);
301 int rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
9e5aaf78
RL
302 OSSL_PARAM *p;
303
304 if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
305 && !OSSL_PARAM_set_int(p, RSA_bits(rsa)))
306 return 0;
307 if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
308 && !OSSL_PARAM_set_int(p, RSA_security_bits(rsa)))
309 return 0;
310 if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
311 && !OSSL_PARAM_set_int(p, RSA_size(rsa)))
312 return 0;
8baa49ae 313
8a758e96
RL
314 /*
315 * For RSA-PSS keys, we ignore the default digest request
316 * TODO(3.0) with RSA-OAEP keys, this may need to be amended
317 */
318 if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_DEFAULT_DIGEST)) != NULL
319 && rsa_type != RSA_FLAG_TYPE_RSASSAPSS) {
320 if (!OSSL_PARAM_set_utf8_string(p, RSA_DEFAULT_MD))
321 return 0;
322 }
323
324 /*
325 * For non-RSA-PSS keys, we ignore the mandatory digest request
326 * TODO(3.0) with RSA-OAEP keys, this may need to be amended
327 */
8baa49ae
RL
328 if ((p = OSSL_PARAM_locate(params,
329 OSSL_PKEY_PARAM_MANDATORY_DIGEST)) != NULL
8a758e96
RL
330 && rsa_type == RSA_FLAG_TYPE_RSASSAPSS) {
331 const char *mdname = RSA_PSS_DEFAULT_MD;
8baa49ae 332
8a758e96
RL
333 if (!rsa_pss_params_30_is_unrestricted(pss_params)) {
334 mdname =
335 rsa_oaeppss_nid2name(rsa_pss_params_30_hashalg(pss_params));
336
337 if (mdname == NULL || !OSSL_PARAM_set_utf8_string(p, mdname))
338 return 0;
8baa49ae 339 }
afb638f1 340 }
8a758e96
RL
341 return (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
342 || rsa_pss_params_30_todata(pss_params, NULL, NULL, params))
343 && rsa_todata(rsa, NULL, params);
9e5aaf78
RL
344}
345
273a67e3
RL
346static const OSSL_PARAM rsa_params[] = {
347 OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
348 OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
349 OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
350 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_DEFAULT_DIGEST, NULL, 0),
96ebe52e 351 RSA_KEY_TYPES()
273a67e3
RL
352 OSSL_PARAM_END
353};
354
af5e1e85 355static const OSSL_PARAM *rsa_gettable_params(void *provctx)
273a67e3
RL
356{
357 return rsa_params;
358}
359
8dd5c603 360static int rsa_validate(void *keydata, int selection)
12603de6 361{
8dd5c603
RL
362 RSA *rsa = keydata;
363 int ok = 0;
364
422cbcee
P
365 if (!ossl_prov_is_running())
366 return 0;
367
8dd5c603
RL
368 if ((selection & RSA_POSSIBLE_SELECTIONS) != 0)
369 ok = 1;
370
371 /* If the whole key is selected, we do a pairwise validation */
372 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
373 == OSSL_KEYMGMT_SELECT_KEYPAIR) {
374 ok = ok && rsa_validate_pairwise(rsa);
375 } else {
376 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
377 ok = ok && rsa_validate_private(rsa);
378 if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
379 ok = ok && rsa_validate_public(rsa);
380 }
381 return ok;
12603de6
SL
382}
383
2972af10
RL
384struct rsa_gen_ctx {
385 OPENSSL_CTX *libctx;
386
8a758e96
RL
387 int rsa_type;
388
2972af10
RL
389 size_t nbits;
390 BIGNUM *pub_exp;
391 size_t primes;
392
8a758e96
RL
393 /* For PSS */
394 RSA_PSS_PARAMS_30 pss_params;
395
2972af10
RL
396 /* For generation callback */
397 OSSL_CALLBACK *cb;
398 void *cbarg;
4f2271d5
SL
399
400#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
401 /* ACVP test parameters */
402 OSSL_PARAM *acvp_test_params;
403#endif
2972af10
RL
404};
405
406static int rsa_gencb(int p, int n, BN_GENCB *cb)
407{
408 struct rsa_gen_ctx *gctx = BN_GENCB_get_arg(cb);
409 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };
410
411 params[0] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_POTENTIAL, &p);
412 params[1] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_ITERATION, &n);
2972af10
RL
413 return gctx->cb(params, gctx->cbarg);
414}
415
8a758e96 416static void *gen_init(void *provctx, int selection, int rsa_type)
2972af10
RL
417{
418 OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
419 struct rsa_gen_ctx *gctx = NULL;
420
422cbcee
P
421 if (!ossl_prov_is_running())
422 return NULL;
423
2972af10
RL
424 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
425 return NULL;
426
427 if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
428 gctx->libctx = libctx;
429 if ((gctx->pub_exp = BN_new()) == NULL
430 || !BN_set_word(gctx->pub_exp, RSA_F4)) {
431 BN_free(gctx->pub_exp);
ba61a0e6 432 OPENSSL_free(gctx);
2972af10
RL
433 gctx = NULL;
434 } else {
435 gctx->nbits = 2048;
436 gctx->primes = RSA_DEFAULT_PRIME_NUM;
4d55122e 437 gctx->rsa_type = rsa_type;
2972af10
RL
438 }
439 }
440 return gctx;
441}
442
8a758e96
RL
443static void *rsa_gen_init(void *provctx, int selection)
444{
445 return gen_init(provctx, selection, RSA_FLAG_TYPE_RSA);
446}
447
448static void *rsapss_gen_init(void *provctx, int selection)
449{
450 return gen_init(provctx, selection, RSA_FLAG_TYPE_RSASSAPSS);
451}
452
453/*
454 * This function is common for all RSA sub-types, to detect possible
455 * misuse, such as PSS parameters being passed when a plain RSA key
456 * is generated.
457 */
2972af10
RL
458static int rsa_gen_set_params(void *genctx, const OSSL_PARAM params[])
459{
460 struct rsa_gen_ctx *gctx = genctx;
461 const OSSL_PARAM *p;
462
463 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_BITS)) != NULL
464 && !OSSL_PARAM_get_size_t(p, &gctx->nbits))
465 return 0;
466 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PRIMES)) != NULL
467 && !OSSL_PARAM_get_size_t(p, &gctx->primes))
468 return 0;
469 if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_E)) != NULL
470 && !OSSL_PARAM_get_BN(p, &gctx->pub_exp))
471 return 0;
8a758e96
RL
472 /* Only attempt to get PSS parameters when generating an RSA-PSS key */
473 if (gctx->rsa_type == RSA_FLAG_TYPE_RSASSAPSS
474 && !pss_params_fromdata(&gctx->pss_params, params, gctx->rsa_type,
475 gctx->libctx))
476 return 0;
4f2271d5
SL
477#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
478 /* Any ACVP test related parameters are copied into a params[] */
479 if (!rsa_acvp_test_gen_params_new(&gctx->acvp_test_params, params))
480 return 0;
481#endif
2972af10
RL
482 return 1;
483}
484
8a758e96
RL
485#define rsa_gen_basic \
486 OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_BITS, NULL), \
487 OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_PRIMES, NULL), \
488 OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0)
489
490/*
491 * The following must be kept in sync with rsa_pss_params_30_fromdata()
492 * in crypto/rsa/rsa_backend.c
493 */
494#define rsa_gen_pss \
495 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_DIGEST, NULL, 0), \
496 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MASKGENFUNC, NULL, 0), \
497 OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MGF1_DIGEST, NULL, 0), \
498 OSSL_PARAM_int(OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, NULL)
499
2972af10
RL
500static const OSSL_PARAM *rsa_gen_settable_params(void *provctx)
501{
502 static OSSL_PARAM settable[] = {
8a758e96
RL
503 rsa_gen_basic,
504 OSSL_PARAM_END
505 };
506
507 return settable;
508}
509
510static const OSSL_PARAM *rsapss_gen_settable_params(void *provctx)
511{
512 static OSSL_PARAM settable[] = {
513 rsa_gen_basic,
514 rsa_gen_pss,
2972af10
RL
515 OSSL_PARAM_END
516 };
517
518 return settable;
519}
520
521static void *rsa_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
522{
523 struct rsa_gen_ctx *gctx = genctx;
8a758e96 524 RSA *rsa = NULL, *rsa_tmp = NULL;
2972af10
RL
525 BN_GENCB *gencb = NULL;
526
422cbcee 527 if (!ossl_prov_is_running() || gctx == NULL)
3f17066f
P
528 return NULL;
529
8a758e96
RL
530 switch (gctx->rsa_type) {
531 case RSA_FLAG_TYPE_RSA:
532 /* For plain RSA keys, PSS parameters must not be set */
533 if (!rsa_pss_params_30_is_unrestricted(&gctx->pss_params))
534 goto err;
535 break;
536 case RSA_FLAG_TYPE_RSASSAPSS:
537 /*
538 * For plain RSA-PSS keys, PSS parameters may be set but don't have
539 * to, so not check.
540 */
541 break;
542 default:
543 /* Unsupported RSA key sub-type... */
544 return NULL;
545 }
546
3f17066f 547 if ((rsa_tmp = rsa_new_with_ctx(gctx->libctx)) == NULL)
2972af10
RL
548 return NULL;
549
550 gctx->cb = osslcb;
551 gctx->cbarg = cbarg;
552 gencb = BN_GENCB_new();
553 if (gencb != NULL)
554 BN_GENCB_set(gencb, rsa_gencb, genctx);
555
4f2271d5
SL
556#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
557 if (gctx->acvp_test_params != NULL) {
558 if (!rsa_acvp_test_set_params(rsa_tmp, gctx->acvp_test_params))
559 goto err;
560 }
561#endif
562
8a758e96
RL
563 if (!RSA_generate_multi_prime_key(rsa_tmp,
564 (int)gctx->nbits, (int)gctx->primes,
565 gctx->pub_exp, gencb))
566 goto err;
2972af10 567
8a758e96
RL
568 if (!rsa_pss_params_30_copy(rsa_get0_pss_params_30(rsa_tmp),
569 &gctx->pss_params))
570 goto err;
2972af10 571
8a758e96
RL
572 RSA_clear_flags(rsa_tmp, RSA_FLAG_TYPE_MASK);
573 RSA_set_flags(rsa_tmp, gctx->rsa_type);
574
575 rsa = rsa_tmp;
576 rsa_tmp = NULL;
577 err:
578 BN_GENCB_free(gencb);
579 RSA_free(rsa_tmp);
2972af10
RL
580 return rsa;
581}
582
583static void rsa_gen_cleanup(void *genctx)
584{
585 struct rsa_gen_ctx *gctx = genctx;
586
587 if (gctx == NULL)
588 return;
4f2271d5
SL
589#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
590 rsa_acvp_test_gen_params_free(gctx->acvp_test_params);
591 gctx->acvp_test_params = NULL;
592#endif
2972af10
RL
593 BN_clear_free(gctx->pub_exp);
594 OPENSSL_free(gctx);
595}
596
1017b8e4
RL
597void *rsa_load(const void *reference, size_t reference_sz)
598{
599 RSA *rsa = NULL;
600
422cbcee 601 if (ossl_prov_is_running() && reference_sz == sizeof(rsa)) {
1017b8e4
RL
602 /* The contents of the reference is the address to our object */
603 rsa = *(RSA **)reference;
604 /* We grabbed, so we detach it */
605 *(RSA **)reference = NULL;
606 return rsa;
607 }
608 return NULL;
609}
610
8a758e96 611/* For any RSA key, we use the "RSA" algorithms regardless of sub-type. */
80f4fd18 612static const char *rsa_query_operation_name(int operation_id)
8a758e96
RL
613{
614 return "RSA";
615}
616
29be6023 617const OSSL_DISPATCH rsa_keymgmt_functions[] = {
8dd5c603 618 { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsa_newdata },
2972af10
RL
619 { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsa_gen_init },
620 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS,
621 (void (*)(void))rsa_gen_set_params },
622 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
623 (void (*)(void))rsa_gen_settable_params },
624 { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
625 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
1017b8e4 626 { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsa_load },
8dd5c603 627 { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
273a67e3
RL
628 { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))rsa_get_params },
629 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))rsa_gettable_params },
8dd5c603 630 { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
2888fc15 631 { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
273a67e3 632 { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
8dd5c603
RL
633 { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
634 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
635 { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
636 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
29be6023
RL
637 { 0, NULL }
638};
8a758e96
RL
639
640const OSSL_DISPATCH rsapss_keymgmt_functions[] = {
641 { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsapss_newdata },
642 { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsapss_gen_init },
643 { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))rsa_gen_set_params },
644 { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
645 (void (*)(void))rsapss_gen_settable_params },
646 { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
647 { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
a4e55ccc 648 { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsa_load },
8a758e96
RL
649 { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
650 { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))rsa_get_params },
651 { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))rsa_gettable_params },
652 { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
456b3b97 653 { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
8a758e96
RL
654 { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
655 { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
656 { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
657 { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
658 { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
659 { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
80f4fd18 660 (void (*)(void))rsa_query_operation_name },
8a758e96
RL
661 { 0, NULL }
662};