providers/implementations/keymgmt/rsa_kmgmt.c

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