2 * Copyright 2019-2020 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
10 #include <openssl/core_dispatch.h>
11 #include <openssl/core_names.h>
12 #include <openssl/params.h>
13 #include <openssl/obj_mac.h> /* NIDs used by ossl_prov_util_nid_to_name() */
14 #include <openssl/fips_names.h>
15 #include <openssl/rand.h> /* RAND_get0_public() */
16 #include "internal/cryptlib.h"
17 #include "prov/implementations.h"
18 #include "prov/provider_ctx.h"
19 #include "prov/providercommon.h"
20 #include "prov/providercommonerr.h"
21 #include "prov/provider_util.h"
22 #include "self_test.h"
24 static const char FIPS_DEFAULT_PROPERTIES
[] = "provider=fips,fips=yes";
25 static const char FIPS_UNAPPROVED_PROPERTIES
[] = "provider=fips,fips=no";
28 * Forward declarations to ensure that interface functions are correctly
31 static OSSL_FUNC_provider_teardown_fn fips_teardown
;
32 static OSSL_FUNC_provider_gettable_params_fn fips_gettable_params
;
33 static OSSL_FUNC_provider_get_params_fn fips_get_params
;
34 static OSSL_FUNC_provider_query_operation_fn fips_query
;
36 #define ALGC(NAMES, FUNC, CHECK) { { NAMES, FIPS_DEFAULT_PROPERTIES, FUNC }, CHECK }
37 #define ALG(NAMES, FUNC) ALGC(NAMES, FUNC, NULL)
39 extern OSSL_FUNC_core_thread_start_fn
*c_thread_start
;
42 * TODO(3.0): Should these be stored in the provider side provctx? Could they
43 * ever be different from one init to the next? Unfortunately we can't do this
44 * at the moment because c_put_error/c_add_error_vdata do not provide
45 * us with the OPENSSL_CTX as a parameter.
48 static SELF_TEST_POST_PARAMS selftest_params
;
50 /* Functions provided by the core */
51 static OSSL_FUNC_core_gettable_params_fn
*c_gettable_params
;
52 static OSSL_FUNC_core_get_params_fn
*c_get_params
;
53 OSSL_FUNC_core_thread_start_fn
*c_thread_start
;
54 static OSSL_FUNC_core_new_error_fn
*c_new_error
;
55 static OSSL_FUNC_core_set_error_debug_fn
*c_set_error_debug
;
56 static OSSL_FUNC_core_vset_error_fn
*c_vset_error
;
57 static OSSL_FUNC_core_set_error_mark_fn
*c_set_error_mark
;
58 static OSSL_FUNC_core_clear_last_error_mark_fn
*c_clear_last_error_mark
;
59 static OSSL_FUNC_core_pop_error_to_mark_fn
*c_pop_error_to_mark
;
60 static OSSL_FUNC_CRYPTO_malloc_fn
*c_CRYPTO_malloc
;
61 static OSSL_FUNC_CRYPTO_zalloc_fn
*c_CRYPTO_zalloc
;
62 static OSSL_FUNC_CRYPTO_free_fn
*c_CRYPTO_free
;
63 static OSSL_FUNC_CRYPTO_clear_free_fn
*c_CRYPTO_clear_free
;
64 static OSSL_FUNC_CRYPTO_realloc_fn
*c_CRYPTO_realloc
;
65 static OSSL_FUNC_CRYPTO_clear_realloc_fn
*c_CRYPTO_clear_realloc
;
66 static OSSL_FUNC_CRYPTO_secure_malloc_fn
*c_CRYPTO_secure_malloc
;
67 static OSSL_FUNC_CRYPTO_secure_zalloc_fn
*c_CRYPTO_secure_zalloc
;
68 static OSSL_FUNC_CRYPTO_secure_free_fn
*c_CRYPTO_secure_free
;
69 static OSSL_FUNC_CRYPTO_secure_clear_free_fn
*c_CRYPTO_secure_clear_free
;
70 static OSSL_FUNC_CRYPTO_secure_allocated_fn
*c_CRYPTO_secure_allocated
;
71 static OSSL_FUNC_BIO_vsnprintf_fn
*c_BIO_vsnprintf
;
72 static OSSL_FUNC_self_test_cb_fn
*c_stcbfn
= NULL
;
73 static OSSL_FUNC_core_get_library_context_fn
*c_get_libctx
= NULL
;
75 typedef struct fips_global_st
{
76 const OSSL_CORE_HANDLE
*handle
;
79 static void *fips_prov_ossl_ctx_new(OPENSSL_CTX
*libctx
)
81 FIPS_GLOBAL
*fgbl
= OPENSSL_zalloc(sizeof(*fgbl
));
86 static void fips_prov_ossl_ctx_free(void *fgbl
)
91 static const OPENSSL_CTX_METHOD fips_prov_ossl_ctx_method
= {
92 fips_prov_ossl_ctx_new
,
93 fips_prov_ossl_ctx_free
,
97 /* Parameters we provide to the core */
98 static const OSSL_PARAM fips_param_types
[] = {
99 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME
, OSSL_PARAM_UTF8_PTR
, NULL
, 0),
100 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION
, OSSL_PARAM_UTF8_PTR
, NULL
, 0),
101 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO
, OSSL_PARAM_UTF8_PTR
, NULL
, 0),
102 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_STATUS
, OSSL_PARAM_UNSIGNED_INTEGER
, NULL
, 0),
107 * Parameters to retrieve from the core provider - required for self testing.
108 * NOTE: inside core_get_params() these will be loaded from config items
109 * stored inside prov->parameters (except for
110 * OSSL_PROV_PARAM_CORE_MODULE_FILENAME).
112 static OSSL_PARAM core_params
[] =
114 OSSL_PARAM_utf8_ptr(OSSL_PROV_PARAM_CORE_MODULE_FILENAME
,
115 selftest_params
.module_filename
,
116 sizeof(selftest_params
.module_filename
)),
117 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_MODULE_MAC
,
118 selftest_params
.module_checksum_data
,
119 sizeof(selftest_params
.module_checksum_data
)),
120 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_MAC
,
121 selftest_params
.indicator_checksum_data
,
122 sizeof(selftest_params
.indicator_checksum_data
)),
123 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_STATUS
,
124 selftest_params
.indicator_data
,
125 sizeof(selftest_params
.indicator_data
)),
126 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_VERSION
,
127 selftest_params
.indicator_version
,
128 sizeof(selftest_params
.indicator_version
)),
132 static const OSSL_PARAM
*fips_gettable_params(void *provctx
)
134 return fips_param_types
;
137 static int fips_get_params(void *provctx
, OSSL_PARAM params
[])
141 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_NAME
);
142 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, "OpenSSL FIPS Provider"))
144 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_VERSION
);
145 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_VERSION_STR
))
147 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_BUILDINFO
);
148 if (p
!= NULL
&& !OSSL_PARAM_set_utf8_ptr(p
, OPENSSL_FULL_VERSION_STR
))
150 p
= OSSL_PARAM_locate(params
, OSSL_PROV_PARAM_STATUS
);
151 if (p
!= NULL
&& !OSSL_PARAM_set_uint(p
, FIPS_is_running()))
156 static void set_self_test_cb(const OSSL_CORE_HANDLE
*handle
)
158 if (c_stcbfn
!= NULL
&& c_get_libctx
!= NULL
) {
159 c_stcbfn(c_get_libctx(handle
), &selftest_params
.cb
,
160 &selftest_params
.cb_arg
);
162 selftest_params
.cb
= NULL
;
163 selftest_params
.cb_arg
= NULL
;
167 static int fips_self_test(void *provctx
)
169 set_self_test_cb(FIPS_get_core_handle(selftest_params
.libctx
));
170 return SELF_TEST_post(&selftest_params
, 1) ? 1 : 0;
173 /* FIPS specific version of the function of the same name in provlib.c */
174 /* TODO(3.0) - Is this function needed ? */
175 const char *ossl_prov_util_nid_to_name(int nid
)
177 /* We don't have OBJ_nid2n() in FIPS_MODULE so we have an explicit list */
192 return "SHA-512/224";
194 return "SHA-512/256";
205 case NID_aes_256_ecb
:
206 return "AES-256-ECB";
207 case NID_aes_192_ecb
:
208 return "AES-192-ECB";
209 case NID_aes_128_ecb
:
210 return "AES-128-ECB";
211 case NID_aes_256_cbc
:
212 return "AES-256-CBC";
213 case NID_aes_192_cbc
:
214 return "AES-192-CBC";
215 case NID_aes_128_cbc
:
216 return "AES-128-CBC";
217 case NID_aes_256_ctr
:
218 return "AES-256-CTR";
219 case NID_aes_192_ctr
:
220 return "AES-192-CTR";
221 case NID_aes_128_ctr
:
222 return "AES-128-CTR";
223 case NID_aes_256_xts
:
224 return "AES-256-XTS";
225 case NID_aes_128_xts
:
226 return "AES-128-XTS";
227 case NID_aes_256_gcm
:
228 return "AES-256-GCM";
229 case NID_aes_192_gcm
:
230 return "AES-192-GCM";
231 case NID_aes_128_gcm
:
232 return "AES-128-GCM";
233 case NID_aes_256_ccm
:
234 return "AES-256-CCM";
235 case NID_aes_192_ccm
:
236 return "AES-192-CCM";
237 case NID_aes_128_ccm
:
238 return "AES-128-CCM";
239 case NID_id_aes256_wrap
:
240 return "AES-256-WRAP";
241 case NID_id_aes192_wrap
:
242 return "AES-192-WRAP";
243 case NID_id_aes128_wrap
:
244 return "AES-128-WRAP";
245 case NID_id_aes256_wrap_pad
:
246 return "AES-256-WRAP-PAD";
247 case NID_id_aes192_wrap_pad
:
248 return "AES-192-WRAP-PAD";
249 case NID_id_aes128_wrap_pad
:
250 return "AES-128-WRAP-PAD";
251 case NID_des_ede3_ecb
:
253 case NID_des_ede3_cbc
:
254 return "DES-EDE3-CBC";
255 case NID_aes_256_cbc_hmac_sha256
:
256 return "AES-256-CBC-HMAC-SHA256";
257 case NID_aes_128_cbc_hmac_sha256
:
258 return "AES-128-CBC-HMAC-SHA256";
259 case NID_aes_256_cbc_hmac_sha1
:
260 return "AES-256-CBC-HMAC-SHA1";
261 case NID_aes_128_cbc_hmac_sha1
:
262 return "AES-128-CBC-HMAC-SHA1";
271 * For the algorithm names, we use the following formula for our primary
274 * ALGNAME[VERSION?][-SUBNAME[VERSION?]?][-SIZE?][-MODE?]
276 * VERSION is only present if there are multiple versions of
277 * an alg (MD2, MD4, MD5). It may be omitted if there is only
278 * one version (if a subsequent version is released in the future,
279 * we can always change the canonical name, and add the old name
282 * SUBNAME may be present where we are combining multiple
283 * algorithms together, e.g. MD5-SHA1.
285 * SIZE is only present if multiple versions of an algorithm exist
286 * with different sizes (e.g. AES-128-CBC, AES-256-CBC)
288 * MODE is only present where applicable.
290 * We add diverse other names where applicable, such as the names that
291 * NIST uses, or that are used for ASN.1 OBJECT IDENTIFIERs, or names
292 * we have used historically.
294 static const OSSL_ALGORITHM fips_digests
[] = {
295 /* Our primary name:NiST name[:our older names] */
296 { "SHA1:SHA-1:SSL3-SHA1", FIPS_DEFAULT_PROPERTIES
, sha1_functions
},
297 { "SHA2-224:SHA-224:SHA224", FIPS_DEFAULT_PROPERTIES
, sha224_functions
},
298 { "SHA2-256:SHA-256:SHA256", FIPS_DEFAULT_PROPERTIES
, sha256_functions
},
299 { "SHA2-384:SHA-384:SHA384", FIPS_DEFAULT_PROPERTIES
, sha384_functions
},
300 { "SHA2-512:SHA-512:SHA512", FIPS_DEFAULT_PROPERTIES
, sha512_functions
},
301 { "SHA2-512/224:SHA-512/224:SHA512-224", FIPS_DEFAULT_PROPERTIES
,
302 sha512_224_functions
},
303 { "SHA2-512/256:SHA-512/256:SHA512-256", FIPS_DEFAULT_PROPERTIES
,
304 sha512_256_functions
},
306 /* We agree with NIST here, so one name only */
307 { "SHA3-224", FIPS_DEFAULT_PROPERTIES
, sha3_224_functions
},
308 { "SHA3-256", FIPS_DEFAULT_PROPERTIES
, sha3_256_functions
},
309 { "SHA3-384", FIPS_DEFAULT_PROPERTIES
, sha3_384_functions
},
310 { "SHA3-512", FIPS_DEFAULT_PROPERTIES
, sha3_512_functions
},
312 { "SHAKE-128:SHAKE128", FIPS_DEFAULT_PROPERTIES
, shake_128_functions
},
313 { "SHAKE-256:SHAKE256", FIPS_DEFAULT_PROPERTIES
, shake_256_functions
},
316 * KECCAK-KMAC-128 and KECCAK-KMAC-256 as hashes are mostly useful for
317 * KMAC128 and KMAC256.
319 { "KECCAK-KMAC-128:KECCAK-KMAC128", FIPS_DEFAULT_PROPERTIES
,
320 keccak_kmac_128_functions
},
321 { "KECCAK-KMAC-256:KECCAK-KMAC256", FIPS_DEFAULT_PROPERTIES
,
322 keccak_kmac_256_functions
},
326 static const OSSL_ALGORITHM_CAPABLE fips_ciphers
[] = {
327 /* Our primary name[:ASN.1 OID name][:our older names] */
328 ALG("AES-256-ECB", aes256ecb_functions
),
329 ALG("AES-192-ECB", aes192ecb_functions
),
330 ALG("AES-128-ECB", aes128ecb_functions
),
331 ALG("AES-256-CBC:AES256", aes256cbc_functions
),
332 ALG("AES-192-CBC:AES192", aes192cbc_functions
),
333 ALG("AES-128-CBC:AES128", aes128cbc_functions
),
334 ALG("AES-256-CBC-CTS", aes256cbc_cts_functions
),
335 ALG("AES-192-CBC-CTS", aes192cbc_cts_functions
),
336 ALG("AES-128-CBC-CTS", aes128cbc_cts_functions
),
337 ALG("AES-256-OFB", aes256ofb_functions
),
338 ALG("AES-192-OFB", aes192ofb_functions
),
339 ALG("AES-128-OFB", aes128ofb_functions
),
340 ALG("AES-256-CFB", aes256cfb_functions
),
341 ALG("AES-192-CFB", aes192cfb_functions
),
342 ALG("AES-128-CFB", aes128cfb_functions
),
343 ALG("AES-256-CFB1", aes256cfb1_functions
),
344 ALG("AES-192-CFB1", aes192cfb1_functions
),
345 ALG("AES-128-CFB1", aes128cfb1_functions
),
346 ALG("AES-256-CFB8", aes256cfb8_functions
),
347 ALG("AES-192-CFB8", aes192cfb8_functions
),
348 ALG("AES-128-CFB8", aes128cfb8_functions
),
349 ALG("AES-256-CTR", aes256ctr_functions
),
350 ALG("AES-192-CTR", aes192ctr_functions
),
351 ALG("AES-128-CTR", aes128ctr_functions
),
352 ALG("AES-256-XTS", aes256xts_functions
),
353 ALG("AES-128-XTS", aes128xts_functions
),
354 ALG("AES-256-GCM:id-aes256-GCM", aes256gcm_functions
),
355 ALG("AES-192-GCM:id-aes192-GCM", aes192gcm_functions
),
356 ALG("AES-128-GCM:id-aes128-GCM", aes128gcm_functions
),
357 ALG("AES-256-CCM:id-aes256-CCM", aes256ccm_functions
),
358 ALG("AES-192-CCM:id-aes192-CCM", aes192ccm_functions
),
359 ALG("AES-128-CCM:id-aes128-CCM", aes128ccm_functions
),
360 ALG("AES-256-WRAP:id-aes256-wrap:AES256-WRAP", aes256wrap_functions
),
361 ALG("AES-192-WRAP:id-aes192-wrap:AES192-WRAP", aes192wrap_functions
),
362 ALG("AES-128-WRAP:id-aes128-wrap:AES128-WRAP", aes128wrap_functions
),
363 ALG("AES-256-WRAP-PAD:id-aes256-wrap-pad:AES256-WRAP-PAD",
364 aes256wrappad_functions
),
365 ALG("AES-192-WRAP-PAD:id-aes192-wrap-pad:AES192-WRAP-PAD",
366 aes192wrappad_functions
),
367 ALG("AES-128-WRAP-PAD:id-aes128-wrap-pad:AES128-WRAP-PAD",
368 aes128wrappad_functions
),
369 ALGC("AES-128-CBC-HMAC-SHA1", aes128cbc_hmac_sha1_functions
,
370 cipher_capable_aes_cbc_hmac_sha1
),
371 ALGC("AES-256-CBC-HMAC-SHA1", aes256cbc_hmac_sha1_functions
,
372 cipher_capable_aes_cbc_hmac_sha1
),
373 ALGC("AES-128-CBC-HMAC-SHA256", aes128cbc_hmac_sha256_functions
,
374 cipher_capable_aes_cbc_hmac_sha256
),
375 ALGC("AES-256-CBC-HMAC-SHA256", aes256cbc_hmac_sha256_functions
,
376 cipher_capable_aes_cbc_hmac_sha256
),
377 #ifndef OPENSSL_NO_DES
378 ALG("DES-EDE3-ECB:DES-EDE3", tdes_ede3_ecb_functions
),
379 ALG("DES-EDE3-CBC:DES3", tdes_ede3_cbc_functions
),
380 #endif /* OPENSSL_NO_DES */
381 { { NULL
, NULL
, NULL
}, NULL
}
383 static OSSL_ALGORITHM exported_fips_ciphers
[OSSL_NELEM(fips_ciphers
)];
385 static const OSSL_ALGORITHM fips_macs
[] = {
386 #ifndef OPENSSL_NO_CMAC
387 { "CMAC", FIPS_DEFAULT_PROPERTIES
, cmac_functions
},
389 { "GMAC", FIPS_DEFAULT_PROPERTIES
, gmac_functions
},
390 { "HMAC", FIPS_DEFAULT_PROPERTIES
, hmac_functions
},
391 { "KMAC-128:KMAC128", FIPS_DEFAULT_PROPERTIES
, kmac128_functions
},
392 { "KMAC-256:KMAC256", FIPS_DEFAULT_PROPERTIES
, kmac256_functions
},
396 static const OSSL_ALGORITHM fips_kdfs
[] = {
397 { "HKDF", FIPS_DEFAULT_PROPERTIES
, kdf_hkdf_functions
},
398 { "SSKDF", FIPS_DEFAULT_PROPERTIES
, kdf_sskdf_functions
},
399 { "PBKDF2", FIPS_DEFAULT_PROPERTIES
, kdf_pbkdf2_functions
},
400 { "SSHKDF", FIPS_DEFAULT_PROPERTIES
, kdf_sshkdf_functions
},
401 { "X963KDF", FIPS_DEFAULT_PROPERTIES
, kdf_x963_kdf_functions
},
402 { "TLS1-PRF", FIPS_DEFAULT_PROPERTIES
, kdf_tls1_prf_functions
},
403 { "KBKDF", FIPS_DEFAULT_PROPERTIES
, kdf_kbkdf_functions
},
407 static const OSSL_ALGORITHM fips_rands
[] = {
408 { "CTR-DRBG", FIPS_DEFAULT_PROPERTIES
, drbg_ctr_functions
},
409 { "HASH-DRBG", FIPS_DEFAULT_PROPERTIES
, drbg_hash_functions
},
410 { "HMAC-DRBG", FIPS_DEFAULT_PROPERTIES
, drbg_hmac_functions
},
411 { "TEST-RAND", FIPS_UNAPPROVED_PROPERTIES
, test_rng_functions
},
415 static const OSSL_ALGORITHM fips_keyexch
[] = {
416 #ifndef OPENSSL_NO_DH
417 { "DH:dhKeyAgreement", FIPS_DEFAULT_PROPERTIES
, dh_keyexch_functions
},
419 #ifndef OPENSSL_NO_EC
420 { "ECDH", FIPS_DEFAULT_PROPERTIES
, ecdh_keyexch_functions
},
421 { "X25519", FIPS_DEFAULT_PROPERTIES
, x25519_keyexch_functions
},
422 { "X448", FIPS_DEFAULT_PROPERTIES
, x448_keyexch_functions
},
424 { "TLS1-PRF", FIPS_DEFAULT_PROPERTIES
, kdf_tls1_prf_keyexch_functions
},
425 { "HKDF", FIPS_DEFAULT_PROPERTIES
, kdf_hkdf_keyexch_functions
},
429 static const OSSL_ALGORITHM fips_signature
[] = {
430 #ifndef OPENSSL_NO_DSA
431 { "DSA:dsaEncryption", FIPS_DEFAULT_PROPERTIES
, dsa_signature_functions
},
433 { "RSA:rsaEncryption", FIPS_DEFAULT_PROPERTIES
, rsa_signature_functions
},
434 #ifndef OPENSSL_NO_EC
435 { "ED25519", FIPS_DEFAULT_PROPERTIES
, ed25519_signature_functions
},
436 { "ED448", FIPS_DEFAULT_PROPERTIES
, ed448_signature_functions
},
437 { "ECDSA", FIPS_DEFAULT_PROPERTIES
, ecdsa_signature_functions
},
439 { "HMAC", FIPS_DEFAULT_PROPERTIES
, mac_hmac_signature_functions
},
443 static const OSSL_ALGORITHM fips_asym_cipher
[] = {
444 { "RSA:rsaEncryption", FIPS_DEFAULT_PROPERTIES
, rsa_asym_cipher_functions
},
448 static const OSSL_ALGORITHM fips_keymgmt
[] = {
449 #ifndef OPENSSL_NO_DH
450 { "DH:dhKeyAgreement", FIPS_DEFAULT_PROPERTIES
, dh_keymgmt_functions
},
451 { "DHX:X9.42 DH:dhpublicnumber", FIPS_DEFAULT_PROPERTIES
, dhx_keymgmt_functions
},
453 #ifndef OPENSSL_NO_DSA
454 { "DSA", FIPS_DEFAULT_PROPERTIES
, dsa_keymgmt_functions
},
456 { "RSA:rsaEncryption", FIPS_DEFAULT_PROPERTIES
, rsa_keymgmt_functions
},
457 { "RSA-PSS:RSASSA-PSS", FIPS_DEFAULT_PROPERTIES
,
458 rsapss_keymgmt_functions
},
459 #ifndef OPENSSL_NO_EC
460 { "EC:id-ecPublicKey", FIPS_DEFAULT_PROPERTIES
, ec_keymgmt_functions
},
461 { "X25519", FIPS_DEFAULT_PROPERTIES
, x25519_keymgmt_functions
},
462 { "X448", FIPS_DEFAULT_PROPERTIES
, x448_keymgmt_functions
},
463 { "ED25519", FIPS_DEFAULT_PROPERTIES
, ed25519_keymgmt_functions
},
464 { "ED448", FIPS_DEFAULT_PROPERTIES
, ed448_keymgmt_functions
},
466 { "TLS1-PRF", FIPS_DEFAULT_PROPERTIES
, kdf_keymgmt_functions
},
467 { "HKDF", FIPS_DEFAULT_PROPERTIES
, kdf_keymgmt_functions
},
468 { "HMAC", FIPS_DEFAULT_PROPERTIES
, mac_keymgmt_functions
},
472 static const OSSL_ALGORITHM
*fips_query(void *provctx
, int operation_id
,
477 if (!FIPS_is_running())
480 switch (operation_id
) {
484 ossl_prov_cache_exported_algorithms(fips_ciphers
, exported_fips_ciphers
);
485 return exported_fips_ciphers
;
492 case OSSL_OP_KEYMGMT
:
494 case OSSL_OP_KEYEXCH
:
496 case OSSL_OP_SIGNATURE
:
497 return fips_signature
;
498 case OSSL_OP_ASYM_CIPHER
:
499 return fips_asym_cipher
;
504 static void fips_teardown(void *provctx
)
506 OPENSSL_CTX_free(PROV_LIBRARY_CONTEXT_OF(provctx
));
507 PROV_CTX_free(provctx
);
510 static void fips_intern_teardown(void *provctx
)
513 * We know that the library context is the same as for the outer provider,
514 * so no need to destroy it here.
516 PROV_CTX_free(provctx
);
519 /* Functions we provide to the core */
520 static const OSSL_DISPATCH fips_dispatch_table
[] = {
521 { OSSL_FUNC_PROVIDER_TEARDOWN
, (void (*)(void))fips_teardown
},
522 { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS
, (void (*)(void))fips_gettable_params
},
523 { OSSL_FUNC_PROVIDER_GET_PARAMS
, (void (*)(void))fips_get_params
},
524 { OSSL_FUNC_PROVIDER_QUERY_OPERATION
, (void (*)(void))fips_query
},
525 { OSSL_FUNC_PROVIDER_GET_CAPABILITIES
,
526 (void (*)(void))provider_get_capabilities
},
527 { OSSL_FUNC_PROVIDER_SELF_TEST
, (void (*)(void))fips_self_test
},
531 /* Functions we provide to ourself */
532 static const OSSL_DISPATCH intern_dispatch_table
[] = {
533 { OSSL_FUNC_PROVIDER_TEARDOWN
, (void (*)(void))fips_intern_teardown
},
534 { OSSL_FUNC_PROVIDER_QUERY_OPERATION
, (void (*)(void))fips_query
},
538 int OSSL_provider_init(const OSSL_CORE_HANDLE
*handle
,
539 const OSSL_DISPATCH
*in
,
540 const OSSL_DISPATCH
**out
,
544 OPENSSL_CTX
*libctx
= NULL
;
546 for (; in
->function_id
!= 0; in
++) {
547 switch (in
->function_id
) {
548 case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT
:
549 c_get_libctx
= OSSL_FUNC_core_get_library_context(in
);
551 case OSSL_FUNC_CORE_GETTABLE_PARAMS
:
552 c_gettable_params
= OSSL_FUNC_core_gettable_params(in
);
554 case OSSL_FUNC_CORE_GET_PARAMS
:
555 c_get_params
= OSSL_FUNC_core_get_params(in
);
557 case OSSL_FUNC_CORE_THREAD_START
:
558 c_thread_start
= OSSL_FUNC_core_thread_start(in
);
560 case OSSL_FUNC_CORE_NEW_ERROR
:
561 c_new_error
= OSSL_FUNC_core_new_error(in
);
563 case OSSL_FUNC_CORE_SET_ERROR_DEBUG
:
564 c_set_error_debug
= OSSL_FUNC_core_set_error_debug(in
);
566 case OSSL_FUNC_CORE_VSET_ERROR
:
567 c_vset_error
= OSSL_FUNC_core_vset_error(in
);
569 case OSSL_FUNC_CORE_SET_ERROR_MARK
:
570 c_set_error_mark
= OSSL_FUNC_core_set_error_mark(in
);
572 case OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK
:
573 c_clear_last_error_mark
= OSSL_FUNC_core_clear_last_error_mark(in
);
575 case OSSL_FUNC_CORE_POP_ERROR_TO_MARK
:
576 c_pop_error_to_mark
= OSSL_FUNC_core_pop_error_to_mark(in
);
578 case OSSL_FUNC_CRYPTO_MALLOC
:
579 c_CRYPTO_malloc
= OSSL_FUNC_CRYPTO_malloc(in
);
581 case OSSL_FUNC_CRYPTO_ZALLOC
:
582 c_CRYPTO_zalloc
= OSSL_FUNC_CRYPTO_zalloc(in
);
584 case OSSL_FUNC_CRYPTO_FREE
:
585 c_CRYPTO_free
= OSSL_FUNC_CRYPTO_free(in
);
587 case OSSL_FUNC_CRYPTO_CLEAR_FREE
:
588 c_CRYPTO_clear_free
= OSSL_FUNC_CRYPTO_clear_free(in
);
590 case OSSL_FUNC_CRYPTO_REALLOC
:
591 c_CRYPTO_realloc
= OSSL_FUNC_CRYPTO_realloc(in
);
593 case OSSL_FUNC_CRYPTO_CLEAR_REALLOC
:
594 c_CRYPTO_clear_realloc
= OSSL_FUNC_CRYPTO_clear_realloc(in
);
596 case OSSL_FUNC_CRYPTO_SECURE_MALLOC
:
597 c_CRYPTO_secure_malloc
= OSSL_FUNC_CRYPTO_secure_malloc(in
);
599 case OSSL_FUNC_CRYPTO_SECURE_ZALLOC
:
600 c_CRYPTO_secure_zalloc
= OSSL_FUNC_CRYPTO_secure_zalloc(in
);
602 case OSSL_FUNC_CRYPTO_SECURE_FREE
:
603 c_CRYPTO_secure_free
= OSSL_FUNC_CRYPTO_secure_free(in
);
605 case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE
:
606 c_CRYPTO_secure_clear_free
= OSSL_FUNC_CRYPTO_secure_clear_free(in
);
608 case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED
:
609 c_CRYPTO_secure_allocated
= OSSL_FUNC_CRYPTO_secure_allocated(in
);
611 case OSSL_FUNC_BIO_NEW_FILE
:
612 selftest_params
.bio_new_file_cb
= OSSL_FUNC_BIO_new_file(in
);
614 case OSSL_FUNC_BIO_NEW_MEMBUF
:
615 selftest_params
.bio_new_buffer_cb
= OSSL_FUNC_BIO_new_membuf(in
);
617 case OSSL_FUNC_BIO_READ_EX
:
618 selftest_params
.bio_read_ex_cb
= OSSL_FUNC_BIO_read_ex(in
);
620 case OSSL_FUNC_BIO_FREE
:
621 selftest_params
.bio_free_cb
= OSSL_FUNC_BIO_free(in
);
623 case OSSL_FUNC_BIO_VSNPRINTF
:
624 c_BIO_vsnprintf
= OSSL_FUNC_BIO_vsnprintf(in
);
626 case OSSL_FUNC_SELF_TEST_CB
: {
627 c_stcbfn
= OSSL_FUNC_self_test_cb(in
);
631 /* Just ignore anything we don't understand */
636 set_self_test_cb(handle
);
638 if (!c_get_params(handle
, core_params
)) {
639 ERR_raise(ERR_LIB_PROV
, PROV_R_FAILED_TO_GET_PARAMETER
);
643 /* Create a context. */
644 if ((*provctx
= PROV_CTX_new()) == NULL
645 || (libctx
= OPENSSL_CTX_new()) == NULL
) {
647 * We free libctx separately here and only here because it hasn't
648 * been attached to *provctx. All other error paths below rely
649 * solely on fips_teardown.
651 OPENSSL_CTX_free(libctx
);
654 PROV_CTX_set0_library_context(*provctx
, libctx
);
655 PROV_CTX_set0_handle(*provctx
, handle
);
657 if ((fgbl
= openssl_ctx_get_data(libctx
, OPENSSL_CTX_FIPS_PROV_INDEX
,
658 &fips_prov_ossl_ctx_method
)) == NULL
)
661 fgbl
->handle
= handle
;
663 selftest_params
.libctx
= libctx
;
664 if (!SELF_TEST_post(&selftest_params
, 0)) {
665 ERR_raise(ERR_LIB_PROV
, PROV_R_SELF_TEST_POST_FAILURE
);
669 /* TODO(3.0): Tests will hang if this is removed */
670 (void)RAND_get0_public(libctx
);
672 *out
= fips_dispatch_table
;
675 fips_teardown(*provctx
);
681 * The internal init function used when the FIPS module uses EVP to call
682 * another algorithm also in the FIPS module. This is a recursive call that has
683 * been made from within the FIPS module itself. To make this work, we populate
684 * the provider context of this inner instance with the same library context
685 * that was used in the EVP call that initiated this recursive call.
687 OSSL_provider_init_fn fips_intern_provider_init
;
688 int fips_intern_provider_init(const OSSL_CORE_HANDLE
*handle
,
689 const OSSL_DISPATCH
*in
,
690 const OSSL_DISPATCH
**out
,
693 OSSL_FUNC_core_get_library_context_fn
*c_internal_get_libctx
= NULL
;
695 for (; in
->function_id
!= 0; in
++) {
696 switch (in
->function_id
) {
697 case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT
:
698 c_internal_get_libctx
= OSSL_FUNC_core_get_library_context(in
);
705 if (c_internal_get_libctx
== NULL
)
708 if ((*provctx
= PROV_CTX_new()) == NULL
)
712 * Using the parent library context only works because we are a built-in
713 * internal provider. This is not something that most providers would be
716 PROV_CTX_set0_library_context(*provctx
,
717 (OPENSSL_CTX
*)c_internal_get_libctx(handle
));
718 PROV_CTX_set0_handle(*provctx
, handle
);
720 *out
= intern_dispatch_table
;
729 void ERR_set_debug(const char *file
, int line
, const char *func
)
731 c_set_error_debug(NULL
, file
, line
, func
);
734 void ERR_set_error(int lib
, int reason
, const char *fmt
, ...)
739 c_vset_error(NULL
, ERR_PACK(lib
, 0, reason
), fmt
, args
);
743 void ERR_vset_error(int lib
, int reason
, const char *fmt
, va_list args
)
745 c_vset_error(NULL
, ERR_PACK(lib
, 0, reason
), fmt
, args
);
748 int ERR_set_mark(void)
750 return c_set_error_mark(NULL
);
753 int ERR_clear_last_mark(void)
755 return c_clear_last_error_mark(NULL
);
758 int ERR_pop_to_mark(void)
760 return c_pop_error_to_mark(NULL
);
764 * This must take a library context, since it's called from the depths
765 * of crypto/initthread.c code, where it's (correctly) assumed that the
766 * passed caller argument is an OPENSSL_CTX pointer (since the same routine
767 * is also called from other parts of libcrypto, which all pass around a
768 * OPENSSL_CTX pointer)
770 const OSSL_CORE_HANDLE
*FIPS_get_core_handle(OPENSSL_CTX
*libctx
)
772 FIPS_GLOBAL
*fgbl
= openssl_ctx_get_data(libctx
,
773 OPENSSL_CTX_FIPS_PROV_INDEX
,
774 &fips_prov_ossl_ctx_method
);
782 void *CRYPTO_malloc(size_t num
, const char *file
, int line
)
784 return c_CRYPTO_malloc(num
, file
, line
);
787 void *CRYPTO_zalloc(size_t num
, const char *file
, int line
)
789 return c_CRYPTO_zalloc(num
, file
, line
);
792 void CRYPTO_free(void *ptr
, const char *file
, int line
)
794 c_CRYPTO_free(ptr
, file
, line
);
797 void CRYPTO_clear_free(void *ptr
, size_t num
, const char *file
, int line
)
799 c_CRYPTO_clear_free(ptr
, num
, file
, line
);
802 void *CRYPTO_realloc(void *addr
, size_t num
, const char *file
, int line
)
804 return c_CRYPTO_realloc(addr
, num
, file
, line
);
807 void *CRYPTO_clear_realloc(void *addr
, size_t old_num
, size_t num
,
808 const char *file
, int line
)
810 return c_CRYPTO_clear_realloc(addr
, old_num
, num
, file
, line
);
813 void *CRYPTO_secure_malloc(size_t num
, const char *file
, int line
)
815 return c_CRYPTO_secure_malloc(num
, file
, line
);
818 void *CRYPTO_secure_zalloc(size_t num
, const char *file
, int line
)
820 return c_CRYPTO_secure_zalloc(num
, file
, line
);
823 void CRYPTO_secure_free(void *ptr
, const char *file
, int line
)
825 c_CRYPTO_secure_free(ptr
, file
, line
);
828 void CRYPTO_secure_clear_free(void *ptr
, size_t num
, const char *file
, int line
)
830 c_CRYPTO_secure_clear_free(ptr
, num
, file
, line
);
833 int CRYPTO_secure_allocated(const void *ptr
)
835 return c_CRYPTO_secure_allocated(ptr
);
838 int BIO_snprintf(char *buf
, size_t n
, const char *format
, ...)
843 va_start(args
, format
);
844 ret
= c_BIO_vsnprintf(buf
, n
, format
, args
);