1FIPS_CONFIG(5ossl) OpenSSL FIPS_CONFIG(5ossl)
2
6 fips_config - OpenSSL FIPS configuration
7
9 A separate configuration file, using the OpenSSL config(5) syntax, is
10 used to hold information about the FIPS module. This includes a digest
11 of the shared library file, and status about the self-testing. This
12 data is used automatically by the module itself for two purposes:
13 - Run the startup FIPS self-test known answer tests (KATS).
15 This is normally done once, at installation time, but may also be
16 set up to run each time the module is used.
17 - Verify the module's checksum.
19 This is done each time the module is used.
20 This file is generated by the openssl-fipsinstall(1) program, and used
22 internally by the FIPS module during its initialization.
23 The following options are supported. They should all appear in a
25 section whose name is identified by the fips option in the providers
26 section, as described in "Provider Configuration Module" in config(5).
27 activate
29 If present, the module is activated. The value assigned to this
30 name is not significant.
31 install-version
33 A version number for the fips install process. Should be 1.
34 conditional-errors
36 The FIPS module normally enters an internal error mode if any self
37 test fails. Once this error mode is active, no services or
38 cryptographic algorithms are accessible from this point on.
39 Continuous tests are a subset of the self tests (e.g., a key pair
40 test during key generation, or the CRNG output test). Setting this
41 value to 0 allows the error mode to not be triggered if any
42 continuous test fails. The default value of 1 will trigger the
43 error mode. Regardless of the value, the operation (e.g., key
44 generation) that called the continuous test will return an error
45 code if its continuous test fails. The operation may then be
46 retried if the error mode has not been triggered.
47 security-checks
49 This indicates if run-time checks related to enforcement of
50 security parameters such as minimum security strength of keys and
51 approved curve names are used. A value of '1' will perform the
52 checks, otherwise if the value is '0' the checks are not performed
53 and FIPS compliance must be done by procedures documented in the
54 relevant Security Policy.
55 module-mac
57 The calculated MAC of the FIPS provider file.
58 install-status
60 An indicator that the self-tests were successfully run. This
61 should only be written after the module has successfully passed its
62 self tests during installation. If this field is not present, then
63 the self tests will run when the module loads.
64 install-mac
66 A MAC of the value of the install-status option, to prevent
67 accidental changes to that value. It is written-to at the same
68 time as install-status is updated.
69 For example:
71 [fips_sect]
73 activate = 1
74 install-version = 1
75 conditional-errors = 1
76 security-checks = 1
77 module-mac = 41:D0:FA:C2:5D:41:75:CD:7D:C3:90:55:6F:A4:DC
78 install-mac = FE:10:13:5A:D3:B4:C7:82:1B:1E:17:4C:AC:84:0C
79 install-status = INSTALL_SELF_TEST_KATS_RUN
80
82 When using the FIPS provider, it is recommended that the
83 config_diagnostics option is enabled to prevent accidental use of non-
84 FIPS validated algorithms via broken or mistaken configuration. See
85 config(5).
86
88 config(5) openssl-fipsinstall(1)
89
91 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
92 Licensed under the Apache License 2.0 (the "License"). You may not use
94 this file except in compliance with the License. You can obtain a copy
95 in the file LICENSE in the source distribution or at
96 <https://www.openssl.org/source/license.html>.
973.0.5 2022-11-01 FIPS_CONFIG(5ossl)