f4605dcd6ce5f44a65ba6e04c158ff73d7aa29b7
[openssl.git] / 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_TLS1_3_KDF, FIPS_DEFAULT_PROPERTIES,
350       ossl_kdf_tls1_3_kdf_functions },
351     { PROV_NAMES_SSKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_sskdf_functions },
352     { PROV_NAMES_PBKDF2, FIPS_DEFAULT_PROPERTIES, ossl_kdf_pbkdf2_functions },
353     { PROV_NAMES_SSHKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_sshkdf_functions },
354     { PROV_NAMES_X963KDF, FIPS_DEFAULT_PROPERTIES,
355       ossl_kdf_x963_kdf_functions },
356     { PROV_NAMES_X942KDF_ASN1, FIPS_DEFAULT_PROPERTIES,
357       ossl_kdf_x942_kdf_functions },
358     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES,
359       ossl_kdf_tls1_prf_functions },
360     { PROV_NAMES_KBKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_kbkdf_functions },
361     { NULL, NULL, NULL }
362 };
363
364 static const OSSL_ALGORITHM fips_rands[] = {
365     { PROV_NAMES_CTR_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_ctr_functions },
366     { PROV_NAMES_HASH_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_hash_functions },
367     { PROV_NAMES_HMAC_DRBG, FIPS_DEFAULT_PROPERTIES, ossl_drbg_ossl_hmac_functions },
368     { PROV_NAMES_TEST_RAND, FIPS_UNAPPROVED_PROPERTIES, ossl_test_rng_functions },
369     { NULL, NULL, NULL }
370 };
371
372 static const OSSL_ALGORITHM fips_keyexch[] = {
373 #ifndef OPENSSL_NO_DH
374     { PROV_NAMES_DH, FIPS_DEFAULT_PROPERTIES, ossl_dh_keyexch_functions },
375 #endif
376 #ifndef OPENSSL_NO_EC
377     { PROV_NAMES_ECDH, FIPS_DEFAULT_PROPERTIES, ossl_ecdh_keyexch_functions },
378     { PROV_NAMES_X25519, FIPS_DEFAULT_PROPERTIES, ossl_x25519_keyexch_functions },
379     { PROV_NAMES_X448, FIPS_DEFAULT_PROPERTIES, ossl_x448_keyexch_functions },
380 #endif
381     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES,
382       ossl_kdf_tls1_prf_keyexch_functions },
383     { PROV_NAMES_HKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_hkdf_keyexch_functions },
384     { NULL, NULL, NULL }
385 };
386
387 static const OSSL_ALGORITHM fips_signature[] = {
388 #ifndef OPENSSL_NO_DSA
389     { PROV_NAMES_DSA, FIPS_DEFAULT_PROPERTIES, ossl_dsa_signature_functions },
390 #endif
391     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_signature_functions },
392 #ifndef OPENSSL_NO_EC
393     { PROV_NAMES_ED25519, FIPS_DEFAULT_PROPERTIES, ossl_ed25519_signature_functions },
394     { PROV_NAMES_ED448, FIPS_DEFAULT_PROPERTIES, ossl_ed448_signature_functions },
395     { PROV_NAMES_ECDSA, FIPS_DEFAULT_PROPERTIES, ossl_ecdsa_signature_functions },
396 #endif
397     { PROV_NAMES_HMAC, FIPS_DEFAULT_PROPERTIES,
398       ossl_mac_legacy_hmac_signature_functions },
399 #ifndef OPENSSL_NO_CMAC
400     { PROV_NAMES_CMAC, FIPS_DEFAULT_PROPERTIES,
401       ossl_mac_legacy_cmac_signature_functions },
402 #endif
403     { NULL, NULL, NULL }
404 };
405
406 static const OSSL_ALGORITHM fips_asym_cipher[] = {
407     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_asym_cipher_functions },
408     { NULL, NULL, NULL }
409 };
410
411 static const OSSL_ALGORITHM fips_asym_kem[] = {
412     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_asym_kem_functions },
413     { NULL, NULL, NULL }
414 };
415
416 static const OSSL_ALGORITHM fips_keymgmt[] = {
417 #ifndef OPENSSL_NO_DH
418     { PROV_NAMES_DH, FIPS_DEFAULT_PROPERTIES, ossl_dh_keymgmt_functions,
419       PROV_DESCS_DH },
420     { PROV_NAMES_DHX, FIPS_DEFAULT_PROPERTIES, ossl_dhx_keymgmt_functions,
421       PROV_DESCS_DHX },
422 #endif
423 #ifndef OPENSSL_NO_DSA
424     { PROV_NAMES_DSA, FIPS_DEFAULT_PROPERTIES, ossl_dsa_keymgmt_functions,
425       PROV_DESCS_DSA },
426 #endif
427     { PROV_NAMES_RSA, FIPS_DEFAULT_PROPERTIES, ossl_rsa_keymgmt_functions,
428       PROV_DESCS_RSA },
429     { PROV_NAMES_RSA_PSS, FIPS_DEFAULT_PROPERTIES,
430       ossl_rsapss_keymgmt_functions, PROV_DESCS_RSA_PSS },
431 #ifndef OPENSSL_NO_EC
432     { PROV_NAMES_EC, FIPS_DEFAULT_PROPERTIES, ossl_ec_keymgmt_functions,
433       PROV_DESCS_EC },
434     { PROV_NAMES_X25519, FIPS_DEFAULT_PROPERTIES, ossl_x25519_keymgmt_functions,
435       PROV_DESCS_X25519 },
436     { PROV_NAMES_X448, FIPS_DEFAULT_PROPERTIES, ossl_x448_keymgmt_functions,
437       PROV_DESCS_X448 },
438     { PROV_NAMES_ED25519, FIPS_DEFAULT_PROPERTIES, ossl_ed25519_keymgmt_functions,
439       PROV_DESCS_ED25519 },
440     { PROV_NAMES_ED448, FIPS_DEFAULT_PROPERTIES, ossl_ed448_keymgmt_functions,
441       PROV_DESCS_ED448 },
442 #endif
443     { PROV_NAMES_TLS1_PRF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_keymgmt_functions,
444       PROV_DESCS_TLS1_PRF_SIGN },
445     { PROV_NAMES_HKDF, FIPS_DEFAULT_PROPERTIES, ossl_kdf_keymgmt_functions,
446       PROV_DESCS_HKDF_SIGN },
447     { PROV_NAMES_HMAC, FIPS_DEFAULT_PROPERTIES, ossl_mac_legacy_keymgmt_functions,
448       PROV_DESCS_HMAC_SIGN },
449 #ifndef OPENSSL_NO_CMAC
450     { PROV_NAMES_CMAC, FIPS_DEFAULT_PROPERTIES,
451       ossl_cmac_legacy_keymgmt_functions, PROV_DESCS_CMAC_SIGN },
452 #endif
453     { NULL, NULL, NULL }
454 };
455
456 static const OSSL_ALGORITHM *fips_query(void *provctx, int operation_id,
457                                         int *no_cache)
458 {
459     *no_cache = 0;
460
461     if (!ossl_prov_is_running())
462         return NULL;
463
464     switch (operation_id) {
465     case OSSL_OP_DIGEST:
466         return fips_digests;
467     case OSSL_OP_CIPHER:
468         return exported_fips_ciphers;
469     case OSSL_OP_MAC:
470         return fips_macs;
471     case OSSL_OP_KDF:
472         return fips_kdfs;
473     case OSSL_OP_RAND:
474         return fips_rands;
475     case OSSL_OP_KEYMGMT:
476         return fips_keymgmt;
477     case OSSL_OP_KEYEXCH:
478         return fips_keyexch;
479     case OSSL_OP_SIGNATURE:
480         return fips_signature;
481     case OSSL_OP_ASYM_CIPHER:
482         return fips_asym_cipher;
483     case OSSL_OP_KEM:
484         return fips_asym_kem;
485     }
486     return NULL;
487 }
488
489 static void fips_teardown(void *provctx)
490 {
491     OSSL_LIB_CTX_free(PROV_LIBCTX_OF(provctx));
492     ossl_prov_ctx_free(provctx);
493 }
494
495 static void fips_intern_teardown(void *provctx)
496 {
497     /*
498      * We know that the library context is the same as for the outer provider,
499      * so no need to destroy it here.
500      */
501     ossl_prov_ctx_free(provctx);
502 }
503
504 /* Functions we provide to the core */
505 static const OSSL_DISPATCH fips_dispatch_table[] = {
506     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_teardown },
507     { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))fips_gettable_params },
508     { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
509     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
510     { OSSL_FUNC_PROVIDER_GET_CAPABILITIES,
511       (void (*)(void))ossl_prov_get_capabilities },
512     { OSSL_FUNC_PROVIDER_SELF_TEST, (void (*)(void))fips_self_test },
513     { 0, NULL }
514 };
515
516 /* Functions we provide to ourself */
517 static const OSSL_DISPATCH intern_dispatch_table[] = {
518     { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))fips_intern_teardown },
519     { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
520     { 0, NULL }
521 };
522
523 /*
524  * On VMS, the provider init function name is expected to be uppercase,
525  * see the pragmas in <openssl/core.h>.  Let's do the same with this
526  * internal name.  This is how symbol names are treated by default
527  * by the compiler if nothing else is said, but since this is part
528  * of libfips, and we build our libraries with mixed case symbol names,
529  * we must switch back to this default explicitly here.
530  */
531 #ifdef __VMS
532 # pragma names save
533 # pragma names uppercase,truncated
534 #endif
535 OSSL_provider_init_fn OSSL_provider_init_int;
536 #ifdef __VMS
537 # pragma names restore
538 #endif
539 int OSSL_provider_init_int(const OSSL_CORE_HANDLE *handle,
540                            const OSSL_DISPATCH *in,
541                            const OSSL_DISPATCH **out,
542                            void **provctx)
543 {
544     FIPS_GLOBAL *fgbl;
545     OSSL_LIB_CTX *libctx = NULL;
546     SELF_TEST_POST_PARAMS selftest_params;
547
548     memset(&selftest_params, 0, sizeof(selftest_params));
549
550     if (!ossl_prov_seeding_from_dispatch(in))
551         return 0;
552     for (; in->function_id != 0; in++) {
553         /*
554          * We do not support the scenario of an application linked against
555          * multiple versions of libcrypto (e.g. one static and one dynamic), but
556          * sharing a single fips.so. We do a simple sanity check here.
557          */
558 #define set_func(c, f) if (c == NULL) c = f; else if (c != f) return 0;
559         switch (in->function_id) {
560         case OSSL_FUNC_CORE_GET_LIBCTX:
561             set_func(c_get_libctx, OSSL_FUNC_core_get_libctx(in));
562             break;
563         case OSSL_FUNC_CORE_GETTABLE_PARAMS:
564             set_func(c_gettable_params, OSSL_FUNC_core_gettable_params(in));
565             break;
566         case OSSL_FUNC_CORE_GET_PARAMS:
567             set_func(c_get_params, OSSL_FUNC_core_get_params(in));
568             break;
569         case OSSL_FUNC_CORE_THREAD_START:
570             set_func(c_thread_start, OSSL_FUNC_core_thread_start(in));
571             break;
572         case OSSL_FUNC_CORE_NEW_ERROR:
573             set_func(c_new_error, OSSL_FUNC_core_new_error(in));
574             break;
575         case OSSL_FUNC_CORE_SET_ERROR_DEBUG:
576             set_func(c_set_error_debug, OSSL_FUNC_core_set_error_debug(in));
577             break;
578         case OSSL_FUNC_CORE_VSET_ERROR:
579             set_func(c_vset_error, OSSL_FUNC_core_vset_error(in));
580             break;
581         case OSSL_FUNC_CORE_SET_ERROR_MARK:
582             set_func(c_set_error_mark, OSSL_FUNC_core_set_error_mark(in));
583             break;
584         case OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK:
585             set_func(c_clear_last_error_mark,
586                      OSSL_FUNC_core_clear_last_error_mark(in));
587             break;
588         case OSSL_FUNC_CORE_POP_ERROR_TO_MARK:
589             set_func(c_pop_error_to_mark, OSSL_FUNC_core_pop_error_to_mark(in));
590             break;
591         case OSSL_FUNC_CRYPTO_MALLOC:
592             set_func(c_CRYPTO_malloc, OSSL_FUNC_CRYPTO_malloc(in));
593             break;
594         case OSSL_FUNC_CRYPTO_ZALLOC:
595             set_func(c_CRYPTO_zalloc, OSSL_FUNC_CRYPTO_zalloc(in));
596             break;
597         case OSSL_FUNC_CRYPTO_FREE:
598             set_func(c_CRYPTO_free, OSSL_FUNC_CRYPTO_free(in));
599             break;
600         case OSSL_FUNC_CRYPTO_CLEAR_FREE:
601             set_func(c_CRYPTO_clear_free, OSSL_FUNC_CRYPTO_clear_free(in));
602             break;
603         case OSSL_FUNC_CRYPTO_REALLOC:
604             set_func(c_CRYPTO_realloc, OSSL_FUNC_CRYPTO_realloc(in));
605             break;
606         case OSSL_FUNC_CRYPTO_CLEAR_REALLOC:
607             set_func(c_CRYPTO_clear_realloc,
608                      OSSL_FUNC_CRYPTO_clear_realloc(in));
609             break;
610         case OSSL_FUNC_CRYPTO_SECURE_MALLOC:
611             set_func(c_CRYPTO_secure_malloc,
612                      OSSL_FUNC_CRYPTO_secure_malloc(in));
613             break;
614         case OSSL_FUNC_CRYPTO_SECURE_ZALLOC:
615             set_func(c_CRYPTO_secure_zalloc,
616                      OSSL_FUNC_CRYPTO_secure_zalloc(in));
617             break;
618         case OSSL_FUNC_CRYPTO_SECURE_FREE:
619             set_func(c_CRYPTO_secure_free,
620                      OSSL_FUNC_CRYPTO_secure_free(in));
621             break;
622         case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE:
623             set_func(c_CRYPTO_secure_clear_free,
624                      OSSL_FUNC_CRYPTO_secure_clear_free(in));
625             break;
626         case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED:
627             set_func(c_CRYPTO_secure_allocated,
628                      OSSL_FUNC_CRYPTO_secure_allocated(in));
629             break;
630         case OSSL_FUNC_BIO_NEW_FILE:
631             set_func(selftest_params.bio_new_file_cb,
632                      OSSL_FUNC_BIO_new_file(in));
633             break;
634         case OSSL_FUNC_BIO_NEW_MEMBUF:
635             set_func(selftest_params.bio_new_buffer_cb,
636                      OSSL_FUNC_BIO_new_membuf(in));
637             break;
638         case OSSL_FUNC_BIO_READ_EX:
639             set_func(selftest_params.bio_read_ex_cb,
640                      OSSL_FUNC_BIO_read_ex(in));
641             break;
642         case OSSL_FUNC_BIO_FREE:
643             set_func(selftest_params.bio_free_cb, OSSL_FUNC_BIO_free(in));
644             break;
645         case OSSL_FUNC_BIO_VSNPRINTF:
646             set_func(c_BIO_vsnprintf, OSSL_FUNC_BIO_vsnprintf(in));
647             break;
648         case OSSL_FUNC_SELF_TEST_CB:
649             set_func(c_stcbfn, OSSL_FUNC_self_test_cb(in));
650             break;
651         default:
652             /* Just ignore anything we don't understand */
653             break;
654         }
655     }
656
657     /*  Create a context. */
658     if ((*provctx = ossl_prov_ctx_new()) == NULL
659         || (libctx = OSSL_LIB_CTX_new()) == NULL) {
660         /*
661          * We free libctx separately here and only here because it hasn't
662          * been attached to *provctx.  All other error paths below rely
663          * solely on fips_teardown.
664          */
665         OSSL_LIB_CTX_free(libctx);
666         goto err;
667     }
668
669     if ((fgbl = ossl_lib_ctx_get_data(libctx, OSSL_LIB_CTX_FIPS_PROV_INDEX,
670                                       &fips_prov_ossl_ctx_method)) == NULL)
671         goto err;
672
673     fgbl->handle = handle;
674
675     /*
676      * We did initial set up of selftest_params in a local copy, because we
677      * could not create fgbl until c_CRYPTO_zalloc was defined in the loop
678      * above.
679      */
680     fgbl->selftest_params = selftest_params;
681
682     fgbl->selftest_params.libctx = libctx;
683
684     set_self_test_cb(fgbl);
685
686     if (!fips_get_params_from_core(fgbl)) {
687         /* Error already raised */
688         goto err;
689     }
690     /*
691      * Disable the conditional error check if it's disabled in the fips config
692      * file.
693      */
694     if (fgbl->selftest_params.conditional_error_check != NULL
695         && strcmp(fgbl->selftest_params.conditional_error_check, "0") == 0)
696         SELF_TEST_disable_conditional_error_state();
697
698     /* Disable the security check if it's disabled in the fips config file. */
699     if (fgbl->fips_security_check_option != NULL
700         && strcmp(fgbl->fips_security_check_option, "0") == 0)
701         fgbl->fips_security_checks = 0;
702
703     ossl_prov_cache_exported_algorithms(fips_ciphers, exported_fips_ciphers);
704
705     if (!SELF_TEST_post(&fgbl->selftest_params, 0)) {
706         ERR_raise(ERR_LIB_PROV, PROV_R_SELF_TEST_POST_FAILURE);
707         goto err;
708     }
709
710     ossl_prov_ctx_set0_libctx(*provctx, libctx);
711     ossl_prov_ctx_set0_handle(*provctx, handle);
712
713     *out = fips_dispatch_table;
714     return 1;
715  err:
716     fips_teardown(*provctx);
717     OSSL_LIB_CTX_free(libctx);
718     *provctx = NULL;
719     return 0;
720 }
721
722 /*
723  * The internal init function used when the FIPS module uses EVP to call
724  * another algorithm also in the FIPS module. This is a recursive call that has
725  * been made from within the FIPS module itself. To make this work, we populate
726  * the provider context of this inner instance with the same library context
727  * that was used in the EVP call that initiated this recursive call.
728  */
729 OSSL_provider_init_fn ossl_fips_intern_provider_init;
730 int ossl_fips_intern_provider_init(const OSSL_CORE_HANDLE *handle,
731                                    const OSSL_DISPATCH *in,
732                                    const OSSL_DISPATCH **out,
733                                    void **provctx)
734 {
735     OSSL_FUNC_core_get_libctx_fn *c_internal_get_libctx = NULL;
736
737     for (; in->function_id != 0; in++) {
738         switch (in->function_id) {
739         case OSSL_FUNC_CORE_GET_LIBCTX:
740             c_internal_get_libctx = OSSL_FUNC_core_get_libctx(in);
741             break;
742         default:
743             break;
744         }
745     }
746
747     if (c_internal_get_libctx == NULL)
748         return 0;
749
750     if ((*provctx = ossl_prov_ctx_new()) == NULL)
751         return 0;
752
753     /*
754      * Using the parent library context only works because we are a built-in
755      * internal provider. This is not something that most providers would be
756      * able to do.
757      */
758     ossl_prov_ctx_set0_libctx(*provctx,
759                               (OSSL_LIB_CTX *)c_internal_get_libctx(handle));
760     ossl_prov_ctx_set0_handle(*provctx, handle);
761
762     *out = intern_dispatch_table;
763     return 1;
764 }
765
766 void ERR_new(void)
767 {
768     c_new_error(NULL);
769 }
770
771 void ERR_set_debug(const char *file, int line, const char *func)
772 {
773     c_set_error_debug(NULL, file, line, func);
774 }
775
776 void ERR_set_error(int lib, int reason, const char *fmt, ...)
777 {
778     va_list args;
779
780     va_start(args, fmt);
781     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
782     va_end(args);
783 }
784
785 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args)
786 {
787     c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
788 }
789
790 int ERR_set_mark(void)
791 {
792     return c_set_error_mark(NULL);
793 }
794
795 int ERR_clear_last_mark(void)
796 {
797     return c_clear_last_error_mark(NULL);
798 }
799
800 int ERR_pop_to_mark(void)
801 {
802     return c_pop_error_to_mark(NULL);
803 }
804
805 /*
806  * This must take a library context, since it's called from the depths
807  * of crypto/initthread.c code, where it's (correctly) assumed that the
808  * passed caller argument is an OSSL_LIB_CTX pointer (since the same routine
809  * is also called from other parts of libcrypto, which all pass around a
810  * OSSL_LIB_CTX pointer)
811  */
812 const OSSL_CORE_HANDLE *FIPS_get_core_handle(OSSL_LIB_CTX *libctx)
813 {
814     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(libctx,
815                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
816                                               &fips_prov_ossl_ctx_method);
817
818     if (fgbl == NULL)
819         return NULL;
820
821     return fgbl->handle;
822 }
823
824 void *CRYPTO_malloc(size_t num, const char *file, int line)
825 {
826     return c_CRYPTO_malloc(num, file, line);
827 }
828
829 void *CRYPTO_zalloc(size_t num, const char *file, int line)
830 {
831     return c_CRYPTO_zalloc(num, file, line);
832 }
833
834 void CRYPTO_free(void *ptr, const char *file, int line)
835 {
836     c_CRYPTO_free(ptr, file, line);
837 }
838
839 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line)
840 {
841     c_CRYPTO_clear_free(ptr, num, file, line);
842 }
843
844 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line)
845 {
846     return c_CRYPTO_realloc(addr, num, file, line);
847 }
848
849 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
850                            const char *file, int line)
851 {
852     return c_CRYPTO_clear_realloc(addr, old_num, num, file, line);
853 }
854
855 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
856 {
857     return c_CRYPTO_secure_malloc(num, file, line);
858 }
859
860 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
861 {
862     return c_CRYPTO_secure_zalloc(num, file, line);
863 }
864
865 void CRYPTO_secure_free(void *ptr, const char *file, int line)
866 {
867     c_CRYPTO_secure_free(ptr, file, line);
868 }
869
870 void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *file, int line)
871 {
872     c_CRYPTO_secure_clear_free(ptr, num, file, line);
873 }
874
875 int CRYPTO_secure_allocated(const void *ptr)
876 {
877     return c_CRYPTO_secure_allocated(ptr);
878 }
879
880 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
881 {
882     va_list args;
883     int ret;
884
885     va_start(args, format);
886     ret = c_BIO_vsnprintf(buf, n, format, args);
887     va_end(args);
888     return ret;
889 }
890
891 int FIPS_security_check_enabled(OSSL_LIB_CTX *libctx)
892 {
893     FIPS_GLOBAL *fgbl = ossl_lib_ctx_get_data(libctx,
894                                               OSSL_LIB_CTX_FIPS_PROV_INDEX,
895                                               &fips_prov_ossl_ctx_method);
896
897     return fgbl->fips_security_checks;
898 }
899
900 void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX *libctx, OSSL_CALLBACK **cb,
901                                  void **cbarg)
902 {
903     assert(libctx != NULL);
904
905     if (c_stcbfn != NULL && c_get_libctx != NULL) {
906         /* Get the parent libctx */
907         c_stcbfn(c_get_libctx(FIPS_get_core_handle(libctx)), cb, cbarg);
908     } else {
909         if (cb != NULL)
910             *cb = NULL;
911         if (cbarg != NULL)
912             *cbarg = NULL;
913     }
914 }