Coverage Report

Created: 2025-08-25 06:30

/src/openssl/providers/implementations/keymgmt/rsa_kmgmt.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2019-2025 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
/*
11
 * RSA low level APIs are deprecated for public use, but still ok for
12
 * internal use.
13
 */
14
#include "internal/deprecated.h"
15
16
#include <openssl/core_dispatch.h>
17
#include <openssl/core_names.h>
18
#include <openssl/bn.h>
19
#include <openssl/err.h>
20
#include <openssl/rsa.h>
21
#include <openssl/evp.h>
22
#include <openssl/proverr.h>
23
#include "prov/implementations.h"
24
#include "prov/providercommon.h"
25
#include "prov/provider_ctx.h"
26
#include "crypto/rsa.h"
27
#include "crypto/cryptlib.h"
28
#include "internal/fips.h"
29
#include "internal/param_build_set.h"
30
31
static OSSL_FUNC_keymgmt_new_fn rsa_newdata;
32
static OSSL_FUNC_keymgmt_new_fn rsapss_newdata;
33
static OSSL_FUNC_keymgmt_gen_init_fn rsa_gen_init;
34
static OSSL_FUNC_keymgmt_gen_init_fn rsapss_gen_init;
35
static OSSL_FUNC_keymgmt_gen_set_params_fn rsa_gen_set_params;
36
static OSSL_FUNC_keymgmt_gen_settable_params_fn rsa_gen_settable_params;
37
static OSSL_FUNC_keymgmt_gen_settable_params_fn rsapss_gen_settable_params;
38
static OSSL_FUNC_keymgmt_gen_fn rsa_gen;
39
static OSSL_FUNC_keymgmt_gen_cleanup_fn rsa_gen_cleanup;
40
static OSSL_FUNC_keymgmt_load_fn rsa_load;
41
static OSSL_FUNC_keymgmt_load_fn rsapss_load;
42
static OSSL_FUNC_keymgmt_free_fn rsa_freedata;
43
static OSSL_FUNC_keymgmt_get_params_fn rsa_get_params;
44
static OSSL_FUNC_keymgmt_gettable_params_fn rsa_gettable_params;
45
static OSSL_FUNC_keymgmt_has_fn rsa_has;
46
static OSSL_FUNC_keymgmt_match_fn rsa_match;
47
static OSSL_FUNC_keymgmt_validate_fn rsa_validate;
48
static OSSL_FUNC_keymgmt_import_fn rsa_import;
49
static OSSL_FUNC_keymgmt_import_types_fn rsa_import_types;
50
static OSSL_FUNC_keymgmt_export_fn rsa_export;
51
static OSSL_FUNC_keymgmt_export_types_fn rsa_export_types;
52
static OSSL_FUNC_keymgmt_query_operation_name_fn rsa_query_operation_name;
53
static OSSL_FUNC_keymgmt_dup_fn rsa_dup;
54
55
0
#define RSA_DEFAULT_MD "SHA256"
56
#define RSA_POSSIBLE_SELECTIONS                                        \
57
0
    (OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS)
58
59
DEFINE_STACK_OF(BIGNUM)
60
DEFINE_SPECIAL_STACK_OF_CONST(BIGNUM_const, BIGNUM)
61
62
static int pss_params_fromdata(RSA_PSS_PARAMS_30 *pss_params, int *defaults_set,
63
                               const OSSL_PARAM params[], int rsa_type,
64
                               OSSL_LIB_CTX *libctx)
