Debian Codegraph @

upstream/debian-unstable/man5/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 "CONFIG 5SSL"
58 .TH 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 config \- OpenSSL CONF library configuration files
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This page documents the syntax of OpenSSL configuration files,
68 as parsed by \fBNCONF_load\fR\|(3) and related functions.
69 This format is used by many of the OpenSSL commands, and to
70 initialize the libraries when used by any application.
71 .PP
72 The first part describes the general syntax of the configuration
73 files, and subsequent sections describe the semantics of individual
74 modules. Other modules are described in \fBfips_config\fR\|(5) and
75 \&\fBx509v3_config\fR\|(5).
76 The syntax for defining ASN.1 values is described in
77 \&\fBASN1_generate_nconf\fR\|(3).
78 .SH SYNTAX
79 .IX Header "SYNTAX"
80 A configuration file is a series of lines. Blank lines, and whitespace
81 between the elements of a line, have no significance. A comment starts
82 with a \fB#\fR character; the rest of the line is ignored. If the \fB#\fR
83 is the first non-space character in a line, the entire line is ignored.
84 .SS Directives
85 .IX Subsection "Directives"
86 Two directives can be used to control the parsing of configuration files:
87 \&\fB.include\fR and \fB.pragma\fR.
88 .PP
89 For compatibility with older versions of OpenSSL, an equal sign after the
90 directive will be ignored. Older versions will treat it as an assignment,
91 so care should be taken if the difference in semantics is important.
92 .PP
93 A file can include other files using the include syntax:
94 .PP
95 .Vb 1
96 \& .include [=] pathname
97 .Ve
98 .PP
99 If \fBpathname\fR is a simple filename, that file is included directly at
100 that point. Included files can have \fB.include\fR statements that specify
101 other files. If \fBpathname\fR is a directory, all files within that directory
102 that have a \f(CW\*(C`.cnf\*(C'\fR or \f(CW\*(C`.conf\*(C'\fR extension will be included. (This is only
103 available on systems with POSIX IO support.) Any sub-directories found
104 inside the \fBpathname\fR are \fBignored\fR. Similarly, if a file is opened
105 while scanning a directory, and that file has an \fB.include\fR directive
106 that specifies a directory, that is also ignored.
107 .PP
108 As a general rule, the \fBpathname\fR should be an absolute path; this can
109 be enforced with the \fBabspath\fR and \fBincludedir\fR pragmas, described below.
110 The environment variable \fBOPENSSL_CONF_INCLUDE\fR, if it exists,
111 is prepended to all relative pathnames.
112 If the pathname is still relative, it is interpreted based on the
113 current working directory.
114 .PP
115 To require all file inclusions to name absolute paths, use the following
116 directive:
117 .PP
118 .Vb 1
119 \& .pragma [=] abspath:value
120 .Ve
121 .PP
122 The default behavior, where the \fBvalue\fR is \fBfalse\fR or \fBoff\fR, is to allow
123 relative paths. To require all \fB.include\fR pathnames to be absolute paths,
124 use a \fBvalue\fR of \fBtrue\fR or \fBon\fR.
125 .PP
126 In these files, the dollar sign, \fB$\fR, is used to reference a variable, as
127 described below. On some platforms, however, it is common to treat \fB$\fR
128 as a regular character in symbol names. Supporting this behavior can be
129 done with the following directive:
130 .PP
131 .Vb 1
132 \& .pragma [=] dollarid:value
133 .Ve
134 .PP
135 The default behavior, where the \fBvalue\fR is \fBfalse\fR or \fBoff\fR, is to treat
136 the dollarsign as indicating a variable name; \f(CW\*(C`foo$bar\*(C'\fR is interpreted as
137 \&\f(CW\*(C`foo\*(C'\fR followed by the expansion of the variable \f(CW\*(C`bar\*(C'\fR. If \fBvalue\fR is
138 \&\fBtrue\fR or \fBon\fR, then \f(CW\*(C`foo$bar\*(C'\fR is a single seven-character name and
139 variable expansions must be specified using braces or parentheses.
140 .PP
141 .Vb 1
142 \& .pragma [=] includedir:value
143 .Ve
144 .PP
145 If a relative pathname is specified in the \fB.include\fR directive, and
146 the \fBOPENSSL_CONF_INCLUDE\fR environment variable doesn't exist, then
147 the value of the \fBincludedir\fR pragma, if it exists, is prepended to the
148 pathname.
149 .SS Settings
150 .IX Subsection "Settings"
151 A configuration file is divided into a number of \fIsections\fR. A section
152 begins with the section name in square brackets, and ends when a new
153 section starts, or at the end of the file. The section name can consist
154 of alphanumeric characters and underscores.
155 Whitespace between the name and the brackets is removed.
156 .PP
157 The first section of a configuration file is special and is referred to
158 as the \fBdefault\fR section. This section is usually unnamed and spans from
159 the start of file until the first named section. When a name is being
160 looked up, it is first looked up in the current or named section,
161 and then the default section if necessary.
162 .PP
163 The environment is mapped onto a section called \fBENV\fR.
164 .PP
165 Within a section are a series of name/value assignments, described in more
166 detail below. As a reminder, the square brackets shown in this example
167 are required, not optional:
168 .PP
169 .Vb 7
170 \& [ section ]
171 \& name1 = This is value1
172 \& name2 = Another value
173 \& ...
174 \& [ newsection ]
175 \& name1 = New value1
176 \& name3 = Value 3
177 .Ve
178 .PP
179 The \fBname\fR can contain any alphanumeric characters as well as a few
180 punctuation symbols such as \fB.\fR \fB,\fR \fB;\fR and \fB_\fR.
181 Whitespace after the name and before the equal sign is ignored.
182 .PP
183 If a name is repeated in the same section, then all but the last
184 value are ignored. In certain circumstances, such as with
185 Certificate DNs, the same field may occur multiple times.
186 In order to support this, commands like \fBopenssl\-req\fR\|(1) ignore any
187 leading text that is preceded with a period. For example:
188 .PP
189 .Vb 2
190 \& 1.OU = First OU
191 \& 2.OU = Second OU
192 .Ve
193 .PP
194 The \fBvalue\fR consists of the string following the \fB=\fR character until end
195 of line with any leading and trailing whitespace removed.
196 .PP
197 The value string undergoes variable expansion. The text \f(CW$var\fR or \f(CW\*(C`${var}\*(C'\fR
198 inserts the value of the named variable from the current section.
199 To use a value from another section use \f(CW$section::name\fR
200 or \f(CW\*(C`${section::name}\*(C'\fR.
201 By using \f(CW$ENV::name\fR, the value of the specified environment
202 variable will be substituted.
203 .PP
204 Variables must be defined before their value is referenced, otherwise
205 an error is flagged and the file will not load.
206 This can be worked around by specifying a default value in the \fBdefault\fR
207 section before the variable is used.
208 .PP
209 Any name/value settings in an \fBENV\fR section are available
210 to the configuration file, but are not propagated to the environment.
211 .PP
212 It is an error if the value ends up longer than 64k.
213 .PP
214 It is possible to escape certain characters by using a single \fB'\fR or
215 double \fB"\fR quote around the value, or using a backslash \fB\e\fR before the
216 character,
217 By making the last character of a line a \fB\e\fR
218 a \fBvalue\fR string can be spread across multiple lines. In addition
219 the sequences \fB\en\fR, \fB\er\fR, \fB\eb\fR and \fB\et\fR are recognized.
220 .PP
221 The expansion and escape rules as described above that apply to \fBvalue\fR
222 also apply to the pathname of the \fB.include\fR directive.
223 .SH "OPENSSL LIBRARY CONFIGURATION"
224 .IX Header "OPENSSL LIBRARY CONFIGURATION"
225 The sections below use the informal term \fImodule\fR to refer to a part
226 of the OpenSSL functionality. This is not the same as the formal term
227 \&\fIFIPS module\fR, for example.
228 .PP
229 The OpenSSL configuration looks up the value of \fBopenssl_conf\fR
230 in the default section and takes that as the name of a section that specifies
231 how to configure any modules in the library. It is not an error to leave
232 any module in its default configuration. An application can specify a
233 different name by calling \fBCONF_modules_load_file()\fR, for example, directly.
234 .PP
235 OpenSSL also looks up the value of \fBconfig_diagnostics\fR.
236 If this exists and has a nonzero numeric value, any error suppressing flags
237 passed to \fBCONF_modules_load()\fR will be ignored.
238 This is useful for diagnosing misconfigurations but its use in
239 production requires additional consideration. With this option enabled,
240 a configuration error will completely prevent access to a service.
241 Without this option and in the presence of a configuration error, access
242 will be allowed but the desired configuration will \fBnot\fR be used.
243 .PP
244 .Vb 3
245 \& # These must be in the default section
246 \& config_diagnostics = 1
247 \& openssl_conf = openssl_init
248 \&
249 \& [openssl_init]
250 \& oid_section = oids
251 \& providers = providers
252 \& alg_section = evp_properties
253 \& ssl_conf = ssl_configuration
254 \& engines = engines
255 \& random = random
256 \&
257 \& [oids]
258 \& ... new oids here ...
259 \&
260 \& [providers]
261 \& ... provider stuff here ...
262 \&
263 \& [evp_properties]
264 \& ... EVP properties here ...
265 \&
266 \& [ssl_configuration]
267 \& ... SSL/TLS configuration properties here ...
268 \&
269 \& [engines]
270 \& ... engine properties here ...
271 \&
272 \& [random]
273 \& ... random properties here ...
274 .Ve
275 .PP
276 The semantics of each module are described below. The phrase "in the
277 initialization section" refers to the section identified by the
278 \&\fBopenssl_conf\fR or other name (given as \fBopenssl_init\fR in the
279 example above). The examples below assume the configuration above
280 is used to specify the individual sections.
281 .SS "ASN.1 Object Identifier Configuration"
282 .IX Subsection "ASN.1 Object Identifier Configuration"
283 The name \fBoid_section\fR in the initialization section names the section
284 containing name/value pairs of OID's.
285 The name is the short name; the value is an optional long name followed
286 by a comma, and the numeric value.
287 While some OpenSSL commands have their own section for specifying OID's,
288 this section makes them available to all commands and applications.
289 .PP
290 .Vb 4
291 \& [oids]
292 \& shortName = a very long OID name, 1.2.3.4
293 \& newoid1 = 1.2.3.4.1
294 \& some_other_oid = 1.2.3.5
295 .Ve
296 .PP
297 If a full configuration with the above fragment is in the file
298 \&\fIexample.cnf\fR, then the following command line:
299 .PP
300 .Vb 1
301 \& OPENSSL_CONF=example.cnf openssl asn1parse \-genstr OID:1.2.3.4.1
302 .Ve
303 .PP
304 will output:
305 .PP
306 .Vb 1
307 \& 0:d=0 hl=2 l= 4 prim: OBJECT :newoid1
308 .Ve
309 .PP
310 showing that the OID "newoid1" has been added as "1.2.3.4.1".
311 .SS "Provider Configuration"
312 .IX Subsection "Provider Configuration"
313 The name \fBproviders\fR in the initialization section names the section
314 containing cryptographic provider configuration. The name/value assignments
315 in this section each name a provider, and point to the configuration section
316 for that provider. The provider-specific section is used to specify how
317 to load the module, activate it, and set other parameters.
318 .PP
319 Within a provider section, the following names have meaning:
320 .IP \fBidentity\fR 4
321 .IX Item "identity"
322 This is used to specify an alternate name, overriding the default name
323 specified in the list of providers. For example:
324 .Sp
325 .Vb 2
326 \& [providers]
327 \& foo = foo_provider
328 \&
329 \& [foo_provider]
330 \& identity = my_fips_module
331 .Ve
332 .IP \fBmodule\fR 4
333 .IX Item "module"
334 Specifies the pathname of the module (typically a shared library) to load.
335 .IP \fBactivate\fR 4
336 .IX Item "activate"
337 If present and set to one of the values yes, on, true or 1, then the associated
338 provider will be activated. Conversely, setting this value to no, off, false, or
339 0 will prevent the provider from being activated. Settings can be given in lower
340 or uppercase. Setting activate to any other setting, or omitting a setting
341 value will result in an error.
342 .Sp
343 = item \fBsoft_load\fR
344 .Sp
345 If enabled, informs the library to clear the error stack on failure to activate
346 requested provider. A value of 1, yes, true or on (in lower or uppercase) will
347 activate this setting, while a value of 0, no, false, or off (again in lower or
348 uppercase) will disable this setting. Any other value will produce an error.
349 Note this setting defaults to off if not provided
350 .PP
351 All parameters in the section as well as sub-sections are made
352 available to the provider.
353 .PP
354 \fIDefault provider and its activation\fR
355 .IX Subsection "Default provider and its activation"
356 .PP
357 If no providers are activated explicitly, the default one is activated implicitly.
358 See \fBOSSL_PROVIDER\-default\fR\|(7) for more details.
359 .PP
360 If you add a section explicitly activating any other provider(s),
361 you most probably need to explicitly activate the default provider,
362 otherwise it becomes unavailable in openssl. It may make the system remotely unavailable.
363 .SS "EVP Configuration"
364 .IX Subsection "EVP Configuration"
365 The name \fBalg_section\fR in the initialization section names the section
366 containing algorithmic properties when using the \fBEVP\fR API.
367 .PP
368 Within the algorithm properties section, the following names have meaning:
369 .IP \fBdefault_properties\fR 4
370 .IX Item "default_properties"
371 The value may be anything that is acceptable as a property query
372 string for \fBEVP_set_default_properties()\fR.
373 .IP "\fBfips_mode\fR (deprecated)" 4
374 .IX Item "fips_mode (deprecated)"
375 The value is a boolean that can be \fByes\fR or \fBno\fR. If the value is
376 \&\fByes\fR, this is exactly equivalent to:
377 .Sp
378 .Vb 1
379 \& default_properties = fips=yes
380 .Ve
381 .Sp
382 If the value is \fBno\fR, nothing happens. Using this name is deprecated, and
383 if used, it must be the only name in the section.
384 .SS "SSL Configuration"
385 .IX Subsection "SSL Configuration"
386 The name \fBssl_conf\fR in the initialization section names the section
387 containing the list of SSL/TLS configurations.
388 As with the providers, each name in this section identifies a
389 section with the configuration for that name. For example:
390 .PP
391 .Vb 4
392 \& [ssl_configuration]
393 \& server = server_tls_config
394 \& client = client_tls_config
395 \& system_default = tls_system_default
396 \&
397 \& [server_tls_config]
398 \& ... configuration for SSL/TLS servers ...
399 \&
400 \& [client_tls_config]
401 \& ... configuration for SSL/TLS clients ...
402 .Ve
403 .PP
404 The configuration name \fBsystem_default\fR has a special meaning. If it
405 exists, it is applied whenever an \fBSSL_CTX\fR object is created. For example,
406 to impose system-wide minimum TLS and DTLS protocol versions:
407 .PP
408 .Vb 3
409 \& [tls_system_default]
410 \& MinProtocol = TLSv1.2
411 \& MinProtocol = DTLSv1.2
412 .Ve
413 .PP
414 The minimum TLS protocol is applied to \fBSSL_CTX\fR objects that are TLS-based,
415 and the minimum DTLS protocol to those are DTLS-based.
416 The same applies also to maximum versions set with \fBMaxProtocol\fR.
417 .PP
418 Each configuration section consists of name/value pairs that are parsed
419 by \fBSSL_CONF_cmd\|(3)\fR, which will be called by \fBSSL_CTX_config()\fR or
420 \&\fBSSL_config()\fR, appropriately. Note that any characters before an initial
421 dot in the configuration section are ignored, so that the same command can
422 be used multiple times. This probably is most useful for loading different
423 key types, as shown here:
424 .PP
425 .Vb 3
426 \& [server_tls_config]
427 \& RSA.Certificate = server\-rsa.pem
428 \& ECDSA.Certificate = server\-ecdsa.pem
429 .Ve
430 .SS "Engine Configuration"
431 .IX Subsection "Engine Configuration"
432 The name \fBengines\fR in the initialization section names the section
433 containing the list of ENGINE configurations.
434 As with the providers, each name in this section identifies an engine
435 with the configuration for that engine.
436 The engine-specific section is used to specify how to load the engine,
437 activate it, and set other parameters.
438 .PP
439 Within an engine section, the following names have meaning:
440 .IP \fBengine_id\fR 4
441 .IX Item "engine_id"
442 This is used to specify an alternate name, overriding the default name
443 specified in the list of engines. If present, it must be first.
444 For example:
445 .Sp
446 .Vb 2
447 \& [engines]
448 \& foo = foo_engine
449 \&
450 \& [foo_engine]
451 \& engine_id = myfoo
452 .Ve
453 .IP \fBdynamic_path\fR 4
454 .IX Item "dynamic_path"
455 This loads and adds an ENGINE from the given path. It is equivalent to
456 sending the ctrls \fBSO_PATH\fR with the path argument followed by \fBLIST_ADD\fR
457 with value \fB2\fR and \fBLOAD\fR to the dynamic ENGINE. If this is not the
458 required behaviour then alternative ctrls can be sent directly to the
459 dynamic ENGINE using ctrl commands.
460 .IP \fBinit\fR 4
461 .IX Item "init"
462 This specifies whether to initialize the ENGINE. If the value is \fB0\fR the
463 ENGINE will not be initialized, if the value is \fB1\fR an attempt is made
464 to initialize
465 the ENGINE immediately. If the \fBinit\fR command is not present then an
466 attempt will be made to initialize the ENGINE after all commands in its
467 section have been processed.
468 .IP \fBdefault_algorithms\fR 4
469 .IX Item "default_algorithms"
470 This sets the default algorithms an ENGINE will supply using the function
471 \&\fBENGINE_set_default_string()\fR.
472 .PP
473 All other names are taken to be the name of a ctrl command that is
474 sent to the ENGINE, and the value is the argument passed with the command.
475 The special value \fBEMPTY\fR means no value is sent with the command.
476 For example:
477 .PP
478 .Vb 2
479 \& [engines]
480 \& foo = foo_engine
481 \&
482 \& [foo_engine]
483 \& dynamic_path = /some/path/fooengine.so
484 \& some_ctrl = some_value
485 \& default_algorithms = ALL
486 \& other_ctrl = EMPTY
487 .Ve
488 .SS "Random Configuration"
489 .IX Subsection "Random Configuration"
490 The name \fBrandom\fR in the initialization section names the section
491 containing the random number generator settings.
492 .PP
493 Within the random section, the following names have meaning:
494 .IP \fBrandom\fR 4
495 .IX Item "random"
496 This is used to specify the random bit generator.
497 For example:
498 .Sp
499 .Vb 2
500 \& [random]
501 \& random = CTR\-DRBG
502 .Ve
503 .Sp
504 The available random bit generators are:
505 .RS 4
506 .IP \fBCTR-DRBG\fR 4
507 .IX Item "CTR-DRBG"
508 .PD 0
509 .IP \fBHASH-DRBG\fR 4
510 .IX Item "HASH-DRBG"
511 .IP \fBHMAC-DRBG\fR 4
512 .IX Item "HMAC-DRBG"
513 .RE
514 .RS 4
515 .RE
516 .IP \fBcipher\fR 4
517 .IX Item "cipher"
518 .PD
519 This specifies what cipher a \fBCTR-DRBG\fR random bit generator will use.
520 Other random bit generators ignore this name.
521 The default value is \fBAES\-256\-CTR\fR.
522 .IP \fBdigest\fR 4
523 .IX Item "digest"
524 This specifies what digest the \fBHASH-DRBG\fR or \fBHMAC-DRBG\fR random bit
525 generators will use. Other random bit generators ignore this name.
526 .IP \fBproperties\fR 4
527 .IX Item "properties"
528 This sets the property query used when fetching the random bit generator and
529 any underlying algorithms.
530 .IP \fBseed\fR 4
531 .IX Item "seed"
532 This sets the randomness source that should be used. By default \fBSEED-SRC\fR
533 will be used outside of the FIPS provider. The FIPS provider uses call backs
534 to access the same randomness sources from outside the validated boundary.
535 .IP \fBseed_properties\fR 4
536 .IX Item "seed_properties"
537 This sets the property query used when fetching the randomness source.
538 .IP \fBrandom_provider\fR 4
539 .IX Item "random_provider"
540 This sets the provider to use for the \fBRAND_bytes\fR\|(3) calls instead of the built-in
541 entropy sources. It defaults to "fips". If the named provider is not loaded, the
542 built-in entropy sources will be used.
543 .SH EXAMPLES
544 .IX Header "EXAMPLES"
545 This example shows how to use quoting and escaping.
546 .PP
547 .Vb 3
548 \& # This is the default section.
549 \& HOME = /temp
550 \& configdir = $ENV::HOME/config
551 \&
552 \& [ section_one ]
553 \& # Quotes permit leading and trailing whitespace
554 \& any = " any variable name "
555 \& other = A string that can \e
556 \& cover several lines \e
557 \& by including \e\e characters
558 \& message = Hello World\en
559 \&
560 \& [ section_two ]
561 \& greeting = $section_one::message
562 .Ve
563 .PP
564 This example shows how to expand environment variables safely.
565 In this example, the variable \fBtempfile\fR is intended to refer
566 to a temporary file, and the environment variable \fBTEMP\fR or
567 \&\fBTMP\fR, if present, specify the directory where the file
568 should be put.
569 Since the default section is checked if a variable does not
570 exist, it is possible to set \fBTMP\fR to default to \fI/tmp\fR, and
571 \&\fBTEMP\fR to default to \fBTMP\fR.
572 .PP
573 .Vb 3
574 \& # These two lines must be in the default section.
575 \& TMP = /tmp
576 \& TEMP = $ENV::TMP
577 \&
578 \& # This can be used anywhere
579 \& tmpfile = ${ENV::TEMP}/tmp.filename
580 .Ve
581 .PP
582 This example shows how to enforce FIPS mode for the application
583 \&\fIsample\fR.
584 .PP
585 .Vb 1
586 \& sample = fips_config
587 \&
588 \& [fips_config]
589 \& alg_section = evp_properties
590 \&
591 \& [evp_properties]
592 \& default_properties = "fips=yes"
593 .Ve
594 .SH ENVIRONMENT
595 .IX Header "ENVIRONMENT"
596 .IP \fBOPENSSL_CONF\fR 4
597 .IX Item "OPENSSL_CONF"
598 The path to the config file, or the empty string for none.
599 Ignored in set-user-ID and set-group-ID programs.
600 .IP \fBOPENSSL_ENGINES\fR 4
601 .IX Item "OPENSSL_ENGINES"
602 The path to the engines directory.
603 Ignored in set-user-ID and set-group-ID programs.
604 .IP \fBOPENSSL_MODULES\fR 4
605 .IX Item "OPENSSL_MODULES"
606 The path to the directory with OpenSSL modules, such as providers.
607 Ignored in set-user-ID and set-group-ID programs.
608 .IP \fBOPENSSL_CONF_INCLUDE\fR 4
609 .IX Item "OPENSSL_CONF_INCLUDE"
610 The optional path to prepend to all \fB.include\fR paths.
611 .SH BUGS
612 .IX Header "BUGS"
613 There is no way to include characters using the octal \fB\ennn\fR form. Strings
614 are all null terminated so nulls cannot form part of the value.
615 .PP
616 The escaping isn't quite right: if you want to use sequences like \fB\en\fR
617 you can't use any quote escaping on the same line.
618 .PP
619 The limit that only one directory can be opened and read at a time
620 can be considered a bug and should be fixed.
621 .SH HISTORY
622 .IX Header "HISTORY"
623 An undocumented API, \fBNCONF_WIN32()\fR, used a slightly different set
624 of parsing rules there were intended to be tailored to
625 the Microsoft Windows platform.
626 Specifically, the backslash character was not an escape character and
627 could be used in pathnames, only the double-quote character was recognized,
628 and comments began with a semi-colon.
629 This function was deprecated in OpenSSL 3.0; applications with
630 configuration files using that syntax will have to be modified.
631 .SH "SEE ALSO"
632 .IX Header "SEE ALSO"
633 \&\fBopenssl\-x509\fR\|(1), \fBopenssl\-req\fR\|(1), \fBopenssl\-ca\fR\|(1),
634 \&\fBopenssl\-fipsinstall\fR\|(1),
635 \&\fBASN1_generate_nconf\fR\|(3),
636 \&\fBEVP_set_default_properties\fR\|(3),
637 \&\fBCONF_modules_load\fR\|(3),
638 \&\fBCONF_modules_load_file\fR\|(3),
639 \&\fBRAND_bytes\fR\|(3),
640 \&\fBfips_config\fR\|(5), and
641 \&\fBx509v3_config\fR\|(5).
642 .SH COPYRIGHT
643 .IX Header "COPYRIGHT"
644 Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved.
645 .PP
646 Licensed under the Apache License 2.0 (the "License"). You may not use
647 this file except in compliance with the License. You can obtain a copy
648 in the file LICENSE in the source distribution or at
649 <https://www.openssl.org/source/license.html>.