Coverage Report

Created: 2025-12-10 06:24

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl/providers/implementations/keymgmt/rsa_kmgmt.c
Line
Count
Source
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), &pss_defaults_set, params, rsa_type, ossl_rsa_get0_libctx(rsa));
190
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
191
0
        int include_private = selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
192
193
0
        ok = ok && ossl_rsa_fromdata(rsa, params, include_private);
194
0
    }
195
196
0
    return ok;
197
0
}
198
199
static int rsa_export(void *keydata, int selection,
200
    OSSL_CALLBACK *param_callback, void *cbarg)
201
0
{
202
0
    RSA *rsa = keydata;
203
0
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
204
0
    OSSL_PARAM_BLD *tmpl;
205
0
    OSSL_PARAM *params = NULL;
206
0
    int ok = 1;
207
208
0
    if (!ossl_prov_is_running() || rsa == NULL)
209
0
        return 0;
210
211
0
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
212
0
        return 0;
213
214
0
    tmpl = OSSL_PARAM_BLD_new();
215
0
    if (tmpl == NULL)
216
0
        return 0;
217
218
0
    if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
219
0
        ok = ok && (ossl_rsa_pss_params_30_is_unrestricted(pss_params) || ossl_rsa_pss_params_30_todata(pss_params, tmpl, NULL));
220
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
221
0
        int include_private = selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
222
223
0
        ok = ok && ossl_rsa_todata(rsa, tmpl, NULL, include_private);
224
0
    }
225
226
0
    if (!ok || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
227
0
        ok = 0;
228
0
        goto err;
229
0
    }
230
231
0
    ok = param_callback(params, cbarg);
232
0
    OSSL_PARAM_clear_free(params);
233
0
err:
234
0
    OSSL_PARAM_BLD_free(tmpl);
235
0
    return ok;
236
0
}
237
238
#ifdef FIPS_MODULE
239
/* In fips mode there are no multi-primes. */
240
#define RSA_KEY_MP_TYPES()                                     \
241
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0),       \
242
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0),   \
243
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0), \
244
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0), \
245
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0),
246
#else
247
/*
248
 * We allow up to 10 prime factors (starting with p, q).
249
 * NOTE: there is only 9 OSSL_PKEY_PARAM_RSA_COEFFICIENT
250
 */
251
#define RSA_KEY_MP_TYPES()                                        \
252
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR1, NULL, 0),          \
253
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR2, NULL, 0),      \
254
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR3, NULL, 0),      \
255
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR4, NULL, 0),      \
256
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR5, NULL, 0),      \
257
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR6, NULL, 0),      \
258
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR7, NULL, 0),      \
259
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR8, NULL, 0),      \
260
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR9, NULL, 0),      \
261
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_FACTOR10, NULL, 0),     \
262
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT1, NULL, 0),    \
263
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT2, NULL, 0),    \
264
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT3, NULL, 0),    \
265
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT4, NULL, 0),    \
266
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT5, NULL, 0),    \
267
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT6, NULL, 0),    \
268
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT7, NULL, 0),    \
269
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT8, NULL, 0),    \
270
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT9, NULL, 0),    \
271
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_EXPONENT10, NULL, 0),   \
272
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT1, NULL, 0), \
273
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT2, NULL, 0), \
274
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT3, NULL, 0), \
275
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT4, NULL, 0), \
276
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT5, NULL, 0), \
277
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT6, NULL, 0), \
278
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT7, NULL, 0), \
279
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT8, NULL, 0), \
280
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_COEFFICIENT9, NULL, 0),
281
#endif
282
283
#define RSA_KEY_TYPES()                                \
284
    OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_N, NULL, 0),     \
285
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0), \
286
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_D, NULL, 0), \
287
        RSA_KEY_MP_TYPES()
288
289
/*
290
 * This provider can export everything in an RSA key, so we use the exact
291
 * same type description for export as for import.  Other providers might
292
 * choose to import full keys, but only export the public parts, and will
293
 * therefore have the importkey_types and importkey_types functions return
294
 * different arrays.
295
 */
