1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
132 .TH CONFIG 5 "2007-03-28" "0.9.8e" "OpenSSL"
134 config \- OpenSSL CONF library configuration files
136 .IX Header "DESCRIPTION"
137 The OpenSSL \s-1CONF\s0 library can be used to read configuration files.
138 It is used for the OpenSSL master configuration file \fBopenssl.cnf\fR
139 and in a few other places like \fB\s-1SPKAC\s0\fR files and certificate extension
140 files for the \fBx509\fR utility. OpenSSL applications can also use the
141 \&\s-1CONF\s0 library for their own purposes.
143 A configuration file is divided into a number of sections. Each section
144 starts with a line \fB[ section_name ]\fR and ends when a new section is
145 started or end of file is reached. A section name can consist of
146 alphanumeric characters and underscores.
148 The first section of a configuration file is special and is referred
149 to as the \fBdefault\fR section this is usually unnamed and is from the
150 start of file until the first named section. When a name is being looked up
151 it is first looked up in a named section (if any) and then the
154 The environment is mapped onto a section called \fB\s-1ENV\s0\fR.
156 Comments can be included by preceding them with the \fB#\fR character
158 Each section in a configuration file consists of a number of name and
159 value pairs of the form \fBname=value\fR
161 The \fBname\fR string can contain any alphanumeric characters as well as
162 a few punctuation symbols such as \fB.\fR \fB,\fR \fB;\fR and \fB_\fR.
164 The \fBvalue\fR string consists of the string following the \fB=\fR character
165 until end of line with any leading and trailing white space removed.
167 The value string undergoes variable expansion. This can be done by
168 including the form \fB$var\fR or \fB${var}\fR: this will substitute the value
169 of the named variable in the current section. It is also possible to
170 substitute a value from another section using the syntax \fB$section::name\fR
171 or \fB${section::name}\fR. By using the form \fB$ENV::name\fR environment
172 variables can be substituted. It is also possible to assign values to
173 environment variables by using the name \fBENV::name\fR, this will work
174 if the program looks up environment variables using the \fB\s-1CONF\s0\fR library
175 instead of calling \fB\f(BIgetenv()\fB\fR directly.
177 It is possible to escape certain characters by using any kind of quote
178 or the \fB\e\fR character. By making the last character of a line a \fB\e\fR
179 a \fBvalue\fR string can be spread across multiple lines. In addition
180 the sequences \fB\en\fR, \fB\er\fR, \fB\eb\fR and \fB\et\fR are recognized.
181 .SH "OPENSSL LIBRARY CONFIGURATION"
182 .IX Header "OPENSSL LIBRARY CONFIGURATION"
183 In OpenSSL 0.9.7 and later applications can automatically configure certain
184 aspects of OpenSSL using the master OpenSSL configuration file, or optionally
185 an alternative configuration file. The \fBopenssl\fR utility includes this
186 functionality: any sub command uses the master OpenSSL configuration file
187 unless an option is used in the sub command to use an alternative configuration
190 To enable library configuration the default section needs to contain an
191 appropriate line which points to the main configuration section. The default
192 name is \fBopenssl_conf\fR which is used by the \fBopenssl\fR utility. Other
193 applications may use an alternative name such as \fBmyapplicaton_conf\fR.
195 The configuration section should consist of a set of name value pairs which
196 contain specific module configuration information. The \fBname\fR represents
197 the name of the \fIconfiguration module\fR the meaning of the \fBvalue\fR is
198 module specific: it may, for example, represent a further configuration
199 section containing configuration module specific information. E.g.
202 \& openssl_conf = openssl_init
210 \& oid_section = new_oids
211 \& engines = engine_section
219 \& ... new oids here ...
227 \& ... engine stuff here ...
230 Currently there are two configuration modules. One for \s-1ASN1\s0 objects another
231 for \s-1ENGINE\s0 configuration.
232 .Sh "\s-1ASN1\s0 \s-1OBJECT\s0 \s-1CONFIGURATION\s0 \s-1MODULE\s0"
233 .IX Subsection "ASN1 OBJECT CONFIGURATION MODULE"
234 This module has the name \fBoid_section\fR. The value of this variable points
235 to a section containing name value pairs of OIDs: the name is the \s-1OID\s0 short
236 and long name, the value is the numerical form of the \s-1OID\s0. Although some of
237 the \fBopenssl\fR utility sub commands already have their own \s-1ASN1\s0 \s-1OBJECT\s0 section
238 functionality not all do. By using the \s-1ASN1\s0 \s-1OBJECT\s0 configuration module
239 \&\fBall\fR the \fBopenssl\fR utility sub commands can see the new objects as well
240 as any compliant applications. For example:
247 \& some_new_oid = 1.2.3.4
248 \& some_other_oid = 1.2.3.5
251 In OpenSSL 0.9.8 it is also possible to set the value to the long name followed
252 by a comma and the numerical \s-1OID\s0 form. For example:
255 \& shortName = some object long name, 1.2.3.4
257 .Sh "\s-1ENGINE\s0 \s-1CONFIGURATION\s0 \s-1MODULE\s0"
258 .IX Subsection "ENGINE CONFIGURATION MODULE"
259 This \s-1ENGINE\s0 configuration module has the name \fBengines\fR. The value of this
260 variable points to a section containing further \s-1ENGINE\s0 configuration
263 The section pointed to by \fBengines\fR is a table of engine names (though see
264 \&\fBengine_id\fR below) and further sections containing configuration informations
265 specific to each \s-1ENGINE\s0.
267 Each \s-1ENGINE\s0 specific section is used to set default algorithms, load
268 dynamic, perform initialization and send ctrls. The actual operation performed
269 depends on the \fIcommand\fR name which is the name of the name value pair. The
270 currently supported commands are listed below.
279 \& # Configure ENGINE named "foo"
281 \& # Configure ENGINE named "bar"
287 \& ... foo ENGINE specific commands ...
292 \& ... "bar" ENGINE specific commands ...
295 The command \fBengine_id\fR is used to give the \s-1ENGINE\s0 name. If used this
296 command must be first. For example:
300 \& # This would normally handle an ENGINE named "foo"
306 \& # Override default name and use "myfoo" instead.
310 The command \fBdynamic_path\fR loads and adds an \s-1ENGINE\s0 from the given path. It
311 is equivalent to sending the ctrls \fB\s-1SO_PATH\s0\fR with the path argument followed
312 by \fB\s-1LIST_ADD\s0\fR with value 2 and \fB\s-1LOAD\s0\fR to the dynamic \s-1ENGINE\s0. If this is
313 not the required behaviour then alternative ctrls can be sent directly
314 to the dynamic \s-1ENGINE\s0 using ctrl commands.
316 The command \fBinit\fR determines whether to initialize the \s-1ENGINE\s0. If the value
317 is \fB0\fR the \s-1ENGINE\s0 will not be initialized, if \fB1\fR and attempt it made to
318 initialized the \s-1ENGINE\s0 immediately. If the \fBinit\fR command is not present
319 then an attempt will be made to initialize the \s-1ENGINE\s0 after all commands in
320 its section have been processed.
322 The command \fBdefault_algorithms\fR sets the default algorithms an \s-1ENGINE\s0 will
323 supply using the functions \fB\f(BIENGINE_set_default_string()\fB\fR
325 If the name matches none of the above command names it is assumed to be a
326 ctrl command which is sent to the \s-1ENGINE\s0. The value of the command is the
327 argument to the ctrl command. If the value is the string \fB\s-1EMPTY\s0\fR then no
328 value is sent to the command.
337 \& # Configure ENGINE named "foo"
343 \& # Load engine from DSO
344 \& dynamic_path = /some/path/fooengine.so
345 \& # A foo specific ctrl.
346 \& some_ctrl = some_value
347 \& # Another ctrl that doesn't take a value.
348 \& other_ctrl = EMPTY
349 \& # Supply all default algorithms
350 \& default_algorithms = ALL
354 If a configuration file attempts to expand a variable that doesn't exist
355 then an error is flagged and the file will not load. This can happen
356 if an attempt is made to expand an environment variable that doesn't
357 exist. For example in a previous version of OpenSSL the default OpenSSL
358 master configuration file used the value of \fB\s-1HOME\s0\fR which may not be
359 defined on non Unix systems and would cause an error.
361 This can be worked around by including a \fBdefault\fR section to provide
362 a default value: then if the environment lookup fails the default value
363 will be used instead. For this to work properly the default value must
364 be defined earlier in the configuration file than the expansion. See
365 the \fB\s-1EXAMPLES\s0\fR section for an example of how to do this.
367 If the same variable exists in the same section then all but the last
368 value will be silently ignored. In certain circumstances such as with
369 DNs the same field may occur multiple times. This is usually worked
370 around by ignoring any characters before an initial \fB.\fR e.g.
373 \& 1.OU="My first OU"
374 \& 2.OU="My Second OU"
377 .IX Header "EXAMPLES"
378 Here is a sample configuration file using some of the features
382 \& # This is the default section.
387 \& RANDFILE= ${ENV::HOME}/.rnd
388 \& configdir=$ENV::HOME/config
396 \& # We are now in section one.
400 \& # Quotes permit leading and trailing whitespace
401 \& any = " any variable name "
405 \& other = A string that can \e
406 \& cover several lines \e
407 \& by including \e\e characters
411 \& message = Hello World\en
419 \& greeting = $section_one::message
422 This next example shows how to expand environment variables safely.
424 Suppose you want a variable called \fBtmpfile\fR to refer to a
425 temporary filename. The directory it is placed in can determined by
426 the the \fB\s-1TEMP\s0\fR or \fB\s-1TMP\s0\fR environment variables but they may not be
427 set to any value at all. If you just include the environment variable
428 names and the variable doesn't exist then this will cause an error when
429 an attempt is made to load the configuration file. By making use of the
430 default section both values can be looked up with \fB\s-1TEMP\s0\fR taking
431 priority and \fB/tmp\fR used if neither is defined:
435 \& # The above value is used if TMP isn't in the environment
437 \& # The above value is used if TEMP isn't in the environment
438 \& tmpfile=${ENV::TEMP}/tmp.filename
442 Currently there is no way to include characters using the octal \fB\ennn\fR
443 form. Strings are all null terminated so nulls cannot form part of
446 The escaping isn't quite right: if you want to use sequences like \fB\en\fR
447 you can't use any quote escaping on the same line.
449 Files are loaded in a single pass. This means that an variable expansion
450 will only work if the variables referenced are defined earlier in the
453 .IX Header "SEE ALSO"
454 \&\fIx509\fR\|(1), \fIreq\fR\|(1), \fIca\fR\|(1)
projects / dragonfly.git / blob