doc/man1/openssl-fipsinstall.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-fipsinstall - perform FIPS configuration installation
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl fipsinstall>
  10 [B<-help>]
  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>]
  16 [B<-verify>]
  17 [B<-mac_name> I<macname>]
  18 [B<-macopt> I<nm>:I<v>]
  19
  20 =head1 DESCRIPTION
  21
  22 This command is used to generate a FIPS module configuration file.
  23 The generated configuration file consists of:
  24
  25 =over 4
  26
  27 =item - A mac of the FIPS module file.
  28
  29 =item - A status indicator that indicates if the known answer Self Tests (KAT's)
  30 have successfully run.
  31
  32 =back
  33
  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.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<-help>
  43
  44 Print a usage message.
  45
  46 =item B<-module> I<filename>
  47
  48 Filename of a fips module to perform an integrity check on.
  49
  50 =item B<-out> I<configfilename>
  51
  52 Filename to output the configuration data to, or standard output by default.
  53
  54 =item B<-in> I<configfilename>
  55
  56 Input filename to load configuration data from. Used with the '-verify' option.
  57 Standard input is used if the filename is '-'.
  58
  59 =item B<-verify>
  60
  61 Verify that the input configuration file contains the correct information
  62
  63 =item B<-provider_name> I<providername>
  64
  65 Name of the provider inside the configuration file.
  66
  67 =item B<-section_name> I<sectionname>
  68
  69 Name of the section inside the configuration file.
  70
  71 =item B<-mac_name> I<name>
  72
  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
  75 C<openssl list -mac-algorithms>.  The default is B<HMAC>.
  76
  77 =item B<-macopt> I<nm>:I<v>
  78
  79 Passes options to the MAC algorithm.
  80 A comprehensive list of controls can be found in the EVP_MAC implementation
  81 documentation.
  82 Common control strings used for fipsinstall are:
  83
  84 =over 4
  85
  86 =item B<key>:I<string>
  87
  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.
  92
  93 =item B<hexkey>:I<string>
  94
  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.
  98
  99 =item B<digest>:I<string>
 100
 101 Used by HMAC as an alphanumeric string (use if the key contains printable
 102 characters only).
 103 The string length must conform to any restrictions of the MAC algorithm.
 104 To see the list of supported digests, use the command
 105 C<openssl list -digest-commands>.
 106
 107 =back
 108
 109 =back
 110
 111 =head1 EXAMPLES
 112
 113 Calculate the mac of a FIPS module F<fips.so> and run a FIPS self test
 114 for the module, and save the F<fips.conf> configuration file:
 115
 116  openssl fipsinstall -module ./fips.so -out fips.conf -provider_name fips \
 117          -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
 118          -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213
 119
 120 Verify that the configuration file F<fips.conf> contains the correct info:
 121
 122  openssl fipsinstall -module ./fips.so -in fips.conf  -provider_name fips \
 123           -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \
 124           -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify
 125
 126 =head1 NOTES
 127
 128 The MAC mechanisms that are available will depend on the options
 129 used when building OpenSSL.
 130 The command C<openssl list -mac-algorithms> command can be used to list them.
 131
 132 =head1 SEE ALSO
 133
 134 L<fips_config(5)>,
 135 L<EVP_MAC(3)>
 136
 137 =head1 COPYRIGHT
 138
 139 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
 140
 141 Licensed under the OpenSSL license (the "License").  You may not use
 142 this file except in compliance with the License.  You can obtain a copy
 143 in the file LICENSE in the source distribution or at
 144 L<https://www.openssl.org/source/license.html>.
 145
 146 =cut