2 * Copyright 2019 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
10 #include <openssl/crypto.h>
11 #include <openssl/evp.h>
12 #include <openssl/core_numbers.h>
13 #include <openssl/core_names.h>
14 #include <openssl/rsa.h>
15 #include <openssl/params.h>
16 #include <openssl/err.h>
17 /* Just for SSL_MAX_MASTER_KEY_LENGTH */
18 #include <openssl/ssl.h>
19 #include "internal/constant_time.h"
20 #include "internal/sizes.h"
21 #include "crypto/rsa.h"
22 #include "prov/providercommonerr.h"
23 #include "prov/provider_ctx.h"
24 #include "prov/implementations.h"
28 static OSSL_OP_asym_cipher_newctx_fn rsa_newctx;
29 static OSSL_OP_asym_cipher_encrypt_init_fn rsa_init;
30 static OSSL_OP_asym_cipher_encrypt_fn rsa_encrypt;
31 static OSSL_OP_asym_cipher_decrypt_init_fn rsa_init;
32 static OSSL_OP_asym_cipher_decrypt_fn rsa_decrypt;
33 static OSSL_OP_asym_cipher_freectx_fn rsa_freectx;
34 static OSSL_OP_asym_cipher_dupctx_fn rsa_dupctx;
35 static OSSL_OP_asym_cipher_get_ctx_params_fn rsa_get_ctx_params;
36 static OSSL_OP_asym_cipher_gettable_ctx_params_fn rsa_gettable_ctx_params;
37 static OSSL_OP_asym_cipher_set_ctx_params_fn rsa_set_ctx_params;
38 static OSSL_OP_asym_cipher_settable_ctx_params_fn rsa_settable_ctx_params;
40 static OSSL_ITEM padding_item[] = {
41 { RSA_PKCS1_PADDING, "pkcs1" },
42 { RSA_SSLV23_PADDING, "sslv23" },
43 { RSA_NO_PADDING, "none" },
44 { RSA_PKCS1_OAEP_PADDING, "oaep" }, /* Correct spelling first */
45 { RSA_PKCS1_OAEP_PADDING, "oeap" },
46 { RSA_X931_PADDING, "x931" },
47 { RSA_PKCS1_PSS_PADDING, "pss" },
52 * What's passed as an actual key is defined by the KEYMGMT interface.
53 * We happen to know that our KEYMGMT simply passes RSA structures, so
54 * we use that here too.
61 /* OAEP message digest */
63 /* message digest for MGF1 */
66 unsigned char *oaep_label;
69 unsigned int client_version;
70 unsigned int alt_version;
73 static void *rsa_newctx(void *provctx)
75 PROV_RSA_CTX *prsactx = OPENSSL_zalloc(sizeof(PROV_RSA_CTX));
79 prsactx->libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
84 static int rsa_init(void *vprsactx, void *vrsa)
86 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
88 if (prsactx == NULL || vrsa == NULL || !RSA_up_ref(vrsa))
90 RSA_free(prsactx->rsa);
92 prsactx->pad_mode = RSA_PKCS1_PADDING;
96 static int rsa_encrypt(void *vprsactx, unsigned char *out, size_t *outlen,
97 size_t outsize, const unsigned char *in, size_t inlen)
99 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
103 size_t len = RSA_size(prsactx->rsa);
106 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
113 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING) {
114 int rsasize = RSA_size(prsactx->rsa);
117 if ((tbuf = OPENSSL_malloc(rsasize)) == NULL) {
118 PROVerr(0, ERR_R_MALLOC_FAILURE);
121 if (prsactx->oaep_md == NULL) {
123 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA-1", NULL);
124 PROVerr(0, ERR_R_INTERNAL_ERROR);
127 ret = RSA_padding_add_PKCS1_OAEP_mgf1(tbuf, rsasize, in, inlen,
129 prsactx->oaep_labellen,
137 ret = RSA_public_encrypt(rsasize, tbuf, out, prsactx->rsa,
141 ret = RSA_public_encrypt(inlen, in, out, prsactx->rsa,
144 /* A ret value of 0 is not an error */
151 static int rsa_decrypt(void *vprsactx, unsigned char *out, size_t *outlen,
152 size_t outsize, const unsigned char *in, size_t inlen)
154 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
156 size_t len = RSA_size(prsactx->rsa);
158 if (prsactx->pad_mode == RSA_PKCS1_WITH_TLS_PADDING) {
160 *outlen = SSL_MAX_MASTER_KEY_LENGTH;
163 if (outsize < SSL_MAX_MASTER_KEY_LENGTH) {
164 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
170 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY);
178 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
183 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING
184 || prsactx->pad_mode == RSA_PKCS1_WITH_TLS_PADDING) {
187 if ((tbuf = OPENSSL_malloc(len)) == NULL) {
188 PROVerr(0, ERR_R_MALLOC_FAILURE);
191 ret = RSA_private_decrypt(inlen, in, tbuf, prsactx->rsa,
194 * With no padding then, on success ret should be len, otherwise an
195 * error occurred (non-constant time)
197 if (ret != (int)len) {
199 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_DECRYPT);
202 if (prsactx->pad_mode == RSA_PKCS1_OAEP_PADDING) {
203 if (prsactx->oaep_md == NULL) {
204 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA-1", NULL);
205 if (prsactx->oaep_md == NULL) {
206 PROVerr(0, ERR_R_INTERNAL_ERROR);
210 ret = RSA_padding_check_PKCS1_OAEP_mgf1(out, outsize, tbuf,
213 prsactx->oaep_labellen,
217 /* RSA_PKCS1_WITH_TLS_PADDING */
218 if (prsactx->client_version <= 0) {
219 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_TLS_CLIENT_VERSION);
222 ret = rsa_padding_check_PKCS1_type_2_TLS(out, outsize,
224 prsactx->client_version,
225 prsactx->alt_version);
229 ret = RSA_private_decrypt(inlen, in, out, prsactx->rsa,
232 *outlen = constant_time_select_s(constant_time_msb_s(ret), *outlen, ret);
233 ret = constant_time_select_int(constant_time_msb(ret), 0, 1);
237 static void rsa_freectx(void *vprsactx)
239 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
241 RSA_free(prsactx->rsa);
243 EVP_MD_free(prsactx->oaep_md);
244 EVP_MD_free(prsactx->mgf1_md);
246 OPENSSL_free(prsactx);
249 static void *rsa_dupctx(void *vprsactx)
251 PROV_RSA_CTX *srcctx = (PROV_RSA_CTX *)vprsactx;
252 PROV_RSA_CTX *dstctx;
254 dstctx = OPENSSL_zalloc(sizeof(*srcctx));
259 if (dstctx->rsa != NULL && !RSA_up_ref(dstctx->rsa)) {
260 OPENSSL_free(dstctx);
264 if (dstctx->oaep_md != NULL && !EVP_MD_up_ref(dstctx->oaep_md)) {
265 RSA_free(dstctx->rsa);
266 OPENSSL_free(dstctx);
270 if (dstctx->mgf1_md != NULL && !EVP_MD_up_ref(dstctx->mgf1_md)) {
271 RSA_free(dstctx->rsa);
272 EVP_MD_free(dstctx->oaep_md);
273 OPENSSL_free(dstctx);
280 static int rsa_get_ctx_params(void *vprsactx, OSSL_PARAM *params)
282 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
285 if (prsactx == NULL || params == NULL)
288 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
290 switch (p->data_type) {
291 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
292 if (!OSSL_PARAM_set_int(p, prsactx->pad_mode))
295 case OSSL_PARAM_UTF8_STRING:
298 const char *word = NULL;
300 for (i = 0; padding_item[i].id != 0; i++) {
301 if (prsactx->pad_mode == (int)padding_item[i].id) {
302 word = padding_item[i].ptr;
308 if (!OSSL_PARAM_set_utf8_string(p, word))
311 ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
319 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
320 if (p != NULL && !OSSL_PARAM_set_utf8_string(p, prsactx->oaep_md == NULL
322 : EVP_MD_name(prsactx->oaep_md)))
325 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
327 EVP_MD *mgf1_md = prsactx->mgf1_md == NULL ? prsactx->oaep_md
330 if (!OSSL_PARAM_set_utf8_string(p, mgf1_md == NULL
332 : EVP_MD_name(mgf1_md)))
336 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
337 if (p != NULL && !OSSL_PARAM_set_octet_ptr(p, prsactx->oaep_label, 0))
340 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN);
341 if (p != NULL && !OSSL_PARAM_set_size_t(p, prsactx->oaep_labellen))
344 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
345 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->client_version))
348 p = OSSL_PARAM_locate(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
349 if (p != NULL && !OSSL_PARAM_set_uint(p, prsactx->alt_version))
355 static const OSSL_PARAM known_gettable_ctx_params[] = {
356 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
357 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
358 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
359 OSSL_PARAM_DEFN(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, OSSL_PARAM_OCTET_PTR,
361 OSSL_PARAM_size_t(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL_LEN, NULL),
362 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
363 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
367 static const OSSL_PARAM *rsa_gettable_ctx_params(void)
369 return known_gettable_ctx_params;
372 static int rsa_set_ctx_params(void *vprsactx, const OSSL_PARAM params[])
374 PROV_RSA_CTX *prsactx = (PROV_RSA_CTX *)vprsactx;
376 char mdname[OSSL_MAX_NAME_SIZE];
377 char mdprops[OSSL_MAX_PROPQUERY_SIZE] = { '\0' };
380 if (prsactx == NULL || params == NULL)
383 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST);
385 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
389 p = OSSL_PARAM_locate_const(params,
390 OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS);
392 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
396 EVP_MD_free(prsactx->oaep_md);
397 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, mdname, mdprops);
399 if (prsactx->oaep_md == NULL)
403 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_PAD_MODE);
407 switch (p->data_type) {
408 case OSSL_PARAM_INTEGER: /* Support for legacy pad mode number */
409 if (!OSSL_PARAM_get_int(p, &pad_mode))
412 case OSSL_PARAM_UTF8_STRING:
419 for (i = 0; padding_item[i].id != 0; i++) {
420 if (strcmp(p->data, padding_item[i].ptr) == 0) {
421 pad_mode = padding_item[i].id;
432 * PSS padding is for signatures only so is not compatible with
433 * asymmetric cipher use.
435 if (pad_mode == RSA_PKCS1_PSS_PADDING)
437 if (pad_mode == RSA_PKCS1_OAEP_PADDING && prsactx->oaep_md == NULL) {
438 prsactx->oaep_md = EVP_MD_fetch(prsactx->libctx, "SHA1", mdprops);
439 if (prsactx->oaep_md == NULL)
442 prsactx->pad_mode = pad_mode;
445 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST);
447 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdname)))
451 p = OSSL_PARAM_locate_const(params,
452 OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS);
454 if (!OSSL_PARAM_get_utf8_string(p, &str, sizeof(mdprops)))
460 EVP_MD_free(prsactx->mgf1_md);
461 prsactx->mgf1_md = EVP_MD_fetch(prsactx->libctx, mdname, str);
463 if (prsactx->mgf1_md == NULL)
467 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL);
469 void *tmp_label = NULL;
472 if (!OSSL_PARAM_get_octet_string(p, &tmp_label, 0, &tmp_labellen))
474 OPENSSL_free(prsactx->oaep_label);
475 prsactx->oaep_label = (unsigned char *)tmp_label;
476 prsactx->oaep_labellen = tmp_labellen;
479 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION);
481 unsigned int client_version;
483 if (!OSSL_PARAM_get_uint(p, &client_version))
485 prsactx->client_version = client_version;
488 p = OSSL_PARAM_locate_const(params, OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION);
490 unsigned int alt_version;
492 if (!OSSL_PARAM_get_uint(p, &alt_version))
494 prsactx->alt_version = alt_version;
500 static const OSSL_PARAM known_settable_ctx_params[] = {
501 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST, NULL, 0),
502 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_PAD_MODE, NULL, 0),
503 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST, NULL, 0),
504 OSSL_PARAM_utf8_string(OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST_PROPS, NULL, 0),
505 OSSL_PARAM_octet_string(OSSL_ASYM_CIPHER_PARAM_OAEP_LABEL, NULL, 0),
506 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION, NULL),
507 OSSL_PARAM_uint(OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, NULL),
511 static const OSSL_PARAM *rsa_settable_ctx_params(void)
513 return known_settable_ctx_params;
516 const OSSL_DISPATCH rsa_asym_cipher_functions[] = {
517 { OSSL_FUNC_ASYM_CIPHER_NEWCTX, (void (*)(void))rsa_newctx },
518 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT_INIT, (void (*)(void))rsa_init },
519 { OSSL_FUNC_ASYM_CIPHER_ENCRYPT, (void (*)(void))rsa_encrypt },
520 { OSSL_FUNC_ASYM_CIPHER_DECRYPT_INIT, (void (*)(void))rsa_init },
521 { OSSL_FUNC_ASYM_CIPHER_DECRYPT, (void (*)(void))rsa_decrypt },
522 { OSSL_FUNC_ASYM_CIPHER_FREECTX, (void (*)(void))rsa_freectx },
523 { OSSL_FUNC_ASYM_CIPHER_DUPCTX, (void (*)(void))rsa_dupctx },
524 { OSSL_FUNC_ASYM_CIPHER_GET_CTX_PARAMS,
525 (void (*)(void))rsa_get_ctx_params },
526 { OSSL_FUNC_ASYM_CIPHER_GETTABLE_CTX_PARAMS,
527 (void (*)(void))rsa_gettable_ctx_params },
528 { OSSL_FUNC_ASYM_CIPHER_SET_CTX_PARAMS,
529 (void (*)(void))rsa_set_ctx_params },
530 { OSSL_FUNC_ASYM_CIPHER_SETTABLE_CTX_PARAMS,
531 (void (*)(void))rsa_settable_ctx_params },