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_with_libctx(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 PROVerr(0, 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 PROVerr(0, 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 = rsa_padding_check_PKCS1_type_2_TLS(prsactx->libctx, out,
270 prsactx->client_version,
271 prsactx->alt_version);
275 ret = RSA_private_decrypt(inlen, in, out, prsactx->rsa,
278 *outlen = constant_time_select_s(constant_time_msb_s(ret), *outlen, ret);
279 ret = constant_time_select_int(constant_time_msb(ret), 0, 1);
283 static void rsa_freectx(void *vprsactx)
285 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
287 RSA_free(prsactx->rsa);
289 EVP_MD_free(prsactx->oaep_md);
290 EVP_MD_free(prsactx->mgf1_md);
291 OPENSSL_free(prsactx->oaep_label);
293 OPENSSL_free(prsactx);
296 static void *rsa_dupctx(void *vprsactx)
298 PROV_RSA_CTX *srcctx = (PROV_RSA_CTX *)vprsactx;
299 PROV_RSA_CTX *dstctx;
301 if (!ossl_prov_is_running())
304 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
309 if (dstctx->rsa != NULL && !RSA_up_ref(dstctx->rsa)) {
310 OPENSSL_free(dstctx);
314 if (dstctx->oaep_md != NULL && !EVP_MD_up_ref(dstctx->oaep_md)) {
315 RSA_free(dstctx->rsa);
316 OPENSSL_free(dstctx);
320 if (dstctx->mgf1_md != NULL && !EVP_MD_up_ref(dstctx->mgf1_md)) {
321 RSA_free(dstctx->rsa);
322 EVP_MD_free(dstctx->oaep_md);
323 OPENSSL_free(dstctx);
330 static int rsa_get_ctx_params(void *vprsactx, OSSL_PARAM *params)
332 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
335 if (prsactx == NULL || params == NULL)
338 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
340 switch (p->data_type) {
341 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
342 if (!OSSL_PARAM_set_int(p, prsactx->pad_mode))
345 case OSSL_PARAM_UTF8_STRING:
348 const char *word = NULL;
350 for (i = 0; padding_item[i].id != 0; i++) {
351 if (prsactx->pad_mode == (int)padding_item[i].id) {
352 word = padding_item[i].ptr;
358 if (!OSSL_PARAM_set_utf8_string(p, word))
361 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
369 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
370 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->oaep_md == NULL
372 : EVP_MD_name(prsactx->oaep_md)))
375 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
377 EVP_MD *mgf1_md = prsactx->mgf1_md == NULL ? prsactx->oaep_md
380 if (!OSSL_PARAM_set_utf8_string(p, mgf1_md == NULL
382 : EVP_MD_name(mgf1_md)))
386 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
387 if (p != NULL && !OSSL_PARAM_set_octet_ptr(p, prsactx->oaep_label, 0))
390 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN);
391 if (p != NULL && !OSSL_PARAM_set_size_t(p, 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_size_t(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN, NULL),
412 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
413 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
417 static const OSSL_PARAM *rsa_gettable_ctx_params(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' };
430 if (prsactx == NULL || params == NULL)
433 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
435 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
439 p = OSSL_PARAM_locate_const(params,
440 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS);
442 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
446 EVP_MD_free(prsactx->oaep_md);
447 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, mdname, mdprops);
449 if (prsactx->oaep_md == NULL)
453 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
457 switch (p->data_type) {
458 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
459 if (!OSSL_PARAM_get_int(p, &pad_mode))
462 case OSSL_PARAM_UTF8_STRING:
469 for (i = 0; padding_item[i].id != 0; i++) {
470 if (strcmp(p->data, padding_item[i].ptr) == 0) {
471 pad_mode = padding_item[i].id;
482 * PSS padding is for signatures only so is not compatible with
483 * asymmetric cipher use.
485 if (pad_mode == RSA_PKCS1_PSS_PADDING)
487 if (pad_mode == RSA_PKCS1_OAEP_PADDING && prsactx->oaep_md == NULL) {
488 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA1", mdprops);
489 if (prsactx->oaep_md == NULL)
492 prsactx->pad_mode = pad_mode;
495 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
497 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
501 p = OSSL_PARAM_locate_const(params,
502 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS);
504 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
510 EVP_MD_free(prsactx->mgf1_md);
511 prsactx->mgf1_md = EVP_MD_fetch(prsactx->libctx, mdname, str);
513 if (prsactx->mgf1_md == NULL)
517 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
519 void *tmp_label = NULL;
522 if (!OSSL_PARAM_get_octet_string(p, &tmp_label, 0, &tmp_labellen))
524 OPENSSL_free(prsactx->oaep_label);
525 prsactx->oaep_label = (unsigned char *)tmp_label;
526 prsactx->oaep_labellen = tmp_labellen;
529 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
531 unsigned int client_version;
533 if (!OSSL_PARAM_get_uint(p, &client_version))
535 prsactx->client_version = client_version;
538 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
540 unsigned int alt_version;
542 if (!OSSL_PARAM_get_uint(p, &alt_version))
544 prsactx->alt_version = alt_version;
550 static const OSSL_PARAM known_settable_ctx_params[] = {
551 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
552 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
553 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
554 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS, NULL, 0),
555 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, NULL, 0),
556 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
557 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
561 static const OSSL_PARAM *rsa_settable_ctx_params(ossl_unused void *provctx)
563 return known_settable_ctx_params;
566 const OSSL_DISPATCH rsa_asym_cipher_functions[] = {
567 { OSSL_FUNC_ASYM_CIPHER_NEWCTX, (void (*)(void))rsa_newctx },
568 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT, (void (*)(void))rsa_encrypt_init },
569 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT, (void (*)(void))rsa_encrypt },
570 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT, (void (*)(void))rsa_decrypt_init },
571 { OSSL_FUNC_ASYM_CIPHER_DECRYPT, (void (*)(void))rsa_decrypt },
572 { OSSL_FUNC_ASYM_CIPHER_FREECTX, (void (*)(void))rsa_freectx },
573 { OSSL_FUNC_ASYM_CIPHER_DUPCTX, (void (*)(void))rsa_dupctx },
574 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS,
575 (void (*)(void))rsa_get_ctx_params },
576 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS,
577 (void (*)(void))rsa_gettable_ctx_params },
578 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS,
579 (void (*)(void))rsa_set_ctx_params },
580 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS,
581 (void (*)(void))rsa_settable_ctx_params },