| 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 "OPENSSL-FIPSINSTALL 1SSL" |
| 58 |
.TH OPENSSL-FIPSINSTALL 1SSL 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 |
openssl\-fipsinstall \- perform FIPS configuration installation |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBopenssl fipsinstall\fR |
| 68 |
[\fB\-help\fR] |
| 69 |
[\fB\-in\fR \fIconfigfilename\fR] |
| 70 |
[\fB\-out\fR \fIconfigfilename\fR] |
| 71 |
[\fB\-module\fR \fImodulefilename\fR] |
| 72 |
[\fB\-provider_name\fR \fIprovidername\fR] |
| 73 |
[\fB\-section_name\fR \fIsectionname\fR] |
| 74 |
[\fB\-verify\fR] |
| 75 |
[\fB\-mac_name\fR \fImacname\fR] |
| 76 |
[\fB\-macopt\fR \fInm\fR:\fIv\fR] |
| 77 |
[\fB\-noout\fR] |
| 78 |
[\fB\-quiet\fR] |
| 79 |
[\fB\-pedantic\fR] |
| 80 |
[\fB\-no_conditional_errors\fR] |
| 81 |
[\fB\-no_security_checks\fR] |
| 82 |
[\fB\-hmac_key_check\fR] |
| 83 |
[\fB\-kmac_key_check\fR] |
| 84 |
[\fB\-ems_check\fR] |
| 85 |
[\fB\-no_drbg_truncated_digests\fR] |
| 86 |
[\fB\-signature_digest_check\fR] |
| 87 |
[\fB\-hkdf_digest_check\fR] |
| 88 |
[\fB\-tls13_kdf_digest_check\fR] |
| 89 |
[\fB\-tls1_prf_digest_check\fR] |
| 90 |
[\fB\-sshkdf_digest_check\fR] |
| 91 |
[\fB\-sskdf_digest_check\fR] |
| 92 |
[\fB\-x963kdf_digest_check\fR] |
| 93 |
[\fB\-dsa_sign_disabled\fR] |
| 94 |
[\fB\-no_pbkdf2_lower_bound_check\fR] |
| 95 |
[\fB\-no_short_mac\fR] |
| 96 |
[\fB\-tdes_encrypt_disabled\fR] |
| 97 |
[\fB\-rsa_pkcs15_padding_disabled\fR] |
| 98 |
[\fB\-rsa_pss_saltlen_check\fR] |
| 99 |
[\fB\-rsa_sign_x931_disabled\fR] |
| 100 |
[\fB\-hkdf_key_check\fR] |
| 101 |
[\fB\-kbkdf_key_check\fR] |
| 102 |
[\fB\-tls13_kdf_key_check\fR] |
| 103 |
[\fB\-tls1_prf_key_check\fR] |
| 104 |
[\fB\-sshkdf_key_check\fR] |
| 105 |
[\fB\-sskdf_key_check\fR] |
| 106 |
[\fB\-x963kdf_key_check\fR] |
| 107 |
[\fB\-x942kdf_key_check\fR] |
| 108 |
[\fB\-ecdh_cofactor_check\fR] |
| 109 |
[\fB\-self_test_onload\fR] |
| 110 |
[\fB\-self_test_oninstall\fR] |
| 111 |
[\fB\-corrupt_desc\fR \fIselftest_description\fR] |
| 112 |
[\fB\-corrupt_type\fR \fIselftest_type\fR] |
| 113 |
[\fB\-config\fR \fIparent_config\fR] |
| 114 |
.SH DESCRIPTION |
| 115 |
.IX Header "DESCRIPTION" |
| 116 |
This command is used to generate a FIPS module configuration file. |
| 117 |
This configuration file can be used each time a FIPS module is loaded |
| 118 |
in order to pass data to the FIPS module self tests. The FIPS module always |
| 119 |
verifies its MAC, but optionally only needs to run the KAT's once, |
| 120 |
at installation. |
| 121 |
.PP |
| 122 |
The generated configuration file consists of: |
| 123 |
.IP "\- A MAC of the FIPS module file." 4 |
| 124 |
.IX Item "- A MAC of the FIPS module file." |
| 125 |
.PD 0 |
| 126 |
.IP "\- A test status indicator." 4 |
| 127 |
.IX Item "- A test status indicator." |
| 128 |
.PD |
| 129 |
This indicates if the Known Answer Self Tests (KAT's) have successfully run. |
| 130 |
.IP "\- A MAC of the status indicator." 4 |
| 131 |
.IX Item "- A MAC of the status indicator." |
| 132 |
.PD 0 |
| 133 |
.IP "\- A control for conditional self tests errors." 4 |
| 134 |
.IX Item "- A control for conditional self tests errors." |
| 135 |
.PD |
| 136 |
By default if a continuous test (e.g a key pair test) fails then the FIPS module |
| 137 |
will enter an error state, and no services or cryptographic algorithms will be |
| 138 |
able to be accessed after this point. |
| 139 |
The default value of '1' will cause the fips module error state to be entered. |
| 140 |
If the value is '0' then the module error state will not be entered. |
| 141 |
Regardless of whether the error state is entered or not, the current operation |
| 142 |
(e.g. key generation) will return an error. The user is responsible for retrying |
| 143 |
the operation if the module error state is not entered. |
| 144 |
.IP "\- A control to indicate whether run-time security checks are done." 4 |
| 145 |
.IX Item "- A control to indicate whether run-time security checks are done." |
| 146 |
This indicates if run-time checks related to enforcement of security parameters |
| 147 |
such as minimum security strength of keys and approved curve names are used. |
| 148 |
The default value of '1' will perform the checks. |
| 149 |
If the value is '0' the checks are not performed and FIPS compliance must |
| 150 |
be done by procedures documented in the relevant Security Policy. |
| 151 |
.PP |
| 152 |
This file is described in \fBfips_config\fR\|(5). |
| 153 |
.SH OPTIONS |
| 154 |
.IX Header "OPTIONS" |
| 155 |
.IP \fB\-help\fR 4 |
| 156 |
.IX Item "-help" |
| 157 |
Print a usage message. |
| 158 |
.IP "\fB\-module\fR \fIfilename\fR" 4 |
| 159 |
.IX Item "-module filename" |
| 160 |
Filename of the FIPS module to perform an integrity check on. |
| 161 |
The path provided in the filename is used to load the module when it is |
| 162 |
activated, and this overrides the environment variable \fBOPENSSL_MODULES\fR. |
| 163 |
.IP "\fB\-out\fR \fIconfigfilename\fR" 4 |
| 164 |
.IX Item "-out configfilename" |
| 165 |
Filename to output the configuration data to; the default is standard output. |
| 166 |
.IP "\fB\-in\fR \fIconfigfilename\fR" 4 |
| 167 |
.IX Item "-in configfilename" |
| 168 |
Input filename to load configuration data from. |
| 169 |
Must be used if the \fB\-verify\fR option is specified. |
| 170 |
.IP \fB\-verify\fR 4 |
| 171 |
.IX Item "-verify" |
| 172 |
Verify that the input configuration file contains the correct information. |
| 173 |
.IP "\fB\-provider_name\fR \fIprovidername\fR" 4 |
| 174 |
.IX Item "-provider_name providername" |
| 175 |
Name of the provider inside the configuration file. |
| 176 |
The default value is \f(CW\*(C`fips\*(C'\fR. |
| 177 |
.IP "\fB\-section_name\fR \fIsectionname\fR" 4 |
| 178 |
.IX Item "-section_name sectionname" |
| 179 |
Name of the section inside the configuration file. |
| 180 |
The default value is \f(CW\*(C`fips_sect\*(C'\fR. |
| 181 |
.IP "\fB\-mac_name\fR \fIname\fR" 4 |
| 182 |
.IX Item "-mac_name name" |
| 183 |
Specifies the name of a supported MAC algorithm which will be used. |
| 184 |
The MAC mechanisms that are available will depend on the options |
| 185 |
used when building OpenSSL. |
| 186 |
To see the list of supported MAC's use the command |
| 187 |
\&\f(CW\*(C`openssl list \-mac\-algorithms\*(C'\fR. The default is \fBHMAC\fR. |
| 188 |
.IP "\fB\-macopt\fR \fInm\fR:\fIv\fR" 4 |
| 189 |
.IX Item "-macopt nm:v" |
| 190 |
Passes options to the MAC algorithm. |
| 191 |
A comprehensive list of controls can be found in the EVP_MAC implementation |
| 192 |
documentation. |
| 193 |
Common control strings used for this command are: |
| 194 |
.RS 4 |
| 195 |
.IP \fBkey\fR:\fIstring\fR 4 |
| 196 |
.IX Item "key:string" |
| 197 |
Specifies the MAC key as an alphanumeric string (use if the key contains |
| 198 |
printable characters only). |
| 199 |
The string length must conform to any restrictions of the MAC algorithm. |
| 200 |
A key must be specified for every MAC algorithm. |
| 201 |
If no key is provided, the default that was specified when OpenSSL was |
| 202 |
configured is used. |
| 203 |
.IP \fBhexkey\fR:\fIstring\fR 4 |
| 204 |
.IX Item "hexkey:string" |
| 205 |
Specifies the MAC key in hexadecimal form (two hex digits per byte). |
| 206 |
The key length must conform to any restrictions of the MAC algorithm. |
| 207 |
A key must be specified for every MAC algorithm. |
| 208 |
If no key is provided, the default that was specified when OpenSSL was |
| 209 |
configured is used. |
| 210 |
.IP \fBdigest\fR:\fIstring\fR 4 |
| 211 |
.IX Item "digest:string" |
| 212 |
Used by HMAC as an alphanumeric string (use if the key contains printable |
| 213 |
characters only). |
| 214 |
The string length must conform to any restrictions of the MAC algorithm. |
| 215 |
To see the list of supported digests, use the command |
| 216 |
\&\f(CW\*(C`openssl list \-digest\-commands\*(C'\fR. |
| 217 |
The default digest is SHA\-256. |
| 218 |
.RE |
| 219 |
.RS 4 |
| 220 |
.RE |
| 221 |
.IP \fB\-noout\fR 4 |
| 222 |
.IX Item "-noout" |
| 223 |
Disable logging of the self tests. |
| 224 |
.IP \fB\-pedantic\fR 4 |
| 225 |
.IX Item "-pedantic" |
| 226 |
Configure the module so that it is strictly FIPS compliant rather |
| 227 |
than being backwards compatible. This enables conditional errors, |
| 228 |
security checks etc. Note that any previous configuration options will |
| 229 |
be overwritten and any subsequent configuration options that violate |
| 230 |
FIPS compliance will result in an error. |
| 231 |
.IP \fB\-no_conditional_errors\fR 4 |
| 232 |
.IX Item "-no_conditional_errors" |
| 233 |
Configure the module to not enter an error state if a conditional self test |
| 234 |
fails as described above. |
| 235 |
.IP \fB\-no_security_checks\fR 4 |
| 236 |
.IX Item "-no_security_checks" |
| 237 |
Configure the module to not perform run-time security checks as described above. |
| 238 |
.Sp |
| 239 |
Enabling the configuration option "no-fips-securitychecks" provides another way to |
| 240 |
turn off the check at compile time. |
| 241 |
.IP \fB\-ems_check\fR 4 |
| 242 |
.IX Item "-ems_check" |
| 243 |
Configure the module to enable a run-time Extended Master Secret (EMS) check |
| 244 |
when using the TLS1_PRF KDF algorithm. This check is disabled by default. |
| 245 |
See RFC 7627 for information related to EMS. |
| 246 |
.IP \fB\-no_short_mac\fR 4 |
| 247 |
.IX Item "-no_short_mac" |
| 248 |
Configure the module to not allow short MAC outputs. |
| 249 |
See SP 800\-185 8.4.2 and FIPS 140\-3 ID C.D for details. |
| 250 |
.IP \fB\-hmac_key_check\fR 4 |
| 251 |
.IX Item "-hmac_key_check" |
| 252 |
Configure the module to not allow small keys sizes when using HMAC. |
| 253 |
See SP 800\-131Ar2 for details. |
| 254 |
.IP \fB\-kmac_key_check\fR 4 |
| 255 |
.IX Item "-kmac_key_check" |
| 256 |
Configure the module to not allow small keys sizes when using KMAC. |
| 257 |
See SP 800\-131Ar2 for details. |
| 258 |
.IP \fB\-no_drbg_truncated_digests\fR 4 |
| 259 |
.IX Item "-no_drbg_truncated_digests" |
| 260 |
Configure the module to not allow truncated digests to be used with Hash and |
| 261 |
HMAC DRBGs. See FIPS 140\-3 IG D.R for details. |
| 262 |
.IP \fB\-signature_digest_check\fR 4 |
| 263 |
.IX Item "-signature_digest_check" |
| 264 |
Configure the module to enforce signature algorithms to use digests that are |
| 265 |
explicitly permitted by the various standards. |
| 266 |
.IP \fB\-hkdf_digest_check\fR 4 |
| 267 |
.IX Item "-hkdf_digest_check" |
| 268 |
This option is deprecated. |
| 269 |
.IP \fB\-tls13_kdf_digest_check\fR 4 |
| 270 |
.IX Item "-tls13_kdf_digest_check" |
| 271 |
Configure the module to enable a run-time digest check when deriving a key by |
| 272 |
TLS13 KDF. |
| 273 |
See RFC 8446 for details. |
| 274 |
.IP \fB\-tls1_prf_digest_check\fR 4 |
| 275 |
.IX Item "-tls1_prf_digest_check" |
| 276 |
Configure the module to enable a run-time digest check when deriving a key by |
| 277 |
TLS_PRF. |
| 278 |
See NIST SP 800\-135r1 for details. |
| 279 |
.IP \fB\-sshkdf_digest_check\fR 4 |
| 280 |
.IX Item "-sshkdf_digest_check" |
| 281 |
Configure the module to enable a run-time digest check when deriving a key by |
| 282 |
SSHKDF. |
| 283 |
See NIST SP 800\-135r1 for details. |
| 284 |
.IP \fB\-sskdf_digest_check\fR 4 |
| 285 |
.IX Item "-sskdf_digest_check" |
| 286 |
This option is deprecated. |
| 287 |
.IP \fB\-x963kdf_digest_check\fR 4 |
| 288 |
.IX Item "-x963kdf_digest_check" |
| 289 |
Configure the module to enable a run-time digest check when deriving a key by |
| 290 |
X963KDF. |
| 291 |
See NIST SP 800\-131Ar2 for details. |
| 292 |
.IP \fB\-dsa_sign_disabled\fR 4 |
| 293 |
.IX Item "-dsa_sign_disabled" |
| 294 |
Configure the module to not allow DSA signing (DSA signature verification is |
| 295 |
still allowed). See FIPS 140\-3 IG C.K for details. |
| 296 |
.IP \fB\-tdes_encrypt_disabled\fR 4 |
| 297 |
.IX Item "-tdes_encrypt_disabled" |
| 298 |
Configure the module to not allow Triple-DES encryption. |
| 299 |
Triple-DES decryption is still allowed for legacy purposes. |
| 300 |
See SP800\-131Ar2 for details. |
| 301 |
.IP \fB\-rsa_pkcs15_padding_disabled\fR 4 |
| 302 |
.IX Item "-rsa_pkcs15_padding_disabled" |
| 303 |
Configure the module to not allow PKCS#1 version 1.5 padding to be used with |
| 304 |
RSA for key transport and key agreement. See NIST's SP 800\-131A Revision 2 |
| 305 |
for details. |
| 306 |
.IP \fB\-rsa_pss_saltlen_check\fR 4 |
| 307 |
.IX Item "-rsa_pss_saltlen_check" |
| 308 |
Configure the module to enable a run-time salt length check when generating or |
| 309 |
verifying a RSA-PSS signature. |
| 310 |
See FIPS 186\-5 5.4 (g) for details. |
| 311 |
.IP \fB\-rsa_sign_x931_disabled\fR 4 |
| 312 |
.IX Item "-rsa_sign_x931_disabled" |
| 313 |
Configure the module to not allow X9.31 padding to be used when signing with |
| 314 |
RSA. See FIPS 140\-3 IG C.K for details. |
| 315 |
.IP \fB\-hkdf_key_check\fR 4 |
| 316 |
.IX Item "-hkdf_key_check" |
| 317 |
Configure the module to enable a run-time short key-derivation key check when |
| 318 |
deriving a key by HKDF. |
| 319 |
See NIST SP 800\-131Ar2 for details. |
| 320 |
.IP \fB\-kbkdf_key_check\fR 4 |
| 321 |
.IX Item "-kbkdf_key_check" |
| 322 |
Configure the module to enable a run-time short key-derivation key check when |
| 323 |
deriving a key by KBKDF. |
| 324 |
See NIST SP 800\-131Ar2 for details. |
| 325 |
.IP \fB\-tls13_kdf_key_check\fR 4 |
| 326 |
.IX Item "-tls13_kdf_key_check" |
| 327 |
Configure the module to enable a run-time short key-derivation key check when |
| 328 |
deriving a key by TLS13 KDF. |
| 329 |
See NIST SP 800\-131Ar2 for details. |
| 330 |
.IP \fB\-tls1_prf_key_check\fR 4 |
| 331 |
.IX Item "-tls1_prf_key_check" |
| 332 |
Configure the module to enable a run-time short key-derivation key check when |
| 333 |
deriving a key by TLS_PRF. |
| 334 |
See NIST SP 800\-131Ar2 for details. |
| 335 |
.IP \fB\-sshkdf_key_check\fR 4 |
| 336 |
.IX Item "-sshkdf_key_check" |
| 337 |
Configure the module to enable a run-time short key-derivation key check when |
| 338 |
deriving a key by SSHKDF. |
| 339 |
See NIST SP 800\-131Ar2 for details. |
| 340 |
.IP \fB\-sskdf_key_check\fR 4 |
| 341 |
.IX Item "-sskdf_key_check" |
| 342 |
Configure the module to enable a run-time short key-derivation key check when |
| 343 |
deriving a key by SSKDF. |
| 344 |
See NIST SP 800\-131Ar2 for details. |
| 345 |
.IP \fB\-x963kdf_key_check\fR 4 |
| 346 |
.IX Item "-x963kdf_key_check" |
| 347 |
Configure the module to enable a run-time short key-derivation key check when |
| 348 |
deriving a key by X963KDF. |
| 349 |
See NIST SP 800\-131Ar2 for details. |
| 350 |
.IP \fB\-x942kdf_key_check\fR 4 |
| 351 |
.IX Item "-x942kdf_key_check" |
| 352 |
Configure the module to enable a run-time short key-derivation key check when |
| 353 |
deriving a key by X942KDF. |
| 354 |
See NIST SP 800\-131Ar2 for details. |
| 355 |
.IP \fB\-no_pbkdf2_lower_bound_check\fR 4 |
| 356 |
.IX Item "-no_pbkdf2_lower_bound_check" |
| 357 |
Configure the module to not perform run-time lower bound check for PBKDF2. |
| 358 |
See NIST SP 800\-132 for details. |
| 359 |
.IP \fB\-ecdh_cofactor_check\fR 4 |
| 360 |
.IX Item "-ecdh_cofactor_check" |
| 361 |
Configure the module to enable a run-time check that ECDH uses the EC curves |
| 362 |
cofactor value when deriving a key. This only affects the 'B' and 'K' curves. |
| 363 |
See SP 800\-56A r3 Section 5.7.1.2 for details. |
| 364 |
.IP \fB\-self_test_onload\fR 4 |
| 365 |
.IX Item "-self_test_onload" |
| 366 |
Do not write the two fields related to the "test status indicator" and |
| 367 |
"MAC status indicator" to the output configuration file. Without these fields |
| 368 |
the self tests KATS will run each time the module is loaded. This option could be |
| 369 |
used for cross compiling, since the self tests need to run at least once on each |
| 370 |
target machine. Once the self tests have run on the target machine the user |
| 371 |
could possibly then add the 2 fields into the configuration using some other |
| 372 |
mechanism. |
| 373 |
This option defaults to 0 for any OpenSSL FIPS 140\-2 provider (OpenSSL 3.0.X). |
| 374 |
and is not relevant for an OpenSSL FIPS 140\-3 provider, since this is no |
| 375 |
longer allowed. |
| 376 |
.IP \fB\-self_test_oninstall\fR 4 |
| 377 |
.IX Item "-self_test_oninstall" |
| 378 |
The converse of \fB\-self_test_onload\fR. The two fields related to the |
| 379 |
"test status indicator" and "MAC status indicator" are written to the |
| 380 |
output configuration file. |
| 381 |
This field is not relevant for an OpenSSL FIPS 140\-3 provider, since this is no |
| 382 |
longer allowed. |
| 383 |
.IP \fB\-quiet\fR 4 |
| 384 |
.IX Item "-quiet" |
| 385 |
Do not output pass/fail messages. Implies \fB\-noout\fR. |
| 386 |
.IP "\fB\-corrupt_desc\fR \fIselftest_description\fR, \fB\-corrupt_type\fR \fIselftest_type\fR" 4 |
| 387 |
.IX Item "-corrupt_desc selftest_description, -corrupt_type selftest_type" |
| 388 |
The corrupt options can be used to test failure of one or more self tests by |
| 389 |
name. |
| 390 |
Either option or both may be used to select the tests to corrupt. |
| 391 |
Refer to the entries for \fBst-desc\fR and \fBst-type\fR in \fBOSSL_PROVIDER\-FIPS\fR\|(7) for |
| 392 |
values that can be used. |
| 393 |
.IP "\fB\-config\fR \fIparent_config\fR" 4 |
| 394 |
.IX Item "-config parent_config" |
| 395 |
Test that a FIPS provider can be loaded from the specified configuration file. |
| 396 |
A previous call to this application needs to generate the extra configuration |
| 397 |
data that is included by the base \f(CW\*(C`parent_config\*(C'\fR configuration file. |
| 398 |
See \fBconfig\fR\|(5) for further information on how to set up a provider section. |
| 399 |
All other options are ignored if '\-config' is used. |
| 400 |
.SH NOTES |
| 401 |
.IX Header "NOTES" |
| 402 |
Self tests results are logged by default if the options \fB\-quiet\fR and \fB\-noout\fR |
| 403 |
are not specified, or if either of the options \fB\-corrupt_desc\fR or |
| 404 |
\&\fB\-corrupt_type\fR are used. |
| 405 |
If the base configuration file is set up to autoload the fips module, then the |
| 406 |
fips module will be loaded and self tested BEFORE the fipsinstall application |
| 407 |
has a chance to set up its own self test callback. As a result of this the self |
| 408 |
test output and the options \fB\-corrupt_desc\fR and \fB\-corrupt_type\fR will be ignored. |
| 409 |
For normal usage the base configuration file should use the default provider |
| 410 |
when generating the fips configuration file. |
| 411 |
.PP |
| 412 |
The \fB\-self_test_oninstall\fR option was added and the |
| 413 |
\&\fB\-self_test_onload\fR option was made the default in OpenSSL 3.1. |
| 414 |
.PP |
| 415 |
The command and all remaining options were added in OpenSSL 3.0. |
| 416 |
.SH EXAMPLES |
| 417 |
.IX Header "EXAMPLES" |
| 418 |
Calculate the mac of a FIPS module \fIfips.so\fR and run a FIPS self test |
| 419 |
for the module, and save the \fIfips.cnf\fR configuration file: |
| 420 |
.PP |
| 421 |
.Vb 1 |
| 422 |
\& openssl fipsinstall \-module ./fips.so \-out fips.cnf \-provider_name fips |
| 423 |
.Ve |
| 424 |
.PP |
| 425 |
Verify that the configuration file \fIfips.cnf\fR contains the correct info: |
| 426 |
.PP |
| 427 |
.Vb 1 |
| 428 |
\& openssl fipsinstall \-module ./fips.so \-in fips.cnf \-provider_name fips \-verify |
| 429 |
.Ve |
| 430 |
.PP |
| 431 |
Corrupt any self tests which have the description \f(CW\*(C`SHA1\*(C'\fR: |
| 432 |
.PP |
| 433 |
.Vb 2 |
| 434 |
\& openssl fipsinstall \-module ./fips.so \-out fips.cnf \-provider_name fips \e |
| 435 |
\& \-corrupt_desc \*(AqSHA1\*(Aq |
| 436 |
.Ve |
| 437 |
.PP |
| 438 |
Validate that the fips module can be loaded from a base configuration file: |
| 439 |
.PP |
| 440 |
.Vb 3 |
| 441 |
\& export OPENSSL_CONF_INCLUDE=<path of configuration files> |
| 442 |
\& export OPENSSL_MODULES=<provider\-path> |
| 443 |
\& openssl fipsinstall \-config\*(Aq \*(Aqdefault.cnf\*(Aq |
| 444 |
.Ve |
| 445 |
.SH "SEE ALSO" |
| 446 |
.IX Header "SEE ALSO" |
| 447 |
\&\fBconfig\fR\|(5), |
| 448 |
\&\fBfips_config\fR\|(5), |
| 449 |
\&\fBOSSL_PROVIDER\-FIPS\fR\|(7), |
| 450 |
\&\fBEVP_MAC\fR\|(3) |
| 451 |
.SH HISTORY |
| 452 |
.IX Header "HISTORY" |
| 453 |
The \fBopenssl-fipsinstall\fR application was added in OpenSSL 3.0. |
| 454 |
.PP |
| 455 |
The following options were added in OpenSSL 3.1: |
| 456 |
.PP |
| 457 |
\&\fB\-ems_check\fR, |
| 458 |
\&\fB\-self_test_oninstall\fR |
| 459 |
.PP |
| 460 |
The following options were added in OpenSSL 3.2: |
| 461 |
.PP |
| 462 |
\&\fB\-pedantic\fR, |
| 463 |
\&\fB\-no_drbg_truncated_digests\fR |
| 464 |
.PP |
| 465 |
The following options were added in OpenSSL 3.4: |
| 466 |
.PP |
| 467 |
\&\fB\-hmac_key_check\fR, |
| 468 |
\&\fB\-kmac_key_check\fR, |
| 469 |
\&\fB\-signature_digest_check\fR, |
| 470 |
\&\fB\-hkdf_digest_check\fR, |
| 471 |
\&\fB\-tls13_kdf_digest_check\fR, |
| 472 |
\&\fB\-tls1_prf_digest_check\fR, |
| 473 |
\&\fB\-sshkdf_digest_check\fR, |
| 474 |
\&\fB\-sskdf_digest_check\fR, |
| 475 |
\&\fB\-x963kdf_digest_check\fR, |
| 476 |
\&\fB\-dsa_sign_disabled\fR, |
| 477 |
\&\fB\-no_pbkdf2_lower_bound_check\fR, |
| 478 |
\&\fB\-no_short_mac\fR, |
| 479 |
\&\fB\-tdes_encrypt_disabled\fR, |
| 480 |
\&\fB\-rsa_pkcs15_padding_disabled\fR, |
| 481 |
\&\fB\-rsa_pss_saltlen_check\fR, |
| 482 |
\&\fB\-rsa_sign_x931_disabled\fR, |
| 483 |
\&\fB\-hkdf_key_check\fR, |
| 484 |
\&\fB\-kbkdf_key_check\fR, |
| 485 |
\&\fB\-tls13_kdf_key_check\fR, |
| 486 |
\&\fB\-tls1_prf_key_check\fR, |
| 487 |
\&\fB\-sshkdf_key_check\fR, |
| 488 |
\&\fB\-sskdf_key_check\fR, |
| 489 |
\&\fB\-x963kdf_key_check\fR, |
| 490 |
\&\fB\-x942kdf_key_check\fR, |
| 491 |
\&\fB\-ecdh_cofactor_check\fR |
| 492 |
.SH COPYRIGHT |
| 493 |
.IX Header "COPYRIGHT" |
| 494 |
Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 495 |
.PP |
| 496 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 497 |
this file except in compliance with the License. You can obtain a copy |
| 498 |
in the file LICENSE in the source distribution or at |
| 499 |
<https://www.openssl.org/source/license.html>. |