2 * Copyright 2019-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"
16 #include "e_os.h" /* strcasecmp */
18 #include <openssl/crypto.h>
19 #include <openssl/core_dispatch.h>
20 #include <openssl/core_names.h>
21 #include <openssl/err.h>
22 #include <openssl/rsa.h>
23 #include <openssl/params.h>
24 #include <openssl/evp.h>
25 #include <openssl/proverr.h>
26 #include "internal/cryptlib.h"
27 #include "internal/nelem.h"
28 #include "internal/sizes.h"
29 #include "crypto/rsa.h"
30 #include "prov/providercommon.h"
31 #include "prov/implementations.h"
32 #include "prov/provider_ctx.h"
33 #include "prov/der_rsa.h"
34 #include "prov/securitycheck.h"
36 #define RSA_DEFAULT_DIGEST_NAME OSSL_DIGEST_NAME_SHA1
38 static OSSL_FUNC_signature_newctx_fn rsa_newctx;
39 static OSSL_FUNC_signature_sign_init_fn rsa_sign_init;
40 static OSSL_FUNC_signature_verify_init_fn rsa_verify_init;
41 static OSSL_FUNC_signature_verify_recover_init_fn rsa_verify_recover_init;
42 static OSSL_FUNC_signature_sign_fn rsa_sign;
43 static OSSL_FUNC_signature_verify_fn rsa_verify;
44 static OSSL_FUNC_signature_verify_recover_fn rsa_verify_recover;
45 static OSSL_FUNC_signature_digest_sign_init_fn rsa_digest_sign_init;
46 static OSSL_FUNC_signature_digest_sign_update_fn rsa_digest_signverify_update;
47 static OSSL_FUNC_signature_digest_sign_final_fn rsa_digest_sign_final;
48 static OSSL_FUNC_signature_digest_verify_init_fn rsa_digest_verify_init;
49 static OSSL_FUNC_signature_digest_verify_update_fn rsa_digest_signverify_update;
50 static OSSL_FUNC_signature_digest_verify_final_fn rsa_digest_verify_final;
51 static OSSL_FUNC_signature_freectx_fn rsa_freectx;
52 static OSSL_FUNC_signature_dupctx_fn rsa_dupctx;
53 static OSSL_FUNC_signature_get_ctx_params_fn rsa_get_ctx_params;
54 static OSSL_FUNC_signature_gettable_ctx_params_fn rsa_gettable_ctx_params;
55 static OSSL_FUNC_signature_set_ctx_params_fn rsa_set_ctx_params;
56 static OSSL_FUNC_signature_settable_ctx_params_fn rsa_settable_ctx_params;
57 static OSSL_FUNC_signature_get_ctx_md_params_fn rsa_get_ctx_md_params;
58 static OSSL_FUNC_signature_gettable_ctx_md_params_fn rsa_gettable_ctx_md_params;
59 static OSSL_FUNC_signature_set_ctx_md_params_fn rsa_set_ctx_md_params;
60 static OSSL_FUNC_signature_settable_ctx_md_params_fn rsa_settable_ctx_md_params;
62 static OSSL_ITEM padding_item[] = {
63 { RSA_PKCS1_PADDING, OSSL_PKEY_RSA_PAD_MODE_PKCSV15 },
64 { RSA_SSLV23_PADDING, OSSL_PKEY_RSA_PAD_MODE_SSLV23 },
65 { RSA_NO_PADDING, OSSL_PKEY_RSA_PAD_MODE_NONE },
66 { RSA_X931_PADDING, OSSL_PKEY_RSA_PAD_MODE_X931 },
67 { RSA_PKCS1_PSS_PADDING, OSSL_PKEY_RSA_PAD_MODE_PSS },
72 * What's passed as an actual key is defined by the KEYMGMT interface.
73 * We happen to know that our KEYMGMT simply passes RSA structures, so
74 * we use that here too.
84 * Flag to determine if the hash function can be changed (1) or not (0)
85 * Because it's dangerous to change during a DigestSign or DigestVerify
86 * operation, this flag is cleared by their Init function, and set again
87 * by their Final function.
89 unsigned int flag_allow_md : 1;
90 unsigned int mgf1_md_set : 1;
96 char mdname[OSSL_MAX_NAME_SIZE]; /* Purely informational */
98 /* RSA padding mode */
100 /* message digest for MGF1 */
103 char mgf1_mdname[OSSL_MAX_NAME_SIZE]; /* Purely informational */
104 /* PSS salt length */
106 /* Minimum salt length or -1 if no PSS parameter restriction */
114 /* True if PSS parameters are restricted */
115 #define rsa_pss_restricted(prsactx) (prsactx->min_saltlen != -1)
117 static size_t rsa_get_md_size(const PROV_RSA_CTX *prsactx)
119 if (prsactx->md != NULL)
120 return EVP_MD_size(prsactx->md);
124 static int rsa_check_padding(const PROV_RSA_CTX *prsactx,
125 const char *mdname, const char *mgf1_mdname,
128 switch(prsactx->pad_mode) {
130 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_PADDING_MODE);
132 case RSA_X931_PADDING:
133 if (RSA_X931_hash_id(mdnid) == -1) {
134 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_X931_DIGEST);
138 case RSA_PKCS1_PSS_PADDING:
139 if (rsa_pss_restricted(prsactx))
140 if ((mdname != NULL && !EVP_MD_is_a(prsactx->md, mdname))
141 || (mgf1_mdname != NULL
142 && !EVP_MD_is_a(prsactx->mgf1_md, mgf1_mdname))) {
143 ERR_raise(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED);
154 static int rsa_check_parameters(PROV_RSA_CTX *prsactx, int min_saltlen)
156 if (prsactx->pad_mode == RSA_PKCS1_PSS_PADDING) {
159 /* See if minimum salt length exceeds maximum possible */
160 max_saltlen = RSA_size(prsactx->rsa) - EVP_MD_size(prsactx->md);
161 if ((RSA_bits(prsactx->rsa) & 0x7) == 1)
163 if (min_saltlen < 0 || min_saltlen > max_saltlen) {
164 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
167 prsactx->min_saltlen = min_saltlen;
172 static void *rsa_newctx(void *provctx, const char *propq)
174 PROV_RSA_CTX *prsactx = NULL;
175 char *propq_copy = NULL;
177 if (!ossl_prov_is_running())
180 if ((prsactx = OPENSSL_zalloc(sizeof(PROV_RSA_CTX))) == NULL
182 && (propq_copy = OPENSSL_strdup(propq)) == NULL)) {
183 OPENSSL_free(prsactx);
184 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
188 prsactx->libctx = PROV_LIBCTX_OF(provctx);
189 prsactx->flag_allow_md = 1;
190 prsactx->propq = propq_copy;
194 static int rsa_pss_compute_saltlen(PROV_RSA_CTX *ctx)
196 int saltlen = ctx->saltlen;
198 if (saltlen == RSA_PSS_SALTLEN_DIGEST) {
199 saltlen = EVP_MD_size(ctx->md);
200 } else if (saltlen == RSA_PSS_SALTLEN_AUTO || saltlen == RSA_PSS_SALTLEN_MAX) {
201 saltlen = RSA_size(ctx->rsa) - EVP_MD_size(ctx->md) - 2;
202 if ((RSA_bits(ctx->rsa) & 0x7) == 1)
206 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
208 } else if (saltlen < ctx->min_saltlen) {
209 ERR_raise_data(ERR_LIB_PROV, PROV_R_PSS_SALTLEN_TOO_SMALL,
210 "minimum salt length: %d, actual salt length: %d",
211 ctx->min_saltlen, saltlen);
217 static unsigned char *rsa_generate_signature_aid(PROV_RSA_CTX *ctx,
218 unsigned char *aid_buf,
223 unsigned char *aid = NULL;
225 RSA_PSS_PARAMS_30 pss_params;
227 if (!WPACKET_init_der(&pkt, aid_buf, buf_len)) {
228 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
232 switch(ctx->pad_mode) {
233 case RSA_PKCS1_PADDING:
234 if (!ossl_DER_w_algorithmIdentifier_MDWithRSAEncryption(&pkt, -1,
236 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
240 case RSA_PKCS1_PSS_PADDING:
241 saltlen = rsa_pss_compute_saltlen(ctx);
244 if (!ossl_rsa_pss_params_30_set_defaults(&pss_params)
245 || !ossl_rsa_pss_params_30_set_hashalg(&pss_params, ctx->mdnid)
246 || !ossl_rsa_pss_params_30_set_maskgenhashalg(&pss_params,
248 || !ossl_rsa_pss_params_30_set_saltlen(&pss_params, saltlen)
249 || !ossl_DER_w_algorithmIdentifier_RSA_PSS(&pkt, -1,
250 RSA_FLAG_TYPE_RSASSAPSS,
252 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
257 ERR_raise_data(ERR_LIB_PROV, ERR_R_UNSUPPORTED,
258 "Algorithm ID generation");
261 if (WPACKET_finish(&pkt)) {
262 WPACKET_get_total_written(&pkt, aid_len);
263 aid = WPACKET_get_curr(&pkt);
266 WPACKET_cleanup(&pkt);
270 static int rsa_setup_md(PROV_RSA_CTX *ctx, const char *mdname,
274 mdprops = ctx->propq;
276 if (mdname != NULL) {
277 EVP_MD *md = EVP_MD_fetch(ctx->libctx, mdname, mdprops);
278 int sha1_allowed = (ctx->operation != EVP_PKEY_OP_SIGN);
279 int md_nid = digest_rsa_sign_get_md_nid(md, sha1_allowed);
280 size_t mdname_len = strlen(mdname);
283 || md_nid == NID_undef
284 || !rsa_check_padding(ctx, mdname, NULL, md_nid)
285 || mdname_len >= sizeof(ctx->mdname)) {
287 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
288 "%s could not be fetched", mdname);
289 if (md_nid == NID_undef)
290 ERR_raise_data(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED,
291 "digest=%s", mdname);
292 if (mdname_len >= sizeof(ctx->mdname))
293 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
294 "%s exceeds name buffer length", mdname);
299 if (!ctx->mgf1_md_set) {
300 if (!EVP_MD_up_ref(md)) {
304 EVP_MD_free(ctx->mgf1_md);
306 ctx->mgf1_mdnid = md_nid;
307 OPENSSL_strlcpy(ctx->mgf1_mdname, mdname, sizeof(ctx->mgf1_mdname));
310 EVP_MD_CTX_free(ctx->mdctx);
311 EVP_MD_free(ctx->md);
316 OPENSSL_strlcpy(ctx->mdname, mdname, sizeof(ctx->mdname));
322 static int rsa_setup_mgf1_md(PROV_RSA_CTX *ctx, const char *mdname,
330 mdprops = ctx->propq;
332 if ((md = EVP_MD_fetch(ctx->libctx, mdname, mdprops)) == NULL) {
333 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
334 "%s could not be fetched", mdname);
337 /* The default for mgf1 is SHA1 - so allow SHA1 */
338 if ((mdnid = digest_rsa_sign_get_md_nid(md, 1)) == NID_undef
339 || !rsa_check_padding(ctx, NULL, mdname, mdnid)) {
340 if (mdnid == NID_undef)
341 ERR_raise_data(ERR_LIB_PROV, PROV_R_DIGEST_NOT_ALLOWED,
342 "digest=%s", mdname);
346 len = OPENSSL_strlcpy(ctx->mgf1_mdname, mdname, sizeof(ctx->mgf1_mdname));
347 if (len >= sizeof(ctx->mgf1_mdname)) {
348 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
349 "%s exceeds name buffer length", mdname);
354 EVP_MD_free(ctx->mgf1_md);
356 ctx->mgf1_mdnid = mdnid;
357 ctx->mgf1_md_set = 1;
361 static int rsa_signverify_init(void *vprsactx, void *vrsa, int operation)
363 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
365 if (!ossl_prov_is_running())
368 if (prsactx == NULL || vrsa == NULL || !RSA_up_ref(vrsa))
371 RSA_free(prsactx->rsa);
373 prsactx->operation = operation;
375 if (!ossl_rsa_check_key(vrsa, operation == EVP_PKEY_OP_SIGN)) {
376 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
380 /* Maximum for sign, auto for verify */
381 prsactx->saltlen = RSA_PSS_SALTLEN_AUTO;
382 prsactx->min_saltlen = -1;
384 switch (RSA_test_flags(prsactx->rsa, RSA_FLAG_TYPE_MASK)) {
385 case RSA_FLAG_TYPE_RSA:
386 prsactx->pad_mode = RSA_PKCS1_PADDING;
388 case RSA_FLAG_TYPE_RSASSAPSS:
389 prsactx->pad_mode = RSA_PKCS1_PSS_PADDING;
392 const RSA_PSS_PARAMS_30 *pss =
393 ossl_rsa_get0_pss_params_30(prsactx->rsa);
395 if (!ossl_rsa_pss_params_30_is_unrestricted(pss)) {
396 int md_nid = ossl_rsa_pss_params_30_hashalg(pss);
397 int mgf1md_nid = ossl_rsa_pss_params_30_maskgenhashalg(pss);
398 int min_saltlen = ossl_rsa_pss_params_30_saltlen(pss);
399 const char *mdname, *mgf1mdname;
402 mdname = ossl_rsa_oaeppss_nid2name(md_nid);
403 mgf1mdname = ossl_rsa_oaeppss_nid2name(mgf1md_nid);
405 if (mdname == NULL) {
406 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
407 "PSS restrictions lack hash algorithm");
410 if (mgf1mdname == NULL) {
411 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
412 "PSS restrictions lack MGF1 hash algorithm");
416 len = OPENSSL_strlcpy(prsactx->mdname, mdname,
417 sizeof(prsactx->mdname));
418 if (len >= sizeof(prsactx->mdname)) {
419 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
420 "hash algorithm name too long");
423 len = OPENSSL_strlcpy(prsactx->mgf1_mdname, mgf1mdname,
424 sizeof(prsactx->mgf1_mdname));
425 if (len >= sizeof(prsactx->mgf1_mdname)) {
426 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST,
427 "MGF1 hash algorithm name too long");
430 prsactx->saltlen = min_saltlen;
432 /* call rsa_setup_mgf1_md before rsa_setup_md to avoid duplication */
433 return rsa_setup_mgf1_md(prsactx, mgf1mdname, prsactx->propq)
434 && rsa_setup_md(prsactx, mdname, prsactx->propq)
435 && rsa_check_parameters(prsactx, min_saltlen);
441 ERR_raise(ERR_LIB_RSA, PROV_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE);
448 static int setup_tbuf(PROV_RSA_CTX *ctx)
450 if (ctx->tbuf != NULL)
452 if ((ctx->tbuf = OPENSSL_malloc(RSA_size(ctx->rsa))) == NULL) {
453 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
459 static void clean_tbuf(PROV_RSA_CTX *ctx)
461 if (ctx->tbuf != NULL)
462 OPENSSL_cleanse(ctx->tbuf, RSA_size(ctx->rsa));
465 static void free_tbuf(PROV_RSA_CTX *ctx)
468 OPENSSL_free(ctx->tbuf);
472 static int rsa_sign_init(void *vprsactx, void *vrsa)
474 if (!ossl_prov_is_running())
476 return rsa_signverify_init(vprsactx, vrsa, EVP_PKEY_OP_SIGN);
479 static int rsa_sign(void *vprsactx, unsigned char *sig, size_t *siglen,
480 size_t sigsize, const unsigned char *tbs, size_t tbslen)
482 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
484 size_t rsasize = RSA_size(prsactx->rsa);
485 size_t mdsize = rsa_get_md_size(prsactx);
487 if (!ossl_prov_is_running())
495 if (sigsize < rsasize) {
496 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_SIGNATURE_SIZE,
497 "is %zu, should be at least %zu", sigsize, rsasize);
502 if (tbslen != mdsize) {
503 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_LENGTH);
508 if (EVP_MD_is_a(prsactx->md, OSSL_DIGEST_NAME_MDC2)) {
511 if (prsactx->pad_mode != RSA_PKCS1_PADDING) {
512 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_PADDING_MODE,
513 "only PKCS#1 padding supported with MDC2");
516 ret = RSA_sign_ASN1_OCTET_STRING(0, tbs, tbslen, sig, &sltmp,
520 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
527 switch (prsactx->pad_mode) {
528 case RSA_X931_PADDING:
529 if ((size_t)RSA_size(prsactx->rsa) < tbslen + 1) {
530 ERR_raise_data(ERR_LIB_PROV, PROV_R_KEY_SIZE_TOO_SMALL,
531 "RSA key size = %d, expected minimum = %d",
532 RSA_size(prsactx->rsa), tbslen + 1);
535 if (!setup_tbuf(prsactx)) {
536 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
539 memcpy(prsactx->tbuf, tbs, tbslen);
540 prsactx->tbuf[tbslen] = RSA_X931_hash_id(prsactx->mdnid);
541 ret = RSA_private_encrypt(tbslen + 1, prsactx->tbuf,
542 sig, prsactx->rsa, RSA_X931_PADDING);
546 case RSA_PKCS1_PADDING:
550 ret = RSA_sign(prsactx->mdnid, tbs, tbslen, sig, &sltmp,
553 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
560 case RSA_PKCS1_PSS_PADDING:
561 /* Check PSS restrictions */
562 if (rsa_pss_restricted(prsactx)) {
563 switch (prsactx->saltlen) {
564 case RSA_PSS_SALTLEN_DIGEST:
565 if (prsactx->min_saltlen > EVP_MD_size(prsactx->md)) {
566 ERR_raise_data(ERR_LIB_PROV,
567 PROV_R_PSS_SALTLEN_TOO_SMALL,
568 "minimum salt length set to %d, "
569 "but the digest only gives %d",
570 prsactx->min_saltlen,
571 EVP_MD_size(prsactx->md));
576 if (prsactx->saltlen >= 0
577 && prsactx->saltlen < prsactx->min_saltlen) {
578 ERR_raise_data(ERR_LIB_PROV,
579 PROV_R_PSS_SALTLEN_TOO_SMALL,
580 "minimum salt length set to %d, but the"
581 "actual salt length is only set to %d",
582 prsactx->min_saltlen,
589 if (!setup_tbuf(prsactx))
591 if (!RSA_padding_add_PKCS1_PSS_mgf1(prsactx->rsa,
593 prsactx->md, prsactx->mgf1_md,
595 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
598 ret = RSA_private_encrypt(RSA_size(prsactx->rsa), prsactx->tbuf,
599 sig, prsactx->rsa, RSA_NO_PADDING);
604 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_PADDING_MODE,
605 "Only X.931, PKCS#1 v1.5 or PSS padding allowed");
609 ret = RSA_private_encrypt(tbslen, tbs, sig, prsactx->rsa,
617 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
625 static int rsa_verify_recover_init(void *vprsactx, void *vrsa)
627 if (!ossl_prov_is_running())
629 return rsa_signverify_init(vprsactx, vrsa, EVP_PKEY_OP_VERIFYRECOVER);
632 static int rsa_verify_recover(void *vprsactx,
636 const unsigned char *sig,
639 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
642 if (!ossl_prov_is_running())
646 *routlen = RSA_size(prsactx->rsa);
650 if (prsactx->md != NULL) {
651 switch (prsactx->pad_mode) {
652 case RSA_X931_PADDING:
653 if (!setup_tbuf(prsactx))
655 ret = RSA_public_decrypt(siglen, sig, prsactx->tbuf, prsactx->rsa,
658 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
662 if (prsactx->tbuf[ret] != RSA_X931_hash_id(prsactx->mdnid)) {
663 ERR_raise(ERR_LIB_PROV, PROV_R_ALGORITHM_MISMATCH);
666 if (ret != EVP_MD_size(prsactx->md)) {
667 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_LENGTH,
668 "Should be %d, but got %d",
669 EVP_MD_size(prsactx->md), ret);
674 if (rout != prsactx->tbuf) {
675 if (routsize < (size_t)ret) {
676 ERR_raise_data(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL,
677 "buffer size is %d, should be %d",
681 memcpy(rout, prsactx->tbuf, ret);
685 case RSA_PKCS1_PADDING:
689 ret = int_rsa_verify(prsactx->mdnid, NULL, 0, rout, &sltmp,
690 sig, siglen, prsactx->rsa);
692 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
700 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_PADDING_MODE,
701 "Only X.931 or PKCS#1 v1.5 padding allowed");
705 ret = RSA_public_decrypt(siglen, sig, rout, prsactx->rsa,
708 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
716 static int rsa_verify_init(void *vprsactx, void *vrsa)
718 if (!ossl_prov_is_running())
720 return rsa_signverify_init(vprsactx, vrsa, EVP_PKEY_OP_VERIFY);
723 static int rsa_verify(void *vprsactx, const unsigned char *sig, size_t siglen,
724 const unsigned char *tbs, size_t tbslen)
726 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
729 if (!ossl_prov_is_running())
731 if (prsactx->md != NULL) {
732 switch (prsactx->pad_mode) {
733 case RSA_PKCS1_PADDING:
734 if (!RSA_verify(prsactx->mdnid, tbs, tbslen, sig, siglen,
736 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
740 case RSA_X931_PADDING:
741 if (!setup_tbuf(prsactx))
743 if (rsa_verify_recover(prsactx, prsactx->tbuf, &rslen, 0,
747 case RSA_PKCS1_PSS_PADDING:
753 * We need to check this for the RSA_verify_PKCS1_PSS_mgf1()
756 mdsize = rsa_get_md_size(prsactx);
757 if (tbslen != mdsize) {
758 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_DIGEST_LENGTH,
759 "Should be %d, but got %d",
764 if (!setup_tbuf(prsactx))
766 ret = RSA_public_decrypt(siglen, sig, prsactx->tbuf,
767 prsactx->rsa, RSA_NO_PADDING);
769 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
772 ret = RSA_verify_PKCS1_PSS_mgf1(prsactx->rsa, tbs,
773 prsactx->md, prsactx->mgf1_md,
777 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
783 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_PADDING_MODE,
784 "Only X.931, PKCS#1 v1.5 or PSS padding allowed");
788 if (!setup_tbuf(prsactx))
790 rslen = RSA_public_decrypt(siglen, sig, prsactx->tbuf, prsactx->rsa,
793 ERR_raise(ERR_LIB_PROV, ERR_LIB_RSA);
798 if ((rslen != tbslen) || memcmp(tbs, prsactx->tbuf, rslen))
804 static int rsa_digest_signverify_init(void *vprsactx, const char *mdname,
805 void *vrsa, int operation)
807 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
809 if (!ossl_prov_is_running())
813 prsactx->flag_allow_md = 0;
814 if (!rsa_signverify_init(vprsactx, vrsa, operation))
817 /* was rsa_setup_md already called in rsa_signverify_init()? */
818 && (mdname[0] == '\0' || strcasecmp(prsactx->mdname, mdname) != 0)
819 && !rsa_setup_md(prsactx, mdname, prsactx->propq))
822 prsactx->mdctx = EVP_MD_CTX_new();
823 if (prsactx->mdctx == NULL) {
824 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
828 if (!EVP_DigestInit_ex(prsactx->mdctx, prsactx->md, NULL))
834 EVP_MD_CTX_free(prsactx->mdctx);
835 EVP_MD_free(prsactx->md);
836 prsactx->mdctx = NULL;
841 static int rsa_digest_signverify_update(void *vprsactx,
842 const unsigned char *data,
845 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
847 if (prsactx == NULL || prsactx->mdctx == NULL)
850 return EVP_DigestUpdate(prsactx->mdctx, data, datalen);
853 static int rsa_digest_sign_init(void *vprsactx, const char *mdname,
856 if (!ossl_prov_is_running())
858 return rsa_digest_signverify_init(vprsactx, mdname, vrsa,
862 static int rsa_digest_sign_final(void *vprsactx, unsigned char *sig,
863 size_t *siglen, size_t sigsize)
865 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
866 unsigned char digest[EVP_MAX_MD_SIZE];
867 unsigned int dlen = 0;
869 if (!ossl_prov_is_running() || prsactx == NULL)
871 prsactx->flag_allow_md = 1;
872 if (prsactx->mdctx == NULL)
875 * If sig is NULL then we're just finding out the sig size. Other fields
876 * are ignored. Defer to rsa_sign.
880 * The digests used here are all known (see rsa_get_md_nid()), so they
881 * should not exceed the internal buffer size of EVP_MAX_MD_SIZE.
883 if (!EVP_DigestFinal_ex(prsactx->mdctx, digest, &dlen))
887 return rsa_sign(vprsactx, sig, siglen, sigsize, digest, (size_t)dlen);
890 static int rsa_digest_verify_init(void *vprsactx, const char *mdname,
893 if (!ossl_prov_is_running())
895 return rsa_digest_signverify_init(vprsactx, mdname, vrsa,
899 int rsa_digest_verify_final(void *vprsactx, const unsigned char *sig,
902 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
903 unsigned char digest[EVP_MAX_MD_SIZE];
904 unsigned int dlen = 0;
906 if (!ossl_prov_is_running())
911 prsactx->flag_allow_md = 1;
912 if (prsactx->mdctx == NULL)
916 * The digests used here are all known (see rsa_get_md_nid()), so they
917 * should not exceed the internal buffer size of EVP_MAX_MD_SIZE.
919 if (!EVP_DigestFinal_ex(prsactx->mdctx, digest, &dlen))
922 return rsa_verify(vprsactx, sig, siglen, digest, (size_t)dlen);
925 static void rsa_freectx(void *vprsactx)
927 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
932 EVP_MD_CTX_free(prsactx->mdctx);
933 EVP_MD_free(prsactx->md);
934 EVP_MD_free(prsactx->mgf1_md);
935 OPENSSL_free(prsactx->propq);
937 RSA_free(prsactx->rsa);
939 OPENSSL_clear_free(prsactx, sizeof(*prsactx));
942 static void *rsa_dupctx(void *vprsactx)
944 PROV_RSA_CTX *srcctx = (PROV_RSA_CTX *)vprsactx;
945 PROV_RSA_CTX *dstctx;
947 if (!ossl_prov_is_running())
950 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
951 if (dstctx == NULL) {
952 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
959 dstctx->mdctx = NULL;
961 dstctx->propq = NULL;
963 if (srcctx->rsa != NULL && !RSA_up_ref(srcctx->rsa))
965 dstctx->rsa = srcctx->rsa;
967 if (srcctx->md != NULL && !EVP_MD_up_ref(srcctx->md))
969 dstctx->md = srcctx->md;
971 if (srcctx->mgf1_md != NULL && !EVP_MD_up_ref(srcctx->mgf1_md))
973 dstctx->mgf1_md = srcctx->mgf1_md;
975 if (srcctx->mdctx != NULL) {
976 dstctx->mdctx = EVP_MD_CTX_new();
977 if (dstctx->mdctx == NULL
978 || !EVP_MD_CTX_copy_ex(dstctx->mdctx, srcctx->mdctx))
982 if (srcctx->propq != NULL) {
983 dstctx->propq = OPENSSL_strdup(srcctx->propq);
984 if (dstctx->propq == NULL)
994 static int rsa_get_ctx_params(void *vprsactx, OSSL_PARAM *params)
996 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
999 if (prsactx == NULL || params == NULL)
1002 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_ALGORITHM_ID);
1004 /* The Algorithm Identifier of the combined signature algorithm */
1005 unsigned char aid_buf[128];
1009 aid = rsa_generate_signature_aid(prsactx, aid_buf,
1010 sizeof(aid_buf), &aid_len);
1011 if (aid == NULL || !OSSL_PARAM_set_octet_string(p, aid, aid_len))
1015 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_PAD_MODE);
1017 switch (p->data_type) {
1018 case OSSL_PARAM_INTEGER:
1019 if (!OSSL_PARAM_set_int(p, prsactx->pad_mode))
1022 case OSSL_PARAM_UTF8_STRING:
1025 const char *word = NULL;
1027 for (i = 0; padding_item[i].id != 0; i++) {
1028 if (prsactx->pad_mode == (int)padding_item[i].id) {
1029 word = padding_item[i].ptr;
1035 if (!OSSL_PARAM_set_utf8_string(p, word))
1038 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
1046 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_DIGEST);
1047 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->mdname))
1050 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_MGF1_DIGEST);
1051 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->mgf1_mdname))
1054 p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_PSS_SALTLEN);
1056 if (p->data_type == OSSL_PARAM_INTEGER) {
1057 if (!OSSL_PARAM_set_int(p, prsactx->saltlen))
1059 } else if (p->data_type == OSSL_PARAM_UTF8_STRING) {
1060 const char *value = NULL;
1062 switch (prsactx->saltlen) {
1063 case RSA_PSS_SALTLEN_DIGEST:
1064 value = OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST;
1066 case RSA_PSS_SALTLEN_MAX:
1067 value = OSSL_PKEY_RSA_PSS_SALT_LEN_MAX;
1069 case RSA_PSS_SALTLEN_AUTO:
1070 value = OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO;
1074 int len = BIO_snprintf(p->data, p->data_size, "%d",
1079 p->return_size = len;
1084 && !OSSL_PARAM_set_utf8_string(p, value))
1092 static const OSSL_PARAM known_gettable_ctx_params[] = {
1093 OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID, NULL, 0),
1094 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PAD_MODE, NULL, 0),
1095 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
1096 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_MGF1_DIGEST, NULL, 0),
1097 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PSS_SALTLEN, NULL, 0),
1101 static const OSSL_PARAM *rsa_gettable_ctx_params(ossl_unused void *vctx)
1103 return known_gettable_ctx_params;
1106 static int rsa_set_ctx_params(void *vprsactx, const OSSL_PARAM params[])
1108 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
1109 const OSSL_PARAM *p;
1110 int pad_mode = prsactx->pad_mode;
1111 int saltlen = prsactx->saltlen;
1112 char mdname[OSSL_MAX_NAME_SIZE] = "", *pmdname = NULL;
1113 char mdprops[OSSL_MAX_PROPQUERY_SIZE] = "", *pmdprops = NULL;
1114 char mgf1mdname[OSSL_MAX_NAME_SIZE] = "", *pmgf1mdname = NULL;
1115 char mgf1mdprops[OSSL_MAX_PROPQUERY_SIZE] = "", *pmgf1mdprops = NULL;
1117 if (prsactx == NULL || params == NULL)
1120 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_DIGEST);
1121 /* Not allowed during certain operations */
1122 if (p != NULL && !prsactx->flag_allow_md)
1125 const OSSL_PARAM *propsp =
1126 OSSL_PARAM_locate_const(params,
1127 OSSL_SIGNATURE_PARAM_PROPERTIES);
1130 if (!OSSL_PARAM_get_utf8_string(p, &pmdname, sizeof(mdname)))
1133 if (propsp != NULL) {
1135 if (!OSSL_PARAM_get_utf8_string(propsp,
1136 &pmdprops, sizeof(mdprops)))
1141 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_PAD_MODE);
1143 const char *err_extra_text = NULL;
1145 switch (p->data_type) {
1146 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
1147 if (!OSSL_PARAM_get_int(p, &pad_mode))
1150 case OSSL_PARAM_UTF8_STRING:
1154 if (p->data == NULL)
1157 for (i = 0; padding_item[i].id != 0; i++) {
1158 if (strcmp(p->data, padding_item[i].ptr) == 0) {
1159 pad_mode = padding_item[i].id;
1170 case RSA_PKCS1_OAEP_PADDING:
1172 * OAEP padding is for asymmetric cipher only so is not compatible
1173 * with signature use.
1175 err_extra_text = "OAEP padding not allowed for signing / verifying";
1177 case RSA_PKCS1_PSS_PADDING:
1178 if ((prsactx->operation
1179 & (EVP_PKEY_OP_SIGN | EVP_PKEY_OP_VERIFY)) == 0) {
1181 "PSS padding only allowed for sign and verify operations";
1185 case RSA_PKCS1_PADDING:
1186 err_extra_text = "PKCS#1 padding not allowed with RSA-PSS";
1188 case RSA_SSLV23_PADDING:
1189 err_extra_text = "SSLv3 padding not allowed with RSA-PSS";
1191 case RSA_NO_PADDING:
1192 err_extra_text = "No padding not allowed with RSA-PSS";
1194 case RSA_X931_PADDING:
1195 err_extra_text = "X.931 padding not allowed with RSA-PSS";
1197 if (RSA_test_flags(prsactx->rsa,
1198 RSA_FLAG_TYPE_MASK) == RSA_FLAG_TYPE_RSA)
1203 if (err_extra_text == NULL)
1204 ERR_raise(ERR_LIB_PROV,
1205 PROV_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE);
1207 ERR_raise_data(ERR_LIB_PROV,
1208 PROV_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE,
1214 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_PSS_SALTLEN);
1216 if (pad_mode != RSA_PKCS1_PSS_PADDING) {
1217 ERR_raise_data(ERR_LIB_PROV, PROV_R_NOT_SUPPORTED,
1218 "PSS saltlen can only be specified if "
1219 "PSS padding has been specified first");
1223 switch (p->data_type) {
1224 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
1225 if (!OSSL_PARAM_get_int(p, &saltlen))
1228 case OSSL_PARAM_UTF8_STRING:
1229 if (strcmp(p->data, OSSL_PKEY_RSA_PSS_SALT_LEN_DIGEST) == 0)
1230 saltlen = RSA_PSS_SALTLEN_DIGEST;
1231 else if (strcmp(p->data, OSSL_PKEY_RSA_PSS_SALT_LEN_MAX) == 0)
1232 saltlen = RSA_PSS_SALTLEN_MAX;
1233 else if (strcmp(p->data, OSSL_PKEY_RSA_PSS_SALT_LEN_AUTO) == 0)
1234 saltlen = RSA_PSS_SALTLEN_AUTO;
1236 saltlen = atoi(p->data);
1243 * RSA_PSS_SALTLEN_MAX seems curiously named in this check.
1244 * Contrary to what it's name suggests, it's the currently
1245 * lowest saltlen number possible.
1247 if (saltlen < RSA_PSS_SALTLEN_MAX) {
1248 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH);
1252 if (rsa_pss_restricted(prsactx)) {
1254 case RSA_PSS_SALTLEN_AUTO:
1255 if (prsactx->operation == EVP_PKEY_OP_VERIFY) {
1256 ERR_raise_data(ERR_LIB_PROV, PROV_R_INVALID_SALT_LENGTH,
1257 "Cannot use autodetected salt length");
1261 case RSA_PSS_SALTLEN_DIGEST:
1262 if (prsactx->min_saltlen > EVP_MD_size(prsactx->md)) {
1263 ERR_raise_data(ERR_LIB_PROV,
1264 PROV_R_PSS_SALTLEN_TOO_SMALL,
1265 "Should be more than %d, but would be "
1266 "set to match digest size (%d)",
1267 prsactx->min_saltlen,
1268 EVP_MD_size(prsactx->md));
1273 if (saltlen >= 0 && saltlen < prsactx->min_saltlen) {
1274 ERR_raise_data(ERR_LIB_PROV,
1275 PROV_R_PSS_SALTLEN_TOO_SMALL,
1276 "Should be more than %d, "
1277 "but would be set to %d",
1278 prsactx->min_saltlen, saltlen);
1285 p = OSSL_PARAM_locate_const(params, OSSL_SIGNATURE_PARAM_MGF1_DIGEST);
1287 const OSSL_PARAM *propsp =
1288 OSSL_PARAM_locate_const(params,
1289 OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES);
1291 pmgf1mdname = mgf1mdname;
1292 if (!OSSL_PARAM_get_utf8_string(p, &pmgf1mdname, sizeof(mgf1mdname)))
1295 if (propsp != NULL) {
1296 pmgf1mdprops = mgf1mdprops;
1297 if (!OSSL_PARAM_get_utf8_string(propsp,
1298 &pmgf1mdprops, sizeof(mgf1mdprops)))
1302 if (pad_mode != RSA_PKCS1_PSS_PADDING) {
1303 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MGF1_MD);
1308 prsactx->saltlen = saltlen;
1309 prsactx->pad_mode = pad_mode;
1311 if (prsactx->md == NULL && pmdname == NULL
1312 && pad_mode == RSA_PKCS1_PSS_PADDING)
1313 pmdname = RSA_DEFAULT_DIGEST_NAME;
1315 if (pmgf1mdname != NULL
1316 && !rsa_setup_mgf1_md(prsactx, pmgf1mdname, pmgf1mdprops))
1319 if (pmdname != NULL) {
1320 if (!rsa_setup_md(prsactx, pmdname, pmdprops))
1323 if (!rsa_check_padding(prsactx, NULL, NULL, prsactx->mdnid))
1329 static const OSSL_PARAM known_settable_ctx_params[] = {
1330 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PAD_MODE, NULL, 0),
1331 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_DIGEST, NULL, 0),
1332 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PROPERTIES, NULL, 0),
1333 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_MGF1_DIGEST, NULL, 0),
1334 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_MGF1_PROPERTIES, NULL, 0),
1335 OSSL_PARAM_utf8_string(OSSL_SIGNATURE_PARAM_PSS_SALTLEN, NULL, 0),
1339 static const OSSL_PARAM *rsa_settable_ctx_params(ossl_unused void *provctx)
1342 * TODO(3.0): Should this function return a different set of settable ctx
1343 * params if the ctx is being used for a DigestSign/DigestVerify? In that
1344 * case it is not allowed to set the digest size/digest name because the
1345 * digest is explicitly set as part of the init.
1347 return known_settable_ctx_params;
1350 static int rsa_get_ctx_md_params(void *vprsactx, OSSL_PARAM *params)
1352 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
1354 if (prsactx->mdctx == NULL)
1357 return EVP_MD_CTX_get_params(prsactx->mdctx, params);
1360 static const OSSL_PARAM *rsa_gettable_ctx_md_params(void *vprsactx)
1362 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
1364 if (prsactx->md == NULL)
1367 return EVP_MD_gettable_ctx_params(prsactx->md);
1370 static int rsa_set_ctx_md_params(void *vprsactx, const OSSL_PARAM params[])
1372 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
1374 if (prsactx->mdctx == NULL)
1377 return EVP_MD_CTX_set_params(prsactx->mdctx, params);
1380 static const OSSL_PARAM *rsa_settable_ctx_md_params(void *vprsactx)
1382 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
1384 if (prsactx->md == NULL)
1387 return EVP_MD_settable_ctx_params(prsactx->md);
1390 const OSSL_DISPATCH ossl_rsa_signature_functions[] = {
1391 { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))rsa_newctx },
1392 { OSSL_FUNC_SIGNATURE_SIGN_INIT, (void (*)(void))rsa_sign_init },
1393 { OSSL_FUNC_SIGNATURE_SIGN, (void (*)(void))rsa_sign },
1394 { OSSL_FUNC_SIGNATURE_VERIFY_INIT, (void (*)(void))rsa_verify_init },
1395 { OSSL_FUNC_SIGNATURE_VERIFY, (void (*)(void))rsa_verify },
1396 { OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT,
1397 (void (*)(void))rsa_verify_recover_init },
1398 { OSSL_FUNC_SIGNATURE_VERIFY_RECOVER,
1399 (void (*)(void))rsa_verify_recover },
1400 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
1401 (void (*)(void))rsa_digest_sign_init },
1402 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE,
1403 (void (*)(void))rsa_digest_signverify_update },
1404 { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL,
1405 (void (*)(void))rsa_digest_sign_final },
1406 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
1407 (void (*)(void))rsa_digest_verify_init },
1408 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE,
1409 (void (*)(void))rsa_digest_signverify_update },
1410 { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL,
1411 (void (*)(void))rsa_digest_verify_final },
1412 { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))rsa_freectx },
1413 { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))rsa_dupctx },
1414 { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))rsa_get_ctx_params },
1415 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
1416 (void (*)(void))rsa_gettable_ctx_params },
1417 { OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS, (void (*)(void))rsa_set_ctx_params },
1418 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS,
1419 (void (*)(void))rsa_settable_ctx_params },
1420 { OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS,
1421 (void (*)(void))rsa_get_ctx_md_params },
1422 { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS,
1423 (void (*)(void))rsa_gettable_ctx_md_params },
1424 { OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS,
1425 (void (*)(void))rsa_set_ctx_md_params },
1426 { OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMS,
1427 (void (*)(void))rsa_settable_ctx_md_params },