doc/man5/config.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 config - OpenSSL CONF library configuration files
   6
   7 =head1 DESCRIPTION
   8
   9 The OpenSSL CONF library can be used to read configuration files.
  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
  12 files for the B<x509> utility. OpenSSL applications can also use the
  13 CONF library for their own purposes.
  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
  21 to as the B<default> section this is usually unnamed and is from the
  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
  30 Each section in a configuration file consists of a number of name and
  31 value pairs of the form B<name=value>
  32
  33 The B<name> string can contain any alphanumeric characters as well as
  34 a few punctuation symbols such as B<.> B<,> B<;> and B<_>.
  35
  36 The B<value> string consists of the string following the B<=> character
  37 until end of line with any leading and trailing white space removed.
  38
  39 The value string undergoes variable expansion. This can be done by
  40 including the form B<$var> or B<${var}>: this will substitute the value
  41 of the named variable in the current section. It is also possible to
  42 substitute a value from another section using the syntax B<$section::name>
  43 or B<${section::name}>. By using the form B<$ENV::name> environment
  44 variables can be substituted. It is also possible to assign values to
  45 environment variables by using the name B<ENV::name>, this will work
  46 if the program looks up environment variables using the B<CONF> library
  47 instead of calling getenv() directly. The value string must not exceed 64k in
  48 length after variable expansion. Otherwise an error will occur.
  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 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 The features of each configuration module are described below.
  91
  92 =head2 ASN1 Object Configuration Module
  93
  94 This module has the name B<oid_section>. The value of this variable points
  95 to a section containing name value pairs of OIDs: the name is the OID short
  96 and long name, the value is the numerical form of the OID. Although some of
  97 the B<openssl> utility sub commands already have their own ASN1 OBJECT section
  98 functionality not all do. By using the ASN1 OBJECT configuration module
  99 B<all> the B<openssl> utility sub commands can see the new objects as well
 100 as any compliant applications. For example:
 101
 102  [new_oids]
 103
 104  some_new_oid = 1.2.3.4
 105  some_other_oid = 1.2.3.5
 106
 107 It is also possible to set the value to the long name followed
 108 by a comma and the numerical OID form. For example:
 109
 110  shortName = some object long name, 1.2.3.4
 111
 112 =head2 Engine Configuration Module
 113
 114 This ENGINE configuration module has the name B<engines>. The value of this
 115 variable points to a section containing further ENGINE configuration
 116 information.
 117
 118 The section pointed to by B<engines> is a table of engine names (though see
 119 B<engine_id> below) and further sections containing configuration information
 120 specific to each ENGINE.
 121
 122 Each ENGINE specific section is used to set default algorithms, load
 123 dynamic, perform initialization and send ctrls. The actual operation performed
 124 depends on the I<command> name which is the name of the name value pair. The
 125 currently supported commands are listed below.
 126
 127 For example:
 128
 129  [engine_section]
 130
 131  # Configure ENGINE named "foo"
 132  foo = foo_section
 133  # Configure ENGINE named "bar"
 134  bar = bar_section
 135
 136  [foo_section]
 137  ... foo ENGINE specific commands ...
 138
 139  [bar_section]
 140  ... "bar" ENGINE specific commands ...
 141
 142 The command B<engine_id> is used to give the ENGINE name. If used this
 143 command must be first. For example:
 144
 145  [engine_section]
 146  # This would normally handle an ENGINE named "foo"
 147  foo = foo_section
 148
 149  [foo_section]
 150  # Override default name and use "myfoo" instead.
 151  engine_id = myfoo
 152
 153 The command B<dynamic_path> loads and adds an ENGINE from the given path. It
 154 is equivalent to sending the ctrls B<SO_PATH> with the path argument followed
 155 by B<LIST_ADD> with value 2 and B<LOAD> to the dynamic ENGINE. If this is
 156 not the required behaviour then alternative ctrls can be sent directly
 157 to the dynamic ENGINE using ctrl commands.
 158
 159 The command B<init> determines whether to initialize the ENGINE. If the value
 160 is B<0> the ENGINE will not be initialized, if B<1> and attempt it made to
 161 initialized the ENGINE immediately. If the B<init> command is not present
 162 then an attempt will be made to initialize the ENGINE after all commands in
 163 its section have been processed.
 164
 165 The command B<default_algorithms> sets the default algorithms an ENGINE will
 166 supply using the functions ENGINE_set_default_string().
 167
 168 If the name matches none of the above command names it is assumed to be a
 169 ctrl command which is sent to the ENGINE. The value of the command is the
 170 argument to the ctrl command. If the value is the string B<EMPTY> then no
 171 value is sent to the command.
 172
 173 For example:
 174
 175
 176  [engine_section]
 177
 178  # Configure ENGINE named "foo"
 179  foo = foo_section
 180
 181  [foo_section]
 182  # Load engine from DSO
 183  dynamic_path = /some/path/fooengine.so
 184  # A foo specific ctrl.
 185  some_ctrl = some_value
 186  # Another ctrl that doesn't take a value.
 187  other_ctrl = EMPTY
 188  # Supply all default algorithms
 189  default_algorithms = ALL
 190
 191 =head2 EVP Configuration Module
 192
 193 This modules has the name B<alg_section> which points to a section containing
 194 algorithm commands.
 195
 196 Currently the only algorithm command supported is B<fips_mode> whose
 197 value can only be the boolean string B<off>. If B<fips_mode> is set to B<on>,
 198 an error occurs as this library version is not FIPS capable.
 199
 200 =head2 SSL Configuration Module
 201
 202 This module has the name B<ssl_conf> which points to a section containing
 203 SSL configurations.
 204
 205 Each line in the SSL configuration section contains the name of the
 206 configuration and the section containing it.
 207
 208 Each configuration section consists of command value pairs for B<SSL_CONF>.
 209 Each pair will be passed to a B<SSL_CTX> or B<SSL> structure if it calls
 210 SSL_CTX_config() or SSL_config() with the appropriate configuration name.
 211
 212 Note: any characters before an initial dot in the configuration section are
 213 ignored so the same command can be used multiple times.
 214
 215 For example:
 216
 217  ssl_conf = ssl_sect
 218
 219  [ssl_sect]
 220
 221  server = server_section
 222
 223  [server_section]
 224
 225  RSA.Certificate = server-rsa.pem
 226  ECDSA.Certificate = server-ecdsa.pem
 227  Ciphers = ALL:!RC4
 228
 229 =head1 NOTES
 230
 231 If a configuration file attempts to expand a variable that doesn't exist
 232 then an error is flagged and the file will not load. This can happen
 233 if an attempt is made to expand an environment variable that doesn't
 234 exist. For example in a previous version of OpenSSL the default OpenSSL
 235 master configuration file used the value of B<HOME> which may not be
 236 defined on non Unix systems and would cause an error.
 237
 238 This can be worked around by including a B<default> section to provide
 239 a default value: then if the environment lookup fails the default value
 240 will be used instead. For this to work properly the default value must
 241 be defined earlier in the configuration file than the expansion. See
 242 the B<EXAMPLES> section for an example of how to do this.
 243
 244 If the same variable exists in the same section then all but the last
 245 value will be silently ignored. In certain circumstances such as with
 246 DNs the same field may occur multiple times. This is usually worked
 247 around by ignoring any characters before an initial B<.> e.g.
 248
 249  1.OU="My first OU"
 250  2.OU="My Second OU"
 251
 252 =head1 EXAMPLES
 253
 254 Here is a sample configuration file using some of the features
 255 mentioned above.
 256
 257  # This is the default section.
 258
 259  HOME=/temp
 260  RANDFILE= ${ENV::HOME}/.rnd
 261  configdir=$ENV::HOME/config
 262
 263  [ section_one ]
 264
 265  # We are now in section one.
 266
 267  # Quotes permit leading and trailing whitespace
 268  any = " any variable name "
 269
 270  other = A string that can \
 271  cover several lines \
 272  by including \\ characters
 273
 274  message = Hello World\n
 275
 276  [ section_two ]
 277
 278  greeting = $section_one::message
 279
 280 This next example shows how to expand environment variables safely.
 281
 282 Suppose you want a variable called B<tmpfile> to refer to a
 283 temporary filename. The directory it is placed in can determined by
 284 the B<TEMP> or B<TMP> environment variables but they may not be
 285 set to any value at all. If you just include the environment variable
 286 names and the variable doesn't exist then this will cause an error when
 287 an attempt is made to load the configuration file. By making use of the
 288 default section both values can be looked up with B<TEMP> taking
 289 priority and B</tmp> used if neither is defined:
 290
 291  TMP=/tmp
 292  # The above value is used if TMP isn't in the environment
 293  TEMP=$ENV::TMP
 294  # The above value is used if TEMP isn't in the environment
 295  tmpfile=${ENV::TEMP}/tmp.filename
 296
 297 Simple OpenSSL library configuration example to enter FIPS mode:
 298
 299  # Default appname: should match "appname" parameter (if any)
 300  # supplied to CONF_modules_load_file et al.
 301  openssl_conf = openssl_conf_section
 302
 303  [openssl_conf_section]
 304  # Configuration module list
 305  alg_section = evp_sect
 306
 307  [evp_sect]
 308  # Set to "yes" to enter FIPS mode if supported
 309  fips_mode = yes
 310
 311 Note: in the above example you will get an error in non FIPS capable versions
 312 of OpenSSL.
 313
 314 More complex OpenSSL library configuration. Add OID and don't enter FIPS mode:
 315
 316  # Default appname: should match "appname" parameter (if any)
 317  # supplied to CONF_modules_load_file et al.
 318  openssl_conf = openssl_conf_section
 319
 320  [openssl_conf_section]
 321  # Configuration module list
 322  alg_section = evp_sect
 323  oid_section = new_oids
 324
 325  [evp_sect]
 326  # This will have no effect as FIPS mode is off by default.
 327  # Set to "yes" to enter FIPS mode, if supported
 328  fips_mode = no
 329
 330  [new_oids]
 331  # New OID, just short name
 332  newoid1 = 1.2.3.4.1
 333  # New OID shortname and long name
 334  newoid2 = New OID 2 long name, 1.2.3.4.2
 335
 336 The above examples can be used with any application supporting library
 337 configuration if "openssl_conf" is modified to match the appropriate "appname".
 338
 339 For example if the second sample file above is saved to "example.cnf" then
 340 the command line:
 341
 342  OPENSSL_CONF=example.cnf openssl asn1parse -genstr OID:1.2.3.4.1
 343
 344 will output:
 345
 346     0:d=0  hl=2 l=   4 prim: OBJECT            :newoid1
 347
 348 showing that the OID "newoid1" has been added as "1.2.3.4.1".
 349
 350 =head1 BUGS
 351
 352 Currently there is no way to include characters using the octal B<\nnn>
 353 form. Strings are all null terminated so nulls cannot form part of
 354 the value.
 355
 356 The escaping isn't quite right: if you want to use sequences like B<\n>
 357 you can't use any quote escaping on the same line.
 358
 359 Files are loaded in a single pass. This means that an variable expansion
 360 will only work if the variables referenced are defined earlier in the
 361 file.
 362
 363 =head1 SEE ALSO
 364
 365 L<x509(1)>, L<req(1)>, L<ca(1)>
 366
 367 =head1 COPYRIGHT
 368
 369 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 370
 371 Licensed under the OpenSSL license (the "License").  You may not use
 372 this file except in compliance with the License.  You can obtain a copy
 373 in the file LICENSE in the source distribution or at
 374 L<https://www.openssl.org/source/license.html>.
 375
 376 =cut