2 * Copyright 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 #include <openssl/core_names.h>
12 #include <openssl/params.h>
13 #include <openssl/evp.h>
14 #include "internal/sizes.h"
15 #include "internal/param_build_set.h"
16 #include "crypto/rsa.h"
18 #include "e_os.h" /* strcasecmp for Windows() */
21 * The intention with the "backend" source file is to offer backend support
22 * for legacy backends (EVP_PKEY_ASN1_METHOD and EVP_PKEY_METHOD) and provider
23 * implementations alike.
26 DEFINE_STACK_OF(BIGNUM)
28 static int collect_numbers(STACK_OF(BIGNUM) *numbers,
29 const OSSL_PARAM params[], const char *names[])
31 const OSSL_PARAM *p = NULL;
37 for (i = 0; names[i] != NULL; i++){
38 p = OSSL_PARAM_locate_const(params, names[i]);
42 if (!OSSL_PARAM_get_BN(p, &tmp)
43 || sk_BIGNUM_push(numbers, tmp) == 0)
51 int rsa_fromdata(RSA *rsa, const OSSL_PARAM params[])
53 const OSSL_PARAM *param_n, *param_e, *param_d;
54 BIGNUM *n = NULL, *e = NULL, *d = NULL;
55 STACK_OF(BIGNUM) *factors = NULL, *exps = NULL, *coeffs = NULL;
61 param_n = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_N);
62 param_e = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_E);
63 param_d = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_D);
65 if ((param_n != NULL && !OSSL_PARAM_get_BN(param_n, &n))
66 || (param_e != NULL && !OSSL_PARAM_get_BN(param_e, &e))
67 || (param_d != NULL && !OSSL_PARAM_get_BN(param_d, &d)))
70 is_private = (d != NULL);
72 if (!RSA_set0_key(rsa, n, e, d))
77 if (!collect_numbers(factors = sk_BIGNUM_new_null(), params,
79 || !collect_numbers(exps = sk_BIGNUM_new_null(), params,
81 || !collect_numbers(coeffs = sk_BIGNUM_new_null(), params,
85 /* It's ok if this private key just has n, e and d */
86 if (sk_BIGNUM_num(factors) != 0
87 && !rsa_set0_all_params(rsa, factors, exps, coeffs))
91 sk_BIGNUM_free(factors);
93 sk_BIGNUM_free(coeffs);
100 sk_BIGNUM_pop_free(factors, BN_free);
101 sk_BIGNUM_pop_free(exps, BN_free);
102 sk_BIGNUM_pop_free(coeffs, BN_free);
106 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
108 int rsa_todata(RSA *rsa, OSSL_PARAM_BLD *bld, OSSL_PARAM params[])
111 const BIGNUM *rsa_d = NULL, *rsa_n = NULL, *rsa_e = NULL;
112 STACK_OF(BIGNUM_const) *factors = sk_BIGNUM_const_new_null();
113 STACK_OF(BIGNUM_const) *exps = sk_BIGNUM_const_new_null();
114 STACK_OF(BIGNUM_const) *coeffs = sk_BIGNUM_const_new_null();
116 if (rsa == NULL || factors == NULL || exps == NULL || coeffs == NULL)
119 RSA_get0_key(rsa, &rsa_n, &rsa_e, &rsa_d);
120 rsa_get0_all_params(rsa, factors, exps, coeffs);
122 /* Check private key data integrity */
124 int numprimes = sk_BIGNUM_const_num(factors);
125 int numexps = sk_BIGNUM_const_num(exps);
126 int numcoeffs = sk_BIGNUM_const_num(coeffs);
129 * It's permisssible to have zero primes, i.e. no CRT params.
130 * Otherwise, there must be at least two, as many exponents,
131 * and one coefficient less.
134 && (numprimes < 2 || numexps < 2 || numcoeffs < 1))
138 if (!ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_N, rsa_n)
139 || !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_E, rsa_e)
140 || !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_D, rsa_d)
141 || !ossl_param_build_set_multi_key_bn(bld, params, rsa_mp_factor_names,
143 || !ossl_param_build_set_multi_key_bn(bld, params, rsa_mp_exp_names,
145 || !ossl_param_build_set_multi_key_bn(bld, params, rsa_mp_coeff_names,
150 sk_BIGNUM_const_free(factors);
151 sk_BIGNUM_const_free(exps);
152 sk_BIGNUM_const_free(coeffs);
156 int rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30 *pss, const char *propq,
157 OSSL_PARAM_BLD *bld, OSSL_PARAM params[])
159 if (!rsa_pss_params_30_is_unrestricted(pss)) {
160 int hashalg_nid = rsa_pss_params_30_hashalg(pss);
161 int maskgenalg_nid = rsa_pss_params_30_maskgenalg(pss);
162 int maskgenhashalg_nid = rsa_pss_params_30_maskgenhashalg(pss);
163 int saltlen = rsa_pss_params_30_saltlen(pss);
164 int default_hashalg_nid = rsa_pss_params_30_hashalg(NULL);
165 int default_maskgenalg_nid = rsa_pss_params_30_maskgenalg(NULL);
166 int default_maskgenhashalg_nid = rsa_pss_params_30_maskgenhashalg(NULL);
168 (hashalg_nid == default_hashalg_nid
169 ? NULL : rsa_oaeppss_nid2name(hashalg_nid));
170 const char *mgfname =
171 (maskgenalg_nid == default_maskgenalg_nid
172 ? NULL : rsa_oaeppss_nid2name(maskgenalg_nid));
173 const char *mgf1mdname =
174 (maskgenhashalg_nid == default_maskgenhashalg_nid
175 ? NULL : rsa_oaeppss_nid2name(maskgenhashalg_nid));
176 const char *key_md = OSSL_PKEY_PARAM_RSA_DIGEST;
177 const char *key_mgf = OSSL_PKEY_PARAM_RSA_MASKGENFUNC;
178 const char *key_mgf1_md = OSSL_PKEY_PARAM_RSA_MGF1_DIGEST;
179 const char *key_saltlen = OSSL_PKEY_PARAM_RSA_PSS_SALTLEN;
182 * To ensure that the key isn't seen as unrestricted by the recipient,
183 * we make sure that at least one PSS-related parameter is passed, even
184 * if it has a default value; saltlen.
187 && !ossl_param_build_set_utf8_string(bld, params, key_md, mdname))
189 && !ossl_param_build_set_utf8_string(bld, params,
191 || (mgf1mdname != NULL
192 && !ossl_param_build_set_utf8_string(bld, params,
193 key_mgf1_md, mgf1mdname))
194 || (!ossl_param_build_set_int(bld, params, key_saltlen, saltlen)))
200 int rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30 *pss_params,
201 const OSSL_PARAM params[], OPENSSL_CTX *libctx)
203 const OSSL_PARAM *param_md, *param_mgf, *param_mgf1md, *param_saltlen;
204 EVP_MD *md = NULL, *mgf1md = NULL;
208 if (pss_params == NULL)
212 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_DIGEST);
214 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MASKGENFUNC);
216 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MGF1_DIGEST);
218 OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PSS_SALTLEN);
221 * If we get any of the parameters, we know we have at least some
222 * restrictions, so we start by setting default values, and let each
223 * parameter override their specific restriction data.
225 if (param_md != NULL || param_mgf != NULL || param_mgf1md != NULL
226 || param_saltlen != NULL)
227 if (!rsa_pss_params_30_set_defaults(pss_params))
230 if (param_mgf != NULL) {
231 int default_maskgenalg_nid = rsa_pss_params_30_maskgenalg(NULL);
232 const char *mgfname = NULL;
234 if (param_mgf->data_type == OSSL_PARAM_UTF8_STRING)
235 mgfname = param_mgf->data;
236 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgfname))
239 /* TODO Revisit this if / when a new MGF algorithm appears */
240 if (strcasecmp(param_mgf->data,
241 rsa_mgf_nid2name(default_maskgenalg_nid)) != 0)
246 * We're only interested in the NIDs that correspond to the MDs, so the
247 * exact propquery is unimportant in the EVP_MD_fetch() calls below.
250 if (param_md != NULL) {
251 const char *mdname = NULL;
253 if (param_md->data_type == OSSL_PARAM_UTF8_STRING)
254 mdname = param_md->data;
255 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mdname))
258 if ((md = EVP_MD_fetch(libctx, mdname, NULL)) == NULL
259 || !rsa_pss_params_30_set_hashalg(pss_params,
260 rsa_oaeppss_md2nid(md)))
264 if (param_mgf1md != NULL) {
265 const char *mgf1mdname = NULL;
267 if (param_mgf1md->data_type == OSSL_PARAM_UTF8_STRING)
268 mgf1mdname = param_mgf1md->data;
269 else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgf1mdname))
272 if ((mgf1md = EVP_MD_fetch(libctx, mgf1mdname, NULL)) == NULL
273 || !rsa_pss_params_30_set_maskgenhashalg(pss_params,
274 rsa_oaeppss_md2nid(mgf1md)))
278 if (param_saltlen != NULL) {
279 if (!OSSL_PARAM_get_int(param_saltlen, &saltlen)
280 || !rsa_pss_params_30_set_saltlen(pss_params, saltlen))