Debian Codegraph @

upstream/debian-trixie/man7/OSSL_PROVIDER-FIPS.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_PROVIDER-FIPS 7SSL"
58 .TH OSSL_PROVIDER-FIPS 7SSL 2026-04-07 3.5.6 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_PROVIDER\-FIPS \- OpenSSL FIPS provider
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 The OpenSSL FIPS provider is a special provider that conforms to the Federal
68 Information Processing Standards (FIPS) specified in FIPS 140\-3. This 'module'
69 contains an approved set of cryptographic algorithms that is validated by an
70 accredited testing laboratory.
71 .SS Properties
72 .IX Subsection "Properties"
73 The implementations in this provider specifically have these properties
74 defined for approved algorithms:
75 .IP """provider=fips""" 4
76 .IX Item """provider=fips"""
77 .PD 0
78 .IP """fips=yes""" 4
79 .IX Item """fips=yes"""
80 .PD
81 .PP
82 It may be used in a property query string with fetching functions such as
83 \&\fBEVP_MD_fetch\fR\|(3) or \fBEVP_CIPHER_fetch\fR\|(3), as well as with other
84 functions that take a property query string, such as
85 \&\fBEVP_PKEY_CTX_new_from_name\fR\|(3).
86 .PP
87 To be FIPS compliant, it is mandatory to include \f(CW\*(C`fips=yes\*(C'\fR as
88 part of all property queries. This ensures that only FIPS approved
89 implementations are used for cryptographic operations. The \f(CW\*(C`fips=yes\*(C'\fR
90 query may also include other non-crypto support operations that
91 are not in the FIPS provider, such as asymmetric key encoders, see
92 "Asymmetric Key Management" in \fBOSSL_PROVIDER\-default\fR\|(7).
93 .PP
94 It is not mandatory to include \f(CW\*(C`provider=fips\*(C'\fR as part of your property
95 query. Including \f(CW\*(C`provider=fips\*(C'\fR in your property query guarantees
96 that the OpenSSL FIPS provider is used for cryptographic operations
97 rather than other FIPS capable providers.
98 .SS "Approved algorithms"
99 .IX Subsection "Approved algorithms"
100 Algorithms that are fetched using "fips=yes" may still be unapproved if certain
101 conditions are not met. See "FIPS indicators" in \fBfips_module\fR\|(7) for additional
102 information.
103 .SS "Provider parameters"
104 .IX Subsection "Provider parameters"
105 See "Provider parameters" in \fBprovider\-base\fR\|(7) for a list of base parameters.
106 The OpenSSL FIPS provider also handles FIPS indicator related parameters as
107 specified by "FIPS indicator options" in \fBfips_config\fR\|(5).
108 .SH "OPERATIONS AND ALGORITHMS"
109 .IX Header "OPERATIONS AND ALGORITHMS"
110 The OpenSSL FIPS provider supports these operations and algorithms:
111 .SS "Hashing Algorithms / Message Digests"
112 .IX Subsection "Hashing Algorithms / Message Digests"
113 .IP "SHA1, see \fBEVP_MD\-SHA1\fR\|(7)" 4
114 .IX Item "SHA1, see EVP_MD-SHA1"
115 .PD 0
116 .IP "SHA2, see \fBEVP_MD\-SHA2\fR\|(7)" 4
117 .IX Item "SHA2, see EVP_MD-SHA2"
118 .IP "SHA3, see \fBEVP_MD\-SHA3\fR\|(7)" 4
119 .IX Item "SHA3, see EVP_MD-SHA3"
120 .IP "KECCAK-KMAC, see \fBEVP_MD\-KECCAK\-KMAC\fR\|(7)" 4
121 .IX Item "KECCAK-KMAC, see EVP_MD-KECCAK-KMAC"
122 .IP "SHAKE, see \fBEVP_MD\-SHAKE\fR\|(7)" 4
123 .IX Item "SHAKE, see EVP_MD-SHAKE"
124 .PD
125 .SS "Symmetric Ciphers"
126 .IX Subsection "Symmetric Ciphers"
127 .IP "AES, see \fBEVP_CIPHER\-AES\fR\|(7)" 4
128 .IX Item "AES, see EVP_CIPHER-AES"
129 .PD 0
130 .IP "3DES, see \fBEVP_CIPHER\-DES\fR\|(7)" 4
131 .IX Item "3DES, see EVP_CIPHER-DES"
132 .PD
133 .SS "Message Authentication Code (MAC)"
134 .IX Subsection "Message Authentication Code (MAC)"
135 .IP "CMAC, see \fBEVP_MAC\-CMAC\fR\|(7)" 4
136 .IX Item "CMAC, see EVP_MAC-CMAC"
137 .PD 0
138 .IP "GMAC, see \fBEVP_MAC\-GMAC\fR\|(7)" 4
139 .IX Item "GMAC, see EVP_MAC-GMAC"
140 .IP "HMAC, see \fBEVP_MAC\-HMAC\fR\|(7)" 4
141 .IX Item "HMAC, see EVP_MAC-HMAC"
142 .IP "KMAC, see \fBEVP_MAC\-KMAC\fR\|(7)" 4
143 .IX Item "KMAC, see EVP_MAC-KMAC"
144 .PD
145 .SS "Key Derivation Function (KDF)"
146 .IX Subsection "Key Derivation Function (KDF)"
147 .IP "HKDF, see \fBEVP_KDF\-HKDF\fR\|(7)" 4
148 .IX Item "HKDF, see EVP_KDF-HKDF"
149 .PD 0
150 .IP "TLS13\-KDF, see \fBEVP_KDF\-TLS13_KDF\fR\|(7)" 4
151 .IX Item "TLS13-KDF, see EVP_KDF-TLS13_KDF"
152 .IP "SSKDF, see \fBEVP_KDF\-SS\fR\|(7)" 4
153 .IX Item "SSKDF, see EVP_KDF-SS"
154 .IP "PBKDF2, see \fBEVP_KDF\-PBKDF2\fR\|(7)" 4
155 .IX Item "PBKDF2, see EVP_KDF-PBKDF2"
156 .IP "SSHKDF, see \fBEVP_KDF\-SSHKDF\fR\|(7)" 4
157 .IX Item "SSHKDF, see EVP_KDF-SSHKDF"
158 .IP "TLS1\-PRF, see \fBEVP_KDF\-TLS1_PRF\fR\|(7)" 4
159 .IX Item "TLS1-PRF, see EVP_KDF-TLS1_PRF"
160 .IP "KBKDF, see \fBEVP_KDF\-KB\fR\|(7)" 4
161 .IX Item "KBKDF, see EVP_KDF-KB"
162 .IP "X942KDF\-ASN1, see \fBEVP_KDF\-X942\-ASN1\fR\|(7)" 4
163 .IX Item "X942KDF-ASN1, see EVP_KDF-X942-ASN1"
164 .IP "X942KDF\-CONCAT, see \fBEVP_KDF\-X942\-CONCAT\fR\|(7)" 4
165 .IX Item "X942KDF-CONCAT, see EVP_KDF-X942-CONCAT"
166 .IP "X963KDF, see \fBEVP_KDF\-X963\fR\|(7)" 4
167 .IX Item "X963KDF, see EVP_KDF-X963"
168 .PD
169 .SS "Key Exchange"
170 .IX Subsection "Key Exchange"
171 .IP "DH, see \fBEVP_KEYEXCH\-DH\fR\|(7)" 4
172 .IX Item "DH, see EVP_KEYEXCH-DH"
173 .PD 0
174 .IP "ECDH, see \fBEVP_KEYEXCH\-ECDH\fR\|(7)" 4
175 .IX Item "ECDH, see EVP_KEYEXCH-ECDH"
176 .IP "X25519, see \fBEVP_KEYEXCH\-X25519\fR\|(7)" 4
177 .IX Item "X25519, see EVP_KEYEXCH-X25519"
178 .IP "X448, see \fBEVP_KEYEXCH\-X448\fR\|(7)" 4
179 .IX Item "X448, see EVP_KEYEXCH-X448"
180 .IP "ML-KEM, see \fBEVP_KEM\-ML\-KEM\fR\|(7)" 4
181 .IX Item "ML-KEM, see EVP_KEM-ML-KEM"
182 .IP TLS1\-PRF 4
183 .IX Item "TLS1-PRF"
184 .IP HKDF 4
185 .IX Item "HKDF"
186 .PD
187 .SS "Asymmetric Signature"
188 .IX Subsection "Asymmetric Signature"
189 .IP "RSA, see \fBEVP_SIGNATURE\-RSA\fR\|(7)" 4
190 .IX Item "RSA, see EVP_SIGNATURE-RSA"
191 The \fBX931\fR padding mode "OSSL_PKEY_RSA_PAD_MODE_X931" is no longer supported
192 for signature generation, but may be used for verification for legacy use cases.
193 (This is a FIPS 140\-3 requirement)
194 .IP "DSA, see \fBEVP_SIGNATURE\-DSA\fR\|(7)" 4
195 .IX Item "DSA, see EVP_SIGNATURE-DSA"
196 .PD 0
197 .IP "ED25519, see \fBEVP_SIGNATURE\-ED25519\fR\|(7)" 4
198 .IX Item "ED25519, see EVP_SIGNATURE-ED25519"
199 .IP "ED448, see \fBEVP_SIGNATURE\-ED448\fR\|(7)" 4
200 .IX Item "ED448, see EVP_SIGNATURE-ED448"
201 .IP "ECDSA, see \fBEVP_SIGNATURE\-ECDSA\fR\|(7)" 4
202 .IX Item "ECDSA, see EVP_SIGNATURE-ECDSA"
203 .IP "ML\-DSA\-44, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4
204 .IX Item "ML-DSA-44, see EVP_SIGNATURE-ML-DSA"
205 .IP "ML\-DSA\-65, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4
206 .IX Item "ML-DSA-65, see EVP_SIGNATURE-ML-DSA"
207 .IP "ML\-DSA\-87, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4
208 .IX Item "ML-DSA-87, see EVP_SIGNATURE-ML-DSA"
209 .IP "SLH-DSA, see \fBEVP_SIGNATURE\-SLH\-DSA\fR\|(7)" 4
210 .IX Item "SLH-DSA, see EVP_SIGNATURE-SLH-DSA"
211 .IP "HMAC, see \fBEVP_SIGNATURE\-HMAC\fR\|(7)" 4
212 .IX Item "HMAC, see EVP_SIGNATURE-HMAC"
213 .IP "CMAC, see \fBEVP_SIGNATURE\-CMAC\fR\|(7)" 4
214 .IX Item "CMAC, see EVP_SIGNATURE-CMAC"
215 .PD
216 .SS "Asymmetric Cipher"
217 .IX Subsection "Asymmetric Cipher"
218 .IP "RSA, see \fBEVP_ASYM_CIPHER\-RSA\fR\|(7)" 4
219 .IX Item "RSA, see EVP_ASYM_CIPHER-RSA"
220 .SS "Asymmetric Key Encapsulation"
221 .IX Subsection "Asymmetric Key Encapsulation"
222 .PD 0
223 .IP "RSA, see \fBEVP_KEM\-RSA\fR\|(7)" 4
224 .IX Item "RSA, see EVP_KEM-RSA"
225 .PD
226 .SS "Asymmetric Key Management"
227 .IX Subsection "Asymmetric Key Management"
228 .IP "DH, see \fBEVP_KEYMGMT\-DH\fR\|(7)" 4
229 .IX Item "DH, see EVP_KEYMGMT-DH"
230 .PD 0
231 .IP "DHX, see \fBEVP_KEYMGMT\-DHX\fR\|(7)" 4
232 .IX Item "DHX, see EVP_KEYMGMT-DHX"
233 .IP "DSA, see \fBEVP_KEYMGMT\-DSA\fR\|(7)" 4
234 .IX Item "DSA, see EVP_KEYMGMT-DSA"
235 .IP "RSA, see \fBEVP_KEYMGMT\-RSA\fR\|(7)" 4
236 .IX Item "RSA, see EVP_KEYMGMT-RSA"
237 .IP RSA-PSS 4
238 .IX Item "RSA-PSS"
239 .IP "EC, see \fBEVP_KEYMGMT\-EC\fR\|(7)" 4
240 .IX Item "EC, see EVP_KEYMGMT-EC"
241 .IP "ED25519, see \fBEVP_KEYMGMT\-ED25519\fR\|(7)" 4
242 .IX Item "ED25519, see EVP_KEYMGMT-ED25519"
243 .IP "ED448, see \fBEVP_KEYMGMT\-ED448\fR\|(7)" 4
244 .IX Item "ED448, see EVP_KEYMGMT-ED448"
245 .IP "X25519, see \fBEVP_KEYMGMT\-X25519\fR\|(7)" 4
246 .IX Item "X25519, see EVP_KEYMGMT-X25519"
247 .PD
248 This is an unapproved algorithm.
249 The FIPS 140\-3 IG states that "Curves that are included in SP 800\-186 but not
250 included in SP 800\-56Arev3 are not approved for key agreement".
251 .IP "X448, see \fBEVP_KEYMGMT\-X448\fR\|(7)" 4
252 .IX Item "X448, see EVP_KEYMGMT-X448"
253 This is an unapproved algorithm.
254 The FIPS 140\-3 IG states that "Curves that are included in SP 800\-186 but not"
255 included in SP 800\-56Arev3 are not approved for key agreement".
256 .IP TLS1\-PRF 4
257 .IX Item "TLS1-PRF"
258 .PD 0
259 .IP HKDF 4
260 .IX Item "HKDF"
261 .IP "HMAC, see \fBEVP_KEYMGMT\-HMAC\fR\|(7)" 4
262 .IX Item "HMAC, see EVP_KEYMGMT-HMAC"
263 .IP "CMAC, see \fBEVP_KEYMGMT\-CMAC\fR\|(7)" 4
264 .IX Item "CMAC, see EVP_KEYMGMT-CMAC"
265 .IP "ML\-DSA\-44, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4
266 .IX Item "ML-DSA-44, see EVP_KEYMGMT-ML-DSA"
267 .IP "ML\-DSA\-65, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4
268 .IX Item "ML-DSA-65, see EVP_KEYMGMT-ML-DSA"
269 .IP "ML\-DSA\-87, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4
270 .IX Item "ML-DSA-87, see EVP_KEYMGMT-ML-DSA"
271 .IP "SLH\-DSA\-SHA2\-128s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
272 .IX Item "SLH-DSA-SHA2-128s, see EVP_KEYMGMT-SLH-DSA"
273 .IP "SLH\-DSA\-SHA2\-128f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
274 .IX Item "SLH-DSA-SHA2-128f, see EVP_KEYMGMT-SLH-DSA"
275 .IP "SLH\-DSA\-SHA2\-192s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
276 .IX Item "SLH-DSA-SHA2-192s, see EVP_KEYMGMT-SLH-DSA"
277 .IP "SLH\-DSA\-SHA2\-192f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
278 .IX Item "SLH-DSA-SHA2-192f, see EVP_KEYMGMT-SLH-DSA"
279 .IP "SLH\-DSA\-SHA2\-256s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
280 .IX Item "SLH-DSA-SHA2-256s, see EVP_KEYMGMT-SLH-DSA"
281 .IP "SLH\-DSA\-SHA2\-256f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
282 .IX Item "SLH-DSA-SHA2-256f, see EVP_KEYMGMT-SLH-DSA"
283 .IP "SLH\-DSA\-SHAKE\-128s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
284 .IX Item "SLH-DSA-SHAKE-128s, see EVP_KEYMGMT-SLH-DSA"
285 .IP "SLH\-DSA\-SHAKE\-128f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
286 .IX Item "SLH-DSA-SHAKE-128f, see EVP_KEYMGMT-SLH-DSA"
287 .IP "SLH\-DSA\-SHAKE\-192s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
288 .IX Item "SLH-DSA-SHAKE-192s, see EVP_KEYMGMT-SLH-DSA"
289 .IP "SLH\-DSA\-SHAKE\-192f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
290 .IX Item "SLH-DSA-SHAKE-192f, see EVP_KEYMGMT-SLH-DSA"
291 .IP "SLH\-DSA\-SHAKE\-256s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
292 .IX Item "SLH-DSA-SHAKE-256s, see EVP_KEYMGMT-SLH-DSA"
293 .IP "SLH\-DSA\-SHAKE\-256f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4
294 .IX Item "SLH-DSA-SHAKE-256f, see EVP_KEYMGMT-SLH-DSA"
295 .PD
296 .SS "Random Number Generation"
297 .IX Subsection "Random Number Generation"
298 .IP "CRNG-TEST, see \fBEVP_RAND\-CRNG\-TEST\fR\|(7)" 4
299 .IX Item "CRNG-TEST, see EVP_RAND-CRNG-TEST"
300 .PD 0
301 .IP "CTR-DRBG, see \fBEVP_RAND\-CTR\-DRBG\fR\|(7)" 4
302 .IX Item "CTR-DRBG, see EVP_RAND-CTR-DRBG"
303 .IP "HASH-DRBG, see \fBEVP_RAND\-HASH\-DRBG\fR\|(7)" 4
304 .IX Item "HASH-DRBG, see EVP_RAND-HASH-DRBG"
305 .IP "HMAC-DRBG, see \fBEVP_RAND\-HMAC\-DRBG\fR\|(7)" 4
306 .IX Item "HMAC-DRBG, see EVP_RAND-HMAC-DRBG"
307 .IP "TEST-RAND, see \fBEVP_RAND\-TEST\-RAND\fR\|(7)" 4
308 .IX Item "TEST-RAND, see EVP_RAND-TEST-RAND"
309 .PD
310 TEST-RAND is an unapproved algorithm.
311 .SH "SELF TESTING"
312 .IX Header "SELF TESTING"
313 A requirement of FIPS modules is to run cryptographic algorithm self tests.
314 FIPS 140\-3 requires known answer tests to be run on startup as well as
315 conditional tests that run during cryptographic operations.
316 .PP
317 An optional callback mechanism is available to return information to the user using
318 \&\fBOSSL_SELF_TEST_set_callback\fR\|(3).
319 .PP
320 The parameters passed to the callback are described in \fBOSSL_SELF_TEST_new\fR\|(3)
321 .PP
322 The OpenSSL FIPS module uses the following mechanism to provide information
323 about the self tests as they run.
324 This is useful for debugging if a self test is failing.
325 The callback also allows forcing any self test to fail, in order to check that
326 it operates correctly on failure.
327 Note that all self tests run even if a self test failure occurs.
328 .PP
329 The FIPS module passes the following type(s) to \fBOSSL_SELF_TEST_onbegin()\fR.
330 .IP """Module_Integrity"" (\fBOSSL_SELF_TEST_TYPE_MODULE_INTEGRITY\fR)" 4
331 .IX Item """Module_Integrity"" (OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY)"
332 Uses HMAC SHA256 on the module file to validate that the module has not been
333 modified. The integrity value is compared to a value written to a configuration
334 file during installation.
335 .IP """KAT_Integrity"" (\fBOSSL_SELF_TEST_TYPE_KAT_INTEGRITY\fR)" 4
336 .IX Item """KAT_Integrity"" (OSSL_SELF_TEST_TYPE_KAT_INTEGRITY)"
337 Used during the Module Integrity test to perform a known answer test on
338 HMAC SHA256 prior to using it.
339 .IP """KAT_Cipher"" (\fBOSSL_SELF_TEST_TYPE_KAT_CIPHER\fR)" 4
340 .IX Item """KAT_Cipher"" (OSSL_SELF_TEST_TYPE_KAT_CIPHER)"
341 Known answer test for a symmetric cipher.
342 .IP """KAT_AsymmetricCipher"" (\fBOSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER\fR)" 4
343 .IX Item """KAT_AsymmetricCipher"" (OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER)"
344 Known answer test for a asymmetric cipher.
345 .IP """KAT_Digest"" (\fBOSSL_SELF_TEST_TYPE_KAT_DIGEST\fR)" 4
346 .IX Item """KAT_Digest"" (OSSL_SELF_TEST_TYPE_KAT_DIGEST)"
347 Known answer test for a digest.
348 .IP """KAT_AsymmetricKeyGeneration"" (\fBOSSL_SELF_TEST_TYPE_KAT_ASYM_KEYGEN\fR)" 4
349 .IX Item """KAT_AsymmetricKeyGeneration"" (OSSL_SELF_TEST_TYPE_KAT_ASYM_KEYGEN)"
350 Known answer test for asymmetric key generation.
351 .IP """KAT_Signature"" (\fBOSSL_SELF_TEST_TYPE_KAT_SIGNATURE\fR)" 4
352 .IX Item """KAT_Signature"" (OSSL_SELF_TEST_TYPE_KAT_SIGNATURE)"
353 Known answer test for a signature.
354 .IP """PCT_Signature"" (\fBOSSL_SELF_TEST_TYPE_PCT_SIGNATURE\fR)" 4
355 .IX Item """PCT_Signature"" (OSSL_SELF_TEST_TYPE_PCT_SIGNATURE)"
356 Pairwise Consistency check for a signature.
357 .IP """KAT_KDF"" (\fBOSSL_SELF_TEST_TYPE_KAT_KDF\fR)" 4
358 .IX Item """KAT_KDF"" (OSSL_SELF_TEST_TYPE_KAT_KDF)"
359 Known answer test for a key derivation function.
360 .IP """KAT_KA"" (\fBOSSL_SELF_TEST_TYPE_KAT_KA\fR)" 4
361 .IX Item """KAT_KA"" (OSSL_SELF_TEST_TYPE_KAT_KA)"
362 Known answer test for key agreement.
363 .IP """KAT_KEM"" (\fBOSSL_SELF_TEST_TYPE_KAT_KEM\fR)" 4
364 .IX Item """KAT_KEM"" (OSSL_SELF_TEST_TYPE_KAT_KEM)"
365 Known answer test for key encapsulation.
366 .IP """DRBG"" (\fBOSSL_SELF_TEST_TYPE_DRBG\fR)" 4
367 .IX Item """DRBG"" (OSSL_SELF_TEST_TYPE_DRBG)"
368 Known answer test for a Deterministic Random Bit Generator.
369 .IP """Conditional_PCT"" (\fBOSSL_SELF_TEST_TYPE_PCT\fR)" 4
370 .IX Item """Conditional_PCT"" (OSSL_SELF_TEST_TYPE_PCT)"
371 Conditional test that is run during the generation of key pairs.
372 .IP """Import_PCT"" (\fBOSSL_SELF_TEST_TYPE_PCT_IMPORT\fR)" 4
373 .IX Item """Import_PCT"" (OSSL_SELF_TEST_TYPE_PCT_IMPORT)"
374 Conditional test that is run during the import of key pairs.
375 .IP """Conditional_KAT"" (\fBOSSL_SELF_TEST_TYPE_PCT_KAT\fR)" 4
376 .IX Item """Conditional_KAT"" (OSSL_SELF_TEST_TYPE_PCT_KAT)"
377 Conditional test run during generation that derive the public key from the
378 private key and checks that the public key matches. This is a SP 800\-56A requirement.
379 .IP """Continuous_RNG_Test"" (\fBOSSL_SELF_TEST_TYPE_CRNG\fR)" 4
380 .IX Item """Continuous_RNG_Test"" (OSSL_SELF_TEST_TYPE_CRNG)"
381 Continuous random number generator test.
382 .IP """Install_Integrity"" (\fBOSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY\fR)" 4
383 .IX Item """Install_Integrity"" (OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY)"
384 This is deprecated. The option is no longer used since FIPS 140\-3 requires
385 self tests to always run on startup. Previous FIPS 140\-2 validations allowed
386 the self tests to be run just once.
387 .PP
388 The FIPS module passes the following descriptions(s) to \fBOSSL_SELF_TEST_onbegin()\fR.
389 .IP """HMAC"" (\fBOSSL_SELF_TEST_DESC_INTEGRITY_HMAC\fR)" 4
390 .IX Item """HMAC"" (OSSL_SELF_TEST_DESC_INTEGRITY_HMAC)"
391 "Module_Integrity" uses this.
392 .IP """RSA"" (\fBOSSL_SELF_TEST_DESC_PCT_RSA_PKCS1\fR)" 4
393 .IX Item """RSA"" (OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1)"
394 .PD 0
395 .IP """RSA"" (\fBOSSL_SELF_TEST_DESC_PCT_RSA\fR)" 4
396 .IX Item """RSA"" (OSSL_SELF_TEST_DESC_PCT_RSA)"
397 .IP """ECDSA"" (\fBOSSL_SELF_TEST_DESC_PCT_ECDSA\fR)" 4
398 .IX Item """ECDSA"" (OSSL_SELF_TEST_DESC_PCT_ECDSA)"
399 .IP """EDDSA"" (\fBOSSL_SELF_TEST_DESC_PCT_EDDSA\fR)" 4
400 .IX Item """EDDSA"" (OSSL_SELF_TEST_DESC_PCT_EDDSA)"
401 .IP """DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_DSA\fR)" 4
402 .IX Item """DSA"" (OSSL_SELF_TEST_DESC_PCT_DSA)"
403 .IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_ML_DSA\fR)" 4
404 .IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_PCT_ML_DSA)"
405 .IP """ML-KEM"" (\fBOSSL_SELF_TEST_DESC_PCT_ML_KEM\fR)" 4
406 .IX Item """ML-KEM"" (OSSL_SELF_TEST_DESC_PCT_ML_KEM)"
407 .IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_SLH_DSA\fR)" 4
408 .IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_PCT_SLH_DSA)"
409 .PD
410 Key generation tests used with the "Pairwise_Consistency_Test" type.
411 .IP """RSA_Encrypt"" (\fBOSSL_SELF_TEST_DESC_ASYM_RSA_ENC\fR)" 4
412 .IX Item """RSA_Encrypt"" (OSSL_SELF_TEST_DESC_ASYM_RSA_ENC)"
413 .PD 0
414 .IP """RSA_Decrypt"" (\fBOSSL_SELF_TEST_DESC_ASYM_RSA_DEC\fR)" 4
415 .IX Item """RSA_Decrypt"" (OSSL_SELF_TEST_DESC_ASYM_RSA_DEC)"
416 .PD
417 "KAT_AsymmetricCipher" uses this to indicate an encrypt or decrypt KAT.
418 .IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_ML_DSA\fR)" 4
419 .IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_KEYGEN_ML_DSA)"
420 .PD 0
421 .IP """ML-KEM"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_ML_KEM\fR)" 4
422 .IX Item """ML-KEM"" (OSSL_SELF_TEST_DESC_KEYGEN_ML_KEM)"
423 .IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_SLH_DSA\fR)" 4
424 .IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_KEYGEN_SLH_DSA)"
425 .PD
426 "KAT_AsymmetricKeyGeneration" uses this to indicate a key generation KAT.
427 .IP """AES_GCM"" (\fBOSSL_SELF_TEST_DESC_CIPHER_AES_GCM\fR)" 4
428 .IX Item """AES_GCM"" (OSSL_SELF_TEST_DESC_CIPHER_AES_GCM)"
429 .PD 0
430 .IP """AES_ECB_Decrypt"" (\fBOSSL_SELF_TEST_DESC_CIPHER_AES_ECB\fR)" 4
431 .IX Item """AES_ECB_Decrypt"" (OSSL_SELF_TEST_DESC_CIPHER_AES_ECB)"
432 .IP """TDES"" (\fBOSSL_SELF_TEST_DESC_CIPHER_TDES\fR)" 4
433 .IX Item """TDES"" (OSSL_SELF_TEST_DESC_CIPHER_TDES)"
434 .PD
435 Symmetric cipher tests used with the "KAT_Cipher" type.
436 .IP """SHA1"" (\fBOSSL_SELF_TEST_DESC_MD_SHA1\fR)" 4
437 .IX Item """SHA1"" (OSSL_SELF_TEST_DESC_MD_SHA1)"
438 .PD 0
439 .IP """SHA2"" (\fBOSSL_SELF_TEST_DESC_MD_SHA2\fR)" 4
440 .IX Item """SHA2"" (OSSL_SELF_TEST_DESC_MD_SHA2)"
441 .IP """SHA3"" (\fBOSSL_SELF_TEST_DESC_MD_SHA3\fR)" 4
442 .IX Item """SHA3"" (OSSL_SELF_TEST_DESC_MD_SHA3)"
443 .PD
444 Digest tests used with the "KAT_Digest" type.
445 .IP """DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_DSA\fR)" 4
446 .IX Item """DSA"" (OSSL_SELF_TEST_DESC_SIGN_DSA)"
447 .PD 0
448 .IP """RSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_RSA\fR)" 4
449 .IX Item """RSA"" (OSSL_SELF_TEST_DESC_SIGN_RSA)"
450 .IP """ECDSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_ECDSA\fR)" 4
451 .IX Item """ECDSA"" (OSSL_SELF_TEST_DESC_SIGN_ECDSA)"
452 .IP """EDDSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_EDDSA\fR)" 4
453 .IX Item """EDDSA"" (OSSL_SELF_TEST_DESC_SIGN_EDDSA)"
454 .IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_ML_DSA\fR)" 4
455 .IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_SIGN_ML_DSA)"
456 .IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_SLH_DSA\fR)" 4
457 .IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_SIGN_SLH_DSA)"
458 .PD
459 Signature tests used with the "KAT_Signature" type.
460 .IP """ECDH"" (\fBOSSL_SELF_TEST_DESC_KA_ECDH\fR)" 4
461 .IX Item """ECDH"" (OSSL_SELF_TEST_DESC_KA_ECDH)"
462 .PD 0
463 .IP """DH"" (\fBOSSL_SELF_TEST_DESC_KA_DH\fR)" 4
464 .IX Item """DH"" (OSSL_SELF_TEST_DESC_KA_DH)"
465 .PD
466 Key agreement tests used with the "KAT_KA" type.
467 .IP """HKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_HKDF\fR)" 4
468 .IX Item """HKDF"" (OSSL_SELF_TEST_DESC_KDF_HKDF)"
469 .PD 0
470 .IP """TLS13_KDF_EXTRACT"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT\fR)" 4
471 .IX Item """TLS13_KDF_EXTRACT"" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT)"
472 .IP """TLS13_KDF_EXPAND"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND\fR)" 4
473 .IX Item """TLS13_KDF_EXPAND"" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND)"
474 .IP """SSKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_SSKDF\fR)" 4
475 .IX Item """SSKDF"" (OSSL_SELF_TEST_DESC_KDF_SSKDF)"
476 .IP """X963KDF"" (\fBOSSL_SELF_TEST_DESC_KDF_X963KDF\fR)" 4
477 .IX Item """X963KDF"" (OSSL_SELF_TEST_DESC_KDF_X963KDF)"
478 .IP """X942KDF"" (\fBOSSL_SELF_TEST_DESC_KDF_X942KDF\fR)" 4
479 .IX Item """X942KDF"" (OSSL_SELF_TEST_DESC_KDF_X942KDF)"
480 .IP """PBKDF2"" (\fBOSSL_SELF_TEST_DESC_KDF_PBKDF2\fR)" 4
481 .IX Item """PBKDF2"" (OSSL_SELF_TEST_DESC_KDF_PBKDF2)"
482 .IP """SSHKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_SSHKDF\fR)" 4
483 .IX Item """SSHKDF"" (OSSL_SELF_TEST_DESC_KDF_SSHKDF)"
484 .IP """TLS12_PRF"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS12_PRF\fR)" 4
485 .IX Item """TLS12_PRF"" (OSSL_SELF_TEST_DESC_KDF_TLS12_PRF)"
486 .IP """KBKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_KBKDF\fR)" 4
487 .IX Item """KBKDF"" (OSSL_SELF_TEST_DESC_KDF_KBKDF)"
488 .PD
489 Key Encapsulation Function tests used with the "KAT_KEM" type.
490 .IP """KEM_Encap"" (\fBOSSL_SELF_TEST_DESC_ENCAP_KEM\fR)" 4
491 .IX Item """KEM_Encap"" (OSSL_SELF_TEST_DESC_ENCAP_KEM)"
492 .PD 0
493 .IP """KEM_Decap"" (\fBOSSL_SELF_TEST_DESC_DECAP_KEM\fR)" 4
494 .IX Item """KEM_Decap"" (OSSL_SELF_TEST_DESC_DECAP_KEM)"
495 .IP """KEM_Decap_Reject"" (\fBOSSL_SELF_TEST_DESC_DECAP_REJ_KEM\fR)" 4
496 .IX Item """KEM_Decap_Reject"" (OSSL_SELF_TEST_DESC_DECAP_REJ_KEM)"
497 .PD
498 Key Derivation Function tests used with the "KAT_KDF" type.
499 .IP """CTR"" (\fBOSSL_SELF_TEST_DESC_DRBG_CTR\fR)" 4
500 .IX Item """CTR"" (OSSL_SELF_TEST_DESC_DRBG_CTR)"
501 .PD 0
502 .IP """HASH"" (\fBOSSL_SELF_TEST_DESC_DRBG_HASH\fR)" 4
503 .IX Item """HASH"" (OSSL_SELF_TEST_DESC_DRBG_HASH)"
504 .IP """HMAC"" (\fBOSSL_SELF_TEST_DESC_DRBG_HMAC\fR)" 4
505 .IX Item """HMAC"" (OSSL_SELF_TEST_DESC_DRBG_HMAC)"
506 .PD
507 DRBG tests used with the "DRBG" type.
508 .IP """RNG"" (\fBOSSL_SELF_TEST_DESC_RNG\fR)" 4
509 .IX Item """RNG"" (OSSL_SELF_TEST_DESC_RNG)"
510 "Continuous_RNG_Test" uses this.
511 .SH EXAMPLES
512 .IX Header "EXAMPLES"
513 A simple self test callback is shown below for illustrative purposes.
514 .PP
515 .Vb 1
516 \& #include <openssl/self_test.h>
517 \&
518 \& static OSSL_CALLBACK self_test_cb;
519 \&
520 \& static int self_test_cb(const OSSL_PARAM params[], void *arg)
521 \& {
522 \& int ret = 0;
523 \& const OSSL_PARAM *p = NULL;
524 \& const char *phase = NULL, *type = NULL, *desc = NULL;
525 \&
526 \& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE);
527 \& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING)
528 \& goto err;
529 \& phase = (const char *)p\->data;
530 \&
531 \& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC);
532 \& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING)
533 \& goto err;
534 \& desc = (const char *)p\->data;
535 \&
536 \& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE);
537 \& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING)
538 \& goto err;
539 \& type = (const char *)p\->data;
540 \&
541 \& /* Do some logging */
542 \& if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0)
543 \& BIO_printf(bio_out, "%s : (%s) : ", desc, type);
544 \& if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0
545 \& || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0)
546 \& BIO_printf(bio_out, "%s\en", phase);
547 \&
548 \& /* Corrupt the SHA1 self test during the \*(Aqcorrupt\*(Aq phase by returning 0 */
549 \& if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0
550 \& && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) {
551 \& BIO_printf(bio_out, "%s %s", phase, desc);
552 \& return 0;
553 \& }
554 \& ret = 1;
555 \& err:
556 \& return ret;
557 \& }
558 .Ve
559 .SH NOTES
560 .IX Header "NOTES"
561 Some released versions of OpenSSL do not include a validated
562 FIPS provider. To determine which versions have undergone
563 the validation process, please refer to the
564 OpenSSL Downloads page <https://www.openssl.org/source/>. If you
565 require FIPS-approved functionality, it is essential to build your FIPS
566 provider using one of the validated versions listed there. Normally,
567 it is possible to utilize a FIPS provider constructed from one of the
568 validated versions alongside \fIlibcrypto\fR and \fIlibssl\fR compiled from any
569 release within the same major release series. This flexibility enables
570 you to address bug fixes and CVEs that fall outside the FIPS boundary.
571 .PP
572 You can load the FIPS provider into multiple library contexts as any other
573 provider. However the following restriction applies. The FIPS provider cannot
574 be used by multiple copies of OpenSSL libcrypto in a single process.
575 .PP
576 As the provider saves core callbacks to the libcrypto obtained in the
577 \&\fBOSSL_provider_init()\fR call to global data it will fail if subsequent
578 invocations of its \fBOSSL_provider_init()\fR function yield different addresses
579 of these callbacks than in the initial call. This happens when different
580 copies of libcrypto are present in the memory of the process and both try
581 to load the same FIPS provider. A workaround is to have a different copy
582 of the FIPS provider loaded for each of the libcrypto instances in the
583 process.
584 .SH "SEE ALSO"
585 .IX Header "SEE ALSO"
586 \&\fBopenssl\-fipsinstall\fR\|(1),
587 \&\fBfips_config\fR\|(5),
588 \&\fBOSSL_SELF_TEST_set_callback\fR\|(3),
589 \&\fBOSSL_SELF_TEST_new\fR\|(3),
590 \&\fBOSSL_PARAM\fR\|(3),
591 \&\fBopenssl\-core.h\fR\|(7),
592 \&\fBopenssl\-core_dispatch.h\fR\|(7),
593 \&\fBprovider\fR\|(7),
594 <https://www.openssl.org/source/>
595 .SH HISTORY
596 .IX Header "HISTORY"
597 This functionality was added in OpenSSL 3.0.
598 .SH COPYRIGHT
599 .IX Header "COPYRIGHT"
600 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.
601 .PP
602 Licensed under the Apache License 2.0 (the "License"). You may not use
603 this file except in compliance with the License. You can obtain a copy
604 in the file LICENSE in the source distribution or at
605 <https://www.openssl.org/source/license.html>.