2 * Copyright 2020-2021 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"
30 #include "e_os.h" /* strcasecmp for Windows() */
33 * The intention with the "backend" source file is to offer backend support
34 * for legacy backends (EVP_PKEY_ASN1_METHOD and EVP_PKEY_METHOD) and provider
35 * implementations alike.
38 DEFINE_STACK_OF(BIGNUM
)
40 static int collect_numbers(STACK_OF(BIGNUM
) *numbers
,
41 const OSSL_PARAM params
[], const char *names
[])
43 const OSSL_PARAM
*p
= NULL
;
49 for (i
= 0; names
[i
] != NULL
; i
++){
50 p
= OSSL_PARAM_locate_const(params
, names
[i
]);
54 if (!OSSL_PARAM_get_BN(p
, &tmp
)
55 || sk_BIGNUM_push(numbers
, tmp
) == 0)
63 int ossl_rsa_fromdata(RSA
*rsa
, const OSSL_PARAM params
[])
65 const OSSL_PARAM
*param_n
, *param_e
, *param_d
;
66 BIGNUM
*n
= NULL
, *e
= NULL
, *d
= NULL
;
67 STACK_OF(BIGNUM
) *factors
= NULL
, *exps
= NULL
, *coeffs
= NULL
;
73 param_n
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_N
);
74 param_e
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_E
);
75 param_d
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_D
);
77 if ((param_n
!= NULL
&& !OSSL_PARAM_get_BN(param_n
, &n
))
78 || (param_e
!= NULL
&& !OSSL_PARAM_get_BN(param_e
, &e
))
79 || (param_d
!= NULL
&& !OSSL_PARAM_get_BN(param_d
, &d
)))
82 is_private
= (d
!= NULL
);
84 if (!RSA_set0_key(rsa
, n
, e
, d
))
89 if (!collect_numbers(factors
= sk_BIGNUM_new_null(), params
,
90 ossl_rsa_mp_factor_names
)
91 || !collect_numbers(exps
= sk_BIGNUM_new_null(), params
,
92 ossl_rsa_mp_exp_names
)
93 || !collect_numbers(coeffs
= sk_BIGNUM_new_null(), params
,
94 ossl_rsa_mp_coeff_names
))
97 /* It's ok if this private key just has n, e and d */
98 if (sk_BIGNUM_num(factors
) != 0
99 && !ossl_rsa_set0_all_params(rsa
, factors
, exps
, coeffs
))
104 sk_BIGNUM_free(factors
);
105 sk_BIGNUM_free(exps
);
106 sk_BIGNUM_free(coeffs
);
113 sk_BIGNUM_pop_free(factors
, BN_free
);
114 sk_BIGNUM_pop_free(exps
, BN_free
);
115 sk_BIGNUM_pop_free(coeffs
, BN_free
);
119 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const
, BIGNUM
)
121 int ossl_rsa_todata(RSA
*rsa
, OSSL_PARAM_BLD
*bld
, OSSL_PARAM params
[])
124 const BIGNUM
*rsa_d
= NULL
, *rsa_n
= NULL
, *rsa_e
= NULL
;
125 STACK_OF(BIGNUM_const
) *factors
= sk_BIGNUM_const_new_null();
126 STACK_OF(BIGNUM_const
) *exps
= sk_BIGNUM_const_new_null();
127 STACK_OF(BIGNUM_const
) *coeffs
= sk_BIGNUM_const_new_null();
129 if (rsa
== NULL
|| factors
== NULL
|| exps
== NULL
|| coeffs
== NULL
)
132 RSA_get0_key(rsa
, &rsa_n
, &rsa_e
, &rsa_d
);
133 ossl_rsa_get0_all_params(rsa
, factors
, exps
, coeffs
);
135 if (!ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_N
, rsa_n
)
136 || !ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_E
, rsa_e
))
139 /* Check private key data integrity */
141 int numprimes
= sk_BIGNUM_const_num(factors
);
142 int numexps
= sk_BIGNUM_const_num(exps
);
143 int numcoeffs
= sk_BIGNUM_const_num(coeffs
);
146 * It's permissible to have zero primes, i.e. no CRT params.
147 * Otherwise, there must be at least two, as many exponents,
148 * and one coefficient less.
151 && (numprimes
< 2 || numexps
< 2 || numcoeffs
< 1))
154 if (!ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_D
,
156 || !ossl_param_build_set_multi_key_bn(bld
, params
,
157 ossl_rsa_mp_factor_names
,
159 || !ossl_param_build_set_multi_key_bn(bld
, params
,
160 ossl_rsa_mp_exp_names
, exps
)
161 || !ossl_param_build_set_multi_key_bn(bld
, params
,
162 ossl_rsa_mp_coeff_names
,
167 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
168 /* The acvp test results are not meant for export so check for bld == NULL */
170 ossl_rsa_acvp_test_get_params(rsa
, params
);
174 sk_BIGNUM_const_free(factors
);
175 sk_BIGNUM_const_free(exps
);
176 sk_BIGNUM_const_free(coeffs
);
180 int ossl_rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30
*pss
,
181 OSSL_PARAM_BLD
*bld
, OSSL_PARAM params
[])
183 if (!ossl_rsa_pss_params_30_is_unrestricted(pss
)) {
184 int hashalg_nid
= ossl_rsa_pss_params_30_hashalg(pss
);
185 int maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(pss
);
186 int maskgenhashalg_nid
= ossl_rsa_pss_params_30_maskgenhashalg(pss
);
187 int saltlen
= ossl_rsa_pss_params_30_saltlen(pss
);
188 int default_hashalg_nid
= ossl_rsa_pss_params_30_hashalg(NULL
);
189 int default_maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(NULL
);
190 int default_maskgenhashalg_nid
=
191 ossl_rsa_pss_params_30_maskgenhashalg(NULL
);
193 (hashalg_nid
== default_hashalg_nid
194 ? NULL
: ossl_rsa_oaeppss_nid2name(hashalg_nid
));
195 const char *mgfname
=
196 (maskgenalg_nid
== default_maskgenalg_nid
197 ? NULL
: ossl_rsa_oaeppss_nid2name(maskgenalg_nid
));
198 const char *mgf1mdname
=
199 (maskgenhashalg_nid
== default_maskgenhashalg_nid
200 ? NULL
: ossl_rsa_oaeppss_nid2name(maskgenhashalg_nid
));
201 const char *key_md
= OSSL_PKEY_PARAM_RSA_DIGEST
;
202 const char *key_mgf
= OSSL_PKEY_PARAM_RSA_MASKGENFUNC
;
203 const char *key_mgf1_md
= OSSL_PKEY_PARAM_RSA_MGF1_DIGEST
;
204 const char *key_saltlen
= OSSL_PKEY_PARAM_RSA_PSS_SALTLEN
;
207 * To ensure that the key isn't seen as unrestricted by the recipient,
208 * we make sure that at least one PSS-related parameter is passed, even
209 * if it has a default value; saltlen.
212 && !ossl_param_build_set_utf8_string(bld
, params
, key_md
, mdname
))
214 && !ossl_param_build_set_utf8_string(bld
, params
,
216 || (mgf1mdname
!= NULL
217 && !ossl_param_build_set_utf8_string(bld
, params
,
218 key_mgf1_md
, mgf1mdname
))
219 || (!ossl_param_build_set_int(bld
, params
, key_saltlen
, saltlen
)))
225 int ossl_rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30
*pss_params
,
227 const OSSL_PARAM params
[],
228 OSSL_LIB_CTX
*libctx
)
230 const OSSL_PARAM
*param_md
, *param_mgf
, *param_mgf1md
, *param_saltlen
;
231 const OSSL_PARAM
*param_propq
;
232 const char *propq
= NULL
;
233 EVP_MD
*md
= NULL
, *mgf1md
= NULL
;
237 if (pss_params
== NULL
)
240 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_DIGEST_PROPS
);
242 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_DIGEST
);
244 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_MASKGENFUNC
);
246 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_MGF1_DIGEST
);
248 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_PSS_SALTLEN
);
250 if (param_propq
!= NULL
) {
251 if (param_propq
->data_type
== OSSL_PARAM_UTF8_STRING
)
252 propq
= param_propq
->data
;
255 * If we get any of the parameters, we know we have at least some
256 * restrictions, so we start by setting default values, and let each
257 * parameter override their specific restriction data.
260 && (param_md
!= NULL
|| param_mgf
!= NULL
|| param_mgf1md
!= NULL
261 || param_saltlen
!= NULL
)) {
262 if (!ossl_rsa_pss_params_30_set_defaults(pss_params
))
267 if (param_mgf
!= NULL
) {
268 int default_maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(NULL
);
269 const char *mgfname
= NULL
;
271 if (param_mgf
->data_type
== OSSL_PARAM_UTF8_STRING
)
272 mgfname
= param_mgf
->data
;
273 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mgfname
))
276 if (strcasecmp(param_mgf
->data
,
277 ossl_rsa_mgf_nid2name(default_maskgenalg_nid
)) != 0)
282 * We're only interested in the NIDs that correspond to the MDs, so the
283 * exact propquery is unimportant in the EVP_MD_fetch() calls below.
286 if (param_md
!= NULL
) {
287 const char *mdname
= NULL
;
289 if (param_md
->data_type
== OSSL_PARAM_UTF8_STRING
)
290 mdname
= param_md
->data
;
291 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mdname
))
294 if ((md
= EVP_MD_fetch(libctx
, mdname
, propq
)) == NULL
295 || !ossl_rsa_pss_params_30_set_hashalg(pss_params
,
296 ossl_rsa_oaeppss_md2nid(md
)))
300 if (param_mgf1md
!= NULL
) {
301 const char *mgf1mdname
= NULL
;
303 if (param_mgf1md
->data_type
== OSSL_PARAM_UTF8_STRING
)
304 mgf1mdname
= param_mgf1md
->data
;
305 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mgf1mdname
))
308 if ((mgf1md
= EVP_MD_fetch(libctx
, mgf1mdname
, propq
)) == NULL
309 || !ossl_rsa_pss_params_30_set_maskgenhashalg(
310 pss_params
, ossl_rsa_oaeppss_md2nid(mgf1md
)))
314 if (param_saltlen
!= NULL
) {
315 if (!OSSL_PARAM_get_int(param_saltlen
, &saltlen
)
316 || !ossl_rsa_pss_params_30_set_saltlen(pss_params
, saltlen
))
328 int ossl_rsa_is_foreign(const RSA
*rsa
)
331 if (rsa
->engine
!= NULL
|| RSA_get_method(rsa
) != RSA_PKCS1_OpenSSL())
337 static ossl_inline
int rsa_bn_dup_check(BIGNUM
**out
, const BIGNUM
*f
)
339 if (f
!= NULL
&& (*out
= BN_dup(f
)) == NULL
)
344 RSA
*ossl_rsa_dup(const RSA
*rsa
, int selection
)
351 /* Do not try to duplicate foreign RSA keys */
352 if (ossl_rsa_is_foreign(rsa
))
355 if ((dupkey
= ossl_rsa_new_with_ctx(rsa
->libctx
)) == NULL
)
359 if ((selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) != 0) {
360 if (!rsa_bn_dup_check(&dupkey
->n
, rsa
->n
))
362 if (!rsa_bn_dup_check(&dupkey
->e
, rsa
->e
))
366 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0) {
369 if (!rsa_bn_dup_check(&dupkey
->d
, rsa
->d
))
372 /* factors and crt params */
373 if (!rsa_bn_dup_check(&dupkey
->p
, rsa
->p
))
375 if (!rsa_bn_dup_check(&dupkey
->q
, rsa
->q
))
377 if (!rsa_bn_dup_check(&dupkey
->dmp1
, rsa
->dmp1
))
379 if (!rsa_bn_dup_check(&dupkey
->dmq1
, rsa
->dmq1
))
381 if (!rsa_bn_dup_check(&dupkey
->iqmp
, rsa
->iqmp
))
385 dupkey
->version
= rsa
->version
;
386 dupkey
->flags
= rsa
->flags
;
387 /* we always copy the PSS parameters regardless of selection */
388 dupkey
->pss_params
= rsa
->pss_params
;
392 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0
393 && (pnum
= sk_RSA_PRIME_INFO_num(rsa
->prime_infos
)) > 0) {
394 dupkey
->prime_infos
= sk_RSA_PRIME_INFO_new_reserve(NULL
, pnum
);
395 for (i
= 0; i
< pnum
; i
++) {
396 const RSA_PRIME_INFO
*pinfo
= NULL
;
397 RSA_PRIME_INFO
*duppinfo
= NULL
;
399 if ((duppinfo
= OPENSSL_zalloc(sizeof(*duppinfo
))) == NULL
) {
400 ERR_raise(ERR_LIB_RSA
, ERR_R_MALLOC_FAILURE
);
403 /* push first so cleanup in error case works */
404 (void)sk_RSA_PRIME_INFO_push(dupkey
->prime_infos
, duppinfo
);
406 pinfo
= sk_RSA_PRIME_INFO_value(rsa
->prime_infos
, i
);
407 if (!rsa_bn_dup_check(&duppinfo
->r
, pinfo
->r
))
409 if (!rsa_bn_dup_check(&duppinfo
->d
, pinfo
->d
))
411 if (!rsa_bn_dup_check(&duppinfo
->t
, pinfo
->t
))
414 if (!ossl_rsa_multip_calc_product(dupkey
))
418 if (rsa
->pss
!= NULL
) {
419 dupkey
->pss
= RSA_PSS_PARAMS_dup(rsa
->pss
);
420 if (rsa
->pss
->maskGenAlgorithm
!= NULL
421 && dupkey
->pss
->maskGenAlgorithm
== NULL
) {
422 dupkey
->pss
->maskHash
= ossl_x509_algor_mgf1_decode(rsa
->pss
->maskGenAlgorithm
);
423 if (dupkey
->pss
->maskHash
== NULL
)
427 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_RSA
,
428 &dupkey
->ex_data
, &rsa
->ex_data
))
440 RSA_PSS_PARAMS
*ossl_rsa_pss_decode(const X509_ALGOR
*alg
)
444 pss
= ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_PSS_PARAMS
),
450 if (pss
->maskGenAlgorithm
!= NULL
) {
451 pss
->maskHash
= ossl_x509_algor_mgf1_decode(pss
->maskGenAlgorithm
);
452 if (pss
->maskHash
== NULL
) {
453 RSA_PSS_PARAMS_free(pss
);
461 static int ossl_rsa_sync_to_pss_params_30(RSA
*rsa
)
463 const RSA_PSS_PARAMS
*legacy_pss
= NULL
;
464 RSA_PSS_PARAMS_30
*pss
= NULL
;
467 && (legacy_pss
= RSA_get0_pss_params(rsa
)) != NULL
468 && (pss
= ossl_rsa_get0_pss_params_30(rsa
)) != NULL
) {
469 const EVP_MD
*md
= NULL
, *mgf1md
= NULL
;
470 int md_nid
, mgf1md_nid
, saltlen
, trailerField
;
471 RSA_PSS_PARAMS_30 pss_params
;
474 * We don't care about the validity of the fields here, we just
475 * want to synchronise values. Verifying here makes it impossible
476 * to even read a key with invalid values, making it hard to test
479 * Other routines use ossl_rsa_pss_get_param(), so the values will
480 * be checked, eventually.
482 if (!ossl_rsa_pss_get_param_unverified(legacy_pss
, &md
, &mgf1md
,
483 &saltlen
, &trailerField
))
485 md_nid
= EVP_MD_get_type(md
);
486 mgf1md_nid
= EVP_MD_get_type(mgf1md
);
487 if (!ossl_rsa_pss_params_30_set_defaults(&pss_params
)
488 || !ossl_rsa_pss_params_30_set_hashalg(&pss_params
, md_nid
)
489 || !ossl_rsa_pss_params_30_set_maskgenhashalg(&pss_params
,
491 || !ossl_rsa_pss_params_30_set_saltlen(&pss_params
, saltlen
)
492 || !ossl_rsa_pss_params_30_set_trailerfield(&pss_params
,
500 int ossl_rsa_pss_get_param_unverified(const RSA_PSS_PARAMS
*pss
,
501 const EVP_MD
**pmd
, const EVP_MD
**pmgf1md
,
502 int *psaltlen
, int *ptrailerField
)
504 RSA_PSS_PARAMS_30 pss_params
;
506 /* Get the defaults from the ONE place */
507 (void)ossl_rsa_pss_params_30_set_defaults(&pss_params
);
511 *pmd
= ossl_x509_algor_get_md(pss
->hashAlgorithm
);
514 *pmgf1md
= ossl_x509_algor_get_md(pss
->maskHash
);
515 if (*pmgf1md
== NULL
)
518 *psaltlen
= ASN1_INTEGER_get(pss
->saltLength
);
520 *psaltlen
= ossl_rsa_pss_params_30_saltlen(&pss_params
);
521 if (pss
->trailerField
)
522 *ptrailerField
= ASN1_INTEGER_get(pss
->trailerField
);
524 *ptrailerField
= ossl_rsa_pss_params_30_trailerfield(&pss_params
);;
529 int ossl_rsa_param_decode(RSA
*rsa
, const X509_ALGOR
*alg
)
532 const ASN1_OBJECT
*algoid
;
536 X509_ALGOR_get0(&algoid
, &algptype
, &algp
, alg
);
537 if (OBJ_obj2nid(algoid
) != EVP_PKEY_RSA_PSS
)
539 if (algptype
== V_ASN1_UNDEF
)
541 if (algptype
!= V_ASN1_SEQUENCE
) {
542 ERR_raise(ERR_LIB_RSA
, RSA_R_INVALID_PSS_PARAMETERS
);
545 if ((pss
= ossl_rsa_pss_decode(alg
)) == NULL
546 || !ossl_rsa_set0_pss_params(rsa
, pss
)) {
547 RSA_PSS_PARAMS_free(pss
);
550 if (!ossl_rsa_sync_to_pss_params_30(rsa
))
555 RSA
*ossl_rsa_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO
*p8inf
,
556 OSSL_LIB_CTX
*libctx
, const char *propq
)
558 const unsigned char *p
;
561 const X509_ALGOR
*alg
;
563 if (!PKCS8_pkey_get0(NULL
, &p
, &pklen
, &alg
, p8inf
))
565 rsa
= d2i_RSAPrivateKey(NULL
, &p
, pklen
);
567 ERR_raise(ERR_LIB_RSA
, ERR_R_RSA_LIB
);
570 if (!ossl_rsa_param_decode(rsa
, alg
)) {
575 RSA_clear_flags(rsa
, RSA_FLAG_TYPE_MASK
);
576 switch (OBJ_obj2nid(alg
->algorithm
)) {
578 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSA
);
580 case EVP_PKEY_RSA_PSS
:
581 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSASSAPSS
);
584 /* Leave the type bits zero */