2 * Copyright 2019 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
12 #include <openssl/core.h>
13 #include <openssl/core_numbers.h>
14 #include <openssl/core_names.h>
15 #include <openssl/params.h>
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18 #include <openssl/kdf.h>
20 /* TODO(3.0): Needed for dummy_evp_call(). To be removed */
21 #include <openssl/sha.h>
22 #include <openssl/rand_drbg.h>
23 #include <openssl/ec.h>
24 #include <openssl/fips_names.h>
26 #include "internal/cryptlib.h"
27 #include "internal/property.h"
28 #include "internal/nelem.h"
29 #include "internal/param_build.h"
30 #include "crypto/evp.h"
31 #include "prov/implementations.h"
32 #include "prov/provider_ctx.h"
33 #include "prov/providercommon.h"
34 #include "prov/provider_util.h"
35 #include "self_test.h"
37 #define ALGC(NAMES, FUNC, CHECK) { { NAMES, "provider=fips,fips=yes", FUNC }, CHECK }
38 #define ALG(NAMES, FUNC) ALGC(NAMES, FUNC, NULL)
40 extern OSSL_core_thread_start_fn *c_thread_start;
43 * TODO(3.0): Should these be stored in the provider side provctx? Could they
44 * ever be different from one init to the next? Unfortunately we can't do this
45 * at the moment because c_put_error/c_add_error_vdata do not provide
46 * us with the OPENSSL_CTX as a parameter.
49 static SELF_TEST_POST_PARAMS selftest_params;
51 /* Functions provided by the core */
52 static OSSL_core_gettable_params_fn *c_gettable_params;
53 static OSSL_core_get_params_fn *c_get_params;
54 OSSL_core_thread_start_fn *c_thread_start;
55 static OSSL_core_new_error_fn *c_new_error;
56 static OSSL_core_set_error_debug_fn *c_set_error_debug;
57 static OSSL_core_vset_error_fn *c_vset_error;
58 static OSSL_core_set_error_mark_fn *c_set_error_mark;
59 static OSSL_core_clear_last_error_mark_fn *c_clear_last_error_mark;
60 static OSSL_core_pop_error_to_mark_fn *c_pop_error_to_mark;
61 static OSSL_CRYPTO_malloc_fn *c_CRYPTO_malloc;
62 static OSSL_CRYPTO_zalloc_fn *c_CRYPTO_zalloc;
63 static OSSL_CRYPTO_free_fn *c_CRYPTO_free;
64 static OSSL_CRYPTO_clear_free_fn *c_CRYPTO_clear_free;
65 static OSSL_CRYPTO_realloc_fn *c_CRYPTO_realloc;
66 static OSSL_CRYPTO_clear_realloc_fn *c_CRYPTO_clear_realloc;
67 static OSSL_CRYPTO_secure_malloc_fn *c_CRYPTO_secure_malloc;
68 static OSSL_CRYPTO_secure_zalloc_fn *c_CRYPTO_secure_zalloc;
69 static OSSL_CRYPTO_secure_free_fn *c_CRYPTO_secure_free;
70 static OSSL_CRYPTO_secure_clear_free_fn *c_CRYPTO_secure_clear_free;
71 static OSSL_CRYPTO_secure_allocated_fn *c_CRYPTO_secure_allocated;
72 static OSSL_BIO_vsnprintf_fn *c_BIO_vsnprintf;
74 typedef struct fips_global_st {
75 const OSSL_PROVIDER *prov;
78 static void *fips_prov_ossl_ctx_new(OPENSSL_CTX *libctx)
80 FIPS_GLOBAL *fgbl = OPENSSL_zalloc(sizeof(*fgbl));
85 static void fips_prov_ossl_ctx_free(void *fgbl)
90 static const OPENSSL_CTX_METHOD fips_prov_ossl_ctx_method = {
91 fips_prov_ossl_ctx_new,
92 fips_prov_ossl_ctx_free,
96 /* Parameters we provide to the core */
97 static const OSSL_PARAM fips_param_types[] = {
98 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_NAME, OSSL_PARAM_UTF8_PTR, NULL, 0),
99 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_VERSION, OSSL_PARAM_UTF8_PTR, NULL, 0),
100 OSSL_PARAM_DEFN(OSSL_PROV_PARAM_BUILDINFO, OSSL_PARAM_UTF8_PTR, NULL, 0),
105 * Parameters to retrieve from the core provider - required for self testing.
106 * NOTE: inside core_get_params() these will be loaded from config items
107 * stored inside prov->parameters (except for OSSL_PROV_PARAM_MODULE_FILENAME).
109 static OSSL_PARAM core_params[] =
111 OSSL_PARAM_utf8_ptr(OSSL_PROV_PARAM_MODULE_FILENAME,
112 selftest_params.module_filename,
113 sizeof(selftest_params.module_filename)),
114 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_MODULE_MAC,
115 selftest_params.module_checksum_data,
116 sizeof(selftest_params.module_checksum_data)),
117 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_MAC,
118 selftest_params.indicator_checksum_data,
119 sizeof(selftest_params.indicator_checksum_data)),
120 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_STATUS,
121 selftest_params.indicator_data,
122 sizeof(selftest_params.indicator_data)),
123 OSSL_PARAM_utf8_ptr(OSSL_PROV_FIPS_PARAM_INSTALL_VERSION,
124 selftest_params.indicator_version,
125 sizeof(selftest_params.indicator_version)),
130 * Convert a string into a bignumber.
131 * The array of hex_data is used to get around compilers that dont like
132 * strings longer than 509 bytes,
134 #if !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_DSA)
135 static int hextobn(const char *hex_data[], BIGNUM **bn)
141 /* Get the total length of the strings */
142 for (slen = 0, i = 0; hex_data[i] != NULL; ++i)
143 slen += strlen(hex_data[i]);
145 /* Add 1 for the string terminator */
146 str = OPENSSL_zalloc(slen + 1);
150 /* join the strings together into 1 buffer */
151 for (i = 0; hex_data[i] != NULL; ++i)
152 strcat(str, hex_data[i]);
154 if (BN_hex2bn(bn, str) <= 0)
161 #endif /* !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_DSA) */
163 #ifndef OPENSSL_NO_DH
164 static int hextobin(const char *hex_data[], unsigned char **out, size_t *len)
168 unsigned char *buf = NULL;
170 if (!hextobn(hex_data, &bn))
172 sz = BN_num_bytes(bn);
173 buf = OPENSSL_zalloc(sz);
176 if (BN_bn2binpad(bn, buf, sz) <= 0)
181 buf = NULL; /* Set to NULL so it is not freed */
190 #ifndef OPENSSL_NO_DSA
191 static int dsa_key_signature_test(OPENSSL_CTX *libctx)
194 BIGNUM *p = NULL, *q = NULL, *g = NULL;
195 BIGNUM *pub = NULL, *priv = NULL;
196 OSSL_PARAM *params = NULL, *params_sig = NULL;
198 EVP_PKEY_CTX *sctx = NULL, *kctx = NULL;
199 EVP_PKEY *pkey = NULL;
200 unsigned char sig[64];
203 static const unsigned char dgst[SHA256_DIGEST_LENGTH] = {
204 0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
205 0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
206 0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
209 static const char *dsa_p_hex[] = {
210 "a29b8872ce8b8423b7d5d21d4b02f57e03e9e6b8a258dc16611ba098ab543415"
211 "e415f156997a3ee236658fa093260de3ad422e05e046f9ec29161a375f0eb4ef"
212 "fcef58285c5d39ed425d7a62ca12896c4a92cb1946f2952a48133f07da364d1b"
213 "df6b0f7139983e693c80059b0eacd1479ba9f2857754ede75f112b07ebbf3534",
214 "8bbf3e01e02f2d473de39453f99dd2367541caca3ba01166343d7b5b58a37bd1"
215 "b7521db2f13b86707132fe09f4cd09dc1618fa3401ebf9cc7b19fa94aa472088"
216 "133d6cb2d35c1179c8c8ff368758d507d9f9a17d46c110fe3144ce9b022b42e4"
217 "19eb4f5388613bfc3e26241a432e8706bc58ef76117278deab6cf692618291b7",
220 static const char *dsa_q_hex[] = {
221 "a3bfd9ab7884794e383450d5891dc18b65157bdcfcdac51518902867",
224 static const char *dsa_g_hex[] = {
225 "6819278869c7fd3d2d7b77f77e8150d9ad433bea3ba85efc80415aa3545f78f7"
226 "2296f06cb19ceda06c94b0551cfe6e6f863e31d1de6eed7dab8b0c9df231e084"
227 "34d1184f91d033696bb382f8455e9888f5d31d4784ec40120246f4bea61794bb"
228 "a5866f09746463bdf8e9e108cd9529c3d0f6df80316e2e70aaeb1b26cdb8ad97",
229 "bc3d287e0b8d616c42e65b87db20deb7005bc416747a6470147a68a7820388eb"
230 "f44d52e0628af9cf1b7166d03465f35acc31b6110c43dabc7c5d591e671eaf7c"
231 "252c1c145336a1a4ddf13244d55e835680cab2533b82df2efe55ec18c1e6cd00"
232 "7bb089758bb17c2cbe14441bd093ae66e5976d53733f4fa3269701d31d23d467",
235 static const char *dsa_pub_hex[] = {
236 "a012b3b170b307227957b7ca2061a816ac7a2b3d9ae995a5119c385b603bf6f6"
237 "c5de4dc5ecb5dfa4a41c68662eb25b638b7e2620ba898d07da6c4991e76cc0ec"
238 "d1ad3421077067e47c18f58a92a72ad43199ecb7bd84e7d3afb9019f0e9dd0fb"
239 "aa487300b13081e33c902876436f7b03c345528481d362815e24fe59dac5ac34",
240 "660d4c8a76cb99a7c7de93eb956cd6bc88e58d901034944a094b01803a43c672"
241 "b9688c0e01d8f4fc91c62a3f88021f7bd6a651b1a88f43aa4ef27653d12bf8b7"
242 "099fdf6b461082f8e939107bfd2f7210087d326c375200f1f51e7e74a3413190"
243 "1bcd0863521ff8d676c48581868736c5e51b16a4e39215ea0b17c4735974c516",
246 static const char *dsa_priv_hex[] = {
247 "6ccaeef6d73b4e80f11c17b8e9627c036635bac39423505e407e5cb7",
251 if (!hextobn(dsa_p_hex, &p)
252 || !hextobn(dsa_q_hex, &q)
253 || !hextobn(dsa_g_hex, &g)
254 || !hextobn(dsa_pub_hex, &pub)
255 || !hextobn(dsa_priv_hex, &priv))
258 ossl_param_bld_init(&bld);
259 if (!ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_P, p)
260 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_Q, q)
261 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_G, g)
262 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_PUB_KEY, pub)
263 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_PRIV_KEY, priv))
265 params = ossl_param_bld_to_param(&bld);
267 /* Create a EVP_PKEY_CTX to load the DSA key into */
268 kctx = EVP_PKEY_CTX_new_from_name(libctx, SN_dsa, "");
269 if (kctx == NULL || params == NULL)
271 if (EVP_PKEY_key_fromdata_init(kctx) <= 0
272 || EVP_PKEY_fromdata(kctx, &pkey, params) <= 0)
275 /* Create a EVP_PKEY_CTX to use for the signing operation */
276 sctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, NULL);
278 || EVP_PKEY_sign_init(sctx) <= 0)
281 /* set signature parameters */
282 ossl_param_bld_init(&bld);
283 if (!ossl_param_bld_push_utf8_string(&bld, OSSL_SIGNATURE_PARAM_DIGEST,
284 SN_sha256,strlen(SN_sha256) + 1))
286 params_sig = ossl_param_bld_to_param(&bld);
287 if (EVP_PKEY_CTX_set_params(sctx, params_sig) <= 0)
290 if (EVP_PKEY_sign(sctx, sig, &siglen, dgst, sizeof(dgst)) <= 0
291 || EVP_PKEY_verify_init(sctx) <= 0
292 || EVP_PKEY_verify(sctx, sig, siglen, dgst, sizeof(dgst)) <= 0)
296 ossl_param_bld_free(params);
297 ossl_param_bld_free(params_sig);
304 EVP_PKEY_CTX_free(kctx);
305 EVP_PKEY_CTX_free(sctx);
308 #endif /* OPENSSL_NO_DSA */
310 #ifndef OPENSSL_NO_DH
311 static int dh_key_exchange_test(OPENSSL_CTX *libctx)
314 BIGNUM *p = NULL, *q = NULL, *g = NULL;
315 BIGNUM *pub = NULL, *priv = NULL, *pub_peer = NULL;
316 unsigned char *kat_secret = NULL;
317 EVP_PKEY_CTX *kactx = NULL, *dctx = NULL;
318 EVP_PKEY *pkey = NULL, *peerkey = NULL;
319 OSSL_PARAM *params = NULL;
320 OSSL_PARAM *params_peer = NULL;
321 unsigned char secret[256];
322 size_t secret_len, kat_secret_len = 0;
326 static const char *dh_p_hex[] = {
327 "dcca1511b2313225f52116e1542789e001f0425bccc7f366f7406407f1c9fa8b"
328 "e610f1778bb170be39dbb76f85bf24ce6880adb7629f7c6d015e61d43fa3ee4d"
329 "e185f2cfd041ffde9d418407e15138bb021daeb35f762d1782acc658d32bd4b0"
330 "232c927dd38fa097b3d1859fa8acafb98f066608fc644ec7ddb6f08599f92ac1",
331 "b59825da8432077def695646063c20823c9507ab6f0176d4730d990dbbe6361c"
332 "d8b2b94d3d2f329b82099bd661f42950f403df3ede62a33188b02798ba823f44"
333 "b946fe9df677a0c5a1238eaa97b70f80da8cac88e092b1127060ffbf45579994"
334 "011dc2faa5e7f6c76245e1cc312231c17d1ca6b19007ef0db99f9cb60e1d5f69",
337 static const char *dh_q_hex[] = {
338 "898b226717ef039e603e82e5c7afe48374ac5f625c54f1ea11acb57d",
341 static const char *dh_g_hex[] = {
342 "5ef7b88f2df60139351dfbfe1266805fdf356cdfd13a4da0050c7ede"
343 "246df59f6abf96ade5f2b28ffe88d6bce7f7894a3d535fc82126ddd4"
344 "24872e16b838df8c51e9016f889c7c203e98a8b631f9c72563d38a49"
345 "589a0753d358e783318cefd9677c7b2dbb77d6dce2a1963795ca64b9",
346 "2d1c9aac6d0e8d431de5e50060dff78689c9eca1c1248c16ed09c7ad",
347 "412a17406d2b525aa1cabb237b9734ec7b8ce3fae02f29c5efed30d6"
348 "9187da109c2c9fe2aadbb0c22af54c616655000c431c6b4a379763b0"
349 "a91658efc84e8b06358c8b4f213710fd10172cf39b830c2dd84a0c8a"
350 "b82516ecab995fa4215e023e4ecf8074c39d6c88b70d1ee4e96fdc20",
354 static const char *dh_priv_hex[] = {
355 "1433e0b5a917b60a3023f2f8aa2c2d70d2968aba9aeac81540b8fce6",
358 static const char *dh_pub_hex[] = {
359 "95dd338d29e5710492b918317b72a36936e1951a2ee5a5591699c048"
360 "6d0d4f9bdd6d5a3f6b98890c62b37652d36e712111e68a7355372506"
361 "99efe330537391fbc2c548bc5ac3e5b23386c3eef5eb43c099d70a52"
362 "02687e83964248fca91f40908e8fb3319315f6d2606d7f7cd52cc6e7",
363 "c5843afb22519cf0f0f9d3a0a4e8c88899efede7364351fb6a363ee7"
364 "17e5445adab4c931a6483997b87dad83677e4d1d3a7775e0f6d00fdf"
365 "73c7ad801e665a0e5a796d0a0380a19fa182efc8a04f5e4db90d1a86"
366 "37f95db16436bdc8f3fc096c4ff7f234be8fef479ac4b0dc4b77263e",
367 "07d9959de0f1bf3f0ae3d9d50e4b89c99e3ea1217343dd8c6581acc4"
371 static const char *dh_peer_pub_hex[] = {
372 "1fc1da341d1a846a96b7be24340f877dd010aa0356d5ad58aae9c7b0"
373 "8f749a32235110b5d88eb5dbfa978d27ecc530f02d3114005b64b1c0"
374 "e024cb8ae21698bca9e60d42808622f181c56e1de7a96e6efee9d665"
375 "67e91b977042c7e3d0448f05fb77f522b9bfc8d33cc3c31ed3b31f0f",
376 "ecb6db4f6ea311e77afdbcd47aee1bb150f216873578fb96468e8f9f"
377 "3de8efbfce75624b1df05322a34f1463e839e8984c4ad0a96e1ac842"
378 "e5318cc23c062a8ca171b8d575980dde7fc56f1536523820d43192bf"
379 "d51e8e228978aca5b94472f339caeb9931b42be301268bc99789c9b2",
380 "5571c3c0e4cb3f007f1a511cbb53c8519cdd1302abca6c0f34f96739"
384 static const char *dh_secret_exptd_hex[] = {
385 "08ff33bb2ecff49a7d4a7912aeb1bb6ab511641b4a76770c8cc1bcc2"
386 "33343dfe700d11813d2c9ed23b211ca9e8786921edca283c68b16153"
387 "fa01e91ab82c90ddab4a95816770a98710e14c92ab83b6e46e1e426e"
388 "e852430d6187daa3720a6bcd73235c6b0f941f3364f50420551a4bfe",
389 "afe2bc438505a59a4a40daca7a895a73db575c74c13a23ad8832957d"
390 "582d38f0a6165fb0d7e9b8799e42fd3220e332e98185a0c9429757b2"
391 "d0d02c17dbaa1ff6ed93d7e73e241eaed90caf394d2bc6570f18c81f"
392 "2be5d01a2ca99ff142b5d963f9f500325e7556f95849b3ffc7479486",
393 "be1d4596a3106bd5cb4f61c57ec5f100fb7a0c82a10b82526a97d1d9"
398 if (!hextobn(dh_p_hex, &p)
399 || !hextobn(dh_q_hex, &q)
400 || !hextobn(dh_g_hex, &g)
401 || !hextobn(dh_pub_hex, &pub)
402 || !hextobn(dh_priv_hex, &priv)
403 || !hextobn(dh_peer_pub_hex, &pub_peer)
404 || !hextobin(dh_secret_exptd_hex, &kat_secret, &kat_secret_len))
407 ossl_param_bld_init(&bld);
408 if (!ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_P, p)
409 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_Q, q)
410 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_G, g)
411 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_PUB_KEY, pub)
412 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_PRIV_KEY, priv))
414 params = ossl_param_bld_to_param(&bld);
416 ossl_param_bld_init(&bld);
417 if (!ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_P, p)
418 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_Q, q)
419 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_FFC_G, g)
420 || !ossl_param_bld_push_BN(&bld, OSSL_PKEY_PARAM_PUB_KEY, pub_peer))
423 params_peer = ossl_param_bld_to_param(&bld);
424 if (params == NULL || params_peer == NULL)
427 /* Create a EVP_PKEY_CTX to load the DH keys into */
428 kactx = EVP_PKEY_CTX_new_from_name(libctx, "DH", "");
431 if (EVP_PKEY_key_fromdata_init(kactx) <= 0
432 || EVP_PKEY_fromdata(kactx, &pkey, params) <= 0)
434 if (EVP_PKEY_key_fromdata_init(kactx) <= 0
435 || EVP_PKEY_fromdata(kactx, &peerkey, params_peer) <= 0)
438 /* Create a EVP_PKEY_CTX to perform key derivation */
439 dctx = EVP_PKEY_CTX_new_from_pkey(libctx, pkey, NULL);
443 if (EVP_PKEY_derive_init(dctx) <= 0
444 || EVP_PKEY_derive_set_peer(dctx, peerkey) <= 0
445 || EVP_PKEY_derive(dctx, secret, &secret_len) <= 0)
448 if (secret_len != kat_secret_len
449 || memcmp(secret, kat_secret, secret_len) != 0)
453 ossl_param_bld_free(params_peer);
454 ossl_param_bld_free(params);
461 OPENSSL_free(kat_secret);
463 EVP_PKEY_free(peerkey);
464 EVP_PKEY_CTX_free(kactx);
465 EVP_PKEY_CTX_free(dctx);
468 #endif /* OPENSSL_NO_DH */
470 /* TODO(3.0): To be removed */
471 static int dummy_evp_call(void *provctx)
473 OPENSSL_CTX *libctx = PROV_LIBRARY_CONTEXT_OF(provctx);
474 EVP_MD_CTX *ctx = EVP_MD_CTX_new();
475 EVP_MD *sha256 = EVP_MD_fetch(libctx, "SHA256", NULL);
476 EVP_KDF *kdf = EVP_KDF_fetch(libctx, OSSL_KDF_NAME_PBKDF2, NULL);
477 unsigned char dgst[SHA256_DIGEST_LENGTH];
478 unsigned int dgstlen;
480 BN_CTX *bnctx = NULL;
481 BIGNUM *a = NULL, *b = NULL;
482 unsigned char randbuf[128];
483 RAND_DRBG *drbg = OPENSSL_CTX_get0_public_drbg(libctx);
484 #ifndef OPENSSL_NO_EC
488 static const char msg[] = "Hello World!";
489 static const unsigned char exptd[] = {
490 0x7f, 0x83, 0xb1, 0x65, 0x7f, 0xf1, 0xfc, 0x53, 0xb9, 0x2d, 0xc1, 0x81,
491 0x48, 0xa1, 0xd6, 0x5d, 0xfc, 0x2d, 0x4b, 0x1f, 0xa3, 0xd6, 0x77, 0x28,
492 0x4a, 0xdd, 0xd2, 0x00, 0x12, 0x6d, 0x90, 0x69
495 if (ctx == NULL || sha256 == NULL || drbg == NULL || kdf == NULL)
498 if (!EVP_DigestInit_ex(ctx, sha256, NULL))
500 if (!EVP_DigestUpdate(ctx, msg, sizeof(msg) - 1))
502 if (!EVP_DigestFinal(ctx, dgst, &dgstlen))
504 if (dgstlen != sizeof(exptd) || memcmp(dgst, exptd, sizeof(exptd)) != 0)
507 bnctx = BN_CTX_new_ex(libctx);
511 a = BN_CTX_get(bnctx);
512 b = BN_CTX_get(bnctx);
518 || BN_cmp(a, b) != 0)
521 if (RAND_DRBG_bytes(drbg, randbuf, sizeof(randbuf)) <= 0)
524 if (!BN_rand_ex(a, 256, BN_RAND_TOP_ANY, BN_RAND_BOTTOM_ANY, bnctx))
527 #ifndef OPENSSL_NO_EC
528 /* Do some dummy EC calls */
529 key = EC_KEY_new_by_curve_name_ex(libctx, NID_X9_62_prime256v1);
533 if (!EC_KEY_generate_key(key))
537 #ifndef OPENSSL_NO_DSA
538 if (!dsa_key_signature_test(libctx))
542 #ifndef OPENSSL_NO_DH
543 if (!dh_key_exchange_test(libctx))
545 #endif /* OPENSSL_NO_DH */
553 EVP_MD_CTX_free(ctx);
556 #ifndef OPENSSL_NO_EC
562 static const OSSL_PARAM *fips_gettable_params(const OSSL_PROVIDER *prov)
564 return fips_param_types;
567 static int fips_get_params(const OSSL_PROVIDER *prov, OSSL_PARAM params[])
571 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_NAME);
572 if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, "OpenSSL FIPS Provider"))
574 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_VERSION);
575 if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_VERSION_STR))
577 p = OSSL_PARAM_locate(params, OSSL_PROV_PARAM_BUILDINFO);
578 if (p != NULL && !OSSL_PARAM_set_utf8_ptr(p, OPENSSL_FULL_VERSION_STR))
584 /* FIPS specific version of the function of the same name in provlib.c */
585 const char *ossl_prov_util_nid_to_name(int nid)
587 /* We don't have OBJ_nid2n() in FIPS_MODE so we have an explicit list */
602 return "SHA-512/224";
604 return "SHA-512/256";
615 case NID_aes_256_ecb:
616 return "AES-256-ECB";
617 case NID_aes_192_ecb:
618 return "AES-192-ECB";
619 case NID_aes_128_ecb:
620 return "AES-128-ECB";
621 case NID_aes_256_cbc:
622 return "AES-256-CBC";
623 case NID_aes_192_cbc:
624 return "AES-192-CBC";
625 case NID_aes_128_cbc:
626 return "AES-128-CBC";
627 case NID_aes_256_ctr:
628 return "AES-256-CTR";
629 case NID_aes_192_ctr:
630 return "AES-192-CTR";
631 case NID_aes_128_ctr:
632 return "AES-128-CTR";
633 case NID_aes_256_xts:
634 return "AES-256-XTS";
635 case NID_aes_128_xts:
636 return "AES-128-XTS";
637 case NID_aes_256_gcm:
638 return "AES-256-GCM";
639 case NID_aes_192_gcm:
640 return "AES-192-GCM";
641 case NID_aes_128_gcm:
642 return "AES-128-GCM";
643 case NID_aes_256_ccm:
644 return "AES-256-CCM";
645 case NID_aes_192_ccm:
646 return "AES-192-CCM";
647 case NID_aes_128_ccm:
648 return "AES-128-CCM";
649 case NID_id_aes256_wrap:
650 return "AES-256-WRAP";
651 case NID_id_aes192_wrap:
652 return "AES-192-WRAP";
653 case NID_id_aes128_wrap:
654 return "AES-128-WRAP";
655 case NID_id_aes256_wrap_pad:
656 return "AES-256-WRAP-PAD";
657 case NID_id_aes192_wrap_pad:
658 return "AES-192-WRAP-PAD";
659 case NID_id_aes128_wrap_pad:
660 return "AES-128-WRAP-PAD";
661 case NID_des_ede3_ecb:
663 case NID_des_ede3_cbc:
664 return "DES-EDE3-CBC";
665 case NID_aes_256_cbc_hmac_sha256:
666 return "AES-256-CBC-HMAC-SHA256";
667 case NID_aes_128_cbc_hmac_sha256:
668 return "AES-128-CBC-HMAC-SHA256";
669 case NID_aes_256_cbc_hmac_sha1:
670 return "AES-256-CBC-HMAC-SHA1";
671 case NID_aes_128_cbc_hmac_sha1:
672 return "AES-128-CBC-HMAC-SHA1";
681 * For the algorithm names, we use the following formula for our primary
684 * ALGNAME[VERSION?][-SUBNAME[VERSION?]?][-SIZE?][-MODE?]
686 * VERSION is only present if there are multiple versions of
687 * an alg (MD2, MD4, MD5). It may be omitted if there is only
688 * one version (if a subsequent version is released in the future,
689 * we can always change the canonical name, and add the old name
692 * SUBNAME may be present where we are combining multiple
693 * algorithms together, e.g. MD5-SHA1.
695 * SIZE is only present if multiple versions of an algorithm exist
696 * with different sizes (e.g. AES-128-CBC, AES-256-CBC)
698 * MODE is only present where applicable.
700 * We add diverse other names where applicable, such as the names that
701 * NIST uses, or that are used for ASN.1 OBJECT IDENTIFIERs, or names
702 * we have used historically.
704 static const OSSL_ALGORITHM fips_digests[] = {
705 /* Our primary name:NiST name[:our older names] */
706 { "SHA1:SHA-1", "provider=fips,fips=yes", sha1_functions },
707 { "SHA2-224:SHA-224:SHA224", "provider=fips,fips=yes", sha224_functions },
708 { "SHA2-256:SHA-256:SHA256", "provider=fips,fips=yes", sha256_functions },
709 { "SHA2-384:SHA-384:SHA384", "provider=fips,fips=yes", sha384_functions },
710 { "SHA2-512:SHA-512:SHA512", "provider=fips,fips=yes", sha512_functions },
711 { "SHA2-512/224:SHA-512/224:SHA512-224", "provider=fips,fips=yes",
712 sha512_224_functions },
713 { "SHA2-512/256:SHA-512/256:SHA512-256", "provider=fips,fips=yes",
714 sha512_256_functions },
716 /* We agree with NIST here, so one name only */
717 { "SHA3-224", "provider=fips,fips=yes", sha3_224_functions },
718 { "SHA3-256", "provider=fips,fips=yes", sha3_256_functions },
719 { "SHA3-384", "provider=fips,fips=yes", sha3_384_functions },
720 { "SHA3-512", "provider=fips,fips=yes", sha3_512_functions },
722 * KECCAK-KMAC-128 and KECCAK-KMAC-256 as hashes are mostly useful for
723 * KMAC128 and KMAC256.
725 { "KECCAK-KMAC-128:KECCAK-KMAC128", "provider=fips,fips=yes", keccak_kmac_128_functions },
726 { "KECCAK-KMAC-256:KECCAK-KMAC256", "provider=fips,fips=yes", keccak_kmac_256_functions },
731 static const OSSL_ALGORITHM_CAPABLE fips_ciphers[] = {
732 /* Our primary name[:ASN.1 OID name][:our older names] */
733 ALG("AES-256-ECB", aes256ecb_functions),
734 ALG("AES-192-ECB", aes192ecb_functions),
735 ALG("AES-128-ECB", aes128ecb_functions),
736 ALG("AES-256-CBC", aes256cbc_functions),
737 ALG("AES-192-CBC", aes192cbc_functions),
738 ALG("AES-128-CBC", aes128cbc_functions),
739 ALG("AES-256-CTR", aes256ctr_functions),
740 ALG("AES-192-CTR", aes192ctr_functions),
741 ALG("AES-128-CTR", aes128ctr_functions),
742 ALG("AES-256-XTS", aes256xts_functions),
743 ALG("AES-128-XTS", aes128xts_functions),
744 ALG("AES-256-GCM:id-aes256-GCM", aes256gcm_functions),
745 ALG("AES-192-GCM:id-aes192-GCM", aes192gcm_functions),
746 ALG("AES-128-GCM:id-aes128-GCM", aes128gcm_functions),
747 ALG("AES-256-CCM:id-aes256-CCM", aes256ccm_functions),
748 ALG("AES-192-CCM:id-aes192-CCM", aes192ccm_functions),
749 ALG("AES-128-CCM:id-aes128-CCM", aes128ccm_functions),
750 ALG("AES-256-WRAP:id-aes256-wrap:AES256-WRAP", aes256wrap_functions),
751 ALG("AES-192-WRAP:id-aes192-wrap:AES192-WRAP", aes192wrap_functions),
752 ALG("AES-128-WRAP:id-aes128-wrap:AES128-WRAP", aes128wrap_functions),
753 ALG("AES-256-WRAP-PAD:id-aes256-wrap-pad:AES256-WRAP-PAD",
754 aes256wrappad_functions),
755 ALG("AES-192-WRAP-PAD:id-aes192-wrap-pad:AES192-WRAP-PAD",
756 aes192wrappad_functions),
757 ALG("AES-128-WRAP-PAD:id-aes128-wrap-pad:AES128-WRAP-PAD",
758 aes128wrappad_functions),
759 ALGC("AES-128-CBC-HMAC-SHA1", aes128cbc_hmac_sha1_functions,
760 cipher_capable_aes_cbc_hmac_sha1),
761 ALGC("AES-256-CBC-HMAC-SHA1", aes256cbc_hmac_sha1_functions,
762 cipher_capable_aes_cbc_hmac_sha1),
763 ALGC("AES-128-CBC-HMAC-SHA256", aes128cbc_hmac_sha256_functions,
764 cipher_capable_aes_cbc_hmac_sha256),
765 ALGC("AES-256-CBC-HMAC-SHA256", aes256cbc_hmac_sha256_functions,
766 cipher_capable_aes_cbc_hmac_sha256),
767 #ifndef OPENSSL_NO_DES
768 ALG("DES-EDE3-ECB:DES-EDE3", tdes_ede3_ecb_functions),
769 ALG("DES-EDE3-CBC:DES3", tdes_ede3_cbc_functions),
770 #endif /* OPENSSL_NO_DES */
771 { { NULL, NULL, NULL }, NULL }
773 static OSSL_ALGORITHM exported_fips_ciphers[OSSL_NELEM(fips_ciphers)];
775 static const OSSL_ALGORITHM fips_macs[] = {
776 #ifndef OPENSSL_NO_CMAC
777 { "CMAC", "provider=fips,fips=yes", cmac_functions },
779 { "GMAC", "provider=fips,fips=yes", gmac_functions },
780 { "HMAC", "provider=fips,fips=yes", hmac_functions },
781 { "KMAC-128:KMAC128", "provider=fips,fips=yes", kmac128_functions },
782 { "KMAC-256:KMAC256", "provider=fips,fips=yes", kmac256_functions },
786 static const OSSL_ALGORITHM fips_kdfs[] = {
787 { "HKDF", "provider=fips,fips=yes", kdf_hkdf_functions },
788 { "SSKDF", "provider=fips,fips=yes", kdf_sskdf_functions },
789 { "PBKDF2", "provider=fips,fips=yes", kdf_pbkdf2_functions },
790 { "TLS1-PRF", "provider=fips,fips=yes", kdf_tls1_prf_functions },
791 { "KBKDF", "provider=fips,fips=yes", kdf_kbkdf_functions },
795 static const OSSL_ALGORITHM fips_keyexch[] = {
796 #ifndef OPENSSL_NO_DH
797 { "DH:dhKeyAgreement", "provider=fips,fips=yes", dh_keyexch_functions },
799 #ifndef OPENSSL_NO_EC
800 { "ECDH:id-ecPublicKey", "provider=fips,fips=yes", ecdh_keyexch_functions },
805 static const OSSL_ALGORITHM fips_signature[] = {
806 #ifndef OPENSSL_NO_DSA
807 { "DSA:dsaEncryption", "provider=fips,fips=yes", dsa_signature_functions },
809 { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_signature_functions },
813 static const OSSL_ALGORITHM fips_asym_cipher[] = {
814 { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_asym_cipher_functions },
818 static const OSSL_ALGORITHM fips_keymgmt[] = {
819 #ifndef OPENSSL_NO_DH
820 { "DH:dhKeyAgreement", "provider=fips,fips=yes", dh_keymgmt_functions },
822 #ifndef OPENSSL_NO_DSA
823 { "DSA", "provider=fips,fips=yes", dsa_keymgmt_functions },
825 { "RSA:rsaEncryption", "provider=fips,fips=yes", rsa_keymgmt_functions },
826 #ifndef OPENSSL_NO_EC
827 { "EC:id-ecPublicKey", "provider=fips,fips=yes", ec_keymgmt_functions },
832 static const OSSL_ALGORITHM *fips_query(OSSL_PROVIDER *prov,
837 switch (operation_id) {
841 ossl_prov_cache_exported_algorithms(fips_ciphers, exported_fips_ciphers);
842 return exported_fips_ciphers;
847 case OSSL_OP_KEYMGMT:
849 case OSSL_OP_KEYEXCH:
851 case OSSL_OP_SIGNATURE:
852 return fips_signature;
853 case OSSL_OP_ASYM_CIPHER:
854 return fips_asym_cipher;
859 /* Functions we provide to the core */
860 static const OSSL_DISPATCH fips_dispatch_table[] = {
862 * To release our resources we just need to free the OPENSSL_CTX so we just
863 * use OPENSSL_CTX_free directly as our teardown function
865 { OSSL_FUNC_PROVIDER_TEARDOWN, (void (*)(void))OPENSSL_CTX_free },
866 { OSSL_FUNC_PROVIDER_GETTABLE_PARAMS, (void (*)(void))fips_gettable_params },
867 { OSSL_FUNC_PROVIDER_GET_PARAMS, (void (*)(void))fips_get_params },
868 { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
872 /* Functions we provide to ourself */
873 static const OSSL_DISPATCH intern_dispatch_table[] = {
874 { OSSL_FUNC_PROVIDER_QUERY_OPERATION, (void (*)(void))fips_query },
879 int OSSL_provider_init(const OSSL_PROVIDER *provider,
880 const OSSL_DISPATCH *in,
881 const OSSL_DISPATCH **out,
886 OSSL_self_test_cb_fn *stcbfn = NULL;
887 OSSL_core_get_library_context_fn *c_get_libctx = NULL;
889 for (; in->function_id != 0; in++) {
890 switch (in->function_id) {
891 case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
892 c_get_libctx = OSSL_get_core_get_library_context(in);
894 case OSSL_FUNC_CORE_GETTABLE_PARAMS:
895 c_gettable_params = OSSL_get_core_gettable_params(in);
897 case OSSL_FUNC_CORE_GET_PARAMS:
898 c_get_params = OSSL_get_core_get_params(in);
900 case OSSL_FUNC_CORE_THREAD_START:
901 c_thread_start = OSSL_get_core_thread_start(in);
903 case OSSL_FUNC_CORE_NEW_ERROR:
904 c_new_error = OSSL_get_core_new_error(in);
906 case OSSL_FUNC_CORE_SET_ERROR_DEBUG:
907 c_set_error_debug = OSSL_get_core_set_error_debug(in);
909 case OSSL_FUNC_CORE_VSET_ERROR:
910 c_vset_error = OSSL_get_core_vset_error(in);
912 case OSSL_FUNC_CORE_SET_ERROR_MARK:
913 c_set_error_mark = OSSL_get_core_set_error_mark(in);
915 case OSSL_FUNC_CORE_CLEAR_LAST_ERROR_MARK:
916 c_clear_last_error_mark = OSSL_get_core_clear_last_error_mark(in);
918 case OSSL_FUNC_CORE_POP_ERROR_TO_MARK:
919 c_pop_error_to_mark = OSSL_get_core_pop_error_to_mark(in);
921 case OSSL_FUNC_CRYPTO_MALLOC:
922 c_CRYPTO_malloc = OSSL_get_CRYPTO_malloc(in);
924 case OSSL_FUNC_CRYPTO_ZALLOC:
925 c_CRYPTO_zalloc = OSSL_get_CRYPTO_zalloc(in);
927 case OSSL_FUNC_CRYPTO_FREE:
928 c_CRYPTO_free = OSSL_get_CRYPTO_free(in);
930 case OSSL_FUNC_CRYPTO_CLEAR_FREE:
931 c_CRYPTO_clear_free = OSSL_get_CRYPTO_clear_free(in);
933 case OSSL_FUNC_CRYPTO_REALLOC:
934 c_CRYPTO_realloc = OSSL_get_CRYPTO_realloc(in);
936 case OSSL_FUNC_CRYPTO_CLEAR_REALLOC:
937 c_CRYPTO_clear_realloc = OSSL_get_CRYPTO_clear_realloc(in);
939 case OSSL_FUNC_CRYPTO_SECURE_MALLOC:
940 c_CRYPTO_secure_malloc = OSSL_get_CRYPTO_secure_malloc(in);
942 case OSSL_FUNC_CRYPTO_SECURE_ZALLOC:
943 c_CRYPTO_secure_zalloc = OSSL_get_CRYPTO_secure_zalloc(in);
945 case OSSL_FUNC_CRYPTO_SECURE_FREE:
946 c_CRYPTO_secure_free = OSSL_get_CRYPTO_secure_free(in);
948 case OSSL_FUNC_CRYPTO_SECURE_CLEAR_FREE:
949 c_CRYPTO_secure_clear_free = OSSL_get_CRYPTO_secure_clear_free(in);
951 case OSSL_FUNC_CRYPTO_SECURE_ALLOCATED:
952 c_CRYPTO_secure_allocated = OSSL_get_CRYPTO_secure_allocated(in);
954 case OSSL_FUNC_BIO_NEW_FILE:
955 selftest_params.bio_new_file_cb = OSSL_get_BIO_new_file(in);
957 case OSSL_FUNC_BIO_NEW_MEMBUF:
958 selftest_params.bio_new_buffer_cb = OSSL_get_BIO_new_membuf(in);
960 case OSSL_FUNC_BIO_READ_EX:
961 selftest_params.bio_read_ex_cb = OSSL_get_BIO_read_ex(in);
963 case OSSL_FUNC_BIO_FREE:
964 selftest_params.bio_free_cb = OSSL_get_BIO_free(in);
966 case OSSL_FUNC_BIO_VSNPRINTF:
967 c_BIO_vsnprintf = OSSL_get_BIO_vsnprintf(in);
969 case OSSL_FUNC_SELF_TEST_CB: {
970 stcbfn = OSSL_get_self_test_cb(in);
974 /* Just ignore anything we don't understand */
979 if (stcbfn != NULL && c_get_libctx != NULL) {
980 stcbfn(c_get_libctx(provider), &selftest_params.cb,
981 &selftest_params.cb_arg);
984 selftest_params.cb = NULL;
985 selftest_params.cb_arg = NULL;
988 if (!c_get_params(provider, core_params))
991 /* Create a context. */
992 if ((ctx = OPENSSL_CTX_new()) == NULL)
994 if ((fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
995 &fips_prov_ossl_ctx_method)) == NULL) {
996 OPENSSL_CTX_free(ctx);
1000 fgbl->prov = provider;
1002 selftest_params.libctx = PROV_LIBRARY_CONTEXT_OF(ctx);
1003 if (!SELF_TEST_post(&selftest_params, 0)) {
1004 OPENSSL_CTX_free(ctx);
1009 * TODO(3.0): Remove me. This is just a dummy call to demonstrate making
1010 * EVP calls from within the FIPS module.
1012 if (!dummy_evp_call(ctx)) {
1013 OPENSSL_CTX_free(ctx);
1017 *out = fips_dispatch_table;
1024 * The internal init function used when the FIPS module uses EVP to call
1025 * another algorithm also in the FIPS module. This is a recursive call that has
1026 * been made from within the FIPS module itself. To make this work, we populate
1027 * the provider context of this inner instance with the same library context
1028 * that was used in the EVP call that initiated this recursive call.
1030 OSSL_provider_init_fn fips_intern_provider_init;
1031 int fips_intern_provider_init(const OSSL_PROVIDER *provider,
1032 const OSSL_DISPATCH *in,
1033 const OSSL_DISPATCH **out,
1036 OSSL_core_get_library_context_fn *c_get_libctx = NULL;
1038 for (; in->function_id != 0; in++) {
1039 switch (in->function_id) {
1040 case OSSL_FUNC_CORE_GET_LIBRARY_CONTEXT:
1041 c_get_libctx = OSSL_get_core_get_library_context(in);
1048 if (c_get_libctx == NULL)
1051 *provctx = c_get_libctx(provider);
1054 * Safety measure... we should get the library context that was
1055 * created up in OSSL_provider_init().
1057 if (*provctx == NULL)
1060 *out = intern_dispatch_table;
1069 void ERR_set_debug(const char *file, int line, const char *func)
1071 c_set_error_debug(NULL, file, line, func);
1074 void ERR_set_error(int lib, int reason, const char *fmt, ...)
1078 va_start(args, fmt);
1079 c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
1083 void ERR_vset_error(int lib, int reason, const char *fmt, va_list args)
1085 c_vset_error(NULL, ERR_PACK(lib, 0, reason), fmt, args);
1088 int ERR_set_mark(void)
1090 return c_set_error_mark(NULL);
1093 int ERR_clear_last_mark(void)
1095 return c_clear_last_error_mark(NULL);
1098 int ERR_pop_to_mark(void)
1100 return c_pop_error_to_mark(NULL);
1103 const OSSL_PROVIDER *FIPS_get_provider(OPENSSL_CTX *ctx)
1105 FIPS_GLOBAL *fgbl = openssl_ctx_get_data(ctx, OPENSSL_CTX_FIPS_PROV_INDEX,
1106 &fips_prov_ossl_ctx_method);
1114 void *CRYPTO_malloc(size_t num, const char *file, int line)
1116 return c_CRYPTO_malloc(num, file, line);
1119 void *CRYPTO_zalloc(size_t num, const char *file, int line)
1121 return c_CRYPTO_zalloc(num, file, line);
1124 void CRYPTO_free(void *ptr, const char *file, int line)
1126 c_CRYPTO_free(ptr, file, line);
1129 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line)
1131 c_CRYPTO_clear_free(ptr, num, file, line);
1134 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line)
1136 return c_CRYPTO_realloc(addr, num, file, line);
1139 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
1140 const char *file, int line)
1142 return c_CRYPTO_clear_realloc(addr, old_num, num, file, line);
1145 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
1147 return c_CRYPTO_secure_malloc(num, file, line);
1150 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
1152 return c_CRYPTO_secure_zalloc(num, file, line);
1155 void CRYPTO_secure_free(void *ptr, const char *file, int line)
1157 c_CRYPTO_secure_free(ptr, file, line);
1160 void CRYPTO_secure_clear_free(void *ptr, size_t num, const char *file, int line)
1162 c_CRYPTO_secure_clear_free(ptr, num, file, line);
1165 int CRYPTO_secure_allocated(const void *ptr)
1167 return c_CRYPTO_secure_allocated(ptr);
1170 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
1175 va_start(args, format);
1176 ret = c_BIO_vsnprintf(buf, n, format, args);