Coverage Report

Created: 2026-10-28 06:28

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