Debian Codegraph @

upstream/debian-unstable/man5/fips_config.5ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "FIPS_CONFIG 5SSL"
58 .TH FIPS_CONFIG 5SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 fips_config \- OpenSSL FIPS configuration
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 A separate configuration file, using the OpenSSL \fBconfig\fR\|(5) syntax,
68 is used to hold information about the FIPS module. This includes a digest
69 of the shared library file, and status about the self-testing.
70 This data is used automatically by the module itself for two
71 purposes:
72 .IP "\- Run the startup FIPS self-test known answer tests (KATS)." 4
73 .IX Item "- Run the startup FIPS self-test known answer tests (KATS)."
74 This is normally done once, at installation time, but may also be set up to
75 run each time the module is used.
76 .IP "\- Verify the module's checksum." 4
77 .IX Item "- Verify the module's checksum."
78 This is done each time the module is used.
79 .PP
80 This file is generated by the \fBopenssl\-fipsinstall\fR\|(1) program, and
81 used internally by the FIPS module during its initialization.
82 .PP
83 The following options are supported. They should all appear in a section
84 whose name is identified by the \fBfips\fR option in the \fBproviders\fR
85 section, as described in "Provider Configuration Module" in \fBconfig\fR\|(5).
86 .IP \fBactivate\fR 4
87 .IX Item "activate"
88 If present, the module is activated. The value assigned to this name is not
89 significant.
90 .IP \fBconditional-errors\fR 4
91 .IX Item "conditional-errors"
92 The FIPS module normally enters an internal error mode if any self test fails.
93 Once this error mode is active, no services or cryptographic algorithms are
94 accessible from this point on.
95 Continuous tests are a subset of the self tests (e.g., a key pair test during key
96 generation, or the CRNG output test).
97 Setting this value to \f(CW0\fR allows the error mode to not be triggered if any
98 continuous test fails. The default value of \f(CW1\fR will trigger the error mode.
99 Regardless of the value, the operation (e.g., key generation) that called the
100 continuous test will return an error code if its continuous test fails. The
101 operation may then be retried if the error mode has not been triggered.
102 .IP \fBmodule-mac\fR 4
103 .IX Item "module-mac"
104 The calculated MAC of the FIPS provider file.
105 .IP \fBinstall-version\fR 4
106 .IX Item "install-version"
107 A version number for the fips install process. Should be 1.
108 .IP \fBinstall-status\fR 4
109 .IX Item "install-status"
110 This field is deprecated and is no longer used.
111 .IP \fBinstall-mac\fR 4
112 .IX Item "install-mac"
113 This field is deprecated and is no longer used.
114 .SS "FIPS indicator options"
115 .IX Subsection "FIPS indicator options"
116 The following FIPS configuration options indicate if run-time checks related to
117 enforcement of FIPS security parameters such as minimum security strength of
118 keys and approved curve names are used.
119 A value of '1' will perform the checks, otherwise if the value is '0' the checks
120 are not performed and FIPS compliance must be done by procedures documented in
121 the relevant Security Policy.
122 .PP
123 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) for further information related to these
124 options.
125 .IP \fBsecurity-checks\fR 4
126 .IX Item "security-checks"
127 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-no_security_checks\fR
128 .IP \fBtls1\-prf\-ems\-check\fR 4
129 .IX Item "tls1-prf-ems-check"
130 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-ems_check\fR
131 .IP \fBno-short-mac\fR 4
132 .IX Item "no-short-mac"
133 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-no_short_mac\fR
134 .IP \fBdrbg-no-trunc-md\fR 4
135 .IX Item "drbg-no-trunc-md"
136 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-no_drbg_truncated_digests\fR
137 .IP \fBsignature-digest-check\fR 4
138 .IX Item "signature-digest-check"
139 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-signature_digest_check\fR
140 .IP \fBhkdf-digest-check\fR 4
141 .IX Item "hkdf-digest-check"
142 This option is deprecated.
143 .IP \fBtls13\-kdf\-digest\-check\fR 4
144 .IX Item "tls13-kdf-digest-check"
145 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-tls13_kdf_digest_check\fR
146 .IP \fBtls1\-prf\-digest\-check\fR 4
147 .IX Item "tls1-prf-digest-check"
148 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-tls1_prf_digest_check\fR
149 .IP \fBsshkdf-digest-check\fR 4
150 .IX Item "sshkdf-digest-check"
151 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-sshkdf_digest_check\fR
152 .IP \fBsskdf-digest-check\fR 4
153 .IX Item "sskdf-digest-check"
154 This option is deprecated.
155 .IP \fBx963kdf\-digest\-check\fR 4
156 .IX Item "x963kdf-digest-check"
157 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-x963kdf_digest_check\fR
158 .IP \fBdsa-sign-disabled\fR 4
159 .IX Item "dsa-sign-disabled"
160 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-dsa_sign_disabled\fR
161 .IP \fBtdes-encrypt-disabled\fR 4
162 .IX Item "tdes-encrypt-disabled"
163 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-tdes_encrypt_disabled\fR
164 .IP \fBrsa\-pkcs15\-pad\-disabled\fR 4
165 .IX Item "rsa-pkcs15-pad-disabled"
166 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-rsa_pkcs15_pad_disabled\fR
167 .IP \fBrsa-pss-saltlen-check\fR 4
168 .IX Item "rsa-pss-saltlen-check"
169 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-rsa_pss_saltlen_check\fR
170 .IP \fBrsa\-sign\-x931\-pad\-disabled\fR 4
171 .IX Item "rsa-sign-x931-pad-disabled"
172 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-rsa_sign_x931_disabled\fR
173 .IP \fBhkdf-key-check\fR 4
174 .IX Item "hkdf-key-check"
175 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-hkdf_key_check\fR
176 .IP \fBkbkdf-key-check\fR 4
177 .IX Item "kbkdf-key-check"
178 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-kbkdf_key_check\fR
179 .IP \fBtls13\-kdf\-key\-check\fR 4
180 .IX Item "tls13-kdf-key-check"
181 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-tls13_kdf_key_check\fR
182 .IP \fBtls1\-prf\-key\-check\fR 4
183 .IX Item "tls1-prf-key-check"
184 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-tls1_prf_key_check\fR
185 .IP \fBsshkdf-key-check\fR 4
186 .IX Item "sshkdf-key-check"
187 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-sshkdf_key_check\fR
188 .IP \fBsskdf-key-check\fR 4
189 .IX Item "sskdf-key-check"
190 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-sskdf_key_check\fR
191 .IP \fBx963kdf\-key\-check\fR 4
192 .IX Item "x963kdf-key-check"
193 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-x963kdf_key_check\fR
194 .IP \fBx942kdf\-key\-check\fR 4
195 .IX Item "x942kdf-key-check"
196 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-x942kdf_key_check\fR
197 .IP \fBpbkdf2\-lower\-bound\-check\fR 4
198 .IX Item "pbkdf2-lower-bound-check"
199 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-no_pbkdf2_lower_bound_check\fR
200 .IP \fBecdh-cofactor-check\fR 4
201 .IX Item "ecdh-cofactor-check"
202 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-ecdh_cofactor_check\fR
203 .IP \fBhmac-key-check\fR 4
204 .IX Item "hmac-key-check"
205 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-hmac_key_check\fR
206 .IP \fBkmac-key-check\fR 4
207 .IX Item "kmac-key-check"
208 See "OPTIONS" in \fBopenssl\-fipsinstall\fR\|(1) \fB\-kmac_key_check\fR
209 .PP
210 For example:
211 .PP
212 .Vb 8
213 \& [fips_sect]
214 \& activate = 1
215 \& install\-version = 1
216 \& conditional\-errors = 1
217 \& security\-checks = 1
218 \& module\-mac = 41:D0:FA:C2:5D:41:75:CD:7D:C3:90:55:6F:A4:DC
219 \& install\-mac = FE:10:13:5A:D3:B4:C7:82:1B:1E:17:4C:AC:84:0C
220 \& install\-status = INSTALL_SELF_TEST_KATS_RUN
221 .Ve
222 .SH NOTES
223 .IX Header "NOTES"
224 When using the FIPS provider, it is recommended that the
225 \&\fBconfig_diagnostics\fR option is enabled to prevent accidental use of
226 non-FIPS validated algorithms via broken or mistaken configuration.
227 See \fBconfig\fR\|(5).
228 .SH "SEE ALSO"
229 .IX Header "SEE ALSO"
230 \&\fBconfig\fR\|(5)
231 \&\fBopenssl\-fipsinstall\fR\|(1)
232 .SH HISTORY
233 .IX Header "HISTORY"
234 This functionality was added in OpenSSL 3.0.
235 .SH COPYRIGHT
236 .IX Header "COPYRIGHT"
237 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.
238 .PP
239 Licensed under the Apache License 2.0 (the "License"). You may not use
240 this file except in compliance with the License. You can obtain a copy
241 in the file LICENSE in the source distribution or at
242 <https://www.openssl.org/source/license.html>.