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