2 * Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
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
11 * RSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
17 #include <openssl/core_names.h>
18 #include <openssl/params.h>
19 #include <openssl/err.h>
20 #include <openssl/evp.h>
22 # include <openssl/x509.h>
23 # include "crypto/asn1.h"
25 #include "internal/sizes.h"
26 #include "internal/param_build_set.h"
27 #include "crypto/rsa.h"
28 #include "rsa_local.h"
31 * The intention with the "backend" source file is to offer backend support
32 * for legacy backends (EVP_PKEY_ASN1_METHOD and EVP_PKEY_METHOD) and provider
33 * implementations alike.
36 DEFINE_STACK_OF(BIGNUM)
38 static int collect_numbers(STACK_OF(BIGNUM) *numbers,
39 const OSSL_PARAM params[], const char *names[])
41 const OSSL_PARAM *p = NULL;
47 for (i = 0; names[i] != NULL; i++){
48 p = OSSL_PARAM_locate_const(params, names[i]);
52 if (!OSSL_PARAM_get_BN(p, &tmp))
54 if (sk_BIGNUM_push(numbers, tmp) == 0) {
64 int ossl_rsa_fromdata(RSA *rsa, const OSSL_PARAM params[], int include_private)
66 const OSSL_PARAM *param_n, *param_e, *param_d = NULL;
67 BIGNUM *n = NULL, *e = NULL, *d = NULL;
68 STACK_OF(BIGNUM) *factors = NULL, *exps = NULL, *coeffs = NULL;
74 param_n = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_N);
75 param_e = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_E);
77 param_d = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_D);
79 if ((param_n != NULL && !OSSL_PARAM_get_BN(param_n, &n))
80 || (param_e != NULL && !OSSL_PARAM_get_BN(param_e, &e))
81 || (param_d != NULL && !OSSL_PARAM_get_BN(param_d, &d)))
84 is_private = (d != NULL);
86 if (!RSA_set0_key(rsa, n, e, d))
91 if (!collect_numbers(factors = sk_BIGNUM_new_null(), params,
92 ossl_rsa_mp_factor_names)
93 || !collect_numbers(exps = sk_BIGNUM_new_null(), params,
94 ossl_rsa_mp_exp_names)
95 || !collect_numbers(coeffs = sk_BIGNUM_new_null(), params,
96 ossl_rsa_mp_coeff_names))
99 /* It's ok if this private key just has n, e and d */
100 if (sk_BIGNUM_num(factors) != 0
101 && !ossl_rsa_set0_all_params(rsa, factors, exps, coeffs))
106 sk_BIGNUM_free(factors);
107 sk_BIGNUM_free(exps);
108 sk_BIGNUM_free(coeffs);
115 sk_BIGNUM_pop_free(factors, BN_free);
116 sk_BIGNUM_pop_free(exps, BN_free);
117 sk_BIGNUM_pop_free(coeffs, BN_free);
121 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
123 int ossl_rsa_todata(RSA *rsa, OSSL_PARAM_BLD *bld, OSSL_PARAM params[],
127 const BIGNUM *rsa_d = NULL, *rsa_n = NULL, *rsa_e = NULL;
128 STACK_OF(BIGNUM_const) *factors = sk_BIGNUM_const_new_null();
129 STACK_OF(BIGNUM_const) *exps = sk_BIGNUM_const_new_null();
130 STACK_OF(BIGNUM_const) *coeffs = sk_BIGNUM_const_new_null();
132 if (rsa == NULL || factors == NULL || exps == NULL || coeffs == NULL)
135 RSA_get0_key(rsa, &rsa_n, &rsa_e, &rsa_d);
136 ossl_rsa_get0_all_params(rsa, factors, exps, coeffs);
138 if (!ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_N, rsa_n)
139 || !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_E, rsa_e))
142 /* Check private key data integrity */
143 if (include_private && rsa_d != NULL) {
144 int numprimes = sk_BIGNUM_const_num(factors);
145 int numexps = sk_BIGNUM_const_num(exps);
146 int numcoeffs = sk_BIGNUM_const_num(coeffs);
149 * It's permissible to have zero primes, i.e. no CRT params.
150 * Otherwise, there must be at least two, as many exponents,
151 * and one coefficient less.
154 && (numprimes < 2 || numexps < 2 || numcoeffs < 1))
157 if (!ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_D,
159 || !ossl_param_build_set_multi_key_bn(bld, params,
160 ossl_rsa_mp_factor_names,
162 || !ossl_param_build_set_multi_key_bn(bld, params,
163 ossl_rsa_mp_exp_names, exps)
164 || !ossl_param_build_set_multi_key_bn(bld, params,
165 ossl_rsa_mp_coeff_names,
170 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
171 /* The acvp test results are not meant for export so check for bld == NULL */
173 ossl_rsa_acvp_test_get_params(rsa, params);
177 sk_BIGNUM_const_free(factors);
178 sk_BIGNUM_const_free(exps);
179 sk_BIGNUM_const_free(coeffs);
183 int ossl_rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30 *pss,
184 OSSL_PARAM_BLD *bld, OSSL_PARAM params[])
186 if (!ossl_rsa_pss_params_30_is_unrestricted(pss)) {
187 int hashalg_nid = ossl_rsa_pss_params_30_hashalg(pss);
188 int maskgenalg_nid = ossl_rsa_pss_params_30_maskgenalg(pss);
189 int maskgenhashalg_nid = ossl_rsa_pss_params_30_maskgenhashalg(pss);
190 int saltlen = ossl_rsa_pss_params_30_saltlen(pss);
191 int default_hashalg_nid = ossl_rsa_pss_params_30_hashalg(NULL);
192 int default_maskgenalg_nid = ossl_rsa_pss_params_30_maskgenalg(NULL);
193 int default_maskgenhashalg_nid =
194 ossl_rsa_pss_params_30_maskgenhashalg(NULL);
196 (hashalg_nid == default_hashalg_nid
197 ? NULL : ossl_rsa_oaeppss_nid2name(hashalg_nid));
198 const char *mgfname =
199 (maskgenalg_nid == default_maskgenalg_nid
200 ? NULL : ossl_rsa_oaeppss_nid2name(maskgenalg_nid));
201 const char *mgf1mdname =
202 (maskgenhashalg_nid == default_maskgenhashalg_nid
203 ? NULL : ossl_rsa_oaeppss_nid2name(maskgenhashalg_nid));
204 const char *key_md = OSSL_PKEY_PARAM_RSA_DIGEST;
205 const char *key_mgf = OSSL_PKEY_PARAM_RSA_MASKGENFUNC;
206 const char *key_mgf1_md = OSSL_PKEY_PARAM_RSA_MGF1_DIGEST;
207 const char *key_saltlen = OSSL_PKEY_PARAM_RSA_PSS_SALTLEN;
210 * To ensure that the key isn't seen as unrestricted by the recipient,
211 * we make sure that at least one PSS-related parameter is passed, even
212 * if it has a default value; saltlen.
215 && !ossl_param_build_set_utf8_string(bld, params, key_md, mdname))
217 && !ossl_param_build_set_utf8_string(bld, params,
219 || (mgf1mdname != NULL
220 && !ossl_param_build_set_utf8_string(bld, params,
221 key_mgf1_md, mgf1mdname))
222 || (!ossl_param_build_set_int(bld, params, key_saltlen, saltlen)))
228 int ossl_rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30 *pss_params,
230 const OSSL_PARAM params[],
231 OSSL_LIB_CTX *libctx)
233 const OSSL_PARAM *param_md, *param_mgf, *param_mgf1md, *param_saltlen;
234 const OSSL_PARAM *param_propq;
235 const char *propq = NULL;
236 EVP_MD *md = NULL, *mgf1md = NULL;
240 if (pss_params == NULL)
243 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_DIGEST_PROPS);
245 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_DIGEST);
247 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MASKGENFUNC);
249 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MGF1_DIGEST);
251 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PSS_SALTLEN);
253 if (param_propq != NULL) {
254 if (param_propq->data_type == OSSL_PARAM_UTF8_STRING)
255 propq = param_propq->data;
258 * If we get any of the parameters, we know we have at least some
259 * restrictions, so we start by setting default values, and let each
260 * parameter override their specific restriction data.
263 && (param_md != NULL || param_mgf != NULL || param_mgf1md != NULL
264 || param_saltlen != NULL)) {
265 if (!ossl_rsa_pss_params_30_set_defaults(pss_params))
270 if (param_mgf != NULL) {
271 int default_maskgenalg_nid = ossl_rsa_pss_params_30_maskgenalg(NULL);
272 const char *mgfname = NULL;
274 if (param_mgf->data_type == OSSL_PARAM_UTF8_STRING)
275 mgfname = param_mgf->data;
276 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgfname))
279 if (OPENSSL_strcasecmp(param_mgf->data,
280 ossl_rsa_mgf_nid2name(default_maskgenalg_nid)) != 0)
285 * We're only interested in the NIDs that correspond to the MDs, so the
286 * exact propquery is unimportant in the EVP_MD_fetch() calls below.
289 if (param_md != NULL) {
290 const char *mdname = NULL;
292 if (param_md->data_type == OSSL_PARAM_UTF8_STRING)
293 mdname = param_md->data;
294 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mdname))
297 if ((md = EVP_MD_fetch(libctx, mdname, propq)) == NULL
298 || !ossl_rsa_pss_params_30_set_hashalg(pss_params,
299 ossl_rsa_oaeppss_md2nid(md)))
303 if (param_mgf1md != NULL) {
304 const char *mgf1mdname = NULL;
306 if (param_mgf1md->data_type == OSSL_PARAM_UTF8_STRING)
307 mgf1mdname = param_mgf1md->data;
308 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgf1mdname))
311 if ((mgf1md = EVP_MD_fetch(libctx, mgf1mdname, propq)) == NULL
312 || !ossl_rsa_pss_params_30_set_maskgenhashalg(
313 pss_params, ossl_rsa_oaeppss_md2nid(mgf1md)))
317 if (param_saltlen != NULL) {
318 if (!OSSL_PARAM_get_int(param_saltlen, &saltlen)
319 || !ossl_rsa_pss_params_30_set_saltlen(pss_params, saltlen))
331 int ossl_rsa_is_foreign(const RSA *rsa)
334 if (rsa->engine != NULL || RSA_get_method(rsa) != RSA_PKCS1_OpenSSL())
340 static ossl_inline int rsa_bn_dup_check(BIGNUM **out, const BIGNUM *f)
342 if (f != NULL && (*out = BN_dup(f)) == NULL)
347 RSA *ossl_rsa_dup(const RSA *rsa, int selection)
354 /* Do not try to duplicate foreign RSA keys */
355 if (ossl_rsa_is_foreign(rsa))
358 if ((dupkey = ossl_rsa_new_with_ctx(rsa->libctx)) == NULL)
362 if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
363 if (!rsa_bn_dup_check(&dupkey->n, rsa->n))
365 if (!rsa_bn_dup_check(&dupkey->e, rsa->e))
369 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
372 if (!rsa_bn_dup_check(&dupkey->d, rsa->d))
375 /* factors and crt params */
376 if (!rsa_bn_dup_check(&dupkey->p, rsa->p))
378 if (!rsa_bn_dup_check(&dupkey->q, rsa->q))
380 if (!rsa_bn_dup_check(&dupkey->dmp1, rsa->dmp1))
382 if (!rsa_bn_dup_check(&dupkey->dmq1, rsa->dmq1))
384 if (!rsa_bn_dup_check(&dupkey->iqmp, rsa->iqmp))
388 dupkey->version = rsa->version;
389 dupkey->flags = rsa->flags;
390 /* we always copy the PSS parameters regardless of selection */
391 dupkey->pss_params = rsa->pss_params;
395 if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0
396 && (pnum = sk_RSA_PRIME_INFO_num(rsa->prime_infos)) > 0) {
397 dupkey->prime_infos = sk_RSA_PRIME_INFO_new_reserve(NULL, pnum);
398 if (dupkey->prime_infos == NULL)
400 for (i = 0; i < pnum; i++) {
401 const RSA_PRIME_INFO *pinfo = NULL;
402 RSA_PRIME_INFO *duppinfo = NULL;
404 if ((duppinfo = OPENSSL_zalloc(sizeof(*duppinfo))) == NULL) {
405 ERR_raise(ERR_LIB_RSA, ERR_R_MALLOC_FAILURE);
408 /* push first so cleanup in error case works */
409 (void)sk_RSA_PRIME_INFO_push(dupkey->prime_infos, duppinfo);
411 pinfo = sk_RSA_PRIME_INFO_value(rsa->prime_infos, i);
412 if (!rsa_bn_dup_check(&duppinfo->r, pinfo->r))
414 if (!rsa_bn_dup_check(&duppinfo->d, pinfo->d))
416 if (!rsa_bn_dup_check(&duppinfo->t, pinfo->t))
419 if (!ossl_rsa_multip_calc_product(dupkey))
423 if (rsa->pss != NULL) {
424 dupkey->pss = RSA_PSS_PARAMS_dup(rsa->pss);
425 if (rsa->pss->maskGenAlgorithm != NULL
426 && dupkey->pss->maskGenAlgorithm == NULL) {
427 dupkey->pss->maskHash = ossl_x509_algor_mgf1_decode(rsa->pss->maskGenAlgorithm);
428 if (dupkey->pss->maskHash == NULL)
432 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_RSA,
433 &dupkey->ex_data, &rsa->ex_data))
445 RSA_PSS_PARAMS *ossl_rsa_pss_decode(const X509_ALGOR *alg)
449 pss = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_PSS_PARAMS),
455 if (pss->maskGenAlgorithm != NULL) {
456 pss->maskHash = ossl_x509_algor_mgf1_decode(pss->maskGenAlgorithm);
457 if (pss->maskHash == NULL) {
458 RSA_PSS_PARAMS_free(pss);
466 static int ossl_rsa_sync_to_pss_params_30(RSA *rsa)
468 const RSA_PSS_PARAMS *legacy_pss = NULL;
469 RSA_PSS_PARAMS_30 *pss = NULL;
472 && (legacy_pss = RSA_get0_pss_params(rsa)) != NULL
473 && (pss = ossl_rsa_get0_pss_params_30(rsa)) != NULL) {
474 const EVP_MD *md = NULL, *mgf1md = NULL;
475 int md_nid, mgf1md_nid, saltlen, trailerField;
476 RSA_PSS_PARAMS_30 pss_params;
479 * We don't care about the validity of the fields here, we just
480 * want to synchronise values. Verifying here makes it impossible
481 * to even read a key with invalid values, making it hard to test
484 * Other routines use ossl_rsa_pss_get_param(), so the values will
485 * be checked, eventually.
487 if (!ossl_rsa_pss_get_param_unverified(legacy_pss, &md, &mgf1md,
488 &saltlen, &trailerField))
490 md_nid = EVP_MD_get_type(md);
491 mgf1md_nid = EVP_MD_get_type(mgf1md);
492 if (!ossl_rsa_pss_params_30_set_defaults(&pss_params)
493 || !ossl_rsa_pss_params_30_set_hashalg(&pss_params, md_nid)
494 || !ossl_rsa_pss_params_30_set_maskgenhashalg(&pss_params,
496 || !ossl_rsa_pss_params_30_set_saltlen(&pss_params, saltlen)
497 || !ossl_rsa_pss_params_30_set_trailerfield(&pss_params,
505 int ossl_rsa_pss_get_param_unverified(const RSA_PSS_PARAMS *pss,
506 const EVP_MD **pmd, const EVP_MD **pmgf1md,
507 int *psaltlen, int *ptrailerField)
509 RSA_PSS_PARAMS_30 pss_params;
511 /* Get the defaults from the ONE place */
512 (void)ossl_rsa_pss_params_30_set_defaults(&pss_params);
516 *pmd = ossl_x509_algor_get_md(pss->hashAlgorithm);
519 *pmgf1md = ossl_x509_algor_get_md(pss->maskHash);
520 if (*pmgf1md == NULL)
523 *psaltlen = ASN1_INTEGER_get(pss->saltLength);
525 *psaltlen = ossl_rsa_pss_params_30_saltlen(&pss_params);
526 if (pss->trailerField)
527 *ptrailerField = ASN1_INTEGER_get(pss->trailerField);
529 *ptrailerField = ossl_rsa_pss_params_30_trailerfield(&pss_params);;
534 int ossl_rsa_param_decode(RSA *rsa, const X509_ALGOR *alg)
537 const ASN1_OBJECT *algoid;
541 X509_ALGOR_get0(&algoid, &algptype, &algp, alg);
542 if (OBJ_obj2nid(algoid) != EVP_PKEY_RSA_PSS)
544 if (algptype == V_ASN1_UNDEF)
546 if (algptype != V_ASN1_SEQUENCE) {
547 ERR_raise(ERR_LIB_RSA, RSA_R_INVALID_PSS_PARAMETERS);
550 if ((pss = ossl_rsa_pss_decode(alg)) == NULL
551 || !ossl_rsa_set0_pss_params(rsa, pss)) {
552 RSA_PSS_PARAMS_free(pss);
555 if (!ossl_rsa_sync_to_pss_params_30(rsa))
560 RSA *ossl_rsa_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO *p8inf,
561 OSSL_LIB_CTX *libctx, const char *propq)
563 const unsigned char *p;
566 const X509_ALGOR *alg;
568 if (!PKCS8_pkey_get0(NULL, &p, &pklen, &alg, p8inf))
570 rsa = d2i_RSAPrivateKey(NULL, &p, pklen);
572 ERR_raise(ERR_LIB_RSA, ERR_R_RSA_LIB);
575 if (!ossl_rsa_param_decode(rsa, alg)) {
580 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
581 switch (OBJ_obj2nid(alg->algorithm)) {
583 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
585 case EVP_PKEY_RSA_PSS:
586 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS);
589 /* Leave the type bits zero */