772 lines
26 KiB
Plaintext
772 lines
26 KiB
Plaintext
|
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
||
|
|
.\"
|
||
|
|
.\" Standard preamble:
|
||
|
|
.\" ========================================================================
|
||
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
||
|
|
.if t .sp .5v
|
||
|
|
.if n .sp
|
||
|
|
..
|
||
|
|
.de Vb \" Begin verbatim text
|
||
|
|
.ft CW
|
||
|
|
.nf
|
||
|
|
.ne \\$1
|
||
|
|
..
|
||
|
|
.de Ve \" End verbatim text
|
||
|
|
.ft R
|
||
|
|
.fi
|
||
|
|
..
|
||
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
||
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
||
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
||
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
||
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
||
|
|
.\" nothing in troff, for use with C<>.
|
||
|
|
.tr \(*W-
|
||
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
||
|
|
.ie n \{\
|
||
|
|
. ds -- \(*W-
|
||
|
|
. ds PI pi
|
||
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
||
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
||
|
|
. ds L" ""
|
||
|
|
. ds R" ""
|
||
|
|
. ds C` ""
|
||
|
|
. ds C' ""
|
||
|
|
'br\}
|
||
|
|
.el\{\
|
||
|
|
. ds -- \|\(em\|
|
||
|
|
. ds PI \(*p
|
||
|
|
. ds L" ``
|
||
|
|
. ds R" ''
|
||
|
|
. ds C`
|
||
|
|
. ds C'
|
||
|
|
'br\}
|
||
|
|
.\"
|
||
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\"
|
||
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
|
.\" output yourself in some meaningful fashion.
|
||
|
|
.\"
|
||
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
||
|
|
.de IX
|
||
|
|
..
|
||
|
|
.nr rF 0
|
||
|
|
.if \n(.g .if rF .nr rF 1
|
||
|
|
.if (\n(rF:(\n(.g==0)) \{
|
||
|
|
. if \nF \{
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. if !\nF==2 \{
|
||
|
|
. nr % 0
|
||
|
|
. nr F 2
|
||
|
|
. \}
|
||
|
|
. \}
|
||
|
|
.\}
|
||
|
|
.rr rF
|
||
|
|
.\"
|
||
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
||
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
||
|
|
. \" fudge factors for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds #H 0
|
||
|
|
. ds #V .8m
|
||
|
|
. ds #F .3m
|
||
|
|
. ds #[ \f1
|
||
|
|
. ds #] \fP
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
||
|
|
. ds #V .6m
|
||
|
|
. ds #F 0
|
||
|
|
. ds #[ \&
|
||
|
|
. ds #] \&
|
||
|
|
.\}
|
||
|
|
. \" simple accents for nroff and troff
|
||
|
|
.if n \{\
|
||
|
|
. ds ' \&
|
||
|
|
. ds ` \&
|
||
|
|
. ds ^ \&
|
||
|
|
. ds , \&
|
||
|
|
. ds ~ ~
|
||
|
|
. ds /
|
||
|
|
.\}
|
||
|
|
.if t \{\
|
||
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
||
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
||
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
||
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
||
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
||
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
||
|
|
.\}
|
||
|
|
. \" troff and (daisy-wheel) nroff accents
|
||
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
||
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
||
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
||
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
||
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
||
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
||
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
||
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
||
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
||
|
|
. \" corrections for vroff
|
||
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
||
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
||
|
|
. \" for low resolution devices (crt and lpr)
|
||
|
|
.if \n(.H>23 .if \n(.V>19 \
|
||
|
|
\{\
|
||
|
|
. ds : e
|
||
|
|
. ds 8 ss
|
||
|
|
. ds o a
|
||
|
|
. ds d- d\h'-1'\(ga
|
||
|
|
. ds D- D\h'-1'\(hy
|
||
|
|
. ds th \o'bp'
|
||
|
|
. ds Th \o'LP'
|
||
|
|
. ds ae ae
|
||
|
|
. ds Ae AE
|
||
|
|
.\}
|
||
|
|
.rm #[ #] #H #V #F C
|
||
|
|
.\" ========================================================================
|
||
|
|
.\"
|
||
|
|
.IX Title "X509V3_CONFIG 5ossl"
|
||
|
|
.TH X509V3_CONFIG 5ossl "2024-01-30" "3.2.1" "OpenSSL"
|
||
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
|
.\" way too many mistakes in technical documents.
|
||
|
|
.if n .ad l
|
||
|
|
.nh
|
||
|
|
.SH "NAME"
|
||
|
|
x509v3_config \- X509 V3 certificate extension configuration format
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
Several OpenSSL commands can add extensions to a certificate or
|
||
|
|
certificate request based on the contents of a configuration file
|
||
|
|
and \s-1CLI\s0 options such as \fB\-addext\fR.
|
||
|
|
The syntax of configuration files is described in \fIconfig\fR\|(5).
|
||
|
|
The commands typically have an option to specify the name of the configuration
|
||
|
|
file, and a section within that file; see the documentation of the
|
||
|
|
individual command for details.
|
||
|
|
.PP
|
||
|
|
This page uses \fBextensions\fR as the name of the section, when needed
|
||
|
|
in examples.
|
||
|
|
.PP
|
||
|
|
Each entry in the extension section takes the form:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& name = [critical, ]value(s)
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
If \fBcritical\fR is present then the extension will be marked as critical.
|
||
|
|
.PP
|
||
|
|
If multiple entries are processed for the same extension name,
|
||
|
|
later entries override earlier ones with the same name.
|
||
|
|
.PP
|
||
|
|
The format of \fBvalues\fR depends on the value of \fBname\fR, many have a
|
||
|
|
type-value pairing where the type and value are separated by a colon.
|
||
|
|
There are four main types of extension:
|
||
|
|
.PP
|
||
|
|
.Vb 4
|
||
|
|
\& string
|
||
|
|
\& multi\-valued
|
||
|
|
\& raw
|
||
|
|
\& arbitrary
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Each is described in the following paragraphs.
|
||
|
|
.PP
|
||
|
|
String extensions simply have a string which contains either the value itself
|
||
|
|
or how it is obtained.
|
||
|
|
.PP
|
||
|
|
Multi-valued extensions have a short form and a long form. The short form
|
||
|
|
is a comma-separated list of names and values:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& basicConstraints = critical, CA:true, pathlen:1
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
The long form allows the values to be placed in a separate section:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& basicConstraints = critical, @basic_constraints
|
||
|
|
\&
|
||
|
|
\& [basic_constraints]
|
||
|
|
\& CA = true
|
||
|
|
\& pathlen = 1
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Both forms are equivalent.
|
||
|
|
.PP
|
||
|
|
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:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& subjectAltName = URI:ldap://somehost.com/CN=foo,OU=bar
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
will produce an error but the equivalent form:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& subjectAltName = @subject_alt_section
|
||
|
|
\&
|
||
|
|
\& [subject_alt_section]
|
||
|
|
\& subjectAltName = URI:ldap://somehost.com/CN=foo,OU=bar
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
is valid.
|
||
|
|
.PP
|
||
|
|
OpenSSL does not support multiple occurrences of the same field within a
|
||
|
|
section. In this example:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& subjectAltName = @alt_section
|
||
|
|
\&
|
||
|
|
\& [alt_section]
|
||
|
|
\& email = steve@example.com
|
||
|
|
\& email = steve@example.org
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
will only recognize the last value. To specify multiple values append a
|
||
|
|
numeric identifier, as shown here:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& subjectAltName = @alt_section
|
||
|
|
\&
|
||
|
|
\& [alt_section]
|
||
|
|
\& email.1 = steve@example.com
|
||
|
|
\& email.2 = steve@example.org
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
The syntax of raw extensions is defined by the source code that parses
|
||
|
|
the extension but should be documented.
|
||
|
|
See \*(L"Certificate Policies\*(R" for an example of a raw extension.
|
||
|
|
.PP
|
||
|
|
If an extension type is unsupported, then the \fIarbitrary\fR extension syntax
|
||
|
|
must be used, see the \*(L"\s-1ARBITRARY EXTENSIONS\*(R"\s0 section for more details.
|
||
|
|
.SH "STANDARD EXTENSIONS"
|
||
|
|
.IX Header "STANDARD EXTENSIONS"
|
||
|
|
The following sections describe the syntax of each supported extension.
|
||
|
|
They do not define the semantics of the extension.
|
||
|
|
.SS "Basic Constraints"
|
||
|
|
.IX Subsection "Basic Constraints"
|
||
|
|
This is a multi-valued extension which indicates whether a certificate is
|
||
|
|
a \s-1CA\s0 certificate. The first value is \fB\s-1CA\s0\fR followed by \fB\s-1TRUE\s0\fR or
|
||
|
|
\&\fB\s-1FALSE\s0\fR. If \fB\s-1CA\s0\fR is \fB\s-1TRUE\s0\fR then an optional \fBpathlen\fR name followed by a
|
||
|
|
nonnegative value can be included.
|
||
|
|
.PP
|
||
|
|
For example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& basicConstraints = CA:TRUE
|
||
|
|
\&
|
||
|
|
\& basicConstraints = CA:FALSE
|
||
|
|
\&
|
||
|
|
\& basicConstraints = critical, CA:TRUE, pathlen:1
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
A \s-1CA\s0 certificate \fImust\fR include the \fBbasicConstraints\fR name with the \fB\s-1CA\s0\fR
|
||
|
|
parameter set to \fB\s-1TRUE\s0\fR. An end-user certificate must either have \fB\s-1CA:FALSE\s0\fR
|
||
|
|
or omit the extension entirely.
|
||
|
|
The \fBpathlen\fR parameter specifies the maximum number of CAs that can appear
|
||
|
|
below this one in a chain. A \fBpathlen\fR of zero means the \s-1CA\s0 cannot sign
|
||
|
|
any sub-CA's, and can only sign end-entity certificates.
|
||
|
|
.SS "Key Usage"
|
||
|
|
.IX Subsection "Key Usage"
|
||
|
|
Key usage is a multi-valued extension consisting of a list of names of
|
||
|
|
the permitted key usages. The defined values are: \f(CW\*(C`digitalSignature\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`nonRepudiation\*(C'\fR, \f(CW\*(C`keyEncipherment\*(C'\fR, \f(CW\*(C`dataEncipherment\*(C'\fR, \f(CW\*(C`keyAgreement\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`keyCertSign\*(C'\fR, \f(CW\*(C`cRLSign\*(C'\fR, \f(CW\*(C`encipherOnly\*(C'\fR, and \f(CW\*(C`decipherOnly\*(C'\fR.
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& keyUsage = digitalSignature, nonRepudiation
|
||
|
|
\&
|
||
|
|
\& keyUsage = critical, keyCertSign
|
||
|
|
.Ve
|
||
|
|
.SS "Extended Key Usage"
|
||
|
|
.IX Subsection "Extended Key Usage"
|
||
|
|
This extension consists of a list of values indicating purposes for which
|
||
|
|
the certificate public key can be used.
|
||
|
|
Each value can be either a short text name or an \s-1OID.\s0
|
||
|
|
The following text names, and their intended meaning, are known:
|
||
|
|
.PP
|
||
|
|
.Vb 10
|
||
|
|
\& Value Meaning according to RFC 5280 etc.
|
||
|
|
\& \-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
||
|
|
\& serverAuth SSL/TLS WWW Server Authentication
|
||
|
|
\& clientAuth SSL/TLS WWW 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
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
While \s-1IETF RFC 5280\s0 says that \fBid-kp-serverAuth\fR and \fBid-kp-clientAuth\fR
|
||
|
|
are only for \s-1WWW\s0 use, in practice they are used for all kinds of \s-1TLS\s0 clients
|
||
|
|
and servers, and this is what OpenSSL assumes as well.
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& extendedKeyUsage = critical, codeSigning, 1.2.3.4
|
||
|
|
\&
|
||
|
|
\& extendedKeyUsage = serverAuth, clientAuth
|
||
|
|
.Ve
|
||
|
|
.SS "Subject Key Identifier"
|
||
|
|
.IX Subsection "Subject Key Identifier"
|
||
|
|
The \s-1SKID\s0 extension specification has a value with three choices.
|
||
|
|
.IP "\fBnone\fR" 4
|
||
|
|
.IX Item "none"
|
||
|
|
No \s-1SKID\s0 extension will be included.
|
||
|
|
.IP "\fBhash\fR" 4
|
||
|
|
.IX Item "hash"
|
||
|
|
The process specified in \s-1RFC 5280\s0 section 4.2.1.2. (1) is followed:
|
||
|
|
The keyIdentifier is composed of the 160\-bit \s-1SHA\-1\s0 hash of the value of the \s-1BIT
|
||
|
|
STRING\s0 subjectPublicKey (excluding the tag, length, and number of unused bits).
|
||
|
|
.ie n .IP "A hex string (possibly with "":"" separating bytes)" 4
|
||
|
|
.el .IP "A hex string (possibly with \f(CW:\fR separating bytes)" 4
|
||
|
|
.IX Item "A hex string (possibly with : separating bytes)"
|
||
|
|
The provided value is output directly.
|
||
|
|
This choice is strongly discouraged.
|
||
|
|
.PP
|
||
|
|
By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBhash\fR was given.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& subjectKeyIdentifier = hash
|
||
|
|
.Ve
|
||
|
|
.SS "Authority Key Identifier"
|
||
|
|
.IX Subsection "Authority Key Identifier"
|
||
|
|
The \s-1AKID\s0 extension specification may have the value \fBnone\fR
|
||
|
|
indicating that no \s-1AKID\s0 shall be included.
|
||
|
|
Otherwise it may have the value \fBkeyid\fR or \fBissuer\fR
|
||
|
|
or both of them, separated by \f(CW\*(C`,\*(C'\fR.
|
||
|
|
Either or both can have the option \fBalways\fR,
|
||
|
|
indicated by putting a colon \f(CW\*(C`:\*(C'\fR between the value and this option.
|
||
|
|
For self-signed certificates the \s-1AKID\s0 is suppressed unless \fBalways\fR is present.
|
||
|
|
.PP
|
||
|
|
By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBnone\fR was given
|
||
|
|
for self-signed certificates and \fBkeyid\fR\f(CW\*(C`,\*(C'\fR \fBissuer\fR otherwise.
|
||
|
|
.PP
|
||
|
|
If \fBkeyid\fR is present, an attempt is made to
|
||
|
|
copy the subject key identifier (\s-1SKID\s0) from the issuer certificate except if
|
||
|
|
the issuer certificate is the same as the current one and it is not self-signed.
|
||
|
|
The hash of the public key related to the signing key is taken as fallback
|
||
|
|
if the issuer certificate is the same as the current certificate.
|
||
|
|
If \fBalways\fR is present but no value can be obtained, an error is returned.
|
||
|
|
.PP
|
||
|
|
If \fBissuer\fR is present, and in addition it has the option \fBalways\fR specified
|
||
|
|
or \fBkeyid\fR is not present,
|
||
|
|
then the issuer \s-1DN\s0 and serial number are copied from the issuer certificate.
|
||
|
|
If this fails, an error is returned.
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& authorityKeyIdentifier = keyid, issuer
|
||
|
|
\&
|
||
|
|
\& authorityKeyIdentifier = keyid, issuer:always
|
||
|
|
.Ve
|
||
|
|
.SS "Subject Alternative Name"
|
||
|
|
.IX Subsection "Subject Alternative Name"
|
||
|
|
This is a multi-valued extension that supports several types of name
|
||
|
|
identifier, including
|
||
|
|
\&\fBemail\fR (an email address),
|
||
|
|
\&\fB\s-1URI\s0\fR (a uniform resource indicator),
|
||
|
|
\&\fB\s-1DNS\s0\fR (a \s-1DNS\s0 domain name),
|
||
|
|
\&\fB\s-1RID\s0\fR (a registered \s-1ID: OBJECT IDENTIFIER\s0),
|
||
|
|
\&\fB\s-1IP\s0\fR (an \s-1IP\s0 address),
|
||
|
|
\&\fBdirName\fR (a distinguished name),
|
||
|
|
and \fBotherName\fR.
|
||
|
|
The syntax of each is described in the following paragraphs.
|
||
|
|
.PP
|
||
|
|
The \fBemail\fR option has two special values.
|
||
|
|
\&\f(CW\*(C`copy\*(C'\fR will automatically include any email addresses
|
||
|
|
contained in the certificate subject name in the extension.
|
||
|
|
\&\f(CW\*(C`move\*(C'\fR will automatically move any email addresses
|
||
|
|
from the certificate subject name to the extension.
|
||
|
|
.PP
|
||
|
|
The \s-1IP\s0 address used in the \fB\s-1IP\s0\fR option can be in either IPv4 or IPv6 format.
|
||
|
|
.PP
|
||
|
|
The value of \fBdirName\fR is specifies the configuration section containing
|
||
|
|
the distinguished name to use, as a set of name-value pairs.
|
||
|
|
Multi-valued AVAs can be formed by prefacing the name with a \fB+\fR character.
|
||
|
|
.PP
|
||
|
|
The value of \fBotherName\fR can include arbitrary data associated with an \s-1OID\s0;
|
||
|
|
the value should be the \s-1OID\s0 followed by a semicolon and the content in specified
|
||
|
|
using the syntax in \fIASN1_generate_nconf\fR\|(3).
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& subjectAltName = email:copy, email:my@example.com, URI:http://my.example.com/
|
||
|
|
\&
|
||
|
|
\& subjectAltName = IP:192.168.7.1
|
||
|
|
\&
|
||
|
|
\& subjectAltName = IP:13::17
|
||
|
|
\&
|
||
|
|
\& subjectAltName = email:my@example.com, RID:1.2.3.4
|
||
|
|
\&
|
||
|
|
\& subjectAltName = otherName:1.2.3.4;UTF8:some other identifier
|
||
|
|
\&
|
||
|
|
\& [extensions]
|
||
|
|
\& subjectAltName = dirName:dir_sect
|
||
|
|
\&
|
||
|
|
\& [dir_sect]
|
||
|
|
\& C = UK
|
||
|
|
\& O = My Organization
|
||
|
|
\& OU = My Unit
|
||
|
|
\& CN = My Name
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Non-ASCII Email Address conforming the syntax defined in Section 3.3 of \s-1RFC 6531\s0
|
||
|
|
are provided as otherName.SmtpUTF8Mailbox. According to \s-1RFC 8398,\s0 the email
|
||
|
|
address should be provided as UTF8String. To enforce the valid representation in
|
||
|
|
the certificate, the SmtpUTF8Mailbox should be provided as follows
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& subjectAltName=@alts
|
||
|
|
\& [alts]
|
||
|
|
\& otherName = 1.3.6.1.5.5.7.8.9;FORMAT:UTF8,UTF8String:nonasciiname.example.com
|
||
|
|
.Ve
|
||
|
|
.SS "Issuer Alternative Name"
|
||
|
|
.IX Subsection "Issuer Alternative Name"
|
||
|
|
This extension supports most of the options of subject alternative name;
|
||
|
|
it does not support \fBemail:copy\fR.
|
||
|
|
It also adds \fBissuer:copy\fR as an allowed value, which copies any subject
|
||
|
|
alternative names from the issuer certificate, if possible.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& issuerAltName = issuer:copy
|
||
|
|
.Ve
|
||
|
|
.SS "Authority Info Access"
|
||
|
|
.IX Subsection "Authority Info Access"
|
||
|
|
This extension gives details about how to retrieve information that
|
||
|
|
related to the certificate that the \s-1CA\s0 makes available. The syntax is
|
||
|
|
\&\fBaccess_id;location\fR, where \fBaccess_id\fR is an object identifier
|
||
|
|
(although only a few values are well-known) and \fBlocation\fR has the same
|
||
|
|
syntax as subject alternative name (except that \fBemail:copy\fR is not supported).
|
||
|
|
.PP
|
||
|
|
Possible values for access_id include \fB\s-1OCSP\s0\fR (\s-1OCSP\s0 responder),
|
||
|
|
\&\fBcaIssuers\fR (\s-1CA\s0 Issuers),
|
||
|
|
\&\fBad_timestamping\fR (\s-1AD\s0 Time Stamping),
|
||
|
|
\&\fB\s-1AD_DVCS\s0\fR (ad dvcs),
|
||
|
|
\&\fBcaRepository\fR (\s-1CA\s0 Repository).
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& authorityInfoAccess = OCSP;URI:http://ocsp.example.com/,caIssuers;URI:http://myca.example.com/ca.cer
|
||
|
|
\&
|
||
|
|
\& authorityInfoAccess = OCSP;URI:http://ocsp.example.com/
|
||
|
|
.Ve
|
||
|
|
.SS "\s-1CRL\s0 distribution points"
|
||
|
|
.IX Subsection "CRL distribution points"
|
||
|
|
This is a multi-valued extension whose values can be either a name-value
|
||
|
|
pair using the same form as subject alternative name or a single value
|
||
|
|
specifying the section name containing all the distribution point values.
|
||
|
|
.PP
|
||
|
|
When a name-value pair is used, a DistributionPoint extension will
|
||
|
|
be set with the given value as the fullName field as the distributionPoint
|
||
|
|
value, and the reasons and cRLIssuer fields will be omitted.
|
||
|
|
.PP
|
||
|
|
When a single option is used, the value specifies the section, and that
|
||
|
|
section can have the following items:
|
||
|
|
.IP "fullname" 4
|
||
|
|
.IX Item "fullname"
|
||
|
|
The full name of the distribution point, in the same format as the subject
|
||
|
|
alternative name.
|
||
|
|
.IP "relativename" 4
|
||
|
|
.IX Item "relativename"
|
||
|
|
The value is taken as a distinguished name fragment that is set as the
|
||
|
|
value of the nameRelativeToCRLIssuer field.
|
||
|
|
.IP "CRLIssuer" 4
|
||
|
|
.IX Item "CRLIssuer"
|
||
|
|
The value must in the same format as the subject alternative name.
|
||
|
|
.IP "reasons" 4
|
||
|
|
.IX Item "reasons"
|
||
|
|
A multi-value field that contains the reasons for revocation. The recognized
|
||
|
|
values are: \f(CW\*(C`keyCompromise\*(C'\fR, \f(CW\*(C`CACompromise\*(C'\fR, \f(CW\*(C`affiliationChanged\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`superseded\*(C'\fR, \f(CW\*(C`cessationOfOperation\*(C'\fR, \f(CW\*(C`certificateHold\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`privilegeWithdrawn\*(C'\fR, and \f(CW\*(C`AACompromise\*(C'\fR.
|
||
|
|
.PP
|
||
|
|
Only one of \fBfullname\fR or \fBrelativename\fR should be specified.
|
||
|
|
.PP
|
||
|
|
Simple examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& crlDistributionPoints = URI:http://example.com/myca.crl
|
||
|
|
\&
|
||
|
|
\& crlDistributionPoints = URI:http://example.com/myca.crl, URI:http://example.org/my.crl
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Full distribution point example:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& crlDistributionPoints = crldp1_section
|
||
|
|
\&
|
||
|
|
\& [crldp1_section]
|
||
|
|
\& fullname = URI:http://example.com/myca.crl
|
||
|
|
\& CRLissuer = dirName:issuer_sect
|
||
|
|
\& reasons = keyCompromise, CACompromise
|
||
|
|
\&
|
||
|
|
\& [issuer_sect]
|
||
|
|
\& C = UK
|
||
|
|
\& O = Organisation
|
||
|
|
\& CN = Some Name
|
||
|
|
.Ve
|
||
|
|
.SS "Issuing Distribution Point"
|
||
|
|
.IX Subsection "Issuing Distribution Point"
|
||
|
|
This extension should only appear in CRLs. It is a multi-valued extension
|
||
|
|
whose syntax is similar to the \*(L"section\*(R" pointed to by the \s-1CRL\s0 distribution
|
||
|
|
points extension. The following names have meaning:
|
||
|
|
.IP "fullname" 4
|
||
|
|
.IX Item "fullname"
|
||
|
|
The full name of the distribution point, in the same format as the subject
|
||
|
|
alternative name.
|
||
|
|
.IP "relativename" 4
|
||
|
|
.IX Item "relativename"
|
||
|
|
The value is taken as a distinguished name fragment that is set as the
|
||
|
|
value of the nameRelativeToCRLIssuer field.
|
||
|
|
.IP "onlysomereasons" 4
|
||
|
|
.IX Item "onlysomereasons"
|
||
|
|
A multi-value field that contains the reasons for revocation. The recognized
|
||
|
|
values are: \f(CW\*(C`keyCompromise\*(C'\fR, \f(CW\*(C`CACompromise\*(C'\fR, \f(CW\*(C`affiliationChanged\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`superseded\*(C'\fR, \f(CW\*(C`cessationOfOperation\*(C'\fR, \f(CW\*(C`certificateHold\*(C'\fR,
|
||
|
|
\&\f(CW\*(C`privilegeWithdrawn\*(C'\fR, and \f(CW\*(C`AACompromise\*(C'\fR.
|
||
|
|
.IP "onlyuser, onlyCA, onlyAA, indirectCRL" 4
|
||
|
|
.IX Item "onlyuser, onlyCA, onlyAA, indirectCRL"
|
||
|
|
The value for each of these names is a boolean.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& issuingDistributionPoint = critical, @idp_section
|
||
|
|
\&
|
||
|
|
\& [idp_section]
|
||
|
|
\& fullname = URI:http://example.com/myca.crl
|
||
|
|
\& indirectCRL = TRUE
|
||
|
|
\& onlysomereasons = keyCompromise, CACompromise
|
||
|
|
.Ve
|
||
|
|
.SS "Certificate Policies"
|
||
|
|
.IX Subsection "Certificate Policies"
|
||
|
|
This is a \fIraw\fR extension that supports all of the defined fields of the
|
||
|
|
certificate extension.
|
||
|
|
.PP
|
||
|
|
Policies without qualifiers are specified by giving the \s-1OID.\s0
|
||
|
|
Multiple policies are comma-separated. For example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& certificatePolicies = 1.2.4.5, 1.1.3.4
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
To include policy qualifiers, use the \*(L"@section\*(R" syntax to point to a
|
||
|
|
section that specifies all the information.
|
||
|
|
.PP
|
||
|
|
The section referred to must include the policy \s-1OID\s0 using the name
|
||
|
|
\&\fBpolicyIdentifier\fR. cPSuri qualifiers can be included using the syntax:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& CPS.nnn = value
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
where \f(CW\*(C`nnn\*(C'\fR is a number.
|
||
|
|
.PP
|
||
|
|
userNotice qualifiers can be set using the syntax:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& userNotice.nnn = @notice
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
The value of the userNotice qualifier is specified in the relevant section.
|
||
|
|
This section can include \fBexplicitText\fR, \fBorganization\fR, and \fBnoticeNumbers\fR
|
||
|
|
options. explicitText and organization are text strings, noticeNumbers is a
|
||
|
|
comma separated list of numbers. The organization and noticeNumbers options
|
||
|
|
(if included) must \s-1BOTH\s0 be present. Some software might require
|
||
|
|
the \fBia5org\fR option at the top level; this changes the encoding from
|
||
|
|
Displaytext to IA5String.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [extensions]
|
||
|
|
\& certificatePolicies = ia5org, 1.2.3.4, 1.5.6.7.8, @polsect
|
||
|
|
\&
|
||
|
|
\& [polsect]
|
||
|
|
\& policyIdentifier = 1.3.5.8
|
||
|
|
\& CPS.1 = "http://my.host.example.com/"
|
||
|
|
\& CPS.2 = "http://my.your.example.com/"
|
||
|
|
\& userNotice.1 = @notice
|
||
|
|
\&
|
||
|
|
\& [notice]
|
||
|
|
\& explicitText = "Explicit Text Here"
|
||
|
|
\& organization = "Organisation Name"
|
||
|
|
\& noticeNumbers = 1, 2, 3, 4
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
The character encoding of explicitText can be specified by prefixing the
|
||
|
|
value with \fB\s-1UTF8\s0\fR, \fB\s-1BMP\s0\fR, or \fB\s-1VISIBLE\s0\fR followed by colon. For example:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& [notice]
|
||
|
|
\& explicitText = "UTF8:Explicit Text Here"
|
||
|
|
.Ve
|
||
|
|
.SS "Policy Constraints"
|
||
|
|
.IX Subsection "Policy Constraints"
|
||
|
|
This is a multi-valued extension which consisting of the names
|
||
|
|
\&\fBrequireExplicitPolicy\fR or \fBinhibitPolicyMapping\fR and a non negative integer
|
||
|
|
value. At least one component must be present.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& policyConstraints = requireExplicitPolicy:3
|
||
|
|
.Ve
|
||
|
|
.SS "Inhibit Any Policy"
|
||
|
|
.IX Subsection "Inhibit Any Policy"
|
||
|
|
This is a string extension whose value must be a non negative integer.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& inhibitAnyPolicy = 2
|
||
|
|
.Ve
|
||
|
|
.SS "Name Constraints"
|
||
|
|
.IX Subsection "Name Constraints"
|
||
|
|
This is a multi-valued extension. The name should
|
||
|
|
begin with the word \fBpermitted\fR or \fBexcluded\fR followed by a \fB;\fR. The rest of
|
||
|
|
the name and the value follows the syntax of subjectAltName except
|
||
|
|
\&\fBemail:copy\fR
|
||
|
|
is not supported and the \fB\s-1IP\s0\fR form should consist of an \s-1IP\s0 addresses and
|
||
|
|
subnet mask separated by a \fB/\fR.
|
||
|
|
.PP
|
||
|
|
Examples:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& nameConstraints = permitted;IP:192.168.0.0/255.255.0.0
|
||
|
|
\&
|
||
|
|
\& nameConstraints = permitted;email:.example.com
|
||
|
|
\&
|
||
|
|
\& nameConstraints = excluded;email:.com
|
||
|
|
.Ve
|
||
|
|
.SS "\s-1OCSP\s0 No Check"
|
||
|
|
.IX Subsection "OCSP No Check"
|
||
|
|
This is a string extension. It is parsed, but ignored.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& noCheck = ignored
|
||
|
|
.Ve
|
||
|
|
.SS "\s-1TLS\s0 Feature (aka Must Staple)"
|
||
|
|
.IX Subsection "TLS Feature (aka Must Staple)"
|
||
|
|
This is a multi-valued extension consisting of a list of \s-1TLS\s0 extension
|
||
|
|
identifiers. Each identifier may be a number (0..65535) or a supported name.
|
||
|
|
When a \s-1TLS\s0 client sends a listed extension, the \s-1TLS\s0 server is expected to
|
||
|
|
include that extension in its reply.
|
||
|
|
.PP
|
||
|
|
The supported names are: \fBstatus_request\fR and \fBstatus_request_v2\fR.
|
||
|
|
.PP
|
||
|
|
Example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& tlsfeature = status_request
|
||
|
|
.Ve
|
||
|
|
.SH "DEPRECATED EXTENSIONS"
|
||
|
|
.IX Header "DEPRECATED EXTENSIONS"
|
||
|
|
The following extensions are non standard, Netscape specific and largely
|
||
|
|
obsolete. Their use in new applications is discouraged.
|
||
|
|
.SS "Netscape String extensions"
|
||
|
|
.IX Subsection "Netscape String extensions"
|
||
|
|
Netscape Comment (\fBnsComment\fR) is a string extension containing a comment
|
||
|
|
which will be displayed when the certificate is viewed in some browsers.
|
||
|
|
Other extensions of this type are: \fBnsBaseUrl\fR,
|
||
|
|
\&\fBnsRevocationUrl\fR, \fBnsCaRevocationUrl\fR, \fBnsRenewalUrl\fR, \fBnsCaPolicyUrl\fR
|
||
|
|
and \fBnsSslServerName\fR.
|
||
|
|
.SS "Netscape Certificate Type"
|
||
|
|
.IX Subsection "Netscape Certificate Type"
|
||
|
|
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.
|
||
|
|
.PP
|
||
|
|
Acceptable values for nsCertType are: \fBclient\fR, \fBserver\fR, \fBemail\fR,
|
||
|
|
\&\fBobjsign\fR, \fBreserved\fR, \fBsslCA\fR, \fBemailCA\fR, \fBobjCA\fR.
|
||
|
|
.SH "ARBITRARY EXTENSIONS"
|
||
|
|
.IX Header "ARBITRARY EXTENSIONS"
|
||
|
|
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.
|
||
|
|
.PP
|
||
|
|
There are two ways to encode arbitrary extensions.
|
||
|
|
.PP
|
||
|
|
The first way is to use the word \s-1ASN1\s0 followed by the extension content
|
||
|
|
using the same syntax as \fIASN1_generate_nconf\fR\|(3).
|
||
|
|
For example:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& [extensions]
|
||
|
|
\& 1.2.3.4 = critical, ASN1:UTF8String:Some random data
|
||
|
|
\& 1.2.3.4.1 = ASN1:SEQUENCE:seq_sect
|
||
|
|
\&
|
||
|
|
\& [seq_sect]
|
||
|
|
\& field1 = UTF8:field1
|
||
|
|
\& field2 = UTF8:field2
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any
|
||
|
|
extension.
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& 1.2.3.4 = critical, DER:01:02:03:04
|
||
|
|
\& 1.2.3.4.1 = DER:01020304
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
The value following \s-1DER\s0 is a hex dump of the \s-1DER\s0 encoding of the extension
|
||
|
|
Any extension can be placed in this form to override the default behaviour.
|
||
|
|
For example:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& basicConstraints = critical, DER:00:01:02:03
|
||
|
|
.Ve
|
||
|
|
.SH "WARNINGS"
|
||
|
|
.IX Header "WARNINGS"
|
||
|
|
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.
|
||
|
|
.PP
|
||
|
|
The \s-1DER\s0 and \s-1ASN1\s0 options should be used with caution. It is possible to create
|
||
|
|
invalid extensions if they are not used carefully.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIopenssl\-req\fR\|(1), \fIopenssl\-ca\fR\|(1), \fIopenssl\-x509\fR\|(1),
|
||
|
|
\&\fIASN1_generate_nconf\fR\|(3)
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2004\-2023 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
|
.PP
|
||
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
|
this file except in compliance with the License. You can obtain a copy
|
||
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
|
<https://www.openssl.org/source/license.html>.
|