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