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/prov_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, const OSSL_PARAM params[],
97 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
99 if (!ossl_prov_is_running() || prsactx == NULL || vrsa == NULL)
102 if (!ossl_rsa_check_key(prsactx->libctx, vrsa, operation))
105 if (!RSA_up_ref(vrsa))
107 RSA_free(prsactx->rsa);
109 prsactx->operation = operation;
111 switch (RSA_test_flags(prsactx->rsa, RSA_FLAG_TYPE_MASK)) {
112 case RSA_FLAG_TYPE_RSA:
113 prsactx->pad_mode = RSA_PKCS1_PADDING;
116 /* This should not happen due to the check above */
117 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
120 return rsa_set_ctx_params(prsactx, params);
123 static int rsa_encrypt_init(void *vprsactx, void *vrsa,
124 const OSSL_PARAM params[])
126 return rsa_init(vprsactx, vrsa, params, EVP_PKEY_OP_ENCRYPT);
129 static int rsa_decrypt_init(void *vprsactx, void *vrsa,
130 const OSSL_PARAM params[])
132 return rsa_init(vprsactx, vrsa, params, EVP_PKEY_OP_DECRYPT);
135 static int rsa_encrypt(void *vprsactx, unsigned char *out, size_t *outlen,
136 size_t outsize, const unsigned char *in, size_t inlen)
138 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
141 if (!ossl_prov_is_running())
145 size_t len = RSA_size(prsactx->rsa);
148 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
155 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING) {
156 int rsasize = RSA_size(prsactx->rsa);
159 if ((tbuf = OPENSSL_malloc(rsasize)) == NULL) {
160 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
163 if (prsactx->oaep_md == NULL) {
165 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA-1", NULL);
166 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
170 ossl_rsa_padding_add_PKCS1_OAEP_mgf1_ex(prsactx->libctx, tbuf,
173 prsactx->oaep_labellen,
181 ret = RSA_public_encrypt(rsasize, tbuf, out, prsactx->rsa,
185 ret = RSA_public_encrypt(inlen, in, out, prsactx->rsa,
188 /* A ret value of 0 is not an error */
195 static int rsa_decrypt(void *vprsactx, unsigned char *out, size_t *outlen,
196 size_t outsize, const unsigned char *in, size_t inlen)
198 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
200 size_t len = RSA_size(prsactx->rsa);
202 if (!ossl_prov_is_running())
205 if (prsactx->pad_mode == RSA_PKCS1_WITH_TLS_PADDING) {
207 *outlen = SSL_MAX_MASTER_KEY_LENGTH;
210 if (outsize < SSL_MAX_MASTER_KEY_LENGTH) {
211 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
217 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
225 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
230 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING
231 || prsactx->pad_mode == RSA_PKCS1_WITH_TLS_PADDING) {
234 if ((tbuf = OPENSSL_malloc(len)) == NULL) {
235 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
238 ret = RSA_private_decrypt(inlen, in, tbuf, prsactx->rsa,
241 * With no padding then, on success ret should be len, otherwise an
242 * error occurred (non-constant time)
244 if (ret != (int)len) {
246 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_DECRYPT);
249 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING) {
250 if (prsactx->oaep_md == NULL) {
251 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA-1", NULL);
252 if (prsactx->oaep_md == NULL) {
254 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
258 ret = RSA_padding_check_PKCS1_OAEP_mgf1(out, outsize, tbuf,
261 prsactx->oaep_labellen,
265 /* RSA_PKCS1_WITH_TLS_PADDING */
266 if (prsactx->client_version <= 0) {
267 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_TLS_CLIENT_VERSION);
271 ret = ossl_rsa_padding_check_PKCS1_type_2_TLS(
272 prsactx->libctx, out, outsize, tbuf, len,
273 prsactx->client_version, prsactx->alt_version);
277 ret = RSA_private_decrypt(inlen, in, out, prsactx->rsa,
280 *outlen = constant_time_select_s(constant_time_msb_s(ret), *outlen, ret);
281 ret = constant_time_select_int(constant_time_msb(ret), 0, 1);
285 static void rsa_freectx(void *vprsactx)
287 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
289 RSA_free(prsactx->rsa);
291 EVP_MD_free(prsactx->oaep_md);
292 EVP_MD_free(prsactx->mgf1_md);
293 OPENSSL_free(prsactx->oaep_label);
295 OPENSSL_free(prsactx);
298 static void *rsa_dupctx(void *vprsactx)
300 PROV_RSA_CTX *srcctx = (PROV_RSA_CTX *)vprsactx;
301 PROV_RSA_CTX *dstctx;
303 if (!ossl_prov_is_running())
306 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
311 if (dstctx->rsa != NULL && !RSA_up_ref(dstctx->rsa)) {
312 OPENSSL_free(dstctx);
316 if (dstctx->oaep_md != NULL && !EVP_MD_up_ref(dstctx->oaep_md)) {
317 RSA_free(dstctx->rsa);
318 OPENSSL_free(dstctx);
322 if (dstctx->mgf1_md != NULL && !EVP_MD_up_ref(dstctx->mgf1_md)) {
323 RSA_free(dstctx->rsa);
324 EVP_MD_free(dstctx->oaep_md);
325 OPENSSL_free(dstctx);
332 static int rsa_get_ctx_params(void *vprsactx, OSSL_PARAM *params)
334 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
340 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
342 switch (p->data_type) {
343 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
344 if (!OSSL_PARAM_set_int(p, prsactx->pad_mode))
347 case OSSL_PARAM_UTF8_STRING:
350 const char *word = NULL;
352 for (i = 0; padding_item[i].id != 0; i++) {
353 if (prsactx->pad_mode == (int)padding_item[i].id) {
354 word = padding_item[i].ptr;
360 if (!OSSL_PARAM_set_utf8_string(p, word))
363 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
371 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
372 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->oaep_md == NULL
374 : EVP_MD_get0_name(prsactx->oaep_md)))
377 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
379 EVP_MD *mgf1_md = prsactx->mgf1_md == NULL ? prsactx->oaep_md
382 if (!OSSL_PARAM_set_utf8_string(p, mgf1_md == NULL
384 : EVP_MD_get0_name(mgf1_md)))
388 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
390 !OSSL_PARAM_set_octet_ptr(p, prsactx->oaep_label,
391 prsactx->oaep_labellen))
394 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
395 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->client_version))
398 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
399 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->alt_version))
405 static const OSSL_PARAM known_gettable_ctx_params[] = {
406 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
407 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
408 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
409 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_PTR,
411 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
412 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
416 static const OSSL_PARAM *rsa_gettable_ctx_params(ossl_unused void *vprsactx,
417 ossl_unused void *provctx)
419 return known_gettable_ctx_params;
422 static int rsa_set_ctx_params(void *vprsactx, const OSSL_PARAM params[])
424 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
426 char mdname[OSSL_MAX_NAME_SIZE];
427 char mdprops[OSSL_MAX_PROPQUERY_SIZE] = { '\0' };
435 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
437 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
441 p = OSSL_PARAM_locate_const(params,
442 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS);
444 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
448 EVP_MD_free(prsactx->oaep_md);
449 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, mdname, mdprops);
451 if (prsactx->oaep_md == NULL)
455 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
459 switch (p->data_type) {
460 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
461 if (!OSSL_PARAM_get_int(p, &pad_mode))
464 case OSSL_PARAM_UTF8_STRING:
471 for (i = 0; padding_item[i].id != 0; i++) {
472 if (strcmp(p->data, padding_item[i].ptr) == 0) {
473 pad_mode = padding_item[i].id;
484 * PSS padding is for signatures only so is not compatible with
485 * asymmetric cipher use.
487 if (pad_mode == RSA_PKCS1_PSS_PADDING)
489 if (pad_mode == RSA_PKCS1_OAEP_PADDING && prsactx->oaep_md == NULL) {
490 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA1", mdprops);
491 if (prsactx->oaep_md == NULL)
494 prsactx->pad_mode = pad_mode;
497 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
499 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
503 p = OSSL_PARAM_locate_const(params,
504 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS);
506 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
512 EVP_MD_free(prsactx->mgf1_md);
513 prsactx->mgf1_md = EVP_MD_fetch(prsactx->libctx, mdname, str);
515 if (prsactx->mgf1_md == NULL)
519 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
521 void *tmp_label = NULL;
524 if (!OSSL_PARAM_get_octet_string(p, &tmp_label, 0, &tmp_labellen))
526 OPENSSL_free(prsactx->oaep_label);
527 prsactx->oaep_label = (unsigned char *)tmp_label;
528 prsactx->oaep_labellen = tmp_labellen;
531 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
533 unsigned int client_version;
535 if (!OSSL_PARAM_get_uint(p, &client_version))
537 prsactx->client_version = client_version;
540 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
542 unsigned int alt_version;
544 if (!OSSL_PARAM_get_uint(p, &alt_version))
546 prsactx->alt_version = alt_version;
552 static const OSSL_PARAM known_settable_ctx_params[] = {
553 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
554 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
555 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
556 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS, NULL, 0),
557 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, NULL, 0),
558 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
559 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
563 static const OSSL_PARAM *rsa_settable_ctx_params(ossl_unused void *vprsactx,
564 ossl_unused void *provctx)
566 return known_settable_ctx_params;
569 const OSSL_DISPATCH ossl_rsa_asym_cipher_functions[] = {
570 { OSSL_FUNC_ASYM_CIPHER_NEWCTX, (void (*)(void))rsa_newctx },
571 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT, (void (*)(void))rsa_encrypt_init },
572 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT, (void (*)(void))rsa_encrypt },
573 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT, (void (*)(void))rsa_decrypt_init },
574 { OSSL_FUNC_ASYM_CIPHER_DECRYPT, (void (*)(void))rsa_decrypt },
575 { OSSL_FUNC_ASYM_CIPHER_FREECTX, (void (*)(void))rsa_freectx },
576 { OSSL_FUNC_ASYM_CIPHER_DUPCTX, (void (*)(void))rsa_dupctx },
577 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS,
578 (void (*)(void))rsa_get_ctx_params },
579 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS,
580 (void (*)(void))rsa_gettable_ctx_params },
581 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS,
582 (void (*)(void))rsa_set_ctx_params },
583 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS,
584 (void (*)(void))rsa_settable_ctx_params },