5 OSSL_PROVIDER-FIPS - OpenSSL FIPS provider
9 The OpenSSL FIPS provider is a special provider that conforms to the Federal
10 Information Processing Standards (FIPS) specified in FIPS 140-2. This 'module'
11 contains an approved set of cryptographic algorithms that is validated by an
12 accredited testing laboratory.
16 The implementations in this provider specifically have these properties
21 =item "provider=default"
27 It may be used in a property query string with fetching functions such as
28 L<EVP_MD_fetch(3)> or L<EVP_CIPHER_fetch(3)>, as well as with other
29 functions that take a property query string, such as
30 L<EVP_PKEY_CTX_new_from_name(3)>.
32 It isn't mandatory to query for any of these properties, except to
33 make sure to get implementations of this provider and none other.
35 The "fips=yes" property can be use to make sure only FIPS approved
36 implementations are used for crypto operations. This may also include
37 other non-crypto support operations that are not in the fips provider,
38 such as asymmetric key serializers,
39 see L<OSSL_PROVIDER-default(7)/Asymmetric Key Management>.
41 =head1 OPERATIONS AND ALGORITHMS
43 The OpenSSL FIPS provider supports these operations and algorithms:
45 =head2 Hashing Algorithms / Message Digests
49 =item SHA1, see L<EVP_MD-SHA1(7)>
51 =item SHA2, see L<EVP_MD-SHA2(7)>
53 =item SHA3, see L<EVP_MD-SHA3(7)>
55 =item KECCAK-KMAC, see L<EVP_MD-KECCAK-KMAC(7)>
59 =head2 Symmetric Ciphers
63 =item AES, see L<EVP_CIPHER-AES(7)>
65 =item DES-EDE3 (TrippleDES), see L<EVP_CIPHER-DES(7)>
69 =head2 Message Authentication Code (MAC)
73 =item CMAC, see L<EVP_MAC-CMAC(7)>
75 =item GMAC, see L<EVP_MAC-GMAC(7)>
77 =item HMAC, see L<EVP_MAC-HMAC(7)>
79 =item KMAC, see L<EVP_MAC-KMAC(7)>
83 =head2 Key Derivation Function (KDF)
87 =item HKDF, see L<EVP_KDF-HKDF(7)>
89 =item SSKDF, see L<EVP_KDF-SSKDF(7)>
91 =item PBKDF2, see L<EVP_KDF-PBKDF2(7)>
93 =item TLS1-PRF, see L<EVP_KDF-TLS1-PRF(7)>
95 =item KBKDF, see L<EVP_KDF-KBKDF(7)>
103 =item DH, see L<EVP_KEYEXCH-DH(7)>
105 =item ECDH, see L<EVP_KEYEXCH-ECDH(7)>
107 =item X25519, see L<EVP_KEYEXCH-X25519(7)>
109 This has the property "provider=fips,fips=no"
111 =item X448, see L<EVP_KEYEXCH-X448(7)>
113 This has the property "provider=fips,fips=no"
117 =head2 Asymmetric Signature
121 =item DSA, see L<EVP_KEYEXCH-DSA(7)>
125 =head2 Asymmetric Cipher
129 =item RSA, see L<EVP_KEYEXCH-RSA(7)>
133 =head2 Asymmetric Key Management
137 =item DH, see L<EVP_KEYMGMT-DH(7)>
139 =item DSA, see L<EVP_KEYMGMT-DSA(7)>
141 =item RSA, see L<EVP_KEYMGMT-RSA(7)>
147 One of the requirements for the FIPS module is self testing. An optional callback
148 mechanism is available to return information to the user using
149 L<OSSL_SELF_TEST_set_callback(3)>.
151 The parameters passed to the callback are described in L<OSSL_SELF_TEST_new(3)>
153 The OpenSSL FIPS module uses the following mechanism to provide information
154 about the self tests as they run.
155 This is useful for debugging if a self test is failing.
156 The callback also allows forcing any self test to fail, in order to check that
157 it operates correctly on failure.
158 Note that all self tests run even if a self test failure occurs.
160 The FIPS module passes the following type(s) to OSSL_SELF_TEST_onbegin().
164 =item "Module_Integrity" (B<OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY>)
166 Uses HMAC SHA256 on the module file to validate that the module has not been
167 modified. The integrity value is compared to a value written to a configuration
168 file during installation.
170 =item "Install_Integrity" (B<OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY>)
172 Uses HMAC SHA256 on a fixed string to validate that the installation process
173 has already been performed and the self test KATS have already been tested,
174 The integrity value is compared to a value written to a configuration
175 file after successfully running the self tests during installation.
177 =item "KAT_Cipher" (B<OSSL_SELF_TEST_TYPE_KAT_CIPHER>)
179 Known answer test for a symmetric cipher.
181 =item "KAT_Digest" (B<OSSL_SELF_TEST_TYPE_KAT_DIGEST>)
183 Known answer test for a digest.
185 =item "KAT_Signature" (B<OSSL_SELF_TEST_TYPE_KAT_SIGNATURE>)
187 Known answer test for a signature.
189 =item "KAT_KDF" (B<OSSL_SELF_TEST_TYPE_KAT_KDF>)
191 Known answer test for a key derivation function.
193 =item "KAT_KA" (B<OSSL_SELF_TEST_TYPE_KAT_KA>)
195 Known answer test for key agreement.
197 =item "DRBG" (B<OSSL_SELF_TEST_TYPE_DRBG>)
199 Known answer test for a Deterministic Random Bit Generator.
201 =item "Pairwise_Consistency_Test" (B<OSSL_SELF_TEST_TYPE_PCT>)
203 Conditional test that is run during the generation of key pairs.
207 The "Module_Integrity" self test is always run at startup.
208 The "Install_Integrity" self test is used to check if the self tests have
209 already been run at installation time. If they have already run then the
210 self tests are not run on subsequent startups.
211 All other self test categories are run once at installation time, except for the
212 "Pairwise_Consistency_Test".
214 There is only one instance of the "Module_Integrity" and "Install_Integrity"
215 self tests. All other self tests may have multiple instances.
218 The FIPS module passes the following descriptions(s) to OSSL_SELF_TEST_onbegin().
222 =item "HMAC" (B<OSSL_SELF_TEST_DESC_INTEGRITY_HMAC>)
224 "Module_Integrity" and "Install_Integrity" use this.
226 =item "RSA" (B<OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1>)
228 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_PCT_ECDSA>)
230 =item "DSA" (B<OSSL_SELF_TEST_DESC_PCT_DSA>)
232 Key generation tests used with the "Pairwise_Consistency_Test" type.
234 =item "AES_GCM" (B<OSSL_SELF_TEST_DESC_CIPHER_AES_GCM>)
236 =item "TDES" (B<OSSL_SELF_TEST_DESC_CIPHER_TDES>)
238 Symmetric cipher tests used with the "KAT_Cipher" type.
240 =item "SHA1" (B<OSSL_SELF_TEST_DESC_MD_SHA1>)
242 =item "SHA2" (B<OSSL_SELF_TEST_DESC_MD_SHA2>)
244 =item "SHA3" (B<OSSL_SELF_TEST_DESC_MD_SHA3>)
246 Digest tests used with the "KAT_Digest" type.
248 =item "DSA" (B<OSSL_SELF_TEST_DESC_SIGN_DSA>)
250 =item "RSA" (B<OSSL_SELF_TEST_DESC_SIGN_RSA>)
252 =item "ECDSA" (B<OSSL_SELF_TEST_DESC_SIGN_ECDSA>)
254 Signature tests used with the "KAT_Signature" type.
256 =item "ECDH" (B<OSSL_SELF_TEST_DESC_KA_ECDH>)
258 =item "DH" (B<OSSL_SELF_TEST_DESC_KA_DH>)
260 Key agreement tests used with the "KAT_KA" type.
262 =item "HKDF" (B<OSSL_SELF_TEST_DESC_KDF_HKDF>)
264 =item "SSKDF" (B<OSSL_SELF_TEST_DESC_KDF_SSKDF>)
266 Key Derivation Function tests used with the "KAT_KDF" type.
268 =item "CTR" (B<OSSL_SELF_TEST_DESC_DRBG_CTR>)
270 =item "HASH" (B<OSSL_SELF_TEST_DESC_DRBG_HASH>)
272 =item "HMAC" (B<OSSL_SELF_TEST_DESC_DRBG_HMAC>)
274 DRBG tests used with the "DRBG" type.
280 A simple self test callback is shown below for illustrative purposes.
282 #include <openssl/self_test.h>
284 static OSSL_CALLBACK self_test_cb;
286 static int self_test_cb(const OSSL_PARAM params[], void *arg)
289 const OSSL_PARAM *p = NULL;
290 const char *phase = NULL, *type = NULL, *desc = NULL;
292 p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
293 if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
295 phase = (const char *)p->data;
297 p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
298 if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
300 desc = (const char *)p->data;
302 p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
303 if (p == NULL || p->data_type != OSSL_PARAM_UTF8_STRING)
305 type = (const char *)p->data;
307 /* Do some logging */
308 if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
309 BIO_printf(bio_out, "%s : (%s) : ", desc, type);
310 if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
311 || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
312 BIO_printf(bio_out, "%s\n", phase);
314 /* Corrupt the SHA1 self test during the 'corrupt' phase by returning 0 */
315 if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
316 && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) {
317 BIO_printf(bio_out, "%s %s", phase, desc);
327 L<openssl-fipsinstall(1)>,
329 L<OSSL_SELF_TEST_set_callback(3)>,
330 L<OSSL_SELF_TEST_new(3)>,
332 L<openssl-core.h(7)>,
333 L<openssl-core_numbers.h(7)>,
338 The type and functions described here were added in OpenSSL 3.0.
342 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
344 Licensed under the Apache License 2.0 (the "License"). You may not use
345 this file except in compliance with the License. You can obtain a copy
346 in the file LICENSE in the source distribution or at
347 L<https://www.openssl.org/source/license.html>.