1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "X509V3_CONFIG 5"
136 .TH X509V3_CONFIG 5 "2020-09-22" "1.1.1h" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 x509v3_config \- X509 V3 certificate extension configuration format
144 .IX Header "DESCRIPTION"
145 Several of the OpenSSL utilities can add extensions to a certificate or
146 certificate request based on the contents of a configuration file.
148 Typically the application will contain an option to point to an extension
149 section. Each line of the extension section takes the form:
152 \& extension_name=[critical,] extension_options
155 If \fBcritical\fR is present then the extension will be critical.
157 The format of \fBextension_options\fR depends on the value of \fBextension_name\fR.
159 There are four main types of extension: \fIstring\fR extensions, \fImulti-valued\fR
160 extensions, \fIraw\fR and \fIarbitrary\fR extensions.
162 String extensions simply have a string which contains either the value itself
163 or how it is obtained.
168 \& nsComment="This is a Comment"
171 Multi-valued extensions have a short form and a long form. The short form
172 is a list of names and values:
175 \& basicConstraints=critical,CA:true,pathlen:1
178 The long form allows the values to be placed in a separate section:
181 \& basicConstraints=critical,@bs_section
189 Both forms are equivalent.
191 The syntax of raw extensions is governed by the extension code: it can
192 for example contain data in multiple sections. The correct syntax to
193 use is defined by the extension code itself: check out the certificate
194 policies extension for an example.
196 If an extension type is unsupported then the \fIarbitrary\fR extension syntax
197 must be used, see the \s-1ARBITRARY EXTENSIONS\s0 section for more details.
198 .SH "STANDARD EXTENSIONS"
199 .IX Header "STANDARD EXTENSIONS"
200 The following sections describe each supported extension in detail.
201 .SS "Basic Constraints."
202 .IX Subsection "Basic Constraints."
203 This is a multi valued extension which indicates whether a certificate is
204 a \s-1CA\s0 certificate. The first (mandatory) name is \fB\s-1CA\s0\fR followed by \fB\s-1TRUE\s0\fR or
205 \&\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
206 nonnegative value can be included.
211 \& basicConstraints=CA:TRUE
213 \& basicConstraints=CA:FALSE
215 \& basicConstraints=critical,CA:TRUE, pathlen:0
218 A \s-1CA\s0 certificate \fBmust\fR include the basicConstraints value with the \s-1CA\s0 field
219 set to \s-1TRUE.\s0 An end user certificate must either set \s-1CA\s0 to \s-1FALSE\s0 or exclude the
220 extension entirely. Some software may require the inclusion of basicConstraints
221 with \s-1CA\s0 set to \s-1FALSE\s0 for end entity certificates.
223 The pathlen parameter indicates the maximum number of CAs that can appear
224 below this one in a chain. So if you have a \s-1CA\s0 with a pathlen of zero it can
225 only be used to sign end user certificates and not further CAs.
227 .IX Subsection "Key Usage."
228 Key usage is a multi valued extension consisting of a list of names of the
229 permitted key usages.
231 The supported names are: digitalSignature, nonRepudiation, keyEncipherment,
232 dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly
238 \& keyUsage=digitalSignature, nonRepudiation
240 \& keyUsage=critical, keyCertSign
242 .SS "Extended Key Usage."
243 .IX Subsection "Extended Key Usage."
244 This extensions consists of a list of usages indicating purposes for which
245 the certificate public key can be used for,
247 These can either be object short names or the dotted numerical form of OIDs.
248 While any \s-1OID\s0 can be used only certain values make sense. In particular the
249 following \s-1PKIX, NS\s0 and \s-1MS\s0 values are meaningful:
253 \& \-\-\-\-\- \-\-\-\-\-\-\-
254 \& serverAuth SSL/TLS Web Server Authentication.
255 \& clientAuth SSL/TLS Web Client Authentication.
256 \& codeSigning Code signing.
257 \& emailProtection E\-mail Protection (S/MIME).
258 \& timeStamping Trusted Timestamping
259 \& OCSPSigning OCSP Signing
260 \& ipsecIKE ipsec Internet Key Exchange
261 \& msCodeInd Microsoft Individual Code Signing (authenticode)
262 \& msCodeCom Microsoft Commercial Code Signing (authenticode)
263 \& msCTLSign Microsoft Trust List Signing
264 \& msEFS Microsoft Encrypted File System
270 \& extendedKeyUsage=critical,codeSigning,1.2.3.4
271 \& extendedKeyUsage=serverAuth,clientAuth
273 .SS "Subject Key Identifier."
274 .IX Subsection "Subject Key Identifier."
275 This is really a string extension and can take two possible values. Either
276 the word \fBhash\fR which will automatically follow the guidelines in \s-1RFC3280\s0
277 or a hex string giving the extension value to include. The use of the hex
278 string is strongly discouraged.
283 \& subjectKeyIdentifier=hash
285 .SS "Authority Key Identifier."
286 .IX Subsection "Authority Key Identifier."
287 The authority key identifier extension permits two options. keyid and issuer:
288 both can take the optional value \*(L"always\*(R".
290 If the keyid option is present an attempt is made to copy the subject key
291 identifier from the parent certificate. If the value \*(L"always\*(R" is present
292 then an error is returned if the option fails.
294 The issuer option copies the issuer and serial number from the issuer
295 certificate. This will only be done if the keyid option fails or
296 is not included unless the \*(L"always\*(R" flag will always include the value.
301 \& authorityKeyIdentifier=keyid,issuer
303 .SS "Subject Alternative Name."
304 .IX Subsection "Subject Alternative Name."
305 The subject alternative name extension allows various literal values to be
306 included in the configuration file. These include \fBemail\fR (an email address)
307 \&\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
308 registered \s-1ID: OBJECT IDENTIFIER\s0), \fB\s-1IP\s0\fR (an \s-1IP\s0 address), \fBdirName\fR
309 (a distinguished name) and otherName.
311 The email option include a special 'copy' value. This will automatically
312 include any email addresses contained in the certificate subject name in
315 The \s-1IP\s0 address used in the \fB\s-1IP\s0\fR options can be in either IPv4 or IPv6 format.
317 The value of \fBdirName\fR should point to a section containing the distinguished
318 name to use as a set of name value pairs. Multi values AVAs can be formed by
319 prefacing the name with a \fB+\fR character.
321 otherName can include arbitrary data associated with an \s-1OID:\s0 the value
322 should be the \s-1OID\s0 followed by a semicolon and the content in standard
323 \&\fBASN1_generate_nconf\fR\|(3) format.
328 \& subjectAltName=email:copy,email:my@other.address,URI:http://my.url.here/
329 \& subjectAltName=IP:192.168.7.1
330 \& subjectAltName=IP:13::17
331 \& subjectAltName=email:my@other.address,RID:1.2.3.4
332 \& subjectAltName=otherName:1.2.3.4;UTF8:some other identifier
334 \& subjectAltName=dirName:dir_sect
342 .SS "Issuer Alternative Name."
343 .IX Subsection "Issuer Alternative Name."
344 The issuer alternative name option supports all the literal options of
345 subject alternative name. It does \fBnot\fR support the email:copy option because
346 that would not make sense. It does support an additional issuer:copy option
347 that will copy all the subject alternative name values from the issuer
348 certificate (if possible).
353 \& issuerAltName = issuer:copy
355 .SS "Authority Info Access."
356 .IX Subsection "Authority Info Access."
357 The authority information access extension gives details about how to access
358 certain information relating to the \s-1CA.\s0 Its syntax is accessOID;location
359 where \fIlocation\fR has the same syntax as subject alternative name (except
360 that email:copy is not supported). accessOID can be any valid \s-1OID\s0 but only
361 certain values are meaningful, for example \s-1OCSP\s0 and caIssuers.
366 \& authorityInfoAccess = OCSP;URI:http://ocsp.my.host/
367 \& authorityInfoAccess = caIssuers;URI:http://my.ca/ca.html
369 .SS "\s-1CRL\s0 distribution points"
370 .IX Subsection "CRL distribution points"
371 This is a multi-valued extension whose options can be either in name:value pair
372 using the same form as subject alternative name or a single value representing
373 a section name containing all the distribution point fields.
375 For a name:value pair a new DistributionPoint with the fullName field set to
376 the given value both the cRLissuer and reasons fields are omitted in this case.
378 In the single option case the section indicated contains values for each
379 field. In this section:
381 If the name is \*(L"fullname\*(R" the value field should contain the full name
382 of the distribution point in the same format as subject alternative name.
384 If the name is \*(L"relativename\*(R" then the value field should contain a section
385 name whose contents represent a \s-1DN\s0 fragment to be placed in this field.
387 The name \*(L"CRLIssuer\*(R" if present should contain a value for this field in
388 subject alternative name format.
390 If the name is \*(L"reasons\*(R" the value field should consist of a comma
391 separated field containing the reasons. Valid reasons are: \*(L"keyCompromise\*(R",
392 \&\*(L"CACompromise\*(R", \*(L"affiliationChanged\*(R", \*(L"superseded\*(R", \*(L"cessationOfOperation\*(R",
393 \&\*(L"certificateHold\*(R", \*(L"privilegeWithdrawn\*(R" and \*(L"AACompromise\*(R".
398 \& crlDistributionPoints=URI:http://myhost.com/myca.crl
399 \& crlDistributionPoints=URI:http://my.com/my.crl,URI:http://oth.com/my.crl
402 Full distribution point example:
405 \& crlDistributionPoints=crldp1_section
409 \& fullname=URI:http://myhost.com/myca.crl
410 \& CRLissuer=dirName:issuer_sect
411 \& reasons=keyCompromise, CACompromise
418 .SS "Issuing Distribution Point"
419 .IX Subsection "Issuing Distribution Point"
420 This extension should only appear in CRLs. It is a multi valued extension
421 whose syntax is similar to the \*(L"section\*(R" pointed to by the \s-1CRL\s0 distribution
422 points extension with a few differences.
424 The names \*(L"reasons\*(R" and \*(L"CRLissuer\*(R" are not recognized.
426 The name \*(L"onlysomereasons\*(R" is accepted which sets this field. The value is
427 in the same format as the \s-1CRL\s0 distribution point \*(L"reasons\*(R" field.
429 The names \*(L"onlyuser\*(R", \*(L"onlyCA\*(R", \*(L"onlyAA\*(R" and \*(L"indirectCRL\*(R" are also accepted
430 the values should be a boolean value (\s-1TRUE\s0 or \s-1FALSE\s0) to indicate the value of
431 the corresponding field.
436 \& issuingDistributionPoint=critical, @idp_section
440 \& fullname=URI:http://myhost.com/myca.crl
442 \& onlysomereasons=keyCompromise, CACompromise
449 .SS "Certificate Policies."
450 .IX Subsection "Certificate Policies."
451 This is a \fIraw\fR extension. All the fields of this extension can be set by
452 using the appropriate syntax.
454 If you follow the \s-1PKIX\s0 recommendations and just using one \s-1OID\s0 then you just
455 include the value of that \s-1OID.\s0 Multiple OIDs can be set separated by commas,
459 \& certificatePolicies= 1.2.4.5, 1.1.3.4
462 If you wish to include qualifiers then the policy \s-1OID\s0 and qualifiers need to
463 be specified in a separate section: this is done by using the \f(CW@section\fR syntax
464 instead of a literal \s-1OID\s0 value.
466 The section referred to must include the policy \s-1OID\s0 using the name
467 policyIdentifier, cPSuri qualifiers can be included using the syntax:
473 userNotice qualifiers can be set using the syntax:
476 \& userNotice.nnn=@notice
479 The value of the userNotice qualifier is specified in the relevant section.
480 This section can include explicitText, organization and noticeNumbers
481 options. explicitText and organization are text strings, noticeNumbers is a
482 comma separated list of numbers. The organization and noticeNumbers options
483 (if included) must \s-1BOTH\s0 be present. If you use the userNotice option with \s-1IE5\s0
484 then you need the 'ia5org' option at the top level to modify the encoding:
485 otherwise it will not be interpreted properly.
490 \& certificatePolicies=ia5org,1.2.3.4,1.5.6.7.8,@polsect
494 \& policyIdentifier = 1.3.5.8
495 \& CPS.1="http://my.host.name/"
496 \& CPS.2="http://my.your.name/"
497 \& userNotice.1=@notice
501 \& explicitText="Explicit Text Here"
502 \& organization="Organisation Name"
503 \& noticeNumbers=1,2,3,4
506 The \fBia5org\fR option changes the type of the \fIorganization\fR field. In \s-1RFC2459\s0
507 it can only be of type DisplayText. In \s-1RFC3280\s0 IA5String is also permissible.
508 Some software (for example some versions of \s-1MSIE\s0) may require ia5org.
510 \&\s-1ASN1\s0 type of explicitText can be specified by prepending \fB\s-1UTF8\s0\fR,
511 \&\fB\s-1BMP\s0\fR or \fB\s-1VISIBLE\s0\fR prefix followed by colon. For example:
515 \& explicitText="UTF8:Explicit Text Here"
517 .SS "Policy Constraints"
518 .IX Subsection "Policy Constraints"
519 This is a multi-valued extension which consisting of the names
520 \&\fBrequireExplicitPolicy\fR or \fBinhibitPolicyMapping\fR and a non negative integer
521 value. At least one component must be present.
526 \& policyConstraints = requireExplicitPolicy:3
528 .SS "Inhibit Any Policy"
529 .IX Subsection "Inhibit Any Policy"
530 This is a string extension whose value must be a non negative integer.
535 \& inhibitAnyPolicy = 2
537 .SS "Name Constraints"
538 .IX Subsection "Name Constraints"
539 The name constraints extension is a multi-valued extension. The name should
540 begin with the word \fBpermitted\fR or \fBexcluded\fR followed by a \fB;\fR. The rest of
541 the name and the value follows the syntax of subjectAltName except email:copy
542 is not supported and the \fB\s-1IP\s0\fR form should consist of an \s-1IP\s0 addresses and
543 subnet mask separated by a \fB/\fR.
548 \& nameConstraints=permitted;IP:192.168.0.0/255.255.0.0
550 \& nameConstraints=permitted;email:.somedomain.com
552 \& nameConstraints=excluded;email:.com
554 .SS "\s-1OCSP\s0 No Check"
555 .IX Subsection "OCSP No Check"
556 The \s-1OCSP\s0 No Check extension is a string extension but its value is ignored.
563 .SS "\s-1TLS\s0 Feature (aka Must Staple)"
564 .IX Subsection "TLS Feature (aka Must Staple)"
565 This is a multi-valued extension consisting of a list of \s-1TLS\s0 extension
566 identifiers. Each identifier may be a number (0..65535) or a supported name.
567 When a \s-1TLS\s0 client sends a listed extension, the \s-1TLS\s0 server is expected to
568 include that extension in its reply.
570 The supported names are: \fBstatus_request\fR and \fBstatus_request_v2\fR.
575 \& tlsfeature = status_request
577 .SH "DEPRECATED EXTENSIONS"
578 .IX Header "DEPRECATED EXTENSIONS"
579 The following extensions are non standard, Netscape specific and largely
580 obsolete. Their use in new applications is discouraged.
581 .SS "Netscape String extensions."
582 .IX Subsection "Netscape String extensions."
583 Netscape Comment (\fBnsComment\fR) is a string extension containing a comment
584 which will be displayed when the certificate is viewed in some browsers.
589 \& nsComment = "Some Random Comment"
592 Other supported extensions in this category are: \fBnsBaseUrl\fR,
593 \&\fBnsRevocationUrl\fR, \fBnsCaRevocationUrl\fR, \fBnsRenewalUrl\fR, \fBnsCaPolicyUrl\fR
594 and \fBnsSslServerName\fR.
595 .SS "Netscape Certificate Type"
596 .IX Subsection "Netscape Certificate Type"
597 This is a multi-valued extensions which consists of a list of flags to be
598 included. It was used to indicate the purposes for which a certificate could
599 be used. The basicConstraints, keyUsage and extended key usage extensions are
602 Acceptable values for nsCertType are: \fBclient\fR, \fBserver\fR, \fBemail\fR,
603 \&\fBobjsign\fR, \fBreserved\fR, \fBsslCA\fR, \fBemailCA\fR, \fBobjCA\fR.
604 .SH "ARBITRARY EXTENSIONS"
605 .IX Header "ARBITRARY EXTENSIONS"
606 If an extension is not supported by the OpenSSL code then it must be encoded
607 using the arbitrary extension format. It is also possible to use the arbitrary
608 format for supported extensions. Extreme care should be taken to ensure that
609 the data is formatted correctly for the given extension type.
611 There are two ways to encode arbitrary extensions.
613 The first way is to use the word \s-1ASN1\s0 followed by the extension content
614 using the same syntax as \fBASN1_generate_nconf\fR\|(3).
618 \& 1.2.3.4=critical,ASN1:UTF8String:Some random data
620 \& 1.2.3.4=ASN1:SEQUENCE:seq_sect
624 \& field1 = UTF8:field1
625 \& field2 = UTF8:field2
628 It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any
632 \& 1.2.3.4=critical,DER:01:02:03:04
633 \& 1.2.3.4=DER:01020304
636 The value following \s-1DER\s0 is a hex dump of the \s-1DER\s0 encoding of the extension
637 Any extension can be placed in this form to override the default behaviour.
641 \& basicConstraints=critical,DER:00:01:02:03
644 .IX Header "WARNINGS"
645 There is no guarantee that a specific implementation will process a given
646 extension. It may therefore be sometimes possible to use certificates for
647 purposes prohibited by their extensions because a specific application does
648 not recognize or honour the values of the relevant extensions.
650 The \s-1DER\s0 and \s-1ASN1\s0 options should be used with caution. It is possible to create
651 totally invalid extensions if they are not used carefully.
654 If an extension is multi-value and a field value must contain a comma the long
655 form must be used otherwise the comma would be misinterpreted as a field
656 separator. For example:
659 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
662 will produce an error but the equivalent form:
665 \& subjectAltName=@subject_alt_section
667 \& [subject_alt_section]
668 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
673 Due to the behaviour of the OpenSSL \fBconf\fR library the same field name
674 can only occur once in a section. This means that:
677 \& subjectAltName=@alt_section
685 will only recognize the last value. This can be worked around by using the form:
690 \& email.1=steve@here
691 \& email.2=steve@there
694 .IX Header "SEE ALSO"
695 \&\fBreq\fR\|(1), \fBca\fR\|(1), \fBx509\fR\|(1),
696 \&\fBASN1_generate_nconf\fR\|(3)
698 .IX Header "COPYRIGHT"
699 Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
701 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
702 this file except in compliance with the License. You can obtain a copy
703 in the file \s-1LICENSE\s0 in the source distribution or at
704 <https://www.openssl.org/source/license.html>.