doc/man5/fips_config.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 fips_config - OpenSSL FIPS configuration
   6
   7 =head1 DESCRIPTION
   8
   9 A separate configuration file, using the OpenSSL L<config(5)> syntax,
  10 is used to hold information about the FIPS module. This includes a digest
  11 of the shared library file, and status about the self-testing.
  12 This data is used automatically by the module itself for two
  13 purposes:
  14
  15 =over 4
  16
  17 =item - Run the startup FIPS self-test known answer tests (KATS).
  18
  19 This is done once, at installation time.
  20
  21 =item - Verify the module's checksum.
  22
  23 This is done each time the module is used.
  24
  25 =back
  26
  27 This file is generated by the L<openssl-fipsinstall(1)> program, and
  28 used internally by the FIPS module during its initialization.
  29
  30 The following options are supported. They should all appear in a section
  31 whose name is identified by the B<fips> option in the B<providers>
  32 section, as desribed in L<config(5)/Provider Configuration Module>.
  33
  34 =over 4
  35
  36 =item B<module-checksum>
  37
  38 The calculated digest of the module file.
  39
  40 =item B<install-version>
  41
  42 A version number for the fips install process. Should be 1.
  43
  44 =item B<install-status>
  45
  46 An indicator that the self-tests were run.
  47 This should only be written after the module has
  48 successfully passed its self tests during installation.
  49 If this field is not present, then the self tests will run when the module
  50 loads.
  51
  52 =item B<install-checksum>
  53
  54 A MAC on the value of the B<install-status> option, to prevent accidental
  55 changes to that value.
  56 It is written-to at the same time as B<install-status> is updated.
  57
  58 =back
  59
  60 For example:
  61
  62  [fips_install]
  63  install-version = 1
  64  module-checksum = 41:D0:FA:C2:5D:41:75:CD:7D:C3:90:55:6F:A4:DC
  65  install-checksum = FE:10:13:5A:D3:B4:C7:82:1B:1E:17:4C:AC:84:0C
  66  install-status = INSTALL_SELF_TEST_KATS_RUN
  67
  68 =head1 SEE ALSO
  69
  70 L<config(5)>
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  75
  76 Licensed under the Apache License 2.0 (the "License").  You may not use
  77 this file except in compliance with the License.  You can obtain a copy
  78 in the file LICENSE in the source distribution or at
  79 L<https://www.openssl.org/source/license.html>.
  80
  81 =cut