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