2 * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved.
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
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"
29 static const char FIPS_DEFAULT_PROPERTIES
[] = "provider=fips,fips=yes";
30 static const char FIPS_UNAPPROVED_PROPERTIES
[] = "provider=fips,fips=no";
33 * Forward declarations to ensure that interface functions are correctly
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
;
41 /* Locale object accessor functions */
42 #ifndef OPENSSL_NO_LOCALE
44 # ifdef OPENSSL_SYS_MACOSX
50 static int fips_init_casecmp(void);
51 static void fips_deinit_casecmp(void);
53 #define ALGC(NAMES, FUNC, CHECK) { { NAMES, FIPS_DEFAULT_PROPERTIES, FUNC }, CHECK }
54 #define ALG(NAMES, FUNC) ALGC(NAMES, FUNC, NULL)
56 extern OSSL_FUNC_core_thread_start_fn
*c_thread_start
;
57 int FIPS_security_check_enabled(OSSL_LIB_CTX
*libctx
);
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.
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
;
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
;
96 void *ossl_fips_prov_ossl_ctx_new(OSSL_LIB_CTX
*libctx
)
98 FIPS_GLOBAL
*fgbl
= OPENSSL_zalloc(sizeof(*fgbl
));
102 fgbl
->fips_security_checks
= 1;
103 fgbl
->fips_security_check_option
= "1";
108 void ossl_fips_prov_ossl_ctx_free(void *fgbl
)
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),
123 static int fips_get_params_from_core(FIPS_GLOBAL
*fgbl
)
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.
132 OSSL_PARAM core_params
[8], *p
= core_params
;
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();
164 if (!c_get_params(fgbl
->handle
, core_params
)) {
165 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
172 static const OSSL_PARAM
*fips_gettable_params(void *provctx
)
174 return fips_param_types
;
177 static int fips_get_params(void *provctx
, OSSL_PARAM params
[])
180 FIPS_GLOBAL
*fgbl
= ossl_lib_ctx_get_data(ossl_prov_ctx_get0_libctx(provctx
),
181 OSSL_LIB_CTX_FIPS_PROV_INDEX
);
183 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_NAME
);
184 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, "OpenSSL FIPS Provider"))
186 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_VERSION
);
187 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_VERSION_STR
))
189 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_BUILDINFO
);
190 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_FULL_VERSION_STR
))
192 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_STATUS
);
193 if (p
!= NULL
&& !OSSL_PARAM_set_int(p
, ossl_prov_is_running()))
195 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_SECURITY_CHECKS
);
196 if (p
!= NULL
&& !OSSL_PARAM_set_int(p
, fgbl
->fips_security_checks
))
201 static void set_self_test_cb(FIPS_GLOBAL
*fgbl
)
203 const OSSL_CORE_HANDLE
*handle
=
204 FIPS_get_core_handle(fgbl
->selftest_params
.libctx
);
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
);
210 fgbl
->selftest_params
.cb
= NULL
;
211 fgbl
->selftest_params
.cb_arg
= NULL
;
215 static int fips_self_test(void *provctx
)
217 FIPS_GLOBAL
*fgbl
= ossl_lib_ctx_get_data(ossl_prov_ctx_get0_libctx(provctx
),
218 OSSL_LIB_CTX_FIPS_PROV_INDEX
);
220 set_self_test_cb(fgbl
);
221 return SELF_TEST_post(&fgbl
->selftest_params
, 1) ? 1 : 0;
225 * For the algorithm names, we use the following formula for our primary
228 * ALGNAME[VERSION?][-SUBNAME[VERSION?]?][-SIZE?][-MODE?]
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
236 * SUBNAME may be present where we are combining multiple
237 * algorithms together, e.g. MD5-SHA1.
239 * SIZE is only present if multiple versions of an algorithm exist
240 * with different sizes (e.g. AES-128-CBC, AES-256-CBC)
242 * MODE is only present where applicable.
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.
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
},
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
},
266 { PROV_NAMES_SHAKE_128
, FIPS_DEFAULT_PROPERTIES
, ossl_shake_128_functions
},
267 { PROV_NAMES_SHAKE_256
, FIPS_DEFAULT_PROPERTIES
, ossl_shake_256_functions
},
270 * KECCAK-KMAC-128 and KECCAK-KMAC-256 as hashes are mostly useful for
271 * KMAC128 and KMAC256.
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
},
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
}
340 static OSSL_ALGORITHM exported_fips_ciphers
[OSSL_NELEM(fips_ciphers
)];
342 static const OSSL_ALGORITHM fips_macs
[] = {
343 #ifndef OPENSSL_NO_CMAC
344 { PROV_NAMES_CMAC
, FIPS_DEFAULT_PROPERTIES
, ossl_cmac_functions
},
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
},
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
},
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
},
378 static const OSSL_ALGORITHM fips_keyexch
[] = {
379 #ifndef OPENSSL_NO_DH
380 { PROV_NAMES_DH
, FIPS_DEFAULT_PROPERTIES
, ossl_dh_keyexch_functions
},
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
},
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
},
393 static const OSSL_ALGORITHM fips_signature
[] = {
394 #ifndef OPENSSL_NO_DSA
395 { PROV_NAMES_DSA
, FIPS_DEFAULT_PROPERTIES
, ossl_dsa_signature_functions
},
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
},
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
},
412 static const OSSL_ALGORITHM fips_asym_cipher
[] = {
413 { PROV_NAMES_RSA
, FIPS_DEFAULT_PROPERTIES
, ossl_rsa_asym_cipher_functions
},
417 static const OSSL_ALGORITHM fips_asym_kem
[] = {
418 { PROV_NAMES_RSA
, FIPS_DEFAULT_PROPERTIES
, ossl_rsa_asym_kem_functions
},
422 static const OSSL_ALGORITHM fips_keymgmt
[] = {
423 #ifndef OPENSSL_NO_DH
424 { PROV_NAMES_DH
, FIPS_DEFAULT_PROPERTIES
, ossl_dh_keymgmt_functions
,
426 { PROV_NAMES_DHX
, FIPS_DEFAULT_PROPERTIES
, ossl_dhx_keymgmt_functions
,
429 #ifndef OPENSSL_NO_DSA
430 { PROV_NAMES_DSA
, FIPS_DEFAULT_PROPERTIES
, ossl_dsa_keymgmt_functions
,
433 { PROV_NAMES_RSA
, FIPS_DEFAULT_PROPERTIES
, ossl_rsa_keymgmt_functions
,
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
,
440 { PROV_NAMES_X25519
, FIPS_DEFAULT_PROPERTIES
, ossl_x25519_keymgmt_functions
,
442 { PROV_NAMES_X448
, FIPS_DEFAULT_PROPERTIES
, ossl_x448_keymgmt_functions
,
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
,
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
},
462 static const OSSL_ALGORITHM
*fips_query(void *provctx
, int operation_id
,
467 if (!ossl_prov_is_running())
470 switch (operation_id
) {
474 return exported_fips_ciphers
;
481 case OSSL_OP_KEYMGMT
:
483 case OSSL_OP_KEYEXCH
:
485 case OSSL_OP_SIGNATURE
:
486 return fips_signature
;
487 case OSSL_OP_ASYM_CIPHER
:
488 return fips_asym_cipher
;
490 return fips_asym_kem
;
495 # ifndef OPENSSL_NO_LOCALE
496 void *ossl_c_locale() {
500 static int fips_init_casecmp(void) {
501 # ifdef OPENSSL_SYS_WINDOWS
502 loc
= _create_locale(LC_COLLATE
, "C");
504 loc
= newlocale(LC_COLLATE_MASK
, "C", (locale_t
) 0);
506 return (loc
== (locale_t
) 0) ? 0 : 1;
509 static void fips_deinit_casecmp(void) {
513 void *ossl_c_locale() {
517 static int fips_init_casecmp(void) {
521 static void fips_deinit_casecmp(void) {
525 static void fips_teardown(void *provctx
)
527 OSSL_LIB_CTX_free(PROV_LIBCTX_OF(provctx
));
528 ossl_prov_ctx_free(provctx
);
531 static void fips_intern_teardown(void *provctx
)
534 * We know that the library context is the same as for the outer provider,
535 * so no need to destroy it here.
537 fips_deinit_casecmp();
538 ossl_prov_ctx_free(provctx
);
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
},
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
},
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.
570 # pragma names uppercase,truncated
572 OSSL_provider_init_fn OSSL_provider_init_int
;
574 # pragma names restore
576 int OSSL_provider_init_int(const OSSL_CORE_HANDLE
*handle
,
577 const OSSL_DISPATCH
*in
,
578 const OSSL_DISPATCH
**out
,
582 OSSL_LIB_CTX
*libctx
= NULL
;
583 SELF_TEST_POST_PARAMS selftest_params
;
585 memset(&selftest_params
, 0, sizeof(selftest_params
));
587 if (!fips_init_casecmp())
589 if (!ossl_prov_seeding_from_dispatch(in
))
591 for (; in
->function_id
!= 0; in
++) {
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.
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
));
602 case OSSL_FUNC_CORE_GETTABLE_PARAMS
:
603 set_func(c_gettable_params
, OSSL_FUNC_core_gettable_params(in
));
605 case OSSL_FUNC_CORE_GET_PARAMS
:
606 set_func(c_get_params
, OSSL_FUNC_core_get_params(in
));
608 case OSSL_FUNC_CORE_THREAD_START
:
609 set_func(c_thread_start
, OSSL_FUNC_core_thread_start(in
));
611 case OSSL_FUNC_CORE_NEW_ERROR
:
612 set_func(c_new_error
, OSSL_FUNC_core_new_error(in
));
614 case OSSL_FUNC_CORE_SET_ERROR_DEBUG
:
615 set_func(c_set_error_debug
, OSSL_FUNC_core_set_error_debug(in
));
617 case OSSL_FUNC_CORE_VSET_ERROR
:
618 set_func(c_vset_error
, OSSL_FUNC_core_vset_error(in
));
620 case OSSL_FUNC_CORE_SET_ERROR_MARK
:
621 set_func(c_set_error_mark
, OSSL_FUNC_core_set_error_mark(in
));
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
));
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
));
630 case OSSL_FUNC_CRYPTO_MALLOC
:
631 set_func(c_CRYPTO_malloc
, OSSL_FUNC_CRYPTO_malloc(in
));
633 case OSSL_FUNC_CRYPTO_ZALLOC
:
634 set_func(c_CRYPTO_zalloc
, OSSL_FUNC_CRYPTO_zalloc(in
));
636 case OSSL_FUNC_CRYPTO_FREE
:
637 set_func(c_CRYPTO_free
, OSSL_FUNC_CRYPTO_free(in
));
639 case OSSL_FUNC_CRYPTO_CLEAR_FREE
:
640 set_func(c_CRYPTO_clear_free
, OSSL_FUNC_CRYPTO_clear_free(in
));
642 case OSSL_FUNC_CRYPTO_REALLOC
:
643 set_func(c_CRYPTO_realloc
, OSSL_FUNC_CRYPTO_realloc(in
));
645 case OSSL_FUNC_CRYPTO_CLEAR_REALLOC
:
646 set_func(c_CRYPTO_clear_realloc
,
647 OSSL_FUNC_CRYPTO_clear_realloc(in
));
649 case OSSL_FUNC_CRYPTO_SECURE_MALLOC
:
650 set_func(c_CRYPTO_secure_malloc
,
651 OSSL_FUNC_CRYPTO_secure_malloc(in
));
653 case OSSL_FUNC_CRYPTO_SECURE_ZALLOC
:
654 set_func(c_CRYPTO_secure_zalloc
,
655 OSSL_FUNC_CRYPTO_secure_zalloc(in
));
657 case OSSL_FUNC_CRYPTO_SECURE_FREE
:
658 set_func(c_CRYPTO_secure_free
,
659 OSSL_FUNC_CRYPTO_secure_free(in
));
661 case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
:
662 set_func(c_CRYPTO_secure_clear_free
,
663 OSSL_FUNC_CRYPTO_secure_clear_free(in
));
665 case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
:
666 set_func(c_CRYPTO_secure_allocated
,
667 OSSL_FUNC_CRYPTO_secure_allocated(in
));
669 case OSSL_FUNC_BIO_NEW_FILE
:
670 set_func(selftest_params
.bio_new_file_cb
,
671 OSSL_FUNC_BIO_new_file(in
));
673 case OSSL_FUNC_BIO_NEW_MEMBUF
:
674 set_func(selftest_params
.bio_new_buffer_cb
,
675 OSSL_FUNC_BIO_new_membuf(in
));
677 case OSSL_FUNC_BIO_READ_EX
:
678 set_func(selftest_params
.bio_read_ex_cb
,
679 OSSL_FUNC_BIO_read_ex(in
));
681 case OSSL_FUNC_BIO_FREE
:
682 set_func(selftest_params
.bio_free_cb
, OSSL_FUNC_BIO_free(in
));
684 case OSSL_FUNC_BIO_VSNPRINTF
:
685 set_func(c_BIO_vsnprintf
, OSSL_FUNC_BIO_vsnprintf(in
));
687 case OSSL_FUNC_SELF_TEST_CB
:
688 set_func(c_stcbfn
, OSSL_FUNC_self_test_cb(in
));
691 /* Just ignore anything we don't understand */
696 /* Create a context. */
697 if ((*provctx
= ossl_prov_ctx_new()) == NULL
698 || (libctx
= OSSL_LIB_CTX_new()) == NULL
) {
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.
704 OSSL_LIB_CTX_free(libctx
);
708 if ((fgbl
= ossl_lib_ctx_get_data(libctx
, OSSL_LIB_CTX_FIPS_PROV_INDEX
)) == NULL
)
711 fgbl
->handle
= handle
;
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
718 fgbl
->selftest_params
= selftest_params
;
720 fgbl
->selftest_params
.libctx
= libctx
;
722 set_self_test_cb(fgbl
);
724 if (!fips_get_params_from_core(fgbl
)) {
725 /* Error already raised */
729 * Disable the conditional error check if it's disabled in the fips config
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();
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;
741 ossl_prov_cache_exported_algorithms(fips_ciphers
, exported_fips_ciphers
);
743 if (!SELF_TEST_post(&fgbl
->selftest_params
, 0)) {
744 ERR_raise(ERR_LIB_PROV
, PROV_R_SELF_TEST_POST_FAILURE
);
748 ossl_prov_ctx_set0_libctx(*provctx
, libctx
);
749 ossl_prov_ctx_set0_handle(*provctx
, handle
);
751 *out
= fips_dispatch_table
;
754 fips_teardown(*provctx
);
755 OSSL_LIB_CTX_free(libctx
);
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.
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
,
773 OSSL_FUNC_core_get_libctx_fn
*c_internal_get_libctx
= NULL
;
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
);
785 if (c_internal_get_libctx
== NULL
)
788 if ((*provctx
= ossl_prov_ctx_new()) == NULL
)
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
796 ossl_prov_ctx_set0_libctx(*provctx
,
797 (OSSL_LIB_CTX
*)c_internal_get_libctx(handle
));
798 ossl_prov_ctx_set0_handle(*provctx
, handle
);
800 *out
= intern_dispatch_table
;
809 void ERR_set_debug(const char *file
, int line
, const char *func
)
811 c_set_error_debug(NULL
, file
, line
, func
);
814 void ERR_set_error(int lib
, int reason
, const char *fmt
, ...)
819 c_vset_error(NULL
, ERR_PACK(lib
, 0, reason
), fmt
, args
);
823 void ERR_vset_error(int lib
, int reason
, const char *fmt
, va_list args
)
825 c_vset_error(NULL
, ERR_PACK(lib
, 0, reason
), fmt
, args
);
828 int ERR_set_mark(void)
830 return c_set_error_mark(NULL
);
833 int ERR_clear_last_mark(void)
835 return c_clear_last_error_mark(NULL
);
838 int ERR_pop_to_mark(void)
840 return c_pop_error_to_mark(NULL
);
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)
850 const OSSL_CORE_HANDLE
*FIPS_get_core_handle(OSSL_LIB_CTX
*libctx
)
852 FIPS_GLOBAL
*fgbl
= ossl_lib_ctx_get_data(libctx
,
853 OSSL_LIB_CTX_FIPS_PROV_INDEX
);
861 void *CRYPTO_malloc(size_t num
, const char *file
, int line
)
863 return c_CRYPTO_malloc(num
, file
, line
);
866 void *CRYPTO_zalloc(size_t num
, const char *file
, int line
)
868 return c_CRYPTO_zalloc(num
, file
, line
);
871 void CRYPTO_free(void *ptr
, const char *file
, int line
)
873 c_CRYPTO_free(ptr
, file
, line
);
876 void CRYPTO_clear_free(void *ptr
, size_t num
, const char *file
, int line
)
878 c_CRYPTO_clear_free(ptr
, num
, file
, line
);
881 void *CRYPTO_realloc(void *addr
, size_t num
, const char *file
, int line
)
883 return c_CRYPTO_realloc(addr
, num
, file
, line
);
886 void *CRYPTO_clear_realloc(void *addr
, size_t old_num
, size_t num
,
887 const char *file
, int line
)
889 return c_CRYPTO_clear_realloc(addr
, old_num
, num
, file
, line
);
892 void *CRYPTO_secure_malloc(size_t num
, const char *file
, int line
)
894 return c_CRYPTO_secure_malloc(num
, file
, line
);
897 void *CRYPTO_secure_zalloc(size_t num
, const char *file
, int line
)
899 return c_CRYPTO_secure_zalloc(num
, file
, line
);
902 void CRYPTO_secure_free(void *ptr
, const char *file
, int line
)
904 c_CRYPTO_secure_free(ptr
, file
, line
);
907 void CRYPTO_secure_clear_free(void *ptr
, size_t num
, const char *file
, int line
)
909 c_CRYPTO_secure_clear_free(ptr
, num
, file
, line
);
912 int CRYPTO_secure_allocated(const void *ptr
)
914 return c_CRYPTO_secure_allocated(ptr
);
917 int BIO_snprintf(char *buf
, size_t n
, const char *format
, ...)
922 va_start(args
, format
);
923 ret
= c_BIO_vsnprintf(buf
, n
, format
, args
);
928 int FIPS_security_check_enabled(OSSL_LIB_CTX
*libctx
)
930 FIPS_GLOBAL
*fgbl
= ossl_lib_ctx_get_data(libctx
,
931 OSSL_LIB_CTX_FIPS_PROV_INDEX
);
933 return fgbl
->fips_security_checks
;
936 void OSSL_SELF_TEST_get_callback(OSSL_LIB_CTX
*libctx
, OSSL_CALLBACK
**cb
,
939 assert(libctx
!= NULL
);
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
);