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"
34 static OSSL_FUNC_asym_cipher_newctx_fn rsa_newctx
;
35 static OSSL_FUNC_asym_cipher_encrypt_init_fn rsa_init
;
36 static OSSL_FUNC_asym_cipher_encrypt_fn rsa_encrypt
;
37 static OSSL_FUNC_asym_cipher_decrypt_init_fn rsa_init
;
38 static OSSL_FUNC_asym_cipher_decrypt_fn rsa_decrypt
;
39 static OSSL_FUNC_asym_cipher_freectx_fn rsa_freectx
;
40 static OSSL_FUNC_asym_cipher_dupctx_fn rsa_dupctx
;
41 static OSSL_FUNC_asym_cipher_get_ctx_params_fn rsa_get_ctx_params
;
42 static OSSL_FUNC_asym_cipher_gettable_ctx_params_fn rsa_gettable_ctx_params
;
43 static OSSL_FUNC_asym_cipher_set_ctx_params_fn rsa_set_ctx_params
;
44 static OSSL_FUNC_asym_cipher_settable_ctx_params_fn rsa_settable_ctx_params
;
46 static OSSL_ITEM padding_item
[] = {
47 { RSA_PKCS1_PADDING
, OSSL_PKEY_RSA_PAD_MODE_PKCSV15
},
48 { RSA_SSLV23_PADDING
, OSSL_PKEY_RSA_PAD_MODE_SSLV23
},
49 { RSA_NO_PADDING
, OSSL_PKEY_RSA_PAD_MODE_NONE
},
50 { RSA_PKCS1_OAEP_PADDING
, OSSL_PKEY_RSA_PAD_MODE_OAEP
}, /* Correct spelling first */
51 { RSA_PKCS1_OAEP_PADDING
, "oeap" },
52 { RSA_X931_PADDING
, OSSL_PKEY_RSA_PAD_MODE_X931
},
57 * What's passed as an actual key is defined by the KEYMGMT interface.
58 * We happen to know that our KEYMGMT simply passes RSA structures, so
59 * we use that here too.
66 /* OAEP message digest */
68 /* message digest for MGF1 */
71 unsigned char *oaep_label
;
74 unsigned int client_version
;
75 unsigned int alt_version
;
78 static void *rsa_newctx(void *provctx
)
80 PROV_RSA_CTX
*prsactx
= OPENSSL_zalloc(sizeof(PROV_RSA_CTX
));
84 prsactx
->libctx
= PROV_LIBRARY_CONTEXT_OF(provctx
);
89 static int rsa_init(void *vprsactx
, void *vrsa
)
91 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
93 if (prsactx
== NULL
|| vrsa
== NULL
|| !RSA_up_ref(vrsa
))
95 RSA_free(prsactx
->rsa
);
98 switch (RSA_test_flags(prsactx
->rsa
, RSA_FLAG_TYPE_MASK
)) {
99 case RSA_FLAG_TYPE_RSA
:
100 prsactx
->pad_mode
= RSA_PKCS1_PADDING
;
103 ERR_raise(ERR_LIB_PROV
, PROV_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE
);
110 static int rsa_encrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
111 size_t outsize
, const unsigned char *in
, size_t inlen
)
113 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
117 size_t len
= RSA_size(prsactx
->rsa
);
120 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
127 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
128 int rsasize
= RSA_size(prsactx
->rsa
);
131 if ((tbuf
= OPENSSL_malloc(rsasize
)) == NULL
) {
132 PROVerr(0, ERR_R_MALLOC_FAILURE
);
135 if (prsactx
->oaep_md
== NULL
) {
137 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
138 PROVerr(0, ERR_R_INTERNAL_ERROR
);
142 rsa_padding_add_PKCS1_OAEP_mgf1_with_libctx(prsactx
->libctx
, tbuf
,
145 prsactx
->oaep_labellen
,
153 ret
= RSA_public_encrypt(rsasize
, tbuf
, out
, prsactx
->rsa
,
157 ret
= RSA_public_encrypt(inlen
, in
, out
, prsactx
->rsa
,
160 /* A ret value of 0 is not an error */
167 static int rsa_decrypt(void *vprsactx
, unsigned char *out
, size_t *outlen
,
168 size_t outsize
, const unsigned char *in
, size_t inlen
)
170 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
172 size_t len
= RSA_size(prsactx
->rsa
);
174 if (prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
176 *outlen
= SSL_MAX_MASTER_KEY_LENGTH
;
179 if (outsize
< SSL_MAX_MASTER_KEY_LENGTH
) {
180 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
186 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_KEY
);
194 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_LENGTH
);
199 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
200 || prsactx
->pad_mode
== RSA_PKCS1_WITH_TLS_PADDING
) {
203 if ((tbuf
= OPENSSL_malloc(len
)) == NULL
) {
204 PROVerr(0, ERR_R_MALLOC_FAILURE
);
207 ret
= RSA_private_decrypt(inlen
, in
, tbuf
, prsactx
->rsa
,
210 * With no padding then, on success ret should be len, otherwise an
211 * error occurred (non-constant time)
213 if (ret
!= (int)len
) {
215 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_DECRYPT
);
218 if (prsactx
->pad_mode
== RSA_PKCS1_OAEP_PADDING
) {
219 if (prsactx
->oaep_md
== NULL
) {
220 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA-1", NULL
);
221 if (prsactx
->oaep_md
== NULL
) {
222 PROVerr(0, ERR_R_INTERNAL_ERROR
);
226 ret
= RSA_padding_check_PKCS1_OAEP_mgf1(out
, outsize
, tbuf
,
229 prsactx
->oaep_labellen
,
233 /* RSA_PKCS1_WITH_TLS_PADDING */
234 if (prsactx
->client_version
<= 0) {
235 ERR_raise(ERR_LIB_PROV
, PROV_R_BAD_TLS_CLIENT_VERSION
);
238 ret
= rsa_padding_check_PKCS1_type_2_TLS(prsactx
->libctx
, out
,
241 prsactx
->client_version
,
242 prsactx
->alt_version
);
246 ret
= RSA_private_decrypt(inlen
, in
, out
, prsactx
->rsa
,
249 *outlen
= constant_time_select_s(constant_time_msb_s(ret
), *outlen
, ret
);
250 ret
= constant_time_select_int(constant_time_msb(ret
), 0, 1);
254 static void rsa_freectx(void *vprsactx
)
256 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
258 RSA_free(prsactx
->rsa
);
260 EVP_MD_free(prsactx
->oaep_md
);
261 EVP_MD_free(prsactx
->mgf1_md
);
262 OPENSSL_free(prsactx
->oaep_label
);
264 OPENSSL_free(prsactx
);
267 static void *rsa_dupctx(void *vprsactx
)
269 PROV_RSA_CTX
*srcctx
= (PROV_RSA_CTX
*)vprsactx
;
270 PROV_RSA_CTX
*dstctx
;
272 dstctx
= OPENSSL_zalloc(sizeof(*srcctx
));
277 if (dstctx
->rsa
!= NULL
&& !RSA_up_ref(dstctx
->rsa
)) {
278 OPENSSL_free(dstctx
);
282 if (dstctx
->oaep_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->oaep_md
)) {
283 RSA_free(dstctx
->rsa
);
284 OPENSSL_free(dstctx
);
288 if (dstctx
->mgf1_md
!= NULL
&& !EVP_MD_up_ref(dstctx
->mgf1_md
)) {
289 RSA_free(dstctx
->rsa
);
290 EVP_MD_free(dstctx
->oaep_md
);
291 OPENSSL_free(dstctx
);
298 static int rsa_get_ctx_params(void *vprsactx
, OSSL_PARAM
*params
)
300 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
303 if (prsactx
== NULL
|| params
== NULL
)
306 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
308 switch (p
->data_type
) {
309 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
310 if (!OSSL_PARAM_set_int(p
, prsactx
->pad_mode
))
313 case OSSL_PARAM_UTF8_STRING
:
316 const char *word
= NULL
;
318 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
319 if (prsactx
->pad_mode
== (int)padding_item
[i
].id
) {
320 word
= padding_item
[i
].ptr
;
326 if (!OSSL_PARAM_set_utf8_string(p
, word
))
329 ERR_raise(ERR_LIB_PROV
, ERR_R_INTERNAL_ERROR
);
337 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
338 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_string(p
, prsactx
->oaep_md
== NULL
340 : EVP_MD_name(prsactx
->oaep_md
)))
343 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
345 EVP_MD
*mgf1_md
= prsactx
->mgf1_md
== NULL
? prsactx
->oaep_md
348 if (!OSSL_PARAM_set_utf8_string(p
, mgf1_md
== NULL
350 : EVP_MD_name(mgf1_md
)))
354 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
355 if (p
!= NULL
&& !OSSL_PARAM_set_octet_ptr(p
, prsactx
->oaep_label
, 0))
358 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN
);
359 if (p
!= NULL
&& !OSSL_PARAM_set_size_t(p
, prsactx
->oaep_labellen
))
362 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
363 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->client_version
))
366 p
= OSSL_PARAM_locate(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
367 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, prsactx
->alt_version
))
373 static const OSSL_PARAM known_gettable_ctx_params
[] = {
374 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
375 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
376 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
377 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, OSSL_PARAM_OCTET_PTR
,
379 OSSL_PARAM_size_t(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN
, NULL
),
380 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
381 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
385 static const OSSL_PARAM
*rsa_gettable_ctx_params(void)
387 return known_gettable_ctx_params
;
390 static int rsa_set_ctx_params(void *vprsactx
, const OSSL_PARAM params
[])
392 PROV_RSA_CTX
*prsactx
= (PROV_RSA_CTX
*)vprsactx
;
394 char mdname
[OSSL_MAX_NAME_SIZE
];
395 char mdprops
[OSSL_MAX_PROPQUERY_SIZE
] = { '\0' };
398 if (prsactx
== NULL
|| params
== NULL
)
401 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
);
403 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
407 p
= OSSL_PARAM_locate_const(params
,
408 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS
);
410 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
414 EVP_MD_free(prsactx
->oaep_md
);
415 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, mdprops
);
417 if (prsactx
->oaep_md
== NULL
)
421 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_PAD_MODE
);
425 switch (p
->data_type
) {
426 case OSSL_PARAM_INTEGER
: /* Support for legacy pad mode number */
427 if (!OSSL_PARAM_get_int(p
, &pad_mode
))
430 case OSSL_PARAM_UTF8_STRING
:
437 for (i
= 0; padding_item
[i
].id
!= 0; i
++) {
438 if (strcmp(p
->data
, padding_item
[i
].ptr
) == 0) {
439 pad_mode
= padding_item
[i
].id
;
450 * PSS padding is for signatures only so is not compatible with
451 * asymmetric cipher use.
453 if (pad_mode
== RSA_PKCS1_PSS_PADDING
)
455 if (pad_mode
== RSA_PKCS1_OAEP_PADDING
&& prsactx
->oaep_md
== NULL
) {
456 prsactx
->oaep_md
= EVP_MD_fetch(prsactx
->libctx
, "SHA1", mdprops
);
457 if (prsactx
->oaep_md
== NULL
)
460 prsactx
->pad_mode
= pad_mode
;
463 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
);
465 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdname
)))
469 p
= OSSL_PARAM_locate_const(params
,
470 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
);
472 if (!OSSL_PARAM_get_utf8_string(p
, &str
, sizeof(mdprops
)))
478 EVP_MD_free(prsactx
->mgf1_md
);
479 prsactx
->mgf1_md
= EVP_MD_fetch(prsactx
->libctx
, mdname
, str
);
481 if (prsactx
->mgf1_md
== NULL
)
485 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
);
487 void *tmp_label
= NULL
;
490 if (!OSSL_PARAM_get_octet_string(p
, &tmp_label
, 0, &tmp_labellen
))
492 OPENSSL_free(prsactx
->oaep_label
);
493 prsactx
->oaep_label
= (unsigned char *)tmp_label
;
494 prsactx
->oaep_labellen
= tmp_labellen
;
497 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
);
499 unsigned int client_version
;
501 if (!OSSL_PARAM_get_uint(p
, &client_version
))
503 prsactx
->client_version
= client_version
;
506 p
= OSSL_PARAM_locate_const(params
, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
);
508 unsigned int alt_version
;
510 if (!OSSL_PARAM_get_uint(p
, &alt_version
))
512 prsactx
->alt_version
= alt_version
;
518 static const OSSL_PARAM known_settable_ctx_params
[] = {
519 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST
, NULL
, 0),
520 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE
, NULL
, 0),
521 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST
, NULL
, 0),
522 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS
, NULL
, 0),
523 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL
, NULL
, 0),
524 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION
, NULL
),
525 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION
, NULL
),
529 static const OSSL_PARAM
*rsa_settable_ctx_params(void)
531 return known_settable_ctx_params
;
534 const OSSL_DISPATCH rsa_asym_cipher_functions
[] = {
535 { OSSL_FUNC_ASYM_CIPHER_NEWCTX
, (void (*)(void))rsa_newctx
},
536 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT
, (void (*)(void))rsa_init
},
537 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT
, (void (*)(void))rsa_encrypt
},
538 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT
, (void (*)(void))rsa_init
},
539 { OSSL_FUNC_ASYM_CIPHER_DECRYPT
, (void (*)(void))rsa_decrypt
},
540 { OSSL_FUNC_ASYM_CIPHER_FREECTX
, (void (*)(void))rsa_freectx
},
541 { OSSL_FUNC_ASYM_CIPHER_DUPCTX
, (void (*)(void))rsa_dupctx
},
542 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS
,
543 (void (*)(void))rsa_get_ctx_params
},
544 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS
,
545 (void (*)(void))rsa_gettable_ctx_params
},
546 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS
,
547 (void (*)(void))rsa_set_ctx_params
},
548 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS
,
549 (void (*)(void))rsa_settable_ctx_params
},