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