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