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