fae09d706752469e30af960f11d3feebd64cbea1
[openssl.git] / crypto / rsa / rsa_backend.c
1 /*
2  * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include <string.h>
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"
17
18 #include "e_os.h"                /* strcasecmp for Windows() */
19
20 /*
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.
24  */
25
26 DEFINE_STACK_OF(BIGNUM)
27
28 static int collect_numbers(STACK_OF(BIGNUM) *numbers,
29                            const OSSL_PARAM params[], const char *names[])
30 {
31     const OSSL_PARAM *p = NULL;
32     int i;
33
34     if (numbers == NULL)
35         return 0;
36
37     for (i = 0; names[i] != NULL; i++){
38         p = OSSL_PARAM_locate_const(params, names[i]);
39         if (p != NULL) {
40             BIGNUM *tmp = NULL;
41
42             if (!OSSL_PARAM_get_BN(p, &tmp)
43                 || sk_BIGNUM_push(numbers, tmp) == 0)
44                 return 0;
45         }
46     }
47
48     return 1;
49 }
50
51 int rsa_fromdata(RSA *rsa, const OSSL_PARAM params[])
52 {
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;
56     int is_private = 0;
57
58     if (rsa == NULL)
59         return 0;
60
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);
64
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)))
68         goto err;
69
70     is_private = (d != NULL);
71
72     if (!RSA_set0_key(rsa, n, e, d))
73         goto err;
74     n = e = d = NULL;
75
76     if (is_private) {
77         if (!collect_numbers(factors = sk_BIGNUM_new_null(), params,
78                              rsa_mp_factor_names)
79             || !collect_numbers(exps = sk_BIGNUM_new_null(), params,
80                                 rsa_mp_exp_names)
81             || !collect_numbers(coeffs = sk_BIGNUM_new_null(), params,
82                                 rsa_mp_coeff_names))
83             goto err;
84
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))
88             goto err;
89     }
90
91
92     sk_BIGNUM_free(factors);
93     sk_BIGNUM_free(exps);
94     sk_BIGNUM_free(coeffs);
95     return 1;
96
97  err:
98     BN_free(n);
99     BN_free(e);
100     BN_free(d);
101     sk_BIGNUM_pop_free(factors, BN_free);
102     sk_BIGNUM_pop_free(exps, BN_free);
103     sk_BIGNUM_pop_free(coeffs, BN_free);
104     return 0;
105 }
106
107 DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
108
109 int rsa_todata(RSA *rsa, OSSL_PARAM_BLD *bld, OSSL_PARAM params[])
110 {
111     int ret = 0;
112     const BIGNUM *rsa_d = NULL, *rsa_n = NULL, *rsa_e = NULL;
113     STACK_OF(BIGNUM_const) *factors = sk_BIGNUM_const_new_null();
114     STACK_OF(BIGNUM_const) *exps = sk_BIGNUM_const_new_null();
115     STACK_OF(BIGNUM_const) *coeffs = sk_BIGNUM_const_new_null();
116
117     if (rsa == NULL || factors == NULL || exps == NULL || coeffs == NULL)
118         goto err;
119
120     RSA_get0_key(rsa, &rsa_n, &rsa_e, &rsa_d);
121     rsa_get0_all_params(rsa, factors, exps, coeffs);
122
123     if (!ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_N, rsa_n)
124         || !ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_E, rsa_e))
125         goto err;
126
127     /* Check private key data integrity */
128     if (rsa_d != NULL) {
129         int numprimes = sk_BIGNUM_const_num(factors);
130         int numexps = sk_BIGNUM_const_num(exps);
131         int numcoeffs = sk_BIGNUM_const_num(coeffs);
132
133         /*
134          * It's permissible to have zero primes, i.e. no CRT params.
135          * Otherwise, there must be at least two, as many exponents,
136          * and one coefficient less.
137          */
138         if (numprimes != 0
139             && (numprimes < 2 || numexps < 2 || numcoeffs < 1))
140             goto err;
141
142         if (!ossl_param_build_set_bn(bld, params, OSSL_PKEY_PARAM_RSA_D,
143                                      rsa_d)
144             || !ossl_param_build_set_multi_key_bn(bld, params,
145                                                   rsa_mp_factor_names, factors)
146             || !ossl_param_build_set_multi_key_bn(bld, params,
147                                                   rsa_mp_exp_names, exps)
148             || !ossl_param_build_set_multi_key_bn(bld, params,
149                                                   rsa_mp_coeff_names, coeffs))
150         goto err;
151     }
152
153 #if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
154     /* The acvp test results are not meant for export so check for bld == NULL */
155     if (bld == NULL)
156         rsa_acvp_test_get_params(rsa, params);
157 #endif
158     ret = 1;
159  err:
160     sk_BIGNUM_const_free(factors);
161     sk_BIGNUM_const_free(exps);
162     sk_BIGNUM_const_free(coeffs);
163     return ret;
164 }
165
166 int rsa_pss_params_30_todata(const RSA_PSS_PARAMS_30 *pss,
167                              OSSL_PARAM_BLD *bld, OSSL_PARAM params[])
168 {
169     if (!rsa_pss_params_30_is_unrestricted(pss)) {
170         int hashalg_nid = rsa_pss_params_30_hashalg(pss);
171         int maskgenalg_nid = rsa_pss_params_30_maskgenalg(pss);
172         int maskgenhashalg_nid = rsa_pss_params_30_maskgenhashalg(pss);
173         int saltlen = rsa_pss_params_30_saltlen(pss);
174         int default_hashalg_nid = rsa_pss_params_30_hashalg(NULL);
175         int default_maskgenalg_nid = rsa_pss_params_30_maskgenalg(NULL);
176         int default_maskgenhashalg_nid = rsa_pss_params_30_maskgenhashalg(NULL);
177         const char *mdname =
178             (hashalg_nid == default_hashalg_nid
179              ? NULL : rsa_oaeppss_nid2name(hashalg_nid));
180         const char *mgfname =
181             (maskgenalg_nid == default_maskgenalg_nid
182              ? NULL : rsa_oaeppss_nid2name(maskgenalg_nid));
183         const char *mgf1mdname =
184             (maskgenhashalg_nid == default_maskgenhashalg_nid
185              ? NULL : rsa_oaeppss_nid2name(maskgenhashalg_nid));
186         const char *key_md = OSSL_PKEY_PARAM_RSA_DIGEST;
187         const char *key_mgf = OSSL_PKEY_PARAM_RSA_MASKGENFUNC;
188         const char *key_mgf1_md = OSSL_PKEY_PARAM_RSA_MGF1_DIGEST;
189         const char *key_saltlen = OSSL_PKEY_PARAM_RSA_PSS_SALTLEN;
190
191         /*
192          * To ensure that the key isn't seen as unrestricted by the recipient,
193          * we make sure that at least one PSS-related parameter is passed, even
194          * if it has a default value; saltlen.
195          */
196         if ((mdname != NULL
197              && !ossl_param_build_set_utf8_string(bld, params, key_md, mdname))
198             || (mgfname != NULL
199                 && !ossl_param_build_set_utf8_string(bld, params,
200                                                      key_mgf, mgfname))
201             || (mgf1mdname != NULL
202                 && !ossl_param_build_set_utf8_string(bld, params,
203                                                      key_mgf1_md, mgf1mdname))
204             || (!ossl_param_build_set_int(bld, params, key_saltlen, saltlen)))
205             return 0;
206     }
207     return 1;
208 }
209
210 int rsa_pss_params_30_fromdata(RSA_PSS_PARAMS_30 *pss_params,
211                                const OSSL_PARAM params[], OPENSSL_CTX *libctx)
212 {
213     const OSSL_PARAM *param_md, *param_mgf, *param_mgf1md,  *param_saltlen;
214     const OSSL_PARAM *param_propq;
215     const char *propq = NULL;
216     EVP_MD *md = NULL, *mgf1md = NULL;
217     int saltlen;
218     int ret = 0;
219
220     if (pss_params == NULL)
221         return 0;
222     param_propq =
223         OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_DIGEST_PROPS);
224     param_md =
225         OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_DIGEST);
226     param_mgf =
227         OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MASKGENFUNC);
228     param_mgf1md =
229         OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_MGF1_DIGEST);
230     param_saltlen =
231         OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PSS_SALTLEN);
232
233     if (param_propq != NULL) {
234         if (param_propq->data_type == OSSL_PARAM_UTF8_STRING)
235             propq = param_propq->data;
236     }
237     /*
238      * If we get any of the parameters, we know we have at least some
239      * restrictions, so we start by setting default values, and let each
240      * parameter override their specific restriction data.
241      */
242     if (param_md != NULL || param_mgf != NULL || param_mgf1md != NULL
243         || param_saltlen != NULL)
244         if (!rsa_pss_params_30_set_defaults(pss_params))
245             return 0;
246
247     if (param_mgf != NULL) {
248         int default_maskgenalg_nid = rsa_pss_params_30_maskgenalg(NULL);
249         const char *mgfname = NULL;
250
251         if (param_mgf->data_type == OSSL_PARAM_UTF8_STRING)
252             mgfname = param_mgf->data;
253         else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgfname))
254             return 0;
255
256         /* TODO Revisit this if / when a new MGF algorithm appears */
257         if (strcasecmp(param_mgf->data,
258                        rsa_mgf_nid2name(default_maskgenalg_nid)) != 0)
259             return 0;
260     }
261
262     /*
263      * We're only interested in the NIDs that correspond to the MDs, so the
264      * exact propquery is unimportant in the EVP_MD_fetch() calls below.
265      */
266
267     if (param_md != NULL) {
268         const char *mdname = NULL;
269
270         if (param_md->data_type == OSSL_PARAM_UTF8_STRING)
271             mdname = param_md->data;
272         else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mdname))
273             goto err;
274
275         if ((md = EVP_MD_fetch(libctx, mdname, propq)) == NULL
276             || !rsa_pss_params_30_set_hashalg(pss_params,
277                                               rsa_oaeppss_md2nid(md)))
278             goto err;
279     }
280
281     if (param_mgf1md != NULL) {
282         const char *mgf1mdname = NULL;
283
284         if (param_mgf1md->data_type == OSSL_PARAM_UTF8_STRING)
285             mgf1mdname = param_mgf1md->data;
286         else if (!OSSL_PARAM_get_utf8_ptr(param_mgf, &mgf1mdname))
287             goto err;
288
289         if ((mgf1md = EVP_MD_fetch(libctx, mgf1mdname, propq)) == NULL
290             || !rsa_pss_params_30_set_maskgenhashalg(pss_params,
291                                                      rsa_oaeppss_md2nid(mgf1md)))
292             goto err;
293     }
294
295     if (param_saltlen != NULL) {
296         if (!OSSL_PARAM_get_int(param_saltlen, &saltlen)
297             || !rsa_pss_params_30_set_saltlen(pss_params, saltlen))
298             goto err;
299     }
300
301     ret = 1;
302
303  err:
304     EVP_MD_free(md);
305     EVP_MD_free(mgf1md);
306     return ret;
307 }