| 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.6.2 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 "SHAKE, see \fBEVP_MD\-SHAKE\fR\|(7)" 4 |
| 121 |
.IX Item "SHAKE, see EVP_MD-SHAKE" |
| 122 |
.IP "KECCAK-KMAC, see \fBEVP_MD\-KECCAK\-KMAC\fR\|(7)" 4 |
| 123 |
.IX Item "KECCAK-KMAC, see EVP_MD-KECCAK-KMAC" |
| 124 |
.PD |
| 125 |
KECCAK-KMAC is only used internally as a sub algorithm of KMAC. |
| 126 |
.SS "Symmetric Ciphers" |
| 127 |
.IX Subsection "Symmetric Ciphers" |
| 128 |
.IP "AES, see \fBEVP_CIPHER\-AES\fR\|(7)" 4 |
| 129 |
.IX Item "AES, see EVP_CIPHER-AES" |
| 130 |
.PD 0 |
| 131 |
.IP "3DES, see \fBEVP_CIPHER\-DES\fR\|(7)" 4 |
| 132 |
.IX Item "3DES, see EVP_CIPHER-DES" |
| 133 |
.PD |
| 134 |
.SS "Message Authentication Code (MAC)" |
| 135 |
.IX Subsection "Message Authentication Code (MAC)" |
| 136 |
.IP "CMAC, see \fBEVP_MAC\-CMAC\fR\|(7)" 4 |
| 137 |
.IX Item "CMAC, see EVP_MAC-CMAC" |
| 138 |
.PD 0 |
| 139 |
.IP "GMAC, see \fBEVP_MAC\-GMAC\fR\|(7)" 4 |
| 140 |
.IX Item "GMAC, see EVP_MAC-GMAC" |
| 141 |
.IP "HMAC, see \fBEVP_MAC\-HMAC\fR\|(7)" 4 |
| 142 |
.IX Item "HMAC, see EVP_MAC-HMAC" |
| 143 |
.IP "KMAC, see \fBEVP_MAC\-KMAC\fR\|(7)" 4 |
| 144 |
.IX Item "KMAC, see EVP_MAC-KMAC" |
| 145 |
.PD |
| 146 |
.SS "Key Derivation Function (KDF)" |
| 147 |
.IX Subsection "Key Derivation Function (KDF)" |
| 148 |
.IP "HKDF, see \fBEVP_KDF\-HKDF\fR\|(7)" 4 |
| 149 |
.IX Item "HKDF, see EVP_KDF-HKDF" |
| 150 |
.PD 0 |
| 151 |
.IP "HKDF\-SHA256, see \fBEVP_KDF\-HKDF\fR\|(7)" 4 |
| 152 |
.IX Item "HKDF-SHA256, see EVP_KDF-HKDF" |
| 153 |
.IP "HKDF\-SHA384, see \fBEVP_KDF\-HKDF\fR\|(7)" 4 |
| 154 |
.IX Item "HKDF-SHA384, see EVP_KDF-HKDF" |
| 155 |
.IP "HKDF\-SHA512, see \fBEVP_KDF\-HKDF\fR\|(7)" 4 |
| 156 |
.IX Item "HKDF-SHA512, see EVP_KDF-HKDF" |
| 157 |
.IP "TLS13\-KDF, see \fBEVP_KDF\-TLS13_KDF\fR\|(7)" 4 |
| 158 |
.IX Item "TLS13-KDF, see EVP_KDF-TLS13_KDF" |
| 159 |
.IP "SSKDF, see \fBEVP_KDF\-SS\fR\|(7)" 4 |
| 160 |
.IX Item "SSKDF, see EVP_KDF-SS" |
| 161 |
.IP "PBKDF2, see \fBEVP_KDF\-PBKDF2\fR\|(7)" 4 |
| 162 |
.IX Item "PBKDF2, see EVP_KDF-PBKDF2" |
| 163 |
.IP "SSHKDF, see \fBEVP_KDF\-SSHKDF\fR\|(7)" 4 |
| 164 |
.IX Item "SSHKDF, see EVP_KDF-SSHKDF" |
| 165 |
.IP "TLS1\-PRF, see \fBEVP_KDF\-TLS1_PRF\fR\|(7)" 4 |
| 166 |
.IX Item "TLS1-PRF, see EVP_KDF-TLS1_PRF" |
| 167 |
.IP "KBKDF, see \fBEVP_KDF\-KB\fR\|(7)" 4 |
| 168 |
.IX Item "KBKDF, see EVP_KDF-KB" |
| 169 |
.IP "X942KDF\-ASN1, see \fBEVP_KDF\-X942\-ASN1\fR\|(7)" 4 |
| 170 |
.IX Item "X942KDF-ASN1, see EVP_KDF-X942-ASN1" |
| 171 |
.IP "X942KDF\-CONCAT, see \fBEVP_KDF\-X942\-CONCAT\fR\|(7)" 4 |
| 172 |
.IX Item "X942KDF-CONCAT, see EVP_KDF-X942-CONCAT" |
| 173 |
.IP "X963KDF, see \fBEVP_KDF\-X963\fR\|(7)" 4 |
| 174 |
.IX Item "X963KDF, see EVP_KDF-X963" |
| 175 |
.PD |
| 176 |
.SS "Key Exchange" |
| 177 |
.IX Subsection "Key Exchange" |
| 178 |
.IP "DH, see \fBEVP_KEYEXCH\-DH\fR\|(7)" 4 |
| 179 |
.IX Item "DH, see EVP_KEYEXCH-DH" |
| 180 |
.PD 0 |
| 181 |
.IP "ECDH, see \fBEVP_KEYEXCH\-ECDH\fR\|(7)" 4 |
| 182 |
.IX Item "ECDH, see EVP_KEYEXCH-ECDH" |
| 183 |
.IP "X25519, see \fBEVP_KEYEXCH\-X25519\fR\|(7)" 4 |
| 184 |
.IX Item "X25519, see EVP_KEYEXCH-X25519" |
| 185 |
.IP "X448, see \fBEVP_KEYEXCH\-X448\fR\|(7)" 4 |
| 186 |
.IX Item "X448, see EVP_KEYEXCH-X448" |
| 187 |
.IP "ML-KEM, see \fBEVP_KEM\-ML\-KEM\fR\|(7)" 4 |
| 188 |
.IX Item "ML-KEM, see EVP_KEM-ML-KEM" |
| 189 |
.IP TLS1\-PRF 4 |
| 190 |
.IX Item "TLS1-PRF" |
| 191 |
.IP HKDF 4 |
| 192 |
.IX Item "HKDF" |
| 193 |
.PD |
| 194 |
.SS "Asymmetric Signature" |
| 195 |
.IX Subsection "Asymmetric Signature" |
| 196 |
.IP "RSA, see \fBEVP_SIGNATURE\-RSA\fR\|(7)" 4 |
| 197 |
.IX Item "RSA, see EVP_SIGNATURE-RSA" |
| 198 |
The \fBX931\fR padding mode "OSSL_PKEY_RSA_PAD_MODE_X931" is no longer supported |
| 199 |
for signature generation, but may be used for verification for legacy use cases. |
| 200 |
(This is a FIPS 140\-3 requirement) |
| 201 |
.IP "DSA, see \fBEVP_SIGNATURE\-DSA\fR\|(7)" 4 |
| 202 |
.IX Item "DSA, see EVP_SIGNATURE-DSA" |
| 203 |
.PD 0 |
| 204 |
.IP "ED25519, see \fBEVP_SIGNATURE\-ED25519\fR\|(7)" 4 |
| 205 |
.IX Item "ED25519, see EVP_SIGNATURE-ED25519" |
| 206 |
.IP "ED448, see \fBEVP_SIGNATURE\-ED448\fR\|(7)" 4 |
| 207 |
.IX Item "ED448, see EVP_SIGNATURE-ED448" |
| 208 |
.IP "ECDSA, see \fBEVP_SIGNATURE\-ECDSA\fR\|(7)" 4 |
| 209 |
.IX Item "ECDSA, see EVP_SIGNATURE-ECDSA" |
| 210 |
.IP "ML\-DSA\-44, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4 |
| 211 |
.IX Item "ML-DSA-44, see EVP_SIGNATURE-ML-DSA" |
| 212 |
.IP "ML\-DSA\-65, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4 |
| 213 |
.IX Item "ML-DSA-65, see EVP_SIGNATURE-ML-DSA" |
| 214 |
.IP "ML\-DSA\-87, see \fBEVP_SIGNATURE\-ML\-DSA\fR\|(7)" 4 |
| 215 |
.IX Item "ML-DSA-87, see EVP_SIGNATURE-ML-DSA" |
| 216 |
.IP "SLH-DSA, see \fBEVP_SIGNATURE\-SLH\-DSA\fR\|(7)" 4 |
| 217 |
.IX Item "SLH-DSA, see EVP_SIGNATURE-SLH-DSA" |
| 218 |
.IP "HMAC, see \fBEVP_SIGNATURE\-HMAC\fR\|(7)" 4 |
| 219 |
.IX Item "HMAC, see EVP_SIGNATURE-HMAC" |
| 220 |
.IP "CMAC, see \fBEVP_SIGNATURE\-CMAC\fR\|(7)" 4 |
| 221 |
.IX Item "CMAC, see EVP_SIGNATURE-CMAC" |
| 222 |
.IP "LMS, see \fBEVP_SIGNATURE\-LMS\fR\|(7)" 4 |
| 223 |
.IX Item "LMS, see EVP_SIGNATURE-LMS" |
| 224 |
.PD |
| 225 |
.SS "Asymmetric Cipher" |
| 226 |
.IX Subsection "Asymmetric Cipher" |
| 227 |
.IP "RSA, see \fBEVP_ASYM_CIPHER\-RSA\fR\|(7)" 4 |
| 228 |
.IX Item "RSA, see EVP_ASYM_CIPHER-RSA" |
| 229 |
.SS "Asymmetric Key Encapsulation" |
| 230 |
.IX Subsection "Asymmetric Key Encapsulation" |
| 231 |
.PD 0 |
| 232 |
.IP "RSA, see \fBEVP_KEM\-RSA\fR\|(7)" 4 |
| 233 |
.IX Item "RSA, see EVP_KEM-RSA" |
| 234 |
.PD |
| 235 |
.SS "Asymmetric Key Management" |
| 236 |
.IX Subsection "Asymmetric Key Management" |
| 237 |
.IP "DH, see \fBEVP_KEYMGMT\-DH\fR\|(7)" 4 |
| 238 |
.IX Item "DH, see EVP_KEYMGMT-DH" |
| 239 |
.PD 0 |
| 240 |
.IP "DHX, see \fBEVP_KEYMGMT\-DHX\fR\|(7)" 4 |
| 241 |
.IX Item "DHX, see EVP_KEYMGMT-DHX" |
| 242 |
.IP "DSA, see \fBEVP_KEYMGMT\-DSA\fR\|(7)" 4 |
| 243 |
.IX Item "DSA, see EVP_KEYMGMT-DSA" |
| 244 |
.IP "RSA, see \fBEVP_KEYMGMT\-RSA\fR\|(7)" 4 |
| 245 |
.IX Item "RSA, see EVP_KEYMGMT-RSA" |
| 246 |
.IP RSA-PSS 4 |
| 247 |
.IX Item "RSA-PSS" |
| 248 |
.IP "EC, see \fBEVP_KEYMGMT\-EC\fR\|(7)" 4 |
| 249 |
.IX Item "EC, see EVP_KEYMGMT-EC" |
| 250 |
.IP "ED25519, see \fBEVP_KEYMGMT\-ED25519\fR\|(7)" 4 |
| 251 |
.IX Item "ED25519, see EVP_KEYMGMT-ED25519" |
| 252 |
.IP "ED448, see \fBEVP_KEYMGMT\-ED448\fR\|(7)" 4 |
| 253 |
.IX Item "ED448, see EVP_KEYMGMT-ED448" |
| 254 |
.IP "X25519, see \fBEVP_KEYMGMT\-X25519\fR\|(7)" 4 |
| 255 |
.IX Item "X25519, see EVP_KEYMGMT-X25519" |
| 256 |
.PD |
| 257 |
This is an unapproved algorithm. |
| 258 |
The FIPS 140\-3 IG states that "Curves that are included in SP 800\-186 but not |
| 259 |
included in SP 800\-56Arev3 are not approved for key agreement". |
| 260 |
.IP "X448, see \fBEVP_KEYMGMT\-X448\fR\|(7)" 4 |
| 261 |
.IX Item "X448, see EVP_KEYMGMT-X448" |
| 262 |
This is an unapproved algorithm. |
| 263 |
The FIPS 140\-3 IG states that "Curves that are included in SP 800\-186 but not" |
| 264 |
included in SP 800\-56Arev3 are not approved for key agreement". |
| 265 |
.IP TLS1\-PRF 4 |
| 266 |
.IX Item "TLS1-PRF" |
| 267 |
.PD 0 |
| 268 |
.IP HKDF 4 |
| 269 |
.IX Item "HKDF" |
| 270 |
.IP "HMAC, see \fBEVP_KEYMGMT\-HMAC\fR\|(7)" 4 |
| 271 |
.IX Item "HMAC, see EVP_KEYMGMT-HMAC" |
| 272 |
.IP "CMAC, see \fBEVP_KEYMGMT\-CMAC\fR\|(7)" 4 |
| 273 |
.IX Item "CMAC, see EVP_KEYMGMT-CMAC" |
| 274 |
.IP "ML\-DSA\-44, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4 |
| 275 |
.IX Item "ML-DSA-44, see EVP_KEYMGMT-ML-DSA" |
| 276 |
.IP "ML\-DSA\-65, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4 |
| 277 |
.IX Item "ML-DSA-65, see EVP_KEYMGMT-ML-DSA" |
| 278 |
.IP "ML\-DSA\-87, see \fBEVP_KEYMGMT\-ML\-DSA\fR\|(7)" 4 |
| 279 |
.IX Item "ML-DSA-87, see EVP_KEYMGMT-ML-DSA" |
| 280 |
.IP "SLH\-DSA\-SHA2\-128s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 281 |
.IX Item "SLH-DSA-SHA2-128s, see EVP_KEYMGMT-SLH-DSA" |
| 282 |
.IP "SLH\-DSA\-SHA2\-128f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 283 |
.IX Item "SLH-DSA-SHA2-128f, see EVP_KEYMGMT-SLH-DSA" |
| 284 |
.IP "SLH\-DSA\-SHA2\-192s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 285 |
.IX Item "SLH-DSA-SHA2-192s, see EVP_KEYMGMT-SLH-DSA" |
| 286 |
.IP "SLH\-DSA\-SHA2\-192f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 287 |
.IX Item "SLH-DSA-SHA2-192f, see EVP_KEYMGMT-SLH-DSA" |
| 288 |
.IP "SLH\-DSA\-SHA2\-256s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 289 |
.IX Item "SLH-DSA-SHA2-256s, see EVP_KEYMGMT-SLH-DSA" |
| 290 |
.IP "SLH\-DSA\-SHA2\-256f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 291 |
.IX Item "SLH-DSA-SHA2-256f, see EVP_KEYMGMT-SLH-DSA" |
| 292 |
.IP "SLH\-DSA\-SHAKE\-128s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 293 |
.IX Item "SLH-DSA-SHAKE-128s, see EVP_KEYMGMT-SLH-DSA" |
| 294 |
.IP "SLH\-DSA\-SHAKE\-128f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 295 |
.IX Item "SLH-DSA-SHAKE-128f, see EVP_KEYMGMT-SLH-DSA" |
| 296 |
.IP "SLH\-DSA\-SHAKE\-192s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 297 |
.IX Item "SLH-DSA-SHAKE-192s, see EVP_KEYMGMT-SLH-DSA" |
| 298 |
.IP "SLH\-DSA\-SHAKE\-192f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 299 |
.IX Item "SLH-DSA-SHAKE-192f, see EVP_KEYMGMT-SLH-DSA" |
| 300 |
.IP "SLH\-DSA\-SHAKE\-256s, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 301 |
.IX Item "SLH-DSA-SHAKE-256s, see EVP_KEYMGMT-SLH-DSA" |
| 302 |
.IP "SLH\-DSA\-SHAKE\-256f, see \fBEVP_KEYMGMT\-SLH\-DSA\fR\|(7)" 4 |
| 303 |
.IX Item "SLH-DSA-SHAKE-256f, see EVP_KEYMGMT-SLH-DSA" |
| 304 |
.PD |
| 305 |
.SS "Random Number Generation" |
| 306 |
.IX Subsection "Random Number Generation" |
| 307 |
.IP "CRNG-TEST, see \fBEVP_RAND\-CRNG\-TEST\fR\|(7)" 4 |
| 308 |
.IX Item "CRNG-TEST, see EVP_RAND-CRNG-TEST" |
| 309 |
.PD 0 |
| 310 |
.IP "CTR-DRBG, see \fBEVP_RAND\-CTR\-DRBG\fR\|(7)" 4 |
| 311 |
.IX Item "CTR-DRBG, see EVP_RAND-CTR-DRBG" |
| 312 |
.IP "HASH-DRBG, see \fBEVP_RAND\-HASH\-DRBG\fR\|(7)" 4 |
| 313 |
.IX Item "HASH-DRBG, see EVP_RAND-HASH-DRBG" |
| 314 |
.IP "HMAC-DRBG, see \fBEVP_RAND\-HMAC\-DRBG\fR\|(7)" 4 |
| 315 |
.IX Item "HMAC-DRBG, see EVP_RAND-HMAC-DRBG" |
| 316 |
.IP "TEST-RAND, see \fBEVP_RAND\-TEST\-RAND\fR\|(7)" 4 |
| 317 |
.IX Item "TEST-RAND, see EVP_RAND-TEST-RAND" |
| 318 |
.PD |
| 319 |
TEST-RAND is an unapproved algorithm. |
| 320 |
.SH "SELF TESTING" |
| 321 |
.IX Header "SELF TESTING" |
| 322 |
A requirement of FIPS modules is to run cryptographic algorithm self tests. |
| 323 |
FIPS 140\-3 requires known answer tests to be run on startup as well as |
| 324 |
conditional tests that run during cryptographic operations. |
| 325 |
.PP |
| 326 |
An optional callback mechanism is available to return information to the user using |
| 327 |
\&\fBOSSL_SELF_TEST_set_callback\fR\|(3). |
| 328 |
.PP |
| 329 |
The parameters passed to the callback are described in \fBOSSL_SELF_TEST_new\fR\|(3) |
| 330 |
.PP |
| 331 |
The OpenSSL FIPS module uses the following mechanism to provide information |
| 332 |
about the self tests as they run. |
| 333 |
This is useful for debugging if a self test is failing. |
| 334 |
The callback also allows forcing any self test to fail, in order to check that |
| 335 |
it operates correctly on failure. |
| 336 |
Note that all self tests run even if a self test failure occurs. |
| 337 |
.PP |
| 338 |
The FIPS module passes the following type(s) to \fBOSSL_SELF_TEST_onbegin()\fR. |
| 339 |
.IP """Module_Integrity"" (\fBOSSL_SELF_TEST_TYPE_MODULE_INTEGRITY\fR)" 4 |
| 340 |
.IX Item """Module_Integrity"" (OSSL_SELF_TEST_TYPE_MODULE_INTEGRITY)" |
| 341 |
Uses HMAC SHA256 on the module file to validate that the module has not been |
| 342 |
modified. The integrity value is compared to a value written to a configuration |
| 343 |
file during installation. |
| 344 |
.IP """KAT_Integrity"" (\fBOSSL_SELF_TEST_TYPE_KAT_INTEGRITY\fR)" 4 |
| 345 |
.IX Item """KAT_Integrity"" (OSSL_SELF_TEST_TYPE_KAT_INTEGRITY)" |
| 346 |
Used during the Module Integrity test to perform a known answer test on |
| 347 |
HMAC SHA256 prior to using it. |
| 348 |
.IP """KAT_Cipher"" (\fBOSSL_SELF_TEST_TYPE_KAT_CIPHER\fR)" 4 |
| 349 |
.IX Item """KAT_Cipher"" (OSSL_SELF_TEST_TYPE_KAT_CIPHER)" |
| 350 |
Known answer test for a symmetric cipher. |
| 351 |
.IP """KAT_AsymmetricCipher"" (\fBOSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER\fR)" 4 |
| 352 |
.IX Item """KAT_AsymmetricCipher"" (OSSL_SELF_TEST_TYPE_KAT_ASYM_CIPHER)" |
| 353 |
Known answer test for a asymmetric cipher. |
| 354 |
.IP """KAT_Digest"" (\fBOSSL_SELF_TEST_TYPE_KAT_DIGEST\fR)" 4 |
| 355 |
.IX Item """KAT_Digest"" (OSSL_SELF_TEST_TYPE_KAT_DIGEST)" |
| 356 |
Known answer test for a digest. |
| 357 |
.IP """KAT_AsymmetricKeyGeneration"" (\fBOSSL_SELF_TEST_TYPE_KAT_ASYM_KEYGEN\fR)" 4 |
| 358 |
.IX Item """KAT_AsymmetricKeyGeneration"" (OSSL_SELF_TEST_TYPE_KAT_ASYM_KEYGEN)" |
| 359 |
Known answer test for asymmetric key generation. |
| 360 |
.IP """KAT_Signature"" (\fBOSSL_SELF_TEST_TYPE_KAT_SIGNATURE\fR)" 4 |
| 361 |
.IX Item """KAT_Signature"" (OSSL_SELF_TEST_TYPE_KAT_SIGNATURE)" |
| 362 |
Known answer test for a signature. |
| 363 |
.IP """PCT_Signature"" (\fBOSSL_SELF_TEST_TYPE_PCT_SIGNATURE\fR)" 4 |
| 364 |
.IX Item """PCT_Signature"" (OSSL_SELF_TEST_TYPE_PCT_SIGNATURE)" |
| 365 |
Pairwise Consistency check for a signature. |
| 366 |
.IP """KAT_KDF"" (\fBOSSL_SELF_TEST_TYPE_KAT_KDF\fR)" 4 |
| 367 |
.IX Item """KAT_KDF"" (OSSL_SELF_TEST_TYPE_KAT_KDF)" |
| 368 |
Known answer test for a key derivation function. |
| 369 |
.IP """KAT_KA"" (\fBOSSL_SELF_TEST_TYPE_KAT_KA\fR)" 4 |
| 370 |
.IX Item """KAT_KA"" (OSSL_SELF_TEST_TYPE_KAT_KA)" |
| 371 |
Known answer test for key agreement. |
| 372 |
.IP """KAT_KEM"" (\fBOSSL_SELF_TEST_TYPE_KAT_KEM\fR)" 4 |
| 373 |
.IX Item """KAT_KEM"" (OSSL_SELF_TEST_TYPE_KAT_KEM)" |
| 374 |
Known answer test for key encapsulation. |
| 375 |
.IP """DRBG"" (\fBOSSL_SELF_TEST_TYPE_DRBG\fR)" 4 |
| 376 |
.IX Item """DRBG"" (OSSL_SELF_TEST_TYPE_DRBG)" |
| 377 |
Known answer test for a Deterministic Random Bit Generator. |
| 378 |
.IP """Conditional_PCT"" (\fBOSSL_SELF_TEST_TYPE_PCT\fR)" 4 |
| 379 |
.IX Item """Conditional_PCT"" (OSSL_SELF_TEST_TYPE_PCT)" |
| 380 |
Conditional test that is run during the generation of key pairs. |
| 381 |
.IP """Import_PCT"" (\fBOSSL_SELF_TEST_TYPE_PCT_IMPORT\fR)" 4 |
| 382 |
.IX Item """Import_PCT"" (OSSL_SELF_TEST_TYPE_PCT_IMPORT)" |
| 383 |
Conditional test that is run during the import of key pairs. |
| 384 |
.IP """Conditional_KAT"" (\fBOSSL_SELF_TEST_TYPE_PCT_KAT\fR)" 4 |
| 385 |
.IX Item """Conditional_KAT"" (OSSL_SELF_TEST_TYPE_PCT_KAT)" |
| 386 |
Conditional test run during generation that derive the public key from the |
| 387 |
private key and checks that the public key matches. This is a SP 800\-56A requirement. |
| 388 |
.IP """Continuous_RNG_Test"" (\fBOSSL_SELF_TEST_TYPE_CRNG\fR)" 4 |
| 389 |
.IX Item """Continuous_RNG_Test"" (OSSL_SELF_TEST_TYPE_CRNG)" |
| 390 |
Continuous random number generator test. |
| 391 |
.IP """Install_Integrity"" (\fBOSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY\fR)" 4 |
| 392 |
.IX Item """Install_Integrity"" (OSSL_SELF_TEST_TYPE_INSTALL_INTEGRITY)" |
| 393 |
This is deprecated. The option is no longer used since FIPS 140\-3 requires |
| 394 |
self tests to always run on startup. Previous FIPS 140\-2 validations allowed |
| 395 |
the self tests to be run just once. |
| 396 |
.PP |
| 397 |
The FIPS module passes the following descriptions(s) to \fBOSSL_SELF_TEST_onbegin()\fR. |
| 398 |
.IP """HMAC"" (\fBOSSL_SELF_TEST_DESC_INTEGRITY_HMAC\fR)" 4 |
| 399 |
.IX Item """HMAC"" (OSSL_SELF_TEST_DESC_INTEGRITY_HMAC)" |
| 400 |
"Module_Integrity" uses this. |
| 401 |
.IP """RSA"" (\fBOSSL_SELF_TEST_DESC_PCT_RSA_PKCS1\fR)" 4 |
| 402 |
.IX Item """RSA"" (OSSL_SELF_TEST_DESC_PCT_RSA_PKCS1)" |
| 403 |
.PD 0 |
| 404 |
.IP """RSA"" (\fBOSSL_SELF_TEST_DESC_PCT_RSA\fR)" 4 |
| 405 |
.IX Item """RSA"" (OSSL_SELF_TEST_DESC_PCT_RSA)" |
| 406 |
.IP """ECDSA"" (\fBOSSL_SELF_TEST_DESC_PCT_ECDSA\fR)" 4 |
| 407 |
.IX Item """ECDSA"" (OSSL_SELF_TEST_DESC_PCT_ECDSA)" |
| 408 |
.IP """EDDSA"" (\fBOSSL_SELF_TEST_DESC_PCT_EDDSA\fR)" 4 |
| 409 |
.IX Item """EDDSA"" (OSSL_SELF_TEST_DESC_PCT_EDDSA)" |
| 410 |
.IP """DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_DSA\fR)" 4 |
| 411 |
.IX Item """DSA"" (OSSL_SELF_TEST_DESC_PCT_DSA)" |
| 412 |
.IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_ML_DSA\fR)" 4 |
| 413 |
.IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_PCT_ML_DSA)" |
| 414 |
.IP """ML-KEM"" (\fBOSSL_SELF_TEST_DESC_PCT_ML_KEM\fR)" 4 |
| 415 |
.IX Item """ML-KEM"" (OSSL_SELF_TEST_DESC_PCT_ML_KEM)" |
| 416 |
.IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_PCT_SLH_DSA\fR)" 4 |
| 417 |
.IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_PCT_SLH_DSA)" |
| 418 |
.PD |
| 419 |
Key generation tests used with the "Pairwise_Consistency_Test" type. |
| 420 |
.IP """RSA_Encrypt"" (\fBOSSL_SELF_TEST_DESC_ASYM_RSA_ENC\fR)" 4 |
| 421 |
.IX Item """RSA_Encrypt"" (OSSL_SELF_TEST_DESC_ASYM_RSA_ENC)" |
| 422 |
.PD 0 |
| 423 |
.IP """RSA_Decrypt"" (\fBOSSL_SELF_TEST_DESC_ASYM_RSA_DEC\fR)" 4 |
| 424 |
.IX Item """RSA_Decrypt"" (OSSL_SELF_TEST_DESC_ASYM_RSA_DEC)" |
| 425 |
.PD |
| 426 |
"KAT_AsymmetricCipher" uses this to indicate an encrypt or decrypt KAT. |
| 427 |
.IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_ML_DSA\fR)" 4 |
| 428 |
.IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_KEYGEN_ML_DSA)" |
| 429 |
.PD 0 |
| 430 |
.IP """ML-KEM"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_ML_KEM\fR)" 4 |
| 431 |
.IX Item """ML-KEM"" (OSSL_SELF_TEST_DESC_KEYGEN_ML_KEM)" |
| 432 |
.IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_KEYGEN_SLH_DSA\fR)" 4 |
| 433 |
.IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_KEYGEN_SLH_DSA)" |
| 434 |
.PD |
| 435 |
"KAT_AsymmetricKeyGeneration" uses this to indicate a key generation KAT. |
| 436 |
.IP """AES_GCM"" (\fBOSSL_SELF_TEST_DESC_CIPHER_AES_GCM\fR)" 4 |
| 437 |
.IX Item """AES_GCM"" (OSSL_SELF_TEST_DESC_CIPHER_AES_GCM)" |
| 438 |
.PD 0 |
| 439 |
.IP """AES_ECB_Decrypt"" (\fBOSSL_SELF_TEST_DESC_CIPHER_AES_ECB\fR)" 4 |
| 440 |
.IX Item """AES_ECB_Decrypt"" (OSSL_SELF_TEST_DESC_CIPHER_AES_ECB)" |
| 441 |
.IP """TDES"" (\fBOSSL_SELF_TEST_DESC_CIPHER_TDES\fR)" 4 |
| 442 |
.IX Item """TDES"" (OSSL_SELF_TEST_DESC_CIPHER_TDES)" |
| 443 |
.PD |
| 444 |
Symmetric cipher tests used with the "KAT_Cipher" type. |
| 445 |
.IP """SHA1"" (\fBOSSL_SELF_TEST_DESC_MD_SHA1\fR)" 4 |
| 446 |
.IX Item """SHA1"" (OSSL_SELF_TEST_DESC_MD_SHA1)" |
| 447 |
.PD 0 |
| 448 |
.IP """SHA2"" (\fBOSSL_SELF_TEST_DESC_MD_SHA2\fR)" 4 |
| 449 |
.IX Item """SHA2"" (OSSL_SELF_TEST_DESC_MD_SHA2)" |
| 450 |
.IP """SHA3"" (\fBOSSL_SELF_TEST_DESC_MD_SHA3\fR)" 4 |
| 451 |
.IX Item """SHA3"" (OSSL_SELF_TEST_DESC_MD_SHA3)" |
| 452 |
.PD |
| 453 |
Digest tests used with the "KAT_Digest" type. |
| 454 |
.IP """DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_DSA\fR)" 4 |
| 455 |
.IX Item """DSA"" (OSSL_SELF_TEST_DESC_SIGN_DSA)" |
| 456 |
.PD 0 |
| 457 |
.IP """RSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_RSA\fR)" 4 |
| 458 |
.IX Item """RSA"" (OSSL_SELF_TEST_DESC_SIGN_RSA)" |
| 459 |
.IP """ECDSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_ECDSA\fR)" 4 |
| 460 |
.IX Item """ECDSA"" (OSSL_SELF_TEST_DESC_SIGN_ECDSA)" |
| 461 |
.IP """DetECDSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_DetECDSA\fR)" 4 |
| 462 |
.IX Item """DetECDSA"" (OSSL_SELF_TEST_DESC_SIGN_DetECDSA)" |
| 463 |
.IP """EDDSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_EDDSA\fR)" 4 |
| 464 |
.IX Item """EDDSA"" (OSSL_SELF_TEST_DESC_SIGN_EDDSA)" |
| 465 |
.IP """LMS"" (\fBOSSL_SELF_TEST_DESC_SIGN_LMS\fR)" 4 |
| 466 |
.IX Item """LMS"" (OSSL_SELF_TEST_DESC_SIGN_LMS)" |
| 467 |
.IP """ML-DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_ML_DSA\fR)" 4 |
| 468 |
.IX Item """ML-DSA"" (OSSL_SELF_TEST_DESC_SIGN_ML_DSA)" |
| 469 |
.IP """SLH-DSA"" (\fBOSSL_SELF_TEST_DESC_SIGN_SLH_DSA\fR)" 4 |
| 470 |
.IX Item """SLH-DSA"" (OSSL_SELF_TEST_DESC_SIGN_SLH_DSA)" |
| 471 |
.PD |
| 472 |
Signature tests used with the "KAT_Signature" type. |
| 473 |
.IP """ECDH"" (\fBOSSL_SELF_TEST_DESC_KA_ECDH\fR)" 4 |
| 474 |
.IX Item """ECDH"" (OSSL_SELF_TEST_DESC_KA_ECDH)" |
| 475 |
.PD 0 |
| 476 |
.IP """DH"" (\fBOSSL_SELF_TEST_DESC_KA_DH\fR)" 4 |
| 477 |
.IX Item """DH"" (OSSL_SELF_TEST_DESC_KA_DH)" |
| 478 |
.PD |
| 479 |
Key agreement tests used with the "KAT_KA" type. |
| 480 |
.IP """HKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_HKDF\fR)" 4 |
| 481 |
.IX Item """HKDF"" (OSSL_SELF_TEST_DESC_KDF_HKDF)" |
| 482 |
.PD 0 |
| 483 |
.IP """TLS13_KDF_EXTRACT"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT\fR)" 4 |
| 484 |
.IX Item """TLS13_KDF_EXTRACT"" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXTRACT)" |
| 485 |
.IP """TLS13_KDF_EXPAND"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND\fR)" 4 |
| 486 |
.IX Item """TLS13_KDF_EXPAND"" (OSSL_SELF_TEST_DESC_KDF_TLS13_EXPAND)" |
| 487 |
.IP """SSKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_SSKDF\fR)" 4 |
| 488 |
.IX Item """SSKDF"" (OSSL_SELF_TEST_DESC_KDF_SSKDF)" |
| 489 |
.IP """X963KDF"" (\fBOSSL_SELF_TEST_DESC_KDF_X963KDF\fR)" 4 |
| 490 |
.IX Item """X963KDF"" (OSSL_SELF_TEST_DESC_KDF_X963KDF)" |
| 491 |
.IP """X942KDF"" (\fBOSSL_SELF_TEST_DESC_KDF_X942KDF\fR)" 4 |
| 492 |
.IX Item """X942KDF"" (OSSL_SELF_TEST_DESC_KDF_X942KDF)" |
| 493 |
.IP """PBKDF2"" (\fBOSSL_SELF_TEST_DESC_KDF_PBKDF2\fR)" 4 |
| 494 |
.IX Item """PBKDF2"" (OSSL_SELF_TEST_DESC_KDF_PBKDF2)" |
| 495 |
.IP """SSHKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_SSHKDF\fR)" 4 |
| 496 |
.IX Item """SSHKDF"" (OSSL_SELF_TEST_DESC_KDF_SSHKDF)" |
| 497 |
.IP """TLS12_PRF"" (\fBOSSL_SELF_TEST_DESC_KDF_TLS12_PRF\fR)" 4 |
| 498 |
.IX Item """TLS12_PRF"" (OSSL_SELF_TEST_DESC_KDF_TLS12_PRF)" |
| 499 |
.IP """KBKDF"" (\fBOSSL_SELF_TEST_DESC_KDF_KBKDF\fR)" 4 |
| 500 |
.IX Item """KBKDF"" (OSSL_SELF_TEST_DESC_KDF_KBKDF)" |
| 501 |
.PD |
| 502 |
Key Encapsulation Function tests used with the "KAT_KEM" type. |
| 503 |
.IP """KEM_Encap"" (\fBOSSL_SELF_TEST_DESC_ENCAP_KEM\fR)" 4 |
| 504 |
.IX Item """KEM_Encap"" (OSSL_SELF_TEST_DESC_ENCAP_KEM)" |
| 505 |
.PD 0 |
| 506 |
.IP """KEM_Decap"" (\fBOSSL_SELF_TEST_DESC_DECAP_KEM\fR)" 4 |
| 507 |
.IX Item """KEM_Decap"" (OSSL_SELF_TEST_DESC_DECAP_KEM)" |
| 508 |
.IP """KEM_Decap_Reject"" (\fBOSSL_SELF_TEST_DESC_DECAP_REJ_KEM\fR)" 4 |
| 509 |
.IX Item """KEM_Decap_Reject"" (OSSL_SELF_TEST_DESC_DECAP_REJ_KEM)" |
| 510 |
.PD |
| 511 |
Key Derivation Function tests used with the "KAT_KDF" type. |
| 512 |
.IP """CTR"" (\fBOSSL_SELF_TEST_DESC_DRBG_CTR\fR)" 4 |
| 513 |
.IX Item """CTR"" (OSSL_SELF_TEST_DESC_DRBG_CTR)" |
| 514 |
.PD 0 |
| 515 |
.IP """HASH"" (\fBOSSL_SELF_TEST_DESC_DRBG_HASH\fR)" 4 |
| 516 |
.IX Item """HASH"" (OSSL_SELF_TEST_DESC_DRBG_HASH)" |
| 517 |
.IP """HMAC"" (\fBOSSL_SELF_TEST_DESC_DRBG_HMAC\fR)" 4 |
| 518 |
.IX Item """HMAC"" (OSSL_SELF_TEST_DESC_DRBG_HMAC)" |
| 519 |
.PD |
| 520 |
DRBG tests used with the "DRBG" type. |
| 521 |
.IP """RNG"" (\fBOSSL_SELF_TEST_DESC_RNG\fR)" 4 |
| 522 |
.IX Item """RNG"" (OSSL_SELF_TEST_DESC_RNG)" |
| 523 |
"Continuous_RNG_Test" uses this. |
| 524 |
.SH EXAMPLES |
| 525 |
.IX Header "EXAMPLES" |
| 526 |
A simple self test callback is shown below for illustrative purposes. |
| 527 |
.PP |
| 528 |
.Vb 1 |
| 529 |
\& #include <openssl/self_test.h> |
| 530 |
\& |
| 531 |
\& static OSSL_CALLBACK self_test_cb; |
| 532 |
\& |
| 533 |
\& static int self_test_cb(const OSSL_PARAM params[], void *arg) |
| 534 |
\& { |
| 535 |
\& int ret = 0; |
| 536 |
\& const OSSL_PARAM *p = NULL; |
| 537 |
\& const char *phase = NULL, *type = NULL, *desc = NULL; |
| 538 |
\& |
| 539 |
\& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_PHASE); |
| 540 |
\& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING) |
| 541 |
\& goto err; |
| 542 |
\& phase = (const char *)p\->data; |
| 543 |
\& |
| 544 |
\& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_DESC); |
| 545 |
\& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING) |
| 546 |
\& goto err; |
| 547 |
\& desc = (const char *)p\->data; |
| 548 |
\& |
| 549 |
\& p = OSSL_PARAM_locate_const(params, OSSL_PROV_PARAM_SELF_TEST_TYPE); |
| 550 |
\& if (p == NULL || p\->data_type != OSSL_PARAM_UTF8_STRING) |
| 551 |
\& goto err; |
| 552 |
\& type = (const char *)p\->data; |
| 553 |
\& |
| 554 |
\& /* Do some logging */ |
| 555 |
\& if (strcmp(phase, OSSL_SELF_TEST_PHASE_START) == 0) |
| 556 |
\& BIO_printf(bio_out, "%s : (%s) : ", desc, type); |
| 557 |
\& if (strcmp(phase, OSSL_SELF_TEST_PHASE_PASS) == 0 |
| 558 |
\& || strcmp(phase, OSSL_SELF_TEST_PHASE_FAIL) == 0) |
| 559 |
\& BIO_printf(bio_out, "%s\en", phase); |
| 560 |
\& |
| 561 |
\& /* Corrupt the SHA1 self test during the \*(Aqcorrupt\*(Aq phase by returning 0 */ |
| 562 |
\& if (strcmp(phase, OSSL_SELF_TEST_PHASE_CORRUPT) == 0 |
| 563 |
\& && strcmp(desc, OSSL_SELF_TEST_DESC_MD_SHA1) == 0) { |
| 564 |
\& BIO_printf(bio_out, "%s %s", phase, desc); |
| 565 |
\& return 0; |
| 566 |
\& } |
| 567 |
\& ret = 1; |
| 568 |
\& err: |
| 569 |
\& return ret; |
| 570 |
\& } |
| 571 |
.Ve |
| 572 |
.SH NOTES |
| 573 |
.IX Header "NOTES" |
| 574 |
Some released versions of OpenSSL do not include a validated |
| 575 |
FIPS provider. To determine which versions have undergone |
| 576 |
the validation process, please refer to the |
| 577 |
OpenSSL Downloads page <https://www.openssl.org/source/>. If you |
| 578 |
require FIPS-approved functionality, it is essential to build your FIPS |
| 579 |
provider using one of the validated versions listed there. Normally, |
| 580 |
it is possible to utilize a FIPS provider constructed from one of the |
| 581 |
validated versions alongside \fIlibcrypto\fR and \fIlibssl\fR compiled from any |
| 582 |
release within the same major release series. This flexibility enables |
| 583 |
you to address bug fixes and CVEs that fall outside the FIPS boundary. |
| 584 |
.PP |
| 585 |
You can load the FIPS provider into multiple library contexts as any other |
| 586 |
provider. However the following restriction applies. The FIPS provider cannot |
| 587 |
be used by multiple copies of OpenSSL libcrypto in a single process. |
| 588 |
.PP |
| 589 |
As the provider saves core callbacks to the libcrypto obtained in the |
| 590 |
\&\fBOSSL_provider_init()\fR call to global data it will fail if subsequent |
| 591 |
invocations of its \fBOSSL_provider_init()\fR function yield different addresses |
| 592 |
of these callbacks than in the initial call. This happens when different |
| 593 |
copies of libcrypto are present in the memory of the process and both try |
| 594 |
to load the same FIPS provider. A workaround is to have a different copy |
| 595 |
of the FIPS provider loaded for each of the libcrypto instances in the |
| 596 |
process. |
| 597 |
.SH "SEE ALSO" |
| 598 |
.IX Header "SEE ALSO" |
| 599 |
\&\fBopenssl\-fipsinstall\fR\|(1), |
| 600 |
\&\fBfips_config\fR\|(5), |
| 601 |
\&\fBOSSL_SELF_TEST_set_callback\fR\|(3), |
| 602 |
\&\fBOSSL_SELF_TEST_new\fR\|(3), |
| 603 |
\&\fBOSSL_PARAM\fR\|(3), |
| 604 |
\&\fBopenssl\-core.h\fR\|(7), |
| 605 |
\&\fBopenssl\-core_dispatch.h\fR\|(7), |
| 606 |
\&\fBprovider\fR\|(7), |
| 607 |
<https://www.openssl.org/source/> |
| 608 |
.SH HISTORY |
| 609 |
.IX Header "HISTORY" |
| 610 |
The HKDF\-SHA256, HKDF\-SHA384 and HKDF\-SHA512 algorithms were added in OpenSSL 3.6. |
| 611 |
.PP |
| 612 |
All other functionality was added in OpenSSL 3.0. |
| 613 |
.SH COPYRIGHT |
| 614 |
.IX Header "COPYRIGHT" |
| 615 |
Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 616 |
.PP |
| 617 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 618 |
this file except in compliance with the License. You can obtain a copy |
| 619 |
in the file LICENSE in the source distribution or at |
| 620 |
<https://www.openssl.org/source/license.html>. |