Debian Codegraph @

upstream/debian-trixie/man5/x509v3_config.5ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509V3_CONFIG 5SSL"
58 .TH X509V3_CONFIG 5SSL 2026-04-07 3.5.6 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 x509v3_config \- X509 V3 certificate extension configuration format
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Several OpenSSL commands can add extensions to a certificate or
68 certificate request based on the contents of a configuration file
69 and CLI options such as \fB\-addext\fR.
70 The syntax of configuration files is described in \fBconfig\fR\|(5).
71 The commands typically have an option to specify the name of the configuration
72 file, and a section within that file; see the documentation of the
73 individual command for details.
74 .PP
75 This page uses \fBextensions\fR as the name of the section, when needed
76 in examples.
77 .PP
78 Each entry in the extension section takes the form:
79 .PP
80 .Vb 1
81 \& name = [critical, ]value(s)
82 .Ve
83 .PP
84 If \fBcritical\fR is present then the extension will be marked as critical.
85 .PP
86 If multiple entries are processed for the same extension name,
87 later entries override earlier ones with the same name.
88 .PP
89 The format of \fBvalues\fR depends on the value of \fBname\fR, many have a
90 type-value pairing where the type and value are separated by a colon.
91 There are four main types of extension:
92 .PP
93 .Vb 4
94 \& string
95 \& multi\-valued
96 \& raw
97 \& arbitrary
98 .Ve
99 .PP
100 Each is described in the following paragraphs.
101 .PP
102 String extensions simply have a string which contains either the value itself
103 or how it is obtained.
104 .PP
105 Multi-valued extensions have a short form and a long form. The short form
106 is a comma-separated list of names and values:
107 .PP
108 .Vb 1
109 \& basicConstraints = critical, CA:true, pathlen:1
110 .Ve
111 .PP
112 The long form allows the values to be placed in a separate section:
113 .PP
114 .Vb 2
115 \& [extensions]
116 \& basicConstraints = critical, @basic_constraints
117 \&
118 \& [basic_constraints]
119 \& CA = true
120 \& pathlen = 1
121 .Ve
122 .PP
123 Both forms are equivalent.
124 .PP
125 If an extension is multi-value and a field value must contain a comma the long
126 form must be used otherwise the comma would be misinterpreted as a field
127 separator. For example:
128 .PP
129 .Vb 1
130 \& subjectAltName = URI:ldap://somehost.com/CN=foo,OU=bar
131 .Ve
132 .PP
133 will produce an error but the equivalent form:
134 .PP
135 .Vb 2
136 \& [extensions]
137 \& subjectAltName = @subject_alt_section
138 \&
139 \& [subject_alt_section]
140 \& subjectAltName = URI:ldap://somehost.com/CN=foo,OU=bar
141 .Ve
142 .PP
143 is valid.
144 .PP
145 OpenSSL does not support multiple occurrences of the same field within a
146 section. In this example:
147 .PP
148 .Vb 2
149 \& [extensions]
150 \& subjectAltName = @alt_section
151 \&
152 \& [alt_section]
153 \& email = [email protected]
154 \& email = [email protected]
155 .Ve
156 .PP
157 will only recognize the last value. To specify multiple values append a
158 numeric identifier, as shown here:
159 .PP
160 .Vb 2
161 \& [extensions]
162 \& subjectAltName = @alt_section
163 \&
164 \& [alt_section]
165 \& email.1 = [email protected]
166 \& email.2 = [email protected]
167 .Ve
168 .PP
169 The syntax of raw extensions is defined by the source code that parses
170 the extension but should be documented.
171 See "Certificate Policies" for an example of a raw extension.
172 .PP
173 If an extension type is unsupported, then the \fIarbitrary\fR extension syntax
174 must be used, see the "ARBITRARY EXTENSIONS" section for more details.
175 .SH "STANDARD EXTENSIONS"
176 .IX Header "STANDARD EXTENSIONS"
177 The following sections describe the syntax of each supported extension.
178 They do not define the semantics of the extension.
179 .SS "Basic Constraints"
180 .IX Subsection "Basic Constraints"
181 This is a multi-valued extension which indicates whether a certificate is
182 a CA certificate. The first value is \fBCA\fR followed by \fBTRUE\fR or
183 \&\fBFALSE\fR. If \fBCA\fR is \fBTRUE\fR then an optional \fBpathlen\fR name followed by a
184 nonnegative value can be included.
185 .PP
186 For example:
187 .PP
188 .Vb 1
189 \& basicConstraints = CA:TRUE
190 \&
191 \& basicConstraints = CA:FALSE
192 \&
193 \& basicConstraints = critical, CA:TRUE, pathlen:1
194 .Ve
195 .PP
196 A CA certificate \fImust\fR include the \fBbasicConstraints\fR name with the \fBCA\fR
197 parameter set to \fBTRUE\fR. An end-user certificate must either have \fBCA:FALSE\fR
198 or omit the extension entirely.
199 The \fBpathlen\fR parameter specifies the maximum number of CAs that can appear
200 below this one in a chain. A \fBpathlen\fR of zero means the CA cannot sign
201 any sub-CA's, and can only sign end-entity certificates.
202 .SS "Key Usage"
203 .IX Subsection "Key Usage"
204 Key usage is a multi-valued extension consisting of a list of names of
205 the permitted key usages. The defined values are: \f(CW\*(C`digitalSignature\*(C'\fR,
206 \&\f(CW\*(C`nonRepudiation\*(C'\fR, \f(CW\*(C`keyEncipherment\*(C'\fR, \f(CW\*(C`dataEncipherment\*(C'\fR, \f(CW\*(C`keyAgreement\*(C'\fR,
207 \&\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.
208 .PP
209 Examples:
210 .PP
211 .Vb 1
212 \& keyUsage = digitalSignature, nonRepudiation
213 \&
214 \& keyUsage = critical, keyCertSign
215 .Ve
216 .SS "Extended Key Usage"
217 .IX Subsection "Extended Key Usage"
218 This extension consists of a list of values indicating purposes for which
219 the certificate public key can be used.
220 Each value can be either a short text name or an OID.
221 The following text names, and their intended meaning, are known:
222 .PP
223 .Vb 10
224 \& Value Meaning according to RFC 5280 etc.
225 \& \-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
226 \& serverAuth SSL/TLS WWW Server Authentication
227 \& clientAuth SSL/TLS WWW Client Authentication
228 \& codeSigning Code Signing
229 \& emailProtection E\-mail Protection (S/MIME)
230 \& timeStamping Trusted Timestamping
231 \& OCSPSigning OCSP Signing
232 \& ipsecIKE ipsec Internet Key Exchange
233 \& msCodeInd Microsoft Individual Code Signing (authenticode)
234 \& msCodeCom Microsoft Commercial Code Signing (authenticode)
235 \& msCTLSign Microsoft Trust List Signing
236 \& msEFS Microsoft Encrypted File System
237 .Ve
238 .PP
239 While IETF RFC 5280 says that \fBid-kp-serverAuth\fR and \fBid-kp-clientAuth\fR
240 are only for WWW use, in practice they are used for all kinds of TLS clients
241 and servers, and this is what OpenSSL assumes as well.
242 .PP
243 Examples:
244 .PP
245 .Vb 1
246 \& extendedKeyUsage = critical, codeSigning, 1.2.3.4
247 \&
248 \& extendedKeyUsage = serverAuth, clientAuth
249 .Ve
250 .SS "Subject Key Identifier"
251 .IX Subsection "Subject Key Identifier"
252 The SKID extension specification has a value with three choices.
253 .IP \fBnone\fR 4
254 .IX Item "none"
255 No SKID extension will be included.
256 .IP \fBhash\fR 4
257 .IX Item "hash"
258 The process specified in RFC 5280 section 4.2.1.2. (1) is followed:
259 The keyIdentifier is composed of the 160\-bit SHA\-1 hash of the value of the BIT
260 STRING subjectPublicKey (excluding the tag, length, and number of unused bits).
261 .ie n .IP "A hex string (possibly with "":"" separating bytes)" 4
262 .el .IP "A hex string (possibly with \f(CW:\fR separating bytes)" 4
263 .IX Item "A hex string (possibly with : separating bytes)"
264 The provided value is output directly.
265 This choice is strongly discouraged.
266 .PP
267 By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBhash\fR was given.
268 .PP
269 Example:
270 .PP
271 .Vb 1
272 \& subjectKeyIdentifier = hash
273 .Ve
274 .SS "Authority Key Identifier"
275 .IX Subsection "Authority Key Identifier"
276 The AKID extension specification may have the value \fBnone\fR
277 indicating that no AKID shall be included.
278 Otherwise it may have the value \fBkeyid\fR or \fBissuer\fR
279 or both of them, separated by \f(CW\*(C`,\*(C'\fR.
280 Either or both can have the option \fBalways\fR,
281 indicated by putting a colon \f(CW\*(C`:\*(C'\fR between the value and this option.
282 For self-signed certificates the AKID is suppressed unless \fBalways\fR is present.
283 .PP
284 By default the \fBx509\fR, \fBreq\fR, and \fBca\fR apps behave as if \fBnone\fR was given
285 for self-signed certificates and \fBkeyid\fR\f(CW\*(C`,\*(C'\fR \fBissuer\fR otherwise.
286 .PP
287 If \fBkeyid\fR is present, an attempt is made to
288 copy the subject key identifier (SKID) from the issuer certificate except if
289 the issuer certificate is the same as the current one and it is not self-signed.
290 The hash of the public key related to the signing key is taken as fallback
291 if the issuer certificate is the same as the current certificate.
292 If \fBalways\fR is present but no value can be obtained, an error is returned.
293 .PP
294 If \fBissuer\fR is present, and in addition it has the option \fBalways\fR specified
295 or \fBkeyid\fR is not present,
296 then the issuer DN and serial number are copied from the issuer certificate.
297 If this fails, an error is returned.
298 .PP
299 Examples:
300 .PP
301 .Vb 1
302 \& authorityKeyIdentifier = keyid, issuer
303 \&
304 \& authorityKeyIdentifier = keyid, issuer:always
305 .Ve
306 .SS "Subject Alternative Name"
307 .IX Subsection "Subject Alternative Name"
308 This is a multi-valued extension that supports several types of name
309 identifier, including
310 \&\fBemail\fR (an email address),
311 \&\fBURI\fR (a uniform resource indicator),
312 \&\fBDNS\fR (a DNS domain name),
313 \&\fBRID\fR (a registered ID: OBJECT IDENTIFIER),
314 \&\fBIP\fR (an IP address),
315 \&\fBdirName\fR (a distinguished name),
316 and \fBotherName\fR.
317 The syntax of each is described in the following paragraphs.
318 .PP
319 The \fBemail\fR option has two special values.
320 \&\f(CW\*(C`copy\*(C'\fR will automatically include any email addresses
321 contained in the certificate subject name in the extension.
322 \&\f(CW\*(C`move\*(C'\fR will automatically move any email addresses
323 from the certificate subject name to the extension.
324 .PP
325 The IP address used in the \fBIP\fR option can be in either IPv4 or IPv6 format.
326 .PP
327 The value of \fBdirName\fR is specifies the configuration section containing
328 the distinguished name to use, as a set of name-value pairs.
329 Multi-valued AVAs can be formed by prefacing the name with a \fB+\fR character.
330 .PP
331 The value of \fBotherName\fR can include arbitrary data associated with an OID;
332 the value should be the OID followed by a semicolon and the content in specified
333 using the syntax in \fBASN1_generate_nconf\fR\|(3).
334 .PP
335 Examples:
336 .PP
337 .Vb 1
338 \& subjectAltName = email:copy, email:[email protected], URI:http://my.example.com/
339 \&
340 \& subjectAltName = IP:192.168.7.1
341 \&
342 \& subjectAltName = IP:13::17
343 \&
344 \& subjectAltName = email:[email protected], RID:1.2.3.4
345 \&
346 \& subjectAltName = otherName:1.2.3.4;UTF8:some other identifier
347 \&
348 \& [extensions]
349 \& subjectAltName = dirName:dir_sect
350 \&
351 \& [dir_sect]
352 \& C = UK
353 \& O = My Organization
354 \& OU = My Unit
355 \& CN = My Name
356 .Ve
357 .PP
358 Non-ASCII Email Address conforming the syntax defined in Section 3.3 of RFC 6531
359 are provided as otherName.SmtpUTF8Mailbox. According to RFC 8398, the email
360 address should be provided as UTF8String. To enforce the valid representation in
361 the certificate, the SmtpUTF8Mailbox should be provided as follows
362 .PP
363 .Vb 3
364 \& subjectAltName=@alts
365 \& [alts]
366 \& otherName = 1.3.6.1.5.5.7.8.9;FORMAT:UTF8,UTF8String:nonasciiname.example.com
367 .Ve
368 .SS "Issuer Alternative Name"
369 .IX Subsection "Issuer Alternative Name"
370 This extension supports most of the options of subject alternative name;
371 it does not support \fBemail:copy\fR.
372 It also adds \fBissuer:copy\fR as an allowed value, which copies any subject
373 alternative names from the issuer certificate, if possible.
374 .PP
375 Example:
376 .PP
377 .Vb 1
378 \& issuerAltName = issuer:copy
379 .Ve
380 .SS "Authority Info Access"
381 .IX Subsection "Authority Info Access"
382 This extension gives details about how to retrieve information that
383 related to the certificate that the CA makes available. The syntax is
384 \&\fBaccess_id;location\fR, where \fBaccess_id\fR is an object identifier
385 (although only a few values are well-known) and \fBlocation\fR has the same
386 syntax as subject alternative name (except that \fBemail:copy\fR is not supported).
387 .PP
388 Possible values for access_id include \fBOCSP\fR (OCSP responder),
389 \&\fBcaIssuers\fR (CA Issuers),
390 \&\fBad_timestamping\fR (AD Time Stamping),
391 \&\fBAD_DVCS\fR (ad dvcs),
392 \&\fBcaRepository\fR (CA Repository).
393 .PP
394 Examples:
395 .PP
396 .Vb 1
397 \& authorityInfoAccess = OCSP;URI:http://ocsp.example.com/,caIssuers;URI:http://myca.example.com/ca.cer
398 \&
399 \& authorityInfoAccess = OCSP;URI:http://ocsp.example.com/
400 .Ve
401 .SS "CRL distribution points"
402 .IX Subsection "CRL distribution points"
403 This is a multi-valued extension whose values can be either a name-value
404 pair using the same form as subject alternative name or a single value
405 specifying the section name containing all the distribution point values.
406 .PP
407 When a name-value pair is used, a DistributionPoint extension will
408 be set with the given value as the fullName field as the distributionPoint
409 value, and the reasons and cRLIssuer fields will be omitted.
410 .PP
411 When a single option is used, the value specifies the section, and that
412 section can have the following items:
413 .IP fullname 4
414 .IX Item "fullname"
415 The full name of the distribution point, in the same format as the subject
416 alternative name.
417 .IP relativename 4
418 .IX Item "relativename"
419 The value is taken as a distinguished name fragment that is set as the
420 value of the nameRelativeToCRLIssuer field.
421 .IP CRLIssuer 4
422 .IX Item "CRLIssuer"
423 The value must in the same format as the subject alternative name.
424 .IP reasons 4
425 .IX Item "reasons"
426 A multi-value field that contains the reasons for revocation. The recognized
427 values are: \f(CW\*(C`keyCompromise\*(C'\fR, \f(CW\*(C`CACompromise\*(C'\fR, \f(CW\*(C`affiliationChanged\*(C'\fR,
428 \&\f(CW\*(C`superseded\*(C'\fR, \f(CW\*(C`cessationOfOperation\*(C'\fR, \f(CW\*(C`certificateHold\*(C'\fR,
429 \&\f(CW\*(C`privilegeWithdrawn\*(C'\fR, and \f(CW\*(C`AACompromise\*(C'\fR.
430 .PP
431 Only one of \fBfullname\fR or \fBrelativename\fR should be specified.
432 .PP
433 Simple examples:
434 .PP
435 .Vb 1
436 \& crlDistributionPoints = URI:http://example.com/myca.crl
437 \&
438 \& crlDistributionPoints = URI:http://example.com/myca.crl, URI:http://example.org/my.crl
439 .Ve
440 .PP
441 Full distribution point example:
442 .PP
443 .Vb 2
444 \& [extensions]
445 \& crlDistributionPoints = crldp1_section
446 \&
447 \& [crldp1_section]
448 \& fullname = URI:http://example.com/myca.crl
449 \& CRLissuer = dirName:issuer_sect
450 \& reasons = keyCompromise, CACompromise
451 \&
452 \& [issuer_sect]
453 \& C = UK
454 \& O = Organisation
455 \& CN = Some Name
456 .Ve
457 .SS "Issuing Distribution Point"
458 .IX Subsection "Issuing Distribution Point"
459 This extension should only appear in CRLs. It is a multi-valued extension
460 whose syntax is similar to the "section" pointed to by the CRL distribution
461 points extension. The following names have meaning:
462 .IP fullname 4
463 .IX Item "fullname"
464 The full name of the distribution point, in the same format as the subject
465 alternative name.
466 .IP relativename 4
467 .IX Item "relativename"
468 The value is taken as a distinguished name fragment that is set as the
469 value of the nameRelativeToCRLIssuer field.
470 .IP onlysomereasons 4
471 .IX Item "onlysomereasons"
472 A multi-value field that contains the reasons for revocation. The recognized
473 values are: \f(CW\*(C`keyCompromise\*(C'\fR, \f(CW\*(C`CACompromise\*(C'\fR, \f(CW\*(C`affiliationChanged\*(C'\fR,
474 \&\f(CW\*(C`superseded\*(C'\fR, \f(CW\*(C`cessationOfOperation\*(C'\fR, \f(CW\*(C`certificateHold\*(C'\fR,
475 \&\f(CW\*(C`privilegeWithdrawn\*(C'\fR, and \f(CW\*(C`AACompromise\*(C'\fR.
476 .IP "onlyuser, onlyCA, onlyAA, indirectCRL" 4
477 .IX Item "onlyuser, onlyCA, onlyAA, indirectCRL"
478 The value for each of these names is a boolean.
479 .PP
480 Example:
481 .PP
482 .Vb 2
483 \& [extensions]
484 \& issuingDistributionPoint = critical, @idp_section
485 \&
486 \& [idp_section]
487 \& fullname = URI:http://example.com/myca.crl
488 \& indirectCRL = TRUE
489 \& onlysomereasons = keyCompromise, CACompromise
490 .Ve
491 .SS "Certificate Policies"
492 .IX Subsection "Certificate Policies"
493 This is a \fIraw\fR extension that supports all of the defined fields of the
494 certificate extension.
495 .PP
496 Policies without qualifiers are specified by giving the OID.
497 Multiple policies are comma-separated. For example:
498 .PP
499 .Vb 1
500 \& certificatePolicies = 1.2.4.5, 1.1.3.4
501 .Ve
502 .PP
503 To include policy qualifiers, use the "@section" syntax to point to a
504 section that specifies all the information.
505 .PP
506 The section referred to must include the policy OID using the name
507 \&\fBpolicyIdentifier\fR. cPSuri qualifiers can be included using the syntax:
508 .PP
509 .Vb 1
510 \& CPS.nnn = value
511 .Ve
512 .PP
513 where \f(CW\*(C`nnn\*(C'\fR is a number.
514 .PP
515 userNotice qualifiers can be set using the syntax:
516 .PP
517 .Vb 1
518 \& userNotice.nnn = @notice
519 .Ve
520 .PP
521 The value of the userNotice qualifier is specified in the relevant section.
522 This section can include \fBexplicitText\fR, \fBorganization\fR, and \fBnoticeNumbers\fR
523 options. explicitText and organization are text strings, noticeNumbers is a
524 comma separated list of numbers. The organization and noticeNumbers options
525 (if included) must BOTH be present. Some software might require
526 the \fBia5org\fR option at the top level; this changes the encoding from
527 Displaytext to IA5String.
528 .PP
529 Example:
530 .PP
531 .Vb 2
532 \& [extensions]
533 \& certificatePolicies = ia5org, 1.2.3.4, 1.5.6.7.8, @polsect
534 \&
535 \& [polsect]
536 \& policyIdentifier = 1.3.5.8
537 \& CPS.1 = "http://my.host.example.com/"
538 \& CPS.2 = "http://my.your.example.com/"
539 \& userNotice.1 = @notice
540 \&
541 \& [notice]
542 \& explicitText = "Explicit Text Here"
543 \& organization = "Organisation Name"
544 \& noticeNumbers = 1, 2, 3, 4
545 .Ve
546 .PP
547 The character encoding of explicitText can be specified by prefixing the
548 value with \fBUTF8\fR, \fBBMP\fR, or \fBVISIBLE\fR followed by colon. For example:
549 .PP
550 .Vb 2
551 \& [notice]
552 \& explicitText = "UTF8:Explicit Text Here"
553 .Ve
554 .SS "Policy Constraints"
555 .IX Subsection "Policy Constraints"
556 This is a multi-valued extension which consisting of the names
557 \&\fBrequireExplicitPolicy\fR or \fBinhibitPolicyMapping\fR and a non negative integer
558 value. At least one component must be present.
559 .PP
560 Example:
561 .PP
562 .Vb 1
563 \& policyConstraints = requireExplicitPolicy:3
564 .Ve
565 .SS "Inhibit Any Policy"
566 .IX Subsection "Inhibit Any Policy"
567 This is a string extension whose value must be a non negative integer.
568 .PP
569 Example:
570 .PP
571 .Vb 1
572 \& inhibitAnyPolicy = 2
573 .Ve
574 .SS "Name Constraints"
575 .IX Subsection "Name Constraints"
576 This is a multi-valued extension. The name should
577 begin with the word \fBpermitted\fR or \fBexcluded\fR followed by a \fB;\fR. The rest of
578 the name and the value follows the syntax of subjectAltName except
579 \&\fBemail:copy\fR
580 is not supported and the \fBIP\fR form should consist of an IP addresses and
581 subnet mask separated by a \fB/\fR.
582 .PP
583 Examples:
584 .PP
585 .Vb 1
586 \& nameConstraints = permitted;IP:192.168.0.0/255.255.0.0
587 \&
588 \& nameConstraints = permitted;email:.example.com
589 \&
590 \& nameConstraints = excluded;email:.com
591 .Ve
592 .SS "OCSP No Check"
593 .IX Subsection "OCSP No Check"
594 This is a string extension. It is parsed, but ignored.
595 .PP
596 Example:
597 .PP
598 .Vb 1
599 \& noCheck = ignored
600 .Ve
601 .SS "TLS Feature (aka Must Staple)"
602 .IX Subsection "TLS Feature (aka Must Staple)"
603 This is a multi-valued extension consisting of a list of TLS extension
604 identifiers. Each identifier may be a number (0..65535) or a supported name.
605 When a TLS client sends a listed extension, the TLS server is expected to
606 include that extension in its reply.
607 .PP
608 The supported names are: \fBstatus_request\fR and \fBstatus_request_v2\fR.
609 .PP
610 Example:
611 .PP
612 .Vb 1
613 \& tlsfeature = status_request
614 .Ve
615 .SH "DEPRECATED EXTENSIONS"
616 .IX Header "DEPRECATED EXTENSIONS"
617 The following extensions are non standard, Netscape specific and largely
618 obsolete. Their use in new applications is discouraged.
619 .SS "Netscape String extensions"
620 .IX Subsection "Netscape String extensions"
621 Netscape Comment (\fBnsComment\fR) is a string extension containing a comment
622 which will be displayed when the certificate is viewed in some browsers.
623 Other extensions of this type are: \fBnsBaseUrl\fR,
624 \&\fBnsRevocationUrl\fR, \fBnsCaRevocationUrl\fR, \fBnsRenewalUrl\fR, \fBnsCaPolicyUrl\fR
625 and \fBnsSslServerName\fR.
626 .SS "Netscape Certificate Type"
627 .IX Subsection "Netscape Certificate Type"
628 This is a multi-valued extensions which consists of a list of flags to be
629 included. It was used to indicate the purposes for which a certificate could
630 be used. The basicConstraints, keyUsage and extended key usage extensions are
631 now used instead.
632 .PP
633 Acceptable values for nsCertType are: \fBclient\fR, \fBserver\fR, \fBemail\fR,
634 \&\fBobjsign\fR, \fBreserved\fR, \fBsslCA\fR, \fBemailCA\fR, \fBobjCA\fR.
635 .SH "ARBITRARY EXTENSIONS"
636 .IX Header "ARBITRARY EXTENSIONS"
637 If an extension is not supported by the OpenSSL code then it must be encoded
638 using the arbitrary extension format. It is also possible to use the arbitrary
639 format for supported extensions. Extreme care should be taken to ensure that
640 the data is formatted correctly for the given extension type.
641 .PP
642 There are two ways to encode arbitrary extensions.
643 .PP
644 The first way is to use the word ASN1 followed by the extension content
645 using the same syntax as \fBASN1_generate_nconf\fR\|(3).
646 For example:
647 .PP
648 .Vb 3
649 \& [extensions]
650 \& 1.2.3.4 = critical, ASN1:UTF8String:Some random data
651 \& 1.2.3.4.1 = ASN1:SEQUENCE:seq_sect
652 \&
653 \& [seq_sect]
654 \& field1 = UTF8:field1
655 \& field2 = UTF8:field2
656 .Ve
657 .PP
658 It is also possible to use the word DER to include the raw encoded data in any
659 extension.
660 .PP
661 .Vb 2
662 \& 1.2.3.4 = critical, DER:01:02:03:04
663 \& 1.2.3.4.1 = DER:01020304
664 .Ve
665 .PP
666 The value following DER is a hex dump of the DER encoding of the extension
667 Any extension can be placed in this form to override the default behaviour.
668 For example:
669 .PP
670 .Vb 1
671 \& basicConstraints = critical, DER:00:01:02:03
672 .Ve
673 .SH WARNINGS
674 .IX Header "WARNINGS"
675 There is no guarantee that a specific implementation will process a given
676 extension. It may therefore be sometimes possible to use certificates for
677 purposes prohibited by their extensions because a specific application does
678 not recognize or honour the values of the relevant extensions.
679 .PP
680 The DER and ASN1 options should be used with caution. It is possible to create
681 invalid extensions if they are not used carefully.
682 .SH "SEE ALSO"
683 .IX Header "SEE ALSO"
684 \&\fBopenssl\-req\fR\|(1), \fBopenssl\-ca\fR\|(1), \fBopenssl\-x509\fR\|(1),
685 \&\fBASN1_generate_nconf\fR\|(3)
686 .SH COPYRIGHT
687 .IX Header "COPYRIGHT"
688 Copyright 2004\-2023 The OpenSSL Project Authors. All Rights Reserved.
689 .PP
690 Licensed under the Apache License 2.0 (the "License"). You may not use
691 this file except in compliance with the License. You can obtain a copy
692 in the file LICENSE in the source distribution or at
693 <https://www.openssl.org/source/license.html>.