Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl36/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
251k
    (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
51.4k
{
80
51.4k
    OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(provctx);
81
51.4k
    RSA *rsa;
82
83
51.4k
    if (!ossl_prov_is_running())
84
0
        return NULL;
85
86
51.4k
    rsa = ossl_rsa_new_with_ctx(libctx);
87
51.4k
    if (rsa != NULL) {
88
51.4k
        RSA_clear_flags(rsa, RSA_FLAG_TYPE_MASK);
89
51.4k
        RSA_set_flags(rsa, RSA_FLAG_TYPE_RSA);
90
51.4k
    }
91
51.4k
    return rsa;
92
51.4k
}
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
205k
{
112
205k
    RSA_free(keydata);
113
205k
}
114
115
static int rsa_has(const void *keydata, int selection)
116
165k
{
117
165k
    const RSA *rsa = keydata;
118
165k
    int ok = 1;
119
120
165k
    if (rsa == NULL || !ossl_prov_is_running())
121
0
        return 0;
122
165k
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
123
83.1k
        return 1; /* the selection is not missing */
124
125
    /* OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS are always available even if empty */
126
81.9k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
127
81.9k
        ok = ok && (RSA_get0_n(rsa) != NULL);
128
81.9k
    if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
129
59.1k
        ok = ok && (RSA_get0_e(rsa) != NULL);
130
81.9k
    if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
131
22.7k
        ok = ok && (RSA_get0_d(rsa) != NULL);
132
81.9k
    return ok;
133
165k
}
134
135
static int rsa_match(const void *keydata1, const void *keydata2, int selection)
136
106k
{
137
106k
    const RSA *rsa1 = keydata1;
138
106k
    const RSA *rsa2 = keydata2;
139
106k
    int ok = 1;
140
141
106k
    if (!ossl_prov_is_running())
142
0
        return 0;
143
144
    /* There is always an |e| */
145
106k
    ok = ok && BN_cmp(RSA_get0_e(rsa1), RSA_get0_e(rsa2)) == 0;
146
106k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
147
55.3k
        int key_checked = 0;
148
149
55.3k
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0) {
150
55.3k
            const BIGNUM *pa = RSA_get0_n(rsa1);
151
55.3k
            const BIGNUM *pb = RSA_get0_n(rsa2);
152
153
55.3k
            if (pa != NULL && pb != NULL) {
154
55.3k
                ok = ok && BN_cmp(pa, pb) == 0;
155
55.3k
                key_checked = 1;
156
55.3k
            }
157
55.3k
        }
158
55.3k
        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
55.3k
        ok = ok && key_checked;
169
55.3k
    }
170
106k
    return ok;
171
106k
}
172
173
static int rsa_import(void *keydata, int selection, const OSSL_PARAM params[])
174
51.4k
{
175
51.4k
    RSA *rsa = keydata;
176
51.4k
    int rsa_type;
177
51.4k
    int ok = 1;
178
51.4k
    int pss_defaults_set = 0;
179
180
51.4k
    if (!ossl_prov_is_running() || rsa == NULL)
181
0
        return 0;
182
183
51.4k
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
184
0
        return 0;
185
186
51.4k
    rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
187
188
51.4k
    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
51.4k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
191
51.4k
        int include_private = selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
192
193
51.4k
        ok = ok && ossl_rsa_fromdata(rsa, params, include_private);
194
51.4k
    }
195
196
51.4k
    return ok;
197
51.4k
}
198
199
static int rsa_export(void *keydata, int selection,
200
    OSSL_CALLBACK *param_callback, void *cbarg)
201
21.6k
{
202
21.6k
    RSA *rsa = keydata;
203
21.6k
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
204
21.6k
    OSSL_PARAM_BLD *tmpl;
205
21.6k
    OSSL_PARAM *params = NULL;
206
21.6k
    int ok = 1;
207
208
21.6k
    if (!ossl_prov_is_running() || rsa == NULL)
209
0
        return 0;
210
211
21.6k
    if ((selection & RSA_POSSIBLE_SELECTIONS) == 0)
212
0
        return 0;
213
214
21.6k
    tmpl = OSSL_PARAM_BLD_new();
215
21.6k
    if (tmpl == NULL)
216
0
        return 0;
217
218
21.6k
    if ((selection & OSSL_KEYMGMT_SELECT_OTHER_PARAMETERS) != 0)
219
21.6k
        ok = ok && (ossl_rsa_pss_params_30_is_unrestricted(pss_params) || ossl_rsa_pss_params_30_todata(pss_params, tmpl, NULL));
220
21.6k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0) {
221
21.6k
        int include_private = selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY ? 1 : 0;
222
223
21.6k
        ok = ok && ossl_rsa_todata(rsa, tmpl, NULL, include_private);
224
21.6k
    }
