Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL-FIPSINSTALL 1ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
openssl-fipsinstall - perform FIPS configuration installation Header "SYNOPSIS" \fBopenssl fipsinstall [-help] [-in configfilename] [-out configfilename] [-module modulefilename] [-provider_name providername] [-section_name sectionname] [-verify] [-mac_name macname] [-macopt nm:v] [-noout] [-quiet] [-no_conditional_errors] [-no_security_checks] [-self_test_onload] [-corrupt_desc selftest_description] [-corrupt_type selftest_type] [-config parent_config] Header "DESCRIPTION" This command is used to generate a \s-1FIPS\s0 module configuration file. This configuration file can be used each time a \s-1FIPS\s0 module is loaded in order to pass data to the \s-1FIPS\s0 module self tests. The \s-1FIPS\s0 module always verifies its \s-1MAC,\s0 but optionally only needs to run the \s-1KAT\s0's once, at installation.

The generated configuration file consists of:

Item "- A MAC of the FIPS module file."

0

Item "- A test status indicator."

This indicates if the Known Answer Self Tests (\s-1KAT\s0's) have successfully run.

Item "- A MAC of the status indicator."

0

Item "- A control for conditional self tests errors."

By default if a continuous test (e.g a key pair test) fails then the \s-1FIPS\s0 module will enter an error state, and no services or cryptographic algorithms will be able to be accessed after this point. The default value of '1' will cause the fips module error state to be entered. If the value is '0' then the module error state will not be entered. Regardless of whether the error state is entered or not, the current operation (e.g. key generation) will return an error. The user is responsible for retrying the operation if the module error state is not entered.

Item "- A control to indicate whether run-time security checks are done." This indicates if run-time checks related to enforcement of security parameters such as minimum security strength of keys and approved curve names are used. The default value of '1' will perform the checks. If the value is '0' the checks are not performed and \s-1FIPS\s0 compliance must be done by procedures documented in the relevant Security Policy.

This file is described in fips_config\|(5).

Header "OPTIONS" Item "-help" Print a usage message. Item "-module filename" Filename of the \s-1FIPS\s0 module to perform an integrity check on. The path provided in the filename is used to load the module when it is activated, and this overrides the environment variable \s-1OPENSSL_MODULES\s0. Item "-out configfilename" Filename to output the configuration data to; the default is standard output. Item "-in configfilename" Input filename to load configuration data from. Must be used if the -verify option is specified. Item "-verify" Verify that the input configuration file contains the correct information. Item "-provider_name providername" Name of the provider inside the configuration file. The default value is \*(C`fips\*(C'. Item "-section_name sectionname" Name of the section inside the configuration file. The default value is \*(C`fips_sect\*(C'. Item "-mac_name name" Specifies the name of a supported \s-1MAC\s0 algorithm which will be used. The \s-1MAC\s0 mechanisms that are available will depend on the options used when building OpenSSL. To see the list of supported \s-1MAC\s0's use the command \f(CW\*(C`openssl list -mac-algorithms\*(C'. The default is \s-1HMAC\s0. Item "-macopt nm:v" Passes options to the \s-1MAC\s0 algorithm. A comprehensive list of controls can be found in the \s-1EVP_MAC\s0 implementation documentation. Common control strings used for this command are: Item "-noout" Disable logging of the self tests. Item "-no_conditional_errors" Configure the module to not enter an error state if a conditional self test fails as described above. Item "-no_security_checks" Configure the module to not perform run-time security checks as described above. Item "-self_test_onload" Do not write the two fields related to the \*(L"test status indicator\*(R" and \*(L"\s-1MAC\s0 status indicator\*(R" to the output configuration file. Without these fields the self tests \s-1KATS\s0 will run each time the module is loaded. This option could be used for cross compiling, since the self tests need to run at least once on each target machine. Once the self tests have run on the target machine the user could possibly then add the 2 fields into the configuration using some other mechanism. Item "-quiet" Do not output pass/fail messages. Implies -noout. Item "-corrupt_desc selftest_description, -corrupt_type selftest_type" The corrupt options can be used to test failure of one or more self tests by name. Either option or both may be used to select the tests to corrupt. Refer to the entries for st-desc and st-type in \s-1OSSL_PROVIDER-FIPS\s0\|(7) for values that can be used. Item "-config parent_config" Test that a \s-1FIPS\s0 provider can be loaded from the specified configuration file. A previous call to this application needs to generate the extra configuration data that is included by the base \*(C`parent_config\*(C' configuration file. See config\|(5) for further information on how to set up a provider section. All other options are ignored if '-config' is used. Header "NOTES" Self tests results are logged by default if the options -quiet and -noout are not specified, or if either of the options -corrupt_desc or \fB-corrupt_type are used. If the base configuration file is set up to autoload the fips module, then the fips module will be loaded and self tested \s-1BEFORE\s0 the fipsinstall application has a chance to set up its own self test callback. As a result of this the self test output and the options -corrupt_desc and -corrupt_type will be ignored. For normal usage the base configuration file should use the default provider when generating the fips configuration file. Header "EXAMPLES" Calculate the mac of a \s-1FIPS\s0 module fips.so and run a \s-1FIPS\s0 self test for the module, and save the fips.cnf configuration file:

.Vb 1 openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips .Ve

Verify that the configuration file fips.cnf contains the correct info:

.Vb 1 openssl fipsinstall -module ./fips.so -in fips.cnf -provider_name fips -verify .Ve

Corrupt any self tests which have the description \*(C`SHA1\*(C':

.Vb 2 openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \e -corrupt_desc \*(AqSHA1\*(Aq .Ve

Validate that the fips module can be loaded from a base configuration file:

.Vb 3 export OPENSSL_CONF_INCLUDE=<path of configuration files> export OPENSSL_MODULES=<provider-path> openssl fipsinstall -config\*(Aq \*(Aqdefault.cnf\*(Aq .Ve

Header "SEE ALSO" \fBconfig\|(5), \fBfips_config\|(5), \s-1OSSL_PROVIDER-FIPS\s0\|(7), \s-1EVP_MAC\s0\|(3) Header "COPYRIGHT" Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.