diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man5/x509v3_config.5')
| -rw-r--r-- | secure/lib/libcrypto/man/man5/x509v3_config.5 | 235 |
1 files changed, 84 insertions, 151 deletions
diff --git a/secure/lib/libcrypto/man/man5/x509v3_config.5 b/secure/lib/libcrypto/man/man5/x509v3_config.5 index 374dd11e34ff..f0ae1fbb3564 100644 --- a/secure/lib/libcrypto/man/man5/x509v3_config.5 +++ b/secure/lib/libcrypto/man/man5/x509v3_config.5 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,81 +52,21 @@ . \} .\} .rr rF -.\" 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 "2023-09-19" "3.0.11" "OpenSSL" +.TH X509V3_CONFIG 5ossl 2025-07-01 3.5.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" +.SH NAME x509v3_config \- X509 V3 certificate extension configuration format -.SH "DESCRIPTION" +.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. +and CLI options such as \fB\-addext\fR. The syntax of configuration files is described in \fBconfig\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 @@ -244,10 +168,10 @@ numeric identifier, as shown here: .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. +See "Certificate Policies" 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. +must be used, see the "ARBITRARY EXTENSIONS" section for more details. .SH "STANDARD EXTENSIONS" .IX Header "STANDARD EXTENSIONS" The following sections describe the syntax of each supported extension. @@ -255,8 +179,8 @@ 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 +a CA certificate. The first value is \fBCA\fR followed by \fBTRUE\fR or +\&\fBFALSE\fR. If \fBCA\fR is \fBTRUE\fR then an optional \fBpathlen\fR name followed by a nonnegative value can be included. .PP For example: @@ -269,11 +193,11 @@ For example: \& 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 +A CA certificate \fImust\fR include the \fBbasicConstraints\fR name with the \fBCA\fR +parameter set to \fBTRUE\fR. An end-user certificate must either have \fBCA:FALSE\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 +below this one in a chain. A \fBpathlen\fR of zero means the CA cannot sign any sub-CA's, and can only sign end-entity certificates. .SS "Key Usage" .IX Subsection "Key Usage" @@ -293,7 +217,7 @@ Examples: .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 +Each value can be either a short text name or an OID. The following text names, and their intended meaning, are known: .PP .Vb 10 @@ -312,8 +236,8 @@ The following text names, and their intended meaning, are known: \& 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 +While IETF RFC 5280 says that \fBid-kp-serverAuth\fR and \fBid-kp-clientAuth\fR +are only for WWW use, in practice they are used for all kinds of TLS clients and servers, and this is what OpenSSL assumes as well. .PP Examples: @@ -325,15 +249,22 @@ Examples: .Ve .SS "Subject Key Identifier" .IX Subsection "Subject Key Identifier" -The \s-1SKID\s0 extension specification has a value with three choices. -If the value is the word \fBnone\fR then no \s-1SKID\s0 extension will be included. -If the value is the word \fBhash\fR, or by default for the \fBx509\fR, \fBreq\fR, and -\&\fBca\fR apps, 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). -.PP -Otherwise, the value must be a hex string (possibly with \f(CW\*(C`:\*(C'\fR separating bytes) -to output directly, however, this is strongly discouraged. +The SKID extension specification has a value with three choices. +.IP \fBnone\fR 4 +.IX Item "none" +No SKID extension will be included. +.IP \fBhash\fR 4 +.IX Item "hash" +The process specified in RFC 5280 section 4.2.1.2. (1) is followed: +The keyIdentifier is composed of the 160\-bit SHA\-1 hash of the value of the BIT +STRING 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 @@ -342,18 +273,19 @@ Example: .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. +The AKID extension specification may have the value \fBnone\fR +indicating that no AKID 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. -By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if -\&\*(L"none\*(R" was given for self-signed certificates and \*(L"keyid, issuer\*(R" otherwise. +For self-signed certificates the AKID 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 +copy the subject key identifier (SKID) 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. @@ -361,7 +293,8 @@ 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. +then the issuer DN and serial number are copied from the issuer certificate. +If this fails, an error is returned. .PP Examples: .PP @@ -375,10 +308,10 @@ Examples: 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), +\&\fBURI\fR (a uniform resource indicator), +\&\fBDNS\fR (a DNS domain name), +\&\fBRID\fR (a registered ID: OBJECT IDENTIFIER), +\&\fBIP\fR (an IP address), \&\fBdirName\fR (a distinguished name), and \fBotherName\fR. The syntax of each is described in the following paragraphs. @@ -389,14 +322,14 @@ 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. +The IP address used in the \fBIP\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 +The value of \fBotherName\fR can include arbitrary data associated with an OID; +the value should be the OID followed by a semicolon and the content in specified using the syntax in \fBASN1_generate_nconf\fR\|(3). .PP Examples: @@ -422,8 +355,8 @@ Examples: \& 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 +Non-ASCII Email Address conforming the syntax defined in Section 3.3 of RFC 6531 +are provided as otherName.SmtpUTF8Mailbox. According to RFC 8398, the email address should be provided as UTF8String. To enforce the valid representation in the certificate, the SmtpUTF8Mailbox should be provided as follows .PP @@ -447,16 +380,16 @@ Example: .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 +related to the certificate that the CA 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). +Possible values for access_id include \fBOCSP\fR (OCSP responder), +\&\fBcaIssuers\fR (CA Issuers), +\&\fBad_timestamping\fR (AD Time Stamping), +\&\fBAD_DVCS\fR (ad dvcs), +\&\fBcaRepository\fR (CA Repository). .PP Examples: .PP @@ -465,7 +398,7 @@ Examples: \& \& authorityInfoAccess = OCSP;URI:http://ocsp.example.com/ .Ve -.SS "\s-1CRL\s0 distribution points" +.SS "CRL 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 @@ -477,18 +410,18 @@ 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 +.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 +.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 +.IP CRLIssuer 4 .IX Item "CRLIssuer" The value must in the same format as the subject alternative name. -.IP "reasons" 4 +.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, @@ -524,17 +457,17 @@ Full distribution point example: .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 +whose syntax is similar to the "section" pointed to by the CRL distribution points extension. The following names have meaning: -.IP "fullname" 4 +.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 +.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 +.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, @@ -560,17 +493,17 @@ Example: 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 +Policies without qualifiers are specified by giving the OID. 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 +To include policy qualifiers, use the "@section" 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 +The section referred to must include the policy OID using the name \&\fBpolicyIdentifier\fR. cPSuri qualifiers can be included using the syntax: .PP .Vb 1 @@ -589,7 +522,7 @@ 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 +(if included) must BOTH be present. Some software might require the \fBia5org\fR option at the top level; this changes the encoding from Displaytext to IA5String. .PP @@ -612,7 +545,7 @@ Example: .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: +value with \fBUTF8\fR, \fBBMP\fR, or \fBVISIBLE\fR followed by colon. For example: .PP .Vb 2 \& [notice] @@ -644,7 +577,7 @@ 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 +is not supported and the \fBIP\fR form should consist of an IP addresses and subnet mask separated by a \fB/\fR. .PP Examples: @@ -656,7 +589,7 @@ Examples: \& \& nameConstraints = excluded;email:.com .Ve -.SS "\s-1OCSP\s0 No Check" +.SS "OCSP No Check" .IX Subsection "OCSP No Check" This is a string extension. It is parsed, but ignored. .PP @@ -665,11 +598,11 @@ Example: .Vb 1 \& noCheck = ignored .Ve -.SS "\s-1TLS\s0 Feature (aka Must Staple)" +.SS "TLS 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 +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 \s-1TLS\s0 client sends a listed extension, the \s-1TLS\s0 server is expected to +When a TLS client sends a listed extension, the TLS server is expected to include that extension in its reply. .PP The supported names are: \fBstatus_request\fR and \fBstatus_request_v2\fR. @@ -708,7 +641,7 @@ 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 +The first way is to use the word ASN1 followed by the extension content using the same syntax as \fBASN1_generate_nconf\fR\|(3). For example: .PP @@ -722,7 +655,7 @@ For example: \& field2 = UTF8:field2 .Ve .PP -It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any +It is also possible to use the word DER to include the raw encoded data in any extension. .PP .Vb 2 @@ -730,31 +663,31 @@ extension. \& 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 +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: .PP .Vb 1 \& basicConstraints = critical, DER:00:01:02:03 .Ve -.SH "WARNINGS" +.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 +The DER and ASN1 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" \&\fBopenssl\-req\fR\|(1), \fBopenssl\-ca\fR\|(1), \fBopenssl\-x509\fR\|(1), \&\fBASN1_generate_nconf\fR\|(3) -.SH "COPYRIGHT" +.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 +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |