579 lines
22 KiB
Plaintext
579 lines
22 KiB
Plaintext
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. 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.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" 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'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==0)) \{\
|
|
. if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
. \}
|
|
.\}
|
|
.rr rF
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "OPENSSL-FIPSINSTALL 1ossl"
|
|
.TH OPENSSL-FIPSINSTALL 1ossl "2024-11-04" "3.4.0" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
openssl\-fipsinstall \- perform FIPS configuration installation
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl fipsinstall\fR
|
|
[\fB\-help\fR]
|
|
[\fB\-in\fR \fIconfigfilename\fR]
|
|
[\fB\-out\fR \fIconfigfilename\fR]
|
|
[\fB\-module\fR \fImodulefilename\fR]
|
|
[\fB\-provider_name\fR \fIprovidername\fR]
|
|
[\fB\-section_name\fR \fIsectionname\fR]
|
|
[\fB\-verify\fR]
|
|
[\fB\-mac_name\fR \fImacname\fR]
|
|
[\fB\-macopt\fR \fInm\fR:\fIv\fR]
|
|
[\fB\-noout\fR]
|
|
[\fB\-quiet\fR]
|
|
[\fB\-pedantic\fR]
|
|
[\fB\-no_conditional_errors\fR]
|
|
[\fB\-no_security_checks\fR]
|
|
[\fB\-hmac_key_check\fR]
|
|
[\fB\-kmac_key_check\fR]
|
|
[\fB\-ems_check\fR]
|
|
[\fB\-no_drbg_truncated_digests\fR]
|
|
[\fB\-signature_digest_check\fR]
|
|
[\fB\-hkdf_digest_check\fR]
|
|
[\fB\-tls13_kdf_digest_check\fR]
|
|
[\fB\-tls1_prf_digest_check\fR]
|
|
[\fB\-sshkdf_digest_check\fR]
|
|
[\fB\-sskdf_digest_check\fR]
|
|
[\fB\-x963kdf_digest_check\fR]
|
|
[\fB\-dsa_sign_disabled\fR]
|
|
[\fB\-no_pbkdf2_lower_bound_check\fR]
|
|
[\fB\-no_short_mac\fR]
|
|
[\fB\-tdes_encrypt_disabled\fR]
|
|
[\fB\-rsa_pkcs15_padding_disabled\fR]
|
|
[\fB\-rsa_pss_saltlen_check\fR]
|
|
[\fB\-rsa_sign_x931_disabled\fR]
|
|
[\fB\-hkdf_key_check\fR]
|
|
[\fB\-kbkdf_key_check\fR]
|
|
[\fB\-tls13_kdf_key_check\fR]
|
|
[\fB\-tls1_prf_key_check\fR]
|
|
[\fB\-sshkdf_key_check\fR]
|
|
[\fB\-sskdf_key_check\fR]
|
|
[\fB\-x963kdf_key_check\fR]
|
|
[\fB\-x942kdf_key_check\fR]
|
|
[\fB\-ecdh_cofactor_check\fR]
|
|
[\fB\-self_test_onload\fR]
|
|
[\fB\-self_test_oninstall\fR]
|
|
[\fB\-corrupt_desc\fR \fIselftest_description\fR]
|
|
[\fB\-corrupt_type\fR \fIselftest_type\fR]
|
|
[\fB\-config\fR \fIparent_config\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX 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.
|
|
.PP
|
|
The generated configuration file consists of:
|
|
.IP "\- A \s-1MAC\s0 of the \s-1FIPS\s0 module file." 4
|
|
.IX Item "- A MAC of the FIPS module file."
|
|
.PD 0
|
|
.IP "\- A test status indicator." 4
|
|
.IX Item "- A test status indicator."
|
|
.PD
|
|
This indicates if the Known Answer Self Tests (\s-1KAT\s0's) have successfully run.
|
|
.IP "\- A \s-1MAC\s0 of the status indicator." 4
|
|
.IX Item "- A MAC of the status indicator."
|
|
.PD 0
|
|
.IP "\- A control for conditional self tests errors." 4
|
|
.IX Item "- A control for conditional self tests errors."
|
|
.PD
|
|
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.
|
|
.IP "\- A control to indicate whether run-time security checks are done." 4
|
|
.IX 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.
|
|
.PP
|
|
This file is described in \fBfips_config\fR\|(5).
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
.IP "\fB\-help\fR" 4
|
|
.IX Item "-help"
|
|
Print a usage message.
|
|
.IP "\fB\-module\fR \fIfilename\fR" 4
|
|
.IX 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 \fB\s-1OPENSSL_MODULES\s0\fR.
|
|
.IP "\fB\-out\fR \fIconfigfilename\fR" 4
|
|
.IX Item "-out configfilename"
|
|
Filename to output the configuration data to; the default is standard output.
|
|
.IP "\fB\-in\fR \fIconfigfilename\fR" 4
|
|
.IX Item "-in configfilename"
|
|
Input filename to load configuration data from.
|
|
Must be used if the \fB\-verify\fR option is specified.
|
|
.IP "\fB\-verify\fR" 4
|
|
.IX Item "-verify"
|
|
Verify that the input configuration file contains the correct information.
|
|
.IP "\fB\-provider_name\fR \fIprovidername\fR" 4
|
|
.IX Item "-provider_name providername"
|
|
Name of the provider inside the configuration file.
|
|
The default value is \f(CW\*(C`fips\*(C'\fR.
|
|
.IP "\fB\-section_name\fR \fIsectionname\fR" 4
|
|
.IX Item "-section_name sectionname"
|
|
Name of the section inside the configuration file.
|
|
The default value is \f(CW\*(C`fips_sect\*(C'\fR.
|
|
.IP "\fB\-mac_name\fR \fIname\fR" 4
|
|
.IX 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'\fR. The default is \fB\s-1HMAC\s0\fR.
|
|
.IP "\fB\-macopt\fR \fInm\fR:\fIv\fR" 4
|
|
.IX 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:
|
|
.RS 4
|
|
.IP "\fBkey\fR:\fIstring\fR" 4
|
|
.IX Item "key:string"
|
|
Specifies the \s-1MAC\s0 key as an alphanumeric string (use if the key contains
|
|
printable characters only).
|
|
The string length must conform to any restrictions of the \s-1MAC\s0 algorithm.
|
|
A key must be specified for every \s-1MAC\s0 algorithm.
|
|
If no key is provided, the default that was specified when OpenSSL was
|
|
configured is used.
|
|
.IP "\fBhexkey\fR:\fIstring\fR" 4
|
|
.IX Item "hexkey:string"
|
|
Specifies the \s-1MAC\s0 key in hexadecimal form (two hex digits per byte).
|
|
The key length must conform to any restrictions of the \s-1MAC\s0 algorithm.
|
|
A key must be specified for every \s-1MAC\s0 algorithm.
|
|
If no key is provided, the default that was specified when OpenSSL was
|
|
configured is used.
|
|
.IP "\fBdigest\fR:\fIstring\fR" 4
|
|
.IX Item "digest:string"
|
|
Used by \s-1HMAC\s0 as an alphanumeric string (use if the key contains printable
|
|
characters only).
|
|
The string length must conform to any restrictions of the \s-1MAC\s0 algorithm.
|
|
To see the list of supported digests, use the command
|
|
\&\f(CW\*(C`openssl list \-digest\-commands\*(C'\fR.
|
|
The default digest is \s-1SHA\-256.\s0
|
|
.RE
|
|
.RS 4
|
|
.RE
|
|
.IP "\fB\-noout\fR" 4
|
|
.IX Item "-noout"
|
|
Disable logging of the self tests.
|
|
.IP "\fB\-pedantic\fR" 4
|
|
.IX Item "-pedantic"
|
|
Configure the module so that it is strictly \s-1FIPS\s0 compliant rather
|
|
than being backwards compatible. This enables conditional errors,
|
|
security checks etc. Note that any previous configuration options will
|
|
be overwritten and any subsequent configuration options that violate
|
|
\&\s-1FIPS\s0 compliance will result in an error.
|
|
.IP "\fB\-no_conditional_errors\fR" 4
|
|
.IX Item "-no_conditional_errors"
|
|
Configure the module to not enter an error state if a conditional self test
|
|
fails as described above.
|
|
.IP "\fB\-no_security_checks\fR" 4
|
|
.IX Item "-no_security_checks"
|
|
Configure the module to not perform run-time security checks as described above.
|
|
.Sp
|
|
Enabling the configuration option \*(L"no-fips-securitychecks\*(R" provides another way to
|
|
turn off the check at compile time.
|
|
.IP "\fB\-ems_check\fR" 4
|
|
.IX Item "-ems_check"
|
|
Configure the module to enable a run-time Extended Master Secret (\s-1EMS\s0) check
|
|
when using the \s-1TLS1_PRF KDF\s0 algorithm. This check is disabled by default.
|
|
See \s-1RFC 7627\s0 for information related to \s-1EMS.\s0
|
|
.IP "\fB\-no_short_mac\fR" 4
|
|
.IX Item "-no_short_mac"
|
|
Configure the module to not allow short \s-1MAC\s0 outputs.
|
|
See \s-1SP 800\-185 8.4.2\s0 and \s-1FIPS 140\-3 ID C.D\s0 for details.
|
|
.IP "\fB\-hmac_key_check\fR" 4
|
|
.IX Item "-hmac_key_check"
|
|
Configure the module to not allow small keys sizes when using \s-1HMAC.\s0
|
|
See \s-1SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-kmac_key_check\fR" 4
|
|
.IX Item "-kmac_key_check"
|
|
Configure the module to not allow small keys sizes when using \s-1KMAC.\s0
|
|
See \s-1SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-no_drbg_truncated_digests\fR" 4
|
|
.IX Item "-no_drbg_truncated_digests"
|
|
Configure the module to not allow truncated digests to be used with Hash and
|
|
\&\s-1HMAC\s0 DRBGs. See \s-1FIPS 140\-3 IG D.R\s0 for details.
|
|
.IP "\fB\-signature_digest_check\fR" 4
|
|
.IX Item "-signature_digest_check"
|
|
Configure the module to enforce signature algorithms to use digests that are
|
|
explicitly permitted by the various standards.
|
|
.IP "\fB\-hkdf_digest_check\fR" 4
|
|
.IX Item "-hkdf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
\&\s-1HKDF.\s0
|
|
See \s-1NIST SP\s0 800\-56Cr2 for details.
|
|
.IP "\fB\-tls13_kdf_digest_check\fR" 4
|
|
.IX Item "-tls13_kdf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
\&\s-1TLS13 KDF.\s0
|
|
See \s-1RFC 8446\s0 for details.
|
|
.IP "\fB\-tls1_prf_digest_check\fR" 4
|
|
.IX Item "-tls1_prf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
\&\s-1TLS_PRF.\s0
|
|
See \s-1NIST SP\s0 800\-135r1 for details.
|
|
.IP "\fB\-sshkdf_digest_check\fR" 4
|
|
.IX Item "-sshkdf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
\&\s-1SSHKDF.\s0
|
|
See \s-1NIST SP\s0 800\-135r1 for details.
|
|
.IP "\fB\-sskdf_digest_check\fR" 4
|
|
.IX Item "-sskdf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
\&\s-1SSKDF.\s0
|
|
See \s-1NIST SP\s0 800\-56Cr2 for details.
|
|
.IP "\fB\-x963kdf_digest_check\fR" 4
|
|
.IX Item "-x963kdf_digest_check"
|
|
Configure the module to enable a run-time digest check when deriving a key by
|
|
X963KDF.
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-dsa_sign_disabled\fR" 4
|
|
.IX Item "-dsa_sign_disabled"
|
|
Configure the module to not allow \s-1DSA\s0 signing (\s-1DSA\s0 signature verification is
|
|
still allowed). See \s-1FIPS 140\-3 IG C.K\s0 for details.
|
|
.IP "\fB\-tdes_encrypt_disabled\fR" 4
|
|
.IX Item "-tdes_encrypt_disabled"
|
|
Configure the module to not allow Triple-DES encryption.
|
|
Triple-DES decryption is still allowed for legacy purposes.
|
|
See SP800\-131Ar2 for details.
|
|
.IP "\fB\-rsa_pkcs15_padding_disabled\fR" 4
|
|
.IX Item "-rsa_pkcs15_padding_disabled"
|
|
Configure the module to not allow PKCS#1 version 1.5 padding to be used with
|
|
\&\s-1RSA\s0 for key transport and key agreement. See \s-1NIST\s0's \s-1SP 800\-131A\s0 Revision 2
|
|
for details.
|
|
.IP "\fB\-rsa_pss_saltlen_check\fR" 4
|
|
.IX Item "-rsa_pss_saltlen_check"
|
|
Configure the module to enable a run-time salt length check when generating or
|
|
verifying a RSA-PSS signature.
|
|
See \s-1FIPS 186\-5 5.4\s0 (g) for details.
|
|
.IP "\fB\-rsa_sign_x931_disabled\fR" 4
|
|
.IX Item "-rsa_sign_x931_disabled"
|
|
Configure the module to not allow X9.31 padding to be used when signing with
|
|
\&\s-1RSA.\s0 See \s-1FIPS 140\-3 IG C.K\s0 for details.
|
|
.IP "\fB\-hkdf_key_check\fR" 4
|
|
.IX Item "-hkdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1HKDF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-kbkdf_key_check\fR" 4
|
|
.IX Item "-kbkdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1KBKDF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-tls13_kdf_key_check\fR" 4
|
|
.IX Item "-tls13_kdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1TLS13 KDF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-tls1_prf_key_check\fR" 4
|
|
.IX Item "-tls1_prf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1TLS_PRF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-sshkdf_key_check\fR" 4
|
|
.IX Item "-sshkdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1SSHKDF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-sskdf_key_check\fR" 4
|
|
.IX Item "-sskdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by \s-1SSKDF.\s0
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-x963kdf_key_check\fR" 4
|
|
.IX Item "-x963kdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by X963KDF.
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-x942kdf_key_check\fR" 4
|
|
.IX Item "-x942kdf_key_check"
|
|
Configure the module to enable a run-time short key-derivation key check when
|
|
deriving a key by X942KDF.
|
|
See \s-1NIST SP\s0 800\-131Ar2 for details.
|
|
.IP "\fB\-no_pbkdf2_lower_bound_check\fR" 4
|
|
.IX Item "-no_pbkdf2_lower_bound_check"
|
|
Configure the module to not perform run-time lower bound check for \s-1PBKDF2.\s0
|
|
See \s-1NIST SP 800\-132\s0 for details.
|
|
.IP "\fB\-ecdh_cofactor_check\fR" 4
|
|
.IX Item "-ecdh_cofactor_check"
|
|
Configure the module to enable a run-time check that \s-1ECDH\s0 uses the \s-1EC\s0 curves
|
|
cofactor value when deriving a key. This only affects the 'B' and 'K' curves.
|
|
See \s-1SP 800\-56A\s0 r3 Section 5.7.1.2 for details.
|
|
.IP "\fB\-self_test_onload\fR" 4
|
|
.IX 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.
|
|
.Sp
|
|
This is the default.
|
|
.IP "\fB\-self_test_oninstall\fR" 4
|
|
.IX Item "-self_test_oninstall"
|
|
The converse of \fB\-self_test_oninstall\fR. The two fields related to the
|
|
\&\*(L"test status indicator\*(R" and \*(L"\s-1MAC\s0 status indicator\*(R" are written to the
|
|
output configuration file.
|
|
.IP "\fB\-quiet\fR" 4
|
|
.IX Item "-quiet"
|
|
Do not output pass/fail messages. Implies \fB\-noout\fR.
|
|
.IP "\fB\-corrupt_desc\fR \fIselftest_description\fR, \fB\-corrupt_type\fR \fIselftest_type\fR" 4
|
|
.IX 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 \fBst-desc\fR and \fBst-type\fR in \s-1\fBOSSL_PROVIDER\-FIPS\s0\fR\|(7) for
|
|
values that can be used.
|
|
.IP "\fB\-config\fR \fIparent_config\fR" 4
|
|
.IX 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 \f(CW\*(C`parent_config\*(C'\fR configuration file.
|
|
See \fBconfig\fR\|(5) for further information on how to set up a provider section.
|
|
All other options are ignored if '\-config' is used.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
Self tests results are logged by default if the options \fB\-quiet\fR and \fB\-noout\fR
|
|
are not specified, or if either of the options \fB\-corrupt_desc\fR or
|
|
\&\fB\-corrupt_type\fR 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 \fB\-corrupt_desc\fR and \fB\-corrupt_type\fR will be ignored.
|
|
For normal usage the base configuration file should use the default provider
|
|
when generating the fips configuration file.
|
|
.PP
|
|
The \fB\-self_test_oninstall\fR option was added and the
|
|
\&\fB\-self_test_onload\fR option was made the default in OpenSSL 3.1.
|
|
.PP
|
|
The command and all remaining options were added in OpenSSL 3.0.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Calculate the mac of a \s-1FIPS\s0 module \fIfips.so\fR and run a \s-1FIPS\s0 self test
|
|
for the module, and save the \fIfips.cnf\fR configuration file:
|
|
.PP
|
|
.Vb 1
|
|
\& openssl fipsinstall \-module ./fips.so \-out fips.cnf \-provider_name fips
|
|
.Ve
|
|
.PP
|
|
Verify that the configuration file \fIfips.cnf\fR contains the correct info:
|
|
.PP
|
|
.Vb 1
|
|
\& openssl fipsinstall \-module ./fips.so \-in fips.cnf \-provider_name fips \-verify
|
|
.Ve
|
|
.PP
|
|
Corrupt any self tests which have the description \f(CW\*(C`SHA1\*(C'\fR:
|
|
.PP
|
|
.Vb 2
|
|
\& openssl fipsinstall \-module ./fips.so \-out fips.cnf \-provider_name fips \e
|
|
\& \-corrupt_desc \*(AqSHA1\*(Aq
|
|
.Ve
|
|
.PP
|
|
Validate that the fips module can be loaded from a base configuration file:
|
|
.PP
|
|
.Vb 3
|
|
\& export OPENSSL_CONF_INCLUDE=<path of configuration files>
|
|
\& export OPENSSL_MODULES=<provider\-path>
|
|
\& openssl fipsinstall \-config\*(Aq \*(Aqdefault.cnf\*(Aq
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fBconfig\fR\|(5),
|
|
\&\fBfips_config\fR\|(5),
|
|
\&\s-1\fBOSSL_PROVIDER\-FIPS\s0\fR\|(7),
|
|
\&\s-1\fBEVP_MAC\s0\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fBopenssl-fipsinstall\fR application was added in OpenSSL 3.0.
|
|
.PP
|
|
The following options were added in OpenSSL 3.1:
|
|
.PP
|
|
\&\fB\-ems_check\fR,
|
|
\&\fB\-self_test_oninstall\fR
|
|
.PP
|
|
The following options were added in OpenSSL 3.2:
|
|
.PP
|
|
\&\fB\-pedantic\fR,
|
|
\&\fB\-no_drbg_truncated_digests\fR
|
|
.PP
|
|
The following options were added in OpenSSL 3.4:
|
|
.PP
|
|
\&\fB\-hmac_key_check\fR,
|
|
\&\fB\-kmac_key_check\fR,
|
|
\&\fB\-signature_digest_check\fR,
|
|
\&\fB\-hkdf_digest_check\fR,
|
|
\&\fB\-tls13_kdf_digest_check\fR,
|
|
\&\fB\-tls1_prf_digest_check\fR,
|
|
\&\fB\-sshkdf_digest_check\fR,
|
|
\&\fB\-sskdf_digest_check\fR,
|
|
\&\fB\-x963kdf_digest_check\fR,
|
|
\&\fB\-dsa_sign_disabled\fR,
|
|
\&\fB\-no_pbkdf2_lower_bound_check\fR,
|
|
\&\fB\-no_short_mac\fR,
|
|
\&\fB\-tdes_encrypt_disabled\fR,
|
|
\&\fB\-rsa_pkcs15_padding_disabled\fR,
|
|
\&\fB\-rsa_pss_saltlen_check\fR,
|
|
\&\fB\-rsa_sign_x931_disabled\fR,
|
|
\&\fB\-hkdf_key_check\fR,
|
|
\&\fB\-kbkdf_key_check\fR,
|
|
\&\fB\-tls13_kdf_key_check\fR,
|
|
\&\fB\-tls1_prf_key_check\fR,
|
|
\&\fB\-sshkdf_key_check\fR,
|
|
\&\fB\-sskdf_key_check\fR,
|
|
\&\fB\-x963kdf_key_check\fR,
|
|
\&\fB\-x942kdf_key_check\fR,
|
|
\&\fB\-ecdh_cofactor_check\fR
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|