65
0
{
66
0
    if (!ossl_rsa_pss_params_30_fromdata(pss_params, defaults_set,
67
0
                                         params, libctx))
68
0
        return 0;
69
70
    /* If not a PSS type RSA, sending us PSS parameters is wrong */
71
0
    if (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
72
0
        && !ossl_rsa_pss_params_30_is_unrestricted(pss_params))
73
0
        return 0;
74
75
0
    return 1;
76
0
}
77
78
static void *rsa_newdata(void *provctx)
79
0
{
80
0
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
81
0
    RSA *rsa;
82
83
0
    if (!ossl_prov_is_running())
84
0
        return NULL;
85
86
0
    rsa = ossl_rsa_new_with_ctx(libctx);
87
0
    if (rsa != NULL) {
88
0
        RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
89
0
        RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
90
0
    }
91
0
    return rsa;
92
0
}
93
94
static void *rsapss_newdata(void *provctx)
95
0
{
96
0
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
97
0
    RSA *rsa;
98
99
0
    if (!ossl_prov_is_running())
100
0
        return NULL;
101
102
0
    rsa = ossl_rsa_new_with_ctx(libctx);
103
0
    if (rsa != NULL) {
104
0
        RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
105
0
        RSA_set_flags(rsa, RSA_FLAG_TYPE_RSASSAPSS);
106
0
    }
107
0
    return rsa;
108
0
}
109
110
static void rsa_freedata(void *keydata)
111
0
{
112
0
    RSA_free(keydata);
113
0
}
114
115
static int rsa_has(const void *keydata, int selection)
116
0
{
117
0
    const RSA *rsa = keydata;
118
0
    int ok = 1;
119
120
0
    if (rsa == NULL || !ossl_prov_is_running())
121
0
        return 0;
122
0
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
123
0
        return 1; /* the selection is not missing */
124
125
    /* OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS are always available even if empty */
126
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
127
0
        ok = ok && (RSA_get0_n(rsa) != NULL);
128
0
    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
129
0
        ok = ok && (RSA_get0_e(rsa) != NULL);
130
0
    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
131
0
        ok = ok && (RSA_get0_d(rsa) != NULL);
132
0
    return ok;
133
0
}
134
135
static int rsa_match(const void *keydata1, const void *keydata2, int selection)
136
0
{
137
0
    const RSA *rsa1 = keydata1;
138
0
    const RSA *rsa2 = keydata2;
139
0
    int ok = 1;
140
141
0
    if (!ossl_prov_is_running())
142
0
        return 0;
143
144
    /* There is always an |e| */
145
0
    ok = ok && BN_cmp(RSA_get0_e(rsa1), RSA_get0_e(rsa2)) == 0;
146
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
147
0
        int key_checked = 0;
148
149
0
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
150
0
            const BIGNUM *pa = RSA_get0_n(rsa1);
151
0
            const BIGNUM *pb = RSA_get0_n(rsa2);
152
153
0
            if (pa != NULL && pb != NULL) {
154
0
                ok = ok && BN_cmp(pa, pb) == 0;
155
0
                key_checked = 1;
156
0
            }
157
0
        }
158
0
        if (!key_checked
159
0
            && (selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0) {
160
0
            const BIGNUM *pa = RSA_get0_d(rsa1);
161
0
            const BIGNUM *pb = RSA_get0_d(rsa2);
162
163
0
            if (pa != NULL && pb != NULL) {
164
0
                ok = ok && BN_cmp(pa, pb) == 0;
165
0
                key_checked = 1;
166
0
            }
167
0
        }
168
0
        ok = ok && key_checked;
169
0
    }
170
0
    return ok;
171
0
}
172
173
static int rsa_import(void *keydata, int selection, const OSSL_PARAM params[])
174
0
{
175
0
    RSA *rsa = keydata;
176
0
    int rsa_type;
177
0
    int ok = 1;
178
0
    int pss_defaults_set = 0;
179
180
0
    if (!ossl_prov_is_running() || rsa == NULL)
181
0
        return 0;
182
183
0
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
184
0
        return 0;
185
186
0
    rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
187
188
0
    if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
189
0
        ok = ok && pss_params_fromdata(ossl_rsa_get0_pss_params_30(rsa),
190
0
                                       &pss_defaults_set,
191
0
                                       params, rsa_type,
192
0
                                       ossl_rsa_get0_libctx(rsa));
193
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
194
0
        int include_private =
195
0
            selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
196
197
0
        ok = ok && ossl_rsa_fromdata(rsa, params, include_private);
198
0
    }
