2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * RSA low level APIs are deprecated for public use, but still ok for
14 #include "internal/deprecated.h"
16 #include <openssl/crypto.h>
17 #include <openssl/core_names.h>
19 # include <openssl/engine.h>
21 #include <openssl/evp.h>
22 #include <openssl/param_build.h>
23 #include "internal/cryptlib.h"
24 #include "internal/refcount.h"
25 #include "crypto/bn.h"
26 #include "crypto/evp.h"
27 #include "crypto/rsa.h"
28 #include "crypto/security_bits.h"
29 #include "rsa_local.h"
31 static RSA
*rsa_new_intern(ENGINE
*engine
, OSSL_LIB_CTX
*libctx
);
36 return rsa_new_intern(NULL
, NULL
);
39 const RSA_METHOD
*RSA_get_method(const RSA
*rsa
)
44 int RSA_set_method(RSA
*rsa
, const RSA_METHOD
*meth
)
47 * NB: The caller is specifically setting a method, so it's not up to us
48 * to deal with which ENGINE it comes from.
50 const RSA_METHOD
*mtmp
;
54 #ifndef OPENSSL_NO_ENGINE
55 ENGINE_finish(rsa
->engine
);
64 RSA
*RSA_new_method(ENGINE
*engine
)
66 return rsa_new_intern(engine
, NULL
);
70 RSA
*ossl_rsa_new_with_ctx(OSSL_LIB_CTX
*libctx
)
72 return rsa_new_intern(NULL
, libctx
);
75 static RSA
*rsa_new_intern(ENGINE
*engine
, OSSL_LIB_CTX
*libctx
)
77 RSA
*ret
= OPENSSL_zalloc(sizeof(*ret
));
80 ERR_raise(ERR_LIB_RSA
, ERR_R_MALLOC_FAILURE
);
85 ret
->lock
= CRYPTO_THREAD_lock_new();
86 if (ret
->lock
== NULL
) {
87 ERR_raise(ERR_LIB_RSA
, ERR_R_MALLOC_FAILURE
);
93 ret
->meth
= RSA_get_default_method();
94 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
95 ret
->flags
= ret
->meth
->flags
& ~RSA_FLAG_NON_FIPS_ALLOW
;
97 if (!ENGINE_init(engine
)) {
98 ERR_raise(ERR_LIB_RSA
, ERR_R_ENGINE_LIB
);
101 ret
->engine
= engine
;
103 ret
->engine
= ENGINE_get_default_RSA();
106 ret
->meth
= ENGINE_get_RSA(ret
->engine
);
107 if (ret
->meth
== NULL
) {
108 ERR_raise(ERR_LIB_RSA
, ERR_R_ENGINE_LIB
);
114 ret
->flags
= ret
->meth
->flags
& ~RSA_FLAG_NON_FIPS_ALLOW
;
116 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_RSA
, ret
, &ret
->ex_data
)) {
121 if ((ret
->meth
->init
!= NULL
) && !ret
->meth
->init(ret
)) {
122 ERR_raise(ERR_LIB_RSA
, ERR_R_INIT_FAIL
);
133 void RSA_free(RSA
*r
)
140 CRYPTO_DOWN_REF(&r
->references
, &i
, r
->lock
);
141 REF_PRINT_COUNT("RSA", r
);
144 REF_ASSERT_ISNT(i
< 0);
146 if (r
->meth
!= NULL
&& r
->meth
->finish
!= NULL
)
148 #if !defined(OPENSSL_NO_ENGINE) && !defined(FIPS_MODULE)
149 ENGINE_finish(r
->engine
);
153 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_RSA
, r
, &r
->ex_data
);
156 CRYPTO_THREAD_lock_free(r
->lock
);
163 BN_clear_free(r
->dmp1
);
164 BN_clear_free(r
->dmq1
);
165 BN_clear_free(r
->iqmp
);
167 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
168 ossl_rsa_acvp_test_free(r
->acvp_test
);
172 RSA_PSS_PARAMS_free(r
->pss
);
173 sk_RSA_PRIME_INFO_pop_free(r
->prime_infos
, ossl_rsa_multip_info_free
);
175 BN_BLINDING_free(r
->blinding
);
176 BN_BLINDING_free(r
->mt_blinding
);
180 int RSA_up_ref(RSA
*r
)
184 if (CRYPTO_UP_REF(&r
->references
, &i
, r
->lock
) <= 0)
187 REF_PRINT_COUNT("RSA", r
);
188 REF_ASSERT_ISNT(i
< 2);
189 return i
> 1 ? 1 : 0;
192 OSSL_LIB_CTX
*ossl_rsa_get0_libctx(RSA
*r
)
197 void ossl_rsa_set0_libctx(RSA
*r
, OSSL_LIB_CTX
*libctx
)
203 int RSA_set_ex_data(RSA
*r
, int idx
, void *arg
)
205 return CRYPTO_set_ex_data(&r
->ex_data
, idx
, arg
);
208 void *RSA_get_ex_data(const RSA
*r
, int idx
)
210 return CRYPTO_get_ex_data(&r
->ex_data
, idx
);
215 * Define a scaling constant for our fixed point arithmetic.
216 * This value must be a power of two because the base two logarithm code
217 * makes this assumption. The exponent must also be a multiple of three so
218 * that the scale factor has an exact cube root. Finally, the scale factor
219 * should not be so large that a multiplication of two scaled numbers
220 * overflows a 64 bit unsigned integer.
222 static const unsigned int scale
= 1 << 18;
223 static const unsigned int cbrt_scale
= 1 << (2 * 18 / 3);
225 /* Define some constants, none exceed 32 bits */
226 static const unsigned int log_2
= 0x02c5c8; /* scale * log(2) */
227 static const unsigned int log_e
= 0x05c551; /* scale * log2(M_E) */
228 static const unsigned int c1_923
= 0x07b126; /* scale * 1.923 */
229 static const unsigned int c4_690
= 0x12c28f; /* scale * 4.690 */
232 * Multiply two scaled integers together and rescale the result.
234 static ossl_inline
uint64_t mul2(uint64_t a
, uint64_t b
)
236 return a
* b
/ scale
;
240 * Calculate the cube root of a 64 bit scaled integer.
241 * Although the cube root of a 64 bit number does fit into a 32 bit unsigned
242 * integer, this is not guaranteed after scaling, so this function has a
243 * 64 bit return. This uses the shifting nth root algorithm with some
244 * algebraic simplifications.
246 static uint64_t icbrt64(uint64_t x
)
252 for (s
= 63; s
>= 0; s
-= 3) {
254 b
= 3 * r
* (r
+ 1) + 1;
260 return r
* cbrt_scale
;
264 * Calculate the natural logarithm of a 64 bit scaled integer.
265 * This is done by calculating a base two logarithm and scaling.
266 * The maximum logarithm (base 2) is 64 and this reduces base e, so
267 * a 32 bit result should not overflow. The argument passed must be
268 * greater than unity so we don't need to handle negative results.
270 static uint32_t ilog_e(uint64_t v
)
275 * Scale down the value into the range 1 .. 2.
277 * If fractional numbers need to be processed, another loop needs
278 * to go here that checks v < scale and if so multiplies it by 2 and
279 * reduces r by scale. This also means making r signed.
281 while (v
>= 2 * scale
) {
285 for (i
= scale
/ 2; i
!= 0; i
/= 2) {
287 if (v
>= 2 * scale
) {
292 r
= (r
* (uint64_t)scale
) / log_e
;
297 * NIST SP 800-56B rev 2 Appendix D: Maximum Security Strength Estimates for IFC
300 * Note that this formula is also referred to in SP800-56A rev3 Appendix D:
301 * for FFC safe prime groups for modp and ffdhe.
302 * After Table 25 and Table 26 it refers to
303 * "The maximum security strength estimates were calculated using the formula in
304 * Section 7.5 of the FIPS 140 IG and rounded to the nearest multiple of eight
309 * E = \frac{1.923 \sqrt[3]{nBits \cdot log_e(2)}
310 * \cdot(log_e(nBits \cdot log_e(2))^{2/3} - 4.69}{log_e(2)}
311 * The two cube roots are merged together here.
313 uint16_t ossl_ifc_ffc_compute_security_bits(int n
)
320 * Look for common values as listed in standards.
321 * These values are not exactly equal to the results from the formulae in
322 * the standards but are defined to be canonical.
325 case 2048: /* SP 800-56B rev 2 Appendix D and FIPS 140-2 IG 7.5 */
327 case 3072: /* SP 800-56B rev 2 Appendix D and FIPS 140-2 IG 7.5 */
329 case 4096: /* SP 800-56B rev 2 Appendix D */
331 case 6144: /* SP 800-56B rev 2 Appendix D */
333 case 7680: /* FIPS 140-2 IG 7.5 */
335 case 8192: /* SP 800-56B rev 2 Appendix D */
337 case 15360: /* FIPS 140-2 IG 7.5 */
342 * The first incorrect result (i.e. not accurate or off by one low) occurs
343 * for n = 699668. The true value here is 1200. Instead of using this n
344 * as the check threshold, the smallest n such that the correct result is
345 * 1200 is used instead.
353 * To ensure that the output is non-decreasing with respect to n,
354 * a cap needs to be applied to the two values where the function over
355 * estimates the strength (according to the above fast path).
364 x
= n
* (uint64_t)log_2
;
366 y
= (uint16_t)((mul2(c1_923
, icbrt64(mul2(mul2(x
, lx
), lx
))) - c4_690
)
376 int RSA_security_bits(const RSA
*rsa
)
378 int bits
= BN_num_bits(rsa
->n
);
381 if (rsa
->version
== RSA_ASN1_VERSION_MULTI
) {
382 /* This ought to mean that we have private key at hand. */
383 int ex_primes
= sk_RSA_PRIME_INFO_num(rsa
->prime_infos
);
385 if (ex_primes
<= 0 || (ex_primes
+ 2) > ossl_rsa_multip_cap(bits
))
389 return ossl_ifc_ffc_compute_security_bits(bits
);
392 int RSA_set0_key(RSA
*r
, BIGNUM
*n
, BIGNUM
*e
, BIGNUM
*d
)
394 /* If the fields n and e in r are NULL, the corresponding input
395 * parameters MUST be non-NULL for n and e. d may be
396 * left NULL (in case only the public key is used).
398 if ((r
->n
== NULL
&& n
== NULL
)
399 || (r
->e
== NULL
&& e
== NULL
))
413 BN_set_flags(r
->d
, BN_FLG_CONSTTIME
);
420 int RSA_set0_factors(RSA
*r
, BIGNUM
*p
, BIGNUM
*q
)
422 /* If the fields p and q in r are NULL, the corresponding input
423 * parameters MUST be non-NULL.
425 if ((r
->p
== NULL
&& p
== NULL
)
426 || (r
->q
== NULL
&& q
== NULL
))
432 BN_set_flags(r
->p
, BN_FLG_CONSTTIME
);
437 BN_set_flags(r
->q
, BN_FLG_CONSTTIME
);
444 int RSA_set0_crt_params(RSA
*r
, BIGNUM
*dmp1
, BIGNUM
*dmq1
, BIGNUM
*iqmp
)
446 /* If the fields dmp1, dmq1 and iqmp in r are NULL, the corresponding input
447 * parameters MUST be non-NULL.
449 if ((r
->dmp1
== NULL
&& dmp1
== NULL
)
450 || (r
->dmq1
== NULL
&& dmq1
== NULL
)
451 || (r
->iqmp
== NULL
&& iqmp
== NULL
))
455 BN_clear_free(r
->dmp1
);
457 BN_set_flags(r
->dmp1
, BN_FLG_CONSTTIME
);
460 BN_clear_free(r
->dmq1
);
462 BN_set_flags(r
->dmq1
, BN_FLG_CONSTTIME
);
465 BN_clear_free(r
->iqmp
);
467 BN_set_flags(r
->iqmp
, BN_FLG_CONSTTIME
);
476 * Is it better to export RSA_PRIME_INFO structure
477 * and related functions to let user pass a triplet?
479 int RSA_set0_multi_prime_params(RSA
*r
, BIGNUM
*primes
[], BIGNUM
*exps
[],
480 BIGNUM
*coeffs
[], int pnum
)
482 STACK_OF(RSA_PRIME_INFO
) *prime_infos
, *old
= NULL
;
483 RSA_PRIME_INFO
*pinfo
;
486 if (primes
== NULL
|| exps
== NULL
|| coeffs
== NULL
|| pnum
== 0)
489 prime_infos
= sk_RSA_PRIME_INFO_new_reserve(NULL
, pnum
);
490 if (prime_infos
== NULL
)
493 if (r
->prime_infos
!= NULL
)
494 old
= r
->prime_infos
;
496 for (i
= 0; i
< pnum
; i
++) {
497 pinfo
= ossl_rsa_multip_info_new();
500 if (primes
[i
] != NULL
&& exps
[i
] != NULL
&& coeffs
[i
] != NULL
) {
501 BN_clear_free(pinfo
->r
);
502 BN_clear_free(pinfo
->d
);
503 BN_clear_free(pinfo
->t
);
504 pinfo
->r
= primes
[i
];
506 pinfo
->t
= coeffs
[i
];
507 BN_set_flags(pinfo
->r
, BN_FLG_CONSTTIME
);
508 BN_set_flags(pinfo
->d
, BN_FLG_CONSTTIME
);
509 BN_set_flags(pinfo
->t
, BN_FLG_CONSTTIME
);
511 ossl_rsa_multip_info_free(pinfo
);
514 (void)sk_RSA_PRIME_INFO_push(prime_infos
, pinfo
);
517 r
->prime_infos
= prime_infos
;
519 if (!ossl_rsa_multip_calc_product(r
)) {
520 r
->prime_infos
= old
;
526 * This is hard to deal with, since the old infos could
527 * also be set by this function and r, d, t should not
528 * be freed in that case. So currently, stay consistent
529 * with other *set0* functions: just free it...
531 sk_RSA_PRIME_INFO_pop_free(old
, ossl_rsa_multip_info_free
);
534 r
->version
= RSA_ASN1_VERSION_MULTI
;
539 /* r, d, t should not be freed */
540 sk_RSA_PRIME_INFO_pop_free(prime_infos
, ossl_rsa_multip_info_free_ex
);
545 void RSA_get0_key(const RSA
*r
,
546 const BIGNUM
**n
, const BIGNUM
**e
, const BIGNUM
**d
)
556 void RSA_get0_factors(const RSA
*r
, const BIGNUM
**p
, const BIGNUM
**q
)
565 int RSA_get_multi_prime_extra_count(const RSA
*r
)
569 pnum
= sk_RSA_PRIME_INFO_num(r
->prime_infos
);
575 int RSA_get0_multi_prime_factors(const RSA
*r
, const BIGNUM
*primes
[])
578 RSA_PRIME_INFO
*pinfo
;
580 if ((pnum
= RSA_get_multi_prime_extra_count(r
)) == 0)
584 * return other primes
585 * it's caller's responsibility to allocate oth_primes[pnum]
587 for (i
= 0; i
< pnum
; i
++) {
588 pinfo
= sk_RSA_PRIME_INFO_value(r
->prime_infos
, i
);
589 primes
[i
] = pinfo
->r
;
596 void RSA_get0_crt_params(const RSA
*r
,
597 const BIGNUM
**dmp1
, const BIGNUM
**dmq1
,
609 int RSA_get0_multi_prime_crt_params(const RSA
*r
, const BIGNUM
*exps
[],
610 const BIGNUM
*coeffs
[])
614 if ((pnum
= RSA_get_multi_prime_extra_count(r
)) == 0)
617 /* return other primes */
618 if (exps
!= NULL
|| coeffs
!= NULL
) {
619 RSA_PRIME_INFO
*pinfo
;
622 /* it's the user's job to guarantee the buffer length */
623 for (i
= 0; i
< pnum
; i
++) {
624 pinfo
= sk_RSA_PRIME_INFO_value(r
->prime_infos
, i
);
628 coeffs
[i
] = pinfo
->t
;
636 const BIGNUM
*RSA_get0_n(const RSA
*r
)
641 const BIGNUM
*RSA_get0_e(const RSA
*r
)
646 const BIGNUM
*RSA_get0_d(const RSA
*r
)
651 const BIGNUM
*RSA_get0_p(const RSA
*r
)
656 const BIGNUM
*RSA_get0_q(const RSA
*r
)
661 const BIGNUM
*RSA_get0_dmp1(const RSA
*r
)
666 const BIGNUM
*RSA_get0_dmq1(const RSA
*r
)
671 const BIGNUM
*RSA_get0_iqmp(const RSA
*r
)
676 const RSA_PSS_PARAMS
*RSA_get0_pss_params(const RSA
*r
)
686 int ossl_rsa_set0_pss_params(RSA
*r
, RSA_PSS_PARAMS
*pss
)
691 RSA_PSS_PARAMS_free(r
->pss
);
698 RSA_PSS_PARAMS_30
*ossl_rsa_get0_pss_params_30(RSA
*r
)
700 return &r
->pss_params
;
703 void RSA_clear_flags(RSA
*r
, int flags
)
708 int RSA_test_flags(const RSA
*r
, int flags
)
710 return r
->flags
& flags
;
713 void RSA_set_flags(RSA
*r
, int flags
)
718 int RSA_get_version(RSA
*r
)
720 /* { two-prime(0), multi(1) } */
725 ENGINE
*RSA_get0_engine(const RSA
*r
)
730 int RSA_pkey_ctx_ctrl(EVP_PKEY_CTX
*ctx
, int optype
, int cmd
, int p1
, void *p2
)
732 /* If key type not RSA or RSA-PSS return error */
733 if (ctx
!= NULL
&& ctx
->pmeth
!= NULL
734 && ctx
->pmeth
->pkey_id
!= EVP_PKEY_RSA
735 && ctx
->pmeth
->pkey_id
!= EVP_PKEY_RSA_PSS
)
737 return EVP_PKEY_CTX_ctrl(ctx
, -1, optype
, cmd
, p1
, p2
);
741 DEFINE_STACK_OF(BIGNUM
)
743 int ossl_rsa_set0_all_params(RSA
*r
, const STACK_OF(BIGNUM
) *primes
,
744 const STACK_OF(BIGNUM
) *exps
,
745 const STACK_OF(BIGNUM
) *coeffs
)
748 STACK_OF(RSA_PRIME_INFO
) *prime_infos
, *old_infos
= NULL
;
752 if (primes
== NULL
|| exps
== NULL
|| coeffs
== NULL
)
755 pnum
= sk_BIGNUM_num(primes
);
757 || pnum
!= sk_BIGNUM_num(exps
)
758 || pnum
!= sk_BIGNUM_num(coeffs
) + 1)
761 if (!RSA_set0_factors(r
, sk_BIGNUM_value(primes
, 0),
762 sk_BIGNUM_value(primes
, 1))
763 || !RSA_set0_crt_params(r
, sk_BIGNUM_value(exps
, 0),
764 sk_BIGNUM_value(exps
, 1),
765 sk_BIGNUM_value(coeffs
, 0)))
769 old_infos
= r
->prime_infos
;
776 prime_infos
= sk_RSA_PRIME_INFO_new_reserve(NULL
, pnum
);
777 if (prime_infos
== NULL
)
780 for (i
= 2; i
< pnum
; i
++) {
781 BIGNUM
*prime
= sk_BIGNUM_value(primes
, i
);
782 BIGNUM
*exp
= sk_BIGNUM_value(exps
, i
);
783 BIGNUM
*coeff
= sk_BIGNUM_value(coeffs
, i
- 1);
784 RSA_PRIME_INFO
*pinfo
= NULL
;
786 if (!ossl_assert(prime
!= NULL
&& exp
!= NULL
&& coeff
!= NULL
))
789 /* Using ossl_rsa_multip_info_new() is wasteful, so allocate directly */
790 if ((pinfo
= OPENSSL_zalloc(sizeof(*pinfo
))) == NULL
) {
791 ERR_raise(ERR_LIB_RSA
, ERR_R_MALLOC_FAILURE
);
798 BN_set_flags(pinfo
->r
, BN_FLG_CONSTTIME
);
799 BN_set_flags(pinfo
->d
, BN_FLG_CONSTTIME
);
800 BN_set_flags(pinfo
->t
, BN_FLG_CONSTTIME
);
801 (void)sk_RSA_PRIME_INFO_push(prime_infos
, pinfo
);
804 r
->prime_infos
= prime_infos
;
806 if (!ossl_rsa_multip_calc_product(r
)) {
807 r
->prime_infos
= old_infos
;
816 if (old_infos
!= NULL
) {
818 * This is hard to deal with, since the old infos could
819 * also be set by this function and r, d, t should not
820 * be freed in that case. So currently, stay consistent
821 * with other *set0* functions: just free it...
823 sk_RSA_PRIME_INFO_pop_free(old_infos
, ossl_rsa_multip_info_free
);
827 r
->version
= pnum
> 2 ? RSA_ASN1_VERSION_MULTI
: RSA_ASN1_VERSION_DEFAULT
;
833 /* r, d, t should not be freed */
834 sk_RSA_PRIME_INFO_pop_free(prime_infos
, ossl_rsa_multip_info_free_ex
);
839 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const
, BIGNUM
)
841 int ossl_rsa_get0_all_params(RSA
*r
, STACK_OF(BIGNUM_const
) *primes
,
842 STACK_OF(BIGNUM_const
) *exps
,
843 STACK_OF(BIGNUM_const
) *coeffs
)
846 RSA_PRIME_INFO
*pinfo
;
853 /* If |p| is NULL, there are no CRT parameters */
854 if (RSA_get0_p(r
) == NULL
)
857 sk_BIGNUM_const_push(primes
, RSA_get0_p(r
));
858 sk_BIGNUM_const_push(primes
, RSA_get0_q(r
));
859 sk_BIGNUM_const_push(exps
, RSA_get0_dmp1(r
));
860 sk_BIGNUM_const_push(exps
, RSA_get0_dmq1(r
));
861 sk_BIGNUM_const_push(coeffs
, RSA_get0_iqmp(r
));
864 pnum
= RSA_get_multi_prime_extra_count(r
);
865 for (i
= 0; i
< pnum
; i
++) {
866 pinfo
= sk_RSA_PRIME_INFO_value(r
->prime_infos
, i
);
867 sk_BIGNUM_const_push(primes
, pinfo
->r
);
868 sk_BIGNUM_const_push(exps
, pinfo
->d
);
869 sk_BIGNUM_const_push(coeffs
, pinfo
->t
);
877 /* Helpers to set or get diverse hash algorithm names */
878 static int int_set_rsa_md_name(EVP_PKEY_CTX
*ctx
,
880 int keytype
, int optype
,
881 /* For EVP_PKEY_CTX_set_params() */
882 const char *mdkey
, const char *mdname
,
883 const char *propkey
, const char *mdprops
)
885 OSSL_PARAM params
[3], *p
= params
;
887 if (ctx
== NULL
|| mdname
== NULL
|| (ctx
->operation
& optype
) == 0) {
888 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
889 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
893 /* If key type not RSA return error */
896 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA")
897 && !EVP_PKEY_CTX_is_a(ctx
, "RSA-PSS"))
901 if (!EVP_PKEY_CTX_is_a(ctx
, evp_pkey_type2name(keytype
)))
906 /* Cast away the const. This is read only so should be safe */
907 *p
++ = OSSL_PARAM_construct_utf8_string(mdkey
, (char *)mdname
, 0);
908 if (evp_pkey_ctx_is_provided(ctx
) && mdprops
!= NULL
) {
909 /* Cast away the const. This is read only so should be safe */
910 *p
++ = OSSL_PARAM_construct_utf8_string(propkey
, (char *)mdprops
, 0);
912 *p
++ = OSSL_PARAM_construct_end();
914 return evp_pkey_ctx_set_params_strict(ctx
, params
);
917 /* Helpers to set or get diverse hash algorithm names */
918 static int int_get_rsa_md_name(EVP_PKEY_CTX
*ctx
,
920 int keytype
, int optype
,
921 /* For EVP_PKEY_CTX_get_params() */
923 char *mdname
, size_t mdnamesize
)
925 OSSL_PARAM params
[2], *p
= params
;
927 if (ctx
== NULL
|| mdname
== NULL
|| (ctx
->operation
& optype
) == 0) {
928 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
929 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
933 /* If key type not RSA return error */
936 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA")
937 && !EVP_PKEY_CTX_is_a(ctx
, "RSA-PSS"))
941 if (!EVP_PKEY_CTX_is_a(ctx
, evp_pkey_type2name(keytype
)))
946 /* Cast away the const. This is read only so should be safe */
947 *p
++ = OSSL_PARAM_construct_utf8_string(mdkey
, (char *)mdname
, mdnamesize
);
948 *p
++ = OSSL_PARAM_construct_end();
950 return evp_pkey_ctx_get_params_strict(ctx
, params
);
954 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
955 * simply because that's easier.
957 int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX
*ctx
, int pad_mode
)
959 return RSA_pkey_ctx_ctrl(ctx
, -1, EVP_PKEY_CTRL_RSA_PADDING
,
964 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
965 * simply because that's easier.
967 int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX
*ctx
, int *pad_mode
)
969 return RSA_pkey_ctx_ctrl(ctx
, -1, EVP_PKEY_CTRL_GET_RSA_PADDING
,
974 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
975 * simply because that's easier.
977 int EVP_PKEY_CTX_set_rsa_pss_keygen_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
)
979 return EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_RSA_PSS
, EVP_PKEY_OP_KEYGEN
,
980 EVP_PKEY_CTRL_MD
, 0, (void *)(md
));
983 int EVP_PKEY_CTX_set_rsa_pss_keygen_md_name(EVP_PKEY_CTX
*ctx
,
987 return int_set_rsa_md_name(ctx
, EVP_PKEY_RSA_PSS
, EVP_PKEY_OP_KEYGEN
,
988 OSSL_PKEY_PARAM_RSA_DIGEST
, mdname
,
989 OSSL_PKEY_PARAM_RSA_DIGEST_PROPS
, mdprops
);
993 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
994 * simply because that's easier.
996 int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
)
998 return EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_RSA
, EVP_PKEY_OP_TYPE_CRYPT
,
999 EVP_PKEY_CTRL_RSA_OAEP_MD
, 0, (void *)(md
));
1002 int EVP_PKEY_CTX_set_rsa_oaep_md_name(EVP_PKEY_CTX
*ctx
, const char *mdname
,
1003 const char *mdprops
)
1006 int_set_rsa_md_name(ctx
, EVP_PKEY_RSA
, EVP_PKEY_OP_TYPE_CRYPT
,
1007 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, mdname
,
1008 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS
, mdprops
);
1011 int EVP_PKEY_CTX_get_rsa_oaep_md_name(EVP_PKEY_CTX
*ctx
, char *name
,
1014 return int_get_rsa_md_name(ctx
, EVP_PKEY_RSA
, EVP_PKEY_OP_TYPE_CRYPT
,
1015 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
,
1020 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1021 * simply because that's easier.
1023 int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
**md
)
1025 return EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_RSA
, EVP_PKEY_OP_TYPE_CRYPT
,
1026 EVP_PKEY_CTRL_GET_RSA_OAEP_MD
, 0, (void *)md
);
1030 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1031 * simply because that's easier.
1033 int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
)
1035 return RSA_pkey_ctx_ctrl(ctx
, EVP_PKEY_OP_TYPE_SIG
| EVP_PKEY_OP_TYPE_CRYPT
,
1036 EVP_PKEY_CTRL_RSA_MGF1_MD
, 0, (void *)(md
));
1039 int EVP_PKEY_CTX_set_rsa_mgf1_md_name(EVP_PKEY_CTX
*ctx
, const char *mdname
,
1040 const char *mdprops
)
1042 return int_set_rsa_md_name(ctx
, -1,
1043 EVP_PKEY_OP_TYPE_CRYPT
| EVP_PKEY_OP_TYPE_SIG
,
1044 OSSL_PKEY_PARAM_MGF1_DIGEST
, mdname
,
1045 OSSL_PKEY_PARAM_MGF1_PROPERTIES
, mdprops
);
1048 int EVP_PKEY_CTX_get_rsa_mgf1_md_name(EVP_PKEY_CTX
*ctx
, char *name
,
1051 return int_get_rsa_md_name(ctx
, -1,
1052 EVP_PKEY_OP_TYPE_CRYPT
| EVP_PKEY_OP_TYPE_SIG
,
1053 OSSL_PKEY_PARAM_MGF1_DIGEST
, name
, namesize
);
1057 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1058 * simply because that's easier.
1060 int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
*md
)
1062 return EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_RSA_PSS
, EVP_PKEY_OP_KEYGEN
,
1063 EVP_PKEY_CTRL_RSA_MGF1_MD
, 0, (void *)(md
));
1066 int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name(EVP_PKEY_CTX
*ctx
,
1069 return int_set_rsa_md_name(ctx
, EVP_PKEY_RSA_PSS
, EVP_PKEY_OP_KEYGEN
,
1070 OSSL_PKEY_PARAM_MGF1_DIGEST
, mdname
,
1075 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1076 * simply because that's easier.
1078 int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX
*ctx
, const EVP_MD
**md
)
1080 return RSA_pkey_ctx_ctrl(ctx
, EVP_PKEY_OP_TYPE_SIG
| EVP_PKEY_OP_TYPE_CRYPT
,
1081 EVP_PKEY_CTRL_GET_RSA_MGF1_MD
, 0, (void *)(md
));
1084 int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX
*ctx
, void *label
, int llen
)
1086 OSSL_PARAM rsa_params
[2], *p
= rsa_params
;
1088 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)) {
1089 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1090 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1094 /* If key type not RSA return error */
1095 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA"))
1098 /* Cast away the const. This is read only so should be safe */
1099 *p
++ = OSSL_PARAM_construct_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
,
1100 (void *)label
, (size_t)llen
);
1101 *p
++ = OSSL_PARAM_construct_end();
1103 if (!evp_pkey_ctx_set_params_strict(ctx
, rsa_params
))
1106 /* Ownership is supposed to be transfered to the callee. */
1107 OPENSSL_free(label
);
1111 int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX
*ctx
, unsigned char **label
)
1113 OSSL_PARAM rsa_params
[2], *p
= rsa_params
;
1116 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_ASYM_CIPHER_OP(ctx
)) {
1117 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1118 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1122 /* If key type not RSA return error */
1123 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA"))
1126 *p
++ = OSSL_PARAM_construct_octet_ptr(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
,
1128 *p
++ = OSSL_PARAM_construct_end();
1130 if (!EVP_PKEY_CTX_get_params(ctx
, rsa_params
))
1133 labellen
= rsa_params
[0].return_size
;
1134 if (labellen
> INT_MAX
)
1137 return (int)labellen
;
1141 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1142 * simply because that's easier.
1144 int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX
*ctx
, int saltlen
)
1147 * For some reason, the optype was set to this:
1149 * EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY
1151 * However, we do use RSA-PSS with the whole gamut of diverse signature
1152 * and verification operations, so the optype gets upgraded to this:
1154 * EVP_PKEY_OP_TYPE_SIG
1156 return RSA_pkey_ctx_ctrl(ctx
, EVP_PKEY_OP_TYPE_SIG
,
1157 EVP_PKEY_CTRL_RSA_PSS_SALTLEN
, saltlen
, NULL
);
1161 * This one is currently implemented as an EVP_PKEY_CTX_ctrl() wrapper,
1162 * simply because that's easier.
1164 int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX
*ctx
, int *saltlen
)
1167 * Because of circumstances, the optype is updated from:
1169 * EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY
1173 * EVP_PKEY_OP_TYPE_SIG
1175 return RSA_pkey_ctx_ctrl(ctx
, EVP_PKEY_OP_TYPE_SIG
,
1176 EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN
, 0, saltlen
);
1179 int EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen(EVP_PKEY_CTX
*ctx
, int saltlen
)
1181 OSSL_PARAM pad_params
[2], *p
= pad_params
;
1183 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_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 (!EVP_PKEY_CTX_is_a(ctx
, "RSA-PSS"))
1192 *p
++ = OSSL_PARAM_construct_int(OSSL_SIGNATURE_PARAM_PSS_SALTLEN
,
1194 *p
++ = OSSL_PARAM_construct_end();
1196 return evp_pkey_ctx_set_params_strict(ctx
, pad_params
);
1199 int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX
*ctx
, int bits
)
1201 OSSL_PARAM params
[2], *p
= params
;
1202 size_t bits2
= bits
;
1204 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1205 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1206 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1210 /* If key type not RSA return error */
1211 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA")
1212 && !EVP_PKEY_CTX_is_a(ctx
, "RSA-PSS"))
1215 *p
++ = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_BITS
, &bits2
);
1216 *p
++ = OSSL_PARAM_construct_end();
1218 return evp_pkey_ctx_set_params_strict(ctx
, params
);
1221 int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX
*ctx
, BIGNUM
*pubexp
)
1223 int ret
= RSA_pkey_ctx_ctrl(ctx
, EVP_PKEY_OP_KEYGEN
,
1224 EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP
, 0, pubexp
);
1227 * Satisfy memory semantics for pre-3.0 callers of
1228 * EVP_PKEY_CTX_set_rsa_keygen_pubexp(): their expectation is that input
1229 * pubexp BIGNUM becomes managed by the EVP_PKEY_CTX on success.
1231 if (ret
> 0 && evp_pkey_ctx_is_provided(ctx
)) {
1232 BN_free(ctx
->rsa_pubexp
);
1233 ctx
->rsa_pubexp
= pubexp
;
1239 int EVP_PKEY_CTX_set1_rsa_keygen_pubexp(EVP_PKEY_CTX
*ctx
, BIGNUM
*pubexp
)
1244 * When we're dealing with a provider, there's no need to duplicate
1245 * pubexp, as it gets copied when transforming to an OSSL_PARAM anyway.
1247 if (evp_pkey_ctx_is_legacy(ctx
)) {
1248 pubexp
= BN_dup(pubexp
);
1252 ret
= EVP_PKEY_CTX_ctrl(ctx
, EVP_PKEY_RSA
, EVP_PKEY_OP_KEYGEN
,
1253 EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP
, 0, pubexp
);
1254 if (evp_pkey_ctx_is_legacy(ctx
) && ret
<= 0)
1259 int EVP_PKEY_CTX_set_rsa_keygen_primes(EVP_PKEY_CTX
*ctx
, int primes
)
1261 OSSL_PARAM params
[2], *p
= params
;
1262 size_t primes2
= primes
;
1264 if (ctx
== NULL
|| !EVP_PKEY_CTX_IS_GEN_OP(ctx
)) {
1265 ERR_raise(ERR_LIB_EVP
, EVP_R_COMMAND_NOT_SUPPORTED
);
1266 /* Uses the same return values as EVP_PKEY_CTX_ctrl */
1270 /* If key type not RSA return error */
1271 if (!EVP_PKEY_CTX_is_a(ctx
, "RSA")
1272 && !EVP_PKEY_CTX_is_a(ctx
, "RSA-PSS"))
1275 *p
++ = OSSL_PARAM_construct_size_t(OSSL_PKEY_PARAM_RSA_PRIMES
, &primes2
);
1276 *p
++ = OSSL_PARAM_construct_end();
1278 return evp_pkey_ctx_set_params_strict(ctx
, params
);