296
static const OSSL_PARAM rsa_key_types[] = {
297
    RSA_KEY_TYPES()
298
        OSSL_PARAM_END
299
};
300
/*
301
 * We lied about the amount of factors, exponents and coefficients, the
302
 * export and import functions can really deal with an infinite amount
303
 * of these numbers.  However, RSA keys with too many primes are futile,
304
 * so we at least pretend to have some limits.
305
 */
306
307
static const OSSL_PARAM *rsa_imexport_types(int selection)
308
0
{
309
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
310
0
        return rsa_key_types;
311
0
    return NULL;
312
0
}
313
314
static const OSSL_PARAM *rsa_import_types(int selection)
315
0
{
316
0
    return rsa_imexport_types(selection);
317
0
}
318
319
static const OSSL_PARAM *rsa_export_types(int selection)
320
0
{
321
0
    return rsa_imexport_types(selection);
322
0
}
323
324
static int rsa_get_params(void *key, OSSL_PARAM params[])
325
0
{
326
0
    RSA *rsa = key;
327
0
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
328
0
    int rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
329
0
    OSSL_PARAM *p;
330
0
    int empty = RSA_get0_n(rsa) == NULL;
331
332
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
333
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_bits(rsa))))
334
0
        return 0;
335
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
336
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_security_bits(rsa))))
337
0
        return 0;
338
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
339
0
        && (empty || !OSSL_PARAM_set_int(p, RSA_size(rsa))))
340
0
        return 0;
341
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_CATEGORY)) != NULL)
342
0
        if (!OSSL_PARAM_set_int(p, 0))
343
0
            return 0;
344
345
    /*
346
     * For restricted RSA-PSS keys, we ignore the default digest request.
347
     * With RSA-OAEP keys, this may need to be amended.
348
     */
349
0
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_DEFAULT_DIGEST)) != NULL
350
0
        && (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
351
0
            || ossl_rsa_pss_params_30_is_unrestricted(pss_params))) {
352
0
        if (!OSSL_PARAM_set_utf8_string(p, RSA_DEFAULT_MD))
353
0
            return 0;
354
0
    }
355
356
    /*
357
     * For non-RSA-PSS keys, we ignore the mandatory digest request.
358
     * With RSA-OAEP keys, this may need to be amended.
359
     */
360
0
    if ((p = OSSL_PARAM_locate(params,
361
0
             OSSL_PKEY_PARAM_MANDATORY_DIGEST))
362
0
            != NULL
363
0
        && rsa_type == RSA_FLAG_TYPE_RSASSAPSS
364
0
        && !ossl_rsa_pss_params_30_is_unrestricted(pss_params)) {
365
0
        const char *mdname = ossl_rsa_oaeppss_nid2name(ossl_rsa_pss_params_30_hashalg(pss_params));
366
367
0
        if (mdname == NULL || !OSSL_PARAM_set_utf8_string(p, mdname))
368
0
            return 0;
369
0
    }
370
0
    return (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
371
0
               || ossl_rsa_pss_params_30_todata(pss_params, NULL, params))
372
0
        && ossl_rsa_todata(rsa, NULL, params, 1);
373
0
}
374
375
static const OSSL_PARAM rsa_params[] = {
376
    OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
377
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
378
    OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
379
    OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_CATEGORY, 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
0
{
392
0
    const RSA *rsa = keydata;
393
0
    int ok = 1;
394
395
0
    if (!ossl_prov_is_running())
396
0
        return 0;
397
398
0
    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
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
403
0
        == OSSL_KEYMGMT_SELECT_KEYPAIR) {
404
0
        ok = ok && ossl_rsa_validate_pairwise(rsa);
405
0
    } else {
406
0
        if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
407
0
            ok = ok && ossl_rsa_validate_private(rsa);
408
0
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
409
0
            ok = ok && ossl_rsa_validate_public(rsa);
410
0
    }
411
0
    return ok;
412
0
}
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
    uint32_t a, b;
437
};
438
439
static int rsa_gencb(int p, int n, BN_GENCB *cb)
440
0
{
441
0
    struct rsa_gen_ctx *gctx = BN_GENCB_get_arg(cb);
442
0
    OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END, OSSL_PARAM_END };
443
444
0
    params[0] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_POTENTIAL, &p);
445
0
    params[1] = OSSL_PARAM_construct_int(OSSL_GEN_PARAM_ITERATION, &n);
