doc/apps/config.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 config - OpenSSL CONF library configuration files
   7
   8 =head1 DESCRIPTION
   9
  10 The OpenSSL CONF library can be used to read configuration files.
  11 It is used for the OpenSSL master configuration file B<openssl.cnf>
  12 and in a few other places like B<SPKAC> files and certificate extension
  13 files for the B<x509> utility. OpenSSL applications can also use the
  14 CONF library for their own purposes.
  15
  16 A configuration file is divided into a number of sections. Each section
  17 starts with a line B<[ section_name ]> and ends when a new section is
  18 started or end of file is reached. A section name can consist of
  19 alphanumeric characters and underscores.
  20
  21 The first section of a configuration file is special and is referred
  22 to as the B<default> section this is usually unnamed and is from the
  23 start of file until the first named section. When a name is being looked up
  24 it is first looked up in a named section (if any) and then the
  25 default section.
  26
  27 The environment is mapped onto a section called B<ENV>.
  28
  29 Comments can be included by preceding them with the B<#> character
  30
  31 Each section in a configuration file consists of a number of name and
  32 value pairs of the form B<name=value>
  33
  34 The B<name> string can contain any alphanumeric characters as well as
  35 a few punctuation symbols such as B<.> B<,> B<;> and B<_>.
  36
  37 The B<value> string consists of the string following the B<=> character
  38 until end of line with any leading and trailing white space removed.
  39
  40 The value string undergoes variable expansion. This can be done by
  41 including the form B<$var> or B<${var}>: this will substitute the value
  42 of the named variable in the current section. It is also possible to
  43 substitute a value from another section using the syntax B<$section::name>
  44 or B<${section::name}>. By using the form B<$ENV::name> environment
  45 variables can be substituted. It is also possible to assign values to
  46 environment variables by using the name B<ENV::name>, this will work
  47 if the program looks up environment variables using the B<CONF> library
  48 instead of calling B<getenv()> directly.
  49
  50 It is possible to escape certain characters by using any kind of quote
  51 or the B<\> character. By making the last character of a line a B<\>
  52 a B<value> string can be spread across multiple lines. In addition
  53 the sequences B<\n>, B<\r>, B<\b> and B<\t> are recognized.
  54
  55 =head1 OPENSSL LIBRARY CONFIGURATION
  56
  57 In OpenSSL 0.9.7 and later applications can automatically configure certain
  58 aspects of OpenSSL using the master OpenSSL configuration file, or optionally
  59 an alternative configuration file. The B<openssl> utility includes this
  60 functionality: any sub command uses the master OpenSSL configuration file
  61 unless an option is used in the sub command to use an alternative configuration
  62 file.
  63
  64 To enable library configuration the default section needs to contain an
  65 appropriate line which points to the main configuration section. The default
  66 name is B<openssl_conf> which is used by the B<openssl> utility. Other
  67 applications may use an alternative name such as B<myapplicaton_conf>.
  68
  69 The configuration section should consist of a set of name value pairs which
  70 contain specific module configuration information. The B<name> represents
  71 the name of the I<configuration module> the meaning of the B<value> is
  72 module specific: it may, for example, represent a further configuration
  73 section containing configuration module specific information. E.g.
  74
  75  openssl_conf = openssl_init
  76
  77  [openssl_init]
  78
  79  oid_section = new_oids
  80  engines = engine_section
  81
  82  [new_oids]
  83
  84  ... new oids here ...
  85
  86  [engine_section]
  87
  88  ... engine stuff here ...
  89
  90 Currently there are two configuration modules. One for ASN1 objects another
  91 for ENGINE configuration.
  92
  93 =head2 ASN1 OBJECT CONFIGURATION MODULE
  94
  95 This module has the name B<oid_section>. The value of this variable points
  96 to a section containing name value pairs of OIDs: the name is the OID short
  97 and long name, the value is the numerical form of the OID. Although some of
  98 the B<openssl> utility sub commands already have their own ASN1 OBJECT section
  99 functionality not all do. By using the ASN1 OBJECT configuration module
 100 B<all> the B<openssl> utility sub commands can see the new objects as well
 101 as any compliant applications. For example:
 102
 103  [new_oids]
 104
 105  some_new_oid = 1.2.3.4
 106  some_other_oid = 1.2.3.5
 107
 108 In OpenSSL 0.9.8 it is also possible to set the value to the long name followed
 109 by a comma and the numerical OID form. For example:
 110
 111  shortName = some object long name, 1.2.3.4
 112
 113 =head2 ENGINE CONFIGURATION MODULE
 114
 115 This ENGINE configuration module has the name B<engines>. The value of this
 116 variable points to a section containing further ENGINE configuration
 117 information.
 118
 119 The section pointed to by B<engines> is a table of engine names (though see
 120 B<engine_id> below) and further sections containing configuration informations
 121 specific to each ENGINE.
 122
 123 Each ENGINE specific section is used to set default algorithms, load
 124 dynamic, perform initialization and send ctrls. The actual operation performed
 125 depends on the I<command> name which is the name of the name value pair. The
 126 currently supported commands are listed below.
 127
 128 For example:
 129
 130  [engine_section]
 131
 132  # Configure ENGINE named "foo"
 133  foo = foo_section
 134  # Configure ENGINE named "bar"
 135  bar = bar_section
 136
 137  [foo_section]
 138  ... foo ENGINE specific commands ...
 139
 140  [bar_section]
 141  ... "bar" ENGINE specific commands ...
 142
 143 The command B<engine_id> is used to give the ENGINE name. If used this
 144 command must be first. For example:
 145
 146  [engine_section]
 147  # This would normally handle an ENGINE named "foo"
 148  foo = foo_section
 149
 150  [foo_section]
 151  # Override default name and use "myfoo" instead.
 152  engine_id = myfoo
 153
 154 The command B<dynamic_path> loads and adds an ENGINE from the given path. It
 155 is equivalent to sending the ctrls B<SO_PATH> with the path argument followed
 156 by B<LIST_ADD> with value 2 and B<LOAD> to the dynamic ENGINE. If this is
 157 not the required behaviour then alternative ctrls can be sent directly
 158 to the dynamic ENGINE using ctrl commands.
 159
 160 The command B<init> determines whether to initialize the ENGINE. If the value
 161 is B<0> the ENGINE will not be initialized, if B<1> and attempt it made to
 162 initialized the ENGINE immediately. If the B<init> command is not present
 163 then an attempt will be made to initialize the ENGINE after all commands in
 164 its section have been processed.
 165
 166 The command B<default_algorithms> sets the default algorithms an ENGINE will
 167 supply using the functions B<ENGINE_set_default_string()>
 168
 169 If the name matches none of the above command names it is assumed to be a
 170 ctrl command which is sent to the ENGINE. The value of the command is the
 171 argument to the ctrl command. If the value is the string B<EMPTY> then no
 172 value is sent to the command.
 173
 174 For example:
 175
 176
 177  [engine_section]
 178
 179  # Configure ENGINE named "foo"
 180  foo = foo_section
 181
 182  [foo_section]
 183  # Load engine from DSO
 184  dynamic_path = /some/path/fooengine.so
 185  # A foo specific ctrl.
 186  some_ctrl = some_value
 187  # Another ctrl that doesn't take a value.
 188  other_ctrl = EMPTY
 189  # Supply all default algorithms
 190  default_algorithms = ALL
 191
 192 =head1 NOTES
 193
 194 If a configuration file attempts to expand a variable that doesn't exist
 195 then an error is flagged and the file will not load. This can happen
 196 if an attempt is made to expand an environment variable that doesn't
 197 exist. For example in a previous version of OpenSSL the default OpenSSL
 198 master configuration file used the value of B<HOME> which may not be
 199 defined on non Unix systems and would cause an error.
 200
 201 This can be worked around by including a B<default> section to provide
 202 a default value: then if the environment lookup fails the default value
 203 will be used instead. For this to work properly the default value must
 204 be defined earlier in the configuration file than the expansion. See
 205 the B<EXAMPLES> section for an example of how to do this.
 206
 207 If the same variable exists in the same section then all but the last
 208 value will be silently ignored. In certain circumstances such as with
 209 DNs the same field may occur multiple times. This is usually worked
 210 around by ignoring any characters before an initial B<.> e.g.
 211
 212  1.OU="My first OU"
 213  2.OU="My Second OU"
 214
 215 =head1 EXAMPLES
 216
 217 Here is a sample configuration file using some of the features
 218 mentioned above.
 219
 220  # This is the default section.
 221
 222  HOME=/temp
 223  RANDFILE= ${ENV::HOME}/.rnd
 224  configdir=$ENV::HOME/config
 225
 226  [ section_one ]
 227
 228  # We are now in section one.
 229
 230  # Quotes permit leading and trailing whitespace
 231  any = " any variable name "
 232
 233  other = A string that can \
 234  cover several lines \
 235  by including \\ characters
 236
 237  message = Hello World\n
 238
 239  [ section_two ]
 240
 241  greeting = $section_one::message
 242
 243 This next example shows how to expand environment variables safely.
 244
 245 Suppose you want a variable called B<tmpfile> to refer to a
 246 temporary filename. The directory it is placed in can determined by
 247 the the B<TEMP> or B<TMP> environment variables but they may not be
 248 set to any value at all. If you just include the environment variable
 249 names and the variable doesn't exist then this will cause an error when
 250 an attempt is made to load the configuration file. By making use of the
 251 default section both values can be looked up with B<TEMP> taking
 252 priority and B</tmp> used if neither is defined:
 253
 254  TMP=/tmp
 255  # The above value is used if TMP isn't in the environment
 256  TEMP=$ENV::TMP
 257  # The above value is used if TEMP isn't in the environment
 258  tmpfile=${ENV::TEMP}/tmp.filename
 259
 260 =head1 BUGS
 261
 262 Currently there is no way to include characters using the octal B<\nnn>
 263 form. Strings are all null terminated so nulls cannot form part of
 264 the value.
 265
 266 The escaping isn't quite right: if you want to use sequences like B<\n>
 267 you can't use any quote escaping on the same line.
 268
 269 Files are loaded in a single pass. This means that an variable expansion
 270 will only work if the variables referenced are defined earlier in the
 271 file.
 272
 273 =head1 SEE ALSO
 274
 275 L<x509(1)|x509(1)>, L<req(1)|req(1)>, L<ca(1)|ca(1)>
 276
 277 =cut