2 * Copyright 2019-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/evp.h>
18 #include <openssl/core_dispatch.h>
19 #include <openssl/core_names.h>
20 #include <openssl/rsa.h>
21 #include <openssl/params.h>
22 #include <openssl/err.h>
23 #include <openssl/proverr.h>
24 /* Just for SSL_MAX_MASTER_KEY_LENGTH */
25 #include <openssl/ssl.h>
26 #include "internal/constant_time.h"
27 #include "internal/sizes.h"
28 #include "crypto/rsa.h"
29 #include "prov/provider_ctx.h"
30 #include "prov/implementations.h"
31 #include "prov/providercommon.h"
32 #include "prov/securitycheck.h"
36 static OSSL_FUNC_asym_cipher_newctx_fn rsa_newctx
;
37 static OSSL_FUNC_asym_cipher_encrypt_init_fn rsa_encrypt_init
;
38 static OSSL_FUNC_asym_cipher_encrypt_fn rsa_encrypt
;
39 static OSSL_FUNC_asym_cipher_decrypt_init_fn rsa_decrypt_init
;
40 static OSSL_FUNC_asym_cipher_decrypt_fn rsa_decrypt
;
41 static OSSL_FUNC_asym_cipher_freectx_fn rsa_freectx
;
42 static OSSL_FUNC_asym_cipher_dupctx_fn rsa_dupctx
;
43 static OSSL_FUNC_asym_cipher_get_ctx_params_fn rsa_get_ctx_params
;
44 static OSSL_FUNC_asym_cipher_gettable_ctx_params_fn rsa_gettable_ctx_params
;
45 static OSSL_FUNC_asym_cipher_set_ctx_params_fn rsa_set_ctx_params
;
46 static OSSL_FUNC_asym_cipher_settable_ctx_params_fn rsa_settable_ctx_params
;
48 static OSSL_ITEM padding_item
[] = {
49 { RSA_PKCS1_PADDING
, OSSL_PKEY_RSA_PAD_MODE_PKCSV15
},
50 { RSA_NO_PADDING
, OSSL_PKEY_RSA_PAD_MODE_NONE
},
51 { RSA_PKCS1_OAEP_PADDING
, OSSL_PKEY_RSA_PAD_MODE_OAEP
}, /* Correct spelling first */
52 { RSA_PKCS1_OAEP_PADDING
, "oeap" },
53 { RSA_X931_PADDING
, OSSL_PKEY_RSA_PAD_MODE_X931
},
58 * What's passed as an actual key is defined by the KEYMGMT interface.
59 * We happen to know that our KEYMGMT simply passes RSA structures, so
60 * we use that here too.
68 /* OAEP message digest */
70 /* message digest for MGF1 */
73 unsigned char *oaep_label
;
76 unsigned int client_version
;
77 unsigned int alt_version
;
80 static void *rsa_newctx(void *provctx
)
82 PROV_RSA_CTX
*prsactx
;
84 if (!ossl_prov_is_running())
86 prsactx
= OPENSSL_zalloc(sizeof(PROV_RSA_CTX
));
89 prsactx
->libctx
= PROV_LIBCTX_OF(provctx
);
94 static int rsa_init(void *vprsactx
, void *vrsa
, int operation
)
96 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
98 if (!ossl_prov_is_running()
101 || !RSA_up_ref(vrsa
))
103 RSA_free(prsactx
->rsa
);
105 prsactx
->operation
= operation
;
107 switch (RSA_test_flags(prsactx
->rsa
, RSA_FLAG_TYPE_MASK
)) {
108 case RSA_FLAG_TYPE_RSA
:
109 prsactx
->pad_mode
= RSA_PKCS1_PADDING
;
112 ERR_raise(ERR_LIB_PROV
, PROV_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
115 if (!ossl_rsa_check_key(vrsa
, operation
== EVP_PKEY_OP_ENCRYPT
)) {
116 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
122 static int rsa_encrypt_init(void *vprsactx
, void *vrsa
)
124 return rsa_init(vprsactx
, vrsa
, EVP_PKEY_OP_ENCRYPT
);
127 static int rsa_decrypt_init(void *vprsactx
, void *vrsa
)
129 return rsa_init(vprsactx
, vrsa
, EVP_PKEY_OP_DECRYPT
);
132 static int rsa_encrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
133 size_t outsize
, const unsigned char *in
, size_t inlen
)
135 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
138 if (!ossl_prov_is_running())
142 size_t len
= RSA_size(prsactx
->rsa
);
145 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
152 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
153 int rsasize
= RSA_size(prsactx
->rsa
);
156 if ((tbuf
= OPENSSL_malloc(rsasize
)) == NULL
) {
157 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
160 if (prsactx
->oaep_md
== NULL
) {
162 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
163 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
167 ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(prsactx
->libctx
, tbuf
,
170 prsactx
->oaep_labellen
,
178 ret
= RSA_public_encrypt(rsasize
, tbuf
, out
, prsactx
->rsa
,
182 ret
= RSA_public_encrypt(inlen
, in
, out
, prsactx
->rsa
,
185 /* A ret value of 0 is not an error */
192 static int rsa_decrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
193 size_t outsize
, const unsigned char *in
, size_t inlen
)
195 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
197 size_t len
= RSA_size(prsactx
->rsa
);
199 if (!ossl_prov_is_running())
202 if (prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
204 *outlen
= SSL_MAX_MASTER_KEY_LENGTH
;
207 if (outsize
< SSL_MAX_MASTER_KEY_LENGTH
) {
208 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
214 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
222 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
227 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
228 || prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
231 if ((tbuf
= OPENSSL_malloc(len
)) == NULL
) {
232 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
235 ret
= RSA_private_decrypt(inlen
, in
, tbuf
, prsactx
->rsa
,
238 * With no padding then, on success ret should be len, otherwise an
239 * error occurred (non-constant time)
241 if (ret
!= (int)len
) {
243 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_DECRYPT
);
246 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
247 if (prsactx
->oaep_md
== NULL
) {
248 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
249 if (prsactx
->oaep_md
== NULL
) {
250 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
254 ret
= RSA_padding_check_PKCS1_OAEP_mgf1(out
, outsize
, tbuf
,
257 prsactx
->oaep_labellen
,
261 /* RSA_PKCS1_WITH_TLS_PADDING */
262 if (prsactx
->client_version
<= 0) {
263 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_TLS_CLIENT_VERSION
);
266 ret
= ossl_rsa_padding_check_PKCS1_type_2_TLS(
267 prsactx
->libctx
, out
, outsize
, tbuf
, len
,
268 prsactx
->client_version
, prsactx
->alt_version
);
272 ret
= RSA_private_decrypt(inlen
, in
, out
, prsactx
->rsa
,
275 *outlen
= constant_time_select_s(constant_time_msb_s(ret
), *outlen
, ret
);
276 ret
= constant_time_select_int(constant_time_msb(ret
), 0, 1);
280 static void rsa_freectx(void *vprsactx
)
282 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
284 RSA_free(prsactx
->rsa
);
286 EVP_MD_free(prsactx
->oaep_md
);
287 EVP_MD_free(prsactx
->mgf1_md
);
288 OPENSSL_free(prsactx
->oaep_label
);
290 OPENSSL_free(prsactx
);
293 static void *rsa_dupctx(void *vprsactx
)
295 PROV_RSA_CTX
*srcctx
= (PROV_RSA_CTX
*)vprsactx
;
296 PROV_RSA_CTX
*dstctx
;
298 if (!ossl_prov_is_running())
301 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
306 if (dstctx
->rsa
!= NULL
&& !RSA_up_ref(dstctx
->rsa
)) {
307 OPENSSL_free(dstctx
);
311 if (dstctx
->oaep_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->oaep_md
)) {
312 RSA_free(dstctx
->rsa
);
313 OPENSSL_free(dstctx
);
317 if (dstctx
->mgf1_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->mgf1_md
)) {
318 RSA_free(dstctx
->rsa
);
319 EVP_MD_free(dstctx
->oaep_md
);
320 OPENSSL_free(dstctx
);
327 static int rsa_get_ctx_params(void *vprsactx
, OSSL_PARAM
*params
)
329 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
332 if (prsactx
== NULL
|| params
== NULL
)
335 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
337 switch (p
->data_type
) {
338 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
339 if (!OSSL_PARAM_set_int(p
, prsactx
->pad_mode
))
342 case OSSL_PARAM_UTF8_STRING
:
345 const char *word
= NULL
;
347 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
348 if (prsactx
->pad_mode
== (int)padding_item
[i
].id
) {
349 word
= padding_item
[i
].ptr
;
355 if (!OSSL_PARAM_set_utf8_string(p
, word
))
358 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
366 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
367 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, prsactx
->oaep_md
== NULL
369 : EVP_MD_name(prsactx
->oaep_md
)))
372 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
374 EVP_MD
*mgf1_md
= prsactx
->mgf1_md
== NULL
? prsactx
->oaep_md
377 if (!OSSL_PARAM_set_utf8_string(p
, mgf1_md
== NULL
379 : EVP_MD_name(mgf1_md
)))
383 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
385 !OSSL_PARAM_set_octet_ptr(p
, prsactx
->oaep_label
,
386 prsactx
->oaep_labellen
))
389 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
390 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->client_version
))
393 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
394 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->alt_version
))
400 static const OSSL_PARAM known_gettable_ctx_params
[] = {
401 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
402 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
403 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
404 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, OSSL_PARAM_OCTET_PTR
,
406 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
407 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
411 static const OSSL_PARAM
*rsa_gettable_ctx_params(ossl_unused
void *provctx
)
413 return known_gettable_ctx_params
;
416 static int rsa_set_ctx_params(void *vprsactx
, const OSSL_PARAM params
[])
418 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
420 char mdname
[OSSL_MAX_NAME_SIZE
];
421 char mdprops
[OSSL_MAX_PROPQUERY_SIZE
] = { '\0' };
424 if (prsactx
== NULL
|| params
== NULL
)
427 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
429 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
433 p
= OSSL_PARAM_locate_const(params
,
434 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS
);
436 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
440 EVP_MD_free(prsactx
->oaep_md
);
441 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, mdprops
);
443 if (prsactx
->oaep_md
== NULL
)
447 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
451 switch (p
->data_type
) {
452 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
453 if (!OSSL_PARAM_get_int(p
, &pad_mode
))
456 case OSSL_PARAM_UTF8_STRING
:
463 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
464 if (strcmp(p
->data
, padding_item
[i
].ptr
) == 0) {
465 pad_mode
= padding_item
[i
].id
;
476 * PSS padding is for signatures only so is not compatible with
477 * asymmetric cipher use.
479 if (pad_mode
== RSA_PKCS1_PSS_PADDING
)
481 if (pad_mode
== RSA_PKCS1_OAEP_PADDING
&& prsactx
->oaep_md
== NULL
) {
482 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA1", mdprops
);
483 if (prsactx
->oaep_md
== NULL
)
486 prsactx
->pad_mode
= pad_mode
;
489 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
491 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
495 p
= OSSL_PARAM_locate_const(params
,
496 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
);
498 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
504 EVP_MD_free(prsactx
->mgf1_md
);
505 prsactx
->mgf1_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, str
);
507 if (prsactx
->mgf1_md
== NULL
)
511 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
513 void *tmp_label
= NULL
;
516 if (!OSSL_PARAM_get_octet_string(p
, &tmp_label
, 0, &tmp_labellen
))
518 OPENSSL_free(prsactx
->oaep_label
);
519 prsactx
->oaep_label
= (unsigned char *)tmp_label
;
520 prsactx
->oaep_labellen
= tmp_labellen
;
523 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
525 unsigned int client_version
;
527 if (!OSSL_PARAM_get_uint(p
, &client_version
))
529 prsactx
->client_version
= client_version
;
532 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
534 unsigned int alt_version
;
536 if (!OSSL_PARAM_get_uint(p
, &alt_version
))
538 prsactx
->alt_version
= alt_version
;
544 static const OSSL_PARAM known_settable_ctx_params
[] = {
545 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
546 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
547 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
548 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
, NULL
, 0),
549 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, NULL
, 0),
550 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
551 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
555 static const OSSL_PARAM
*rsa_settable_ctx_params(ossl_unused
void *provctx
)
557 return known_settable_ctx_params
;
560 const OSSL_DISPATCH ossl_rsa_asym_cipher_functions
[] = {
561 { OSSL_FUNC_ASYM_CIPHER_NEWCTX
, (void (*)(void))rsa_newctx
},
562 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT
, (void (*)(void))rsa_encrypt_init
},
563 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT
, (void (*)(void))rsa_encrypt
},
564 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT
, (void (*)(void))rsa_decrypt_init
},
565 { OSSL_FUNC_ASYM_CIPHER_DECRYPT
, (void (*)(void))rsa_decrypt
},
566 { OSSL_FUNC_ASYM_CIPHER_FREECTX
, (void (*)(void))rsa_freectx
},
567 { OSSL_FUNC_ASYM_CIPHER_DUPCTX
, (void (*)(void))rsa_dupctx
},
568 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS
,
569 (void (*)(void))rsa_get_ctx_params
},
570 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS
,
571 (void (*)(void))rsa_gettable_ctx_params
},
572 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS
,
573 (void (*)(void))rsa_set_ctx_params
},
574 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS
,
575 (void (*)(void))rsa_settable_ctx_params
},