providers/fips/fipsprov.c

   1 /*
   2  * Copyright 2019-2020 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 #include <string.h>
  11 #include <stdio.h>
  12 #include <openssl/core.h>
  13 #include <openssl/core_numbers.h>
  14 #include <openssl/core_names.h>
  15 #include <openssl/params.h>
  16 #include <openssl/err.h>
  17 #include <openssl/evp.h>
  18 #include <openssl/kdf.h>
  19
  20 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
  21 #include <openssl/sha.h>
  22 #include <openssl/rand_drbg.h>
  23 #include <openssl/ec.h>
  24 #include <openssl/fips_names.h>
  25
  26 #include "internal/cryptlib.h"
  27 #include "internal/property.h"
  28 #include "internal/nelem.h"
  29 #include "openssl/param_build.h"
  30 #include "crypto/evp.h"
  31 #include "prov/implementations.h"
  32 #include "prov/provider_ctx.h"
  33 #include "prov/providercommon.h"
  34 #include "prov/provider_util.h"
  35 #include "self_test.h"
  36
  37 /*
  38  * Forward declarations to ensure that interface functions are correctly
  39  * defined.
  40  */
  41 static OSSL_provider_teardown_fn fips_teardown;
  42 static OSSL_provider_gettable_params_fn fips_gettable_params;
  43 static OSSL_provider_get_params_fn fips_get_params;
  44 static OSSL_provider_query_operation_fn fips_query;
  45
  46 #define ALGC(NAMES, FUNC, CHECK) { { NAMES, "provider=fips,fips=yes", FUNC }, CHECK }
  47 #define ALG(NAMES, FUNC) ALGC(NAMES, FUNC, NULL)
  48
  49 extern OSSL_core_thread_start_fn *c_thread_start;
  50
  51 /*
  52  * TODO(3.0): Should these be stored in the provider side provctx? Could they
  53  * ever be different from one init to the next? Unfortunately we can't do this
  54  * at the moment because c_put_error/c_add_error_vdata do not provide
  55  * us with the OPENSSL_CTX as a parameter.
  56  */
  57
  58 static SELF_TEST_POST_PARAMS selftest_params;
  59
  60 /* Functions provided by the core */
  61 static OSSL_core_gettable_params_fn *c_gettable_params;
  62 static OSSL_core_get_params_fn *c_get_params;
  63 OSSL_core_thread_start_fn *c_thread_start;
  64 static OSSL_core_new_error_fn *c_new_error;
  65 static OSSL_core_set_error_debug_fn *c_set_error_debug;
  66 static OSSL_core_vset_error_fn *c_vset_error;
  67 static OSSL_core_set_error_mark_fn *c_set_error_mark;
  68 static OSSL_core_clear_last_error_mark_fn *c_clear_last_error_mark;
  69 static OSSL_core_pop_error_to_mark_fn *c_pop_error_to_mark;
  70 static OSSL_CRYPTO_malloc_fn *c_CRYPTO_malloc;
  71 static OSSL_CRYPTO_zalloc_fn *c_CRYPTO_zalloc;
  72 static OSSL_CRYPTO_free_fn *c_CRYPTO_free;
  73 static OSSL_CRYPTO_clear_free_fn *c_CRYPTO_clear_free;
  74 static OSSL_CRYPTO_realloc_fn *c_CRYPTO_realloc;
  75 static OSSL_CRYPTO_clear_realloc_fn *c_CRYPTO_clear_realloc;
  76 static OSSL_CRYPTO_secure_malloc_fn *c_CRYPTO_secure_malloc;
  77 static OSSL_CRYPTO_secure_zalloc_fn *c_CRYPTO_secure_zalloc;
  78 static OSSL_CRYPTO_secure_free_fn *c_CRYPTO_secure_free;
  79 static OSSL_CRYPTO_secure_clear_free_fn *c_CRYPTO_secure_clear_free;
  80 static OSSL_CRYPTO_secure_allocated_fn *c_CRYPTO_secure_allocated;
  81 static OSSL_BIO_vsnprintf_fn *c_BIO_vsnprintf;
  82
  83 typedef struct fips_global_st {
  84     const OSSL_CORE_HANDLE *handle;
  85 } FIPS_GLOBAL;
  86
  87 static void *fips_prov_ossl_ctx_new(OPENSSL_CTX *libctx)
  88 {
  89     FIPS_GLOBAL *fgbl = OPENSSL_zalloc(sizeof(*fgbl));
  90
  91     return fgbl;
  92 }
  93
  94 static void fips_prov_ossl_ctx_free(void *fgbl)
  95 {
  96     OPENSSL_free(fgbl);
  97 }
  98
  99 static const OPENSSL_CTX_METHOD fips_prov_ossl_ctx_method = {
 100     fips_prov_ossl_ctx_new,
 101     fips_prov_ossl_ctx_free,
 102 };
 103
 104
 105 /* Parameters we provide to the core */
 106 static const OSSL_PARAM fips_param_types[] = {
 107     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
 108     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
 109     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
 110     OSSL_PARAM_END
 111 };
 112
 113 /*
 114  * Parameters to retrieve from the core provider - required for self testing.
 115  * NOTE: inside core_get_params() these will be loaded from config items
 116  * stored inside prov->parameters (except for
 117  * OSSL_PROV_PARAM_CORE_MODULE_FILENAME).
 118  */
 119 static OSSL_PARAM core_params[] =
 120 {
 121     OSSL_PARAM_utf8_ptr(OSSL_PROV_PARAM_CORE_MODULE_FILENAME,
 122                         selftest_params.module_filename,
 123                         sizeof(selftest_params.module_filename)),
 124     OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_MODULE_MAC,
 125                         selftest_params.module_checksum_data,
 126                         sizeof(selftest_params.module_checksum_data)),
 127     OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_MAC,
 128                         selftest_params.indicator_checksum_data,
 129                         sizeof(selftest_params.indicator_checksum_data)),
 130     OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_STATUS,
 131                         selftest_params.indicator_data,
 132                         sizeof(selftest_params.indicator_data)),
 133     OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_VERSION,
 134                         selftest_params.indicator_version,
 135                         sizeof(selftest_params.indicator_version)),
 136     OSSL_PARAM_END
 137 };
 138
 139 /* TODO(3.0): To be removed */
 140 static int dummy_evp_call(OPENSSL_CTX *libctx)
 141 {
 142     EVP_MD_CTX *ctx = EVP_MD_CTX_new();
 143     EVP_MD *sha256 = EVP_MD_fetch(libctx, "SHA256", NULL);
 144     EVP_KDF *kdf = EVP_KDF_fetch(libctx, OSSL_KDF_NAME_PBKDF2, NULL);
 145     unsigned char dgst[SHA256_DIGEST_LENGTH];
 146     unsigned int dgstlen;
 147     int ret = 0;
 148     BN_CTX *bnctx = NULL;
 149     BIGNUM *a = NULL, *b = NULL;
 150     unsigned char randbuf[128];
 151     RAND_DRBG *drbg = OPENSSL_CTX_get0_public_drbg(libctx);
 152 #ifndef OPENSSL_NO_EC
 153     EC_KEY *key = NULL;
 154 #endif
 155
 156     static const char msg[] = "Hello World!";
 157     static const unsigned char exptd[] = {
 158         0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
 159         0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
 160         0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
 161     };
 162
 163     if (ctx == NULL || sha256 == NULL || drbg == NULL || kdf == NULL)
 164         goto err;
 165
 166     if (!EVP_DigestInit_ex(ctx, sha256, NULL))
 167         goto err;
 168     if (!EVP_DigestUpdate(ctx, msg, sizeof(msg) - 1))
 169         goto err;
 170     if (!EVP_DigestFinal(ctx, dgst, &dgstlen))
 171         goto err;
 172     if (dgstlen != sizeof(exptd) || memcmp(dgst, exptd, sizeof(exptd)) != 0)
 173         goto err;
 174
 175     bnctx = BN_CTX_new_ex(libctx);
 176     if (bnctx == NULL)
 177         goto err;
 178     BN_CTX_start(bnctx);
 179     a = BN_CTX_get(bnctx);
 180     b = BN_CTX_get(bnctx);
 181     if (b == NULL)
 182         goto err;
 183     BN_zero(a);
 184     if (!BN_one(b)
 185         || !BN_add(a, a, b)
 186         || BN_cmp(a, b) != 0)
 187         goto err;
 188
 189     if (RAND_DRBG_bytes(drbg, randbuf, sizeof(randbuf)) <= 0)
 190         goto err;
 191
 192     if (!BN_rand_ex(a, 256, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY, bnctx))
 193         goto err;
 194
 195 #ifndef OPENSSL_NO_EC
 196     /* Do some dummy EC calls */
 197     key = EC_KEY_new_by_curve_name_ex(libctx, NID_X9_62_prime256v1);
 198     if (key == NULL)
 199         goto err;
 200
 201     if (!EC_KEY_generate_key(key))
 202         goto err;
 203 #endif
 204
 205     ret = 1;
 206  err:
 207     BN_CTX_end(bnctx);
 208     BN_CTX_free(bnctx);
 209
 210     EVP_KDF_free(kdf);
 211     EVP_MD_CTX_free(ctx);
 212     EVP_MD_free(sha256);
 213
 214 #ifndef OPENSSL_NO_EC
 215     EC_KEY_free(key);
 216 #endif
 217     return ret;
 218 }
 219
 220 static const OSSL_PARAM *fips_gettable_params(void *provctx)
 221 {
 222     return fips_param_types;
 223 }
 224
 225 static int fips_get_params(void *provctx, OSSL_PARAM params[])
 226 {
 227     OSSL_PARAM *p;
 228
 229     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
 230     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
 231         return 0;
 232     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
 233     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
 234         return 0;
 235     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
 236     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
 237         return 0;
 238
 239     return 1;
 240 }
 241
 242 /* FIPS specific version of the function of the same name in provlib.c */
 243 const char *ossl_prov_util_nid_to_name(int nid)
 244 {
 245     /* We don't have OBJ_nid2n() in FIPS_MODULE so we have an explicit list */
 246
 247     switch (nid) {
 248     /* Digests */
 249     case NID_sha1:
 250         return "SHA1";
 251     case NID_sha224:
 252         return "SHA-224";
 253     case NID_sha256:
 254         return "SHA-256";
 255     case NID_sha384:
 256         return "SHA-384";
 257     case NID_sha512:
 258         return "SHA-512";
 259     case NID_sha512_224:
 260         return "SHA-512/224";
 261     case NID_sha512_256:
 262         return "SHA-512/256";
 263     case NID_sha3_224:
 264         return "SHA3-224";
 265     case NID_sha3_256:
 266         return "SHA3-256";
 267     case NID_sha3_384:
 268         return "SHA3-384";
 269     case NID_sha3_512:
 270         return "SHA3-512";
 271
 272     /* Ciphers */
 273     case NID_aes_256_ecb:
 274         return "AES-256-ECB";
 275     case NID_aes_192_ecb:
 276         return "AES-192-ECB";
 277     case NID_aes_128_ecb:
 278         return "AES-128-ECB";
 279     case NID_aes_256_cbc:
 280         return "AES-256-CBC";
 281     case NID_aes_192_cbc:
 282         return "AES-192-CBC";
 283     case NID_aes_128_cbc:
 284         return "AES-128-CBC";
 285     case NID_aes_256_ctr:
 286         return "AES-256-CTR";
 287     case NID_aes_192_ctr:
 288         return "AES-192-CTR";
 289     case NID_aes_128_ctr:
 290         return "AES-128-CTR";
 291     case NID_aes_256_xts:
 292         return "AES-256-XTS";
 293     case NID_aes_128_xts:
 294         return "AES-128-XTS";
 295     case NID_aes_256_gcm:
 296         return "AES-256-GCM";
 297     case NID_aes_192_gcm:
 298         return "AES-192-GCM";
 299     case NID_aes_128_gcm:
 300         return "AES-128-GCM";
 301     case NID_aes_256_ccm:
 302         return "AES-256-CCM";
 303     case NID_aes_192_ccm:
 304         return "AES-192-CCM";
 305     case NID_aes_128_ccm:
 306         return "AES-128-CCM";
 307     case NID_id_aes256_wrap:
 308         return "AES-256-WRAP";
 309     case NID_id_aes192_wrap:
 310         return "AES-192-WRAP";
 311     case NID_id_aes128_wrap:
 312         return "AES-128-WRAP";
 313     case NID_id_aes256_wrap_pad:
 314         return "AES-256-WRAP-PAD";
 315     case NID_id_aes192_wrap_pad:
 316         return "AES-192-WRAP-PAD";
 317     case NID_id_aes128_wrap_pad:
 318         return "AES-128-WRAP-PAD";
 319     case NID_des_ede3_ecb:
 320         return "DES-EDE3";
 321     case NID_des_ede3_cbc:
 322         return "DES-EDE3-CBC";
 323     case NID_aes_256_cbc_hmac_sha256:
 324         return "AES-256-CBC-HMAC-SHA256";
 325     case NID_aes_128_cbc_hmac_sha256:
 326         return "AES-128-CBC-HMAC-SHA256";
 327     case NID_aes_256_cbc_hmac_sha1:
 328         return "AES-256-CBC-HMAC-SHA1";
 329     case NID_aes_128_cbc_hmac_sha1:
 330         return "AES-128-CBC-HMAC-SHA1";
 331     default:
 332         break;
 333     }
 334
 335     return NULL;
 336 }
 337
 338 /*
 339  * For the algorithm names, we use the following formula for our primary
 340  * names:
 341  *
 342  *     ALGNAME[VERSION?][-SUBNAME[VERSION?]?][-SIZE?][-MODE?]
 343  *
 344  *     VERSION is only present if there are multiple versions of
 345  *     an alg (MD2, MD4, MD5).  It may be omitted if there is only
 346  *     one version (if a subsequent version is released in the future,
 347  *     we can always change the canonical name, and add the old name
 348  *     as an alias).
 349  *
 350  *     SUBNAME may be present where we are combining multiple
 351  *     algorithms together, e.g. MD5-SHA1.
 352  *
 353  *     SIZE is only present if multiple versions of an algorithm exist
 354  *     with different sizes (e.g. AES-128-CBC, AES-256-CBC)
 355  *
 356  *     MODE is only present where applicable.
 357  *
 358  * We add diverse other names where applicable, such as the names that
 359  * NIST uses, or that are used for ASN.1 OBJECT IDENTIFIERs, or names
 360  * we have used historically.
 361  */
 362 static const OSSL_ALGORITHM fips_digests[] = {
 363     /* Our primary name:NiST name[:our older names] */
 364     { "SHA1:SHA-1", "provider=fips,fips=yes", sha1_functions },
 365     { "SHA2-224:SHA-224:SHA224", "provider=fips,fips=yes", sha224_functions },
 366     { "SHA2-256:SHA-256:SHA256", "provider=fips,fips=yes", sha256_functions },
 367     { "SHA2-384:SHA-384:SHA384", "provider=fips,fips=yes", sha384_functions },
 368     { "SHA2-512:SHA-512:SHA512", "provider=fips,fips=yes", sha512_functions },
 369     { "SHA2-512/224:SHA-512/224:SHA512-224", "provider=fips,fips=yes",
 370       sha512_224_functions },
 371     { "SHA2-512/256:SHA-512/256:SHA512-256", "provider=fips,fips=yes",
 372       sha512_256_functions },
 373
 374     /* We agree with NIST here, so one name only */
 375     { "SHA3-224", "provider=fips,fips=yes", sha3_224_functions },
 376     { "SHA3-256", "provider=fips,fips=yes", sha3_256_functions },
 377     { "SHA3-384", "provider=fips,fips=yes", sha3_384_functions },
 378     { "SHA3-512", "provider=fips,fips=yes", sha3_512_functions },
 379
 380     /* Non-FIPS algorithm to support oneshot_hash in the Ed448 code */
 381     { "SHAKE-256:SHAKE256", "provider=fips,fips=no", shake_256_functions },
 382     { NULL, NULL, NULL }
 383 };
 384
 385 static const OSSL_ALGORITHM_CAPABLE fips_ciphers[] = {
 386     /* Our primary name[:ASN.1 OID name][:our older names] */
 387     ALG("AES-256-ECB", aes256ecb_functions),
 388     ALG("AES-192-ECB", aes192ecb_functions),
 389     ALG("AES-128-ECB", aes128ecb_functions),
 390     ALG("AES-256-CBC", aes256cbc_functions),
 391     ALG("AES-192-CBC", aes192cbc_functions),
 392     ALG("AES-128-CBC", aes128cbc_functions),
 393     ALG("AES-256-OFB", aes256ofb_functions),
 394     ALG("AES-192-OFB", aes192ofb_functions),
 395     ALG("AES-128-OFB", aes128ofb_functions),
 396     ALG("AES-256-CFB", aes256cfb_functions),
 397     ALG("AES-192-CFB", aes192cfb_functions),
 398     ALG("AES-128-CFB", aes128cfb_functions),
 399     ALG("AES-256-CFB1", aes256cfb1_functions),
 400     ALG("AES-192-CFB1", aes192cfb1_functions),
 401     ALG("AES-128-CFB1", aes128cfb1_functions),
 402     ALG("AES-256-CFB8", aes256cfb8_functions),
 403     ALG("AES-192-CFB8", aes192cfb8_functions),
 404     ALG("AES-128-CFB8", aes128cfb8_functions),
 405     ALG("AES-256-CTR", aes256ctr_functions),
 406     ALG("AES-192-CTR", aes192ctr_functions),
 407     ALG("AES-128-CTR", aes128ctr_functions),
 408     ALG("AES-256-XTS", aes256xts_functions),
 409     ALG("AES-128-XTS", aes128xts_functions),
 410     ALG("AES-256-GCM:id-aes256-GCM", aes256gcm_functions),
 411     ALG("AES-192-GCM:id-aes192-GCM", aes192gcm_functions),
 412     ALG("AES-128-GCM:id-aes128-GCM", aes128gcm_functions),
 413     ALG("AES-256-CCM:id-aes256-CCM", aes256ccm_functions),
 414     ALG("AES-192-CCM:id-aes192-CCM", aes192ccm_functions),
 415     ALG("AES-128-CCM:id-aes128-CCM", aes128ccm_functions),
 416     ALG("AES-256-WRAP:id-aes256-wrap:AES256-WRAP", aes256wrap_functions),
 417     ALG("AES-192-WRAP:id-aes192-wrap:AES192-WRAP", aes192wrap_functions),
 418     ALG("AES-128-WRAP:id-aes128-wrap:AES128-WRAP", aes128wrap_functions),
 419     ALG("AES-256-WRAP-PAD:id-aes256-wrap-pad:AES256-WRAP-PAD",
 420         aes256wrappad_functions),
 421     ALG("AES-192-WRAP-PAD:id-aes192-wrap-pad:AES192-WRAP-PAD",
 422         aes192wrappad_functions),
 423     ALG("AES-128-WRAP-PAD:id-aes128-wrap-pad:AES128-WRAP-PAD",
 424         aes128wrappad_functions),
 425     ALGC("AES-128-CBC-HMAC-SHA1", aes128cbc_hmac_sha1_functions,
 426          cipher_capable_aes_cbc_hmac_sha1),
 427     ALGC("AES-256-CBC-HMAC-SHA1", aes256cbc_hmac_sha1_functions,
 428          cipher_capable_aes_cbc_hmac_sha1),
 429     ALGC("AES-128-CBC-HMAC-SHA256", aes128cbc_hmac_sha256_functions,
 430          cipher_capable_aes_cbc_hmac_sha256),
 431     ALGC("AES-256-CBC-HMAC-SHA256", aes256cbc_hmac_sha256_functions,
 432          cipher_capable_aes_cbc_hmac_sha256),
 433 #ifndef OPENSSL_NO_DES
 434     ALG("DES-EDE3-ECB:DES-EDE3", tdes_ede3_ecb_functions),
 435     ALG("DES-EDE3-CBC:DES3", tdes_ede3_cbc_functions),
 436 #endif  /* OPENSSL_NO_DES */
 437     { { NULL, NULL, NULL }, NULL }
 438 };
 439 static OSSL_ALGORITHM exported_fips_ciphers[OSSL_NELEM(fips_ciphers)];
 440
 441 static const OSSL_ALGORITHM fips_macs[] = {
 442     { "GMAC", "provider=fips,fips=yes", gmac_functions },
 443     { "HMAC", "provider=fips,fips=yes", hmac_functions },
 444     { NULL, NULL, NULL }
 445 };
 446
 447 static const OSSL_ALGORITHM fips_kdfs[] = {
 448     { "HKDF", "provider=fips,fips=yes", kdf_hkdf_functions },
 449     { "SSKDF", "provider=fips,fips=yes", kdf_sskdf_functions },
 450     { "PBKDF2", "provider=fips,fips=yes", kdf_pbkdf2_functions },
 451     { "TLS1-PRF", "provider=fips,fips=yes", kdf_tls1_prf_functions },
 452     { NULL, NULL, NULL }
 453 };
 454
 455 static const OSSL_ALGORITHM fips_keyexch[] = {
 456 #ifndef OPENSSL_NO_DH
 457     { "DH:dhKeyAgreement", "provider=fips,fips=yes", dh_keyexch_functions },
 458 #endif
 459 #ifndef OPENSSL_NO_EC
 460     { "ECDH", "provider=fips,fips=yes", ecdh_keyexch_functions },
 461     { "X25519", "provider=fips,fips=no", x25519_keyexch_functions },
 462     { "X448", "provider=fips,fips=no", x448_keyexch_functions },
 463 #endif
 464     { NULL, NULL, NULL }
 465 };
 466
 467 static const OSSL_ALGORITHM fips_signature[] = {
 468 #ifndef OPENSSL_NO_DSA
 469     { "DSA:dsaEncryption", "provider=fips,fips=yes", dsa_signature_functions },
 470 #endif
 471     { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_signature_functions },
 472 #ifndef OPENSSL_NO_EC
 473     { "ED25519", "provider=fips,fips=no", ed25519_signature_functions },
 474     { "ED448", "provider=fips,fips=no", ed448_signature_functions },
 475     { "ECDSA", "provider=fips,fips=yes", ecdsa_signature_functions },
 476 #endif
 477     { NULL, NULL, NULL }
 478 };
 479
 480 static const OSSL_ALGORITHM fips_asym_cipher[] = {
 481     { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_asym_cipher_functions },
 482     { NULL, NULL, NULL }
 483 };
 484
 485 static const OSSL_ALGORITHM fips_keymgmt[] = {
 486 #ifndef OPENSSL_NO_DH
 487     { "DH:dhKeyAgreement", "provider=fips,fips=yes", dh_keymgmt_functions },
 488 #endif
 489 #ifndef OPENSSL_NO_DSA
 490     { "DSA", "provider=fips,fips=yes", dsa_keymgmt_functions },
 491 #endif
 492     { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_keymgmt_functions },
 493     { "RSA-PSS:RSASSA-PSS", "provider=default", rsapss_keymgmt_functions },
 494 #ifndef OPENSSL_NO_EC
 495     { "EC:id-ecPublicKey", "provider=fips,fips=yes", ec_keymgmt_functions },
 496     { "X25519", "provider=fips,fips=no", x25519_keymgmt_functions },
 497     { "X448", "provider=fips,fips=no", x448_keymgmt_functions },
 498     { "ED25519", "provider=fips,fips=no", ed25519_keymgmt_functions },
 499     { "ED448", "provider=fips,fips=no", ed448_keymgmt_functions },
 500 #endif
 501     { NULL, NULL, NULL }
 502 };
 503
 504 static const OSSL_ALGORITHM *fips_query(void *provctx, int operation_id,
 505                                         int *no_cache)
 506 {
 507     *no_cache = 0;
 508     switch (operation_id) {
 509     case OSSL_OP_DIGEST:
 510         return fips_digests;
 511     case OSSL_OP_CIPHER:
 512         ossl_prov_cache_exported_algorithms(fips_ciphers, exported_fips_ciphers);
 513         return exported_fips_ciphers;
 514     case OSSL_OP_MAC:
 515         return fips_macs;
 516     case OSSL_OP_KDF:
 517         return fips_kdfs;
 518     case OSSL_OP_KEYMGMT:
 519         return fips_keymgmt;
 520     case OSSL_OP_KEYEXCH:
 521         return fips_keyexch;
 522     case OSSL_OP_SIGNATURE:
 523         return fips_signature;
 524     case OSSL_OP_ASYM_CIPHER:
 525         return fips_asym_cipher;
 526     }
 527     return NULL;
 528 }
 529
 530 static void fips_teardown(void *provctx)
 531 {
 532     OPENSSL_CTX_free(PROV_LIBRARY_CONTEXT_OF(provctx));
 533     PROV_CTX_free(provctx);
 534 }
 535
 536 static void fips_intern_teardown(void *provctx)
 537 {
 538     /*
 539      * We know that the library context is the same as for the outer provider,
 540      * so no need to destroy it here.
 541      */
 542     PROV_CTX_free(provctx);
 543 }
 544
 545 /* Functions we provide to the core */
 546 static const OSSL_DISPATCH fips_dispatch_table[] = {
 547     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_teardown },
 548     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))fips_gettable_params },
 549     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
 550     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 551     { 0, NULL }
 552 };
 553
 554 /* Functions we provide to ourself */
 555 static const OSSL_DISPATCH intern_dispatch_table[] = {
 556     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_intern_teardown },
 557     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 558     { 0, NULL }
 559 };
 560
 561
 562 int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
 563                        const OSSL_DISPATCH *in,
 564                        const OSSL_DISPATCH **out,
 565                        void **provctx)
 566 {
 567     FIPS_GLOBAL *fgbl;
 568     OPENSSL_CTX *libctx = NULL;
 569     OSSL_self_test_cb_fn *stcbfn = NULL;
 570     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
 571
 572     for (; in->function_id != 0; in++) {
 573         switch (in->function_id) {
 574         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
 575             c_get_libctx = OSSL_get_core_get_library_context(in);
 576             break;
 577         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
 578             c_gettable_params = OSSL_get_core_gettable_params(in);
 579             break;
 580         case OSSL_FUNC_CORE_GET_PARAMS:
 581             c_get_params = OSSL_get_core_get_params(in);
 582             break;
 583         case OSSL_FUNC_CORE_THREAD_START:
 584             c_thread_start = OSSL_get_core_thread_start(in);
 585             break;
 586         case OSSL_FUNC_CORE_NEW_ERROR:
 587             c_new_error = OSSL_get_core_new_error(in);
 588             break;
 589         case OSSL_FUNC_CORE_SET_ERROR_DEBUG:
 590             c_set_error_debug = OSSL_get_core_set_error_debug(in);
 591             break;
 592         case OSSL_FUNC_CORE_VSET_ERROR:
 593             c_vset_error = OSSL_get_core_vset_error(in);
 594             break;
 595         case OSSL_FUNC_CORE_SET_ERROR_MARK:
 596             c_set_error_mark = OSSL_get_core_set_error_mark(in);
 597             break;
 598         case OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK:
 599             c_clear_last_error_mark = OSSL_get_core_clear_last_error_mark(in);
 600             break;
 601         case OSSL_FUNC_CORE_POP_ERROR_TO_MARK:
 602             c_pop_error_to_mark = OSSL_get_core_pop_error_to_mark(in);
 603             break;
 604         case OSSL_FUNC_CRYPTO_MALLOC:
 605             c_CRYPTO_malloc = OSSL_get_CRYPTO_malloc(in);
 606             break;
 607         case OSSL_FUNC_CRYPTO_ZALLOC:
 608             c_CRYPTO_zalloc = OSSL_get_CRYPTO_zalloc(in);
 609             break;
 610         case OSSL_FUNC_CRYPTO_FREE:
 611             c_CRYPTO_free = OSSL_get_CRYPTO_free(in);
 612             break;
 613         case OSSL_FUNC_CRYPTO_CLEAR_FREE:
 614             c_CRYPTO_clear_free = OSSL_get_CRYPTO_clear_free(in);
 615             break;
 616         case OSSL_FUNC_CRYPTO_REALLOC:
 617             c_CRYPTO_realloc = OSSL_get_CRYPTO_realloc(in);
 618             break;
 619         case OSSL_FUNC_CRYPTO_CLEAR_REALLOC:
 620             c_CRYPTO_clear_realloc = OSSL_get_CRYPTO_clear_realloc(in);
 621             break;
 622         case OSSL_FUNC_CRYPTO_SECURE_MALLOC:
 623             c_CRYPTO_secure_malloc = OSSL_get_CRYPTO_secure_malloc(in);
 624             break;
 625         case OSSL_FUNC_CRYPTO_SECURE_ZALLOC:
 626             c_CRYPTO_secure_zalloc = OSSL_get_CRYPTO_secure_zalloc(in);
 627             break;
 628         case OSSL_FUNC_CRYPTO_SECURE_FREE:
 629             c_CRYPTO_secure_free = OSSL_get_CRYPTO_secure_free(in);
 630             break;
 631         case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE:
 632             c_CRYPTO_secure_clear_free = OSSL_get_CRYPTO_secure_clear_free(in);
 633             break;
 634         case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED:
 635             c_CRYPTO_secure_allocated = OSSL_get_CRYPTO_secure_allocated(in);
 636             break;
 637         case OSSL_FUNC_BIO_NEW_FILE:
 638             selftest_params.bio_new_file_cb = OSSL_get_BIO_new_file(in);
 639             break;
 640         case OSSL_FUNC_BIO_NEW_MEMBUF:
 641             selftest_params.bio_new_buffer_cb = OSSL_get_BIO_new_membuf(in);
 642             break;
 643         case OSSL_FUNC_BIO_READ_EX:
 644             selftest_params.bio_read_ex_cb = OSSL_get_BIO_read_ex(in);
 645             break;
 646         case OSSL_FUNC_BIO_FREE:
 647             selftest_params.bio_free_cb = OSSL_get_BIO_free(in);
 648             break;
 649         case OSSL_FUNC_BIO_VSNPRINTF:
 650             c_BIO_vsnprintf = OSSL_get_BIO_vsnprintf(in);
 651             break;
 652         case OSSL_FUNC_SELF_TEST_CB: {
 653             stcbfn = OSSL_get_self_test_cb(in);
 654             break;
 655         }
 656         default:
 657             /* Just ignore anything we don't understand */
 658             break;
 659         }
 660     }
 661
 662     if (stcbfn != NULL && c_get_libctx != NULL) {
 663         stcbfn(c_get_libctx(handle), &selftest_params.cb,
 664                &selftest_params.cb_arg);
 665     }
 666     else {
 667         selftest_params.cb = NULL;
 668         selftest_params.cb_arg = NULL;
 669     }
 670
 671     if (!c_get_params(handle, core_params))
 672         return 0;
 673
 674     /*  Create a context. */
 675     if ((*provctx = PROV_CTX_new()) == NULL
 676         || (libctx = OPENSSL_CTX_new()) == NULL) {
 677         /*
 678          * We free libctx separately here and only here because it hasn't
 679          * been attached to *provctx.  All other error paths below rely
 680          * solely on fips_teardown.
 681          */
 682         OPENSSL_CTX_free(libctx);
 683         goto err;
 684     }
 685     PROV_CTX_set0_library_context(*provctx, libctx);
 686     PROV_CTX_set0_handle(*provctx, handle);
 687
 688     if ((fgbl = openssl_ctx_get_data(libctx, OPENSSL_CTX_FIPS_PROV_INDEX,
 689                                      &fips_prov_ossl_ctx_method)) == NULL)
 690         goto err;
 691
 692     fgbl->handle = handle;
 693
 694     selftest_params.libctx = libctx;
 695     if (!SELF_TEST_post(&selftest_params, 0))
 696         goto err;
 697
 698     /*
 699      * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
 700      * EVP calls from within the FIPS module.
 701      */
 702     if (!dummy_evp_call(libctx))
 703         goto err;
 704
 705     *out = fips_dispatch_table;
 706
 707     return 1;
 708  err:
 709     fips_teardown(*provctx);
 710     *provctx = NULL;
 711     return 0;
 712 }
 713
 714 /*
 715  * The internal init function used when the FIPS module uses EVP to call
 716  * another algorithm also in the FIPS module. This is a recursive call that has
 717  * been made from within the FIPS module itself. To make this work, we populate
 718  * the provider context of this inner instance with the same library context
 719  * that was used in the EVP call that initiated this recursive call.
 720  */
 721 OSSL_provider_init_fn fips_intern_provider_init;
 722 int fips_intern_provider_init(const OSSL_CORE_HANDLE *handle,
 723                               const OSSL_DISPATCH *in,
 724                               const OSSL_DISPATCH **out,
 725                               void **provctx)
 726 {
 727     OSSL_core_get_library_context_fn *c_get_libctx = NULL;
 728
 729     for (; in->function_id != 0; in++) {
 730         switch (in->function_id) {
 731         case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
 732             c_get_libctx = OSSL_get_core_get_library_context(in);
 733             break;
 734         default:
 735             break;
 736         }
 737     }
 738
 739     if (c_get_libctx == NULL)
 740         return 0;
 741
 742     if ((*provctx = PROV_CTX_new()) == NULL)
 743         return 0;
 744     /*
 745      * Using the parent library context only works because we are a built-in
 746      * internal provider. This is not something that most providers would be
 747      * able to do.
 748      */
 749     PROV_CTX_set0_library_context(*provctx, (OPENSSL_CTX *)c_get_libctx(handle));
 750     PROV_CTX_set0_handle(*provctx, handle);
 751
 752     *out = intern_dispatch_table;
 753     return 1;
 754 }
 755
 756 void ERR_new(void)
 757 {
 758     c_new_error(NULL);
 759 }
 760
 761 void ERR_set_debug(const char *file, int line, const char *func)
 762 {
 763     c_set_error_debug(NULL, file, line, func);
 764 }
 765
 766 void ERR_set_error(int lib, int reason, const char *fmt, ...)
 767 {
 768     va_list args;
 769
 770     va_start(args, fmt);
 771     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
 772     va_end(args);
 773 }
 774
 775 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args)
 776 {
 777     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
 778 }
 779
 780 int ERR_set_mark(void)
 781 {
 782     return c_set_error_mark(NULL);
 783 }
 784
 785 int ERR_clear_last_mark(void)
 786 {
 787     return c_clear_last_error_mark(NULL);
 788 }
 789
 790 int ERR_pop_to_mark(void)
 791 {
 792     return c_pop_error_to_mark(NULL);
 793 }
 794
 795 /*
 796  * This must take a library context, since it's called from the depths
 797  * of crypto/initthread.c code, where it's (correctly) assumed that the
 798  * passed caller argument is an OPENSSL_CTX pointer (since the same routine
 799  * is also called from other parts of libcrypto, which all pass around a
 800  * OPENSSL_CTX pointer)
 801  */
 802 const OSSL_CORE_HANDLE *FIPS_get_core_handle(OPENSSL_CTX *libctx)
 803 {
 804     FIPS_GLOBAL *fgbl = openssl_ctx_get_data(libctx,
 805                                              OPENSSL_CTX_FIPS_PROV_INDEX,
 806                                              &fips_prov_ossl_ctx_method);
 807
 808     if (fgbl == NULL)
 809         return NULL;
 810
 811     return fgbl->handle;
 812 }
 813
 814 void *CRYPTO_malloc(size_t num, const char *file, int line)
 815 {
 816     return c_CRYPTO_malloc(num, file, line);
 817 }
 818
 819 void *CRYPTO_zalloc(size_t num, const char *file, int line)
 820 {
 821     return c_CRYPTO_zalloc(num, file, line);
 822 }
 823
 824 void CRYPTO_free(void *ptr, const char *file, int line)
 825 {
 826     c_CRYPTO_free(ptr, file, line);
 827 }
 828
 829 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line)
 830 {
 831     c_CRYPTO_clear_free(ptr, num, file, line);
 832 }
 833
 834 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line)
 835 {
 836     return c_CRYPTO_realloc(addr, num, file, line);
 837 }
 838
 839 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
 840                            const char *file, int line)
 841 {
 842     return c_CRYPTO_clear_realloc(addr, old_num, num, file, line);
 843 }
 844
 845 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
 846 {
 847     return c_CRYPTO_secure_malloc(num, file, line);
 848 }
 849
 850 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
 851 {
 852     return c_CRYPTO_secure_zalloc(num, file, line);
 853 }
 854
 855 void CRYPTO_secure_free(void *ptr, const char *file, int line)
 856 {
 857     c_CRYPTO_secure_free(ptr, file, line);
 858 }
 859
 860 void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *file, int line)
 861 {
 862     c_CRYPTO_secure_clear_free(ptr, num, file, line);
 863 }
 864
 865 int CRYPTO_secure_allocated(const void *ptr)
 866 {
 867     return c_CRYPTO_secure_allocated(ptr);
 868 }
 869
 870 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
 871 {
 872     va_list args;
 873     int ret;
 874
 875     va_start(args, format);
 876     ret = c_BIO_vsnprintf(buf, n, format, args);
 877     va_end(args);
 878     return ret;
 879 }