446
0
    return gctx->cb(params, gctx->cbarg);
447
0
}
448
449
static void *gen_init(void *provctx, int selection, int rsa_type,
450
    const OSSL_PARAM params[])
451
0
{
452
0
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
453
0
    struct rsa_gen_ctx *gctx = NULL;
454
455
0
    if (!ossl_prov_is_running())
456
0
        return NULL;
457
458
0
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) == 0)
459
0
        return NULL;
460
461
0
    if ((gctx = OPENSSL_zalloc(sizeof(*gctx))) != NULL) {
462
0
        gctx->libctx = libctx;
463
0
        if ((gctx->pub_exp = BN_new()) == NULL
464
0
            || !BN_set_word(gctx->pub_exp, RSA_F4)) {
465
0
            goto err;
466
0
        }
467
0
        gctx->nbits = 2048;
468
0
        gctx->primes = RSA_DEFAULT_PRIME_NUM;
469
0
        gctx->rsa_type = rsa_type;
470
0
    } else {
471
0
        goto err;
472
0
    }
473
474
0
    if (!rsa_gen_set_params(gctx, params))
475
0
        goto err;
476
0
    return gctx;
477
478
0
err:
479
0
    if (gctx != NULL)
480
0
        BN_free(gctx->pub_exp);
481
0
    OPENSSL_free(gctx);
482
0
    return NULL;
483
0
}
484
485
static void *rsa_gen_init(void *provctx, int selection,
486
    const OSSL_PARAM params[])
487
0
{
488
0
    return gen_init(provctx, selection, RSA_FLAG_TYPE_RSA, params);
489
0
}
490
491
static void *rsapss_gen_init(void *provctx, int selection,
492
    const OSSL_PARAM params[])
493
0
{
494
0
    return gen_init(provctx, selection, RSA_FLAG_TYPE_RSASSAPSS, params);
495
0
}
496
497
/*
498
 * This function is common for all RSA sub-types, to detect possible
499
 * misuse, such as PSS parameters being passed when a plain RSA key
500
 * is generated.
501
 */
502
static int rsa_gen_set_params(void *genctx, const OSSL_PARAM params[])
503
0
{
504
0
    struct rsa_gen_ctx *gctx = genctx;
505
0
    const OSSL_PARAM *p;
506
507
0
    if (ossl_param_is_empty(params))
508
0
        return 1;
509
510
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_BITS)) != NULL) {
511
0
        if (!OSSL_PARAM_get_size_t(p, &gctx->nbits))
512
0
            return 0;
513
0
        if (gctx->nbits < RSA_MIN_MODULUS_BITS) {
514
0
            ERR_raise(ERR_LIB_PROV, PROV_R_KEY_SIZE_TOO_SMALL);
515
0
            return 0;
516
0
        }
517
0
    }
518
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_PRIMES)) != NULL
519
0
        && !OSSL_PARAM_get_size_t(p, &gctx->primes))
520
0
        return 0;
521
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_E)) != NULL
522
0
        && !OSSL_PARAM_get_BN(p, &gctx->pub_exp))
523
0
        return 0;
524
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_A)) != NULL) {
525
0
        if (!OSSL_PARAM_get_uint32(p, &gctx->a))
526
0
            return 0;
527
        /* a is an optional value that should be one of (0, 1, 3, 5, 7) */
528
0
        if (gctx->a != 0 && (gctx->a > 7 || (gctx->a & 1) == 0)) {
529
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
530
0
            return 0;
531
0
        }
532
0
    }
533
0
    if ((p = OSSL_PARAM_locate_const(params, OSSL_PKEY_PARAM_RSA_B)) != NULL) {
534
0
        if (!OSSL_PARAM_get_uint32(p, &gctx->b))
535
0
            return 0;
536
        /* b is an optional value that should be one of (0, 1, 3, 5, 7) */
537
0
        if (gctx->b != 0 && (gctx->b > 7 || (gctx->b & 1) == 0)) {
538
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
539
0
            return 0;
540
0
        }
541
0
    }
542
543
    /* Only attempt to get PSS parameters when generating an RSA-PSS key */