199
200
#ifdef FIPS_MODULE
201
    if (ok > 0 && !ossl_fips_self_testing()) {
202
        const BIGNUM *n, *e, *d, *dp, *dq, *iq, *p, *q;
203
204
        RSA_get0_key(rsa, &n, &e, &d);
205
        RSA_get0_crt_params(rsa, &dp, &dq, &iq);
206
        p = RSA_get0_p(rsa);
207
        q = RSA_get0_q(rsa);
208
209
        /* Check for the public key */
210
        if (n != NULL && e != NULL)
211
            /* Check for private key in straightforward or CRT form */
212
            if (d != NULL || (p != NULL && q != NULL && dp != NULL
213
                              && dq != NULL && iq != NULL))
214
                ok = ossl_rsa_key_pairwise_test(rsa);
215
    }
216
#endif  /* FIPS_MODULE */
217
0
    return ok;
218
0
}
219
220
static int rsa_export(void *keydata, int selection,
221
                      OSSL_CALLBACK *param_callback, void *cbarg)
222
0
{
223
0
    RSA *rsa = keydata;
224
0
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
225
0
    OSSL_PARAM_BLD *tmpl;
226
0
    OSSL_PARAM *params = NULL;
227
0
    int ok = 1;
228
229
0
    if (!ossl_prov_is_running() || rsa == NULL)
230
0
        return 0;
231
232
0
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
233
0
        return 0;
234
235
0
    tmpl = OSSL_PARAM_BLD_new();
236
0
    if (tmpl == NULL)
237
0
        return 0;
238
239
0
    if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
240
0
        ok = ok && (ossl_rsa_pss_params_30_is_unrestricted(pss_params)
241
0
                    || ossl_rsa_pss_params_30_todata(pss_params, tmpl, NULL));
242
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
243
0
        int include_private =
244
0
            selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
245
246
0
        ok = ok && ossl_rsa_todata(rsa, tmpl, NULL, include_private);
247
0
    }
248
249
0
    if (!ok || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
250
0
        ok = 0;
251
0
        goto err;
252
0
    }
253
254
0
    ok = param_callback(params, cbarg);
255
0
    OSSL_PARAM_free(params);
256
0
err:
257
0
    OSSL_PARAM_BLD_free(tmpl);
258
0
    return ok;
259
0
}
260
261
#ifdef FIPS_MODULE
262
/* In fips mode there are no multi-primes. */
263
# define RSA_KEY_MP_TYPES()                                                    \
264
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0),                           \
265
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0),                           \
266
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0),                         \
267
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0),                         \
268
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0),
269
#else
270
/*
271
 * We allow up to 10 prime factors (starting with p, q).
272
 * NOTE: there is only 9 OSSL_PKEY_PARAM_RSA_COEFFICIENT
273
 */
274
# define RSA_KEY_MP_TYPES()                                                    \
275
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0),                           \
276
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0),                           \
277
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR3, NULL, 0),                           \
278
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR4, NULL, 0),                           \
279
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR5, NULL, 0),                           \
280
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR6, NULL, 0),                           \
281
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR7, NULL, 0),                           \
282
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR8, NULL, 0),                           \
283
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR9, NULL, 0),                           \
284
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR10, NULL, 0),                          \
285
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0),                         \
286
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0),                         \
287
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT3, NULL, 0),                         \
288
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT4, NULL, 0),                         \
289
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT5, NULL, 0),                         \
290
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT6, NULL, 0),                         \
291
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT7, NULL, 0),                         \
292
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT8, NULL, 0),                         \
293
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT9, NULL, 0),                         \
294
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT10, NULL, 0),                        \
295
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0),                      \
296
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT2, NULL, 0),                      \
297
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT3, NULL, 0),                      \
298
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT4, NULL, 0),                      \
299
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT5, NULL, 0),                      \
300
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT6, NULL, 0),                      \
301
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT7, NULL, 0),                      \
302
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT8, NULL, 0),                      \
303
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT9, NULL, 0),
304
#endif
305
306
#define RSA_KEY_TYPES()                                                        \
307
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_N, NULL, 0),                                 \
308
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0),                                 \
309
OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_D, NULL, 0),                                 \
310
RSA_KEY_MP_TYPES()
311
312
/*
313
 * This provider can export everything in an RSA key, so we use the exact
314
 * same type description for export as for import.  Other providers might
315
 * choose to import full keys, but only export the public parts, and will
316
 * therefore have the importkey_types and importkey_types functions return
317
 * different arrays.
318
 */
