2 * Copyright 2006-2020 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 "internal/cryptlib.h"
18 #include <openssl/asn1t.h>
19 #include <openssl/x509.h>
20 #include <openssl/bn.h>
21 #include <openssl/cms.h>
22 #include <openssl/core_names.h>
23 #include <openssl/param_build.h>
24 #include "crypto/asn1.h"
25 #include "crypto/evp.h"
26 #include "crypto/rsa.h"
27 #include "rsa_local.h"
29 #ifndef OPENSSL_NO_CMS
30 static int rsa_cms_sign(CMS_SignerInfo
*si
);
31 static int rsa_cms_verify(CMS_SignerInfo
*si
);
32 static int rsa_cms_decrypt(CMS_RecipientInfo
*ri
);
33 static int rsa_cms_encrypt(CMS_RecipientInfo
*ri
);
36 static RSA_PSS_PARAMS
*rsa_pss_decode(const X509_ALGOR
*alg
);
38 /* Set any parameters associated with pkey */
39 static int rsa_param_encode(const EVP_PKEY
*pkey
,
40 ASN1_STRING
**pstr
, int *pstrtype
)
42 const RSA
*rsa
= pkey
->pkey
.rsa
;
45 /* If RSA it's just NULL type */
46 if (RSA_test_flags(rsa
, RSA_FLAG_TYPE_MASK
) != RSA_FLAG_TYPE_RSASSAPSS
) {
47 *pstrtype
= V_ASN1_NULL
;
50 /* If no PSS parameters we omit parameters entirely */
51 if (rsa
->pss
== NULL
) {
52 *pstrtype
= V_ASN1_UNDEF
;
55 /* Encode PSS parameters */
56 if (ASN1_item_pack(rsa
->pss
, ASN1_ITEM_rptr(RSA_PSS_PARAMS
), pstr
) == NULL
)
59 *pstrtype
= V_ASN1_SEQUENCE
;
62 /* Decode any parameters and set them in RSA structure */
63 static int rsa_param_decode(RSA
*rsa
, const X509_ALGOR
*alg
)
65 const ASN1_OBJECT
*algoid
;
69 X509_ALGOR_get0(&algoid
, &algptype
, &algp
, alg
);
70 if (OBJ_obj2nid(algoid
) != EVP_PKEY_RSA_PSS
)
72 if (algptype
== V_ASN1_UNDEF
)
74 if (algptype
!= V_ASN1_SEQUENCE
) {
75 RSAerr(RSA_F_RSA_PARAM_DECODE
, RSA_R_INVALID_PSS_PARAMETERS
);
78 rsa
->pss
= rsa_pss_decode(alg
);
84 static int rsa_pub_encode(X509_PUBKEY
*pk
, const EVP_PKEY
*pkey
)
86 unsigned char *penc
= NULL
;
91 if (!rsa_param_encode(pkey
, &str
, &strtype
))
93 penclen
= i2d_RSAPublicKey(pkey
->pkey
.rsa
, &penc
);
96 if (X509_PUBKEY_set0_param(pk
, OBJ_nid2obj(pkey
->ameth
->pkey_id
),
97 strtype
, str
, penc
, penclen
))
104 static int rsa_pub_decode(EVP_PKEY
*pkey
, const X509_PUBKEY
*pubkey
)
106 const unsigned char *p
;
111 if (!X509_PUBKEY_get0_param(NULL
, &p
, &pklen
, &alg
, pubkey
))
113 if ((rsa
= d2i_RSAPublicKey(NULL
, &p
, pklen
)) == NULL
) {
114 RSAerr(RSA_F_RSA_PUB_DECODE
, ERR_R_RSA_LIB
);
117 if (!rsa_param_decode(rsa
, alg
)) {
121 if (!EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, rsa
)) {
128 static int rsa_pub_cmp(const EVP_PKEY
*a
, const EVP_PKEY
*b
)
130 if (BN_cmp(b
->pkey
.rsa
->n
, a
->pkey
.rsa
->n
) != 0
131 || BN_cmp(b
->pkey
.rsa
->e
, a
->pkey
.rsa
->e
) != 0)
136 static int old_rsa_priv_decode(EVP_PKEY
*pkey
,
137 const unsigned char **pder
, int derlen
)
141 if ((rsa
= d2i_RSAPrivateKey(NULL
, pder
, derlen
)) == NULL
) {
142 RSAerr(RSA_F_OLD_RSA_PRIV_DECODE
, ERR_R_RSA_LIB
);
145 EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, rsa
);
149 static int old_rsa_priv_encode(const EVP_PKEY
*pkey
, unsigned char **pder
)
151 return i2d_RSAPrivateKey(pkey
->pkey
.rsa
, pder
);
154 static int rsa_priv_encode(PKCS8_PRIV_KEY_INFO
*p8
, const EVP_PKEY
*pkey
)
156 unsigned char *rk
= NULL
;
161 if (!rsa_param_encode(pkey
, &str
, &strtype
))
163 rklen
= i2d_RSAPrivateKey(pkey
->pkey
.rsa
, &rk
);
166 RSAerr(RSA_F_RSA_PRIV_ENCODE
, ERR_R_MALLOC_FAILURE
);
167 ASN1_STRING_free(str
);
171 if (!PKCS8_pkey_set0(p8
, OBJ_nid2obj(pkey
->ameth
->pkey_id
), 0,
172 strtype
, str
, rk
, rklen
)) {
173 RSAerr(RSA_F_RSA_PRIV_ENCODE
, ERR_R_MALLOC_FAILURE
);
174 ASN1_STRING_free(str
);
181 static int rsa_priv_decode(EVP_PKEY
*pkey
, const PKCS8_PRIV_KEY_INFO
*p8
)
183 const unsigned char *p
;
186 const X509_ALGOR
*alg
;
188 if (!PKCS8_pkey_get0(NULL
, &p
, &pklen
, &alg
, p8
))
190 rsa
= d2i_RSAPrivateKey(NULL
, &p
, pklen
);
192 RSAerr(RSA_F_RSA_PRIV_DECODE
, ERR_R_RSA_LIB
);
195 if (!rsa_param_decode(rsa
, alg
)) {
200 RSA_clear_flags(rsa
, RSA_FLAG_TYPE_MASK
);
201 switch (pkey
->ameth
->pkey_id
) {
203 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSA
);
205 case EVP_PKEY_RSA_PSS
:
206 RSA_set_flags(rsa
, RSA_FLAG_TYPE_RSASSAPSS
);
209 /* Leave the type bits zero */
213 EVP_PKEY_assign(pkey
, pkey
->ameth
->pkey_id
, rsa
);
217 static int int_rsa_size(const EVP_PKEY
*pkey
)
219 return RSA_size(pkey
->pkey
.rsa
);
222 static int rsa_bits(const EVP_PKEY
*pkey
)
224 return BN_num_bits(pkey
->pkey
.rsa
->n
);
227 static int rsa_security_bits(const EVP_PKEY
*pkey
)
229 return RSA_security_bits(pkey
->pkey
.rsa
);
232 static void int_rsa_free(EVP_PKEY
*pkey
)
234 RSA_free(pkey
->pkey
.rsa
);
237 static X509_ALGOR
*rsa_mgf1_decode(X509_ALGOR
*alg
)
239 if (OBJ_obj2nid(alg
->algorithm
) != NID_mgf1
)
241 return ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(X509_ALGOR
),
245 static int rsa_pss_param_print(BIO
*bp
, int pss_key
, RSA_PSS_PARAMS
*pss
,
249 X509_ALGOR
*maskHash
= NULL
;
251 if (!BIO_indent(bp
, indent
, 128))
255 if (BIO_puts(bp
, "No PSS parameter restrictions\n") <= 0)
259 if (BIO_puts(bp
, "PSS parameter restrictions:") <= 0)
262 } else if (pss
== NULL
) {
263 if (BIO_puts(bp
,"(INVALID PSS PARAMETERS)\n") <= 0)
267 if (BIO_puts(bp
, "\n") <= 0)
271 if (!BIO_indent(bp
, indent
, 128))
273 if (BIO_puts(bp
, "Hash Algorithm: ") <= 0)
276 if (pss
->hashAlgorithm
) {
277 if (i2a_ASN1_OBJECT(bp
, pss
->hashAlgorithm
->algorithm
) <= 0)
279 } else if (BIO_puts(bp
, "sha1 (default)") <= 0) {
283 if (BIO_puts(bp
, "\n") <= 0)
286 if (!BIO_indent(bp
, indent
, 128))
289 if (BIO_puts(bp
, "Mask Algorithm: ") <= 0)
291 if (pss
->maskGenAlgorithm
) {
292 if (i2a_ASN1_OBJECT(bp
, pss
->maskGenAlgorithm
->algorithm
) <= 0)
294 if (BIO_puts(bp
, " with ") <= 0)
296 maskHash
= rsa_mgf1_decode(pss
->maskGenAlgorithm
);
297 if (maskHash
!= NULL
) {
298 if (i2a_ASN1_OBJECT(bp
, maskHash
->algorithm
) <= 0)
300 } else if (BIO_puts(bp
, "INVALID") <= 0) {
303 } else if (BIO_puts(bp
, "mgf1 with sha1 (default)") <= 0) {
308 if (!BIO_indent(bp
, indent
, 128))
310 if (BIO_printf(bp
, "%s Salt Length: 0x", pss_key
? "Minimum" : "") <= 0)
312 if (pss
->saltLength
) {
313 if (i2a_ASN1_INTEGER(bp
, pss
->saltLength
) <= 0)
315 } else if (BIO_puts(bp
, "14 (default)") <= 0) {
320 if (!BIO_indent(bp
, indent
, 128))
322 if (BIO_puts(bp
, "Trailer Field: 0x") <= 0)
324 if (pss
->trailerField
) {
325 if (i2a_ASN1_INTEGER(bp
, pss
->trailerField
) <= 0)
327 } else if (BIO_puts(bp
, "BC (default)") <= 0) {
335 X509_ALGOR_free(maskHash
);
340 static int pkey_rsa_print(BIO
*bp
, const EVP_PKEY
*pkey
, int off
, int priv
)
342 const RSA
*x
= pkey
->pkey
.rsa
;
345 int ret
= 0, mod_len
= 0, ex_primes
;
348 mod_len
= BN_num_bits(x
->n
);
349 ex_primes
= sk_RSA_PRIME_INFO_num(x
->prime_infos
);
351 if (!BIO_indent(bp
, off
, 128))
354 if (BIO_printf(bp
, "%s ", pkey_is_pss(pkey
) ? "RSA-PSS" : "RSA") <= 0)
358 if (BIO_printf(bp
, "Private-Key: (%d bit, %d primes)\n",
359 mod_len
, ex_primes
<= 0 ? 2 : ex_primes
+ 2) <= 0)
362 s
= "publicExponent:";
364 if (BIO_printf(bp
, "Public-Key: (%d bit)\n", mod_len
) <= 0)
369 if (!ASN1_bn_print(bp
, str
, x
->n
, NULL
, off
))
371 if (!ASN1_bn_print(bp
, s
, x
->e
, NULL
, off
))
376 if (!ASN1_bn_print(bp
, "privateExponent:", x
->d
, NULL
, off
))
378 if (!ASN1_bn_print(bp
, "prime1:", x
->p
, NULL
, off
))
380 if (!ASN1_bn_print(bp
, "prime2:", x
->q
, NULL
, off
))
382 if (!ASN1_bn_print(bp
, "exponent1:", x
->dmp1
, NULL
, off
))
384 if (!ASN1_bn_print(bp
, "exponent2:", x
->dmq1
, NULL
, off
))
386 if (!ASN1_bn_print(bp
, "coefficient:", x
->iqmp
, NULL
, off
))
388 for (i
= 0; i
< sk_RSA_PRIME_INFO_num(x
->prime_infos
); i
++) {
389 /* print multi-prime info */
391 RSA_PRIME_INFO
*pinfo
;
394 pinfo
= sk_RSA_PRIME_INFO_value(x
->prime_infos
, i
);
395 for (j
= 0; j
< 3; j
++) {
396 if (!BIO_indent(bp
, off
, 128))
400 if (BIO_printf(bp
, "prime%d:", i
+ 3) <= 0)
405 if (BIO_printf(bp
, "exponent%d:", i
+ 3) <= 0)
410 if (BIO_printf(bp
, "coefficient%d:", i
+ 3) <= 0)
417 if (!ASN1_bn_print(bp
, "", bn
, NULL
, off
))
422 if (pkey_is_pss(pkey
) && !rsa_pss_param_print(bp
, 1, x
->pss
, off
))
429 static int rsa_pub_print(BIO
*bp
, const EVP_PKEY
*pkey
, int indent
,
432 return pkey_rsa_print(bp
, pkey
, indent
, 0);
435 static int rsa_priv_print(BIO
*bp
, const EVP_PKEY
*pkey
, int indent
,
438 return pkey_rsa_print(bp
, pkey
, indent
, 1);
441 static RSA_PSS_PARAMS
*rsa_pss_decode(const X509_ALGOR
*alg
)
445 pss
= ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_PSS_PARAMS
),
451 if (pss
->maskGenAlgorithm
!= NULL
) {
452 pss
->maskHash
= rsa_mgf1_decode(pss
->maskGenAlgorithm
);
453 if (pss
->maskHash
== NULL
) {
454 RSA_PSS_PARAMS_free(pss
);
462 static int rsa_sig_print(BIO
*bp
, const X509_ALGOR
*sigalg
,
463 const ASN1_STRING
*sig
, int indent
, ASN1_PCTX
*pctx
)
465 if (OBJ_obj2nid(sigalg
->algorithm
) == EVP_PKEY_RSA_PSS
) {
467 RSA_PSS_PARAMS
*pss
= rsa_pss_decode(sigalg
);
469 rv
= rsa_pss_param_print(bp
, 0, pss
, indent
);
470 RSA_PSS_PARAMS_free(pss
);
473 } else if (BIO_puts(bp
, "\n") <= 0) {
477 return X509_signature_dump(bp
, sig
, indent
);
481 static int rsa_pkey_ctrl(EVP_PKEY
*pkey
, int op
, long arg1
, void *arg2
)
483 X509_ALGOR
*alg
= NULL
;
485 const EVP_MD
*mgf1md
;
490 case ASN1_PKEY_CTRL_PKCS7_SIGN
:
492 PKCS7_SIGNER_INFO_get0_algs(arg2
, NULL
, NULL
, &alg
);
495 case ASN1_PKEY_CTRL_PKCS7_ENCRYPT
:
496 if (pkey_is_pss(pkey
))
499 PKCS7_RECIP_INFO_get0_alg(arg2
, &alg
);
501 #ifndef OPENSSL_NO_CMS
502 case ASN1_PKEY_CTRL_CMS_SIGN
:
504 return rsa_cms_sign(arg2
);
506 return rsa_cms_verify(arg2
);
509 case ASN1_PKEY_CTRL_CMS_ENVELOPE
:
510 if (pkey_is_pss(pkey
))
513 return rsa_cms_encrypt(arg2
);
515 return rsa_cms_decrypt(arg2
);
518 case ASN1_PKEY_CTRL_CMS_RI_TYPE
:
519 if (pkey_is_pss(pkey
))
521 *(int *)arg2
= CMS_RECIPINFO_TRANS
;
525 case ASN1_PKEY_CTRL_DEFAULT_MD_NID
:
526 if (pkey
->pkey
.rsa
->pss
!= NULL
) {
527 if (!rsa_pss_get_param(pkey
->pkey
.rsa
->pss
, &md
, &mgf1md
,
529 RSAerr(0, ERR_R_INTERNAL_ERROR
);
532 *(int *)arg2
= EVP_MD_type(md
);
533 /* Return of 2 indicates this MD is mandatory */
536 *(int *)arg2
= NID_sha256
;
545 X509_ALGOR_set0(alg
, OBJ_nid2obj(NID_rsaEncryption
), V_ASN1_NULL
, 0);
551 /* allocate and set algorithm ID from EVP_MD, default SHA1 */
552 static int rsa_md_to_algor(X509_ALGOR
**palg
, const EVP_MD
*md
)
554 if (md
== NULL
|| EVP_MD_type(md
) == NID_sha1
)
556 *palg
= X509_ALGOR_new();
559 X509_ALGOR_set_md(*palg
, md
);
563 /* Allocate and set MGF1 algorithm ID from EVP_MD */
564 static int rsa_md_to_mgf1(X509_ALGOR
**palg
, const EVP_MD
*mgf1md
)
566 X509_ALGOR
*algtmp
= NULL
;
567 ASN1_STRING
*stmp
= NULL
;
570 if (mgf1md
== NULL
|| EVP_MD_type(mgf1md
) == NID_sha1
)
572 /* need to embed algorithm ID inside another */
573 if (!rsa_md_to_algor(&algtmp
, mgf1md
))
575 if (ASN1_item_pack(algtmp
, ASN1_ITEM_rptr(X509_ALGOR
), &stmp
) == NULL
)
577 *palg
= X509_ALGOR_new();
580 X509_ALGOR_set0(*palg
, OBJ_nid2obj(NID_mgf1
), V_ASN1_SEQUENCE
, stmp
);
583 ASN1_STRING_free(stmp
);
584 X509_ALGOR_free(algtmp
);
590 /* convert algorithm ID to EVP_MD, default SHA1 */
591 static const EVP_MD
*rsa_algor_to_md(X509_ALGOR
*alg
)
597 md
= EVP_get_digestbyobj(alg
->algorithm
);
599 RSAerr(RSA_F_RSA_ALGOR_TO_MD
, RSA_R_UNKNOWN_DIGEST
);
604 * Convert EVP_PKEY_CTX in PSS mode into corresponding algorithm parameter,
605 * suitable for setting an AlgorithmIdentifier.
608 static RSA_PSS_PARAMS
*rsa_ctx_to_pss(EVP_PKEY_CTX
*pkctx
)
610 const EVP_MD
*sigmd
, *mgf1md
;
611 EVP_PKEY
*pk
= EVP_PKEY_CTX_get0_pkey(pkctx
);
612 RSA
*rsa
= EVP_PKEY_get0_RSA(pk
);
615 if (EVP_PKEY_CTX_get_signature_md(pkctx
, &sigmd
) <= 0)
617 if (EVP_PKEY_CTX_get_rsa_mgf1_md(pkctx
, &mgf1md
) <= 0)
619 if (!EVP_PKEY_CTX_get_rsa_pss_saltlen(pkctx
, &saltlen
))
622 saltlen
= EVP_MD_size(sigmd
);
623 } else if (saltlen
== -2 || saltlen
== -3) {
624 saltlen
= RSA_size(rsa
) - EVP_MD_size(sigmd
) - 2;
625 if ((EVP_PKEY_bits(pk
) & 0x7) == 1)
631 return rsa_pss_params_create(sigmd
, mgf1md
, saltlen
);
634 RSA_PSS_PARAMS
*rsa_pss_params_create(const EVP_MD
*sigmd
,
635 const EVP_MD
*mgf1md
, int saltlen
)
637 RSA_PSS_PARAMS
*pss
= RSA_PSS_PARAMS_new();
642 pss
->saltLength
= ASN1_INTEGER_new();
643 if (pss
->saltLength
== NULL
)
645 if (!ASN1_INTEGER_set(pss
->saltLength
, saltlen
))
648 if (!rsa_md_to_algor(&pss
->hashAlgorithm
, sigmd
))
652 if (!rsa_md_to_mgf1(&pss
->maskGenAlgorithm
, mgf1md
))
654 if (!rsa_md_to_algor(&pss
->maskHash
, mgf1md
))
658 RSA_PSS_PARAMS_free(pss
);
662 static ASN1_STRING
*rsa_ctx_to_pss_string(EVP_PKEY_CTX
*pkctx
)
664 RSA_PSS_PARAMS
*pss
= rsa_ctx_to_pss(pkctx
);
670 os
= ASN1_item_pack(pss
, ASN1_ITEM_rptr(RSA_PSS_PARAMS
), NULL
);
671 RSA_PSS_PARAMS_free(pss
);
676 * From PSS AlgorithmIdentifier set public key parameters. If pkey isn't NULL
677 * then the EVP_MD_CTX is setup and initialised. If it is NULL parameters are
678 * passed to pkctx instead.
681 static int rsa_pss_to_ctx(EVP_MD_CTX
*ctx
, EVP_PKEY_CTX
*pkctx
,
682 X509_ALGOR
*sigalg
, EVP_PKEY
*pkey
)
686 const EVP_MD
*mgf1md
= NULL
, *md
= NULL
;
689 /* Sanity check: make sure it is PSS */
690 if (OBJ_obj2nid(sigalg
->algorithm
) != EVP_PKEY_RSA_PSS
) {
691 RSAerr(RSA_F_RSA_PSS_TO_CTX
, RSA_R_UNSUPPORTED_SIGNATURE_TYPE
);
694 /* Decode PSS parameters */
695 pss
= rsa_pss_decode(sigalg
);
697 if (!rsa_pss_get_param(pss
, &md
, &mgf1md
, &saltlen
)) {
698 RSAerr(RSA_F_RSA_PSS_TO_CTX
, RSA_R_INVALID_PSS_PARAMETERS
);
702 /* We have all parameters now set up context */
704 if (!EVP_DigestVerifyInit(ctx
, &pkctx
, md
, NULL
, pkey
))
707 const EVP_MD
*checkmd
;
708 if (EVP_PKEY_CTX_get_signature_md(pkctx
, &checkmd
) <= 0)
710 if (EVP_MD_type(md
) != EVP_MD_type(checkmd
)) {
711 RSAerr(RSA_F_RSA_PSS_TO_CTX
, RSA_R_DIGEST_DOES_NOT_MATCH
);
716 if (EVP_PKEY_CTX_set_rsa_padding(pkctx
, RSA_PKCS1_PSS_PADDING
) <= 0)
719 if (EVP_PKEY_CTX_set_rsa_pss_saltlen(pkctx
, saltlen
) <= 0)
722 if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx
, mgf1md
) <= 0)
728 RSA_PSS_PARAMS_free(pss
);
732 int rsa_pss_get_param(const RSA_PSS_PARAMS
*pss
, const EVP_MD
**pmd
,
733 const EVP_MD
**pmgf1md
, int *psaltlen
)
737 *pmd
= rsa_algor_to_md(pss
->hashAlgorithm
);
740 *pmgf1md
= rsa_algor_to_md(pss
->maskHash
);
741 if (*pmgf1md
== NULL
)
743 if (pss
->saltLength
) {
744 *psaltlen
= ASN1_INTEGER_get(pss
->saltLength
);
746 RSAerr(RSA_F_RSA_PSS_GET_PARAM
, RSA_R_INVALID_SALT_LENGTH
);
754 * low-level routines support only trailer field 0xbc (value 1) and
755 * PKCS#1 says we should reject any other value anyway.
757 if (pss
->trailerField
&& ASN1_INTEGER_get(pss
->trailerField
) != 1) {
758 RSAerr(RSA_F_RSA_PSS_GET_PARAM
, RSA_R_INVALID_TRAILER
);
765 #ifndef OPENSSL_NO_CMS
766 static int rsa_cms_verify(CMS_SignerInfo
*si
)
770 EVP_PKEY_CTX
*pkctx
= CMS_SignerInfo_get0_pkey_ctx(si
);
772 CMS_SignerInfo_get0_algs(si
, NULL
, NULL
, NULL
, &alg
);
773 nid
= OBJ_obj2nid(alg
->algorithm
);
774 if (nid
== EVP_PKEY_RSA_PSS
)
775 return rsa_pss_to_ctx(NULL
, pkctx
, alg
, NULL
);
776 /* Only PSS allowed for PSS keys */
777 if (pkey_ctx_is_pss(pkctx
)) {
778 RSAerr(RSA_F_RSA_CMS_VERIFY
, RSA_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE
);
781 if (nid
== NID_rsaEncryption
)
783 /* Workaround for some implementation that use a signature OID */
784 if (OBJ_find_sigid_algs(nid
, NULL
, &nid2
)) {
785 if (nid2
== NID_rsaEncryption
)
793 * Customised RSA item verification routine. This is called when a signature
794 * is encountered requiring special handling. We currently only handle PSS.
797 static int rsa_item_verify(EVP_MD_CTX
*ctx
, const ASN1_ITEM
*it
, void *asn
,
798 X509_ALGOR
*sigalg
, ASN1_BIT_STRING
*sig
,
801 /* Sanity check: make sure it is PSS */
802 if (OBJ_obj2nid(sigalg
->algorithm
) != EVP_PKEY_RSA_PSS
) {
803 RSAerr(RSA_F_RSA_ITEM_VERIFY
, RSA_R_UNSUPPORTED_SIGNATURE_TYPE
);
806 if (rsa_pss_to_ctx(ctx
, NULL
, sigalg
, pkey
) > 0) {
813 #ifndef OPENSSL_NO_CMS
814 static int rsa_cms_sign(CMS_SignerInfo
*si
)
816 int pad_mode
= RSA_PKCS1_PADDING
;
818 EVP_PKEY_CTX
*pkctx
= CMS_SignerInfo_get0_pkey_ctx(si
);
819 ASN1_STRING
*os
= NULL
;
821 CMS_SignerInfo_get0_algs(si
, NULL
, NULL
, NULL
, &alg
);
823 if (EVP_PKEY_CTX_get_rsa_padding(pkctx
, &pad_mode
) <= 0)
826 if (pad_mode
== RSA_PKCS1_PADDING
) {
827 X509_ALGOR_set0(alg
, OBJ_nid2obj(NID_rsaEncryption
), V_ASN1_NULL
, 0);
830 /* We don't support it */
831 if (pad_mode
!= RSA_PKCS1_PSS_PADDING
)
833 os
= rsa_ctx_to_pss_string(pkctx
);
836 X509_ALGOR_set0(alg
, OBJ_nid2obj(EVP_PKEY_RSA_PSS
), V_ASN1_SEQUENCE
, os
);
841 static int rsa_item_sign(EVP_MD_CTX
*ctx
, const ASN1_ITEM
*it
, void *asn
,
842 X509_ALGOR
*alg1
, X509_ALGOR
*alg2
,
843 ASN1_BIT_STRING
*sig
)
846 EVP_PKEY_CTX
*pkctx
= EVP_MD_CTX_pkey_ctx(ctx
);
848 if (EVP_PKEY_CTX_get_rsa_padding(pkctx
, &pad_mode
) <= 0)
850 if (pad_mode
== RSA_PKCS1_PADDING
)
852 if (pad_mode
== RSA_PKCS1_PSS_PADDING
) {
853 ASN1_STRING
*os1
= NULL
;
854 os1
= rsa_ctx_to_pss_string(pkctx
);
857 /* Duplicate parameters if we have to */
859 ASN1_STRING
*os2
= ASN1_STRING_dup(os1
);
861 ASN1_STRING_free(os1
);
864 X509_ALGOR_set0(alg2
, OBJ_nid2obj(EVP_PKEY_RSA_PSS
),
865 V_ASN1_SEQUENCE
, os2
);
867 X509_ALGOR_set0(alg1
, OBJ_nid2obj(EVP_PKEY_RSA_PSS
),
868 V_ASN1_SEQUENCE
, os1
);
874 static int rsa_sig_info_set(X509_SIG_INFO
*siginf
, const X509_ALGOR
*sigalg
,
875 const ASN1_STRING
*sig
)
880 const EVP_MD
*mgf1md
= NULL
, *md
= NULL
;
884 /* Sanity check: make sure it is PSS */
885 if (OBJ_obj2nid(sigalg
->algorithm
) != EVP_PKEY_RSA_PSS
)
887 /* Decode PSS parameters */
888 pss
= rsa_pss_decode(sigalg
);
889 if (!rsa_pss_get_param(pss
, &md
, &mgf1md
, &saltlen
))
891 mdnid
= EVP_MD_type(md
);
893 * For TLS need SHA256, SHA384 or SHA512, digest and MGF1 digest must
894 * match and salt length must equal digest size
896 if ((mdnid
== NID_sha256
|| mdnid
== NID_sha384
|| mdnid
== NID_sha512
)
897 && mdnid
== EVP_MD_type(mgf1md
) && saltlen
== EVP_MD_size(md
))
898 flags
= X509_SIG_INFO_TLS
;
901 /* Note: security bits half number of digest bits */
902 secbits
= EVP_MD_size(md
) * 4;
904 * SHA1 and MD5 are known to be broken. Reduce security bits so that
905 * they're no longer accepted at security level 1. The real values don't
906 * really matter as long as they're lower than 80, which is our security
908 * https://eprint.iacr.org/2020/014 puts a chosen-prefix attack for SHA1 at
910 * https://documents.epfl.ch/users/l/le/lenstra/public/papers/lat.pdf
911 * puts a chosen-prefix attack for MD5 at 2^39.
913 if (mdnid
== NID_sha1
)
915 else if (mdnid
== NID_md5_sha1
)
917 else if (mdnid
== NID_md5
)
919 X509_SIG_INFO_set(siginf
, mdnid
, EVP_PKEY_RSA_PSS
, secbits
,
923 RSA_PSS_PARAMS_free(pss
);
927 #ifndef OPENSSL_NO_CMS
928 static RSA_OAEP_PARAMS
*rsa_oaep_decode(const X509_ALGOR
*alg
)
930 RSA_OAEP_PARAMS
*oaep
;
932 oaep
= ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_OAEP_PARAMS
),
938 if (oaep
->maskGenFunc
!= NULL
) {
939 oaep
->maskHash
= rsa_mgf1_decode(oaep
->maskGenFunc
);
940 if (oaep
->maskHash
== NULL
) {
941 RSA_OAEP_PARAMS_free(oaep
);
948 static int rsa_cms_decrypt(CMS_RecipientInfo
*ri
)
954 unsigned char *label
= NULL
;
956 const EVP_MD
*mgf1md
= NULL
, *md
= NULL
;
957 RSA_OAEP_PARAMS
*oaep
;
959 pkctx
= CMS_RecipientInfo_get0_pkey_ctx(ri
);
962 if (!CMS_RecipientInfo_ktri_get0_algs(ri
, NULL
, NULL
, &cmsalg
))
964 nid
= OBJ_obj2nid(cmsalg
->algorithm
);
965 if (nid
== NID_rsaEncryption
)
967 if (nid
!= NID_rsaesOaep
) {
968 RSAerr(RSA_F_RSA_CMS_DECRYPT
, RSA_R_UNSUPPORTED_ENCRYPTION_TYPE
);
971 /* Decode OAEP parameters */
972 oaep
= rsa_oaep_decode(cmsalg
);
975 RSAerr(RSA_F_RSA_CMS_DECRYPT
, RSA_R_INVALID_OAEP_PARAMETERS
);
979 mgf1md
= rsa_algor_to_md(oaep
->maskHash
);
982 md
= rsa_algor_to_md(oaep
->hashFunc
);
986 if (oaep
->pSourceFunc
!= NULL
) {
987 X509_ALGOR
*plab
= oaep
->pSourceFunc
;
989 if (OBJ_obj2nid(plab
->algorithm
) != NID_pSpecified
) {
990 RSAerr(RSA_F_RSA_CMS_DECRYPT
, RSA_R_UNSUPPORTED_LABEL_SOURCE
);
993 if (plab
->parameter
->type
!= V_ASN1_OCTET_STRING
) {
994 RSAerr(RSA_F_RSA_CMS_DECRYPT
, RSA_R_INVALID_LABEL
);
998 label
= plab
->parameter
->value
.octet_string
->data
;
999 /* Stop label being freed when OAEP parameters are freed */
1000 plab
->parameter
->value
.octet_string
->data
= NULL
;
1001 labellen
= plab
->parameter
->value
.octet_string
->length
;
1004 if (EVP_PKEY_CTX_set_rsa_padding(pkctx
, RSA_PKCS1_OAEP_PADDING
) <= 0)
1006 if (EVP_PKEY_CTX_set_rsa_oaep_md(pkctx
, md
) <= 0)
1008 if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx
, mgf1md
) <= 0)
1010 if (EVP_PKEY_CTX_set0_rsa_oaep_label(pkctx
, label
, labellen
) <= 0)
1016 RSA_OAEP_PARAMS_free(oaep
);
1020 static int rsa_cms_encrypt(CMS_RecipientInfo
*ri
)
1022 const EVP_MD
*md
, *mgf1md
;
1023 RSA_OAEP_PARAMS
*oaep
= NULL
;
1024 ASN1_STRING
*os
= NULL
;
1026 EVP_PKEY_CTX
*pkctx
= CMS_RecipientInfo_get0_pkey_ctx(ri
);
1027 int pad_mode
= RSA_PKCS1_PADDING
, rv
= 0, labellen
;
1028 unsigned char *label
;
1030 if (CMS_RecipientInfo_ktri_get0_algs(ri
, NULL
, NULL
, &alg
) <= 0)
1033 if (EVP_PKEY_CTX_get_rsa_padding(pkctx
, &pad_mode
) <= 0)
1036 if (pad_mode
== RSA_PKCS1_PADDING
) {
1037 X509_ALGOR_set0(alg
, OBJ_nid2obj(NID_rsaEncryption
), V_ASN1_NULL
, 0);
1041 if (pad_mode
!= RSA_PKCS1_OAEP_PADDING
)
1043 if (EVP_PKEY_CTX_get_rsa_oaep_md(pkctx
, &md
) <= 0)
1045 if (EVP_PKEY_CTX_get_rsa_mgf1_md(pkctx
, &mgf1md
) <= 0)
1047 labellen
= EVP_PKEY_CTX_get0_rsa_oaep_label(pkctx
, &label
);
1050 oaep
= RSA_OAEP_PARAMS_new();
1053 if (!rsa_md_to_algor(&oaep
->hashFunc
, md
))
1055 if (!rsa_md_to_mgf1(&oaep
->maskGenFunc
, mgf1md
))
1058 ASN1_OCTET_STRING
*los
;
1059 oaep
->pSourceFunc
= X509_ALGOR_new();
1060 if (oaep
->pSourceFunc
== NULL
)
1062 los
= ASN1_OCTET_STRING_new();
1065 if (!ASN1_OCTET_STRING_set(los
, label
, labellen
)) {
1066 ASN1_OCTET_STRING_free(los
);
1069 X509_ALGOR_set0(oaep
->pSourceFunc
, OBJ_nid2obj(NID_pSpecified
),
1070 V_ASN1_OCTET_STRING
, los
);
1072 /* create string with pss parameter encoding. */
1073 if (!ASN1_item_pack(oaep
, ASN1_ITEM_rptr(RSA_OAEP_PARAMS
), &os
))
1075 X509_ALGOR_set0(alg
, OBJ_nid2obj(NID_rsaesOaep
), V_ASN1_SEQUENCE
, os
);
1079 RSA_OAEP_PARAMS_free(oaep
);
1080 ASN1_STRING_free(os
);
1085 static int rsa_pkey_check(const EVP_PKEY
*pkey
)
1087 return RSA_check_key_ex(pkey
->pkey
.rsa
, NULL
);
1090 static size_t rsa_pkey_dirty_cnt(const EVP_PKEY
*pkey
)
1092 return pkey
->pkey
.rsa
->dirty_cnt
;
1096 * For the moment, we trust the call path, where keys going through
1097 * rsa_pkey_export_to() match a KEYMGMT for the "RSA" keytype, while
1098 * keys going through rsa_pss_pkey_export_to() match a KEYMGMT for the
1099 * "RSA-PSS" keytype.
1100 * TODO(3.0) Investigate whether we should simply continue to trust the
1101 * call path, or if we should strengthen this function by checking that
1102 * |rsa_type| matches the RSA key subtype. The latter requires ensuring
1103 * that the type flag for the RSA key is properly set by other functions
1106 static int rsa_int_export_to(const EVP_PKEY
*from
, int rsa_type
,
1107 void *to_keydata
, EVP_KEYMGMT
*to_keymgmt
,
1108 OPENSSL_CTX
*libctx
, const char *propq
)
1110 RSA
*rsa
= from
->pkey
.rsa
;
1111 OSSL_PARAM_BLD
*tmpl
= OSSL_PARAM_BLD_new();
1112 OSSL_PARAM
*params
= NULL
;
1119 * If the RSA method is foreign, then we can't be sure of anything, and
1120 * can therefore not export or pretend to export.
1122 if (RSA_get_method(rsa
) != RSA_PKCS1_OpenSSL())
1125 /* Public parameters must always be present */
1126 if (RSA_get0_n(rsa
) == NULL
|| RSA_get0_e(rsa
) == NULL
)
1129 if (!rsa_todata(rsa
, tmpl
, NULL
))
1132 selection
|= OSSL_KEYMGMT_SELECT_PUBLIC_KEY
;
1133 if (RSA_get0_d(rsa
) != NULL
)
1134 selection
|= OSSL_KEYMGMT_SELECT_PRIVATE_KEY
;
1136 if (rsa
->pss
!= NULL
) {
1137 const EVP_MD
*md
= NULL
, *mgf1md
= NULL
;
1138 int md_nid
, mgf1md_nid
, saltlen
;
1139 RSA_PSS_PARAMS_30 pss_params
;
1141 if (!rsa_pss_get_param(rsa
->pss
, &md
, &mgf1md
, &saltlen
))
1143 md_nid
= EVP_MD_type(md
);
1144 mgf1md_nid
= EVP_MD_type(mgf1md
);
1145 if (!rsa_pss_params_30_set_defaults(&pss_params
)
1146 || !rsa_pss_params_30_set_hashalg(&pss_params
, md_nid
)
1147 || !rsa_pss_params_30_set_maskgenhashalg(&pss_params
, mgf1md_nid
)
1148 || !rsa_pss_params_30_set_saltlen(&pss_params
, saltlen
)
1149 || !rsa_pss_params_30_todata(&pss_params
, propq
, tmpl
, NULL
))
1151 selection
|= OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS
;
1154 if ((params
= OSSL_PARAM_BLD_to_param(tmpl
)) == NULL
)
1157 /* We export, the provider imports */
1158 rv
= evp_keymgmt_import(to_keymgmt
, to_keydata
, selection
, params
);
1161 OSSL_PARAM_BLD_free_params(params
);
1162 OSSL_PARAM_BLD_free(tmpl
);
1166 static int rsa_int_import_from(const OSSL_PARAM params
[], void *vpctx
,
1169 EVP_PKEY_CTX
*pctx
= vpctx
;
1170 EVP_PKEY
*pkey
= EVP_PKEY_CTX_get0_pkey(pctx
);
1171 RSA
*rsa
= rsa_new_with_ctx(pctx
->libctx
);
1172 RSA_PSS_PARAMS_30 rsa_pss_params
= { 0, };
1176 ERR_raise(ERR_LIB_DH
, ERR_R_MALLOC_FAILURE
);
1180 RSA_clear_flags(rsa
, RSA_FLAG_TYPE_MASK
);
1181 RSA_set_flags(rsa
, rsa_type
);
1183 if (!rsa_pss_params_30_fromdata(&rsa_pss_params
, params
, pctx
->libctx
))
1187 case RSA_FLAG_TYPE_RSA
:
1189 * Were PSS parameters filled in?
1190 * In that case, something's wrong
1192 if (!rsa_pss_params_30_is_unrestricted(&rsa_pss_params
))
1195 case RSA_FLAG_TYPE_RSASSAPSS
:
1197 * Were PSS parameters filled in? In that case, create the old
1198 * RSA_PSS_PARAMS structure. Otherwise, this is an unrestricted key.
1200 if (!rsa_pss_params_30_is_unrestricted(&rsa_pss_params
)) {
1201 /* Create the older RSA_PSS_PARAMS from RSA_PSS_PARAMS_30 data */
1202 int mdnid
= rsa_pss_params_30_hashalg(&rsa_pss_params
);
1203 int mgf1mdnid
= rsa_pss_params_30_maskgenhashalg(&rsa_pss_params
);
1204 int saltlen
= rsa_pss_params_30_saltlen(&rsa_pss_params
);
1205 const EVP_MD
*md
= EVP_get_digestbynid(mdnid
);
1206 const EVP_MD
*mgf1md
= EVP_get_digestbynid(mgf1mdnid
);
1208 if ((rsa
->pss
= rsa_pss_params_create(md
, mgf1md
, saltlen
)) == NULL
)
1213 /* RSA key sub-types we don't know how to handle yet */
1217 if (!rsa_fromdata(rsa
, params
))
1221 case RSA_FLAG_TYPE_RSA
:
1222 ok
= EVP_PKEY_assign_RSA(pkey
, rsa
);
1224 case RSA_FLAG_TYPE_RSASSAPSS
:
1225 ok
= EVP_PKEY_assign(pkey
, EVP_PKEY_RSA_PSS
, rsa
);
1235 static int rsa_pkey_export_to(const EVP_PKEY
*from
, void *to_keydata
,
1236 EVP_KEYMGMT
*to_keymgmt
, OPENSSL_CTX
*libctx
,
1239 return rsa_int_export_to(from
, RSA_FLAG_TYPE_RSA
, to_keydata
,
1240 to_keymgmt
, libctx
, propq
);
1243 static int rsa_pss_pkey_export_to(const EVP_PKEY
*from
, void *to_keydata
,
1244 EVP_KEYMGMT
*to_keymgmt
, OPENSSL_CTX
*libctx
,
1247 return rsa_int_export_to(from
, RSA_FLAG_TYPE_RSASSAPSS
, to_keydata
,
1248 to_keymgmt
, libctx
, propq
);
1251 static int rsa_pkey_import_from(const OSSL_PARAM params
[], void *vpctx
)
1253 return rsa_int_import_from(params
, vpctx
, RSA_FLAG_TYPE_RSA
);
1256 static int rsa_pss_pkey_import_from(const OSSL_PARAM params
[], void *vpctx
)
1258 return rsa_int_import_from(params
, vpctx
, RSA_FLAG_TYPE_RSASSAPSS
);
1261 const EVP_PKEY_ASN1_METHOD rsa_asn1_meths
[2] = {
1265 ASN1_PKEY_SIGPARAM_NULL
,
1268 "OpenSSL RSA method",
1288 old_rsa_priv_decode
,
1289 old_rsa_priv_encode
,
1300 rsa_pkey_import_from
1309 const EVP_PKEY_ASN1_METHOD rsa_pss_asn1_meth
= {
1312 ASN1_PKEY_SIGPARAM_NULL
,
1315 "OpenSSL RSA-PSS method",
1345 rsa_pss_pkey_export_to
,
1346 rsa_pss_pkey_import_from