544
0
    if (gctx->rsa_type == RSA_FLAG_TYPE_RSASSAPSS
545
0
        && !pss_params_fromdata(&gctx->pss_params, &gctx->pss_defaults_set, params,
546
0
            gctx->rsa_type, gctx->libctx))
547
0
        return 0;
548
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
549
    /* Any ACVP test related parameters are copied into a params[] */
550
    if (!ossl_rsa_acvp_test_gen_params_new(&gctx->acvp_test_params, params))
551
        return 0;
552
#endif
553
0
    return 1;
554
0
}
555
556
#define rsa_gen_basic                                        \
557
0
    OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_BITS, NULL),       \
558
0
        OSSL_PARAM_size_t(OSSL_PKEY_PARAM_RSA_PRIMES, NULL), \
559
0
        OSSL_PARAM_BN(OSSL_PKEY_PARAM_RSA_E, NULL, 0),       \
560
0
        OSSL_PARAM_uint32(OSSL_PKEY_PARAM_RSA_A, NULL),      \
561
0
        OSSL_PARAM_uint32(OSSL_PKEY_PARAM_RSA_B, NULL)
562
/*
563
 * The following must be kept in sync with ossl_rsa_pss_params_30_fromdata()
564
 * in crypto/rsa/rsa_backend.c
565
 */
566
#define rsa_gen_pss                                                        \
567
0
    OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_DIGEST, NULL, 0),           \
568
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_DIGEST_PROPS, NULL, 0), \
569
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MASKGENFUNC, NULL, 0),  \
570
0
        OSSL_PARAM_utf8_string(OSSL_PKEY_PARAM_RSA_MGF1_DIGEST, NULL, 0),  \
571
0
        OSSL_PARAM_int(OSSL_PKEY_PARAM_RSA_PSS_SALTLEN, NULL)
572
573
static const OSSL_PARAM *rsa_gen_settable_params(ossl_unused void *genctx,
574
    ossl_unused void *provctx)
575
0
{
576
0
    static const OSSL_PARAM settable[] = {
577
0
        rsa_gen_basic,
578
0
        OSSL_PARAM_END
579
0
    };
580
581
0
    return settable;
582
0
}
583
584
static const OSSL_PARAM *rsapss_gen_settable_params(ossl_unused void *genctx,
585
    ossl_unused void *provctx)
586
0
{
587
0
    static const OSSL_PARAM settable[] = {
588
0
        rsa_gen_basic,
589
0
        rsa_gen_pss,
590
0
        OSSL_PARAM_END
591
0
    };
592
593
0
    return settable;
594
0
}
595
596
static void *rsa_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
597
0
{
598
0
    struct rsa_gen_ctx *gctx = genctx;
599
0
    RSA *rsa = NULL, *rsa_tmp = NULL;
600
0
    BN_GENCB *gencb = NULL;
601
602
0
    if (!ossl_prov_is_running() || gctx == NULL)
603
0
        return NULL;
604
605
0
    switch (gctx->rsa_type) {
606
0
    case RSA_FLAG_TYPE_RSA:
607
        /* For plain RSA keys, PSS parameters must not be set */
608
0
        if (!ossl_rsa_pss_params_30_is_unrestricted(&gctx->pss_params))
609
0
            goto err;
610
0
        break;
611
0
    case RSA_FLAG_TYPE_RSASSAPSS:
612
        /*
613
         * For plain RSA-PSS keys, PSS parameters may be set but don't have
614
         * to, so not check.
615
         */
616
0
        break;
617
0
    default:
618
        /* Unsupported RSA key sub-type... */
619
0
        return NULL;
620
0
    }
621
622
0
    if ((rsa_tmp = ossl_rsa_new_with_ctx(gctx->libctx)) == NULL)
623
0
        return NULL;
624
625
0
    gctx->cb = osslcb;
626
0
    gctx->cbarg = cbarg;
627
0
    gencb = BN_GENCB_new();
628
0
    if (gencb != NULL)
629
0
        BN_GENCB_set(gencb, rsa_gencb, genctx);
630
631
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
632
    if (gctx->acvp_test_params != NULL) {
633
        if (!ossl_rsa_acvp_test_set_params(rsa_tmp, gctx->acvp_test_params))
634
            goto err;
635
    }
636
#endif
637
638
0
    if (!ossl_rsa_generate_multi_prime_key(rsa_tmp,
639
0
            (int)gctx->nbits, (int)gctx->primes,
640
0
            gctx->pub_exp, gencb,
641
0
            gctx->a, gctx->b))
642
0
        goto err;
643
644
0
    if (!ossl_rsa_pss_params_30_copy(ossl_rsa_get0_pss_params_30(rsa_tmp),
645
0
            &gctx->pss_params))
646
0
        goto err;
647
648
0
    RSA_clear_flags(rsa_tmp, RSA_FLAG_TYPE_MASK);
649
0
    RSA_set_flags(rsa_tmp, gctx->rsa_type);
650
651
0
    rsa = rsa_tmp;
652
0
    rsa_tmp = NULL;
653
0
err:
654
0
    BN_GENCB_free(gencb);
655
0
    RSA_free(rsa_tmp);
656
0
    return rsa;
657
0
}
658
659
static void rsa_gen_cleanup(void *genctx)
660
0
{
661
0
    struct rsa_gen_ctx *gctx = genctx;
662
663
0
    if (gctx == NULL)
664
0
        return;
665
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
666
    ossl_rsa_acvp_test_gen_params_free(gctx->acvp_test_params);
667
    gctx->acvp_test_params = NULL;
668
#endif
669
0
    BN_clear_free(gctx->pub_exp);
670
0
    OPENSSL_free(gctx);
671
0
}
672
673
static void *common_load(const void *reference, size_t reference_sz,
674
    int expected_rsa_type)
