openssl.cnf
dir = certificates |
[ ca ] |
default_ca = CA_default |
[ CA_default ] |
serial = $dir/serial |
database = $dir/index.txt |
new_certs_dir = $dir/newcerts |
certificate = $dir/cacert.pem |
private_key = $dir/private/cakey.pem |
default_days = 36500 |
default_md = sha256 |
preserve = no |
email_in_dn = no |
nameopt = default_ca |
certopt = default_ca |
policy = policy_match |
[ policy_match ] |
commonName = supplied |
countryName = optional |
stateOrProvinceName = optional |
organizationName = optional |
organizationalUnitName = optional |
emailAddress = optional |
[ req ] |
default_bits = 2048 |
default_keyfile = priv.pem |
default_md = sha256 |
distinguished_name = req_distinguished_name |
req_extensions = v3_req |
encyrpt_key = no |
[ req_distinguished_name ] |
[ v3_ca ] |
basicConstraints = CA:TRUE |
subjectKeyIdentifier = hash |
authorityKeyIdentifier = keyid:always,issuer:always |
[ v3_req ] |
basicConstraints = CA:FALSE |
subjectKeyIdentifier = hash |
The environment variable OPENSSLCONF can be used to specify the location of the configuration file. If the environment variable is not specified, a default file is created in the default certificate storage area called openssl.cnf. The settings in this default configuration file depend on the flags set when the version of OpenSSL being used was built. This article is an overview of the available tools provided by openssl.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
Name
config - OpenSSL CONF library configuration files
Description
The OpenSSL CONF library can be used to read configuration files. It is used for the OpenSSL master configuration file openssl.cnf andin a few other places like SPKAC files and certificate extension files for the x509 utility. OpenSSL applications can also use theCONF library for their own purposes.
A configuration file is divided into a number of sections. Each section starts with a line [ section_name ] and ends when a new section is started orend of file is reached. A section name can consist of alphanumeric characters and underscores.
The first section of a configuration file is special and is referred to as the default section this is usually unnamed and is from the start of fileuntil the first named section. When a name is being looked up it is first looked up in a named section (if any) and then the default section.
The environment is mapped onto a section called ENV .
Comments can be included by preceding them with the # character
Each section in a configuration file consists of a number of name and value pairs of the form name=value
The name string can contain any alphanumeric characters as well as a few punctuation symbols such as . , ; and _.
The value string consists of the string following the = character until end of line with any leading and trailing white space removed.
The value string undergoes variable expansion. This can be done by including the form $var or ${var}: this will substitute the valueof the named variable in the current section. It is also possible to substitute a value from another section using the syntax $section::name or${section::name}. By using the form $ENV::name environment variables can be substituted. It is also possible to assign values toenvironment variables by using the name ENV::name, this will work if the program looks up environment variables using the CONFlibrary instead of calling getenv() directly.
It is possible to escape certain characters by using any kind of quote or the character. By making the last character of a line a avalue string can be spread across multiple lines. In addition the sequences n, r, b and t arerecognized.
Openssl Library Configuration
In OpenSSL 0.9.7 and later applications can automatically configure certain aspects of OpenSSL using the master OpenSSL configuration file, or optionally analternative configuration file. The openssl utility includes this functionality: any sub command uses the master OpenSSL configuration file unless anoption is used in the sub command to use an alternative configuration file.
To enable library configuration the default section needs to contain an appropriate line which points to the main configuration section. The default name isopenssl_conf which is used by the openssl utility. Other applications may use an alternative name such as myapplicaton_conf.
The configuration section should consist of a set of name value pairs which contain specific module configuration information. The name representsthe name of the configuration module the meaning of the value is module specific: it may, for example, represent a further configuration sectioncontaining configuration module specific information. E.g.Currently there are two configuration modules. One for ASN1 objects another for ENGINE configuration.
ASN1 OBJECT CONFIGURATION MODULE
The section pointed to by engines is a table of engine names (though see engine_id below) and further sections containing configurationinformations specific to each ENGINE .
Each ENGINE specific section is used to set default algorithms, load dynamic, perform initialization and send ctrls. The actual operationperformed depends on the command name which is the name of the name value pair. The currently supported commands are listed below.
For example:The command engine_id is used to give the ENGINE name. If used this command must be first. For example:The command dynamic_path loads and adds an ENGINE from the given path. It is equivalent to sending the ctrlsSO_PATH with the path argument followed by LIST_ADD with value 2 and LOAD to the dynamicENGINE . If this is not the required behaviour then alternative ctrls can be sent directly to the dynamic ENGINE using ctrlcommands.
The command init determines whether to initialize the ENGINE . If the value is 0 the ENGINE will not beinitialized, if 1 and attempt it made to initialized the ENGINE immediately. If the init command is not present then an attemptwill be made to initialize the ENGINE after all commands in its section have been processed.
The command default_algorithms sets the default algorithms an ENGINE will supply using the functionsENGINE_set_default_string()
If the name matches none of the above command names it is assumed to be a ctrl command which is sent to the ENGINE . The value of the commandis the argument to the ctrl command. If the value is the string EMPTY then no value is sent to the command.
![Openssl error, no objects specified in config file Openssl error, no objects specified in config file](/uploads/1/2/6/4/126463123/415552549.jpeg)
For example:
Notes
If a configuration file attempts to expand a variable that doesn't exist then an error is flagged and the file will not load. This can happen if an attemptis made to expand an environment variable that doesn't exist. For example in a previous version of OpenSSL the default OpenSSL master configuration file usedthe value of HOME which may not be defined on non Unix systems and would cause an error.
This can be worked around by including a default section to provide a default value: then if the environment lookup fails the default value will beused instead. For this to work properly the default value must be defined earlier in the configuration file than the expansion. See theEXAMPLES section for an example of how to do this.
If the same variable exists in the same section then all but the last value will be silently ignored. In certain circumstances such as with DNs the samefield may occur multiple times. This is usually worked around by ignoring any characters before an initial . e.g.
Examples
Here is a sample configuration file using some of the features mentioned above.This next example shows how to expand environment variables safely.
Suppose you want a variable called tmpfile to refer to a temporary filename. The directory it is placed in can determined by the theTEMP or TMP environment variables but they may not be set to any value at all. If you just include the environmentvariable names and the variable doesn't exist then this will cause an error when an attempt is made to load the configuration file. By making use of thedefault section both values can be looked up with TEMP taking priority and /tmp used if neither is defined:
Bugs
Currently there is no way to include characters using the octal nnn form. Strings are all null terminated so nulls cannot form part of the value.
The escaping isn't quite right: if you want to use sequences like n you can't use any quote escaping on the same line.
Files are loaded in a single pass. This means that an variable expansion will only work if the variables referenced are defined earlier in thefile.
See Also
x509(1), req(1), ca(1)