mirror of
https://github.com/Gator96100/ProxSpace.git
synced 2025-07-30 11:38:41 -07:00
Updated msys2
This commit is contained in:
gator96100
parent
6a85995508
commit
f0dc1ea8b0
13308 changed files with 689276 additions and 46605 deletions
347
msys2/usr/share/doc/openssl/html/man5/config.html
Normal file
347
msys2/usr/share/doc/openssl/html/man5/config.html
Normal file
|
|
@ -0,0 +1,347 @@
|
|||
<?xml version="1.0" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>config</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rev="made" href="mailto:" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
|
||||
<ul id="index">
|
||||
<li><a href="#NAME">NAME</a></li>
|
||||
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
|
||||
<li><a href="#OPENSSL-LIBRARY-CONFIGURATION">OPENSSL LIBRARY CONFIGURATION</a>
|
||||
<ul>
|
||||
<li><a href="#ASN1-Object-Configuration-Module">ASN1 Object Configuration Module</a></li>
|
||||
<li><a href="#Engine-Configuration-Module">Engine Configuration Module</a></li>
|
||||
<li><a href="#EVP-Configuration-Module">EVP Configuration Module</a></li>
|
||||
<li><a href="#SSL-Configuration-Module">SSL Configuration Module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#NOTES">NOTES</a></li>
|
||||
<li><a href="#EXAMPLES">EXAMPLES</a></li>
|
||||
<li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
|
||||
<li><a href="#BUGS">BUGS</a></li>
|
||||
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||||
<li><a href="#COPYRIGHT">COPYRIGHT</a></li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>config - OpenSSL CONF library configuration files</p>
|
||||
|
||||
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||||
|
||||
<p>The OpenSSL CONF library can be used to read configuration files. It is used for the OpenSSL master configuration file <b>openssl.cnf</b> and in a few other places like <b>SPKAC</b> files and certificate extension files for the <b>x509</b> utility. OpenSSL applications can also use the CONF library for their own purposes.</p>
|
||||
|
||||
<p>A configuration file is divided into a number of sections. Each section starts with a line <b>[ section_name ]</b> and ends when a new section is started or end of file is reached. A section name can consist of alphanumeric characters and underscores.</p>
|
||||
|
||||
<p>The first section of a configuration file is special and is referred to as the <b>default</b> section. This section is usually unnamed and spans from the start of file until 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.</p>
|
||||
|
||||
<p>The environment is mapped onto a section called <b>ENV</b>.</p>
|
||||
|
||||
<p>Comments can be included by preceding them with the <b>#</b> character</p>
|
||||
|
||||
<p>Other files can be included using the <b>.include</b> directive followed by a path. If the path points to a directory all files with names ending with <b>.cnf</b> or <b>.conf</b> are included from the directory. Recursive inclusion of directories from files in such directory is not supported. That means the files in the included directory can also contain <b>.include</b> directives but only inclusion of regular files is supported there. The inclusion of directories is not supported on systems without POSIX IO support.</p>
|
||||
|
||||
<p>It is strongly recommended to use absolute paths with the <b>.include</b> directive. Relative paths are evaluated based on the application current working directory so unless the configuration file containing the <b>.include</b> directive is application specific the inclusion will not work as expected.</p>
|
||||
|
||||
<p>There can be optional <b>=</b> character and whitespace characters between <b>.include</b> directive and the path which can be useful in cases the configuration file needs to be loaded by old OpenSSL versions which do not support the <b>.include</b> syntax. They would bail out with error if the <b>=</b> character is not present but with it they just ignore the include.</p>
|
||||
|
||||
<p>Each section in a configuration file consists of a number of name and value pairs of the form <b>name=value</b></p>
|
||||
|
||||
<p>The <b>name</b> string can contain any alphanumeric characters as well as a few punctuation symbols such as <b>.</b> <b>,</b> <b>;</b> and <b>_</b>.</p>
|
||||
|
||||
<p>The <b>value</b> string consists of the string following the <b>=</b> character until end of line with any leading and trailing white space removed.</p>
|
||||
|
||||
<p>The value string undergoes variable expansion. This can be done by including the form <b>$var</b> or <b>${var}</b>: this will substitute the value of the named variable in the current section. It is also possible to substitute a value from another section using the syntax <b>$section::name</b> or <b>${section::name}</b>. By using the form <b>$ENV::name</b> environment variables can be substituted. It is also possible to assign values to environment variables by using the name <b>ENV::name</b>, this will work if the program looks up environment variables using the <b>CONF</b> library instead of calling getenv() directly. The value string must not exceed 64k in length after variable expansion. Otherwise an error will occur.</p>
|
||||
|
||||
<p>It is possible to escape certain characters by using any kind of quote or the <b>\</b> character. By making the last character of a line a <b>\</b> a <b>value</b> string can be spread across multiple lines. In addition the sequences <b>\n</b>, <b>\r</b>, <b>\b</b> and <b>\t</b> are recognized.</p>
|
||||
|
||||
<p>All expansion and escape rules as described above that apply to <b>value</b> also apply to the path of the <b>.include</b> directive.</p>
|
||||
|
||||
<h1 id="OPENSSL-LIBRARY-CONFIGURATION">OPENSSL LIBRARY CONFIGURATION</h1>
|
||||
|
||||
<p>Applications can automatically configure certain aspects of OpenSSL using the master OpenSSL configuration file, or optionally an alternative configuration file. The <b>openssl</b> utility includes this functionality: any sub command uses the master OpenSSL configuration file unless an option is used in the sub command to use an alternative configuration file.</p>
|
||||
|
||||
<p>To enable library configuration the default section needs to contain an appropriate line which points to the main configuration section. The default name is <b>openssl_conf</b> which is used by the <b>openssl</b> utility. Other applications may use an alternative name such as <b>myapplication_conf</b>. All library configuration lines appear in the default section at the start of the configuration file.</p>
|
||||
|
||||
<p>The configuration section should consist of a set of name value pairs which contain specific module configuration information. The <b>name</b> represents the name of the <i>configuration module</i>. The meaning of the <b>value</b> is module specific: it may, for example, represent a further configuration section containing configuration module specific information. E.g.:</p>
|
||||
|
||||
<pre><code> # This must be in the default section
|
||||
openssl_conf = openssl_init
|
||||
|
||||
[openssl_init]
|
||||
|
||||
oid_section = new_oids
|
||||
engines = engine_section
|
||||
|
||||
[new_oids]
|
||||
|
||||
... new oids here ...
|
||||
|
||||
[engine_section]
|
||||
|
||||
... engine stuff here ...</code></pre>
|
||||
|
||||
<p>The features of each configuration module are described below.</p>
|
||||
|
||||
<h2 id="ASN1-Object-Configuration-Module">ASN1 Object Configuration Module</h2>
|
||||
|
||||
<p>This module has the name <b>oid_section</b>. The value of this variable points to a section containing name value pairs of OIDs: the name is the OID short and long name, the value is the numerical form of the OID. Although some of the <b>openssl</b> utility sub commands already have their own ASN1 OBJECT section functionality not all do. By using the ASN1 OBJECT configuration module <b>all</b> the <b>openssl</b> utility sub commands can see the new objects as well as any compliant applications. For example:</p>
|
||||
|
||||
<pre><code> [new_oids]
|
||||
|
||||
some_new_oid = 1.2.3.4
|
||||
some_other_oid = 1.2.3.5</code></pre>
|
||||
|
||||
<p>It is also possible to set the value to the long name followed by a comma and the numerical OID form. For example:</p>
|
||||
|
||||
<pre><code> shortName = some object long name, 1.2.3.4</code></pre>
|
||||
|
||||
<h2 id="Engine-Configuration-Module">Engine Configuration Module</h2>
|
||||
|
||||
<p>This ENGINE configuration module has the name <b>engines</b>. The value of this variable points to a section containing further ENGINE configuration information.</p>
|
||||
|
||||
<p>The section pointed to by <b>engines</b> is a table of engine names (though see <b>engine_id</b> below) and further sections containing configuration information specific to each ENGINE.</p>
|
||||
|
||||
<p>Each ENGINE specific section is used to set default algorithms, load dynamic, perform initialization and send ctrls. The actual operation performed depends on the <i>command</i> name which is the name of the name value pair. The currently supported commands are listed below.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code> [engine_section]
|
||||
|
||||
# Configure ENGINE named "foo"
|
||||
foo = foo_section
|
||||
# Configure ENGINE named "bar"
|
||||
bar = bar_section
|
||||
|
||||
[foo_section]
|
||||
... foo ENGINE specific commands ...
|
||||
|
||||
[bar_section]
|
||||
... "bar" ENGINE specific commands ...</code></pre>
|
||||
|
||||
<p>The command <b>engine_id</b> is used to give the ENGINE name. If used this command must be first. For example:</p>
|
||||
|
||||
<pre><code> [engine_section]
|
||||
# This would normally handle an ENGINE named "foo"
|
||||
foo = foo_section
|
||||
|
||||
[foo_section]
|
||||
# Override default name and use "myfoo" instead.
|
||||
engine_id = myfoo</code></pre>
|
||||
|
||||
<p>The command <b>dynamic_path</b> loads and adds an ENGINE from the given path. It is equivalent to sending the ctrls <b>SO_PATH</b> with the path argument followed by <b>LIST_ADD</b> with value 2 and <b>LOAD</b> to the dynamic ENGINE. If this is not the required behaviour then alternative ctrls can be sent directly to the dynamic ENGINE using ctrl commands.</p>
|
||||
|
||||
<p>The command <b>init</b> determines whether to initialize the ENGINE. If the value is <b>0</b> the ENGINE will not be initialized, if <b>1</b> and attempt it made to initialized the ENGINE immediately. If the <b>init</b> command is not present then an attempt will be made to initialize the ENGINE after all commands in its section have been processed.</p>
|
||||
|
||||
<p>The command <b>default_algorithms</b> sets the default algorithms an ENGINE will supply using the functions ENGINE_set_default_string().</p>
|
||||
|
||||
<p>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 command is the argument to the ctrl command. If the value is the string <b>EMPTY</b> then no value is sent to the command.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code> [engine_section]
|
||||
|
||||
# Configure ENGINE named "foo"
|
||||
foo = foo_section
|
||||
|
||||
[foo_section]
|
||||
# Load engine from DSO
|
||||
dynamic_path = /some/path/fooengine.so
|
||||
# A foo specific ctrl.
|
||||
some_ctrl = some_value
|
||||
# Another ctrl that doesn't take a value.
|
||||
other_ctrl = EMPTY
|
||||
# Supply all default algorithms
|
||||
default_algorithms = ALL</code></pre>
|
||||
|
||||
<h2 id="EVP-Configuration-Module">EVP Configuration Module</h2>
|
||||
|
||||
<p>This modules has the name <b>alg_section</b> which points to a section containing algorithm commands.</p>
|
||||
|
||||
<p>Currently the only algorithm command supported is <b>fips_mode</b> whose value can only be the boolean string <b>off</b>. If <b>fips_mode</b> is set to <b>on</b>, an error occurs as this library version is not FIPS capable.</p>
|
||||
|
||||
<h2 id="SSL-Configuration-Module">SSL Configuration Module</h2>
|
||||
|
||||
<p>This module has the name <b>ssl_conf</b> which points to a section containing SSL configurations.</p>
|
||||
|
||||
<p>Each line in the SSL configuration section contains the name of the configuration and the section containing it.</p>
|
||||
|
||||
<p>Each configuration section consists of command value pairs for <b>SSL_CONF</b>. Each pair will be passed to a <b>SSL_CTX</b> or <b>SSL</b> structure if it calls SSL_CTX_config() or SSL_config() with the appropriate configuration name.</p>
|
||||
|
||||
<p>Note: any characters before an initial dot in the configuration section are ignored so the same command can be used multiple times.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code> ssl_conf = ssl_sect
|
||||
|
||||
[ssl_sect]
|
||||
|
||||
server = server_section
|
||||
|
||||
[server_section]
|
||||
|
||||
RSA.Certificate = server-rsa.pem
|
||||
ECDSA.Certificate = server-ecdsa.pem
|
||||
Ciphers = ALL:!RC4</code></pre>
|
||||
|
||||
<p>The system default configuration with name <b>system_default</b> if present will be applied during any creation of the <b>SSL_CTX</b> structure.</p>
|
||||
|
||||
<p>Example of a configuration with the system default:</p>
|
||||
|
||||
<pre><code> ssl_conf = ssl_sect
|
||||
|
||||
[ssl_sect]
|
||||
|
||||
system_default = system_default_sect
|
||||
|
||||
[system_default_sect]
|
||||
|
||||
MinProtocol = TLSv1.2</code></pre>
|
||||
|
||||
<h1 id="NOTES">NOTES</h1>
|
||||
|
||||
<p>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 attempt is made to expand an environment variable that doesn't exist. For example in a previous version of OpenSSL the default OpenSSL master configuration file used the value of <b>HOME</b> which may not be defined on non Unix systems and would cause an error.</p>
|
||||
|
||||
<p>This can be worked around by including a <b>default</b> section to provide a default value: then if the environment lookup fails the default value will be used instead. For this to work properly the default value must be defined earlier in the configuration file than the expansion. See the <b>EXAMPLES</b> section for an example of how to do this.</p>
|
||||
|
||||
<p>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 same field may occur multiple times. This is usually worked around by ignoring any characters before an initial <b>.</b> e.g.</p>
|
||||
|
||||
<pre><code> 1.OU="My first OU"
|
||||
2.OU="My Second OU"</code></pre>
|
||||
|
||||
<h1 id="EXAMPLES">EXAMPLES</h1>
|
||||
|
||||
<p>Here is a sample configuration file using some of the features mentioned above.</p>
|
||||
|
||||
<pre><code> # This is the default section.
|
||||
|
||||
HOME=/temp
|
||||
RANDFILE= ${ENV::HOME}/.rnd
|
||||
configdir=$ENV::HOME/config
|
||||
|
||||
[ section_one ]
|
||||
|
||||
# We are now in section one.
|
||||
|
||||
# Quotes permit leading and trailing whitespace
|
||||
any = " any variable name "
|
||||
|
||||
other = A string that can \
|
||||
cover several lines \
|
||||
by including \\ characters
|
||||
|
||||
message = Hello World\n
|
||||
|
||||
[ section_two ]
|
||||
|
||||
greeting = $section_one::message</code></pre>
|
||||
|
||||
<p>This next example shows how to expand environment variables safely.</p>
|
||||
|
||||
<p>Suppose you want a variable called <b>tmpfile</b> to refer to a temporary filename. The directory it is placed in can determined by the <b>TEMP</b> or <b>TMP</b> environment variables but they may not be set to any value at all. If you just include the environment variable 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 the default section both values can be looked up with <b>TEMP</b> taking priority and <b>/tmp</b> used if neither is defined:</p>
|
||||
|
||||
<pre><code> TMP=/tmp
|
||||
# The above value is used if TMP isn't in the environment
|
||||
TEMP=$ENV::TMP
|
||||
# The above value is used if TEMP isn't in the environment
|
||||
tmpfile=${ENV::TEMP}/tmp.filename</code></pre>
|
||||
|
||||
<p>Simple OpenSSL library configuration example to enter FIPS mode:</p>
|
||||
|
||||
<pre><code> # Default appname: should match "appname" parameter (if any)
|
||||
# supplied to CONF_modules_load_file et al.
|
||||
openssl_conf = openssl_conf_section
|
||||
|
||||
[openssl_conf_section]
|
||||
# Configuration module list
|
||||
alg_section = evp_sect
|
||||
|
||||
[evp_sect]
|
||||
# Set to "yes" to enter FIPS mode if supported
|
||||
fips_mode = yes</code></pre>
|
||||
|
||||
<p>Note: in the above example you will get an error in non FIPS capable versions of OpenSSL.</p>
|
||||
|
||||
<p>More complex OpenSSL library configuration. Add OID and don't enter FIPS mode:</p>
|
||||
|
||||
<pre><code> # Default appname: should match "appname" parameter (if any)
|
||||
# supplied to CONF_modules_load_file et al.
|
||||
openssl_conf = openssl_conf_section
|
||||
|
||||
[openssl_conf_section]
|
||||
# Configuration module list
|
||||
alg_section = evp_sect
|
||||
oid_section = new_oids
|
||||
|
||||
[evp_sect]
|
||||
# This will have no effect as FIPS mode is off by default.
|
||||
# Set to "yes" to enter FIPS mode, if supported
|
||||
fips_mode = no
|
||||
|
||||
[new_oids]
|
||||
# New OID, just short name
|
||||
newoid1 = 1.2.3.4.1
|
||||
# New OID shortname and long name
|
||||
newoid2 = New OID 2 long name, 1.2.3.4.2</code></pre>
|
||||
|
||||
<p>The above examples can be used with any application supporting library configuration if "openssl_conf" is modified to match the appropriate "appname".</p>
|
||||
|
||||
<p>For example if the second sample file above is saved to "example.cnf" then the command line:</p>
|
||||
|
||||
<pre><code> OPENSSL_CONF=example.cnf openssl asn1parse -genstr OID:1.2.3.4.1</code></pre>
|
||||
|
||||
<p>will output:</p>
|
||||
|
||||
<pre><code> 0:d=0 hl=2 l= 4 prim: OBJECT :newoid1</code></pre>
|
||||
|
||||
<p>showing that the OID "newoid1" has been added as "1.2.3.4.1".</p>
|
||||
|
||||
<h1 id="ENVIRONMENT">ENVIRONMENT</h1>
|
||||
|
||||
<dl>
|
||||
|
||||
<dt id="OPENSSL_CONF"><b>OPENSSL_CONF</b></dt>
|
||||
<dd>
|
||||
|
||||
<p>The path to the config file. Ignored in set-user-ID and set-group-ID programs.</p>
|
||||
|
||||
</dd>
|
||||
<dt id="OPENSSL_ENGINES"><b>OPENSSL_ENGINES</b></dt>
|
||||
<dd>
|
||||
|
||||
<p>The path to the engines directory. Ignored in set-user-ID and set-group-ID programs.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h1 id="BUGS">BUGS</h1>
|
||||
|
||||
<p>Currently there is no way to include characters using the octal <b>\nnn</b> form. Strings are all null terminated so nulls cannot form part of the value.</p>
|
||||
|
||||
<p>The escaping isn't quite right: if you want to use sequences like <b>\n</b> you can't use any quote escaping on the same line.</p>
|
||||
|
||||
<p>Files are loaded in a single pass. This means that an variable expansion will only work if the variables referenced are defined earlier in the file.</p>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
<p><a href="../man1/x509.html">x509(1)</a>, <a href="../man1/req.html">req(1)</a>, <a href="../man1/ca.html">ca(1)</a></p>
|
||||
|
||||
<h1 id="COPYRIGHT">COPYRIGHT</h1>
|
||||
|
||||
<p>Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.</p>
|
||||
|
||||
<p>Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
|
||||
464
msys2/usr/share/doc/openssl/html/man5/x509v3_config.html
Normal file
464
msys2/usr/share/doc/openssl/html/man5/x509v3_config.html
Normal file
|
|
@ -0,0 +1,464 @@
|
|||
<?xml version="1.0" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>x509v3_config</title>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||||
<link rev="made" href="mailto:" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
|
||||
<ul id="index">
|
||||
<li><a href="#NAME">NAME</a></li>
|
||||
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
|
||||
<li><a href="#STANDARD-EXTENSIONS">STANDARD EXTENSIONS</a>
|
||||
<ul>
|
||||
<li><a href="#Basic-Constraints">Basic Constraints.</a></li>
|
||||
<li><a href="#Key-Usage">Key Usage.</a></li>
|
||||
<li><a href="#Extended-Key-Usage">Extended Key Usage.</a></li>
|
||||
<li><a href="#Subject-Key-Identifier">Subject Key Identifier.</a></li>
|
||||
<li><a href="#Authority-Key-Identifier">Authority Key Identifier.</a></li>
|
||||
<li><a href="#Subject-Alternative-Name">Subject Alternative Name.</a></li>
|
||||
<li><a href="#Issuer-Alternative-Name">Issuer Alternative Name.</a></li>
|
||||
<li><a href="#Authority-Info-Access">Authority Info Access.</a></li>
|
||||
<li><a href="#CRL-distribution-points">CRL distribution points</a></li>
|
||||
<li><a href="#Issuing-Distribution-Point">Issuing Distribution Point</a></li>
|
||||
<li><a href="#Certificate-Policies">Certificate Policies.</a></li>
|
||||
<li><a href="#Policy-Constraints">Policy Constraints</a></li>
|
||||
<li><a href="#Inhibit-Any-Policy">Inhibit Any Policy</a></li>
|
||||
<li><a href="#Name-Constraints">Name Constraints</a></li>
|
||||
<li><a href="#OCSP-No-Check">OCSP No Check</a></li>
|
||||
<li><a href="#TLS-Feature-aka-Must-Staple">TLS Feature (aka Must Staple)</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#DEPRECATED-EXTENSIONS">DEPRECATED EXTENSIONS</a>
|
||||
<ul>
|
||||
<li><a href="#Netscape-String-extensions">Netscape String extensions.</a></li>
|
||||
<li><a href="#Netscape-Certificate-Type">Netscape Certificate Type</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#ARBITRARY-EXTENSIONS">ARBITRARY EXTENSIONS</a></li>
|
||||
<li><a href="#WARNING">WARNING</a></li>
|
||||
<li><a href="#NOTES">NOTES</a></li>
|
||||
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
|
||||
<li><a href="#COPYRIGHT">COPYRIGHT</a></li>
|
||||
</ul>
|
||||
|
||||
<h1 id="NAME">NAME</h1>
|
||||
|
||||
<p>x509v3_config - X509 V3 certificate extension configuration format</p>
|
||||
|
||||
<h1 id="DESCRIPTION">DESCRIPTION</h1>
|
||||
|
||||
<p>Several of the OpenSSL utilities can add extensions to a certificate or certificate request based on the contents of a configuration file.</p>
|
||||
|
||||
<p>Typically the application will contain an option to point to an extension section. Each line of the extension section takes the form:</p>
|
||||
|
||||
<pre><code> extension_name=[critical,] extension_options</code></pre>
|
||||
|
||||
<p>If <b>critical</b> is present then the extension will be critical.</p>
|
||||
|
||||
<p>The format of <b>extension_options</b> depends on the value of <b>extension_name</b>.</p>
|
||||
|
||||
<p>There are four main types of extension: <i>string</i> extensions, <i>multi-valued</i> extensions, <i>raw</i> and <i>arbitrary</i> extensions.</p>
|
||||
|
||||
<p>String extensions simply have a string which contains either the value itself or how it is obtained.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code> nsComment="This is a Comment"</code></pre>
|
||||
|
||||
<p>Multi-valued extensions have a short form and a long form. The short form is a list of names and values:</p>
|
||||
|
||||
<pre><code> basicConstraints=critical,CA:true,pathlen:1</code></pre>
|
||||
|
||||
<p>The long form allows the values to be placed in a separate section:</p>
|
||||
|
||||
<pre><code> basicConstraints=critical,@bs_section
|
||||
|
||||
[bs_section]
|
||||
|
||||
CA=true
|
||||
pathlen=1</code></pre>
|
||||
|
||||
<p>Both forms are equivalent.</p>
|
||||
|
||||
<p>The syntax of raw extensions is governed by the extension code: it can for example contain data in multiple sections. The correct syntax to use is defined by the extension code itself: check out the certificate policies extension for an example.</p>
|
||||
|
||||
<p>If an extension type is unsupported then the <i>arbitrary</i> extension syntax must be used, see the <a href="#ARBITRARY-EXTENSIONS">ARBITRARY EXTENSIONS</a> section for more details.</p>
|
||||
|
||||
<h1 id="STANDARD-EXTENSIONS">STANDARD EXTENSIONS</h1>
|
||||
|
||||
<p>The following sections describe each supported extension in detail.</p>
|
||||
|
||||
<h2 id="Basic-Constraints">Basic Constraints.</h2>
|
||||
|
||||
<p>This is a multi valued extension which indicates whether a certificate is a CA certificate. The first (mandatory) name is <b>CA</b> followed by <b>TRUE</b> or <b>FALSE</b>. If <b>CA</b> is <b>TRUE</b> then an optional <b>pathlen</b> name followed by an non-negative value can be included.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code> basicConstraints=CA:TRUE
|
||||
|
||||
basicConstraints=CA:FALSE
|
||||
|
||||
basicConstraints=critical,CA:TRUE, pathlen:0</code></pre>
|
||||
|
||||
<p>A CA certificate <b>must</b> include the basicConstraints value with the CA field set to TRUE. An end user certificate must either set CA to FALSE or exclude the extension entirely. Some software may require the inclusion of basicConstraints with CA set to FALSE for end entity certificates.</p>
|
||||
|
||||
<p>The pathlen parameter indicates the maximum number of CAs that can appear below this one in a chain. So if you have a CA with a pathlen of zero it can only be used to sign end user certificates and not further CAs.</p>
|
||||
|
||||
<h2 id="Key-Usage">Key Usage.</h2>
|
||||
|
||||
<p>Key usage is a multi valued extension consisting of a list of names of the permitted key usages.</p>
|
||||
|
||||
<p>The supported names are: digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly and decipherOnly.</p>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<pre><code> keyUsage=digitalSignature, nonRepudiation
|
||||
|
||||
keyUsage=critical, keyCertSign</code></pre>
|
||||
|
||||
<h2 id="Extended-Key-Usage">Extended Key Usage.</h2>
|
||||
|
||||
<p>This extensions consists of a list of usages indicating purposes for which the certificate public key can be used for,</p>
|
||||
|
||||
<p>These can either be object short names or the dotted numerical form of OIDs. While any OID can be used only certain values make sense. In particular the following PKIX, NS and MS values are meaningful:</p>
|
||||
|
||||
<pre><code> Value Meaning
|
||||
----- -------
|
||||
serverAuth SSL/TLS Web Server Authentication.
|
||||
clientAuth SSL/TLS Web Client Authentication.
|
||||
codeSigning Code signing.
|
||||
emailProtection E-mail Protection (S/MIME).
|
||||
timeStamping Trusted Timestamping
|
||||
OCSPSigning OCSP Signing
|
||||
ipsecIKE ipsec Internet Key Exchange
|
||||
msCodeInd Microsoft Individual Code Signing (authenticode)
|
||||
msCodeCom Microsoft Commercial Code Signing (authenticode)
|
||||
msCTLSign Microsoft Trust List Signing
|
||||
msEFS Microsoft Encrypted File System</code></pre>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<pre><code> extendedKeyUsage=critical,codeSigning,1.2.3.4
|
||||
extendedKeyUsage=serverAuth,clientAuth</code></pre>
|
||||
|
||||
<h2 id="Subject-Key-Identifier">Subject Key Identifier.</h2>
|
||||
|
||||
<p>This is really a string extension and can take two possible values. Either the word <b>hash</b> which will automatically follow the guidelines in RFC3280 or a hex string giving the extension value to include. The use of the hex string is strongly discouraged.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> subjectKeyIdentifier=hash</code></pre>
|
||||
|
||||
<h2 id="Authority-Key-Identifier">Authority Key Identifier.</h2>
|
||||
|
||||
<p>The authority key identifier extension permits two options. keyid and issuer: both can take the optional value "always".</p>
|
||||
|
||||
<p>If the keyid option is present an attempt is made to copy the subject key identifier from the parent certificate. If the value "always" is present then an error is returned if the option fails.</p>
|
||||
|
||||
<p>The issuer option copies the issuer and serial number from the issuer certificate. This will only be done if the keyid option fails or is not included unless the "always" flag will always include the value.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> authorityKeyIdentifier=keyid,issuer</code></pre>
|
||||
|
||||
<h2 id="Subject-Alternative-Name">Subject Alternative Name.</h2>
|
||||
|
||||
<p>The subject alternative name extension allows various literal values to be included in the configuration file. These include <b>email</b> (an email address) <b>URI</b> a uniform resource indicator, <b>DNS</b> (a DNS domain name), <b>RID</b> (a registered ID: OBJECT IDENTIFIER), <b>IP</b> (an IP address), <b>dirName</b> (a distinguished name) and otherName.</p>
|
||||
|
||||
<p>The email option include a special 'copy' value. This will automatically include any email addresses contained in the certificate subject name in the extension.</p>
|
||||
|
||||
<p>The IP address used in the <b>IP</b> options can be in either IPv4 or IPv6 format.</p>
|
||||
|
||||
<p>The value of <b>dirName</b> should point to a section containing the distinguished name to use as a set of name value pairs. Multi values AVAs can be formed by prefacing the name with a <b>+</b> character.</p>
|
||||
|
||||
<p>otherName can include arbitrary data associated with an OID: the value should be the OID followed by a semicolon and the content in standard <a href="../man3/ASN1_generate_nconf.html">ASN1_generate_nconf(3)</a> format.</p>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<pre><code> subjectAltName=email:copy,email:my@other.address,URI:http://my.url.here/
|
||||
subjectAltName=IP:192.168.7.1
|
||||
subjectAltName=IP:13::17
|
||||
subjectAltName=email:my@other.address,RID:1.2.3.4
|
||||
subjectAltName=otherName:1.2.3.4;UTF8:some other identifier
|
||||
|
||||
subjectAltName=dirName:dir_sect
|
||||
|
||||
[dir_sect]
|
||||
C=UK
|
||||
O=My Organization
|
||||
OU=My Unit
|
||||
CN=My Name</code></pre>
|
||||
|
||||
<h2 id="Issuer-Alternative-Name">Issuer Alternative Name.</h2>
|
||||
|
||||
<p>The issuer alternative name option supports all the literal options of subject alternative name. It does <b>not</b> support the email:copy option because that would not make sense. It does support an additional issuer:copy option that will copy all the subject alternative name values from the issuer certificate (if possible).</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> issuerAltName = issuer:copy</code></pre>
|
||||
|
||||
<h2 id="Authority-Info-Access">Authority Info Access.</h2>
|
||||
|
||||
<p>The authority information access extension gives details about how to access certain information relating to the CA. Its syntax is accessOID;location where <i>location</i> has the same syntax as subject alternative name (except that email:copy is not supported). accessOID can be any valid OID but only certain values are meaningful, for example OCSP and caIssuers.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> authorityInfoAccess = OCSP;URI:http://ocsp.my.host/
|
||||
authorityInfoAccess = caIssuers;URI:http://my.ca/ca.html</code></pre>
|
||||
|
||||
<h2 id="CRL-distribution-points">CRL distribution points</h2>
|
||||
|
||||
<p>This is a multi-valued extension whose options can be either in name:value pair using the same form as subject alternative name or a single value representing a section name containing all the distribution point fields.</p>
|
||||
|
||||
<p>For a name:value pair a new DistributionPoint with the fullName field set to the given value both the cRLissuer and reasons fields are omitted in this case.</p>
|
||||
|
||||
<p>In the single option case the section indicated contains values for each field. In this section:</p>
|
||||
|
||||
<p>If the name is "fullname" the value field should contain the full name of the distribution point in the same format as subject alternative name.</p>
|
||||
|
||||
<p>If the name is "relativename" then the value field should contain a section name whose contents represent a DN fragment to be placed in this field.</p>
|
||||
|
||||
<p>The name "CRLIssuer" if present should contain a value for this field in subject alternative name format.</p>
|
||||
|
||||
<p>If the name is "reasons" the value field should consist of a comma separated field containing the reasons. Valid reasons are: "keyCompromise", "CACompromise", "affiliationChanged", "superseded", "cessationOfOperation", "certificateHold", "privilegeWithdrawn" and "AACompromise".</p>
|
||||
|
||||
<p>Simple examples:</p>
|
||||
|
||||
<pre><code> crlDistributionPoints=URI:http://myhost.com/myca.crl
|
||||
crlDistributionPoints=URI:http://my.com/my.crl,URI:http://oth.com/my.crl</code></pre>
|
||||
|
||||
<p>Full distribution point example:</p>
|
||||
|
||||
<pre><code> crlDistributionPoints=crldp1_section
|
||||
|
||||
[crldp1_section]
|
||||
|
||||
fullname=URI:http://myhost.com/myca.crl
|
||||
CRLissuer=dirName:issuer_sect
|
||||
reasons=keyCompromise, CACompromise
|
||||
|
||||
[issuer_sect]
|
||||
C=UK
|
||||
O=Organisation
|
||||
CN=Some Name</code></pre>
|
||||
|
||||
<h2 id="Issuing-Distribution-Point">Issuing Distribution Point</h2>
|
||||
|
||||
<p>This extension should only appear in CRLs. It is a multi valued extension whose syntax is similar to the "section" pointed to by the CRL distribution points extension with a few differences.</p>
|
||||
|
||||
<p>The names "reasons" and "CRLissuer" are not recognized.</p>
|
||||
|
||||
<p>The name "onlysomereasons" is accepted which sets this field. The value is in the same format as the CRL distribution point "reasons" field.</p>
|
||||
|
||||
<p>The names "onlyuser", "onlyCA", "onlyAA" and "indirectCRL" are also accepted the values should be a boolean value (TRUE or FALSE) to indicate the value of the corresponding field.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> issuingDistributionPoint=critical, @idp_section
|
||||
|
||||
[idp_section]
|
||||
|
||||
fullname=URI:http://myhost.com/myca.crl
|
||||
indirectCRL=TRUE
|
||||
onlysomereasons=keyCompromise, CACompromise
|
||||
|
||||
[issuer_sect]
|
||||
C=UK
|
||||
O=Organisation
|
||||
CN=Some Name</code></pre>
|
||||
|
||||
<h2 id="Certificate-Policies">Certificate Policies.</h2>
|
||||
|
||||
<p>This is a <i>raw</i> extension. All the fields of this extension can be set by using the appropriate syntax.</p>
|
||||
|
||||
<p>If you follow the PKIX recommendations and just using one OID then you just include the value of that OID. Multiple OIDs can be set separated by commas, for example:</p>
|
||||
|
||||
<pre><code> certificatePolicies= 1.2.4.5, 1.1.3.4</code></pre>
|
||||
|
||||
<p>If you wish to include qualifiers then the policy OID and qualifiers need to be specified in a separate section: this is done by using the @section syntax instead of a literal OID value.</p>
|
||||
|
||||
<p>The section referred to must include the policy OID using the name policyIdentifier, cPSuri qualifiers can be included using the syntax:</p>
|
||||
|
||||
<pre><code> CPS.nnn=value</code></pre>
|
||||
|
||||
<p>userNotice qualifiers can be set using the syntax:</p>
|
||||
|
||||
<pre><code> userNotice.nnn=@notice</code></pre>
|
||||
|
||||
<p>The value of the userNotice qualifier is specified in the relevant section. This section can include explicitText, organization and noticeNumbers options. explicitText and organization are text strings, noticeNumbers is a comma separated list of numbers. The organization and noticeNumbers options (if included) must BOTH be present. If you use the userNotice option with IE5 then you need the 'ia5org' option at the top level to modify the encoding: otherwise it will not be interpreted properly.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> certificatePolicies=ia5org,1.2.3.4,1.5.6.7.8,@polsect
|
||||
|
||||
[polsect]
|
||||
|
||||
policyIdentifier = 1.3.5.8
|
||||
CPS.1="http://my.host.name/"
|
||||
CPS.2="http://my.your.name/"
|
||||
userNotice.1=@notice
|
||||
|
||||
[notice]
|
||||
|
||||
explicitText="Explicit Text Here"
|
||||
organization="Organisation Name"
|
||||
noticeNumbers=1,2,3,4</code></pre>
|
||||
|
||||
<p>The <b>ia5org</b> option changes the type of the <i>organization</i> field. In RFC2459 it can only be of type DisplayText. In RFC3280 IA5String is also permissible. Some software (for example some versions of MSIE) may require ia5org.</p>
|
||||
|
||||
<p>ASN1 type of explicitText can be specified by prepending <b>UTF8</b>, <b>BMP</b> or <b>VISIBLE</b> prefix followed by colon. For example:</p>
|
||||
|
||||
<pre><code> [notice]
|
||||
explicitText="UTF8:Explicit Text Here"</code></pre>
|
||||
|
||||
<h2 id="Policy-Constraints">Policy Constraints</h2>
|
||||
|
||||
<p>This is a multi-valued extension which consisting of the names <b>requireExplicitPolicy</b> or <b>inhibitPolicyMapping</b> and a non negative integer value. At least one component must be present.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> policyConstraints = requireExplicitPolicy:3</code></pre>
|
||||
|
||||
<h2 id="Inhibit-Any-Policy">Inhibit Any Policy</h2>
|
||||
|
||||
<p>This is a string extension whose value must be a non negative integer.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> inhibitAnyPolicy = 2</code></pre>
|
||||
|
||||
<h2 id="Name-Constraints">Name Constraints</h2>
|
||||
|
||||
<p>The name constraints extension is a multi-valued extension. The name should begin with the word <b>permitted</b> or <b>excluded</b> followed by a <b>;</b>. The rest of the name and the value follows the syntax of subjectAltName except email:copy is not supported and the <b>IP</b> form should consist of an IP addresses and subnet mask separated by a <b>/</b>.</p>
|
||||
|
||||
<p>Examples:</p>
|
||||
|
||||
<pre><code> nameConstraints=permitted;IP:192.168.0.0/255.255.0.0
|
||||
|
||||
nameConstraints=permitted;email:.somedomain.com
|
||||
|
||||
nameConstraints=excluded;email:.com</code></pre>
|
||||
|
||||
<h2 id="OCSP-No-Check">OCSP No Check</h2>
|
||||
|
||||
<p>The OCSP No Check extension is a string extension but its value is ignored.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> noCheck = ignored</code></pre>
|
||||
|
||||
<h2 id="TLS-Feature-aka-Must-Staple">TLS Feature (aka Must Staple)</h2>
|
||||
|
||||
<p>This is a multi-valued extension consisting of a list of TLS extension identifiers. Each identifier may be a number (0..65535) or a supported name. When a TLS client sends a listed extension, the TLS server is expected to include that extension in its reply.</p>
|
||||
|
||||
<p>The supported names are: <b>status_request</b> and <b>status_request_v2</b>.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> tlsfeature = status_request</code></pre>
|
||||
|
||||
<h1 id="DEPRECATED-EXTENSIONS">DEPRECATED EXTENSIONS</h1>
|
||||
|
||||
<p>The following extensions are non standard, Netscape specific and largely obsolete. Their use in new applications is discouraged.</p>
|
||||
|
||||
<h2 id="Netscape-String-extensions">Netscape String extensions.</h2>
|
||||
|
||||
<p>Netscape Comment (<b>nsComment</b>) is a string extension containing a comment which will be displayed when the certificate is viewed in some browsers.</p>
|
||||
|
||||
<p>Example:</p>
|
||||
|
||||
<pre><code> nsComment = "Some Random Comment"</code></pre>
|
||||
|
||||
<p>Other supported extensions in this category are: <b>nsBaseUrl</b>, <b>nsRevocationUrl</b>, <b>nsCaRevocationUrl</b>, <b>nsRenewalUrl</b>, <b>nsCaPolicyUrl</b> and <b>nsSslServerName</b>.</p>
|
||||
|
||||
<h2 id="Netscape-Certificate-Type">Netscape Certificate Type</h2>
|
||||
|
||||
<p>This is a multi-valued extensions which consists of a list of flags to be included. It was used to indicate the purposes for which a certificate could be used. The basicConstraints, keyUsage and extended key usage extensions are now used instead.</p>
|
||||
|
||||
<p>Acceptable values for nsCertType are: <b>client</b>, <b>server</b>, <b>email</b>, <b>objsign</b>, <b>reserved</b>, <b>sslCA</b>, <b>emailCA</b>, <b>objCA</b>.</p>
|
||||
|
||||
<h1 id="ARBITRARY-EXTENSIONS">ARBITRARY EXTENSIONS</h1>
|
||||
|
||||
<p>If an extension is not supported by the OpenSSL code then it must be encoded using the arbitrary extension format. It is also possible to use the arbitrary format for supported extensions. Extreme care should be taken to ensure that the data is formatted correctly for the given extension type.</p>
|
||||
|
||||
<p>There are two ways to encode arbitrary extensions.</p>
|
||||
|
||||
<p>The first way is to use the word ASN1 followed by the extension content using the same syntax as <a href="../man3/ASN1_generate_nconf.html">ASN1_generate_nconf(3)</a>. For example:</p>
|
||||
|
||||
<pre><code> 1.2.3.4=critical,ASN1:UTF8String:Some random data
|
||||
|
||||
1.2.3.4=ASN1:SEQUENCE:seq_sect
|
||||
|
||||
[seq_sect]
|
||||
|
||||
field1 = UTF8:field1
|
||||
field2 = UTF8:field2</code></pre>
|
||||
|
||||
<p>It is also possible to use the word DER to include the raw encoded data in any extension.</p>
|
||||
|
||||
<pre><code> 1.2.3.4=critical,DER:01:02:03:04
|
||||
1.2.3.4=DER:01020304</code></pre>
|
||||
|
||||
<p>The value following DER is a hex dump of the DER encoding of the extension Any extension can be placed in this form to override the default behaviour. For example:</p>
|
||||
|
||||
<pre><code> basicConstraints=critical,DER:00:01:02:03</code></pre>
|
||||
|
||||
<h1 id="WARNING">WARNING</h1>
|
||||
|
||||
<p>There is no guarantee that a specific implementation will process a given extension. It may therefore be sometimes possible to use certificates for purposes prohibited by their extensions because a specific application does not recognize or honour the values of the relevant extensions.</p>
|
||||
|
||||
<p>The DER and ASN1 options should be used with caution. It is possible to create totally invalid extensions if they are not used carefully.</p>
|
||||
|
||||
<h1 id="NOTES">NOTES</h1>
|
||||
|
||||
<p>If an extension is multi-value and a field value must contain a comma the long form must be used otherwise the comma would be misinterpreted as a field separator. For example:</p>
|
||||
|
||||
<pre><code> subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar</code></pre>
|
||||
|
||||
<p>will produce an error but the equivalent form:</p>
|
||||
|
||||
<pre><code> subjectAltName=@subject_alt_section
|
||||
|
||||
[subject_alt_section]
|
||||
subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar</code></pre>
|
||||
|
||||
<p>is valid.</p>
|
||||
|
||||
<p>Due to the behaviour of the OpenSSL <b>conf</b> library the same field name can only occur once in a section. This means that:</p>
|
||||
|
||||
<pre><code> subjectAltName=@alt_section
|
||||
|
||||
[alt_section]
|
||||
|
||||
email=steve@here
|
||||
email=steve@there</code></pre>
|
||||
|
||||
<p>will only recognize the last value. This can be worked around by using the form:</p>
|
||||
|
||||
<pre><code> [alt_section]
|
||||
|
||||
email.1=steve@here
|
||||
email.2=steve@there</code></pre>
|
||||
|
||||
<h1 id="SEE-ALSO">SEE ALSO</h1>
|
||||
|
||||
<p><a href="../man1/req.html">req(1)</a>, <a href="../man1/ca.html">ca(1)</a>, <a href="../man1/x509.html">x509(1)</a>, <a href="../man3/ASN1_generate_nconf.html">ASN1_generate_nconf(3)</a></p>
|
||||
|
||||
<h1 id="COPYRIGHT">COPYRIGHT</h1>
|
||||
|
||||
<p>Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.</p>
|
||||
|
||||
<p>Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue