1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" 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 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "X509V3_CONFIG 5"
135 .TH X509V3_CONFIG 5 "2009-11-06" "0.9.8l" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 x509v3_config \- X509 V3 certificate extension configuration format
143 .IX Header "DESCRIPTION"
144 Several of the OpenSSL utilities can add extensions to a certificate or
145 certificate request based on the contents of a configuration file.
147 Typically the application will contain an option to point to an extension
148 section. Each line of the extension section takes the form:
151 \& extension_name=[critical,] extension_options
154 If \fBcritical\fR is present then the extension will be critical.
156 The format of \fBextension_options\fR depends on the value of \fBextension_name\fR.
158 There are four main types of extension: \fIstring\fR extensions, \fImulti-valued\fR
159 extensions, \fIraw\fR and \fIarbitrary\fR extensions.
161 String extensions simply have a string which contains either the value itself
162 or how it is obtained.
167 \& nsComment="This is a Comment"
170 Multi-valued extensions have a short form and a long form. The short form
171 is a list of names and values:
174 \& basicConstraints=critical,CA:true,pathlen:1
177 The long form allows the values to be placed in a separate section:
180 \& basicConstraints=critical,@bs_section
188 Both forms are equivalent.
190 The syntax of raw extensions is governed by the extension code: it can
191 for example contain data in multiple sections. The correct syntax to
192 use is defined by the extension code itself: check out the certificate
193 policies extension for an example.
195 If an extension type is unsupported then the \fIarbitrary\fR extension syntax
196 must be used, see the \s-1ARBITRART\s0 \s-1EXTENSIONS\s0 section for more details.
197 .SH "STANDARD EXTENSIONS"
198 .IX Header "STANDARD EXTENSIONS"
199 The following sections describe each supported extension in detail.
200 .Sh "Basic Constraints."
201 .IX Subsection "Basic Constraints."
202 This is a multi valued extension which indicates whether a certificate is
203 a \s-1CA\s0 certificate. The first (mandatory) name is \fB\s-1CA\s0\fR followed by \fB\s-1TRUE\s0\fR or
204 \&\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
205 non-negative value can be included.
210 \& basicConstraints=CA:TRUE
212 \& basicConstraints=CA:FALSE
214 \& basicConstraints=critical,CA:TRUE, pathlen:0
217 A \s-1CA\s0 certificate \fBmust\fR include the basicConstraints value with the \s-1CA\s0 field
218 set to \s-1TRUE\s0. An end user certificate must either set \s-1CA\s0 to \s-1FALSE\s0 or exclude the
219 extension entirely. Some software may require the inclusion of basicConstraints
220 with \s-1CA\s0 set to \s-1FALSE\s0 for end entity certificates.
222 The pathlen parameter indicates the maximum number of CAs that can appear
223 below this one in a chain. So if you have a \s-1CA\s0 with a pathlen of zero it can
224 only be used to sign end user certificates and not further CAs.
226 .IX Subsection "Key Usage."
227 Key usage is a multi valued extension consisting of a list of names of the
228 permitted key usages.
230 The supporte names are: digitalSignature, nonRepudiation, keyEncipherment,
231 dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly
237 \& keyUsage=digitalSignature, nonRepudiation
239 \& keyUsage=critical, keyCertSign
241 .Sh "Extended Key Usage."
242 .IX Subsection "Extended Key Usage."
243 This extensions consists of a list of usages indicating purposes for which
244 the certificate public key can be used for,
246 These can either be object short names of the dotted numerical form of OIDs.
247 While any \s-1OID\s0 can be used only certain values make sense. In particular the
248 following \s-1PKIX\s0, \s-1NS\s0 and \s-1MS\s0 values are meaningful:
252 \& \-\-\-\-\- \-\-\-\-\-\-\-
253 \& serverAuth SSL/TLS Web Server Authentication.
254 \& clientAuth SSL/TLS Web Client Authentication.
255 \& codeSigning Code signing.
256 \& emailProtection E\-mail Protection (S/MIME).
257 \& timeStamping Trusted Timestamping
258 \& msCodeInd Microsoft Individual Code Signing (authenticode)
259 \& msCodeCom Microsoft Commercial Code Signing (authenticode)
260 \& msCTLSign Microsoft Trust List Signing
261 \& msSGC Microsoft Server Gated Crypto
262 \& msEFS Microsoft Encrypted File System
263 \& nsSGC Netscape Server Gated Crypto
269 \& extendedKeyUsage=critical,codeSigning,1.2.3.4
270 \& extendedKeyUsage=nsSGC,msSGC
272 .Sh "Subject Key Identifier."
273 .IX Subsection "Subject Key Identifier."
274 This is really a string extension and can take two possible values. Either
275 the word \fBhash\fR which will automatically follow the guidelines in \s-1RFC3280\s0
276 or a hex string giving the extension value to include. The use of the hex
277 string is strongly discouraged.
282 \& subjectKeyIdentifier=hash
284 .Sh "Authority Key Identifier."
285 .IX Subsection "Authority Key Identifier."
286 The authority key identifier extension permits two options. keyid and issuer:
287 both can take the optional value \*(L"always\*(R".
289 If the keyid option is present an attempt is made to copy the subject key
290 identifier from the parent certificate. If the value \*(L"always\*(R" is present
291 then an error is returned if the option fails.
293 The issuer option copies the issuer and serial number from the issuer
294 certificate. This will only be done if the keyid option fails or
295 is not included unless the \*(L"always\*(R" flag will always include the value.
300 \& authorityKeyIdentifier=keyid,issuer
302 .Sh "Subject Alternative Name."
303 .IX Subsection "Subject Alternative Name."
304 The subject alternative name extension allows various literal values to be
305 included in the configuration file. These include \fBemail\fR (an email address)
306 \&\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
307 registered \s-1ID:\s0 \s-1OBJECT\s0 \s-1IDENTIFIER\s0), \fB\s-1IP\s0\fR (an \s-1IP\s0 address), \fBdirName\fR
308 (a distinguished name) and otherName.
310 The email option include a special 'copy' value. This will automatically
311 include and email addresses contained in the certificate subject name in
314 The \s-1IP\s0 address used in the \fB\s-1IP\s0\fR options can be in either IPv4 or IPv6 format.
316 The value of \fBdirName\fR should point to a section containing the distinguished
317 name to use as a set of name value pairs. Multi values AVAs can be formed by
318 preceeding the name with a \fB+\fR character.
320 otherName can include arbitrary data associated with an \s-1OID:\s0 the value
321 should be the \s-1OID\s0 followed by a semicolon and the content in standard
322 \&\fIASN1_generate_nconf()\fR format.
327 \& subjectAltName=email:copy,email:my@other.address,URI:http://my.url.here/
328 \& subjectAltName=IP:192.168.7.1
329 \& subjectAltName=IP:13::17
330 \& subjectAltName=email:my@other.address,RID:1.2.3.4
331 \& subjectAltName=otherName:1.2.3.4;UTF8:some other identifier
333 \& subjectAltName=dirName:dir_sect
341 .Sh "Issuer Alternative Name."
342 .IX Subsection "Issuer Alternative Name."
343 The issuer alternative name option supports all the literal options of
344 subject alternative name. It does \fBnot\fR support the email:copy option because
345 that would not make sense. It does support an additional issuer:copy option
346 that will copy all the subject alternative name values from the issuer
347 certificate (if possible).
352 \& issuserAltName = issuer:copy
354 .Sh "Authority Info Access."
355 .IX Subsection "Authority Info Access."
356 The authority information access extension gives details about how to access
357 certain information relating to the \s-1CA\s0. Its syntax is accessOID;location
358 where \fIlocation\fR has the same syntax as subject alternative name (except
359 that email:copy is not supported). accessOID can be any valid \s-1OID\s0 but only
360 certain values are meaningful, for example \s-1OCSP\s0 and caIssuers.
365 \& authorityInfoAccess = OCSP;URI:http://ocsp.my.host/
366 \& authorityInfoAccess = caIssuers;URI:http://my.ca/ca.html
368 .Sh "\s-1CRL\s0 distribution points."
369 .IX Subsection "CRL distribution points."
370 This is a multi-valued extension that supports all the literal options of
371 subject alternative name. Of the few software packages that currently interpret
372 this extension most only interpret the \s-1URI\s0 option.
374 Currently each option will set a new DistributionPoint with the fullName
375 field set to the given value.
377 Other fields like cRLissuer and reasons cannot currently be set or displayed:
378 at this time no examples were available that used these fields.
383 \& crlDistributionPoints=URI:http://myhost.com/myca.crl
384 \& crlDistributionPoints=URI:http://my.com/my.crl,URI:http://oth.com/my.crl
386 .Sh "Certificate Policies."
387 .IX Subsection "Certificate Policies."
388 This is a \fIraw\fR extension. All the fields of this extension can be set by
389 using the appropriate syntax.
391 If you follow the \s-1PKIX\s0 recommendations and just using one \s-1OID\s0 then you just
392 include the value of that \s-1OID\s0. Multiple OIDs can be set separated by commas,
396 \& certificatePolicies= 1.2.4.5, 1.1.3.4
399 If you wish to include qualifiers then the policy \s-1OID\s0 and qualifiers need to
400 be specified in a separate section: this is done by using the \f(CW@section\fR syntax
401 instead of a literal \s-1OID\s0 value.
403 The section referred to must include the policy \s-1OID\s0 using the name
404 policyIdentifier, cPSuri qualifiers can be included using the syntax:
410 userNotice qualifiers can be set using the syntax:
413 \& userNotice.nnn=@notice
416 The value of the userNotice qualifier is specified in the relevant section.
417 This section can include explicitText, organization and noticeNumbers
418 options. explicitText and organization are text strings, noticeNumbers is a
419 comma separated list of numbers. The organization and noticeNumbers options
420 (if included) must \s-1BOTH\s0 be present. If you use the userNotice option with \s-1IE5\s0
421 then you need the 'ia5org' option at the top level to modify the encoding:
422 otherwise it will not be interpreted properly.
427 \& certificatePolicies=ia5org,1.2.3.4,1.5.6.7.8,@polsect
431 \& policyIdentifier = 1.3.5.8
432 \& CPS.1="http://my.host.name/"
433 \& CPS.2="http://my.your.name/"
434 \& userNotice.1=@notice
438 \& explicitText="Explicit Text Here"
439 \& organization="Organisation Name"
440 \& noticeNumbers=1,2,3,4
443 The \fBia5org\fR option changes the type of the \fIorganization\fR field. In \s-1RFC2459\s0
444 it can only be of type DisplayText. In \s-1RFC3280\s0 IA5Strring is also permissible.
445 Some software (for example some versions of \s-1MSIE\s0) may require ia5org.
446 .Sh "Policy Constraints"
447 .IX Subsection "Policy Constraints"
448 This is a multi-valued extension which consisting of the names
449 \&\fBrequireExplicitPolicy\fR or \fBinhibitPolicyMapping\fR and a non negative intger
450 value. At least one component must be present.
455 \& policyConstraints = requireExplicitPolicy:3
457 .Sh "Inhibit Any Policy"
458 .IX Subsection "Inhibit Any Policy"
459 This is a string extension whose value must be a non negative integer.
464 \& inhibitAnyPolicy = 2
466 .Sh "Name Constraints"
467 .IX Subsection "Name Constraints"
468 The name constraints extension is a multi-valued extension. The name should
469 begin with the word \fBpermitted\fR or \fBexcluded\fR followed by a \fB;\fR. The rest of
470 the name and the value follows the syntax of subjectAltName except email:copy
471 is not supported and the \fB\s-1IP\s0\fR form should consist of an \s-1IP\s0 addresses and
472 subnet mask separated by a \fB/\fR.
477 \& nameConstraints=permitted;IP:192.168.0.0/255.255.0.0
479 \& nameConstraints=permitted;email:.somedomain.com
481 \& nameConstraints=excluded;email:.com
483 .SH "DEPRECATED EXTENSIONS"
484 .IX Header "DEPRECATED EXTENSIONS"
485 The following extensions are non standard, Netscape specific and largely
486 obsolete. Their use in new applications is discouraged.
487 .Sh "Netscape String extensions."
488 .IX Subsection "Netscape String extensions."
489 Netscape Comment (\fBnsComment\fR) is a string extension containing a comment
490 which will be displayed when the certificate is viewed in some browsers.
495 \& nsComment = "Some Random Comment"
498 Other supported extensions in this category are: \fBnsBaseUrl\fR,
499 \&\fBnsRevocationUrl\fR, \fBnsCaRevocationUrl\fR, \fBnsRenewalUrl\fR, \fBnsCaPolicyUrl\fR
500 and \fBnsSslServerName\fR.
501 .Sh "Netscape Certificate Type"
502 .IX Subsection "Netscape Certificate Type"
503 This is a multi-valued extensions which consists of a list of flags to be
504 included. It was used to indicate the purposes for which a certificate could
505 be used. The basicConstraints, keyUsage and extended key usage extensions are
508 Acceptable values for nsCertType are: \fBclient\fR, \fBserver\fR, \fBemail\fR,
509 \&\fBobjsign\fR, \fBreserved\fR, \fBsslCA\fR, \fBemailCA\fR, \fBobjCA\fR.
510 .SH "ARBITRARY EXTENSIONS"
511 .IX Header "ARBITRARY EXTENSIONS"
512 If an extension is not supported by the OpenSSL code then it must be encoded
513 using the arbitrary extension format. It is also possible to use the arbitrary
514 format for supported extensions. Extreme care should be taken to ensure that
515 the data is formatted correctly for the given extension type.
517 There are two ways to encode arbitrary extensions.
519 The first way is to use the word \s-1ASN1\s0 followed by the extension content
520 using the same syntax as \fIASN1_generate_nconf()\fR. For example:
523 \& 1.2.3.4=critical,ASN1:UTF8String:Some random data
525 \& 1.2.3.4=ASN1:SEQUENCE:seq_sect
529 \& field1 = UTF8:field1
530 \& field2 = UTF8:field2
533 It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any
537 \& 1.2.3.4=critical,DER:01:02:03:04
538 \& 1.2.3.4=DER:01020304
541 The value following \s-1DER\s0 is a hex dump of the \s-1DER\s0 encoding of the extension
542 Any extension can be placed in this form to override the default behaviour.
546 \& basicConstraints=critical,DER:00:01:02:03
550 There is no guarantee that a specific implementation will process a given
551 extension. It may therefore be sometimes possible to use certificates for
552 purposes prohibited by their extensions because a specific application does
553 not recognize or honour the values of the relevant extensions.
555 The \s-1DER\s0 and \s-1ASN1\s0 options should be used with caution. It is possible to create
556 totally invalid extensions if they are not used carefully.
559 If an extension is multi-value and a field value must contain a comma the long
560 form must be used otherwise the comma would be misinterpreted as a field
561 separator. For example:
564 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
567 will produce an error but the equivalent form:
570 \& subjectAltName=@subject_alt_section
572 \& [subject_alt_section]
573 \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
578 Due to the behaviour of the OpenSSL \fBconf\fR library the same field name
579 can only occur once in a section. This means that:
582 \& subjectAltName=@alt_section
590 will only recognize the last value. This can be worked around by using the form:
595 \& email.1=steve@here
596 \& email.2=steve@there
600 The X509v3 extension code was first added to OpenSSL 0.9.2.
602 Policy mappings, inhibit any policy and name constraints support was added in
605 The \fBdirectoryName\fR and \fBotherName\fR option as well as the \fB\s-1ASN1\s0\fR option
606 for arbitrary extensions was added in OpenSSL 0.9.8
608 .IX Header "SEE ALSO"
609 \&\fIreq\fR\|(1), \fIca\fR\|(1), \fIx509\fR\|(1)
nant's projects / dragonfly.git / blob