5 openssl-fipsinstall - perform FIPS configuration installation
11 [B<-in> I<configfilename>]
12 [B<-out> I<configfilename>]
13 [B<-module> I<modulefilename>]
14 [B<-provider_name> I<providername>]
15 [B<-section_name> I<sectionname>]
17 [B<-mac_name> I<macname>]
18 [B<-macopt> I<nm>:I<v>]
22 This utility is used to generate a FIPS module configuration file.
23 The generated configuration file consists of:
27 =item - A mac of the FIPS module file.
29 =item - A status indicator that indicates if the known answer Self Tests (KAT's)
30 have successfully run.
34 This configuration file can be used each time a FIPS module is loaded
35 in order to pass data to the FIPS modules self tests. The FIPS module always
36 verifies the modules MAC, but only needs to run the KATS once during install.
44 Print a usage message.
46 =item B<-module> I<filename>
48 Filename of a fips module to perform an integrity check on.
50 =item B<-out> I<configfilename>
52 Filename to output the configuration data to, or standard output by default.
54 =item B<-in> I<configfilename>
56 Input filename to load configuration data from. Used with the '-verify' option.
57 Standard input is used if the filename is '-'.
61 Verify that the input configuration file contains the correct information
63 =item B<-provider_name> I<providername>
65 Name of the provider inside the configuration file.
67 =item B<-section_name> I<sectionname>
69 Name of the section inside the configuration file.
71 =item B<-mac_name> I<name>
73 Specifies the name of a supported MAC algorithm which will be used.
74 To see the list of supported MAC's use the command I<list -mac-algorithms>.
75 The default is "HMAC".
77 =item B<-macopt> I<nm>:I<v>
79 Passes options to the MAC algorithm.
80 A comprehensive list of controls can be found in the EVP_MAC implementation
82 Common control strings used for fipsinstall are:
86 =item B<key>:I<string>
88 Specifies the MAC key as an alphanumeric string (use if the key contains
89 printable characters only).
90 The string length must conform to any restrictions of the MAC algorithm.
91 A key must be specified for every MAC algorithm.
93 =item B<hexkey>:I<string>
95 Specifies the MAC key in hexadecimal form (two hex digits per byte).
96 The key length must conform to any restrictions of the MAC algorithm.
97 A key must be specified for every MAC algorithm.
99 =item B<digest>:I<string>
101 Used by HMAC as an alphanumeric string (use if the key contains printable
103 The string length must conform to any restrictions of the MAC algorithm.
104 To see the list of supported digests, use the command I<list -digest-commands>.
112 Calculate the mac of a FIPS module 'fips.so' and run a FIPS self test
113 for the module, and save the fips.conf configuration file:
115 openssl fipsinstall -module ./fips.so -out fips.conf -provider_name fips \
116 -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
117 -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213
119 Verify that the configuration file 'fips.conf' contains the correct info:
121 openssl fipsinstall -module ./fips.so -in fips.conf -provider_name fips \
122 -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \
123 -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify
127 The MAC mechanisms that are available will depend on the options
128 used when building OpenSSL.
129 The B<list -mac-algorithms> command can be used to list them.
138 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
140 Licensed under the OpenSSL license (the "License"). You may not use
141 this file except in compliance with the License. You can obtain a copy
142 in the file LICENSE in the source distribution or at
143 L<https://www.openssl.org/source/license.html>.