225
226
21.6k
    if (!ok || (params = OSSL_PARAM_BLD_to_param(tmpl)) == NULL) {
227
0
        ok = 0;
228
0
        goto err;
229
0
    }
230
231
21.6k
    ok = param_callback(params, cbarg);
232
21.6k
    OSSL_PARAM_free(params);
233
21.6k
err:
234
21.6k
    OSSL_PARAM_BLD_free(tmpl);
235
21.6k
    return ok;
236
21.6k
}
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
50.8k
{
326
50.8k
    RSA *rsa = key;
327
50.8k
    const RSA_PSS_PARAMS_30 *pss_params = ossl_rsa_get0_pss_params_30(rsa);
328
50.8k
    int rsa_type = RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK);
329
50.8k
    OSSL_PARAM *p;
330
50.8k
    int empty = RSA_get0_n(rsa) == NULL;
331
332
50.8k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
333
50.8k
        && (empty || !OSSL_PARAM_set_int(p, RSA_bits(rsa))))
334
0
        return 0;
335
50.8k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
336
50.8k
        && (empty || !OSSL_PARAM_set_int(p, RSA_security_bits(rsa))))
337
0
        return 0;
338
50.8k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
339
50.8k
        && (empty || !OSSL_PARAM_set_int(p, RSA_size(rsa))))
340
0
        return 0;
341
50.8k
    if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_CATEGORY)) != NULL)
342
50.8k
        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
50.8k
    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
50.8k
    if ((p = OSSL_PARAM_locate(params,
361
50.8k
             OSSL_PKEY_PARAM_MANDATORY_DIGEST))
362
50.8k
            != 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
50.8k
    return (rsa_type != RSA_FLAG_TYPE_RSASSAPSS
371
2.97k
               || ossl_rsa_pss_params_30_todata(pss_params, NULL, params))
372
50.8k
        && ossl_rsa_todata(rsa, NULL, params, 1);
373
50.8k
}
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
13.6k
{
392
13.6k
    const RSA *rsa = keydata;
393
13.6k
    int ok = 1;
394
395
13.6k
    if (!ossl_prov_is_running())
396
0
        return 0;
397
398
13.6k
    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
13.6k
    if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR)
403
13.6k
        == OSSL_KEYMGMT_SELECT_KEYPAIR) {
404
2.96k
        ok = ok && ossl_rsa_validate_pairwise(rsa);
405
10.6k
    } else {
406
10.6k
        if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
407
2.96k
            ok = ok && ossl_rsa_validate_private(rsa);
408
10.6k
        if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
409
3.85k
            ok = ok && ossl_rsa_validate_public(rsa);
410
10.6k
    }
411
13.6k
    return ok;
412
13.6k
}
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
static void *rsa_gen(void *genctx, OSSL_CALLBACK *osslcb, void *cbarg)
576
0
{
577
0
    struct rsa_gen_ctx *gctx = genctx;
578
0
    RSA *rsa = NULL, *rsa_tmp = NULL;
579
0
    BN_GENCB *gencb = NULL;
580
581
0
    if (!ossl_prov_is_running() || gctx == NULL)
582
0
        return NULL;
583
584
0
    switch (gctx->rsa_type) {
585
0
    case RSA_FLAG_TYPE_RSA:
586
        /* For plain RSA keys, PSS parameters must not be set */
587
0
        if (!ossl_rsa_pss_params_30_is_unrestricted(&gctx->pss_params))
588
0
            goto err;
589
0
        break;
590
0
    case RSA_FLAG_TYPE_RSASSAPSS:
591
        /*
592
         * For plain RSA-PSS keys, PSS parameters may be set but don't have
593
         * to, so not check.
594
         */
595
0
        break;
596
0
    default:
597
        /* Unsupported RSA key sub-type... */
598
0
        return NULL;
599
0
    }
600
601
0
    if ((rsa_tmp = ossl_rsa_new_with_ctx(gctx->libctx)) == NULL)
602
0
        return NULL;
603
604
0
    gctx->cb = osslcb;
605
0
    gctx->cbarg = cbarg;
606
0
    gencb = BN_GENCB_new();
607
0
    if (gencb != NULL)
608
0
        BN_GENCB_set(gencb, rsa_gencb, genctx);
609
610
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
611
    if (gctx->acvp_test_params != NULL) {
612
        if (!ossl_rsa_acvp_test_set_params(rsa_tmp, gctx->acvp_test_params))
613
            goto err;
614
    }
615
#endif
616
617
0
    if (!RSA_generate_multi_prime_key(rsa_tmp,
618
0
            (int)gctx->nbits, (int)gctx->primes,
619
0
            gctx->pub_exp, gencb))
620
0
        goto err;
621
622
0
    if (!ossl_rsa_pss_params_30_copy(ossl_rsa_get0_pss_params_30(rsa_tmp),
623
0
            &gctx->pss_params))
624
0
        goto err;
625
626
0
    RSA_clear_flags(rsa_tmp, RSA_FLAG_TYPE_MASK);
627
0
    RSA_set_flags(rsa_tmp, gctx->rsa_type);
628
629
0
    rsa = rsa_tmp;
630
0
    rsa_tmp = NULL;
631
0
err:
632
0
    BN_GENCB_free(gencb);
633
0
    RSA_free(rsa_tmp);
634
0
    return rsa;
635
0
}
636
637
static void rsa_gen_cleanup(void *genctx)
638
0
{
639
0
    struct rsa_gen_ctx *gctx = genctx;
640
641
0
    if (gctx == NULL)
642
0
        return;
643
#if defined(FIPS_MODULE) && !defined(OPENSSL_NO_ACVP_TESTS)
644
    ossl_rsa_acvp_test_gen_params_free(gctx->acvp_test_params);
645
    gctx->acvp_test_params = NULL;
646
#endif
647
0
    BN_clear_free(gctx->pub_exp);
648
0
    OPENSSL_free(gctx);
649
0
}
650
651
static void *common_load(const void *reference, size_t reference_sz,
652
    int expected_rsa_type)
