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