319
static const OSSL_PARAM rsa_key_types[] = {
320
    RSA_KEY_TYPES()
321
    OSSL_PARAM_END
322
};
323
/*
324
 * We lied about the amount of factors, exponents and coefficients, the
325
 * export and import functions can really deal with an infinite amount
326
 * of these numbers.  However, RSA keys with too many primes are futile,
327
 * so we at least pretend to have some limits.
328
 */
329
330
static const OSSL_PARAM *rsa_imexport_types(int selection)
331
0
{
332
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
333
0
        return rsa_key_types;
334
0
    return NULL;
335
0
}
336
337
static const OSSL_PARAM *rsa_import_types(int selection)
338
0
{
339
0
    return rsa_imexport_types(selection);
340
0
}
341
342
static const OSSL_PARAM *rsa_export_types(int selection)
343
0
{
344
0
    return rsa_imexport_types(selection);
345
0
}
346
347
static int rsa_get_params(void *key, OSSL_PARAM params[])
348
0
{
349
0
    RSA *rsa = key;
350
0
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
351
0
    int rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
352
0
    OSSL_PARAM *p;
353
0
    int empty = RSA_get0_n(rsa) == NULL;
354
355
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
356
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_bits(rsa))))
357
0
        return 0;
358
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
359
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_security_bits(rsa))))
360
0
        return 0;
361
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
362
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_size(rsa))))
363
0
        return 0;
364
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_CATEGORY)) != NULL)
365
0
        if (!OSSL_PARAM_set_int(p, 0))
366
0
            return 0;
367
368
    /*
369
     * For restricted RSA-PSS keys, we ignore the default digest request.
370
     * With RSA-OAEP keys, this may need to be amended.
371
     */
372
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_DEFAULT_DIGEST)) != NULL
373
0
        && (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
374
0
            || ossl_rsa_pss_params_30_is_unrestricted(pss_params))) {
375
0
        if (!OSSL_PARAM_set_utf8_string(p, RSA_DEFAULT_MD))
376
0
            return 0;
377
0
    }
378
379
    /*
380
     * For non-RSA-PSS keys, we ignore the mandatory digest request.
381
     * With RSA-OAEP keys, this may need to be amended.
382
     */
383
0
    if ((p = OSSL_PARAM_locate(params,
384
0
                               OSSL_PKEY_PARAM_MANDATORY_DIGEST)) != NULL
385
0
        && rsa_type == RSA_FLAG_TYPE_RSASSAPSS
386
0
        && !ossl_rsa_pss_params_30_is_unrestricted(pss_params)) {
387
0
        const char *mdname =
388
0
            ossl_rsa_oaeppss_nid2name(ossl_rsa_pss_params_30_hashalg(pss_params));
389
390
0
        if (mdname == NULL || !OSSL_PARAM_set_utf8_string(p, mdname))
391
0
            return 0;
392
0
    }
393
0
    return (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
394
0
            || ossl_rsa_pss_params_30_todata(pss_params, NULL, params))
395
0
        && ossl_rsa_todata(rsa, NULL, params, 1);
396
0
}
397
398
static const OSSL_PARAM rsa_params[] = {
399
    OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
400
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
401
    OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
402
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_CATEGORY, NULL),
403
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_DEFAULT_DIGEST, NULL, 0),
404
    RSA_KEY_TYPES()
405
    OSSL_PARAM_END
406
};
407
408
static const OSSL_PARAM *rsa_gettable_params(void *provctx)
409
0
{
410
0
    return rsa_params;
411
0
}
412
413
static int rsa_validate(const void *keydata, int selection, int checktype)
414
0
{
415
0
    const RSA *rsa = keydata;
416
0
    int ok = 1;
417
418
0
    if (!ossl_prov_is_running())
419
0
        return 0;
420
421
0
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
422
0
        return 1; /* nothing to validate */
423
424
    /* If the whole key is selected, we do a pairwise validation */
425
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
426
0
        == OSSL_KEYMGMT_SELECT_KEYPAIR) {
427
0
        ok = ok && ossl_rsa_validate_pairwise(rsa);
428
0
    } else {
429
0
        if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
430
0
            ok = ok && ossl_rsa_validate_private(rsa);
431
0
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
432
0
            ok = ok && ossl_rsa_validate_public(rsa);
433
0
    }
