]>
Commit | Line | Data |
---|---|---|
aba3e65f DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
19d2bb57 | 5 | config - OpenSSL CONF library configuration files |
aba3e65f DSH |
6 | |
7 | =head1 DESCRIPTION | |
8 | ||
19d2bb57 | 9 | The OpenSSL CONF library can be used to read configuration files. |
aba3e65f DSH |
10 | It is used for the OpenSSL master configuration file B<openssl.cnf> |
11 | and in a few other places like B<SPKAC> files and certificate extension | |
a30af36c DSH |
12 | files for the B<x509> utility. OpenSSL applications can also use the |
13 | CONF library for their own purposes. | |
aba3e65f DSH |
14 | |
15 | A configuration file is divided into a number of sections. Each section | |
16 | starts with a line B<[ 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 | ||
20 | The first section of a configuration file is special and is referred | |
0652e8a7 | 21 | to as the B<default> section. This section is usually unnamed and spans from the |
aba3e65f DSH |
22 | start of file until the first named section. When a name is being looked up |
23 | it is first looked up in a named section (if any) and then the | |
24 | default section. | |
25 | ||
26 | The environment is mapped onto a section called B<ENV>. | |
27 | ||
28 | Comments can be included by preceding them with the B<#> character | |
29 | ||
b524b808 TM |
30 | Other files can be included using the B<.include> directive followed |
31 | by a path. If the path points to a directory all files with | |
32 | names ending with B<.cnf> or B<.conf> are included from the directory. | |
33 | Recursive inclusion of directories from files in such directory is not | |
34 | supported. That means the files in the included directory can also contain | |
35 | B<.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 | ||
39 | It is strongly recommended to use absolute paths with the B<.include> | |
40 | directive. Relative paths are evaluated based on the application current | |
41 | working directory so unless the configuration file containing the | |
42 | B<.include> directive is application specific the inclusion will not | |
43 | work as expected. | |
44 | ||
9d556033 TM |
45 | There can be optional B<=> character and whitespace characters between |
46 | B<.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 B<.include> syntax. They would bail out with error | |
49 | if the B<=> character is not present but with it they just ignore | |
50 | the include. | |
51 | ||
aba3e65f DSH |
52 | Each section in a configuration file consists of a number of name and |
53 | value pairs of the form B<name=value> | |
54 | ||
55 | The B<name> string can contain any alphanumeric characters as well as | |
56 | a few punctuation symbols such as B<.> B<,> B<;> and B<_>. | |
57 | ||
58 | The B<value> string consists of the string following the B<=> character | |
59 | until end of line with any leading and trailing white space removed. | |
60 | ||
61 | The value string undergoes variable expansion. This can be done by | |
62 | including the form B<$var> or B<${var}>: this will substitute the value | |
63 | of the named variable in the current section. It is also possible to | |
64 | substitute a value from another section using the syntax B<$section::name> | |
19d2bb57 | 65 | or B<${section::name}>. By using the form B<$ENV::name> environment |
aba3e65f DSH |
66 | variables can be substituted. It is also possible to assign values to |
67 | environment variables by using the name B<ENV::name>, this will work | |
68 | if the program looks up environment variables using the B<CONF> library | |
8a585601 MC |
69 | instead of calling getenv() directly. The value string must not exceed 64k in |
70 | length after variable expansion. Otherwise an error will occur. | |
aba3e65f DSH |
71 | |
72 | It is possible to escape certain characters by using any kind of quote | |
73 | or the B<\> character. By making the last character of a line a B<\> | |
74 | a B<value> string can be spread across multiple lines. In addition | |
657e60fa | 75 | the sequences B<\n>, B<\r>, B<\b> and B<\t> are recognized. |
aba3e65f | 76 | |
b524b808 TM |
77 | All expansion and escape rules as described above that apply to B<value> |
78 | also apply to the path of the B<.include> directive. | |
79 | ||
a30af36c DSH |
80 | =head1 OPENSSL LIBRARY CONFIGURATION |
81 | ||
a528d4f0 | 82 | Applications can automatically configure certain |
a30af36c DSH |
83 | aspects of OpenSSL using the master OpenSSL configuration file, or optionally |
84 | an alternative configuration file. The B<openssl> utility includes this | |
85 | functionality: any sub command uses the master OpenSSL configuration file | |
86 | unless an option is used in the sub command to use an alternative configuration | |
87 | file. | |
88 | ||
1bc74519 | 89 | To enable library configuration the default section needs to contain an |
a30af36c DSH |
90 | appropriate line which points to the main configuration section. The default |
91 | name is B<openssl_conf> which is used by the B<openssl> utility. Other | |
a8c5ed81 | 92 | applications may use an alternative name such as B<myapplication_conf>. |
93 | All library configuration lines appear in the default section at the start | |
94 | of the configuration file. | |
a30af36c DSH |
95 | |
96 | The configuration section should consist of a set of name value pairs which | |
97 | contain specific module configuration information. The B<name> represents | |
cb1b2caf | 98 | the name of the I<configuration module>. The meaning of the B<value> is |
a30af36c | 99 | module specific: it may, for example, represent a further configuration |
cb1b2caf | 100 | section containing configuration module specific information. E.g.: |
a30af36c | 101 | |
a8c5ed81 | 102 | # This must be in the default section |
a30af36c DSH |
103 | openssl_conf = openssl_init |
104 | ||
105 | [openssl_init] | |
106 | ||
107 | oid_section = new_oids | |
108 | engines = engine_section | |
b6670f69 | 109 | providers = provider_section |
a30af36c DSH |
110 | |
111 | [new_oids] | |
112 | ||
113 | ... new oids here ... | |
114 | ||
115 | [engine_section] | |
116 | ||
117 | ... engine stuff here ... | |
118 | ||
b6670f69 RL |
119 | [provider_section] |
120 | ||
121 | ... provider stuff here ... | |
122 | ||
3d764db7 | 123 | The features of each configuration module are described below. |
a30af36c | 124 | |
05ea606a | 125 | =head2 ASN1 Object Configuration Module |
a30af36c DSH |
126 | |
127 | This module has the name B<oid_section>. The value of this variable points | |
128 | to a section containing name value pairs of OIDs: the name is the OID short | |
129 | and long name, the value is the numerical form of the OID. Although some of | |
130 | the B<openssl> utility sub commands already have their own ASN1 OBJECT section | |
131 | functionality not all do. By using the ASN1 OBJECT configuration module | |
132 | B<all> the B<openssl> utility sub commands can see the new objects as well | |
133 | as any compliant applications. For example: | |
134 | ||
135 | [new_oids] | |
1bc74519 | 136 | |
a30af36c DSH |
137 | some_new_oid = 1.2.3.4 |
138 | some_other_oid = 1.2.3.5 | |
139 | ||
a528d4f0 | 140 | It is also possible to set the value to the long name followed |
6446e0c3 DSH |
141 | by a comma and the numerical OID form. For example: |
142 | ||
143 | shortName = some object long name, 1.2.3.4 | |
144 | ||
05ea606a | 145 | =head2 Engine Configuration Module |
a30af36c | 146 | |
f2c18125 DSH |
147 | This ENGINE configuration module has the name B<engines>. The value of this |
148 | variable points to a section containing further ENGINE configuration | |
149 | information. | |
150 | ||
151 | The section pointed to by B<engines> is a table of engine names (though see | |
2b4ffc65 | 152 | B<engine_id> below) and further sections containing configuration information |
f2c18125 DSH |
153 | specific to each ENGINE. |
154 | ||
155 | Each ENGINE specific section is used to set default algorithms, load | |
156 | dynamic, perform initialization and send ctrls. The actual operation performed | |
157 | depends on the I<command> name which is the name of the name value pair. The | |
158 | currently supported commands are listed below. | |
159 | ||
160 | For example: | |
161 | ||
162 | [engine_section] | |
163 | ||
164 | # Configure ENGINE named "foo" | |
165 | foo = foo_section | |
166 | # Configure ENGINE named "bar" | |
167 | bar = bar_section | |
168 | ||
169 | [foo_section] | |
170 | ... foo ENGINE specific commands ... | |
171 | ||
172 | [bar_section] | |
173 | ... "bar" ENGINE specific commands ... | |
174 | ||
1bc74519 | 175 | The command B<engine_id> is used to give the ENGINE name. If used this |
f2c18125 DSH |
176 | command must be first. For example: |
177 | ||
178 | [engine_section] | |
179 | # This would normally handle an ENGINE named "foo" | |
180 | foo = foo_section | |
181 | ||
182 | [foo_section] | |
183 | # Override default name and use "myfoo" instead. | |
184 | engine_id = myfoo | |
185 | ||
186 | The command B<dynamic_path> loads and adds an ENGINE from the given path. It | |
187 | is equivalent to sending the ctrls B<SO_PATH> with the path argument followed | |
188 | by B<LIST_ADD> with value 2 and B<LOAD> to the dynamic ENGINE. If this is | |
189 | not the required behaviour then alternative ctrls can be sent directly | |
190 | to the dynamic ENGINE using ctrl commands. | |
191 | ||
192 | The command B<init> determines whether to initialize the ENGINE. If the value | |
193 | is B<0> the ENGINE will not be initialized, if B<1> and attempt it made to | |
194 | initialized the ENGINE immediately. If the B<init> command is not present | |
195 | then an attempt will be made to initialize the ENGINE after all commands in | |
196 | its section have been processed. | |
197 | ||
198 | The command B<default_algorithms> sets the default algorithms an ENGINE will | |
35cb565a | 199 | supply using the functions ENGINE_set_default_string(). |
f2c18125 DSH |
200 | |
201 | If the name matches none of the above command names it is assumed to be a | |
1bc74519 | 202 | ctrl command which is sent to the ENGINE. The value of the command is the |
f2c18125 DSH |
203 | argument to the ctrl command. If the value is the string B<EMPTY> then no |
204 | value is sent to the command. | |
205 | ||
206 | For example: | |
207 | ||
208 | ||
209 | [engine_section] | |
210 | ||
211 | # Configure ENGINE named "foo" | |
212 | foo = foo_section | |
213 | ||
214 | [foo_section] | |
215 | # Load engine from DSO | |
216 | dynamic_path = /some/path/fooengine.so | |
217 | # A foo specific ctrl. | |
218 | some_ctrl = some_value | |
219 | # Another ctrl that doesn't take a value. | |
220 | other_ctrl = EMPTY | |
221 | # Supply all default algorithms | |
222 | default_algorithms = ALL | |
a30af36c | 223 | |
b6670f69 RL |
224 | =head2 Provider Configuration Module |
225 | ||
226 | This provider configuration module has the name B<providers>. The | |
227 | value of this variable points to a section containing further provider | |
228 | configuration information. | |
229 | ||
230 | The section pointed to by B<providers> is a table of provider names | |
231 | (though see B<identity> below) and further sections containing | |
232 | configuration information specific to each provider module. | |
233 | ||
234 | Each provider specific section is used to load its module, perform | |
235 | activation and set parameters to pass to the provider on demand. The | |
236 | actual operation performed depends on the name of the name value pair. | |
237 | The currently supported commands are listed below. | |
238 | ||
239 | For example: | |
240 | ||
241 | [provider_section] | |
242 | ||
243 | # Configure provider named "foo" | |
244 | foo = foo_section | |
245 | # Configure provider named "bar" | |
246 | bar = bar_section | |
247 | ||
248 | [foo_section] | |
249 | ... "foo" provider specific parameters ... | |
250 | ||
251 | [bar_section] | |
252 | ... "bar" provider specific parameters ... | |
253 | ||
254 | The command B<identity> is used to give the provider name. For example: | |
255 | ||
256 | [provider_section] | |
257 | # This would normally handle a provider named "foo" | |
258 | foo = foo_section | |
259 | ||
260 | [foo_section] | |
261 | # Override default name and use "myfoo" instead. | |
262 | identity = myfoo | |
263 | ||
264 | The parameter B<module> loads and adds a provider module from the | |
265 | given module path. That path may be a simple file name, a relative | |
266 | path or an absolute path. | |
267 | ||
268 | The parameter B<activate> determines whether to activate the | |
269 | provider. The value has no importance, the presence of the parameter | |
270 | is enough for activation to take place. | |
271 | ||
272 | All parameters in the section as well as sub-sections are made | |
273 | available to the provider. | |
274 | ||
05ea606a | 275 | =head2 EVP Configuration Module |
3d764db7 | 276 | |
de3955f6 | 277 | This module has the name B<alg_section> which points to a section containing |
3d764db7 DSH |
278 | algorithm commands. |
279 | ||
de3955f6 RL |
280 | The supported algorithm commands are: |
281 | ||
282 | =over 4 | |
283 | ||
284 | =item B<default_properties> | |
285 | ||
286 | The value may be anything that is acceptable as a property query | |
287 | string for EVP_set_default_properties(). | |
288 | ||
289 | =item B<fips_mode> (deprecated) | |
290 | ||
291 | The value is a boolean that can be B<yes> or B<no>. If the value is | |
292 | B<yes>, this is exactly equivalent to: | |
293 | ||
294 | default_properties = fips=yes | |
295 | ||
296 | If the value is B<no>, nothing happens. | |
297 | ||
298 | =back | |
299 | ||
300 | These two commands should not be used together, as there is no control | |
301 | over how they affect each other. | |
302 | The use of B<fips_mode> is strongly discouraged and is only present | |
303 | for backward compatibility with earlier OpenSSL FIPS modules. | |
3d764db7 | 304 | |
05ea606a | 305 | =head2 SSL Configuration Module |
913592d2 DSH |
306 | |
307 | This module has the name B<ssl_conf> which points to a section containing | |
308 | SSL configurations. | |
309 | ||
310 | Each line in the SSL configuration section contains the name of the | |
311 | configuration and the section containing it. | |
312 | ||
313 | Each configuration section consists of command value pairs for B<SSL_CONF>. | |
314 | Each pair will be passed to a B<SSL_CTX> or B<SSL> structure if it calls | |
315 | SSL_CTX_config() or SSL_config() with the appropriate configuration name. | |
316 | ||
317 | Note: any characters before an initial dot in the configuration section are | |
318 | ignored so the same command can be used multiple times. | |
319 | ||
320 | For example: | |
321 | ||
322 | ssl_conf = ssl_sect | |
323 | ||
324 | [ssl_sect] | |
325 | ||
326 | server = server_section | |
327 | ||
328 | [server_section] | |
329 | ||
330 | RSA.Certificate = server-rsa.pem | |
331 | ECDSA.Certificate = server-ecdsa.pem | |
332 | Ciphers = ALL:!RC4 | |
3d764db7 | 333 | |
8a5ed9dc TM |
334 | The system default configuration with name B<system_default> if present will |
335 | be applied during any creation of the B<SSL_CTX> structure. | |
336 | ||
337 | Example of a configuration with the system default: | |
338 | ||
339 | ssl_conf = ssl_sect | |
340 | ||
341 | [ssl_sect] | |
342 | ||
343 | system_default = system_default_sect | |
344 | ||
345 | [system_default_sect] | |
346 | ||
347 | MinProtocol = TLSv1.2 | |
348 | ||
349 | ||
aba3e65f DSH |
350 | =head1 NOTES |
351 | ||
19d2bb57 | 352 | If a configuration file attempts to expand a variable that doesn't exist |
aba3e65f DSH |
353 | then an error is flagged and the file will not load. This can happen |
354 | if an attempt is made to expand an environment variable that doesn't | |
a30af36c DSH |
355 | exist. For example in a previous version of OpenSSL the default OpenSSL |
356 | master configuration file used the value of B<HOME> which may not be | |
357 | defined on non Unix systems and would cause an error. | |
aba3e65f DSH |
358 | |
359 | This can be worked around by including a B<default> section to provide | |
360 | a default value: then if the environment lookup fails the default value | |
361 | will be used instead. For this to work properly the default value must | |
362 | be defined earlier in the configuration file than the expansion. See | |
363 | the B<EXAMPLES> section for an example of how to do this. | |
364 | ||
365 | If the same variable exists in the same section then all but the last | |
366 | value will be silently ignored. In certain circumstances such as with | |
367 | DNs the same field may occur multiple times. This is usually worked | |
368 | around by ignoring any characters before an initial B<.> e.g. | |
369 | ||
370 | 1.OU="My first OU" | |
371 | 2.OU="My Second OU" | |
372 | ||
373 | =head1 EXAMPLES | |
374 | ||
375 | Here is a sample configuration file using some of the features | |
376 | mentioned above. | |
377 | ||
378 | # This is the default section. | |
1bc74519 | 379 | |
aba3e65f DSH |
380 | HOME=/temp |
381 | RANDFILE= ${ENV::HOME}/.rnd | |
382 | configdir=$ENV::HOME/config | |
383 | ||
384 | [ section_one ] | |
385 | ||
386 | # We are now in section one. | |
387 | ||
388 | # Quotes permit leading and trailing whitespace | |
389 | any = " any variable name " | |
390 | ||
391 | other = A string that can \ | |
392 | cover several lines \ | |
393 | by including \\ characters | |
394 | ||
395 | message = Hello World\n | |
396 | ||
397 | [ section_two ] | |
398 | ||
399 | greeting = $section_one::message | |
400 | ||
401 | This next example shows how to expand environment variables safely. | |
402 | ||
403 | Suppose you want a variable called B<tmpfile> to refer to a | |
404 | temporary filename. The directory it is placed in can determined by | |
35ed393e | 405 | the B<TEMP> or B<TMP> environment variables but they may not be |
aba3e65f DSH |
406 | set to any value at all. If you just include the environment variable |
407 | names and the variable doesn't exist then this will cause an error when | |
408 | an attempt is made to load the configuration file. By making use of the | |
1bc74519 | 409 | default section both values can be looked up with B<TEMP> taking |
aba3e65f DSH |
410 | priority and B</tmp> used if neither is defined: |
411 | ||
412 | TMP=/tmp | |
413 | # The above value is used if TMP isn't in the environment | |
414 | TEMP=$ENV::TMP | |
415 | # The above value is used if TEMP isn't in the environment | |
416 | tmpfile=${ENV::TEMP}/tmp.filename | |
417 | ||
7b68c30d DSH |
418 | Simple OpenSSL library configuration example to enter FIPS mode: |
419 | ||
420 | # Default appname: should match "appname" parameter (if any) | |
421 | # supplied to CONF_modules_load_file et al. | |
422 | openssl_conf = openssl_conf_section | |
423 | ||
424 | [openssl_conf_section] | |
425 | # Configuration module list | |
426 | alg_section = evp_sect | |
427 | ||
428 | [evp_sect] | |
429 | # Set to "yes" to enter FIPS mode if supported | |
430 | fips_mode = yes | |
431 | ||
432 | Note: in the above example you will get an error in non FIPS capable versions | |
433 | of OpenSSL. | |
434 | ||
435 | More complex OpenSSL library configuration. Add OID and don't enter FIPS mode: | |
436 | ||
437 | # Default appname: should match "appname" parameter (if any) | |
438 | # supplied to CONF_modules_load_file et al. | |
439 | openssl_conf = openssl_conf_section | |
440 | ||
441 | [openssl_conf_section] | |
442 | # Configuration module list | |
443 | alg_section = evp_sect | |
444 | oid_section = new_oids | |
445 | ||
446 | [evp_sect] | |
447 | # This will have no effect as FIPS mode is off by default. | |
448 | # Set to "yes" to enter FIPS mode, if supported | |
449 | fips_mode = no | |
450 | ||
451 | [new_oids] | |
452 | # New OID, just short name | |
453 | newoid1 = 1.2.3.4.1 | |
454 | # New OID shortname and long name | |
455 | newoid2 = New OID 2 long name, 1.2.3.4.2 | |
456 | ||
35ed393e | 457 | The above examples can be used with any application supporting library |
7b68c30d DSH |
458 | configuration if "openssl_conf" is modified to match the appropriate "appname". |
459 | ||
460 | For example if the second sample file above is saved to "example.cnf" then | |
461 | the command line: | |
462 | ||
463 | OPENSSL_CONF=example.cnf openssl asn1parse -genstr OID:1.2.3.4.1 | |
464 | ||
465 | will output: | |
466 | ||
467 | 0:d=0 hl=2 l= 4 prim: OBJECT :newoid1 | |
468 | ||
469 | showing that the OID "newoid1" has been added as "1.2.3.4.1". | |
470 | ||
284f4f6b BE |
471 | =head1 ENVIRONMENT |
472 | ||
473 | =over 4 | |
474 | ||
475 | =item B<OPENSSL_CONF> | |
476 | ||
477 | The path to the config file. | |
478 | Ignored in set-user-ID and set-group-ID programs. | |
479 | ||
480 | =item B<OPENSSL_ENGINES> | |
481 | ||
482 | The path to the engines directory. | |
483 | Ignored in set-user-ID and set-group-ID programs. | |
484 | ||
b6670f69 RL |
485 | =item B<OPENSSL_MODULES> |
486 | ||
487 | The path to the directory with OpenSSL modules, such as providers. | |
488 | Ignored in set-user-ID and set-group-ID programs. | |
489 | ||
284f4f6b BE |
490 | =back |
491 | ||
aba3e65f DSH |
492 | =head1 BUGS |
493 | ||
494 | Currently there is no way to include characters using the octal B<\nnn> | |
495 | form. Strings are all null terminated so nulls cannot form part of | |
496 | the value. | |
497 | ||
498 | The escaping isn't quite right: if you want to use sequences like B<\n> | |
499 | you can't use any quote escaping on the same line. | |
500 | ||
501 | Files are loaded in a single pass. This means that an variable expansion | |
502 | will only work if the variables referenced are defined earlier in the | |
503 | file. | |
504 | ||
505 | =head1 SEE ALSO | |
506 | ||
9b86974e | 507 | L<x509(1)>, L<req(1)>, L<ca(1)> |
aba3e65f | 508 | |
e2f92610 RS |
509 | =head1 COPYRIGHT |
510 | ||
b0edda11 | 511 | Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 512 | |
b1e979ae | 513 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
514 | this file except in compliance with the License. You can obtain a copy |
515 | in the file LICENSE in the source distribution or at | |
516 | L<https://www.openssl.org/source/license.html>. | |
517 | ||
518 | =cut |