675
0
{
676
0
    RSA *rsa = NULL;
677
678
0
    if (ossl_prov_is_running() && reference_sz == sizeof(rsa)) {
679
        /* The contents of the reference is the address to our object */
680
0
        rsa = *(RSA **)reference;
681
682
0
        if (RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK) != expected_rsa_type)
683
0
            return NULL;
684
685
        /* We grabbed, so we detach it */
686
0
        *(RSA **)reference = NULL;
687
0
        return rsa;
688
0
    }
689
0
    return NULL;
690
0
}
691
692
static void *rsa_load(const void *reference, size_t reference_sz)
693
0
{
694
0
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSA);
695
0
}
696
697
static void *rsapss_load(const void *reference, size_t reference_sz)
698
0
{
699
0
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSASSAPSS);
700
0
}
701
702
static void *rsa_dup(const void *keydata_from, int selection)
703
0
{
704
0
    if (ossl_prov_is_running()
705
        /* do not allow creating empty keys by duplication */
706
0
        && (selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
707
0
        return ossl_rsa_dup(keydata_from, selection);
708
0
    return NULL;
709
0
}
710
711
/* For any RSA key, we use the "RSA" algorithms regardless of sub-type. */
712
static const char *rsa_query_operation_name(int operation_id)
713
0
{
714
0
    return "RSA";
715
0
}
716
717
const OSSL_DISPATCH ossl_rsa_keymgmt_functions[] = {
718
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsa_newdata },
719
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsa_gen_init },
720
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS,
721
        (void (*)(void))rsa_gen_set_params },
722
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
723
        (void (*)(void))rsa_gen_settable_params },
724
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
725
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
726
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsa_load },
727
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
728
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*)(void))rsa_get_params },
729
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*)(void))rsa_gettable_params },
730
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
731
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
732
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
733
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
734
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
735
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
736
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
737
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
738
    OSSL_DISPATCH_END
739
};
740
741
const OSSL_DISPATCH ossl_rsapss_keymgmt_functions[] = {
742
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsapss_newdata },
743
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsapss_gen_init },
744
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))rsa_gen_set_params },
745
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
746
        (void (*)(void))rsapss_gen_settable_params },
747
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
748
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
749
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsapss_load },
750
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
751
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*)(void))rsa_get_params },
752
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*)(void))rsa_gettable_params },
753
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
754
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
755
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
756
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
757
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
758
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
759
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
760
    { OSSL_FUNC_KEYMGMT_QUERY_OPERATION_NAME,
761
        (void (*)(void))rsa_query_operation_name },
762
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
763
    OSSL_DISPATCH_END
764
};