653
150k
{
654
150k
    RSA *rsa = NULL;
655
656
150k
    if (ossl_prov_is_running() && reference_sz == sizeof(rsa)) {
657
        /* The contents of the reference is the address to our object */
658
150k
        rsa = *(RSA **)reference;
659
660
150k
        if (RSA_test_flags(rsa, RSA_FLAG_TYPE_MASK) != expected_rsa_type)
661
0
            return NULL;
662
663
        /* We grabbed, so we detach it */
664
150k
        *(RSA **)reference = NULL;
665
150k
        return rsa;
666
150k
    }
667
0
    return NULL;
668
150k
}
669
670
static void *rsa_load(const void *reference, size_t reference_sz)
671
130k
{
672
130k
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSA);
673
130k
}
674
675
static void *rsapss_load(const void *reference, size_t reference_sz)
676
19.3k
{
677
19.3k
    return common_load(reference, reference_sz, RSA_FLAG_TYPE_RSASSAPSS);
678
19.3k
}
679
680
static void *rsa_dup(const void *keydata_from, int selection)
681
3.85k
{
682
3.85k
    if (ossl_prov_is_running()
683
        /* do not allow creating empty keys by duplication */
684
3.85k
        && (selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
685
3.85k
        return ossl_rsa_dup(keydata_from, selection);
686
0
    return NULL;
687
3.85k
}
688
689
/* For any RSA key, we use the "RSA" algorithms regardless of sub-type. */
690
static const char *rsa_query_operation_name(int operation_id)
691
704
{
692
704
    return "RSA";
693
704
}
694
695
const OSSL_DISPATCH ossl_rsa_keymgmt_functions[] = {
696
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsa_newdata },
697
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsa_gen_init },
698
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS,
699
        (void (*)(void))rsa_gen_set_params },
700
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
701
        (void (*)(void))rsa_gen_settable_params },
702
    { OSSL_FUNC_KEYMGMT_GEN, (void (*)(void))rsa_gen },
703
    { OSSL_FUNC_KEYMGMT_GEN_CLEANUP, (void (*)(void))rsa_gen_cleanup },
704
    { OSSL_FUNC_KEYMGMT_LOAD, (void (*)(void))rsa_load },
705
    { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))rsa_freedata },
706
    { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*)(void))rsa_get_params },
707
    { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*)(void))rsa_gettable_params },
708
    { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))rsa_has },
709
    { OSSL_FUNC_KEYMGMT_MATCH, (void (*)(void))rsa_match },
710
    { OSSL_FUNC_KEYMGMT_VALIDATE, (void (*)(void))rsa_validate },
711
    { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))rsa_import },
712
    { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))rsa_import_types },
713
    { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))rsa_export },
714
    { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))rsa_export_types },
715
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
716
    OSSL_DISPATCH_END
717
};
718
719
const OSSL_DISPATCH ossl_rsapss_keymgmt_functions[] = {
720
    { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))rsapss_newdata },
721
    { OSSL_FUNC_KEYMGMT_GEN_INIT, (void (*)(void))rsapss_gen_init },
722
    { OSSL_FUNC_KEYMGMT_GEN_SET_PARAMS, (void (*)(void))rsa_gen_set_params },
723
    { OSSL_FUNC_KEYMGMT_GEN_SETTABLE_PARAMS,
724
        (void (*)(void))rsapss_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))rsapss_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_QUERY_OPERATION_NAME,
739
        (void (*)(void))rsa_query_operation_name },
740
    { OSSL_FUNC_KEYMGMT_DUP, (void (*)(void))rsa_dup },
741
    OSSL_DISPATCH_END
742
};