Add --fips-key configuration parameter to fipsinstall application.
[openssl.git] / doc / man1 / openssl-fipsinstall.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-fipsinstall - perform FIPS configuration installation
7
8 =head1 SYNOPSIS
9
10 B<openssl fipsinstall>
11 [B<-help>]
12 [B<-in> I<configfilename>]
13 [B<-out> I<configfilename>]
14 [B<-module> I<modulefilename>]
15 [B<-provider_name> I<providername>]
16 [B<-section_name> I<sectionname>]
17 [B<-verify>]
18 [B<-mac_name> I<macname>]
19 [B<-macopt> I<nm>:I<v>]
20 [B<-noout>]
21 [B<-quiet>]
22 [B<-corrupt_desc> I<selftest_description>]
23 [B<-corrupt_type> I<selftest_type>]
24
25 =head1 DESCRIPTION
26
27 This command is used to generate a FIPS module configuration file.
28 This configuration file can be used each time a FIPS module is loaded
29 in order to pass data to the FIPS module self tests. The FIPS module always
30 verifies its MAC, but only needs to run the KAT's once,
31 at installation.
32
33 The generated configuration file consists of:
34
35 =over 4
36
37 =item - A MAC of the FIPS module file.
38
39 =item - A test status indicator.
40
41 This indicates if the Known Answer Self Tests (KAT's) have successfully run.
42
43 =item - A MAC of the status indicator.
44
45 =back
46
47 This file is described in L<fips_config(5)>.
48
49 =head1 OPTIONS
50
51 =over 4
52
53 =item B<-help>
54
55 Print a usage message.
56
57 =item B<-module> I<filename>
58
59 Filename of the FIPS module to perform an integrity check on.
60
61 =item B<-out> I<configfilename>
62
63 Filename to output the configuration data to; the default is standard output.
64
65 =item B<-in> I<configfilename>
66
67 Input filename to load configuration data from. Used with the B<-verify> option.
68 Standard input is used if the filename is C<->.
69
70 =item B<-verify>
71
72 Verify that the input configuration file contains the correct information.
73
74 =item B<-provider_name> I<providername>
75
76 Name of the provider inside the configuration file.
77 This must be specified.
78
79 =item B<-section_name> I<sectionname>
80
81 Name of the section inside the configuration file.
82 This must be specified.
83
84 =item B<-mac_name> I<name>
85
86 Specifies the name of a supported MAC algorithm which will be used.
87 The MAC mechanisms that are available will depend on the options
88 used when building OpenSSL.
89 To see the list of supported MAC's use the command
90 C<openssl list -mac-algorithms>.  The default is B<HMAC>.
91
92 =item B<-macopt> I<nm>:I<v>
93
94 Passes options to the MAC algorithm.
95 A comprehensive list of controls can be found in the EVP_MAC implementation
96 documentation.
97 Common control strings used for this command are:
98
99 =over 4
100
101 =item B<key>:I<string>
102
103 Specifies the MAC key as an alphanumeric string (use if the key contains
104 printable characters only).
105 The string length must conform to any restrictions of the MAC algorithm.
106 A key must be specified for every MAC algorithm.
107 If no key is provided, the default that was specified when OpenSSL was
108 configured is used.
109
110 =item B<hexkey>:I<string>
111
112 Specifies the MAC key in hexadecimal form (two hex digits per byte).
113 The key length must conform to any restrictions of the MAC algorithm.
114 A key must be specified for every MAC algorithm.
115 If no key is provided, the default that was specified when OpenSSL was
116 configured is used.
117
118 =item B<digest>:I<string>
119
120 Used by HMAC as an alphanumeric string (use if the key contains printable
121 characters only).
122 The string length must conform to any restrictions of the MAC algorithm.
123 To see the list of supported digests, use the command
124 C<openssl list -digest-commands>.
125 The default digest is SHA-256.
126
127 =back
128
129 =item B<-noout>
130
131 Disable logging of the self tests.
132
133 =item B<-quiet>
134
135 Do not output pass/fail messages. Implies B<-noout>.
136
137 =item B<-corrupt_desc> I<selftest_description>,
138 B<-corrupt_type> I<selftest_type>
139
140 The corrupt options can be used to test failure of one or more self tests by
141 name.
142 Either option or both may be used to select the tests to corrupt.
143 Refer to the entries for B<st-desc> and B<st-type> in L<OSSL_PROVIDER-FIPS(7)> for
144 values that can be used.
145
146 =back
147
148 =head1 EXAMPLES
149
150 Calculate the mac of a FIPS module F<fips.so> and run a FIPS self test
151 for the module, and save the F<fips.cnf> configuration file:
152
153  openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \
154          -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
155          -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213
156
157 Verify that the configuration file F<fips.cnf> contains the correct info:
158
159  openssl fipsinstall -module ./fips.so -in fips.cnf  -provider_name fips \
160           -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \
161           -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify
162
163 Corrupt any self tests which have the description C<SHA1>:
164
165  openssl fipsinstall -module ./fips.so -out fips.cnf -provider_name fips \
166          -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
167          -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 \
168          -corrupt_desc 'SHA1'
169
170 =head1 SEE ALSO
171
172 L<fips_config(5)>,
173 L<OSSL_PROVIDER-FIPS(7)>,
174 L<EVP_MAC(3)>
175
176 =head1 COPYRIGHT
177
178 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
179
180 Licensed under the Apache License 2.0 (the "License").  You may not use
181 this file except in compliance with the License.  You can obtain a copy
182 in the file LICENSE in the source distribution or at
183 L<https://www.openssl.org/source/license.html>.
184
185 =cut