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);
37 static int rsa_sync_to_pss_params_30(RSA *rsa);
39 /* Set any parameters associated with pkey */
40 static int rsa_param_encode(const EVP_PKEY *pkey,
41 ASN1_STRING **pstr, int *pstrtype)
43 const RSA *rsa = pkey->pkey.rsa;
46 /* If RSA it's just NULL type */
47 if (RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK) != RSA_FLAG_TYPE_RSASSAPSS) {
48 *pstrtype = V_ASN1_NULL;
51 /* If no PSS parameters we omit parameters entirely */
52 if (rsa->pss == NULL) {
53 *pstrtype = V_ASN1_UNDEF;
56 /* Encode PSS parameters */
57 if (ASN1_item_pack(rsa->pss, ASN1_ITEM_rptr(RSA_PSS_PARAMS), pstr) == NULL)
60 *pstrtype = V_ASN1_SEQUENCE;
63 /* Decode any parameters and set them in RSA structure */
64 static int rsa_param_decode(RSA *rsa, const X509_ALGOR *alg)
66 const ASN1_OBJECT *algoid;
70 X509_ALGOR_get0(&algoid, &algptype, &algp, alg);
71 if (OBJ_obj2nid(algoid) != EVP_PKEY_RSA_PSS)
73 if (algptype == V_ASN1_UNDEF)
75 if (algptype != V_ASN1_SEQUENCE) {
76 RSAerr(RSA_F_RSA_PARAM_DECODE, RSA_R_INVALID_PSS_PARAMETERS);
79 rsa->pss = rsa_pss_decode(alg);
82 if (!rsa_sync_to_pss_params_30(rsa))
87 static int rsa_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
89 unsigned char *penc = NULL;
94 if (!rsa_param_encode(pkey, &str, &strtype))
96 penclen = i2d_RSAPublicKey(pkey->pkey.rsa, &penc);
99 if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(pkey->ameth->pkey_id),
100 strtype, str, penc, penclen))
107 static int rsa_pub_decode(EVP_PKEY *pkey, const X509_PUBKEY *pubkey)
109 const unsigned char *p;
114 if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, &alg, pubkey))
116 if ((rsa = d2i_RSAPublicKey(NULL, &p, pklen)) == NULL)
118 if (!rsa_param_decode(rsa, alg)) {
123 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
124 switch (pkey->ameth->pkey_id) {
126 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
128 case EVP_PKEY_RSA_PSS:
129 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS);
132 /* Leave the type bits zero */
136 if (!EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, rsa)) {
143 static int rsa_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
146 * Don't check the public/private key, this is mostly for smart
149 if (((RSA_flags(a->pkey.rsa) & RSA_METHOD_FLAG_NO_CHECK))
150 || (RSA_flags(b->pkey.rsa) & RSA_METHOD_FLAG_NO_CHECK)) {
154 if (BN_cmp(b->pkey.rsa->n, a->pkey.rsa->n) != 0
155 || BN_cmp(b->pkey.rsa->e, a->pkey.rsa->e) != 0)
160 static int old_rsa_priv_decode(EVP_PKEY *pkey,
161 const unsigned char **pder, int derlen)
165 if ((rsa = d2i_RSAPrivateKey(NULL, pder, derlen)) == NULL)
167 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, rsa);
171 static int old_rsa_priv_encode(const EVP_PKEY *pkey, unsigned char **pder)
173 return i2d_RSAPrivateKey(pkey->pkey.rsa, pder);
176 static int rsa_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
178 unsigned char *rk = NULL;
183 if (!rsa_param_encode(pkey, &str, &strtype))
185 rklen = i2d_RSAPrivateKey(pkey->pkey.rsa, &rk);
188 RSAerr(RSA_F_RSA_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
189 ASN1_STRING_free(str);
193 if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(pkey->ameth->pkey_id), 0,
194 strtype, str, rk, rklen)) {
195 RSAerr(RSA_F_RSA_PRIV_ENCODE, ERR_R_MALLOC_FAILURE);
196 ASN1_STRING_free(str);
203 static int rsa_priv_decode(EVP_PKEY *pkey, const PKCS8_PRIV_KEY_INFO *p8)
205 const unsigned char *p;
208 const X509_ALGOR *alg;
210 if (!PKCS8_pkey_get0(NULL, &p, &pklen, &alg, p8))
212 rsa = d2i_RSAPrivateKey(NULL, &p, pklen);
214 RSAerr(RSA_F_RSA_PRIV_DECODE, ERR_R_RSA_LIB);
217 if (!rsa_param_decode(rsa, alg)) {
222 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
223 switch (pkey->ameth->pkey_id) {
225 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
227 case EVP_PKEY_RSA_PSS:
228 RSA_set_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS);
231 /* Leave the type bits zero */
235 EVP_PKEY_assign(pkey, pkey->ameth->pkey_id, rsa);
239 static int int_rsa_size(const EVP_PKEY *pkey)
241 return RSA_size(pkey->pkey.rsa);
244 static int rsa_bits(const EVP_PKEY *pkey)
246 return BN_num_bits(pkey->pkey.rsa->n);
249 static int rsa_security_bits(const EVP_PKEY *pkey)
251 return RSA_security_bits(pkey->pkey.rsa);
254 static void int_rsa_free(EVP_PKEY *pkey)
256 RSA_free(pkey->pkey.rsa);
259 static X509_ALGOR *rsa_mgf1_decode(X509_ALGOR *alg)
261 if (OBJ_obj2nid(alg->algorithm) != NID_mgf1)
263 return ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(X509_ALGOR),
267 static int rsa_pss_param_print(BIO *bp, int pss_key, RSA_PSS_PARAMS *pss,
271 X509_ALGOR *maskHash = NULL;
273 if (!BIO_indent(bp, indent, 128))
277 if (BIO_puts(bp, "No PSS parameter restrictions\n") <= 0)
281 if (BIO_puts(bp, "PSS parameter restrictions:") <= 0)
284 } else if (pss == NULL) {
285 if (BIO_puts(bp,"(INVALID PSS PARAMETERS)\n") <= 0)
289 if (BIO_puts(bp, "\n") <= 0)
293 if (!BIO_indent(bp, indent, 128))
295 if (BIO_puts(bp, "Hash Algorithm: ") <= 0)
298 if (pss->hashAlgorithm) {
299 if (i2a_ASN1_OBJECT(bp, pss->hashAlgorithm->algorithm) <= 0)
301 } else if (BIO_puts(bp, "sha1 (default)") <= 0) {
305 if (BIO_puts(bp, "\n") <= 0)
308 if (!BIO_indent(bp, indent, 128))
311 if (BIO_puts(bp, "Mask Algorithm: ") <= 0)
313 if (pss->maskGenAlgorithm) {
314 if (i2a_ASN1_OBJECT(bp, pss->maskGenAlgorithm->algorithm) <= 0)
316 if (BIO_puts(bp, " with ") <= 0)
318 maskHash = rsa_mgf1_decode(pss->maskGenAlgorithm);
319 if (maskHash != NULL) {
320 if (i2a_ASN1_OBJECT(bp, maskHash->algorithm) <= 0)
322 } else if (BIO_puts(bp, "INVALID") <= 0) {
325 } else if (BIO_puts(bp, "mgf1 with sha1 (default)") <= 0) {
330 if (!BIO_indent(bp, indent, 128))
332 if (BIO_printf(bp, "%s Salt Length: 0x", pss_key ? "Minimum" : "") <= 0)
334 if (pss->saltLength) {
335 if (i2a_ASN1_INTEGER(bp, pss->saltLength) <= 0)
337 } else if (BIO_puts(bp, "14 (default)") <= 0) {
342 if (!BIO_indent(bp, indent, 128))
344 if (BIO_puts(bp, "Trailer Field: 0x") <= 0)
346 if (pss->trailerField) {
347 if (i2a_ASN1_INTEGER(bp, pss->trailerField) <= 0)
349 } else if (BIO_puts(bp, "BC (default)") <= 0) {
357 X509_ALGOR_free(maskHash);
362 static int pkey_rsa_print(BIO *bp, const EVP_PKEY *pkey, int off, int priv)
364 const RSA *x = pkey->pkey.rsa;
367 int ret = 0, mod_len = 0, ex_primes;
370 mod_len = BN_num_bits(x->n);
371 ex_primes = sk_RSA_PRIME_INFO_num(x->prime_infos);
373 if (!BIO_indent(bp, off, 128))
376 if (BIO_printf(bp, "%s ", pkey_is_pss(pkey) ? "RSA-PSS" : "RSA") <= 0)
380 if (BIO_printf(bp, "Private-Key: (%d bit, %d primes)\n",
381 mod_len, ex_primes <= 0 ? 2 : ex_primes + 2) <= 0)
384 s = "publicExponent:";
386 if (BIO_printf(bp, "Public-Key: (%d bit)\n", mod_len) <= 0)
391 if (!ASN1_bn_print(bp, str, x->n, NULL, off))
393 if (!ASN1_bn_print(bp, s, x->e, NULL, off))
398 if (!ASN1_bn_print(bp, "privateExponent:", x->d, NULL, off))
400 if (!ASN1_bn_print(bp, "prime1:", x->p, NULL, off))
402 if (!ASN1_bn_print(bp, "prime2:", x->q, NULL, off))
404 if (!ASN1_bn_print(bp, "exponent1:", x->dmp1, NULL, off))
406 if (!ASN1_bn_print(bp, "exponent2:", x->dmq1, NULL, off))
408 if (!ASN1_bn_print(bp, "coefficient:", x->iqmp, NULL, off))
410 for (i = 0; i < sk_RSA_PRIME_INFO_num(x->prime_infos); i++) {
411 /* print multi-prime info */
413 RSA_PRIME_INFO *pinfo;
416 pinfo = sk_RSA_PRIME_INFO_value(x->prime_infos, i);
417 for (j = 0; j < 3; j++) {
418 if (!BIO_indent(bp, off, 128))
422 if (BIO_printf(bp, "prime%d:", i + 3) <= 0)
427 if (BIO_printf(bp, "exponent%d:", i + 3) <= 0)
432 if (BIO_printf(bp, "coefficient%d:", i + 3) <= 0)
439 if (!ASN1_bn_print(bp, "", bn, NULL, off))
444 if (pkey_is_pss(pkey) && !rsa_pss_param_print(bp, 1, x->pss, off))
451 static int rsa_pub_print(BIO *bp, const EVP_PKEY *pkey, int indent,
454 return pkey_rsa_print(bp, pkey, indent, 0);
457 static int rsa_priv_print(BIO *bp, const EVP_PKEY *pkey, int indent,
460 return pkey_rsa_print(bp, pkey, indent, 1);
463 static RSA_PSS_PARAMS *rsa_pss_decode(const X509_ALGOR *alg)
467 pss = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_PSS_PARAMS),
473 if (pss->maskGenAlgorithm != NULL) {
474 pss->maskHash = rsa_mgf1_decode(pss->maskGenAlgorithm);
475 if (pss->maskHash == NULL) {
476 RSA_PSS_PARAMS_free(pss);
484 static int rsa_sig_print(BIO *bp, const X509_ALGOR *sigalg,
485 const ASN1_STRING *sig, int indent, ASN1_PCTX *pctx)
487 if (OBJ_obj2nid(sigalg->algorithm) == EVP_PKEY_RSA_PSS) {
489 RSA_PSS_PARAMS *pss = rsa_pss_decode(sigalg);
491 rv = rsa_pss_param_print(bp, 0, pss, indent);
492 RSA_PSS_PARAMS_free(pss);
495 } else if (BIO_puts(bp, "\n") <= 0) {
499 return X509_signature_dump(bp, sig, indent);
503 static int rsa_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
505 X509_ALGOR *alg = NULL;
507 const EVP_MD *mgf1md;
512 case ASN1_PKEY_CTRL_PKCS7_SIGN:
514 PKCS7_SIGNER_INFO_get0_algs(arg2, NULL, NULL, &alg);
517 case ASN1_PKEY_CTRL_PKCS7_ENCRYPT:
518 if (pkey_is_pss(pkey))
521 PKCS7_RECIP_INFO_get0_alg(arg2, &alg);
523 #ifndef OPENSSL_NO_CMS
524 case ASN1_PKEY_CTRL_CMS_SIGN:
526 return rsa_cms_sign(arg2);
528 return rsa_cms_verify(arg2);
531 case ASN1_PKEY_CTRL_CMS_ENVELOPE:
532 if (pkey_is_pss(pkey))
535 return rsa_cms_encrypt(arg2);
537 return rsa_cms_decrypt(arg2);
540 case ASN1_PKEY_CTRL_CMS_RI_TYPE:
541 if (pkey_is_pss(pkey))
543 *(int *)arg2 = CMS_RECIPINFO_TRANS;
547 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
548 if (pkey->pkey.rsa->pss != NULL) {
549 if (!rsa_pss_get_param(pkey->pkey.rsa->pss, &md, &mgf1md,
551 RSAerr(0, ERR_R_INTERNAL_ERROR);
554 *(int *)arg2 = EVP_MD_type(md);
555 /* Return of 2 indicates this MD is mandatory */
558 *(int *)arg2 = NID_sha256;
567 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaEncryption), V_ASN1_NULL, 0);
573 /* allocate and set algorithm ID from EVP_MD, default SHA1 */
574 static int rsa_md_to_algor(X509_ALGOR **palg, const EVP_MD *md)
576 if (md == NULL || EVP_MD_type(md) == NID_sha1)
578 *palg = X509_ALGOR_new();
581 X509_ALGOR_set_md(*palg, md);
585 /* Allocate and set MGF1 algorithm ID from EVP_MD */
586 static int rsa_md_to_mgf1(X509_ALGOR **palg, const EVP_MD *mgf1md)
588 X509_ALGOR *algtmp = NULL;
589 ASN1_STRING *stmp = NULL;
592 if (mgf1md == NULL || EVP_MD_type(mgf1md) == NID_sha1)
594 /* need to embed algorithm ID inside another */
595 if (!rsa_md_to_algor(&algtmp, mgf1md))
597 if (ASN1_item_pack(algtmp, ASN1_ITEM_rptr(X509_ALGOR), &stmp) == NULL)
599 *palg = X509_ALGOR_new();
602 X509_ALGOR_set0(*palg, OBJ_nid2obj(NID_mgf1), V_ASN1_SEQUENCE, stmp);
605 ASN1_STRING_free(stmp);
606 X509_ALGOR_free(algtmp);
612 /* convert algorithm ID to EVP_MD, default SHA1 */
613 static const EVP_MD *rsa_algor_to_md(X509_ALGOR *alg)
619 md = EVP_get_digestbyobj(alg->algorithm);
621 RSAerr(RSA_F_RSA_ALGOR_TO_MD, RSA_R_UNKNOWN_DIGEST);
626 * Convert EVP_PKEY_CTX in PSS mode into corresponding algorithm parameter,
627 * suitable for setting an AlgorithmIdentifier.
630 static RSA_PSS_PARAMS *rsa_ctx_to_pss(EVP_PKEY_CTX *pkctx)
632 const EVP_MD *sigmd, *mgf1md;
633 EVP_PKEY *pk = EVP_PKEY_CTX_get0_pkey(pkctx);
634 RSA *rsa = EVP_PKEY_get0_RSA(pk);
637 if (EVP_PKEY_CTX_get_signature_md(pkctx, &sigmd) <= 0)
639 if (EVP_PKEY_CTX_get_rsa_mgf1_md(pkctx, &mgf1md) <= 0)
641 if (!EVP_PKEY_CTX_get_rsa_pss_saltlen(pkctx, &saltlen))
644 saltlen = EVP_MD_size(sigmd);
645 } else if (saltlen == -2 || saltlen == -3) {
646 saltlen = RSA_size(rsa) - EVP_MD_size(sigmd) - 2;
647 if ((EVP_PKEY_bits(pk) & 0x7) == 1)
653 return rsa_pss_params_create(sigmd, mgf1md, saltlen);
656 RSA_PSS_PARAMS *rsa_pss_params_create(const EVP_MD *sigmd,
657 const EVP_MD *mgf1md, int saltlen)
659 RSA_PSS_PARAMS *pss = RSA_PSS_PARAMS_new();
664 pss->saltLength = ASN1_INTEGER_new();
665 if (pss->saltLength == NULL)
667 if (!ASN1_INTEGER_set(pss->saltLength, saltlen))
670 if (!rsa_md_to_algor(&pss->hashAlgorithm, sigmd))
674 if (!rsa_md_to_mgf1(&pss->maskGenAlgorithm, mgf1md))
676 if (!rsa_md_to_algor(&pss->maskHash, mgf1md))
680 RSA_PSS_PARAMS_free(pss);
684 static ASN1_STRING *rsa_ctx_to_pss_string(EVP_PKEY_CTX *pkctx)
686 RSA_PSS_PARAMS *pss = rsa_ctx_to_pss(pkctx);
692 os = ASN1_item_pack(pss, ASN1_ITEM_rptr(RSA_PSS_PARAMS), NULL);
693 RSA_PSS_PARAMS_free(pss);
698 * From PSS AlgorithmIdentifier set public key parameters. If pkey isn't NULL
699 * then the EVP_MD_CTX is setup and initialised. If it is NULL parameters are
700 * passed to pkctx instead.
703 static int rsa_pss_to_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pkctx,
704 const X509_ALGOR *sigalg, EVP_PKEY *pkey)
708 const EVP_MD *mgf1md = NULL, *md = NULL;
711 /* Sanity check: make sure it is PSS */
712 if (OBJ_obj2nid(sigalg->algorithm) != EVP_PKEY_RSA_PSS) {
713 RSAerr(RSA_F_RSA_PSS_TO_CTX, RSA_R_UNSUPPORTED_SIGNATURE_TYPE);
716 /* Decode PSS parameters */
717 pss = rsa_pss_decode(sigalg);
719 if (!rsa_pss_get_param(pss, &md, &mgf1md, &saltlen)) {
720 RSAerr(RSA_F_RSA_PSS_TO_CTX, RSA_R_INVALID_PSS_PARAMETERS);
724 /* We have all parameters now set up context */
726 if (!EVP_DigestVerifyInit(ctx, &pkctx, md, NULL, pkey))
729 const EVP_MD *checkmd;
730 if (EVP_PKEY_CTX_get_signature_md(pkctx, &checkmd) <= 0)
732 if (EVP_MD_type(md) != EVP_MD_type(checkmd)) {
733 RSAerr(RSA_F_RSA_PSS_TO_CTX, RSA_R_DIGEST_DOES_NOT_MATCH);
738 if (EVP_PKEY_CTX_set_rsa_padding(pkctx, RSA_PKCS1_PSS_PADDING) <= 0)
741 if (EVP_PKEY_CTX_set_rsa_pss_saltlen(pkctx, saltlen) <= 0)
744 if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx, mgf1md) <= 0)
750 RSA_PSS_PARAMS_free(pss);
754 static int rsa_pss_verify_param(const EVP_MD **pmd, const EVP_MD **pmgf1md,
755 int *psaltlen, int *ptrailerField)
757 if (psaltlen != NULL && *psaltlen < 0) {
758 ERR_raise(ERR_LIB_RSA, RSA_R_INVALID_SALT_LENGTH);
762 * low-level routines support only trailer field 0xbc (value 1) and
763 * PKCS#1 says we should reject any other value anyway.
765 if (ptrailerField != NULL && *ptrailerField != 1) {
766 ERR_raise(ERR_LIB_RSA, RSA_R_INVALID_TRAILER);
772 static int rsa_pss_get_param_unverified(const RSA_PSS_PARAMS *pss,
774 const EVP_MD **pmgf1md,
775 int *psaltlen, int *ptrailerField)
777 RSA_PSS_PARAMS_30 pss_params;
779 /* Get the defaults from the ONE place */
780 (void)rsa_pss_params_30_set_defaults(&pss_params);
784 *pmd = rsa_algor_to_md(pss->hashAlgorithm);
787 *pmgf1md = rsa_algor_to_md(pss->maskHash);
788 if (*pmgf1md == NULL)
791 *psaltlen = ASN1_INTEGER_get(pss->saltLength);
793 *psaltlen = rsa_pss_params_30_saltlen(&pss_params);
794 if (pss->trailerField)
795 *ptrailerField = ASN1_INTEGER_get(pss->trailerField);
797 *ptrailerField = rsa_pss_params_30_trailerfield(&pss_params);;
802 int rsa_pss_get_param(const RSA_PSS_PARAMS *pss, const EVP_MD **pmd,
803 const EVP_MD **pmgf1md, int *psaltlen)
806 * Callers do not care about the trailer field, and yet, we must
807 * pass it from get_param to verify_param, since the latter checks
810 * When callers start caring, it's a simple thing to add another
811 * argument to this function.
813 int trailerField = 0;
815 return rsa_pss_get_param_unverified(pss, pmd, pmgf1md, psaltlen,
817 && rsa_pss_verify_param(pmd, pmgf1md, psaltlen, &trailerField);
820 static int rsa_sync_to_pss_params_30(RSA *rsa)
822 if (rsa != NULL && rsa->pss != NULL) {
823 const EVP_MD *md = NULL, *mgf1md = NULL;
824 int md_nid, mgf1md_nid, saltlen, trailerField;
825 RSA_PSS_PARAMS_30 pss_params;
828 * We don't care about the validity of the fields here, we just
829 * want to synchronise values. Verifying here makes it impossible
830 * to even read a key with invalid values, making it hard to test
833 * Other routines use rsa_pss_get_param(), so the values will be
834 * checked, eventually.
836 if (!rsa_pss_get_param_unverified(rsa->pss, &md, &mgf1md,
837 &saltlen, &trailerField))
839 md_nid = EVP_MD_type(md);
840 mgf1md_nid = EVP_MD_type(mgf1md);
841 if (!rsa_pss_params_30_set_defaults(&pss_params)
842 || !rsa_pss_params_30_set_hashalg(&pss_params, md_nid)
843 || !rsa_pss_params_30_set_maskgenhashalg(&pss_params, mgf1md_nid)
844 || !rsa_pss_params_30_set_saltlen(&pss_params, saltlen)
845 || !rsa_pss_params_30_set_trailerfield(&pss_params, trailerField))
847 rsa->pss_params = pss_params;
852 #ifndef OPENSSL_NO_CMS
853 static int rsa_cms_verify(CMS_SignerInfo *si)
857 EVP_PKEY_CTX *pkctx = CMS_SignerInfo_get0_pkey_ctx(si);
859 CMS_SignerInfo_get0_algs(si, NULL, NULL, NULL, &alg);
860 nid = OBJ_obj2nid(alg->algorithm);
861 if (nid == EVP_PKEY_RSA_PSS)
862 return rsa_pss_to_ctx(NULL, pkctx, alg, NULL);
863 /* Only PSS allowed for PSS keys */
864 if (pkey_ctx_is_pss(pkctx)) {
865 RSAerr(RSA_F_RSA_CMS_VERIFY, RSA_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE);
868 if (nid == NID_rsaEncryption)
870 /* Workaround for some implementation that use a signature OID */
871 if (OBJ_find_sigid_algs(nid, NULL, &nid2)) {
872 if (nid2 == NID_rsaEncryption)
880 * Customised RSA item verification routine. This is called when a signature
881 * is encountered requiring special handling. We currently only handle PSS.
884 static int rsa_item_verify(EVP_MD_CTX *ctx, const ASN1_ITEM *it,
885 const void *asn, const X509_ALGOR *sigalg,
886 const ASN1_BIT_STRING *sig, EVP_PKEY *pkey)
888 /* Sanity check: make sure it is PSS */
889 if (OBJ_obj2nid(sigalg->algorithm) != EVP_PKEY_RSA_PSS) {
890 RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNSUPPORTED_SIGNATURE_TYPE);
893 if (rsa_pss_to_ctx(ctx, NULL, sigalg, pkey) > 0) {
900 #ifndef OPENSSL_NO_CMS
901 static int rsa_cms_sign(CMS_SignerInfo *si)
903 int pad_mode = RSA_PKCS1_PADDING;
905 EVP_PKEY_CTX *pkctx = CMS_SignerInfo_get0_pkey_ctx(si);
906 ASN1_STRING *os = NULL;
908 CMS_SignerInfo_get0_algs(si, NULL, NULL, NULL, &alg);
910 if (EVP_PKEY_CTX_get_rsa_padding(pkctx, &pad_mode) <= 0)
913 if (pad_mode == RSA_PKCS1_PADDING) {
914 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaEncryption), V_ASN1_NULL, 0);
917 /* We don't support it */
918 if (pad_mode != RSA_PKCS1_PSS_PADDING)
920 os = rsa_ctx_to_pss_string(pkctx);
923 X509_ALGOR_set0(alg, OBJ_nid2obj(EVP_PKEY_RSA_PSS), V_ASN1_SEQUENCE, os);
928 static int rsa_item_sign(EVP_MD_CTX *ctx, const ASN1_ITEM *it, const void *asn,
929 X509_ALGOR *alg1, X509_ALGOR *alg2,
930 ASN1_BIT_STRING *sig)
933 EVP_PKEY_CTX *pkctx = EVP_MD_CTX_pkey_ctx(ctx);
935 if (EVP_PKEY_CTX_get_rsa_padding(pkctx, &pad_mode) <= 0)
937 if (pad_mode == RSA_PKCS1_PADDING)
939 if (pad_mode == RSA_PKCS1_PSS_PADDING) {
940 ASN1_STRING *os1 = NULL;
941 os1 = rsa_ctx_to_pss_string(pkctx);
944 /* Duplicate parameters if we have to */
946 ASN1_STRING *os2 = ASN1_STRING_dup(os1);
948 ASN1_STRING_free(os1);
951 X509_ALGOR_set0(alg2, OBJ_nid2obj(EVP_PKEY_RSA_PSS),
952 V_ASN1_SEQUENCE, os2);
954 X509_ALGOR_set0(alg1, OBJ_nid2obj(EVP_PKEY_RSA_PSS),
955 V_ASN1_SEQUENCE, os1);
961 static int rsa_sig_info_set(X509_SIG_INFO *siginf, const X509_ALGOR *sigalg,
962 const ASN1_STRING *sig)
967 const EVP_MD *mgf1md = NULL, *md = NULL;
971 /* Sanity check: make sure it is PSS */
972 if (OBJ_obj2nid(sigalg->algorithm) != EVP_PKEY_RSA_PSS)
974 /* Decode PSS parameters */
975 pss = rsa_pss_decode(sigalg);
976 if (!rsa_pss_get_param(pss, &md, &mgf1md, &saltlen))
978 mdnid = EVP_MD_type(md);
980 * For TLS need SHA256, SHA384 or SHA512, digest and MGF1 digest must
981 * match and salt length must equal digest size
983 if ((mdnid == NID_sha256 || mdnid == NID_sha384 || mdnid == NID_sha512)
984 && mdnid == EVP_MD_type(mgf1md) && saltlen == EVP_MD_size(md))
985 flags = X509_SIG_INFO_TLS;
988 /* Note: security bits half number of digest bits */
989 secbits = EVP_MD_size(md) * 4;
991 * SHA1 and MD5 are known to be broken. Reduce security bits so that
992 * they're no longer accepted at security level 1. The real values don't
993 * really matter as long as they're lower than 80, which is our security
995 * https://eprint.iacr.org/2020/014 puts a chosen-prefix attack for SHA1 at
997 * https://documents.epfl.ch/users/l/le/lenstra/public/papers/lat.pdf
998 * puts a chosen-prefix attack for MD5 at 2^39.
1000 if (mdnid == NID_sha1)
1002 else if (mdnid == NID_md5_sha1)
1004 else if (mdnid == NID_md5)
1006 X509_SIG_INFO_set(siginf, mdnid, EVP_PKEY_RSA_PSS, secbits,
1010 RSA_PSS_PARAMS_free(pss);
1014 #ifndef OPENSSL_NO_CMS
1015 static RSA_OAEP_PARAMS *rsa_oaep_decode(const X509_ALGOR *alg)
1017 RSA_OAEP_PARAMS *oaep;
1019 oaep = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(RSA_OAEP_PARAMS),
1025 if (oaep->maskGenFunc != NULL) {
1026 oaep->maskHash = rsa_mgf1_decode(oaep->maskGenFunc);
1027 if (oaep->maskHash == NULL) {
1028 RSA_OAEP_PARAMS_free(oaep);
1035 static int rsa_cms_decrypt(CMS_RecipientInfo *ri)
1037 EVP_PKEY_CTX *pkctx;
1041 unsigned char *label = NULL;
1043 const EVP_MD *mgf1md = NULL, *md = NULL;
1044 RSA_OAEP_PARAMS *oaep;
1046 pkctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
1049 if (!CMS_RecipientInfo_ktri_get0_algs(ri, NULL, NULL, &cmsalg))
1051 nid = OBJ_obj2nid(cmsalg->algorithm);
1052 if (nid == NID_rsaEncryption)
1054 if (nid != NID_rsaesOaep) {
1055 RSAerr(RSA_F_RSA_CMS_DECRYPT, RSA_R_UNSUPPORTED_ENCRYPTION_TYPE);
1058 /* Decode OAEP parameters */
1059 oaep = rsa_oaep_decode(cmsalg);
1062 RSAerr(RSA_F_RSA_CMS_DECRYPT, RSA_R_INVALID_OAEP_PARAMETERS);
1066 mgf1md = rsa_algor_to_md(oaep->maskHash);
1069 md = rsa_algor_to_md(oaep->hashFunc);
1073 if (oaep->pSourceFunc != NULL) {
1074 X509_ALGOR *plab = oaep->pSourceFunc;
1076 if (OBJ_obj2nid(plab->algorithm) != NID_pSpecified) {
1077 RSAerr(RSA_F_RSA_CMS_DECRYPT, RSA_R_UNSUPPORTED_LABEL_SOURCE);
1080 if (plab->parameter->type != V_ASN1_OCTET_STRING) {
1081 RSAerr(RSA_F_RSA_CMS_DECRYPT, RSA_R_INVALID_LABEL);
1085 label = plab->parameter->value.octet_string->data;
1086 /* Stop label being freed when OAEP parameters are freed */
1087 plab->parameter->value.octet_string->data = NULL;
1088 labellen = plab->parameter->value.octet_string->length;
1091 if (EVP_PKEY_CTX_set_rsa_padding(pkctx, RSA_PKCS1_OAEP_PADDING) <= 0)
1093 if (EVP_PKEY_CTX_set_rsa_oaep_md(pkctx, md) <= 0)
1095 if (EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx, mgf1md) <= 0)
1098 && EVP_PKEY_CTX_set0_rsa_oaep_label(pkctx, label, labellen) <= 0)
1104 RSA_OAEP_PARAMS_free(oaep);
1108 static int rsa_cms_encrypt(CMS_RecipientInfo *ri)
1110 const EVP_MD *md, *mgf1md;
1111 RSA_OAEP_PARAMS *oaep = NULL;
1112 ASN1_STRING *os = NULL;
1114 EVP_PKEY_CTX *pkctx = CMS_RecipientInfo_get0_pkey_ctx(ri);
1115 int pad_mode = RSA_PKCS1_PADDING, rv = 0, labellen;
1116 unsigned char *label;
1118 if (CMS_RecipientInfo_ktri_get0_algs(ri, NULL, NULL, &alg) <= 0)
1121 if (EVP_PKEY_CTX_get_rsa_padding(pkctx, &pad_mode) <= 0)
1124 if (pad_mode == RSA_PKCS1_PADDING) {
1125 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaEncryption), V_ASN1_NULL, 0);
1129 if (pad_mode != RSA_PKCS1_OAEP_PADDING)
1131 if (EVP_PKEY_CTX_get_rsa_oaep_md(pkctx, &md) <= 0)
1133 if (EVP_PKEY_CTX_get_rsa_mgf1_md(pkctx, &mgf1md) <= 0)
1135 labellen = EVP_PKEY_CTX_get0_rsa_oaep_label(pkctx, &label);
1138 oaep = RSA_OAEP_PARAMS_new();
1141 if (!rsa_md_to_algor(&oaep->hashFunc, md))
1143 if (!rsa_md_to_mgf1(&oaep->maskGenFunc, mgf1md))
1146 ASN1_OCTET_STRING *los;
1147 oaep->pSourceFunc = X509_ALGOR_new();
1148 if (oaep->pSourceFunc == NULL)
1150 los = ASN1_OCTET_STRING_new();
1153 if (!ASN1_OCTET_STRING_set(los, label, labellen)) {
1154 ASN1_OCTET_STRING_free(los);
1157 X509_ALGOR_set0(oaep->pSourceFunc, OBJ_nid2obj(NID_pSpecified),
1158 V_ASN1_OCTET_STRING, los);
1160 /* create string with pss parameter encoding. */
1161 if (!ASN1_item_pack(oaep, ASN1_ITEM_rptr(RSA_OAEP_PARAMS), &os))
1163 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaesOaep), V_ASN1_SEQUENCE, os);
1167 RSA_OAEP_PARAMS_free(oaep);
1168 ASN1_STRING_free(os);
1173 static int rsa_pkey_check(const EVP_PKEY *pkey)
1175 return RSA_check_key_ex(pkey->pkey.rsa, NULL);
1178 static size_t rsa_pkey_dirty_cnt(const EVP_PKEY *pkey)
1180 return pkey->pkey.rsa->dirty_cnt;
1184 * For the moment, we trust the call path, where keys going through
1185 * rsa_pkey_export_to() match a KEYMGMT for the "RSA" keytype, while
1186 * keys going through rsa_pss_pkey_export_to() match a KEYMGMT for the
1187 * "RSA-PSS" keytype.
1188 * TODO(3.0) Investigate whether we should simply continue to trust the
1189 * call path, or if we should strengthen this function by checking that
1190 * |rsa_type| matches the RSA key subtype. The latter requires ensuring
1191 * that the type flag for the RSA key is properly set by other functions
1194 static int rsa_int_export_to(const EVP_PKEY *from, int rsa_type,
1195 void *to_keydata, EVP_KEYMGMT *to_keymgmt,
1196 OPENSSL_CTX *libctx, const char *propq)
1198 RSA *rsa = from->pkey.rsa;
1199 OSSL_PARAM_BLD *tmpl = OSSL_PARAM_BLD_new();
1200 OSSL_PARAM *params = NULL;
1207 * If the RSA method is foreign, then we can't be sure of anything, and
1208 * can therefore not export or pretend to export.
1210 if (RSA_get_method(rsa) != RSA_PKCS1_OpenSSL())
1213 /* Public parameters must always be present */
1214 if (RSA_get0_n(rsa) == NULL || RSA_get0_e(rsa) == NULL)
1217 if (!rsa_todata(rsa, tmpl, NULL))
1220 selection |= OSSL_KEYMGMT_SELECT_PUBLIC_KEY;
1221 if (RSA_get0_d(rsa) != NULL)
1222 selection |= OSSL_KEYMGMT_SELECT_PRIVATE_KEY;
1224 if (rsa->pss != NULL) {
1225 const EVP_MD *md = NULL, *mgf1md = NULL;
1226 int md_nid, mgf1md_nid, saltlen, trailerfield;
1227 RSA_PSS_PARAMS_30 pss_params;
1229 if (!rsa_pss_get_param_unverified(rsa->pss, &md, &mgf1md,
1230 &saltlen, &trailerfield))
1232 md_nid = EVP_MD_type(md);
1233 mgf1md_nid = EVP_MD_type(mgf1md);
1234 if (!rsa_pss_params_30_set_defaults(&pss_params)
1235 || !rsa_pss_params_30_set_hashalg(&pss_params, md_nid)
1236 || !rsa_pss_params_30_set_maskgenhashalg(&pss_params, mgf1md_nid)
1237 || !rsa_pss_params_30_set_saltlen(&pss_params, saltlen)
1238 || !rsa_pss_params_30_todata(&pss_params, tmpl, NULL))
1240 selection |= OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS;
1243 if ((params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL)
1246 /* We export, the provider imports */
1247 rv = evp_keymgmt_import(to_keymgmt, to_keydata, selection, params);
1250 OSSL_PARAM_BLD_free_params(params);
1251 OSSL_PARAM_BLD_free(tmpl);
1255 static int rsa_int_import_from(const OSSL_PARAM params[], void *vpctx,
1258 EVP_PKEY_CTX *pctx = vpctx;
1259 EVP_PKEY *pkey = EVP_PKEY_CTX_get0_pkey(pctx);
1260 RSA *rsa = rsa_new_with_ctx(pctx->libctx);
1261 RSA_PSS_PARAMS_30 rsa_pss_params = { 0, };
1265 ERR_raise(ERR_LIB_DH, ERR_R_MALLOC_FAILURE);
1269 RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
1270 RSA_set_flags(rsa, rsa_type);
1272 if (!rsa_pss_params_30_fromdata(&rsa_pss_params, params, pctx->libctx))
1276 case RSA_FLAG_TYPE_RSA:
1278 * Were PSS parameters filled in?
1279 * In that case, something's wrong
1281 if (!rsa_pss_params_30_is_unrestricted(&rsa_pss_params))
1284 case RSA_FLAG_TYPE_RSASSAPSS:
1286 * Were PSS parameters filled in? In that case, create the old
1287 * RSA_PSS_PARAMS structure. Otherwise, this is an unrestricted key.
1289 if (!rsa_pss_params_30_is_unrestricted(&rsa_pss_params)) {
1290 /* Create the older RSA_PSS_PARAMS from RSA_PSS_PARAMS_30 data */
1291 int mdnid = rsa_pss_params_30_hashalg(&rsa_pss_params);
1292 int mgf1mdnid = rsa_pss_params_30_maskgenhashalg(&rsa_pss_params);
1293 int saltlen = rsa_pss_params_30_saltlen(&rsa_pss_params);
1294 const EVP_MD *md = EVP_get_digestbynid(mdnid);
1295 const EVP_MD *mgf1md = EVP_get_digestbynid(mgf1mdnid);
1297 if ((rsa->pss = rsa_pss_params_create(md, mgf1md, saltlen)) == NULL)
1302 /* RSA key sub-types we don't know how to handle yet */
1306 if (!rsa_fromdata(rsa, params))
1310 case RSA_FLAG_TYPE_RSA:
1311 ok = EVP_PKEY_assign_RSA(pkey, rsa);
1313 case RSA_FLAG_TYPE_RSASSAPSS:
1314 ok = EVP_PKEY_assign(pkey, EVP_PKEY_RSA_PSS, rsa);
1324 static int rsa_pkey_export_to(const EVP_PKEY *from, void *to_keydata,
1325 EVP_KEYMGMT *to_keymgmt, OPENSSL_CTX *libctx,
1328 return rsa_int_export_to(from, RSA_FLAG_TYPE_RSA, to_keydata,
1329 to_keymgmt, libctx, propq);
1332 static int rsa_pss_pkey_export_to(const EVP_PKEY *from, void *to_keydata,
1333 EVP_KEYMGMT *to_keymgmt, OPENSSL_CTX *libctx,
1336 return rsa_int_export_to(from, RSA_FLAG_TYPE_RSASSAPSS, to_keydata,
1337 to_keymgmt, libctx, propq);
1340 static int rsa_pkey_import_from(const OSSL_PARAM params[], void *vpctx)
1342 return rsa_int_import_from(params, vpctx, RSA_FLAG_TYPE_RSA);
1345 static int rsa_pss_pkey_import_from(const OSSL_PARAM params[], void *vpctx)
1347 return rsa_int_import_from(params, vpctx, RSA_FLAG_TYPE_RSASSAPSS);
1350 const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[2] = {
1354 ASN1_PKEY_SIGPARAM_NULL,
1357 "OpenSSL RSA method",
1377 old_rsa_priv_decode,
1378 old_rsa_priv_encode,
1389 rsa_pkey_import_from
1398 const EVP_PKEY_ASN1_METHOD rsa_pss_asn1_meth = {
1401 ASN1_PKEY_SIGPARAM_NULL,
1404 "OpenSSL RSA-PSS method",
1434 rsa_pss_pkey_export_to,
1435 rsa_pss_pkey_import_from