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_LIBRARY_CONTEXT_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 (!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 PROVerr(0, ERR_R_MALLOC_FAILURE);
161 if (prsactx->oaep_md == NULL) {
163 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA-1", NULL);
164 PROVerr(0, ERR_R_INTERNAL_ERROR);
168 rsa_padding_add_PKCS1_OAEP_mgf1_ex(prsactx->libctx, tbuf, rsasize,
169 in, inlen, prsactx->oaep_label,
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 PROVerr(0, 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 PROVerr(0, 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 = rsa_padding_check_PKCS1_type_2_TLS(prsactx->libctx, out,
269 prsactx->client_version,
270 prsactx->alt_version);
274 ret = RSA_private_decrypt(inlen, in, out, prsactx->rsa,
277 *outlen = constant_time_select_s(constant_time_msb_s(ret), *outlen, ret);
278 ret = constant_time_select_int(constant_time_msb(ret), 0, 1);
282 static void rsa_freectx(void *vprsactx)
284 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
286 RSA_free(prsactx->rsa);
288 EVP_MD_free(prsactx->oaep_md);
289 EVP_MD_free(prsactx->mgf1_md);
290 OPENSSL_free(prsactx->oaep_label);
292 OPENSSL_free(prsactx);
295 static void *rsa_dupctx(void *vprsactx)
297 PROV_RSA_CTX *srcctx = (PROV_RSA_CTX *)vprsactx;
298 PROV_RSA_CTX *dstctx;
300 if (!ossl_prov_is_running())
303 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
308 if (dstctx->rsa != NULL && !RSA_up_ref(dstctx->rsa)) {
309 OPENSSL_free(dstctx);
313 if (dstctx->oaep_md != NULL && !EVP_MD_up_ref(dstctx->oaep_md)) {
314 RSA_free(dstctx->rsa);
315 OPENSSL_free(dstctx);
319 if (dstctx->mgf1_md != NULL && !EVP_MD_up_ref(dstctx->mgf1_md)) {
320 RSA_free(dstctx->rsa);
321 EVP_MD_free(dstctx->oaep_md);
322 OPENSSL_free(dstctx);
329 static int rsa_get_ctx_params(void *vprsactx, OSSL_PARAM *params)
331 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
334 if (prsactx == NULL || params == NULL)
337 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
339 switch (p->data_type) {
340 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
341 if (!OSSL_PARAM_set_int(p, prsactx->pad_mode))
344 case OSSL_PARAM_UTF8_STRING:
347 const char *word = NULL;
349 for (i = 0; padding_item[i].id != 0; i++) {
350 if (prsactx->pad_mode == (int)padding_item[i].id) {
351 word = padding_item[i].ptr;
357 if (!OSSL_PARAM_set_utf8_string(p, word))
360 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
368 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
369 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->oaep_md == NULL
371 : EVP_MD_name(prsactx->oaep_md)))
374 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
376 EVP_MD *mgf1_md = prsactx->mgf1_md == NULL ? prsactx->oaep_md
379 if (!OSSL_PARAM_set_utf8_string(p, mgf1_md == NULL
381 : EVP_MD_name(mgf1_md)))
385 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
386 if (p != NULL && !OSSL_PARAM_set_octet_ptr(p, prsactx->oaep_label, 0))
389 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN);
390 if (p != NULL && !OSSL_PARAM_set_size_t(p, prsactx->oaep_labellen))
393 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
394 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->client_version))
397 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
398 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->alt_version))
404 static const OSSL_PARAM known_gettable_ctx_params[] = {
405 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
406 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
407 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
408 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_PTR,
410 OSSL_PARAM_size_t(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN, NULL),
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 *provctx)
418 return known_gettable_ctx_params;
421 static int rsa_set_ctx_params(void *vprsactx, const OSSL_PARAM params[])
423 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
425 char mdname[OSSL_MAX_NAME_SIZE];
426 char mdprops[OSSL_MAX_PROPQUERY_SIZE] = { '\0' };
429 if (prsactx == NULL || params == NULL)
432 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
434 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
438 p = OSSL_PARAM_locate_const(params,
439 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS);
441 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
445 EVP_MD_free(prsactx->oaep_md);
446 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, mdname, mdprops);
448 if (prsactx->oaep_md == NULL)
452 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
456 switch (p->data_type) {
457 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
458 if (!OSSL_PARAM_get_int(p, &pad_mode))
461 case OSSL_PARAM_UTF8_STRING:
468 for (i = 0; padding_item[i].id != 0; i++) {
469 if (strcmp(p->data, padding_item[i].ptr) == 0) {
470 pad_mode = padding_item[i].id;
481 * PSS padding is for signatures only so is not compatible with
482 * asymmetric cipher use.
484 if (pad_mode == RSA_PKCS1_PSS_PADDING)
486 if (pad_mode == RSA_PKCS1_OAEP_PADDING && prsactx->oaep_md == NULL) {
487 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA1", mdprops);
488 if (prsactx->oaep_md == NULL)
491 prsactx->pad_mode = pad_mode;
494 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
496 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
500 p = OSSL_PARAM_locate_const(params,
501 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS);
503 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
509 EVP_MD_free(prsactx->mgf1_md);
510 prsactx->mgf1_md = EVP_MD_fetch(prsactx->libctx, mdname, str);
512 if (prsactx->mgf1_md == NULL)
516 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
518 void *tmp_label = NULL;
521 if (!OSSL_PARAM_get_octet_string(p, &tmp_label, 0, &tmp_labellen))
523 OPENSSL_free(prsactx->oaep_label);
524 prsactx->oaep_label = (unsigned char *)tmp_label;
525 prsactx->oaep_labellen = tmp_labellen;
528 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
530 unsigned int client_version;
532 if (!OSSL_PARAM_get_uint(p, &client_version))
534 prsactx->client_version = client_version;
537 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
539 unsigned int alt_version;
541 if (!OSSL_PARAM_get_uint(p, &alt_version))
543 prsactx->alt_version = alt_version;
549 static const OSSL_PARAM known_settable_ctx_params[] = {
550 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
551 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
552 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
553 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS, NULL, 0),
554 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, NULL, 0),
555 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
556 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
560 static const OSSL_PARAM *rsa_settable_ctx_params(ossl_unused void *provctx)
562 return known_settable_ctx_params;
565 const OSSL_DISPATCH ossl_rsa_asym_cipher_functions[] = {
566 { OSSL_FUNC_ASYM_CIPHER_NEWCTX, (void (*)(void))rsa_newctx },
567 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT, (void (*)(void))rsa_encrypt_init },
568 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT, (void (*)(void))rsa_encrypt },
569 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT, (void (*)(void))rsa_decrypt_init },
570 { OSSL_FUNC_ASYM_CIPHER_DECRYPT, (void (*)(void))rsa_decrypt },
571 { OSSL_FUNC_ASYM_CIPHER_FREECTX, (void (*)(void))rsa_freectx },
572 { OSSL_FUNC_ASYM_CIPHER_DUPCTX, (void (*)(void))rsa_dupctx },
573 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS,
574 (void (*)(void))rsa_get_ctx_params },
575 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS,
576 (void (*)(void))rsa_gettable_ctx_params },
577 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS,
578 (void (*)(void))rsa_set_ctx_params },
579 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS,
580 (void (*)(void))rsa_settable_ctx_params },