openssl-fipsinstall.pod 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. =pod
  2. =head1 NAME
  3. openssl-fipsinstall - perform FIPS configuration installation
  4. =head1 SYNOPSIS
  5. B<openssl fipsinstall>
  6. [B<-help>]
  7. [B<-in> I<configfilename>]
  8. [B<-out> I<configfilename>]
  9. [B<-module> I<modulefilename>]
  10. [B<-provider_name> I<providername>]
  11. [B<-section_name> I<sectionname>]
  12. [B<-verify>]
  13. [B<-mac_name> I<macname>]
  14. [B<-macopt> I<nm>:I<v>]
  15. =head1 DESCRIPTION
  16. This command is used to generate a FIPS module configuration file.
  17. The generated configuration file consists of:
  18. =over 4
  19. =item - A mac of the FIPS module file.
  20. =item - A status indicator that indicates if the known answer Self Tests (KAT's)
  21. have successfully run.
  22. =back
  23. This configuration file can be used each time a FIPS module is loaded
  24. in order to pass data to the FIPS modules self tests. The FIPS module always
  25. verifies the modules MAC, but only needs to run the KATS once during install.
  26. =head1 OPTIONS
  27. =over 4
  28. =item B<-help>
  29. Print a usage message.
  30. =item B<-module> I<filename>
  31. Filename of a fips module to perform an integrity check on.
  32. =item B<-out> I<configfilename>
  33. Filename to output the configuration data to, or standard output by default.
  34. =item B<-in> I<configfilename>
  35. Input filename to load configuration data from. Used with the '-verify' option.
  36. Standard input is used if the filename is '-'.
  37. =item B<-verify>
  38. Verify that the input configuration file contains the correct information
  39. =item B<-provider_name> I<providername>
  40. Name of the provider inside the configuration file.
  41. =item B<-section_name> I<sectionname>
  42. Name of the section inside the configuration file.
  43. =item B<-mac_name> I<name>
  44. Specifies the name of a supported MAC algorithm which will be used.
  45. To see the list of supported MAC's use the command
  46. C<openssl list -mac-algorithms>. The default is B<HMAC>.
  47. =item B<-macopt> I<nm>:I<v>
  48. Passes options to the MAC algorithm.
  49. A comprehensive list of controls can be found in the EVP_MAC implementation
  50. documentation.
  51. Common control strings used for fipsinstall are:
  52. =over 4
  53. =item B<key>:I<string>
  54. Specifies the MAC key as an alphanumeric string (use if the key contains
  55. printable characters only).
  56. The string length must conform to any restrictions of the MAC algorithm.
  57. A key must be specified for every MAC algorithm.
  58. =item B<hexkey>:I<string>
  59. Specifies the MAC key in hexadecimal form (two hex digits per byte).
  60. The key length must conform to any restrictions of the MAC algorithm.
  61. A key must be specified for every MAC algorithm.
  62. =item B<digest>:I<string>
  63. Used by HMAC as an alphanumeric string (use if the key contains printable
  64. characters only).
  65. The string length must conform to any restrictions of the MAC algorithm.
  66. To see the list of supported digests, use the command
  67. C<openssl list -digest-commands>.
  68. =back
  69. =back
  70. =head1 EXAMPLES
  71. Calculate the mac of a FIPS module F<fips.so> and run a FIPS self test
  72. for the module, and save the F<fips.conf> configuration file:
  73. openssl fipsinstall -module ./fips.so -out fips.conf -provider_name fips \
  74. -section_name fipsinstall -mac_name HMAC -macopt digest:SHA256 \
  75. -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213
  76. Verify that the configuration file F<fips.conf> contains the correct info:
  77. openssl fipsinstall -module ./fips.so -in fips.conf -provider_name fips \
  78. -section_name fips_install -mac_name HMAC -macopt digest:SHA256 \
  79. -macopt hexkey:000102030405060708090A0B0C0D0E0F10111213 -verify
  80. =head1 NOTES
  81. The MAC mechanisms that are available will depend on the options
  82. used when building OpenSSL.
  83. The command C<openssl list -mac-algorithms> command can be used to list them.
  84. =head1 SEE ALSO
  85. L<fips_config(5)>,
  86. L<EVP_MAC(3)>
  87. =head1 COPYRIGHT
  88. Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  89. Licensed under the OpenSSL license (the "License"). You may not use
  90. this file except in compliance with the License. You can obtain a copy
  91. in the file LICENSE in the source distribution or at
  92. L<https://www.openssl.org/source/license.html>.
  93. =cut