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 <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 /* Just for SSL_MAX_MASTER_KEY_LENGTH */
24 #include <openssl/ssl.h>
25 #include "internal/constant_time.h"
26 #include "internal/sizes.h"
27 #include "crypto/rsa.h"
28 #include "prov/providercommonerr.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_SSLV23_PADDING
, OSSL_PKEY_RSA_PAD_MODE_SSLV23
},
51 { RSA_NO_PADDING
, OSSL_PKEY_RSA_PAD_MODE_NONE
},
52 { RSA_PKCS1_OAEP_PADDING
, OSSL_PKEY_RSA_PAD_MODE_OAEP
}, /* Correct spelling first */
53 { RSA_PKCS1_OAEP_PADDING
, "oeap" },
54 { RSA_X931_PADDING
, OSSL_PKEY_RSA_PAD_MODE_X931
},
59 * What's passed as an actual key is defined by the KEYMGMT interface.
60 * We happen to know that our KEYMGMT simply passes RSA structures, so
61 * we use that here too.
69 /* OAEP message digest */
71 /* message digest for MGF1 */
74 unsigned char *oaep_label
;
77 unsigned int client_version
;
78 unsigned int alt_version
;
81 static void *rsa_newctx(void *provctx
)
83 PROV_RSA_CTX
*prsactx
;
85 if (!ossl_prov_is_running())
87 prsactx
= OPENSSL_zalloc(sizeof(PROV_RSA_CTX
));
90 prsactx
->libctx
= PROV_LIBCTX_OF(provctx
);
95 static int rsa_init(void *vprsactx
, void *vrsa
, int operation
)
97 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
99 if (!ossl_prov_is_running()
102 || !RSA_up_ref(vrsa
))
104 RSA_free(prsactx
->rsa
);
106 prsactx
->operation
= operation
;
108 switch (RSA_test_flags(prsactx
->rsa
, RSA_FLAG_TYPE_MASK
)) {
109 case RSA_FLAG_TYPE_RSA
:
110 prsactx
->pad_mode
= RSA_PKCS1_PADDING
;
113 ERR_raise(ERR_LIB_PROV
, PROV_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
116 if (!ossl_rsa_check_key(vrsa
, operation
== EVP_PKEY_OP_ENCRYPT
)) {
117 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY_LENGTH
);
123 static int rsa_encrypt_init(void *vprsactx
, void *vrsa
)
125 return rsa_init(vprsactx
, vrsa
, EVP_PKEY_OP_ENCRYPT
);
128 static int rsa_decrypt_init(void *vprsactx
, void *vrsa
)
130 return rsa_init(vprsactx
, vrsa
, EVP_PKEY_OP_DECRYPT
);
133 static int rsa_encrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
134 size_t outsize
, const unsigned char *in
, size_t inlen
)
136 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
139 if (!ossl_prov_is_running())
143 size_t len
= RSA_size(prsactx
->rsa
);
146 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
153 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
154 int rsasize
= RSA_size(prsactx
->rsa
);
157 if ((tbuf
= OPENSSL_malloc(rsasize
)) == NULL
) {
158 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
161 if (prsactx
->oaep_md
== NULL
) {
163 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
164 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
168 ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(prsactx
->libctx
, tbuf
,
171 prsactx
->oaep_labellen
,
179 ret
= RSA_public_encrypt(rsasize
, tbuf
, out
, prsactx
->rsa
,
183 ret
= RSA_public_encrypt(inlen
, in
, out
, prsactx
->rsa
,
186 /* A ret value of 0 is not an error */
193 static int rsa_decrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
194 size_t outsize
, const unsigned char *in
, size_t inlen
)
196 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
198 size_t len
= RSA_size(prsactx
->rsa
);
200 if (!ossl_prov_is_running())
203 if (prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
205 *outlen
= SSL_MAX_MASTER_KEY_LENGTH
;
208 if (outsize
< SSL_MAX_MASTER_KEY_LENGTH
) {
209 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
215 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
223 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
228 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
229 || prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
232 if ((tbuf
= OPENSSL_malloc(len
)) == NULL
) {
233 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
236 ret
= RSA_private_decrypt(inlen
, in
, tbuf
, prsactx
->rsa
,
239 * With no padding then, on success ret should be len, otherwise an
240 * error occurred (non-constant time)
242 if (ret
!= (int)len
) {
244 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_DECRYPT
);
247 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
248 if (prsactx
->oaep_md
== NULL
) {
249 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
250 if (prsactx
->oaep_md
== NULL
) {
251 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
255 ret
= RSA_padding_check_PKCS1_OAEP_mgf1(out
, outsize
, tbuf
,
258 prsactx
->oaep_labellen
,
262 /* RSA_PKCS1_WITH_TLS_PADDING */
263 if (prsactx
->client_version
<= 0) {
264 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_TLS_CLIENT_VERSION
);
267 ret
= ossl_rsa_padding_check_PKCS1_type_2_TLS(
268 prsactx
->libctx
, out
, outsize
, tbuf
, len
,
269 prsactx
->client_version
, prsactx
->alt_version
);
273 ret
= RSA_private_decrypt(inlen
, in
, out
, prsactx
->rsa
,
276 *outlen
= constant_time_select_s(constant_time_msb_s(ret
), *outlen
, ret
);
277 ret
= constant_time_select_int(constant_time_msb(ret
), 0, 1);
281 static void rsa_freectx(void *vprsactx
)
283 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
285 RSA_free(prsactx
->rsa
);
287 EVP_MD_free(prsactx
->oaep_md
);
288 EVP_MD_free(prsactx
->mgf1_md
);
289 OPENSSL_free(prsactx
->oaep_label
);
291 OPENSSL_free(prsactx
);
294 static void *rsa_dupctx(void *vprsactx
)
296 PROV_RSA_CTX
*srcctx
= (PROV_RSA_CTX
*)vprsactx
;
297 PROV_RSA_CTX
*dstctx
;
299 if (!ossl_prov_is_running())
302 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
307 if (dstctx
->rsa
!= NULL
&& !RSA_up_ref(dstctx
->rsa
)) {
308 OPENSSL_free(dstctx
);
312 if (dstctx
->oaep_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->oaep_md
)) {
313 RSA_free(dstctx
->rsa
);
314 OPENSSL_free(dstctx
);
318 if (dstctx
->mgf1_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->mgf1_md
)) {
319 RSA_free(dstctx
->rsa
);
320 EVP_MD_free(dstctx
->oaep_md
);
321 OPENSSL_free(dstctx
);
328 static int rsa_get_ctx_params(void *vprsactx
, OSSL_PARAM
*params
)
330 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
333 if (prsactx
== NULL
|| params
== NULL
)
336 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
338 switch (p
->data_type
) {
339 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
340 if (!OSSL_PARAM_set_int(p
, prsactx
->pad_mode
))
343 case OSSL_PARAM_UTF8_STRING
:
346 const char *word
= NULL
;
348 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
349 if (prsactx
->pad_mode
== (int)padding_item
[i
].id
) {
350 word
= padding_item
[i
].ptr
;
356 if (!OSSL_PARAM_set_utf8_string(p
, word
))
359 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
367 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
368 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, prsactx
->oaep_md
== NULL
370 : EVP_MD_name(prsactx
->oaep_md
)))
373 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
375 EVP_MD
*mgf1_md
= prsactx
->mgf1_md
== NULL
? prsactx
->oaep_md
378 if (!OSSL_PARAM_set_utf8_string(p
, mgf1_md
== NULL
380 : EVP_MD_name(mgf1_md
)))
384 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
386 !OSSL_PARAM_set_octet_ptr(p
, prsactx
->oaep_label
,
387 prsactx
->oaep_labellen
))
390 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
391 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->client_version
))
394 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
395 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->alt_version
))
401 static const OSSL_PARAM known_gettable_ctx_params
[] = {
402 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
403 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
404 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
405 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, OSSL_PARAM_OCTET_PTR
,
407 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
408 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
412 static const OSSL_PARAM
*rsa_gettable_ctx_params(ossl_unused
void *provctx
)
414 return known_gettable_ctx_params
;
417 static int rsa_set_ctx_params(void *vprsactx
, const OSSL_PARAM params
[])
419 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
421 char mdname
[OSSL_MAX_NAME_SIZE
];
422 char mdprops
[OSSL_MAX_PROPQUERY_SIZE
] = { '\0' };
425 if (prsactx
== NULL
|| params
== NULL
)
428 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
430 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
434 p
= OSSL_PARAM_locate_const(params
,
435 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS
);
437 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
441 EVP_MD_free(prsactx
->oaep_md
);
442 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, mdprops
);
444 if (prsactx
->oaep_md
== NULL
)
448 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
452 switch (p
->data_type
) {
453 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
454 if (!OSSL_PARAM_get_int(p
, &pad_mode
))
457 case OSSL_PARAM_UTF8_STRING
:
464 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
465 if (strcmp(p
->data
, padding_item
[i
].ptr
) == 0) {
466 pad_mode
= padding_item
[i
].id
;
477 * PSS padding is for signatures only so is not compatible with
478 * asymmetric cipher use.
480 if (pad_mode
== RSA_PKCS1_PSS_PADDING
)
482 if (pad_mode
== RSA_PKCS1_OAEP_PADDING
&& prsactx
->oaep_md
== NULL
) {
483 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA1", mdprops
);
484 if (prsactx
->oaep_md
== NULL
)
487 prsactx
->pad_mode
= pad_mode
;
490 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
492 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
496 p
= OSSL_PARAM_locate_const(params
,
497 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
);
499 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
505 EVP_MD_free(prsactx
->mgf1_md
);
506 prsactx
->mgf1_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, str
);
508 if (prsactx
->mgf1_md
== NULL
)
512 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
514 void *tmp_label
= NULL
;
517 if (!OSSL_PARAM_get_octet_string(p
, &tmp_label
, 0, &tmp_labellen
))
519 OPENSSL_free(prsactx
->oaep_label
);
520 prsactx
->oaep_label
= (unsigned char *)tmp_label
;
521 prsactx
->oaep_labellen
= tmp_labellen
;
524 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
526 unsigned int client_version
;
528 if (!OSSL_PARAM_get_uint(p
, &client_version
))
530 prsactx
->client_version
= client_version
;
533 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
535 unsigned int alt_version
;
537 if (!OSSL_PARAM_get_uint(p
, &alt_version
))
539 prsactx
->alt_version
= alt_version
;
545 static const OSSL_PARAM known_settable_ctx_params
[] = {
546 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
547 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
548 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
549 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
, NULL
, 0),
550 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, NULL
, 0),
551 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
552 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
556 static const OSSL_PARAM
*rsa_settable_ctx_params(ossl_unused
void *provctx
)
558 return known_settable_ctx_params
;
561 const OSSL_DISPATCH ossl_rsa_asym_cipher_functions
[] = {
562 { OSSL_FUNC_ASYM_CIPHER_NEWCTX
, (void (*)(void))rsa_newctx
},
563 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT
, (void (*)(void))rsa_encrypt_init
},
564 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT
, (void (*)(void))rsa_encrypt
},
565 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT
, (void (*)(void))rsa_decrypt_init
},
566 { OSSL_FUNC_ASYM_CIPHER_DECRYPT
, (void (*)(void))rsa_decrypt
},
567 { OSSL_FUNC_ASYM_CIPHER_FREECTX
, (void (*)(void))rsa_freectx
},
568 { OSSL_FUNC_ASYM_CIPHER_DUPCTX
, (void (*)(void))rsa_dupctx
},
569 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS
,
570 (void (*)(void))rsa_get_ctx_params
},
571 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS
,
572 (void (*)(void))rsa_gettable_ctx_params
},
573 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS
,
574 (void (*)(void))rsa_set_ctx_params
},
575 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS
,
576 (void (*)(void))rsa_settable_ctx_params
},