434
0
    return ok;
435
0
}
436
437
struct rsa_gen_ctx {
438
    OSSL_LIB_CTX *libctx;
439
    const char *propq;
440
441
    int rsa_type;
442
443
    size_t nbits;
444
    BIGNUM *pub_exp;
445
    size_t primes;
446
447
    /* For PSS */
448
    RSA_PSS_PARAMS_30 pss_params;
449
    int pss_defaults_set;
450
451
    /* For generation callback */
452
    OSSL_CALLBACK *cb;
453
    void *cbarg;
454
455
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
456
    /* ACVP test parameters */
457
    OSSL_PARAM *acvp_test_params;
458
#endif
459
};
460
461
static int rsa_gencb(int p, int n, BN_GENCB *cb)
462
0
{
463
0
    struct rsa_gen_ctx *gctx = BN_GENCB_get_arg(cb);
464
0
    OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };
465
466
0
    params[0] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_POTENTIAL, &p);
467
0
    params[1] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_ITERATION, &n);
468
0
    return gctx->cb(params, gctx->cbarg);
469
0
}
470
471
static void *gen_init(void *provctx, int selection, int rsa_type,
472
                      const OSSL_PARAM params[])
473
0
{
474
0
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
475
0
    struct rsa_gen_ctx *gctx = NULL;
476
477
0
    if (!ossl_prov_is_running())
478
0
        return NULL;
479
480
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
481
0
        return NULL;
482
483
0
    if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
484
0
        gctx->libctx = libctx;
485
0
        if ((gctx->pub_exp = BN_new()) == NULL
486
0
            || !BN_set_word(gctx->pub_exp, RSA_F4)) {
487
0
            goto err;
488
0
        }
489
0
        gctx->nbits = 2048;
490
0
        gctx->primes = RSA_DEFAULT_PRIME_NUM;
491
0
        gctx->rsa_type = rsa_type;
492
0
    } else {
493
0
        goto err;
494
0
    }
495
496
0
    if (!rsa_gen_set_params(gctx, params))
497
0
        goto err;
498
0
    return gctx;
499
500
0
err:
501
0
    if (gctx != NULL)
502
0
        BN_free(gctx->pub_exp);
503
0
    OPENSSL_free(gctx);
504
0
    return NULL;
505
0
}
506
507
static void *rsa_gen_init(void *provctx, int selection,
508
                          const OSSL_PARAM params[])
509
0
{
510
0
    return gen_init(provctx, selection, RSA_FLAG_TYPE_RSA, params);
511
0
}
512
513
static void *rsapss_gen_init(void *provctx, int selection,
514
                             const OSSL_PARAM params[])
515
0
{
516
0
    return gen_init(provctx, selection, RSA_FLAG_TYPE_RSASSAPSS, params);
517
0
}
518
519
/*
520
 * This function is common for all RSA sub-types, to detect possible
521
 * misuse, such as PSS parameters being passed when a plain RSA key
522
 * is generated.
523
 */
524
static int rsa_gen_set_params(void *genctx, const OSSL_PARAM params[])
525
0
{
526
0
    struct rsa_gen_ctx *gctx = genctx;
527
0
    const OSSL_PARAM *p;
528
529
0
    if (ossl_param_is_empty(params))
530
0
        return 1;
531
532
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_BITS)) != NULL) {
533
0
        if (!OSSL_PARAM_get_size_t(p, &gctx->nbits))
534
0
            return 0;
535
0
        if (gctx->nbits < RSA_MIN_MODULUS_BITS) {
536
0
            ERR_raise(ERR_LIB_PROV, PROV_R_KEY_SIZE_TOO_SMALL);
537
0
            return 0;
538
0
        }
539
0
    }
