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