providers/fips/fipsprov.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 #include <assert.h>
  11 #include <openssl/core_dispatch.h>
  12 #include <openssl/core_names.h>
  13 #include <openssl/params.h>
  14 #include <openssl/fips_names.h>
  15 #include <openssl/rand.h> /* RAND_get0_public() */
  16 #include <openssl/proverr.h>
  17 #include "internal/cryptlib.h"
  18 #include "prov/implementations.h"
  19 #include "prov/names.h"
  20 #include "prov/provider_ctx.h"
  21 #include "prov/providercommon.h"
  22 #include "prov/provider_util.h"
  23 #include "prov/seeding.h"
  24 #include "self_test.h"
  25
  26 static const char FIPS_DEFAULT_PROPERTIES[] = "provider=fips,fips=yes";
  27 static const char FIPS_UNAPPROVED_PROPERTIES[] = "provider=fips,fips=no";
  28
  29 /*
  30  * Forward declarations to ensure that interface functions are correctly
  31  * defined.
  32  */
  33 static OSSL_FUNC_provider_teardown_fn fips_teardown;
  34 static OSSL_FUNC_provider_gettable_params_fn fips_gettable_params;
  35 static OSSL_FUNC_provider_get_params_fn fips_get_params;
  36 static OSSL_FUNC_provider_query_operation_fn fips_query;
  37
  38 #define ALGC(NAMES, FUNC, CHECK) { { NAMES, FIPS_DEFAULT_PROPERTIES, FUNC }, CHECK }
  39 #define ALG(NAMES, FUNC) ALGC(NAMES, FUNC, NULL)
  40
  41 extern OSSL_FUNC_core_thread_start_fn *c_thread_start;
  42 int FIPS_security_check_enabled(OSSL_LIB_CTX *libctx);
  43
  44 /*
  45  * Should these function pointers be stored in the provider side provctx? Could
  46  * they ever be different from one init to the next? We assume not for now.
  47  */
  48
  49 /* Functions provided by the core */
  50 static OSSL_FUNC_core_gettable_params_fn *c_gettable_params;
  51 static OSSL_FUNC_core_get_params_fn *c_get_params;
  52 OSSL_FUNC_core_thread_start_fn *c_thread_start;
  53 static OSSL_FUNC_core_new_error_fn *c_new_error;
  54 static OSSL_FUNC_core_set_error_debug_fn *c_set_error_debug;
  55 static OSSL_FUNC_core_vset_error_fn *c_vset_error;
  56 static OSSL_FUNC_core_set_error_mark_fn *c_set_error_mark;
  57 static OSSL_FUNC_core_clear_last_error_mark_fn *c_clear_last_error_mark;
  58 static OSSL_FUNC_core_pop_error_to_mark_fn *c_pop_error_to_mark;
  59 static OSSL_FUNC_CRYPTO_malloc_fn *c_CRYPTO_malloc;
  60 static OSSL_FUNC_CRYPTO_zalloc_fn *c_CRYPTO_zalloc;
  61 static OSSL_FUNC_CRYPTO_free_fn *c_CRYPTO_free;
  62 static OSSL_FUNC_CRYPTO_clear_free_fn *c_CRYPTO_clear_free;
  63 static OSSL_FUNC_CRYPTO_realloc_fn *c_CRYPTO_realloc;
  64 static OSSL_FUNC_CRYPTO_clear_realloc_fn *c_CRYPTO_clear_realloc;
  65 static OSSL_FUNC_CRYPTO_secure_malloc_fn *c_CRYPTO_secure_malloc;
  66 static OSSL_FUNC_CRYPTO_secure_zalloc_fn *c_CRYPTO_secure_zalloc;
  67 static OSSL_FUNC_CRYPTO_secure_free_fn *c_CRYPTO_secure_free;
  68 static OSSL_FUNC_CRYPTO_secure_clear_free_fn *c_CRYPTO_secure_clear_free;
  69 static OSSL_FUNC_CRYPTO_secure_allocated_fn *c_CRYPTO_secure_allocated;
  70 static OSSL_FUNC_BIO_vsnprintf_fn *c_BIO_vsnprintf;
  71 static OSSL_FUNC_self_test_cb_fn *c_stcbfn = NULL;
  72 static OSSL_FUNC_core_get_libctx_fn *c_get_libctx = NULL;
  73
  74 typedef struct fips_global_st {
  75     const OSSL_CORE_HANDLE *handle;
  76     SELF_TEST_POST_PARAMS selftest_params;
  77     int fips_security_checks;
  78     const char *fips_security_check_option;
  79 } FIPS_GLOBAL;
  80
  81 static void *fips_prov_ossl_ctx_new(OSSL_LIB_CTX *libctx)
  82 {
  83     FIPS_GLOBAL *fgbl = OPENSSL_zalloc(sizeof(*fgbl));
  84
  85     if (fgbl == NULL)
  86         return NULL;
  87     fgbl->fips_security_checks = 1;
  88     fgbl->fips_security_check_option = "1";
  89
  90     return fgbl;
  91 }
  92
  93 static void fips_prov_ossl_ctx_free(void *fgbl)
  94 {
  95     OPENSSL_free(fgbl);
  96 }
  97
  98 static const OSSL_LIB_CTX_METHOD fips_prov_ossl_ctx_method = {
  99     OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY,
 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_DEFN(OSSL_PROV_PARAM_STATUS, OSSL_PARAM_INTEGER, NULL, 0),
 111     OSSL_PARAM_DEFN(OSSL_PROV_PARAM_SECURITY_CHECKS, OSSL_PARAM_INTEGER, NULL, 0),
 112     OSSL_PARAM_END
 113 };
 114
 115 static int fips_get_params_from_core(FIPS_GLOBAL *fgbl)
 116 {
 117     /*
 118     * Parameters to retrieve from the core provider - required for self testing.
 119     * NOTE: inside core_get_params() these will be loaded from config items
 120     * stored inside prov->parameters (except for
 121     * OSSL_PROV_PARAM_CORE_MODULE_FILENAME).
 122     * OSSL_PROV_FIPS_PARAM_SECURITY_CHECKS is not a self test parameter.
 123     */
 124     OSSL_PARAM core_params[8], *p = core_params;
 125
 126     *p++ = OSSL_PARAM_construct_utf8_ptr(
 127             OSSL_PROV_PARAM_CORE_MODULE_FILENAME,
 128             (char **)&fgbl->selftest_params.module_filename,
 129             sizeof(fgbl->selftest_params.module_filename));
 130     *p++ = OSSL_PARAM_construct_utf8_ptr(
 131             OSSL_PROV_FIPS_PARAM_MODULE_MAC,
 132             (char **)&fgbl->selftest_params.module_checksum_data,
 133             sizeof(fgbl->selftest_params.module_checksum_data));
 134     *p++ = OSSL_PARAM_construct_utf8_ptr(
 135             OSSL_PROV_FIPS_PARAM_INSTALL_MAC,
 136             (char **)&fgbl->selftest_params.indicator_checksum_data,
 137             sizeof(fgbl->selftest_params.indicator_checksum_data));
 138     *p++ = OSSL_PARAM_construct_utf8_ptr(
 139             OSSL_PROV_FIPS_PARAM_INSTALL_STATUS,
 140             (char **)&fgbl->selftest_params.indicator_data,
 141             sizeof(fgbl->selftest_params.indicator_data));
 142     *p++ = OSSL_PARAM_construct_utf8_ptr(
 143             OSSL_PROV_FIPS_PARAM_INSTALL_VERSION,
 144             (char **)&fgbl->selftest_params.indicator_version,
 145             sizeof(fgbl->selftest_params.indicator_version));
 146     *p++ = OSSL_PARAM_construct_utf8_ptr(
 147             OSSL_PROV_FIPS_PARAM_CONDITIONAL_ERRORS,
 148             (char **)&fgbl->selftest_params.conditional_error_check,
 149             sizeof(fgbl->selftest_params.conditional_error_check));
 150     *p++ = OSSL_PARAM_construct_utf8_ptr(
 151             OSSL_PROV_FIPS_PARAM_SECURITY_CHECKS,
 152             (char **)&fgbl->fips_security_check_option,
 153             sizeof(fgbl->fips_security_check_option));
 154     *p = OSSL_PARAM_construct_end();
 155
 156     if (!c_get_params(fgbl->handle, core_params)) {
 157         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 158         return 0;
 159     }
 160
 161     return 1;
 162 }
 163
 164 static const OSSL_PARAM *fips_gettable_params(void *provctx)
 165 {
 166     return fips_param_types;
 167 }
 168
 169 static int fips_get_params(void *provctx, OSSL_PARAM params[])
 170 {
 171     OSSL_PARAM *p;
 172     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(ossl_prov_ctx_get0_libctx(provctx),
 173                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
 174                                               &fips_prov_ossl_ctx_method);
 175
 176     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
 177     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
 178         return 0;
 179     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
 180     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
 181         return 0;
 182     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
 183     if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
 184         return 0;
 185     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_STATUS);
 186     if (p != NULL && !OSSL_PARAM_set_int(p, ossl_prov_is_running()))
 187         return 0;
 188     p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_SECURITY_CHECKS);
 189     if (p != NULL && !OSSL_PARAM_set_int(p, fgbl->fips_security_checks))
 190         return 0;
 191     return 1;
 192 }
 193
 194 static void set_self_test_cb(FIPS_GLOBAL *fgbl)
 195 {
 196     const OSSL_CORE_HANDLE *handle =
 197         FIPS_get_core_handle(fgbl->selftest_params.libctx);
 198
 199     if (c_stcbfn != NULL && c_get_libctx != NULL) {
 200         c_stcbfn(c_get_libctx(handle), &fgbl->selftest_params.cb,
 201                               &fgbl->selftest_params.cb_arg);
 202     } else {
 203         fgbl->selftest_params.cb = NULL;
 204         fgbl->selftest_params.cb_arg = NULL;
 205     }
 206 }
 207
 208 static int fips_self_test(void *provctx)
 209 {
 210     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(ossl_prov_ctx_get0_libctx(provctx),
 211                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
 212                                               &fips_prov_ossl_ctx_method);
 213
 214     set_self_test_cb(fgbl);
 215     return SELF_TEST_post(&fgbl->selftest_params, 1) ? 1 : 0;
 216 }
 217
 218 /*
 219  * For the algorithm names, we use the following formula for our primary
 220  * names:
 221  *
 222  *     ALGNAME[VERSION?][-SUBNAME[VERSION?]?][-SIZE?][-MODE?]
 223  *
 224  *     VERSION is only present if there are multiple versions of
 225  *     an alg (MD2, MD4, MD5).  It may be omitted if there is only
 226  *     one version (if a subsequent version is released in the future,
 227  *     we can always change the canonical name, and add the old name
 228  *     as an alias).
 229  *
 230  *     SUBNAME may be present where we are combining multiple
 231  *     algorithms together, e.g. MD5-SHA1.
 232  *
 233  *     SIZE is only present if multiple versions of an algorithm exist
 234  *     with different sizes (e.g. AES-128-CBC, AES-256-CBC)
 235  *
 236  *     MODE is only present where applicable.
 237  *
 238  * We add diverse other names where applicable, such as the names that
 239  * NIST uses, or that are used for ASN.1 OBJECT IDENTIFIERs, or names
 240  * we have used historically.
 241  */
 242 static const OSSL_ALGORITHM fips_digests[] = {
 243     /* Our primary name:NiST name[:our older names] */
 244     { PROV_NAMES_SHA1, FIPS_DEFAULT_PROPERTIES, ossl_sha1_functions },
 245     { PROV_NAMES_SHA2_224, FIPS_DEFAULT_PROPERTIES, ossl_sha224_functions },
 246     { PROV_NAMES_SHA2_256, FIPS_DEFAULT_PROPERTIES, ossl_sha256_functions },
 247     { PROV_NAMES_SHA2_384, FIPS_DEFAULT_PROPERTIES, ossl_sha384_functions },
 248     { PROV_NAMES_SHA2_512, FIPS_DEFAULT_PROPERTIES, ossl_sha512_functions },
 249     { PROV_NAMES_SHA2_512_224, FIPS_DEFAULT_PROPERTIES,
 250       ossl_sha512_224_functions },
 251     { PROV_NAMES_SHA2_512_256, FIPS_DEFAULT_PROPERTIES,
 252       ossl_sha512_256_functions },
 253
 254     /* We agree with NIST here, so one name only */
 255     { PROV_NAMES_SHA3_224, FIPS_DEFAULT_PROPERTIES, ossl_sha3_224_functions },
 256     { PROV_NAMES_SHA3_256, FIPS_DEFAULT_PROPERTIES, ossl_sha3_256_functions },
 257     { PROV_NAMES_SHA3_384, FIPS_DEFAULT_PROPERTIES, ossl_sha3_384_functions },
 258     { PROV_NAMES_SHA3_512, FIPS_DEFAULT_PROPERTIES, ossl_sha3_512_functions },
 259
 260     { PROV_NAMES_SHAKE_128, FIPS_DEFAULT_PROPERTIES, ossl_shake_128_functions },
 261     { PROV_NAMES_SHAKE_256, FIPS_DEFAULT_PROPERTIES, ossl_shake_256_functions },
 262
 263     /*
 264      * KECCAK-KMAC-128 and KECCAK-KMAC-256 as hashes are mostly useful for
 265      * KMAC128 and KMAC256.
 266      */
 267     { PROV_NAMES_KECCAK_KMAC_128, FIPS_DEFAULT_PROPERTIES,
 268       ossl_keccak_kmac_128_functions },
 269     { PROV_NAMES_KECCAK_KMAC_256, FIPS_DEFAULT_PROPERTIES,
 270       ossl_keccak_kmac_256_functions },
 271     { NULL, NULL, NULL }
 272 };
 273
 274 static const OSSL_ALGORITHM_CAPABLE fips_ciphers[] = {
 275     /* Our primary name[:ASN.1 OID name][:our older names] */
 276     ALG(PROV_NAMES_AES_256_ECB, ossl_aes256ecb_functions),
 277     ALG(PROV_NAMES_AES_192_ECB, ossl_aes192ecb_functions),
 278     ALG(PROV_NAMES_AES_128_ECB, ossl_aes128ecb_functions),
 279     ALG(PROV_NAMES_AES_256_CBC, ossl_aes256cbc_functions),
 280     ALG(PROV_NAMES_AES_192_CBC, ossl_aes192cbc_functions),
 281     ALG(PROV_NAMES_AES_128_CBC, ossl_aes128cbc_functions),
 282     ALG(PROV_NAMES_AES_256_CBC_CTS, ossl_aes256cbc_cts_functions),
 283     ALG(PROV_NAMES_AES_192_CBC_CTS, ossl_aes192cbc_cts_functions),
 284     ALG(PROV_NAMES_AES_128_CBC_CTS, ossl_aes128cbc_cts_functions),
 285     ALG(PROV_NAMES_AES_256_OFB, ossl_aes256ofb_functions),
 286     ALG(PROV_NAMES_AES_192_OFB, ossl_aes192ofb_functions),
 287     ALG(PROV_NAMES_AES_128_OFB, ossl_aes128ofb_functions),
 288     ALG(PROV_NAMES_AES_256_CFB, ossl_aes256cfb_functions),
 289     ALG(PROV_NAMES_AES_192_CFB, ossl_aes192cfb_functions),
 290     ALG(PROV_NAMES_AES_128_CFB, ossl_aes128cfb_functions),
 291     ALG(PROV_NAMES_AES_256_CFB1, ossl_aes256cfb1_functions),
 292     ALG(PROV_NAMES_AES_192_CFB1, ossl_aes192cfb1_functions),
 293     ALG(PROV_NAMES_AES_128_CFB1, ossl_aes128cfb1_functions),
 294     ALG(PROV_NAMES_AES_256_CFB8, ossl_aes256cfb8_functions),
 295     ALG(PROV_NAMES_AES_192_CFB8, ossl_aes192cfb8_functions),
 296     ALG(PROV_NAMES_AES_128_CFB8, ossl_aes128cfb8_functions),
 297     ALG(PROV_NAMES_AES_256_CTR, ossl_aes256ctr_functions),
 298     ALG(PROV_NAMES_AES_192_CTR, ossl_aes192ctr_functions),
 299     ALG(PROV_NAMES_AES_128_CTR, ossl_aes128ctr_functions),
 300     ALG(PROV_NAMES_AES_256_XTS, ossl_aes256xts_functions),
 301     ALG(PROV_NAMES_AES_128_XTS, ossl_aes128xts_functions),
 302     ALG(PROV_NAMES_AES_256_GCM, ossl_aes256gcm_functions),
 303     ALG(PROV_NAMES_AES_192_GCM, ossl_aes192gcm_functions),
 304     ALG(PROV_NAMES_AES_128_GCM, ossl_aes128gcm_functions),
 305     ALG(PROV_NAMES_AES_256_CCM, ossl_aes256ccm_functions),
 306     ALG(PROV_NAMES_AES_192_CCM, ossl_aes192ccm_functions),
 307     ALG(PROV_NAMES_AES_128_CCM, ossl_aes128ccm_functions),
 308     ALG(PROV_NAMES_AES_256_WRAP, ossl_aes256wrap_functions),
 309     ALG(PROV_NAMES_AES_192_WRAP, ossl_aes192wrap_functions),
 310     ALG(PROV_NAMES_AES_128_WRAP, ossl_aes128wrap_functions),
 311     ALG(PROV_NAMES_AES_256_WRAP_PAD, ossl_aes256wrappad_functions),
 312     ALG(PROV_NAMES_AES_192_WRAP_PAD, ossl_aes192wrappad_functions),
 313     ALG(PROV_NAMES_AES_128_WRAP_PAD, ossl_aes128wrappad_functions),
 314     ALG(PROV_NAMES_AES_256_WRAP_INV, ossl_aes256wrapinv_functions),
 315     ALG(PROV_NAMES_AES_192_WRAP_INV, ossl_aes192wrapinv_functions),
 316     ALG(PROV_NAMES_AES_128_WRAP_INV, ossl_aes128wrapinv_functions),
 317     ALG(PROV_NAMES_AES_256_WRAP_PAD_INV, ossl_aes256wrappadinv_functions),
 318     ALG(PROV_NAMES_AES_192_WRAP_PAD_INV, ossl_aes192wrappadinv_functions),
 319     ALG(PROV_NAMES_AES_128_WRAP_PAD_INV, ossl_aes128wrappadinv_functions),
 320     ALGC(PROV_NAMES_AES_128_CBC_HMAC_SHA1, ossl_aes128cbc_hmac_sha1_functions,
 321          ossl_cipher_capable_aes_cbc_hmac_sha1),
 322     ALGC(PROV_NAMES_AES_256_CBC_HMAC_SHA1, ossl_aes256cbc_hmac_sha1_functions,
 323          ossl_cipher_capable_aes_cbc_hmac_sha1),
 324     ALGC(PROV_NAMES_AES_128_CBC_HMAC_SHA256, ossl_aes128cbc_hmac_sha256_functions,
 325          ossl_cipher_capable_aes_cbc_hmac_sha256),
 326     ALGC(PROV_NAMES_AES_256_CBC_HMAC_SHA256, ossl_aes256cbc_hmac_sha256_functions,
 327          ossl_cipher_capable_aes_cbc_hmac_sha256),
 328 #ifndef OPENSSL_NO_DES
 329     ALG(PROV_NAMES_DES_EDE3_ECB, ossl_tdes_ede3_ecb_functions),
 330     ALG(PROV_NAMES_DES_EDE3_CBC, ossl_tdes_ede3_cbc_functions),
 331 #endif  /* OPENSSL_NO_DES */
 332     { { NULL, NULL, NULL }, NULL }
 333 };
 334 static OSSL_ALGORITHM exported_fips_ciphers[OSSL_NELEM(fips_ciphers)];
 335
 336 static const OSSL_ALGORITHM fips_macs[] = {
 337 #ifndef OPENSSL_NO_CMAC
 338     { PROV_NAMES_CMAC, FIPS_DEFAULT_PROPERTIES, ossl_cmac_functions },
 339 #endif
 340     { PROV_NAMES_GMAC, FIPS_DEFAULT_PROPERTIES, ossl_gmac_functions },
 341     { PROV_NAMES_HMAC, FIPS_DEFAULT_PROPERTIES, ossl_hmac_functions },
 342     { PROV_NAMES_KMAC_128, FIPS_DEFAULT_PROPERTIES, ossl_kmac128_functions },
 343     { PROV_NAMES_KMAC_256, FIPS_DEFAULT_PROPERTIES, ossl_kmac256_functions },
 344     { NULL, NULL, NULL }
 345 };
 346
 347 static const OSSL_ALGORITHM fips_kdfs[] = {
 348     { PROV_NAMES_HKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_hkdf_functions },
 349     { PROV_NAMES_SSKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_sskdf_functions },
 350     { PROV_NAMES_PBKDF2, FIPS_DEFAULT_PROPERTIES, ossl_kdf_pbkdf2_functions },
 351     { PROV_NAMES_SSHKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_sshkdf_functions },
 352     { PROV_NAMES_X963KDF, FIPS_DEFAULT_PROPERTIES,
 353       ossl_kdf_x963_kdf_functions },
 354     { PROV_NAMES_X942KDF_ASN1, FIPS_DEFAULT_PROPERTIES,
 355       ossl_kdf_x942_kdf_functions },
 356     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES,
 357       ossl_kdf_tls1_prf_functions },
 358     { PROV_NAMES_KBKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_kbkdf_functions },
 359     { NULL, NULL, NULL }
 360 };
 361
 362 static const OSSL_ALGORITHM fips_rands[] = {
 363     { PROV_NAMES_CTR_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_ctr_functions },
 364     { PROV_NAMES_HASH_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_hash_functions },
 365     { PROV_NAMES_HMAC_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_ossl_hmac_functions },
 366     { PROV_NAMES_TEST_RAND, FIPS_UNAPPROVED_PROPERTIES, ossl_test_rng_functions },
 367     { NULL, NULL, NULL }
 368 };
 369
 370 static const OSSL_ALGORITHM fips_keyexch[] = {
 371 #ifndef OPENSSL_NO_DH
 372     { PROV_NAMES_DH, FIPS_DEFAULT_PROPERTIES, ossl_dh_keyexch_functions },
 373 #endif
 374 #ifndef OPENSSL_NO_EC
 375     { PROV_NAMES_ECDH, FIPS_DEFAULT_PROPERTIES, ossl_ecdh_keyexch_functions },
 376     { PROV_NAMES_X25519, FIPS_DEFAULT_PROPERTIES, ossl_x25519_keyexch_functions },
 377     { PROV_NAMES_X448, FIPS_DEFAULT_PROPERTIES, ossl_x448_keyexch_functions },
 378 #endif
 379     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES,
 380       ossl_kdf_tls1_prf_keyexch_functions },
 381     { PROV_NAMES_HKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_hkdf_keyexch_functions },
 382     { NULL, NULL, NULL }
 383 };
 384
 385 static const OSSL_ALGORITHM fips_signature[] = {
 386 #ifndef OPENSSL_NO_DSA
 387     { PROV_NAMES_DSA, FIPS_DEFAULT_PROPERTIES, ossl_dsa_signature_functions },
 388 #endif
 389     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_signature_functions },
 390 #ifndef OPENSSL_NO_EC
 391     { PROV_NAMES_ED25519, FIPS_DEFAULT_PROPERTIES, ossl_ed25519_signature_functions },
 392     { PROV_NAMES_ED448, FIPS_DEFAULT_PROPERTIES, ossl_ed448_signature_functions },
 393     { PROV_NAMES_ECDSA, FIPS_DEFAULT_PROPERTIES, ossl_ecdsa_signature_functions },
 394 #endif
 395     { PROV_NAMES_HMAC, FIPS_DEFAULT_PROPERTIES,
 396       ossl_mac_legacy_hmac_signature_functions },
 397 #ifndef OPENSSL_NO_CMAC
 398     { PROV_NAMES_CMAC, FIPS_DEFAULT_PROPERTIES,
 399       ossl_mac_legacy_cmac_signature_functions },
 400 #endif
 401     { NULL, NULL, NULL }
 402 };
 403
 404 static const OSSL_ALGORITHM fips_asym_cipher[] = {
 405     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_asym_cipher_functions },
 406     { NULL, NULL, NULL }
 407 };
 408
 409 static const OSSL_ALGORITHM fips_asym_kem[] = {
 410     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_asym_kem_functions },
 411     { NULL, NULL, NULL }
 412 };
 413
 414 static const OSSL_ALGORITHM fips_keymgmt[] = {
 415 #ifndef OPENSSL_NO_DH
 416     { PROV_NAMES_DH, FIPS_DEFAULT_PROPERTIES, ossl_dh_keymgmt_functions,
 417       PROV_DESCS_DH },
 418     { PROV_NAMES_DHX, FIPS_DEFAULT_PROPERTIES, ossl_dhx_keymgmt_functions,
 419       PROV_DESCS_DHX },
 420 #endif
 421 #ifndef OPENSSL_NO_DSA
 422     { PROV_NAMES_DSA, FIPS_DEFAULT_PROPERTIES, ossl_dsa_keymgmt_functions,
 423       PROV_DESCS_DSA },
 424 #endif
 425     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_keymgmt_functions,
 426       PROV_DESCS_RSA },
 427     { PROV_NAMES_RSA_PSS, FIPS_DEFAULT_PROPERTIES,
 428       ossl_rsapss_keymgmt_functions, PROV_DESCS_RSA_PSS },
 429 #ifndef OPENSSL_NO_EC
 430     { PROV_NAMES_EC, FIPS_DEFAULT_PROPERTIES, ossl_ec_keymgmt_functions,
 431       PROV_DESCS_EC },
 432     { PROV_NAMES_X25519, FIPS_DEFAULT_PROPERTIES, ossl_x25519_keymgmt_functions,
 433       PROV_DESCS_X25519 },
 434     { PROV_NAMES_X448, FIPS_DEFAULT_PROPERTIES, ossl_x448_keymgmt_functions,
 435       PROV_DESCS_X448 },
 436     { PROV_NAMES_ED25519, FIPS_DEFAULT_PROPERTIES, ossl_ed25519_keymgmt_functions,
 437       PROV_DESCS_ED25519 },
 438     { PROV_NAMES_ED448, FIPS_DEFAULT_PROPERTIES, ossl_ed448_keymgmt_functions,
 439       PROV_DESCS_ED448 },
 440 #endif
 441     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_keymgmt_functions,
 442       PROV_DESCS_TLS1_PRF_SIGN },
 443     { PROV_NAMES_HKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_keymgmt_functions,
 444       PROV_DESCS_HKDF_SIGN },
 445     { PROV_NAMES_HMAC, FIPS_DEFAULT_PROPERTIES, ossl_mac_legacy_keymgmt_functions,
 446       PROV_DESCS_HMAC_SIGN },
 447 #ifndef OPENSSL_NO_CMAC
 448     { PROV_NAMES_CMAC, FIPS_DEFAULT_PROPERTIES,
 449       ossl_cmac_legacy_keymgmt_functions, PROV_DESCS_CMAC_SIGN },
 450 #endif
 451     { NULL, NULL, NULL }
 452 };
 453
 454 static const OSSL_ALGORITHM *fips_query(void *provctx, int operation_id,
 455                                         int *no_cache)
 456 {
 457     *no_cache = 0;
 458
 459     if (!ossl_prov_is_running())
 460         return NULL;
 461
 462     switch (operation_id) {
 463     case OSSL_OP_DIGEST:
 464         return fips_digests;
 465     case OSSL_OP_CIPHER:
 466         return exported_fips_ciphers;
 467     case OSSL_OP_MAC:
 468         return fips_macs;
 469     case OSSL_OP_KDF:
 470         return fips_kdfs;
 471     case OSSL_OP_RAND:
 472         return fips_rands;
 473     case OSSL_OP_KEYMGMT:
 474         return fips_keymgmt;
 475     case OSSL_OP_KEYEXCH:
 476         return fips_keyexch;
 477     case OSSL_OP_SIGNATURE:
 478         return fips_signature;
 479     case OSSL_OP_ASYM_CIPHER:
 480         return fips_asym_cipher;
 481     case OSSL_OP_KEM:
 482         return fips_asym_kem;
 483     }
 484     return NULL;
 485 }
 486
 487 static void fips_teardown(void *provctx)
 488 {
 489     OSSL_LIB_CTX_free(PROV_LIBCTX_OF(provctx));
 490     ossl_prov_ctx_free(provctx);
 491 }
 492
 493 static void fips_intern_teardown(void *provctx)
 494 {
 495     /*
 496      * We know that the library context is the same as for the outer provider,
 497      * so no need to destroy it here.
 498      */
 499     ossl_prov_ctx_free(provctx);
 500 }
 501
 502 /* Functions we provide to the core */
 503 static const OSSL_DISPATCH fips_dispatch_table[] = {
 504     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_teardown },
 505     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))fips_gettable_params },
 506     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
 507     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 508     { OSSL_FUNC_PROVIDER_GET_CAPABILITIES,
 509       (void (*)(void))ossl_prov_get_capabilities },
 510     { OSSL_FUNC_PROVIDER_SELF_TEST, (void (*)(void))fips_self_test },
 511     { 0, NULL }
 512 };
 513
 514 /* Functions we provide to ourself */
 515 static const OSSL_DISPATCH intern_dispatch_table[] = {
 516     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_intern_teardown },
 517     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
 518     { 0, NULL }
 519 };
 520
 521 int OSSL_provider_init(const OSSL_CORE_HANDLE *handle,
 522                        const OSSL_DISPATCH *in,
 523                        const OSSL_DISPATCH **out,
 524                        void **provctx)
 525 {
 526     FIPS_GLOBAL *fgbl;
 527     OSSL_LIB_CTX *libctx = NULL;
 528     SELF_TEST_POST_PARAMS selftest_params;
 529
 530     memset(&selftest_params, 0, sizeof(selftest_params));
 531
 532     if (!ossl_prov_seeding_from_dispatch(in))
 533         return 0;
 534     for (; in->function_id != 0; in++) {
 535         /*
 536          * We do not support the scenario of an application linked against
 537          * multiple versions of libcrypto (e.g. one static and one dynamic), but
 538          * sharing a single fips.so. We do a simple sanity check here.
 539          */
 540 #define set_func(c, f) if (c == NULL) c = f; else if (c != f) return 0;
 541         switch (in->function_id) {
 542         case OSSL_FUNC_CORE_GET_LIBCTX:
 543             set_func(c_get_libctx, OSSL_FUNC_core_get_libctx(in));
 544             break;
 545         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
 546             set_func(c_gettable_params, OSSL_FUNC_core_gettable_params(in));
 547             break;
 548         case OSSL_FUNC_CORE_GET_PARAMS:
 549             set_func(c_get_params, OSSL_FUNC_core_get_params(in));
 550             break;
 551         case OSSL_FUNC_CORE_THREAD_START:
 552             set_func(c_thread_start, OSSL_FUNC_core_thread_start(in));
 553             break;
 554         case OSSL_FUNC_CORE_NEW_ERROR:
 555             set_func(c_new_error, OSSL_FUNC_core_new_error(in));
 556             break;
 557         case OSSL_FUNC_CORE_SET_ERROR_DEBUG:
 558             set_func(c_set_error_debug, OSSL_FUNC_core_set_error_debug(in));
 559             break;
 560         case OSSL_FUNC_CORE_VSET_ERROR:
 561             set_func(c_vset_error, OSSL_FUNC_core_vset_error(in));
 562             break;
 563         case OSSL_FUNC_CORE_SET_ERROR_MARK:
 564             set_func(c_set_error_mark, OSSL_FUNC_core_set_error_mark(in));
 565             break;
 566         case OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK:
 567             set_func(c_clear_last_error_mark,
 568                      OSSL_FUNC_core_clear_last_error_mark(in));
 569             break;
 570         case OSSL_FUNC_CORE_POP_ERROR_TO_MARK:
 571             set_func(c_pop_error_to_mark, OSSL_FUNC_core_pop_error_to_mark(in));
 572             break;
 573         case OSSL_FUNC_CRYPTO_MALLOC:
 574             set_func(c_CRYPTO_malloc, OSSL_FUNC_CRYPTO_malloc(in));
 575             break;
 576         case OSSL_FUNC_CRYPTO_ZALLOC:
 577             set_func(c_CRYPTO_zalloc, OSSL_FUNC_CRYPTO_zalloc(in));
 578             break;
 579         case OSSL_FUNC_CRYPTO_FREE:
 580             set_func(c_CRYPTO_free, OSSL_FUNC_CRYPTO_free(in));
 581             break;
 582         case OSSL_FUNC_CRYPTO_CLEAR_FREE:
 583             set_func(c_CRYPTO_clear_free, OSSL_FUNC_CRYPTO_clear_free(in));
 584             break;
 585         case OSSL_FUNC_CRYPTO_REALLOC:
 586             set_func(c_CRYPTO_realloc, OSSL_FUNC_CRYPTO_realloc(in));
 587             break;
 588         case OSSL_FUNC_CRYPTO_CLEAR_REALLOC:
 589             set_func(c_CRYPTO_clear_realloc,
 590                      OSSL_FUNC_CRYPTO_clear_realloc(in));
 591             break;
 592         case OSSL_FUNC_CRYPTO_SECURE_MALLOC:
 593             set_func(c_CRYPTO_secure_malloc,
 594                      OSSL_FUNC_CRYPTO_secure_malloc(in));
 595             break;
 596         case OSSL_FUNC_CRYPTO_SECURE_ZALLOC:
 597             set_func(c_CRYPTO_secure_zalloc,
 598                      OSSL_FUNC_CRYPTO_secure_zalloc(in));
 599             break;
 600         case OSSL_FUNC_CRYPTO_SECURE_FREE:
 601             set_func(c_CRYPTO_secure_free,
 602                      OSSL_FUNC_CRYPTO_secure_free(in));
 603             break;
 604         case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE:
 605             set_func(c_CRYPTO_secure_clear_free,
 606                      OSSL_FUNC_CRYPTO_secure_clear_free(in));
 607             break;
 608         case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED:
 609             set_func(c_CRYPTO_secure_allocated,
 610                      OSSL_FUNC_CRYPTO_secure_allocated(in));
 611             break;
 612         case OSSL_FUNC_BIO_NEW_FILE:
 613             set_func(selftest_params.bio_new_file_cb,
 614                      OSSL_FUNC_BIO_new_file(in));
 615             break;
 616         case OSSL_FUNC_BIO_NEW_MEMBUF:
 617             set_func(selftest_params.bio_new_buffer_cb,
 618                      OSSL_FUNC_BIO_new_membuf(in));
 619             break;
 620         case OSSL_FUNC_BIO_READ_EX:
 621             set_func(selftest_params.bio_read_ex_cb,
 622                      OSSL_FUNC_BIO_read_ex(in));
 623             break;
 624         case OSSL_FUNC_BIO_FREE:
 625             set_func(selftest_params.bio_free_cb, OSSL_FUNC_BIO_free(in));
 626             break;
 627         case OSSL_FUNC_BIO_VSNPRINTF:
 628             set_func(c_BIO_vsnprintf, OSSL_FUNC_BIO_vsnprintf(in));
 629             break;
 630         case OSSL_FUNC_SELF_TEST_CB:
 631             set_func(c_stcbfn, OSSL_FUNC_self_test_cb(in));
 632             break;
 633         default:
 634             /* Just ignore anything we don't understand */
 635             break;
 636         }
 637     }
 638
 639     /*  Create a context. */
 640     if ((*provctx = ossl_prov_ctx_new()) == NULL
 641         || (libctx = OSSL_LIB_CTX_new()) == NULL) {
 642         /*
 643          * We free libctx separately here and only here because it hasn't
 644          * been attached to *provctx.  All other error paths below rely
 645          * solely on fips_teardown.
 646          */
 647         OSSL_LIB_CTX_free(libctx);
 648         goto err;
 649     }
 650     ossl_prov_ctx_set0_libctx(*provctx, libctx);
 651     ossl_prov_ctx_set0_handle(*provctx, handle);
 652
 653     if ((fgbl = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_FIPS_PROV_INDEX,
 654                                       &fips_prov_ossl_ctx_method)) == NULL)
 655         goto err;
 656
 657     fgbl->handle = handle;
 658
 659     /*
 660      * We did initial set up of selftest_params in a local copy, because we
 661      * could not create fgbl until c_CRYPTO_zalloc was defined in the loop
 662      * above.
 663      */
 664     fgbl->selftest_params = selftest_params;
 665
 666     fgbl->selftest_params.libctx = libctx;
 667
 668     set_self_test_cb(fgbl);
 669
 670     if (!fips_get_params_from_core(fgbl)) {
 671         /* Error already raised */
 672         goto err;
 673     }
 674     /*
 675      * Disable the conditional error check if it's disabled in the fips config
 676      * file.
 677      */
 678     if (fgbl->selftest_params.conditional_error_check != NULL
 679         && strcmp(fgbl->selftest_params.conditional_error_check, "0") == 0)
 680         SELF_TEST_disable_conditional_error_state();
 681
 682     /* Disable the security check if it's disabled in the fips config file. */
 683     if (fgbl->fips_security_check_option != NULL
 684         && strcmp(fgbl->fips_security_check_option, "0") == 0)
 685         fgbl->fips_security_checks = 0;
 686
 687     ossl_prov_cache_exported_algorithms(fips_ciphers, exported_fips_ciphers);
 688
 689     if (!SELF_TEST_post(&fgbl->selftest_params, 0)) {
 690         ERR_raise(ERR_LIB_PROV, PROV_R_SELF_TEST_POST_FAILURE);
 691         goto err;
 692     }
 693
 694     *out = fips_dispatch_table;
 695     return 1;
 696  err:
 697     fips_teardown(*provctx);
 698     *provctx = NULL;
 699     return 0;
 700 }
 701
 702 /*
 703  * The internal init function used when the FIPS module uses EVP to call
 704  * another algorithm also in the FIPS module. This is a recursive call that has
 705  * been made from within the FIPS module itself. To make this work, we populate
 706  * the provider context of this inner instance with the same library context
 707  * that was used in the EVP call that initiated this recursive call.
 708  */
 709 OSSL_provider_init_fn ossl_fips_intern_provider_init;
 710 int ossl_fips_intern_provider_init(const OSSL_CORE_HANDLE *handle,
 711                                    const OSSL_DISPATCH *in,
 712                                    const OSSL_DISPATCH **out,
 713                                    void **provctx)
 714 {
 715     OSSL_FUNC_core_get_libctx_fn *c_internal_get_libctx = NULL;
 716
 717     for (; in->function_id != 0; in++) {
 718         switch (in->function_id) {
 719         case OSSL_FUNC_CORE_GET_LIBCTX:
 720             c_internal_get_libctx = OSSL_FUNC_core_get_libctx(in);
 721             break;
 722         default:
 723             break;
 724         }
 725     }
 726
 727     if (c_internal_get_libctx == NULL)
 728         return 0;
 729
 730     if ((*provctx = ossl_prov_ctx_new()) == NULL)
 731         return 0;
 732
 733     /*
 734      * Using the parent library context only works because we are a built-in
 735      * internal provider. This is not something that most providers would be
 736      * able to do.
 737      */
 738     ossl_prov_ctx_set0_libctx(*provctx,
 739                               (OSSL_LIB_CTX *)c_internal_get_libctx(handle));
 740     ossl_prov_ctx_set0_handle(*provctx, handle);
 741
 742     *out = intern_dispatch_table;
 743     return 1;
 744 }
 745
 746 void ERR_new(void)
 747 {
 748     c_new_error(NULL);
 749 }
 750
 751 void ERR_set_debug(const char *file, int line, const char *func)
 752 {
 753     c_set_error_debug(NULL, file, line, func);
 754 }
 755
 756 void ERR_set_error(int lib, int reason, const char *fmt, ...)
 757 {
 758     va_list args;
 759
 760     va_start(args, fmt);
 761     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
 762     va_end(args);
 763 }
 764
 765 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args)
 766 {
 767     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
 768 }
 769
 770 int ERR_set_mark(void)
 771 {
 772     return c_set_error_mark(NULL);
 773 }
 774
 775 int ERR_clear_last_mark(void)
 776 {
 777     return c_clear_last_error_mark(NULL);
 778 }
 779
 780 int ERR_pop_to_mark(void)
 781 {
 782     return c_pop_error_to_mark(NULL);
 783 }
 784
 785 /*
 786  * This must take a library context, since it's called from the depths
 787  * of crypto/initthread.c code, where it's (correctly) assumed that the
 788  * passed caller argument is an OSSL_LIB_CTX pointer (since the same routine
 789  * is also called from other parts of libcrypto, which all pass around a
 790  * OSSL_LIB_CTX pointer)
 791  */
 792 const OSSL_CORE_HANDLE *FIPS_get_core_handle(OSSL_LIB_CTX *libctx)
 793 {
 794     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(libctx,
 795                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
 796                                               &fips_prov_ossl_ctx_method);
 797
 798     if (fgbl == NULL)
 799         return NULL;
 800
 801     return fgbl->handle;
 802 }
 803
 804 void *CRYPTO_malloc(size_t num, const char *file, int line)
 805 {
 806     return c_CRYPTO_malloc(num, file, line);
 807 }
 808
 809 void *CRYPTO_zalloc(size_t num, const char *file, int line)
 810 {
 811     return c_CRYPTO_zalloc(num, file, line);
 812 }
 813
 814 void CRYPTO_free(void *ptr, const char *file, int line)
 815 {
 816     c_CRYPTO_free(ptr, file, line);
 817 }
 818
 819 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line)
 820 {
 821     c_CRYPTO_clear_free(ptr, num, file, line);
 822 }
 823
 824 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line)
 825 {
 826     return c_CRYPTO_realloc(addr, num, file, line);
 827 }
 828
 829 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
 830                            const char *file, int line)
 831 {
 832     return c_CRYPTO_clear_realloc(addr, old_num, num, file, line);
 833 }
 834
 835 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
 836 {
 837     return c_CRYPTO_secure_malloc(num, file, line);
 838 }
 839
 840 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
 841 {
 842     return c_CRYPTO_secure_zalloc(num, file, line);
 843 }
 844
 845 void CRYPTO_secure_free(void *ptr, const char *file, int line)
 846 {
 847     c_CRYPTO_secure_free(ptr, file, line);
 848 }
 849
 850 void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *file, int line)
 851 {
 852     c_CRYPTO_secure_clear_free(ptr, num, file, line);
 853 }
 854
 855 int CRYPTO_secure_allocated(const void *ptr)
 856 {
 857     return c_CRYPTO_secure_allocated(ptr);
 858 }
 859
 860 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
 861 {
 862     va_list args;
 863     int ret;
 864
 865     va_start(args, format);
 866     ret = c_BIO_vsnprintf(buf, n, format, args);
 867     va_end(args);
 868     return ret;
 869 }
 870
 871 int FIPS_security_check_enabled(OSSL_LIB_CTX *libctx)
 872 {
 873     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(libctx,
 874                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
 875                                               &fips_prov_ossl_ctx_method);
 876
 877     return fgbl->fips_security_checks;
 878 }
 879
 880 void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX *libctx, OSSL_CALLBACK **cb,
 881                                  void **cbarg)
 882 {
 883     assert(libctx != NULL);
 884
 885     if (c_stcbfn != NULL && c_get_libctx != NULL) {
 886         /* Get the parent libctx */
 887         c_stcbfn(c_get_libctx(FIPS_get_core_handle(libctx)), cb, cbarg);
 888     } else {
 889         if (cb != NULL)
 890             *cb = NULL;
 891         if (cbarg != NULL)
 892             *cbarg = NULL;
 893     }
 894 }