540
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PRIMES)) != NULL
541
0
        && !OSSL_PARAM_get_size_t(p, &gctx->primes))
542
0
        return 0;
543
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_E)) != NULL
544
0
        && !OSSL_PARAM_get_BN(p, &gctx->pub_exp))
545
0
        return 0;
546
    /* Only attempt to get PSS parameters when generating an RSA-PSS key */
547
0
    if (gctx->rsa_type == RSA_FLAG_TYPE_RSASSAPSS
548
0
        && !pss_params_fromdata(&gctx->pss_params, &gctx->pss_defaults_set, params,
549
0
                                gctx->rsa_type, gctx->libctx))
550
0
        return 0;
551
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
552
    /* Any ACVP test related parameters are copied into a params[] */
553
    if (!ossl_rsa_acvp_test_gen_params_new(&gctx->acvp_test_params, params))
554
        return 0;
555
#endif
556
0
    return 1;
557
0
}
558
559
#define rsa_gen_basic                                           \
560
0
    OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_BITS, NULL),          \
561
0
    OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_PRIMES, NULL),        \
562
0
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0)
563
564
/*
565
 * The following must be kept in sync with ossl_rsa_pss_params_30_fromdata()
566
 * in crypto/rsa/rsa_backend.c
567
 */
568
#define rsa_gen_pss                                                     \
569
0
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_DIGEST, NULL, 0),        \
570
0
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_DIGEST_PROPS, NULL, 0),  \
571
0
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MASKGENFUNC, NULL, 0),   \
572
0
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MGF1_DIGEST, NULL, 0),   \
573
0
    OSSL_PARAM_int(OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, NULL)
574
575
static const OSSL_PARAM *rsa_gen_settable_params(ossl_unused void *genctx,
576
                                                 ossl_unused void *provctx)
577
0
{
578
0
    static OSSL_PARAM settable[] = {
579
0
        rsa_gen_basic,
580
0
        OSSL_PARAM_END
581
0
    };
582
583
0
    return settable;
584
0
}
585
586
static const OSSL_PARAM *rsapss_gen_settable_params(ossl_unused void *genctx,
587
                                                    ossl_unused void *provctx)
588
0
{
589
0
    static OSSL_PARAM settable[] = {
590
0
        rsa_gen_basic,
591
0
        rsa_gen_pss,
592
0
        OSSL_PARAM_END
593
0
    };
594
595
0
    return settable;
596
0
}
597
598
static void *rsa_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
599
0
{
600
0
    struct rsa_gen_ctx *gctx = genctx;
601
0
    RSA *rsa = NULL, *rsa_tmp = NULL;
602
0
    BN_GENCB *gencb = NULL;
603
604
0
    if (!ossl_prov_is_running() || gctx == NULL)
605
0
        return NULL;
606
607
0
    switch (gctx->rsa_type) {
608
0
    case RSA_FLAG_TYPE_RSA:
609
        /* For plain RSA keys, PSS parameters must not be set */
610
0
        if (!ossl_rsa_pss_params_30_is_unrestricted(&gctx->pss_params))
611
0
            goto err;
612
0
        break;
613
0
    case RSA_FLAG_TYPE_RSASSAPSS:
614
        /*
615
         * For plain RSA-PSS keys, PSS parameters may be set but don't have
616
         * to, so not check.
617
         */
618
0
        break;
619
0
    default:
620
        /* Unsupported RSA key sub-type... */
621
0
        return NULL;
622
0
    }
623
624
0
    if ((rsa_tmp = ossl_rsa_new_with_ctx(gctx->libctx)) == NULL)
625
0
        return NULL;
626
627
0
    gctx->cb = osslcb;
628
0
    gctx->cbarg = cbarg;
629
0
    gencb = BN_GENCB_new();
630
0
    if (gencb != NULL)
631
0
        BN_GENCB_set(gencb, rsa_gencb, genctx);
632
633
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
634
    if (gctx->acvp_test_params != NULL) {
635
        if (!ossl_rsa_acvp_test_set_params(rsa_tmp, gctx->acvp_test_params))
636
            goto err;
637
    }
638
#endif
639
640
0
    if (!RSA_generate_multi_prime_key(rsa_tmp,
641
0
                                      (int)gctx->nbits, (int)gctx->primes,
642
0
                                      gctx->pub_exp, gencb))
643
0
        goto err;
644
645
0
    if (!ossl_rsa_pss_params_30_copy(ossl_rsa_get0_pss_params_30(rsa_tmp),
646
0
                                     &gctx->pss_params))
647
0
        goto err;
648
649
0
    RSA_clear_flags(rsa_tmp, RSA_FLAG_TYPE_MASK);
650
0
    RSA_set_flags(rsa_tmp, gctx->rsa_type);
651
652
0
    rsa = rsa_tmp;
653
0
    rsa_tmp = NULL;
654
0
 err:
655
0
    BN_GENCB_free(gencb);
656
0
    RSA_free(rsa_tmp);
657
0
    return rsa;
658
0
}
659
660
static void rsa_gen_cleanup(void *genctx)
661
0
{
662
0
    struct rsa_gen_ctx *gctx = genctx;
663
664
0
    if (gctx == NULL)
665
0
        return;
666
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
667
    ossl_rsa_acvp_test_gen_params_free(gctx->acvp_test_params);
668
    gctx->acvp_test_params = NULL;
669
#endif
670
0
    BN_clear_free(gctx->pub_exp);
671
0
    OPENSSL_free(gctx);
672
0
}
673
674
static void *common_load(const void *reference, size_t reference_sz,
675
                         int expected_rsa_type)
