1CONFIG(5) OpenSSL CONFIG(5)
2
6 config - OpenSSL CONF library configuration files
7
9 The OpenSSL CONF library can be used to read configuration files. It
10 is used for the OpenSSL master configuration file openssl.cnf and in a
11 few other places like SPKAC files and certificate extension files for
12 the x509 utility. OpenSSL applications can also use the CONF library
13 for their own purposes.
14 A configuration file is divided into a number of sections. Each section
16 starts with a line [ section_name ] and ends when a new section is
17 started or end of file is reached. A section name can consist of
18 alphanumeric characters and underscores.
19 The first section of a configuration file is special and is referred to
21 as the default section. This section is usually unnamed and spans from
22 the start of file until the first named section. When a name is being
23 looked up it is first looked up in a named section (if any) and then
24 the default section.
25 The environment is mapped onto a section called ENV.
27 Comments can be included by preceding them with the # character
29 Other files can be included using the .include directive followed by a
31 path. If the path points to a directory all files with names ending
32 with .cnf or .conf are included from the directory. Recursive
33 inclusion of directories from files in such directory is not supported.
34 That means the files in the included directory can also contain
35 .include directives but only inclusion of regular files is supported
36 there. The inclusion of directories is not supported on systems without
37 POSIX IO support.
38 It is strongly recommended to use absolute paths with the .include
40 directive. Relative paths are evaluated based on the application
41 current working directory so unless the configuration file containing
42 the .include directive is application specific the inclusion will not
43 work as expected.
44 There can be optional = character and whitespace characters between
46 .include directive and the path which can be useful in cases the
47 configuration file needs to be loaded by old OpenSSL versions which do
48 not support the .include syntax. They would bail out with error if the
49 = character is not present but with it they just ignore the include.
50 Each section in a configuration file consists of a number of name and
52 value pairs of the form name=value
53 The name string can contain any alphanumeric characters as well as a
55 few punctuation symbols such as . , ; and _.
56 The value string consists of the string following the = character until
58 end of line with any leading and trailing white space removed.
59 The value string undergoes variable expansion. This can be done by
61 including the form $var or ${var}: this will substitute the value of
62 the named variable in the current section. It is also possible to
63 substitute a value from another section using the syntax $section::name
64 or ${section::name}. By using the form $ENV::name environment variables
65 can be substituted. It is also possible to assign values to environment
66 variables by using the name ENV::name, this will work if the program
67 looks up environment variables using the CONF library instead of
68 calling getenv() directly. The value string must not exceed 64k in
69 length after variable expansion. Otherwise an error will occur.
70 It is possible to escape certain characters by using any kind of quote
72 or the \ character. By making the last character of a line a \ a value
73 string can be spread across multiple lines. In addition the sequences
74 \n, \r, \b and \t are recognized.
75 All expansion and escape rules as described above that apply to value
77 also apply to the path of the .include directive.
78
80 Applications can automatically configure certain aspects of OpenSSL
81 using the master OpenSSL configuration file, or optionally an
82 alternative configuration file. The openssl utility includes this
83 functionality: any sub command uses the master OpenSSL configuration
84 file unless an option is used in the sub command to use an alternative
85 configuration file.
86 To enable library configuration the default section needs to contain an
88 appropriate line which points to the main configuration section. The
89 default name is openssl_conf which is used by the openssl utility.
90 Other applications may use an alternative name such as
91 myapplication_conf. All library configuration lines appear in the
92 default section at the start of the configuration file.
93 The configuration section should consist of a set of name value pairs
95 which contain specific module configuration information. The name
96 represents the name of the configuration module. The meaning of the
97 value is module specific: it may, for example, represent a further
98 configuration section containing configuration module specific
99 information. E.g.:
100 # This must be in the default section
102 openssl_conf = openssl_init
103 [openssl_init]
105 oid_section = new_oids
107 engines = engine_section
108 [new_oids]
110 ... new oids here ...
112 [engine_section]
114 ... engine stuff here ...
116 The features of each configuration module are described below.
118 ASN1 Object Configuration Module
120 This module has the name oid_section. The value of this variable points
121 to a section containing name value pairs of OIDs: the name is the OID
122 short and long name, the value is the numerical form of the OID.
123 Although some of the openssl utility sub commands already have their
124 own ASN1 OBJECT section functionality not all do. By using the ASN1
125 OBJECT configuration module all the openssl utility sub commands can
126 see the new objects as well as any compliant applications. For example:
127 [new_oids]
129 some_new_oid = 1.2.3.4
131 some_other_oid = 1.2.3.5
132 It is also possible to set the value to the long name followed by a
134 comma and the numerical OID form. For example:
135 shortName = some object long name, 1.2.3.4
137 Engine Configuration Module
139 This ENGINE configuration module has the name engines. The value of
140 this variable points to a section containing further ENGINE
141 configuration information.
142 The section pointed to by engines is a table of engine names (though
144 see engine_id below) and further sections containing configuration
145 information specific to each ENGINE.
146 Each ENGINE specific section is used to set default algorithms, load
148 dynamic, perform initialization and send ctrls. The actual operation
149 performed depends on the command name which is the name of the name
150 value pair. The currently supported commands are listed below.
151 For example:
153 [engine_section]
155 # Configure ENGINE named "foo"
157 foo = foo_section
158 # Configure ENGINE named "bar"
159 bar = bar_section
160 [foo_section]
162 ... foo ENGINE specific commands ...
163 [bar_section]
165 ... "bar" ENGINE specific commands ...
166 The command engine_id is used to give the ENGINE name. If used this
168 command must be first. For example:
169 [engine_section]
171 # This would normally handle an ENGINE named "foo"
172 foo = foo_section
173 [foo_section]
175 # Override default name and use "myfoo" instead.
176 engine_id = myfoo
177 The command dynamic_path loads and adds an ENGINE from the given path.
179 It is equivalent to sending the ctrls SO_PATH with the path argument
180 followed by LIST_ADD with value 2 and LOAD to the dynamic ENGINE. If
181 this is not the required behaviour then alternative ctrls can be sent
182 directly to the dynamic ENGINE using ctrl commands.
183 The command init determines whether to initialize the ENGINE. If the
185 value is 0 the ENGINE will not be initialized, if 1 and attempt it made
186 to initialized the ENGINE immediately. If the init command is not
187 present then an attempt will be made to initialize the ENGINE after all
188 commands in its section have been processed.
189 The command default_algorithms sets the default algorithms an ENGINE
191 will supply using the functions ENGINE_set_default_string().
192 If the name matches none of the above command names it is assumed to be
194 a ctrl command which is sent to the ENGINE. The value of the command is
195 the argument to the ctrl command. If the value is the string EMPTY then
196 no value is sent to the command.
197 For example:
199 [engine_section]
201 # Configure ENGINE named "foo"
203 foo = foo_section
204 [foo_section]
206 # Load engine from DSO
207 dynamic_path = /some/path/fooengine.so
208 # A foo specific ctrl.
209 some_ctrl = some_value
210 # Another ctrl that doesn't take a value.
211 other_ctrl = EMPTY
212 # Supply all default algorithms
213 default_algorithms = ALL
214 EVP Configuration Module
216 This modules has the name alg_section which points to a section
217 containing algorithm commands.
218 Currently the only algorithm command supported is fips_mode whose value
220 can only be the boolean string off. If fips_mode is set to on, an error
221 occurs as this library version is not FIPS capable.
222 SSL Configuration Module
224 This module has the name ssl_conf which points to a section containing
225 SSL configurations.
226 Each line in the SSL configuration section contains the name of the
228 configuration and the section containing it.
229 Each configuration section consists of command value pairs for
231 SSL_CONF. Each pair will be passed to a SSL_CTX or SSL structure if it
232 calls SSL_CTX_config() or SSL_config() with the appropriate
233 configuration name.
234 Note: any characters before an initial dot in the configuration section
236 are ignored so the same command can be used multiple times.
237 For example:
239 ssl_conf = ssl_sect
241 [ssl_sect]
243 server = server_section
245 [server_section]
247 RSA.Certificate = server-rsa.pem
249 ECDSA.Certificate = server-ecdsa.pem
250 Ciphers = ALL:!RC4
251 The system default configuration with name system_default if present
253 will be applied during any creation of the SSL_CTX structure.
254 Example of a configuration with the system default:
256 ssl_conf = ssl_sect
258 [ssl_sect]
260 system_default = system_default_sect
262 [system_default_sect]
264 MinProtocol = TLSv1.2
266
268 If a configuration file attempts to expand a variable that doesn't
269 exist then an error is flagged and the file will not load. This can
270 happen if an attempt is made to expand an environment variable that
271 doesn't exist. For example in a previous version of OpenSSL the default
272 OpenSSL master configuration file used the value of HOME which may not
273 be defined on non Unix systems and would cause an error.
274 This can be worked around by including a default section to provide a
276 default value: then if the environment lookup fails the default value
277 will be used instead. For this to work properly the default value must
278 be defined earlier in the configuration file than the expansion. See
279 the EXAMPLES section for an example of how to do this.
280 If the same variable exists in the same section then all but the last
282 value will be silently ignored. In certain circumstances such as with
283 DNs the same field may occur multiple times. This is usually worked
284 around by ignoring any characters before an initial . e.g.
285 1.OU="My first OU"
287 2.OU="My Second OU"
288
290 Here is a sample configuration file using some of the features
291 mentioned above.
292 # This is the default section.
294 HOME=/temp
296 RANDFILE= ${ENV::HOME}/.rnd
297 configdir=$ENV::HOME/config
298 [ section_one ]
300 # We are now in section one.
302 # Quotes permit leading and trailing whitespace
304 any = " any variable name "
305 other = A string that can \
307 cover several lines \
308 by including \\ characters
309 message = Hello World\n
311 [ section_two ]
313 greeting = $section_one::message
315 This next example shows how to expand environment variables safely.
317 Suppose you want a variable called tmpfile to refer to a temporary
319 filename. The directory it is placed in can determined by the TEMP or
320 TMP environment variables but they may not be set to any value at all.
321 If you just include the environment variable names and the variable
322 doesn't exist then this will cause an error when an attempt is made to
323 load the configuration file. By making use of the default section both
324 values can be looked up with TEMP taking priority and /tmp used if
325 neither is defined:
326 TMP=/tmp
328 # The above value is used if TMP isn't in the environment
329 TEMP=$ENV::TMP
330 # The above value is used if TEMP isn't in the environment
331 tmpfile=${ENV::TEMP}/tmp.filename
332 Simple OpenSSL library configuration example to enter FIPS mode:
334 # Default appname: should match "appname" parameter (if any)
336 # supplied to CONF_modules_load_file et al.
337 openssl_conf = openssl_conf_section
338 [openssl_conf_section]
340 # Configuration module list
341 alg_section = evp_sect
342 [evp_sect]
344 # Set to "yes" to enter FIPS mode if supported
345 fips_mode = yes
346 Note: in the above example you will get an error in non FIPS capable
348 versions of OpenSSL.
349 More complex OpenSSL library configuration. Add OID and don't enter
351 FIPS mode:
352 # Default appname: should match "appname" parameter (if any)
354 # supplied to CONF_modules_load_file et al.
355 openssl_conf = openssl_conf_section
356 [openssl_conf_section]
358 # Configuration module list
359 alg_section = evp_sect
360 oid_section = new_oids
361 [evp_sect]
363 # This will have no effect as FIPS mode is off by default.
364 # Set to "yes" to enter FIPS mode, if supported
365 fips_mode = no
366 [new_oids]
368 # New OID, just short name
369 newoid1 = 1.2.3.4.1
370 # New OID shortname and long name
371 newoid2 = New OID 2 long name, 1.2.3.4.2
372 The above examples can be used with any application supporting library
374 configuration if "openssl_conf" is modified to match the appropriate
375 "appname".
376 For example if the second sample file above is saved to "example.cnf"
378 then the command line:
379 OPENSSL_CONF=example.cnf openssl asn1parse -genstr OID:1.2.3.4.1
381 will output:
383 0:d=0 hl=2 l= 4 prim: OBJECT :newoid1
385 showing that the OID "newoid1" has been added as "1.2.3.4.1".
387
389 OPENSSL_CONF
390 The path to the config file. Ignored in set-user-ID and set-group-
391 ID programs.
392 OPENSSL_ENGINES
394 The path to the engines directory. Ignored in set-user-ID and set-
395 group-ID programs.
396
398 Currently there is no way to include characters using the octal \nnn
399 form. Strings are all null terminated so nulls cannot form part of the
400 value.
401 The escaping isn't quite right: if you want to use sequences like \n
403 you can't use any quote escaping on the same line.
404 Files are loaded in a single pass. This means that an variable
406 expansion will only work if the variables referenced are defined
407 earlier in the file.
408
410 x509(1), req(1), ca(1)
411
413 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
414 Licensed under the OpenSSL license (the "License"). You may not use
416 this file except in compliance with the License. You can obtain a copy
417 in the file LICENSE in the source distribution or at
418 <https://www.openssl.org/source/license.html>.
4191.1.1d 2019-10-03 CONFIG(5)