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
[], int include_private
)
65 const OSSL_PARAM
*param_n
, *param_e
, *param_d
= NULL
;
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
);
76 param_d
= OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_D
);
78 if ((param_n
!= NULL
&& !OSSL_PARAM_get_BN(param_n
, &n
))
79 || (param_e
!= NULL
&& !OSSL_PARAM_get_BN(param_e
, &e
))
80 || (param_d
!= NULL
&& !OSSL_PARAM_get_BN(param_d
, &d
)))
83 is_private
= (d
!= NULL
);
85 if (!RSA_set0_key(rsa
, n
, e
, d
))
90 if (!collect_numbers(factors
= sk_BIGNUM_new_null(), params
,
91 ossl_rsa_mp_factor_names
)
92 || !collect_numbers(exps
= sk_BIGNUM_new_null(), params
,
93 ossl_rsa_mp_exp_names
)
94 || !collect_numbers(coeffs
= sk_BIGNUM_new_null(), params
,
95 ossl_rsa_mp_coeff_names
))
98 /* It's ok if this private key just has n, e and d */
99 if (sk_BIGNUM_num(factors
) != 0
100 && !ossl_rsa_set0_all_params(rsa
, factors
, exps
, coeffs
))
105 sk_BIGNUM_free(factors
);
106 sk_BIGNUM_free(exps
);
107 sk_BIGNUM_free(coeffs
);
114 sk_BIGNUM_pop_free(factors
, BN_free
);
115 sk_BIGNUM_pop_free(exps
, BN_free
);
116 sk_BIGNUM_pop_free(coeffs
, BN_free
);
120 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const
, BIGNUM
)
122 int ossl_rsa_todata(RSA
*rsa
, OSSL_PARAM_BLD
*bld
, OSSL_PARAM params
[],
126 const BIGNUM
*rsa_d
= NULL
, *rsa_n
= NULL
, *rsa_e
= NULL
;
127 STACK_OF(BIGNUM_const
) *factors
= sk_BIGNUM_const_new_null();
128 STACK_OF(BIGNUM_const
) *exps
= sk_BIGNUM_const_new_null();
129 STACK_OF(BIGNUM_const
) *coeffs
= sk_BIGNUM_const_new_null();
131 if (rsa
== NULL
|| factors
== NULL
|| exps
== NULL
|| coeffs
== NULL
)
134 RSA_get0_key(rsa
, &rsa_n
, &rsa_e
, &rsa_d
);
135 ossl_rsa_get0_all_params(rsa
, factors
, exps
, coeffs
);
137 if (!ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_N
, rsa_n
)
138 || !ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_E
, rsa_e
))
141 /* Check private key data integrity */
142 if (include_private
&& rsa_d
!= NULL
) {
143 int numprimes
= sk_BIGNUM_const_num(factors
);
144 int numexps
= sk_BIGNUM_const_num(exps
);
145 int numcoeffs
= sk_BIGNUM_const_num(coeffs
);
148 * It's permissible to have zero primes, i.e. no CRT params.
149 * Otherwise, there must be at least two, as many exponents,
150 * and one coefficient less.
153 && (numprimes
< 2 || numexps
< 2 || numcoeffs
< 1))
156 if (!ossl_param_build_set_bn(bld
, params
, OSSL_PKEY_PARAM_RSA_D
,
158 || !ossl_param_build_set_multi_key_bn(bld
, params
,
159 ossl_rsa_mp_factor_names
,
161 || !ossl_param_build_set_multi_key_bn(bld
, params
,
162 ossl_rsa_mp_exp_names
, exps
)
163 || !ossl_param_build_set_multi_key_bn(bld
, params
,
164 ossl_rsa_mp_coeff_names
,
169 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
170 /* The acvp test results are not meant for export so check for bld == NULL */
172 ossl_rsa_acvp_test_get_params(rsa
, params
);
176 sk_BIGNUM_const_free(factors
);
177 sk_BIGNUM_const_free(exps
);
178 sk_BIGNUM_const_free(coeffs
);
182 int ossl_rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30
*pss
,
183 OSSL_PARAM_BLD
*bld
, OSSL_PARAM params
[])
185 if (!ossl_rsa_pss_params_30_is_unrestricted(pss
)) {
186 int hashalg_nid
= ossl_rsa_pss_params_30_hashalg(pss
);
187 int maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(pss
);
188 int maskgenhashalg_nid
= ossl_rsa_pss_params_30_maskgenhashalg(pss
);
189 int saltlen
= ossl_rsa_pss_params_30_saltlen(pss
);
190 int default_hashalg_nid
= ossl_rsa_pss_params_30_hashalg(NULL
);
191 int default_maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(NULL
);
192 int default_maskgenhashalg_nid
=
193 ossl_rsa_pss_params_30_maskgenhashalg(NULL
);
195 (hashalg_nid
== default_hashalg_nid
196 ? NULL
: ossl_rsa_oaeppss_nid2name(hashalg_nid
));
197 const char *mgfname
=
198 (maskgenalg_nid
== default_maskgenalg_nid
199 ? NULL
: ossl_rsa_oaeppss_nid2name(maskgenalg_nid
));
200 const char *mgf1mdname
=
201 (maskgenhashalg_nid
== default_maskgenhashalg_nid
202 ? NULL
: ossl_rsa_oaeppss_nid2name(maskgenhashalg_nid
));
203 const char *key_md
= OSSL_PKEY_PARAM_RSA_DIGEST
;
204 const char *key_mgf
= OSSL_PKEY_PARAM_RSA_MASKGENFUNC
;
205 const char *key_mgf1_md
= OSSL_PKEY_PARAM_RSA_MGF1_DIGEST
;
206 const char *key_saltlen
= OSSL_PKEY_PARAM_RSA_PSS_SALTLEN
;
209 * To ensure that the key isn't seen as unrestricted by the recipient,
210 * we make sure that at least one PSS-related parameter is passed, even
211 * if it has a default value; saltlen.
214 && !ossl_param_build_set_utf8_string(bld
, params
, key_md
, mdname
))
216 && !ossl_param_build_set_utf8_string(bld
, params
,
218 || (mgf1mdname
!= NULL
219 && !ossl_param_build_set_utf8_string(bld
, params
,
220 key_mgf1_md
, mgf1mdname
))
221 || (!ossl_param_build_set_int(bld
, params
, key_saltlen
, saltlen
)))
227 int ossl_rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30
*pss_params
,
229 const OSSL_PARAM params
[],
230 OSSL_LIB_CTX
*libctx
)
232 const OSSL_PARAM
*param_md
, *param_mgf
, *param_mgf1md
, *param_saltlen
;
233 const OSSL_PARAM
*param_propq
;
234 const char *propq
= NULL
;
235 EVP_MD
*md
= NULL
, *mgf1md
= NULL
;
239 if (pss_params
== NULL
)
242 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_DIGEST_PROPS
);
244 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_DIGEST
);
246 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_MASKGENFUNC
);
248 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_MGF1_DIGEST
);
250 OSSL_PARAM_locate_const(params
, OSSL_PKEY_PARAM_RSA_PSS_SALTLEN
);
252 if (param_propq
!= NULL
) {
253 if (param_propq
->data_type
== OSSL_PARAM_UTF8_STRING
)
254 propq
= param_propq
->data
;
257 * If we get any of the parameters, we know we have at least some
258 * restrictions, so we start by setting default values, and let each
259 * parameter override their specific restriction data.
262 && (param_md
!= NULL
|| param_mgf
!= NULL
|| param_mgf1md
!= NULL
263 || param_saltlen
!= NULL
)) {
264 if (!ossl_rsa_pss_params_30_set_defaults(pss_params
))
269 if (param_mgf
!= NULL
) {
270 int default_maskgenalg_nid
= ossl_rsa_pss_params_30_maskgenalg(NULL
);
271 const char *mgfname
= NULL
;
273 if (param_mgf
->data_type
== OSSL_PARAM_UTF8_STRING
)
274 mgfname
= param_mgf
->data
;
275 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mgfname
))
278 if (strcasecmp(param_mgf
->data
,
279 ossl_rsa_mgf_nid2name(default_maskgenalg_nid
)) != 0)
284 * We're only interested in the NIDs that correspond to the MDs, so the
285 * exact propquery is unimportant in the EVP_MD_fetch() calls below.
288 if (param_md
!= NULL
) {
289 const char *mdname
= NULL
;
291 if (param_md
->data_type
== OSSL_PARAM_UTF8_STRING
)
292 mdname
= param_md
->data
;
293 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mdname
))
296 if ((md
= EVP_MD_fetch(libctx
, mdname
, propq
)) == NULL
297 || !ossl_rsa_pss_params_30_set_hashalg(pss_params
,
298 ossl_rsa_oaeppss_md2nid(md
)))
302 if (param_mgf1md
!= NULL
) {
303 const char *mgf1mdname
= NULL
;
305 if (param_mgf1md
->data_type
== OSSL_PARAM_UTF8_STRING
)
306 mgf1mdname
= param_mgf1md
->data
;
307 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf
, &mgf1mdname
))
310 if ((mgf1md
= EVP_MD_fetch(libctx
, mgf1mdname
, propq
)) == NULL
311 || !ossl_rsa_pss_params_30_set_maskgenhashalg(
312 pss_params
, ossl_rsa_oaeppss_md2nid(mgf1md
)))
316 if (param_saltlen
!= NULL
) {
317 if (!OSSL_PARAM_get_int(param_saltlen
, &saltlen
)
318 || !ossl_rsa_pss_params_30_set_saltlen(pss_params
, saltlen
))
330 int ossl_rsa_is_foreign(const RSA
*rsa
)
333 if (rsa
->engine
!= NULL
|| RSA_get_method(rsa
) != RSA_PKCS1_OpenSSL())
339 static ossl_inline
int rsa_bn_dup_check(BIGNUM
**out
, const BIGNUM
*f
)
341 if (f
!= NULL
&& (*out
= BN_dup(f
)) == NULL
)
346 RSA
*ossl_rsa_dup(const RSA
*rsa
, int selection
)
353 /* Do not try to duplicate foreign RSA keys */
354 if (ossl_rsa_is_foreign(rsa
))
357 if ((dupkey
= ossl_rsa_new_with_ctx(rsa
->libctx
)) == NULL
)
361 if ((selection
& OSSL_KEYMGMT_SELECT_KEYPAIR
) != 0) {
362 if (!rsa_bn_dup_check(&dupkey
->n
, rsa
->n
))
364 if (!rsa_bn_dup_check(&dupkey
->e
, rsa
->e
))
368 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0) {
371 if (!rsa_bn_dup_check(&dupkey
->d
, rsa
->d
))
374 /* factors and crt params */
375 if (!rsa_bn_dup_check(&dupkey
->p
, rsa
->p
))
377 if (!rsa_bn_dup_check(&dupkey
->q
, rsa
->q
))
379 if (!rsa_bn_dup_check(&dupkey
->dmp1
, rsa
->dmp1
))
381 if (!rsa_bn_dup_check(&dupkey
->dmq1
, rsa
->dmq1
))
383 if (!rsa_bn_dup_check(&dupkey
->iqmp
, rsa
->iqmp
))
387 dupkey
->version
= rsa
->version
;
388 dupkey
->flags
= rsa
->flags
;
389 /* we always copy the PSS parameters regardless of selection */
390 dupkey
->pss_params
= rsa
->pss_params
;
394 if ((selection
& OSSL_KEYMGMT_SELECT_PRIVATE_KEY
) != 0
395 && (pnum
= sk_RSA_PRIME_INFO_num(rsa
->prime_infos
)) > 0) {
396 dupkey
->prime_infos
= sk_RSA_PRIME_INFO_new_reserve(NULL
, pnum
);
397 if (dupkey
->prime_infos
== NULL
)
399 for (i
= 0; i
< pnum
; i
++) {
400 const RSA_PRIME_INFO
*pinfo
= NULL
;
401 RSA_PRIME_INFO
*duppinfo
= NULL
;
403 if ((duppinfo
= OPENSSL_zalloc(sizeof(*duppinfo
))) == NULL
) {
404 ERR_raise(ERR_LIB_RSA
, ERR_R_MALLOC_FAILURE
);
407 /* push first so cleanup in error case works */
408 (void)sk_RSA_PRIME_INFO_push(dupkey
->prime_infos
, duppinfo
);
410 pinfo
= sk_RSA_PRIME_INFO_value(rsa
->prime_infos
, i
);
411 if (!rsa_bn_dup_check(&duppinfo
->r
, pinfo
->r
))
413 if (!rsa_bn_dup_check(&duppinfo
->d
, pinfo
->d
))
415 if (!rsa_bn_dup_check(&duppinfo
->t
, pinfo
->t
))
418 if (!ossl_rsa_multip_calc_product(dupkey
))
422 if (rsa
->pss
!= NULL
) {
423 dupkey
->pss
= RSA_PSS_PARAMS_dup(rsa
->pss
);
424 if (rsa
->pss
->maskGenAlgorithm
!= NULL
425 && dupkey
->pss
->maskGenAlgorithm
== NULL
) {
426 dupkey
->pss
->maskHash
= ossl_x509_algor_mgf1_decode(rsa
->pss
->maskGenAlgorithm
);
427 if (dupkey
->pss
->maskHash
== NULL
)
431 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_RSA
,
432 &dupkey
->ex_data
, &rsa
->ex_data
))
444 RSA_PSS_PARAMS
*ossl_rsa_pss_decode(const X509_ALGOR
*alg
)
448 pss
= ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_PSS_PARAMS
),
454 if (pss
->maskGenAlgorithm
!= NULL
) {
455 pss
->maskHash
= ossl_x509_algor_mgf1_decode(pss
->maskGenAlgorithm
);
456 if (pss
->maskHash
== NULL
) {
457 RSA_PSS_PARAMS_free(pss
);
465 static int ossl_rsa_sync_to_pss_params_30(RSA
*rsa
)
467 const RSA_PSS_PARAMS
*legacy_pss
= NULL
;
468 RSA_PSS_PARAMS_30
*pss
= NULL
;
471 && (legacy_pss
= RSA_get0_pss_params(rsa
)) != NULL
472 && (pss
= ossl_rsa_get0_pss_params_30(rsa
)) != NULL
) {
473 const EVP_MD
*md
= NULL
, *mgf1md
= NULL
;
474 int md_nid
, mgf1md_nid
, saltlen
, trailerField
;
475 RSA_PSS_PARAMS_30 pss_params
;
478 * We don't care about the validity of the fields here, we just
479 * want to synchronise values. Verifying here makes it impossible
480 * to even read a key with invalid values, making it hard to test
483 * Other routines use ossl_rsa_pss_get_param(), so the values will
484 * be checked, eventually.
486 if (!ossl_rsa_pss_get_param_unverified(legacy_pss
, &md
, &mgf1md
,
487 &saltlen
, &trailerField
))
489 md_nid
= EVP_MD_get_type(md
);
490 mgf1md_nid
= EVP_MD_get_type(mgf1md
);
491 if (!ossl_rsa_pss_params_30_set_defaults(&pss_params
)
492 || !ossl_rsa_pss_params_30_set_hashalg(&pss_params
, md_nid
)
493 || !ossl_rsa_pss_params_30_set_maskgenhashalg(&pss_params
,
495 || !ossl_rsa_pss_params_30_set_saltlen(&pss_params
, saltlen
)
496 || !ossl_rsa_pss_params_30_set_trailerfield(&pss_params
,
504 int ossl_rsa_pss_get_param_unverified(const RSA_PSS_PARAMS
*pss
,
505 const EVP_MD
**pmd
, const EVP_MD
**pmgf1md
,
506 int *psaltlen
, int *ptrailerField
)
508 RSA_PSS_PARAMS_30 pss_params
;
510 /* Get the defaults from the ONE place */
511 (void)ossl_rsa_pss_params_30_set_defaults(&pss_params
);
515 *pmd
= ossl_x509_algor_get_md(pss
->hashAlgorithm
);
518 *pmgf1md
= ossl_x509_algor_get_md(pss
->maskHash
);
519 if (*pmgf1md
== NULL
)
522 *psaltlen
= ASN1_INTEGER_get(pss
->saltLength
);
524 *psaltlen
= ossl_rsa_pss_params_30_saltlen(&pss_params
);
525 if (pss
->trailerField
)
526 *ptrailerField
= ASN1_INTEGER_get(pss
->trailerField
);
528 *ptrailerField
= ossl_rsa_pss_params_30_trailerfield(&pss_params
);
533 int ossl_rsa_param_decode(RSA
*rsa
, const X509_ALGOR
*alg
)
536 const ASN1_OBJECT
*algoid
;
540 X509_ALGOR_get0(&algoid
, &algptype
, &algp
, alg
);
541 if (OBJ_obj2nid(algoid
) != EVP_PKEY_RSA_PSS
)
543 if (algptype
== V_ASN1_UNDEF
)
545 if (algptype
!= V_ASN1_SEQUENCE
) {
546 ERR_raise(ERR_LIB_RSA
, RSA_R_INVALID_PSS_PARAMETERS
);
549 if ((pss
= ossl_rsa_pss_decode(alg
)) == NULL
550 || !ossl_rsa_set0_pss_params(rsa
, pss
)) {
551 RSA_PSS_PARAMS_free(pss
);
554 if (!ossl_rsa_sync_to_pss_params_30(rsa
))
559 RSA
*ossl_rsa_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO
*p8inf
,
560 OSSL_LIB_CTX
*libctx
, const char *propq
)
562 const unsigned char *p
;
565 const X509_ALGOR
*alg
;
567 if (!PKCS8_pkey_get0(NULL
, &p
, &pklen
, &alg
, p8inf
))
569 rsa
= d2i_RSAPrivateKey(NULL
, &p
, pklen
);
571 ERR_raise(ERR_LIB_RSA
, ERR_R_RSA_LIB
);
574 if (!ossl_rsa_param_decode(rsa
, alg
)) {
579 RSA_clear_flags(rsa
, RSA_FLAG_TYPE_MASK
);
580 switch (OBJ_obj2nid(alg
->algorithm
)) {
582 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSA
);
584 case EVP_PKEY_RSA_PSS
:
585 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSASSAPSS
);
588 /* Leave the type bits zero */