1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "X509V3_CONFIG 5"
132 .TH X509V3_CONFIG 5 "2008-09-06" "0.9.8h" "OpenSSL"
134 x509v3_config \- X509 V3 certificate extension configuration format
136 .IX Header "DESCRIPTION"
137 Several of the OpenSSL utilities can add extensions to a certificate or
138 certificate request based on the contents of a configuration file.
140 Typically the application will contain an option to point to an extension
141 section. Each line of the extension section takes the form:
144 \& extension_name=[critical,] extension_options
147 If \fBcritical\fR is present then the extension will be critical.
149 The format of \fBextension_options\fR depends on the value of \fBextension_name\fR.
151 There are four main types of extension: \fIstring\fR extensions, \fImulti-valued\fR
152 extensions, \fIraw\fR and \fIarbitrary\fR extensions.
154 String extensions simply have a string which contains either the value itself
155 or how it is obtained.
160 \& nsComment="This is a Comment"
163 Multi-valued extensions have a short form and a long form. The short form
164 is a list of names and values:
167 \& basicConstraints=critical,CA:true,pathlen:1
170 The long form allows the values to be placed in a separate section:
173 \& basicConstraints=critical,@bs_section
185 Both forms are equivalent.
187 The syntax of raw extensions is governed by the extension code: it can
188 for example contain data in multiple sections. The correct syntax to
189 use is defined by the extension code itself: check out the certificate
190 policies extension for an example.
192 If an extension type is unsupported then the \fIarbitrary\fR extension syntax
193 must be used, see the \s-1ARBITRART\s0 \s-1EXTENSIONS\s0 section for more details.
194 .SH "STANDARD EXTENSIONS"
195 .IX Header "STANDARD EXTENSIONS"
196 The following sections describe each supported extension in detail.
197 .Sh "Basic Constraints."
198 .IX Subsection "Basic Constraints."
199 This is a multi valued extension which indicates whether a certificate is
200 a \s-1CA\s0 certificate. The first (mandatory) name is \fB\s-1CA\s0\fR followed by \fB\s-1TRUE\s0\fR or
201 \&\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 an
202 non-negative value can be included.
207 \& basicConstraints=CA:TRUE
211 \& 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 supporte names are: digitalSignature, nonRepudiation, keyEncipherment,
232 dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly
238 \& keyUsage=digitalSignature, nonRepudiation
242 \& keyUsage=critical, keyCertSign
244 .Sh "Extended Key Usage."
245 .IX Subsection "Extended Key Usage."
246 This extensions consists of a list of usages indicating purposes for which
247 the certificate public key can be used for,
249 These can either be object short names of the dotted numerical form of OIDs.
250 While any \s-1OID\s0 can be used only certain values make sense. In particular the
251 following \s-1PKIX\s0, \s-1NS\s0 and \s-1MS\s0 values are meaningful:
256 \& serverAuth SSL/TLS Web Server Authentication.
257 \& clientAuth SSL/TLS Web Client Authentication.
258 \& codeSigning Code signing.
259 \& emailProtection E-mail Protection (S/MIME).
260 \& timeStamping Trusted Timestamping
261 \& msCodeInd Microsoft Individual Code Signing (authenticode)
262 \& msCodeCom Microsoft Commercial Code Signing (authenticode)
263 \& msCTLSign Microsoft Trust List Signing
264 \& msSGC Microsoft Server Gated Crypto
265 \& msEFS Microsoft Encrypted File System
266 \& nsSGC Netscape Server Gated Crypto
272 \& extendedKeyUsage=critical,codeSigning,1.2.3.4
273 \& extendedKeyUsage=nsSGC,msSGC
275 .Sh "Subject Key Identifier."
276 .IX Subsection "Subject Key Identifier."
277 This is really a string extension and can take two possible values. Either
278 the word \fBhash\fR which will automatically follow the guidelines in \s-1RFC3280\s0
279 or a hex string giving the extension value to include. The use of the hex
280 string is strongly discouraged.
285 \& subjectKeyIdentifier=hash
287 .Sh "Authority Key Identifier."
288 .IX Subsection "Authority Key Identifier."
289 The authority key identifier extension permits two options. keyid and issuer:
290 both can take the optional value \*(L"always\*(R".
292 If the keyid option is present an attempt is made to copy the subject key
293 identifier from the parent certificate. If the value \*(L"always\*(R" is present
294 then an error is returned if the option fails.
296 The issuer option copies the issuer and serial number from the issuer
297 certificate. This will only be done if the keyid option fails or
298 is not included unless the \*(L"always\*(R" flag will always include the value.
303 \& authorityKeyIdentifier=keyid,issuer
305 .Sh "Subject Alternative Name."
306 .IX Subsection "Subject Alternative Name."
307 The subject alternative name extension allows various literal values to be
308 included in the configuration file. These include \fBemail\fR (an email address)
309 \&\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
310 registered \s-1ID:\s0 \s-1OBJECT\s0 \s-1IDENTIFIER\s0), \fB\s-1IP\s0\fR (an \s-1IP\s0 address), \fBdirName\fR
311 (a distinguished name) and otherName.
313 The email option include a special 'copy' value. This will automatically
314 include and email addresses contained in the certificate subject name in
317 The \s-1IP\s0 address used in the \fB\s-1IP\s0\fR options can be in either IPv4 or IPv6 format.
319 The value of \fBdirName\fR should point to a section containing the distinguished
320 name to use as a set of name value pairs. Multi values AVAs can be formed by
321 preceeding the name with a \fB+\fR character.
323 otherName can include arbitrary data associated with an \s-1OID:\s0 the value
324 should be the \s-1OID\s0 followed by a semicolon and the content in standard
325 \&\fIASN1_generate_nconf()\fR format.
330 \& subjectAltName=email:copy,email:my@other.address,URI:http://my.url.here/
331 \& subjectAltName=IP:192.168.7.1
332 \& subjectAltName=IP:13::17
333 \& subjectAltName=email:my@other.address,RID:1.2.3.4
334 \& subjectAltName=otherName:1.2.3.4;UTF8:some other identifier
338 \& subjectAltName=dirName:dir_sect
348 .Sh "Issuer Alternative Name."
349 .IX Subsection "Issuer Alternative Name."
350 The issuer alternative name option supports all the literal options of
351 subject alternative name. It does \fBnot\fR support the email:copy option because
352 that would not make sense. It does support an additional issuer:copy option
353 that will copy all the subject alternative name values from the issuer
354 certificate (if possible).
359 \& issuserAltName = issuer:copy
361 .Sh "Authority Info Access."
362 .IX Subsection "Authority Info Access."
363 The authority information access extension gives details about how to access
364 certain information relating to the \s-1CA\s0. Its syntax is accessOID;location
365 where \fIlocation\fR has the same syntax as subject alternative name (except
366 that email:copy is not supported). accessOID can be any valid \s-1OID\s0 but only
367 certain values are meaningful, for example \s-1OCSP\s0 and caIssuers.
372 \& authorityInfoAccess = OCSP;URI:http://ocsp.my.host/
373 \& authorityInfoAccess = caIssuers;URI:http://my.ca/ca.html
375 .Sh "\s-1CRL\s0 distribution points."
376 .IX Subsection "CRL distribution points."
377 This is a multi-valued extension that supports all the literal options of
378 subject alternative name. Of the few software packages that currently interpret
379 this extension most only interpret the \s-1URI\s0 option.
381 Currently each option will set a new DistributionPoint with the fullName
382 field set to the given value.
384 Other fields like cRLissuer and reasons cannot currently be set or displayed:
385 at this time no examples were available that used these fields.
390 \& crlDistributionPoints=URI:http://myhost.com/myca.crl
391 \& crlDistributionPoints=URI:http://my.com/my.crl,URI:http://oth.com/my.crl
393 .Sh "Certificate Policies."
394 .IX Subsection "Certificate Policies."
395 This is a \fIraw\fR extension. All the fields of this extension can be set by
396 using the appropriate syntax.
398 If you follow the \s-1PKIX\s0 recommendations and just using one \s-1OID\s0 then you just
399 include the value of that \s-1OID\s0. Multiple OIDs can be set separated by commas,
403 \& certificatePolicies= 1.2.4.5, 1.1.3.4
406 If you wish to include qualifiers then the policy \s-1OID\s0 and qualifiers need to
407 be specified in a separate section: this is done by using the \f(CW@section\fR syntax
408 instead of a literal \s-1OID\s0 value.
410 The section referred to must include the policy \s-1OID\s0 using the name
411 policyIdentifier, cPSuri qualifiers can be included using the syntax:
417 userNotice qualifiers can be set using the syntax:
420 \& userNotice.nnn=@notice
423 The value of the userNotice qualifier is specified in the relevant section.
424 This section can include explicitText, organization and noticeNumbers
425 options. explicitText and organization are text strings, noticeNumbers is a
426 comma separated list of numbers. The organization and noticeNumbers options
427 (if included) must \s-1BOTH\s0 be present. If you use the userNotice option with \s-1IE5\s0
428 then you need the 'ia5org' option at the top level to modify the encoding:
429 otherwise it will not be interpreted properly.
434 \& certificatePolicies=ia5org,1.2.3.4,1.5.6.7.8,@polsect
442 \& policyIdentifier = 1.3.5.8
443 \& CPS.1="http://my.host.name/"
444 \& CPS.2="http://my.your.name/"
445 \& userNotice.1=@notice
453 \& explicitText="Explicit Text Here"
454 \& organization="Organisation Name"
455 \& noticeNumbers=1,2,3,4
458 The \fBia5org\fR option changes the type of the \fIorganization\fR field. In \s-1RFC2459\s0
459 it can only be of type DisplayText. In \s-1RFC3280\s0 IA5Strring is also permissible.
460 Some software (for example some versions of \s-1MSIE\s0) may require ia5org.
461 .Sh "Policy Constraints"
462 .IX Subsection "Policy Constraints"
463 This is a multi-valued extension which consisting of the names
464 \&\fBrequireExplicitPolicy\fR or \fBinhibitPolicyMapping\fR and a non negative intger
465 value. At least one component must be present.
470 \& policyConstraints = requireExplicitPolicy:3
472 .Sh "Inhibit Any Policy"
473 .IX Subsection "Inhibit Any Policy"
474 This is a string extension whose value must be a non negative integer.
479 \& inhibitAnyPolicy = 2
481 .Sh "Name Constraints"
482 .IX Subsection "Name Constraints"
483 The name constraints extension is a multi-valued extension. The name should
484 begin with the word \fBpermitted\fR or \fBexcluded\fR followed by a \fB;\fR. The rest of
485 the name and the value follows the syntax of subjectAltName except email:copy
486 is not supported and the \fB\s-1IP\s0\fR form should consist of an \s-1IP\s0 addresses and
487 subnet mask separated by a \fB/\fR.
492 \& nameConstraints=permitted;IP:192.168.0.0/255.255.0.0
496 \& nameConstraints=permitted;email:.somedomain.com
500 \& nameConstraints=excluded;email:.com
502 .SH "DEPRECATED EXTENSIONS"
503 .IX Header "DEPRECATED EXTENSIONS"
504 The following extensions are non standard, Netscape specific and largely
505 obsolete. Their use in new applications is discouraged.
506 .Sh "Netscape String extensions."
507 .IX Subsection "Netscape String extensions."
508 Netscape Comment (\fBnsComment\fR) is a string extension containing a comment
509 which will be displayed when the certificate is viewed in some browsers.
514 \& nsComment = "Some Random Comment"
517 Other supported extensions in this category are: \fBnsBaseUrl\fR,
518 \&\fBnsRevocationUrl\fR, \fBnsCaRevocationUrl\fR, \fBnsRenewalUrl\fR, \fBnsCaPolicyUrl\fR
519 and \fBnsSslServerName\fR.
520 .Sh "Netscape Certificate Type"
521 .IX Subsection "Netscape Certificate Type"
522 This is a multi-valued extensions which consists of a list of flags to be
523 included. It was used to indicate the purposes for which a certificate could
524 be used. The basicConstraints, keyUsage and extended key usage extensions are
527 Acceptable values for nsCertType are: \fBclient\fR, \fBserver\fR, \fBemail\fR,
528 \&\fBobjsign\fR, \fBreserved\fR, \fBsslCA\fR, \fBemailCA\fR, \fBobjCA\fR.
529 .SH "ARBITRARY EXTENSIONS"
530 .IX Header "ARBITRARY EXTENSIONS"
531 If an extension is not supported by the OpenSSL code then it must be encoded
532 using the arbitrary extension format. It is also possible to use the arbitrary
533 format for supported extensions. Extreme care should be taken to ensure that
534 the data is formatted correctly for the given extension type.
536 There are two ways to encode arbitrary extensions.
538 The first way is to use the word \s-1ASN1\s0 followed by the extension content
539 using the same syntax as \fIASN1_generate_nconf()\fR. For example:
542 \& 1.2.3.4=critical,ASN1:UTF8String:Some random data
546 \& 1.2.3.4=ASN1:SEQUENCE:seq_sect
554 \& field1 = UTF8:field1
555 \& field2 = UTF8:field2
558 It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any
562 \& 1.2.3.4=critical,DER:01:02:03:04
563 \& 1.2.3.4=DER:01020304
566 The value following \s-1DER\s0 is a hex dump of the \s-1DER\s0 encoding of the extension
567 Any extension can be placed in this form to override the default behaviour.
571 \& basicConstraints=critical,DER:00:01:02:03
575 There is no guarantee that a specific implementation will process a given
576 extension. It may therefore be sometimes possible to use certificates for
577 purposes prohibited by their extensions because a specific application does
578 not recognize or honour the values of the relevant extensions.
580 The \s-1DER\s0 and \s-1ASN1\s0 options should be used with caution. It is possible to create
581 totally invalid extensions if they are not used carefully.
584 If an extension is multi-value and a field value must contain a comma the long
585 form must be used otherwise the comma would be misinterpreted as a field
586 separator. For example:
589 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
592 will produce an error but the equivalent form:
595 \& subjectAltName=@subject_alt_section
599 \& [subject_alt_section]
600 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
605 Due to the behaviour of the OpenSSL \fBconf\fR library the same field name
606 can only occur once in a section. This means that:
609 \& subjectAltName=@alt_section
621 will only recognize the last value. This can be worked around by using the form:
628 \& email.1=steve@here
629 \& email.2=steve@there
633 The X509v3 extension code was first added to OpenSSL 0.9.2.
635 Policy mappings, inhibit any policy and name constraints support was added in
638 The \fBdirectoryName\fR and \fBotherName\fR option as well as the \fB\s-1ASN1\s0\fR option
639 for arbitrary extensions was added in OpenSSL 0.9.8
641 .IX Header "SEE ALSO"
642 \&\fIreq\fR\|(1), \fIca\fR\|(1), \fIx509\fR\|(1)
projects / dragonfly.git / blob