mirror of
https://github.com/QuasarApp/openssl.git
synced 2025-05-14 18:39:40 +00:00
3121425830
Change default FIPS HMAC KEY from all-zero's Use default FIPSKEY if not given on command line. Make all -macopt in fipsinstall optional Make all tests, except fipsinstall, use the default -macopt and -mac_name flags. Define and use FIPSDIR variable on VMS/MMS. Also use SRCDIR/BLDDIR in SRCTOP/BLDTOP. Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12235)
186 lines
5.1 KiB
Plaintext
186 lines
5.1 KiB
Plaintext
=pod
|
|
{- OpenSSL::safe::output_do_not_edit_headers(); -}
|
|
|
|
=head1 NAME
|
|
|
|
openssl-fipsinstall - perform FIPS configuration installation
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<openssl fipsinstall>
|
|
[B<-help>]
|
|
[B<-in> I<configfilename>]
|
|
[B<-out> I<configfilename>]
|
|
[B<-module> I<modulefilename>]
|
|
[B<-provider_name> I<providername>]
|
|
[B<-section_name> I<sectionname>]
|
|
[B<-verify>]
|
|
[B<-mac_name> I<macname>]
|
|
[B<-macopt> I<nm>:I<v>]
|
|
[B<-noout>]
|
|
[B<-quiet>]
|
|
[B<-corrupt_desc> I<selftest_description>]
|
|
[B<-corrupt_type> I<selftest_type>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This command is used to generate a FIPS module configuration file.
|
|
This configuration file can be used each time a FIPS module is loaded
|
|
in order to pass data to the FIPS module self tests. The FIPS module always
|
|
verifies its MAC, but only needs to run the KAT's once,
|
|
at installation.
|
|
|
|
The generated configuration file consists of:
|
|
|
|
=over 4
|
|
|
|
=item - A MAC of the FIPS module file.
|
|
|
|
=item - A test status indicator.
|
|
|
|
This indicates if the Known Answer Self Tests (KAT's) have successfully run.
|
|
|
|
=item - A MAC of the status indicator.
|
|
|
|
=back
|
|
|
|
This file is described in L<fips_config(5)>.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-help>
|
|
|
|
Print a usage message.
|
|
|
|
=item B<-module> I<filename>
|
|
|
|
Filename of the FIPS module to perform an integrity check on.
|
|
|
|
=item B<-out> I<configfilename>
|
|
|
|
Filename to output the configuration data to; the default is standard output.
|
|
|
|
=item B<-in> I<configfilename>
|
|
|
|
Input filename to load configuration data from. Used with the B<-verify> option.
|
|
Standard input is used if the filename is C<->.
|
|
|
|
=item B<-verify>
|
|
|
|
Verify that the input configuration file contains the correct information.
|
|
|
|
=item B<-provider_name> I<providername>
|
|
|
|
Name of the provider inside the configuration file.
|
|
This must be specified.
|
|
|
|
=item B<-section_name> I<sectionname>
|
|
|
|
Name of the section inside the configuration file.
|
|
This must be specified.
|
|
|
|
=item B<-mac_name> I<name>
|
|
|
|
Specifies the name of a supported MAC algorithm which will be used.
|
|
The MAC mechanisms that are available will depend on the options
|
|
used when building OpenSSL.
|
|
To see the list of supported MAC's use the command
|
|
C<openssl list -mac-algorithms>. The default is B<HMAC>.
|
|
|
|
=item B<-macopt> I<nm>:I<v>
|
|
|
|
Passes options to the MAC algorithm.
|
|
A comprehensive list of controls can be found in the EVP_MAC implementation
|
|
documentation.
|
|
Common control strings used for this command are:
|
|
|
|
=over 4
|
|
|
|
=item B<key>:I<string>
|
|
|
|
Specifies the MAC key as an alphanumeric string (use if the key contains
|
|
printable characters only).
|
|
The string length must conform to any restrictions of the MAC algorithm.
|
|
A key must be specified for every MAC algorithm.
|
|
If no key is provided, the default that was specified when OpenSSL was
|
|
configured is used.
|
|
|
|
=item B<hexkey>:I<string>
|
|
|
|
Specifies the MAC key in hexadecimal form (two hex digits per byte).
|
|
The key length must conform to any restrictions of the MAC algorithm.
|
|
A key must be specified for every MAC algorithm.
|
|
If no key is provided, the default that was specified when OpenSSL was
|
|
configured is used.
|
|
|
|
=item B<digest>:I<string>
|
|
|
|
Used by HMAC as an alphanumeric string (use if the key contains printable
|
|
characters only).
|
|
The string length must conform to any restrictions of the MAC algorithm.
|
|
To see the list of supported digests, use the command
|
|
C<openssl list -digest-commands>.
|
|
The default digest is SHA-256.
|
|
|
|
=back
|
|
|
|
=item B<-noout>
|
|
|
|
Disable logging of the self tests.
|
|
|
|
=item B<-quiet>
|
|
|
|
Do not output pass/fail messages. Implies B<-noout>.
|
|
|
|
=item B<-corrupt_desc> I<selftest_description>,
|
|
B<-corrupt_type> I<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 B<st-desc> and B<st-type> in L<OSSL_PROVIDER-FIPS(7)> for
|
|
values that can be used.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Calculate the mac of a FIPS module F<fips.so> and run a FIPS self test
|
|
for the module, and save the F<fips.cnf> configuration file:
|
|
|
|
openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \
|
|
-section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
|
|
-macopt hexkey:000102030405060708090A0B0C0D0E0F10111213
|
|
|
|
Verify that the configuration file F<fips.cnf> contains the correct info:
|
|
|
|
openssl fipsinstall -module ./fips.so -in fips.cnf -provider_name fips \
|
|
-section_name fips_install -mac_name HMAC -macopt digest:SHA256 \
|
|
-macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify
|
|
|
|
Corrupt any self tests which have the description C<SHA1>:
|
|
|
|
openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \
|
|
-section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
|
|
-macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \
|
|
-corrupt_desc 'SHA1'
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<fips_config(5)>,
|
|
L<OSSL_PROVIDER-FIPS(7)>,
|
|
L<EVP_MAC(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|