2 * Copyright 1995-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 <openssl/crypto.h>
18 #include <openssl/core_names.h>
19 #include <openssl/engine.h>
20 #include <openssl/evp.h>
21 #include "internal/cryptlib.h"
22 #include "internal/refcount.h"
23 #include "openssl/param_build.h"
24 #include "crypto/bn.h"
25 #include "crypto/evp.h"
26 #include "crypto/rsa.h"
27 #include "crypto/security_bits.h"
28 #include "rsa_local.h"
30 static RSA *rsa_new_intern(ENGINE *engine, OPENSSL_CTX *libctx);
35 return rsa_new_intern(NULL, NULL);
38 const RSA_METHOD *RSA_get_method(const RSA *rsa)
43 int RSA_set_method(RSA *rsa, const RSA_METHOD *meth)
46 * NB: The caller is specifically setting a method, so it's not up to us
47 * to deal with which ENGINE it comes from.
49 const RSA_METHOD *mtmp;
53 #ifndef OPENSSL_NO_ENGINE
54 ENGINE_finish(rsa->engine);
63 RSA *RSA_new_method(ENGINE *engine)
65 return rsa_new_intern(engine, NULL);
69 RSA *rsa_new_with_ctx(OPENSSL_CTX *libctx)
71 return rsa_new_intern(NULL, libctx);
74 static RSA *rsa_new_intern(ENGINE *engine, OPENSSL_CTX *libctx)
76 RSA *ret = OPENSSL_zalloc(sizeof(*ret));
79 RSAerr(0, ERR_R_MALLOC_FAILURE);
84 ret->lock = CRYPTO_THREAD_lock_new();
85 if (ret->lock == NULL) {
86 RSAerr(0, ERR_R_MALLOC_FAILURE);
92 ret->meth = RSA_get_default_method();
93 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
94 ret->flags = ret->meth->flags & ~RSA_FLAG_NON_FIPS_ALLOW;
96 if (!ENGINE_init(engine)) {
97 RSAerr(0, ERR_R_ENGINE_LIB);
100 ret->engine = engine;
102 ret->engine = ENGINE_get_default_RSA();
105 ret->meth = ENGINE_get_RSA(ret->engine);
106 if (ret->meth == NULL) {
107 RSAerr(0, ERR_R_ENGINE_LIB);
113 ret->flags = ret->meth->flags & ~RSA_FLAG_NON_FIPS_ALLOW;
115 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_RSA, ret, &ret->ex_data)) {
120 if ((ret->meth->init != NULL) && !ret->meth->init(ret)) {
121 RSAerr(0, ERR_R_INIT_FAIL);
132 void RSA_free(RSA *r)
139 CRYPTO_DOWN_REF(&r->references, &i, r->lock);
140 REF_PRINT_COUNT("RSA", r);
143 REF_ASSERT_ISNT(i < 0);
145 if (r->meth != NULL && r->meth->finish != NULL)
147 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
148 ENGINE_finish(r->engine);
152 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA, r, &r->ex_data);
155 CRYPTO_THREAD_lock_free(r->lock);
162 BN_clear_free(r->dmp1);
163 BN_clear_free(r->dmq1);
164 BN_clear_free(r->iqmp);
166 RSA_PSS_PARAMS_free(r->pss);
167 sk_RSA_PRIME_INFO_pop_free(r->prime_infos, rsa_multip_info_free);
169 BN_BLINDING_free(r->blinding);
170 BN_BLINDING_free(r->mt_blinding);
171 OPENSSL_free(r->bignum_data);
175 int RSA_up_ref(RSA *r)
179 if (CRYPTO_UP_REF(&r->references, &i, r->lock) <= 0)
182 REF_PRINT_COUNT("RSA", r);
183 REF_ASSERT_ISNT(i < 2);
184 return i > 1 ? 1 : 0;
188 int RSA_set_ex_data(RSA *r, int idx, void *arg)
190 return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
193 void *RSA_get_ex_data(const RSA *r, int idx)
195 return CRYPTO_get_ex_data(&r->ex_data, idx);
200 * Define a scaling constant for our fixed point arithmetic.
201 * This value must be a power of two because the base two logarithm code
202 * makes this assumption. The exponent must also be a multiple of three so
203 * that the scale factor has an exact cube root. Finally, the scale factor
204 * should not be so large that a multiplication of two scaled numbers
205 * overflows a 64 bit unsigned integer.
207 static const unsigned int scale = 1 << 18;
208 static const unsigned int cbrt_scale = 1 << (2 * 18 / 3);
210 /* Define some constants, none exceed 32 bits */
211 static const unsigned int log_2 = 0x02c5c8; /* scale * log(2) */
212 static const unsigned int log_e = 0x05c551; /* scale * log2(M_E) */
213 static const unsigned int c1_923 = 0x07b126; /* scale * 1.923 */
214 static const unsigned int c4_690 = 0x12c28f; /* scale * 4.690 */
217 * Multiply two scaled integers together and rescale the result.
219 static ossl_inline uint64_t mul2(uint64_t a, uint64_t b)
221 return a * b / scale;
225 * Calculate the cube root of a 64 bit scaled integer.
226 * Although the cube root of a 64 bit number does fit into a 32 bit unsigned
227 * integer, this is not guaranteed after scaling, so this function has a
228 * 64 bit return. This uses the shifting nth root algorithm with some
229 * algebraic simplifications.
231 static uint64_t icbrt64(uint64_t x)
237 for (s = 63; s >= 0; s -= 3) {
239 b = 3 * r * (r + 1) + 1;
245 return r * cbrt_scale;
249 * Calculate the natural logarithm of a 64 bit scaled integer.
250 * This is done by calculating a base two logarithm and scaling.
251 * The maximum logarithm (base 2) is 64 and this reduces base e, so
252 * a 32 bit result should not overflow. The argument passed must be
253 * greater than unity so we don't need to handle negative results.
255 static uint32_t ilog_e(uint64_t v)
260 * Scale down the value into the range 1 .. 2.
262 * If fractional numbers need to be processed, another loop needs
263 * to go here that checks v < scale and if so multiplies it by 2 and
264 * reduces r by scale. This also means making r signed.
266 while (v >= 2 * scale) {
270 for (i = scale / 2; i != 0; i /= 2) {
272 if (v >= 2 * scale) {
277 r = (r * (uint64_t)scale) / log_e;
282 * NIST SP 800-56B rev 2 Appendix D: Maximum Security Strength Estimates for IFC
285 * Note that this formula is also referred to in SP800-56A rev3 Appendix D:
286 * for FFC safe prime groups for modp and ffdhe.
287 * After Table 25 and Table 26 it refers to
288 * "The maximum security strength estimates were calculated using the formula in
289 * Section 7.5 of the FIPS 140 IG and rounded to the nearest multiple of eight
294 * E = \frac{1.923 \sqrt[3]{nBits \cdot log_e(2)}
295 * \cdot(log_e(nBits \cdot log_e(2))^{2/3} - 4.69}{log_e(2)}
296 * The two cube roots are merged together here.
298 uint16_t ifc_ffc_compute_security_bits(int n)
304 /* Look for common values as listed in SP 800-56B rev 2 Appendix D */
318 * The first incorrect result (i.e. not accurate or off by one low) occurs
319 * for n = 699668. The true value here is 1200. Instead of using this n
320 * as the check threshold, the smallest n such that the correct result is
321 * 1200 is used instead.
328 x = n * (uint64_t)log_2;
330 y = (uint16_t)((mul2(c1_923, icbrt64(mul2(mul2(x, lx), lx))) - c4_690)
337 int RSA_security_bits(const RSA *rsa)
339 int bits = BN_num_bits(rsa->n);
342 if (rsa->version == RSA_ASN1_VERSION_MULTI) {
343 /* This ought to mean that we have private key at hand. */
344 int ex_primes = sk_RSA_PRIME_INFO_num(rsa->prime_infos);
346 if (ex_primes <= 0 || (ex_primes + 2) > rsa_multip_cap(bits))
350 return ifc_ffc_compute_security_bits(bits);
353 int RSA_set0_key(RSA *r, BIGNUM *n, BIGNUM *e, BIGNUM *d)
355 /* If the fields n and e in r are NULL, the corresponding input
356 * parameters MUST be non-NULL for n and e. d may be
357 * left NULL (in case only the public key is used).
359 if ((r->n == NULL && n == NULL)
360 || (r->e == NULL && e == NULL))
374 BN_set_flags(r->d, BN_FLG_CONSTTIME);
381 int RSA_set0_factors(RSA *r, BIGNUM *p, BIGNUM *q)
383 /* If the fields p and q in r are NULL, the corresponding input
384 * parameters MUST be non-NULL.
386 if ((r->p == NULL && p == NULL)
387 || (r->q == NULL && q == NULL))
393 BN_set_flags(r->p, BN_FLG_CONSTTIME);
398 BN_set_flags(r->q, BN_FLG_CONSTTIME);
405 int RSA_set0_crt_params(RSA *r, BIGNUM *dmp1, BIGNUM *dmq1, BIGNUM *iqmp)
407 /* If the fields dmp1, dmq1 and iqmp in r are NULL, the corresponding input
408 * parameters MUST be non-NULL.
410 if ((r->dmp1 == NULL && dmp1 == NULL)
411 || (r->dmq1 == NULL && dmq1 == NULL)
412 || (r->iqmp == NULL && iqmp == NULL))
416 BN_clear_free(r->dmp1);
418 BN_set_flags(r->dmp1, BN_FLG_CONSTTIME);
421 BN_clear_free(r->dmq1);
423 BN_set_flags(r->dmq1, BN_FLG_CONSTTIME);
426 BN_clear_free(r->iqmp);
428 BN_set_flags(r->iqmp, BN_FLG_CONSTTIME);
437 * Is it better to export RSA_PRIME_INFO structure
438 * and related functions to let user pass a triplet?
440 int RSA_set0_multi_prime_params(RSA *r, BIGNUM *primes[], BIGNUM *exps[],
441 BIGNUM *coeffs[], int pnum)
443 STACK_OF(RSA_PRIME_INFO) *prime_infos, *old = NULL;
444 RSA_PRIME_INFO *pinfo;
447 if (primes == NULL || exps == NULL || coeffs == NULL || pnum == 0)
450 prime_infos = sk_RSA_PRIME_INFO_new_reserve(NULL, pnum);
451 if (prime_infos == NULL)
454 if (r->prime_infos != NULL)
455 old = r->prime_infos;
457 for (i = 0; i < pnum; i++) {
458 pinfo = rsa_multip_info_new();
461 if (primes[i] != NULL && exps[i] != NULL && coeffs[i] != NULL) {
462 BN_clear_free(pinfo->r);
463 BN_clear_free(pinfo->d);
464 BN_clear_free(pinfo->t);
465 pinfo->r = primes[i];
467 pinfo->t = coeffs[i];
468 BN_set_flags(pinfo->r, BN_FLG_CONSTTIME);
469 BN_set_flags(pinfo->d, BN_FLG_CONSTTIME);
470 BN_set_flags(pinfo->t, BN_FLG_CONSTTIME);
472 rsa_multip_info_free(pinfo);
475 (void)sk_RSA_PRIME_INFO_push(prime_infos, pinfo);
478 r->prime_infos = prime_infos;
480 if (!rsa_multip_calc_product(r)) {
481 r->prime_infos = old;
487 * This is hard to deal with, since the old infos could
488 * also be set by this function and r, d, t should not
489 * be freed in that case. So currently, stay consistent
490 * with other *set0* functions: just free it...
492 sk_RSA_PRIME_INFO_pop_free(old, rsa_multip_info_free);
495 r->version = RSA_ASN1_VERSION_MULTI;
500 /* r, d, t should not be freed */
501 sk_RSA_PRIME_INFO_pop_free(prime_infos, rsa_multip_info_free_ex);
506 void RSA_get0_key(const RSA *r,
507 const BIGNUM **n, const BIGNUM **e, const BIGNUM **d)
517 void RSA_get0_factors(const RSA *r, const BIGNUM **p, const BIGNUM **q)
526 int RSA_get_multi_prime_extra_count(const RSA *r)
530 pnum = sk_RSA_PRIME_INFO_num(r->prime_infos);
536 int RSA_get0_multi_prime_factors(const RSA *r, const BIGNUM *primes[])
539 RSA_PRIME_INFO *pinfo;
541 if ((pnum = RSA_get_multi_prime_extra_count(r)) == 0)
545 * return other primes
546 * it's caller's responsibility to allocate oth_primes[pnum]
548 for (i = 0; i < pnum; i++) {
549 pinfo = sk_RSA_PRIME_INFO_value(r->prime_infos, i);
550 primes[i] = pinfo->r;
557 void RSA_get0_crt_params(const RSA *r,
558 const BIGNUM **dmp1, const BIGNUM **dmq1,
570 int RSA_get0_multi_prime_crt_params(const RSA *r, const BIGNUM *exps[],
571 const BIGNUM *coeffs[])
575 if ((pnum = RSA_get_multi_prime_extra_count(r)) == 0)
578 /* return other primes */
579 if (exps != NULL || coeffs != NULL) {
580 RSA_PRIME_INFO *pinfo;
583 /* it's the user's job to guarantee the buffer length */
584 for (i = 0; i < pnum; i++) {
585 pinfo = sk_RSA_PRIME_INFO_value(r->prime_infos, i);
589 coeffs[i] = pinfo->t;
597 const BIGNUM *RSA_get0_n(const RSA *r)
602 const BIGNUM *RSA_get0_e(const RSA *r)
607 const BIGNUM *RSA_get0_d(const RSA *r)
612 const BIGNUM *RSA_get0_p(const RSA *r)
617 const BIGNUM *RSA_get0_q(const RSA *r)
622 const BIGNUM *RSA_get0_dmp1(const RSA *r)
627 const BIGNUM *RSA_get0_dmq1(const RSA *r)
632 const BIGNUM *RSA_get0_iqmp(const RSA *r)
637 const RSA_PSS_PARAMS *RSA_get0_pss_params(const RSA *r)
647 RSA_PSS_PARAMS_30 *rsa_get0_pss_params_30(RSA *r)
649 return &r->pss_params;
652 void RSA_clear_flags(RSA *r, int flags)
657 int RSA_test_flags(const RSA *r, int flags)
659 return r->flags & flags;
662 void RSA_set_flags(RSA *r, int flags)
667 int RSA_get_version(RSA *r)
669 /* { two-prime(0), multi(1) } */
674 ENGINE *RSA_get0_engine(const RSA *r)
679 int RSA_pkey_ctx_ctrl(EVP_PKEY_CTX *ctx, int optype, int cmd, int p1, void *p2)
681 /* If key type not RSA or RSA-PSS return error */
682 if (ctx != NULL && ctx->pmeth != NULL
683 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
684 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
686 return EVP_PKEY_CTX_ctrl(ctx, -1, optype, cmd, p1, p2);
690 DEFINE_STACK_OF(BIGNUM)
692 int rsa_set0_all_params(RSA *r, const STACK_OF(BIGNUM) *primes,
693 const STACK_OF(BIGNUM) *exps,
694 const STACK_OF(BIGNUM) *coeffs)
697 STACK_OF(RSA_PRIME_INFO) *prime_infos, *old_infos = NULL;
701 if (primes == NULL || exps == NULL || coeffs == NULL)
704 pnum = sk_BIGNUM_num(primes);
706 || pnum != sk_BIGNUM_num(exps)
707 || pnum != sk_BIGNUM_num(coeffs) + 1)
710 if (!RSA_set0_factors(r, sk_BIGNUM_value(primes, 0),
711 sk_BIGNUM_value(primes, 1))
712 || !RSA_set0_crt_params(r, sk_BIGNUM_value(exps, 0),
713 sk_BIGNUM_value(exps, 1),
714 sk_BIGNUM_value(coeffs, 0)))
718 old_infos = r->prime_infos;
725 prime_infos = sk_RSA_PRIME_INFO_new_reserve(NULL, pnum);
726 if (prime_infos == NULL)
729 for (i = 2; i < pnum; i++) {
730 BIGNUM *prime = sk_BIGNUM_value(primes, i);
731 BIGNUM *exp = sk_BIGNUM_value(exps, i);
732 BIGNUM *coeff = sk_BIGNUM_value(coeffs, i - 1);
733 RSA_PRIME_INFO *pinfo = NULL;
735 if (!ossl_assert(prime != NULL && exp != NULL && coeff != NULL))
738 /* Using rsa_multip_info_new() is wasteful, so allocate directly */
739 if ((pinfo = OPENSSL_zalloc(sizeof(*pinfo))) == NULL) {
740 ERR_raise(ERR_LIB_RSA, ERR_R_MALLOC_FAILURE);
747 BN_set_flags(pinfo->r, BN_FLG_CONSTTIME);
748 BN_set_flags(pinfo->d, BN_FLG_CONSTTIME);
749 BN_set_flags(pinfo->t, BN_FLG_CONSTTIME);
750 (void)sk_RSA_PRIME_INFO_push(prime_infos, pinfo);
753 r->prime_infos = prime_infos;
755 if (!rsa_multip_calc_product(r)) {
756 r->prime_infos = old_infos;
765 if (old_infos != NULL) {
767 * This is hard to deal with, since the old infos could
768 * also be set by this function and r, d, t should not
769 * be freed in that case. So currently, stay consistent
770 * with other *set0* functions: just free it...
772 sk_RSA_PRIME_INFO_pop_free(old_infos, rsa_multip_info_free);
776 r->version = pnum > 2 ? RSA_ASN1_VERSION_MULTI : RSA_ASN1_VERSION_DEFAULT;
782 /* r, d, t should not be freed */
783 sk_RSA_PRIME_INFO_pop_free(prime_infos, rsa_multip_info_free_ex);
788 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
790 int rsa_get0_all_params(RSA *r, STACK_OF(BIGNUM_const) *primes,
791 STACK_OF(BIGNUM_const) *exps,
792 STACK_OF(BIGNUM_const) *coeffs)
795 RSA_PRIME_INFO *pinfo;
802 /* If |p| is NULL, there are no CRT parameters */
803 if (RSA_get0_p(r) == NULL)
806 sk_BIGNUM_const_push(primes, RSA_get0_p(r));
807 sk_BIGNUM_const_push(primes, RSA_get0_q(r));
808 sk_BIGNUM_const_push(exps, RSA_get0_dmp1(r));
809 sk_BIGNUM_const_push(exps, RSA_get0_dmq1(r));
810 sk_BIGNUM_const_push(coeffs, RSA_get0_iqmp(r));
813 pnum = RSA_get_multi_prime_extra_count(r);
814 for (i = 0; i < pnum; i++) {
815 pinfo = sk_RSA_PRIME_INFO_value(r->prime_infos, i);
816 sk_BIGNUM_const_push(primes, pinfo->r);
817 sk_BIGNUM_const_push(exps, pinfo->d);
818 sk_BIGNUM_const_push(coeffs, pinfo->t);
826 int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad_mode)
828 OSSL_PARAM pad_params[2], *p = pad_params;
831 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
832 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
836 /* If key type not RSA or RSA-PSS return error */
837 if (ctx->pmeth != NULL
838 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
839 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
842 /* TODO(3.0): Remove this eventually when no more legacy */
843 if ((!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
844 || ctx->op.ciph.ciphprovctx == NULL)
845 && (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
846 || ctx->op.sig.sigprovctx == NULL))
847 return EVP_PKEY_CTX_ctrl(ctx, -1, -1, EVP_PKEY_CTRL_RSA_PADDING,
850 *p++ = OSSL_PARAM_construct_int(OSSL_PKEY_PARAM_PAD_MODE, &pad_mode);
851 *p++ = OSSL_PARAM_construct_end();
853 return EVP_PKEY_CTX_set_params(ctx, pad_params);
856 int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, int *pad_mode)
858 OSSL_PARAM pad_params[2], *p = pad_params;
860 if (ctx == NULL || pad_mode == NULL) {
861 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
862 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
866 /* If key type not RSA or RSA-PSS return error */
867 if (ctx->pmeth != NULL
868 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
869 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
872 /* TODO(3.0): Remove this eventually when no more legacy */
873 if ((!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
874 || ctx->op.ciph.ciphprovctx == NULL)
875 && (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
876 || ctx->op.sig.sigprovctx == NULL))
877 return EVP_PKEY_CTX_ctrl(ctx, -1, -1, EVP_PKEY_CTRL_GET_RSA_PADDING, 0,
880 *p++ = OSSL_PARAM_construct_int(OSSL_PKEY_PARAM_PAD_MODE, pad_mode);
881 *p++ = OSSL_PARAM_construct_end();
883 if (!EVP_PKEY_CTX_get_params(ctx, pad_params))
890 int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
894 if (ctx == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
895 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
896 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
900 /* If key type not RSA return error */
901 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
904 /* TODO(3.0): Remove this eventually when no more legacy */
905 if (ctx->op.ciph.ciphprovctx == NULL)
906 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_CRYPT,
907 EVP_PKEY_CTRL_RSA_OAEP_MD, 0, (void *)md);
909 name = (md == NULL) ? "" : EVP_MD_name(md);
911 return EVP_PKEY_CTX_set_rsa_oaep_md_name(ctx, name, NULL);
914 int EVP_PKEY_CTX_set_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
917 OSSL_PARAM rsa_params[3], *p = rsa_params;
919 if (ctx == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
920 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
921 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
925 /* If key type not RSA return error */
926 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
930 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST,
932 * Cast away the const. This is read
933 * only so should be safe
936 if (mdprops != NULL) {
937 *p++ = OSSL_PARAM_construct_utf8_string(
938 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS,
940 * Cast away the const. This is read
941 * only so should be safe
945 *p++ = OSSL_PARAM_construct_end();
947 return EVP_PKEY_CTX_set_params(ctx, rsa_params);
950 int EVP_PKEY_CTX_get_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, char *name,
953 OSSL_PARAM rsa_params[2], *p = rsa_params;
955 if (ctx == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
956 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
957 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
961 /* If key type not RSA return error */
962 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
965 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST,
967 *p++ = OSSL_PARAM_construct_end();
969 if (!EVP_PKEY_CTX_get_params(ctx, rsa_params))
975 int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
977 /* 80 should be big enough */
980 if (ctx == NULL || md == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
981 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
982 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
986 /* If key type not RSA return error */
987 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
990 /* TODO(3.0): Remove this eventually when no more legacy */
991 if (ctx->op.ciph.ciphprovctx == NULL)
992 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_CRYPT,
993 EVP_PKEY_CTRL_GET_RSA_OAEP_MD, 0, (void *)md);
995 if (EVP_PKEY_CTX_get_rsa_oaep_md_name(ctx, name, sizeof(name)) <= 0)
998 /* May be NULL meaning "unknown" */
999 *md = EVP_get_digestbyname(name);
1004 int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md)
1009 || (!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1010 && !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx))) {
1011 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1012 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1016 /* If key type not RSA return error */
1017 if (ctx->pmeth != NULL
1018 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1019 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1022 /* TODO(3.0): Remove this eventually when no more legacy */
1023 if ((EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1024 && ctx->op.ciph.ciphprovctx == NULL)
1025 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1026 && ctx->op.sig.sigprovctx == NULL))
1027 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA,
1028 EVP_PKEY_OP_TYPE_SIG | EVP_PKEY_OP_TYPE_CRYPT,
1029 EVP_PKEY_CTRL_RSA_MGF1_MD, 0, (void *)md);
1031 name = (md == NULL) ? "" : EVP_MD_name(md);
1033 return EVP_PKEY_CTX_set_rsa_mgf1_md_name(ctx, name, NULL);
1036 int EVP_PKEY_CTX_set_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
1037 const char *mdprops)
1039 OSSL_PARAM rsa_params[3], *p = rsa_params;
1043 || (!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1044 && !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx))) {
1045 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1046 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1050 /* If key type not RSA return error */
1051 if (ctx->pmeth != NULL
1052 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1053 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1056 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_MGF1_DIGEST,
1058 * Cast away the const. This is
1059 * read only so should be safe
1062 if (mdprops != NULL) {
1064 OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_MGF1_PROPERTIES,
1066 * Cast away the const. This is
1067 * read only so should be safe
1069 (char *)mdprops, 0);
1071 *p++ = OSSL_PARAM_construct_end();
1073 return EVP_PKEY_CTX_set_params(ctx, rsa_params);
1076 int EVP_PKEY_CTX_get_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, char *name,
1079 OSSL_PARAM rsa_params[2], *p = rsa_params;
1082 || (!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1083 && !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx))) {
1084 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1085 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1089 /* If key type not RSA or RSA-PSS return error */
1090 if (ctx->pmeth != NULL
1091 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1092 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1095 *p++ = OSSL_PARAM_construct_utf8_string(OSSL_PKEY_PARAM_MGF1_DIGEST,
1097 *p++ = OSSL_PARAM_construct_end();
1099 if (!EVP_PKEY_CTX_get_params(ctx, rsa_params))
1105 int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD **md)
1107 /* 80 should be big enough */
1111 || (!EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1112 && !EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx))) {
1113 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1114 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1118 /* If key type not RSA or RSA-PSS return error */
1119 if (ctx->pmeth != NULL
1120 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1121 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1124 /* TODO(3.0): Remove this eventually when no more legacy */
1125 if ((EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)
1126 && ctx->op.ciph.ciphprovctx == NULL)
1127 || (EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1128 && ctx->op.sig.sigprovctx == NULL))
1129 return EVP_PKEY_CTX_ctrl(ctx, -1,
1130 EVP_PKEY_OP_TYPE_SIG | EVP_PKEY_OP_TYPE_CRYPT,
1131 EVP_PKEY_CTRL_GET_RSA_MGF1_MD, 0, (void *)md);
1133 if (EVP_PKEY_CTX_get_rsa_mgf1_md_name(ctx, name, sizeof(name)) <= 0)
1136 /* May be NULL meaning "unknown" */
1137 *md = EVP_get_digestbyname(name);
1142 int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, void *label, int llen)
1144 OSSL_PARAM rsa_params[2], *p = rsa_params;
1146 if (ctx == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
1147 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1148 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1152 /* If key type not RSA return error */
1153 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
1156 /* TODO(3.0): Remove this eventually when no more legacy */
1157 if (ctx->op.ciph.ciphprovctx == NULL)
1158 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_CRYPT,
1159 EVP_PKEY_CTRL_RSA_OAEP_LABEL, llen,
1162 *p++ = OSSL_PARAM_construct_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL,
1164 * Cast away the const. This is
1165 * read only so should be safe
1169 *p++ = OSSL_PARAM_construct_end();
1171 if (!EVP_PKEY_CTX_set_params(ctx, rsa_params))
1174 OPENSSL_free(label);
1178 int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char **label)
1180 OSSL_PARAM rsa_params[3], *p = rsa_params;
1183 if (ctx == NULL || !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx)) {
1184 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1185 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1189 /* If key type not RSA return error */
1190 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
1193 /* TODO(3.0): Remove this eventually when no more legacy */
1194 if (ctx->op.ciph.ciphprovctx == NULL)
1195 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_CRYPT,
1196 EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL, 0,
1199 *p++ = OSSL_PARAM_construct_octet_ptr(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL,
1201 *p++ = OSSL_PARAM_construct_size_t(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN,
1203 *p++ = OSSL_PARAM_construct_end();
1205 if (!EVP_PKEY_CTX_get_params(ctx, rsa_params))
1208 if (labellen > INT_MAX)
1211 return (int)labellen;
1214 int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int saltlen)
1216 OSSL_PARAM pad_params[2], *p = pad_params;
1219 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1220 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1224 /* If key type not RSA or RSA-PSS return error */
1225 if (ctx->pmeth != NULL
1226 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1227 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1230 /* TODO(3.0): Remove this eventually when no more legacy */
1231 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1232 || ctx->op.sig.sigprovctx == NULL)
1233 return EVP_PKEY_CTX_ctrl(ctx, -1, -1, EVP_PKEY_CTRL_RSA_PSS_SALTLEN,
1237 OSSL_PARAM_construct_int(OSSL_SIGNATURE_PARAM_PSS_SALTLEN, &saltlen);
1238 *p++ = OSSL_PARAM_construct_end();
1240 return EVP_PKEY_CTX_set_params(ctx, pad_params);
1243 int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int *saltlen)
1245 OSSL_PARAM pad_params[2], *p = pad_params;
1247 if (ctx == NULL || saltlen == NULL) {
1248 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1249 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1253 /* If key type not RSA or RSA-PSS return error */
1254 if (ctx->pmeth != NULL
1255 && ctx->pmeth->pkey_id != EVP_PKEY_RSA
1256 && ctx->pmeth->pkey_id != EVP_PKEY_RSA_PSS)
1259 /* TODO(3.0): Remove this eventually when no more legacy */
1260 if (!EVP_PKEY_CTX_IS_SIGNATURE_OP(ctx)
1261 || ctx->op.sig.sigprovctx == NULL)
1262 return EVP_PKEY_CTX_ctrl(ctx, -1, -1,
1263 EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN,
1267 OSSL_PARAM_construct_int(OSSL_SIGNATURE_PARAM_PSS_SALTLEN, saltlen);
1268 *p++ = OSSL_PARAM_construct_end();
1270 if (!EVP_PKEY_CTX_get_params(ctx, pad_params))
1277 int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int bits)
1279 OSSL_PARAM params[2], *p = params;
1280 size_t bits2 = bits;
1282 if (ctx == NULL || !EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
1283 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1284 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1288 /* If key type not RSA return error */
1289 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
1292 /* TODO(3.0): Remove this eventually when no more legacy */
1293 if (ctx->op.keymgmt.genctx == NULL)
1294 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_KEYGEN,
1295 EVP_PKEY_CTRL_RSA_KEYGEN_BITS, bits, NULL);
1297 *p++ = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_BITS, &bits2);
1298 *p++ = OSSL_PARAM_construct_end();
1300 if (!EVP_PKEY_CTX_set_params(ctx, params))
1306 int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp)
1308 OSSL_PARAM_BLD *tmpl;
1312 if (ctx == NULL || !EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
1313 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1314 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1318 /* If key type not RSA return error */
1319 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
1322 /* TODO(3.0): Remove this eventually when no more legacy */
1323 if (ctx->op.keymgmt.genctx == NULL)
1324 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_KEYGEN,
1325 EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, 0, pubexp);
1327 if ((tmpl = OSSL_PARAM_BLD_new()) == NULL)
1329 if (!OSSL_PARAM_BLD_push_BN(tmpl, OSSL_PKEY_PARAM_RSA_E, pubexp)
1330 || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
1331 OSSL_PARAM_BLD_free(tmpl);
1334 OSSL_PARAM_BLD_free(tmpl);
1336 ret = EVP_PKEY_CTX_set_params(ctx, params);
1337 OSSL_PARAM_BLD_free_params(params);
1341 int EVP_PKEY_CTX_set_rsa_keygen_primes(EVP_PKEY_CTX *ctx, int primes)
1343 OSSL_PARAM params[2], *p = params;
1344 size_t primes2 = primes;
1346 if (ctx == NULL || !EVP_PKEY_CTX_IS_GEN_OP(ctx)) {
1347 ERR_raise(ERR_LIB_EVP, EVP_R_COMMAND_NOT_SUPPORTED);
1348 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1352 /* If key type not RSA return error */
1353 if (ctx->pmeth != NULL && ctx->pmeth->pkey_id != EVP_PKEY_RSA)
1356 /* TODO(3.0): Remove this eventually when no more legacy */
1357 if (ctx->op.keymgmt.genctx == NULL)
1358 return EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_KEYGEN,
1359 EVP_PKEY_CTRL_RSA_KEYGEN_PRIMES, primes,
1362 *p++ = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_PRIMES, &primes2);
1363 *p++ = OSSL_PARAM_construct_end();
1365 if (!EVP_PKEY_CTX_set_params(ctx, params))