676
0
{
677
0
    RSA *rsa = NULL;
678
679
0
    if (ossl_prov_is_running() && reference_sz == sizeof(rsa)) {
680
        /* The contents of the reference is the address to our object */
681
0
        rsa = *(RSA **)reference;
682
683
0
        if (RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK) != expected_rsa_type)
684
0
            return NULL;
685
686
        /* We grabbed, so we detach it */
687
0
        *(RSA **)reference = NULL;
688
0
        return rsa;
689
0
    }
690
0
    return NULL;
691
0
}
692
693
static void *rsa_load(const void *reference, size_t reference_sz)
694
0
{
695
0
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSA);
696
0
}
697
698
static void *rsapss_load(const void *reference, size_t reference_sz)
699
0
{
700
0
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSASSAPSS);
701
0
}
702
703
static void *rsa_dup(const void *keydata_from, int selection)
704
0
{
705
0
    if (ossl_prov_is_running()
706
        /* do not allow creating empty keys by duplication */
707
0
        && (selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
708
0
        return ossl_rsa_dup(keydata_from, selection);
709
0
    return NULL;
710
0
}
711
712
/* For any RSA key, we use the "RSA" algorithms regardless of sub-type. */
713
static const char *rsa_query_operation_name(int operation_id)
714
0
{
715
0
    return "RSA";
716
0
}
717
718
const OSSL_DISPATCH ossl_rsa_keymgmt_functions[] = {
719
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsa_newdata },
720
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsa_gen_init },
721
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS,
722
      (void (*)(void))rsa_gen_set_params },
723
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
724
      (void (*)(void))rsa_gen_settable_params },
725
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
726
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
727
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsa_load },
728
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
729
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))rsa_get_params },
730
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))rsa_gettable_params },
731
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
732
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
733
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
734
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
735
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
736
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
737
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
738
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
739
    OSSL_DISPATCH_END
740
};
741
742
const OSSL_DISPATCH ossl_rsapss_keymgmt_functions[] = {
743
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsapss_newdata },
744
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsapss_gen_init },
745
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))rsa_gen_set_params },
746
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
747
      (void (*)(void))rsapss_gen_settable_params },
748
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
749
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
750
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsapss_load },
751
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
752
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))rsa_get_params },
753
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))rsa_gettable_params },
754
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
755
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
756
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
757
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
758
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
759
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
760
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
761
    { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
762
      (void (*)(void))rsa_query_operation_name },
763
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
764
    OSSL_DISPATCH_END
765
};