x509v3_config.5 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704
  1. .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  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<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  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
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  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.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  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
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  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'
  105. .\}
  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 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "X509V3_CONFIG 5"
  136. .TH X509V3_CONFIG 5 "2022-03-15" "1.1.1n" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. x509v3_config \- X509 V3 certificate extension configuration format
  143. .SH "DESCRIPTION"
  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.
  147. .PP
  148. Typically the application will contain an option to point to an extension
  149. section. Each line of the extension section takes the form:
  150. .PP
  151. .Vb 1
  152. \& extension_name=[critical,] extension_options
  153. .Ve
  154. .PP
  155. If \fBcritical\fR is present then the extension will be critical.
  156. .PP
  157. The format of \fBextension_options\fR depends on the value of \fBextension_name\fR.
  158. .PP
  159. There are four main types of extension: \fIstring\fR extensions, \fImulti-valued\fR
  160. extensions, \fIraw\fR and \fIarbitrary\fR extensions.
  161. .PP
  162. String extensions simply have a string which contains either the value itself
  163. or how it is obtained.
  164. .PP
  165. For example:
  166. .PP
  167. .Vb 1
  168. \& nsComment="This is a Comment"
  169. .Ve
  170. .PP
  171. Multi-valued extensions have a short form and a long form. The short form
  172. is a list of names and values:
  173. .PP
  174. .Vb 1
  175. \& basicConstraints=critical,CA:true,pathlen:1
  176. .Ve
  177. .PP
  178. The long form allows the values to be placed in a separate section:
  179. .PP
  180. .Vb 1
  181. \& basicConstraints=critical,@bs_section
  182. \&
  183. \& [bs_section]
  184. \&
  185. \& CA=true
  186. \& pathlen=1
  187. .Ve
  188. .PP
  189. Both forms are equivalent.
  190. .PP
  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.
  195. .PP
  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.
  207. .PP
  208. For example:
  209. .PP
  210. .Vb 1
  211. \& basicConstraints=CA:TRUE
  212. \&
  213. \& basicConstraints=CA:FALSE
  214. \&
  215. \& basicConstraints=critical,CA:TRUE, pathlen:0
  216. .Ve
  217. .PP
  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.
  222. .PP
  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.
  226. .SS "Key Usage."
  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.
  230. .PP
  231. The supported names are: digitalSignature, nonRepudiation, keyEncipherment,
  232. dataEncipherment, keyAgreement, keyCertSign, cRLSign, encipherOnly
  233. and decipherOnly.
  234. .PP
  235. Examples:
  236. .PP
  237. .Vb 1
  238. \& keyUsage=digitalSignature, nonRepudiation
  239. \&
  240. \& keyUsage=critical, keyCertSign
  241. .Ve
  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,
  246. .PP
  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:
  250. .PP
  251. .Vb 10
  252. \& Value Meaning
  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
  265. .Ve
  266. .PP
  267. Examples:
  268. .PP
  269. .Vb 2
  270. \& extendedKeyUsage=critical,codeSigning,1.2.3.4
  271. \& extendedKeyUsage=serverAuth,clientAuth
  272. .Ve
  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.
  279. .PP
  280. Example:
  281. .PP
  282. .Vb 1
  283. \& subjectKeyIdentifier=hash
  284. .Ve
  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".
  289. .PP
  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.
  293. .PP
  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.
  297. .PP
  298. Example:
  299. .PP
  300. .Vb 1
  301. \& authorityKeyIdentifier=keyid,issuer
  302. .Ve
  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.
  310. .PP
  311. The email option include a special 'copy' value. This will automatically
  312. include any email addresses contained in the certificate subject name in
  313. the extension.
  314. .PP
  315. The \s-1IP\s0 address used in the \fB\s-1IP\s0\fR options can be in either IPv4 or IPv6 format.
  316. .PP
  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.
  320. .PP
  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.
  324. .PP
  325. Examples:
  326. .PP
  327. .Vb 5
  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
  333. \&
  334. \& subjectAltName=dirName:dir_sect
  335. \&
  336. \& [dir_sect]
  337. \& C=UK
  338. \& O=My Organization
  339. \& OU=My Unit
  340. \& CN=My Name
  341. .Ve
  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).
  349. .PP
  350. Example:
  351. .PP
  352. .Vb 1
  353. \& issuerAltName = issuer:copy
  354. .Ve
  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.
  362. .PP
  363. Example:
  364. .PP
  365. .Vb 2
  366. \& authorityInfoAccess = OCSP;URI:http://ocsp.my.host/
  367. \& authorityInfoAccess = caIssuers;URI:http://my.ca/ca.html
  368. .Ve
  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.
  374. .PP
  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.
  377. .PP
  378. In the single option case the section indicated contains values for each
  379. field. In this section:
  380. .PP
  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.
  383. .PP
  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.
  386. .PP
  387. The name \*(L"CRLIssuer\*(R" if present should contain a value for this field in
  388. subject alternative name format.
  389. .PP
  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".
  394. .PP
  395. Simple examples:
  396. .PP
  397. .Vb 2
  398. \& crlDistributionPoints=URI:http://myhost.com/myca.crl
  399. \& crlDistributionPoints=URI:http://my.com/my.crl,URI:http://oth.com/my.crl
  400. .Ve
  401. .PP
  402. Full distribution point example:
  403. .PP
  404. .Vb 1
  405. \& crlDistributionPoints=crldp1_section
  406. \&
  407. \& [crldp1_section]
  408. \&
  409. \& fullname=URI:http://myhost.com/myca.crl
  410. \& CRLissuer=dirName:issuer_sect
  411. \& reasons=keyCompromise, CACompromise
  412. \&
  413. \& [issuer_sect]
  414. \& C=UK
  415. \& O=Organisation
  416. \& CN=Some Name
  417. .Ve
  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.
  423. .PP
  424. The names \*(L"reasons\*(R" and \*(L"CRLissuer\*(R" are not recognized.
  425. .PP
  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.
  428. .PP
  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.
  432. .PP
  433. Example:
  434. .PP
  435. .Vb 1
  436. \& issuingDistributionPoint=critical, @idp_section
  437. \&
  438. \& [idp_section]
  439. \&
  440. \& fullname=URI:http://myhost.com/myca.crl
  441. \& indirectCRL=TRUE
  442. \& onlysomereasons=keyCompromise, CACompromise
  443. \&
  444. \& [issuer_sect]
  445. \& C=UK
  446. \& O=Organisation
  447. \& CN=Some Name
  448. .Ve
  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.
  453. .PP
  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,
  456. for example:
  457. .PP
  458. .Vb 1
  459. \& certificatePolicies= 1.2.4.5, 1.1.3.4
  460. .Ve
  461. .PP
  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.
  465. .PP
  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:
  468. .PP
  469. .Vb 1
  470. \& CPS.nnn=value
  471. .Ve
  472. .PP
  473. userNotice qualifiers can be set using the syntax:
  474. .PP
  475. .Vb 1
  476. \& userNotice.nnn=@notice
  477. .Ve
  478. .PP
  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.
  486. .PP
  487. Example:
  488. .PP
  489. .Vb 1
  490. \& certificatePolicies=ia5org,1.2.3.4,1.5.6.7.8,@polsect
  491. \&
  492. \& [polsect]
  493. \&
  494. \& policyIdentifier = 1.3.5.8
  495. \& CPS.1="http://my.host.name/"
  496. \& CPS.2="http://my.your.name/"
  497. \& userNotice.1=@notice
  498. \&
  499. \& [notice]
  500. \&
  501. \& explicitText="Explicit Text Here"
  502. \& organization="Organisation Name"
  503. \& noticeNumbers=1,2,3,4
  504. .Ve
  505. .PP
  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.
  509. .PP
  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:
  512. .PP
  513. .Vb 2
  514. \& [notice]
  515. \& explicitText="UTF8:Explicit Text Here"
  516. .Ve
  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.
  522. .PP
  523. Example:
  524. .PP
  525. .Vb 1
  526. \& policyConstraints = requireExplicitPolicy:3
  527. .Ve
  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.
  531. .PP
  532. Example:
  533. .PP
  534. .Vb 1
  535. \& inhibitAnyPolicy = 2
  536. .Ve
  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.
  544. .PP
  545. Examples:
  546. .PP
  547. .Vb 1
  548. \& nameConstraints=permitted;IP:192.168.0.0/255.255.0.0
  549. \&
  550. \& nameConstraints=permitted;email:.somedomain.com
  551. \&
  552. \& nameConstraints=excluded;email:.com
  553. .Ve
  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.
  557. .PP
  558. Example:
  559. .PP
  560. .Vb 1
  561. \& noCheck = ignored
  562. .Ve
  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.
  569. .PP
  570. The supported names are: \fBstatus_request\fR and \fBstatus_request_v2\fR.
  571. .PP
  572. Example:
  573. .PP
  574. .Vb 1
  575. \& tlsfeature = status_request
  576. .Ve
  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.
  585. .PP
  586. Example:
  587. .PP
  588. .Vb 1
  589. \& nsComment = "Some Random Comment"
  590. .Ve
  591. .PP
  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
  600. now used instead.
  601. .PP
  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.
  610. .PP
  611. There are two ways to encode arbitrary extensions.
  612. .PP
  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).
  615. For example:
  616. .PP
  617. .Vb 1
  618. \& 1.2.3.4=critical,ASN1:UTF8String:Some random data
  619. \&
  620. \& 1.2.3.4=ASN1:SEQUENCE:seq_sect
  621. \&
  622. \& [seq_sect]
  623. \&
  624. \& field1 = UTF8:field1
  625. \& field2 = UTF8:field2
  626. .Ve
  627. .PP
  628. It is also possible to use the word \s-1DER\s0 to include the raw encoded data in any
  629. extension.
  630. .PP
  631. .Vb 2
  632. \& 1.2.3.4=critical,DER:01:02:03:04
  633. \& 1.2.3.4=DER:01020304
  634. .Ve
  635. .PP
  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.
  638. For example:
  639. .PP
  640. .Vb 1
  641. \& basicConstraints=critical,DER:00:01:02:03
  642. .Ve
  643. .SH "WARNINGS"
  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.
  649. .PP
  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.
  652. .SH "NOTES"
  653. .IX Header "NOTES"
  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:
  657. .PP
  658. .Vb 1
  659. \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
  660. .Ve
  661. .PP
  662. will produce an error but the equivalent form:
  663. .PP
  664. .Vb 1
  665. \& subjectAltName=@subject_alt_section
  666. \&
  667. \& [subject_alt_section]
  668. \& subjectAltName=URI:ldap://somehost.com/CN=foo,OU=bar
  669. .Ve
  670. .PP
  671. is valid.
  672. .PP
  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:
  675. .PP
  676. .Vb 1
  677. \& subjectAltName=@alt_section
  678. \&
  679. \& [alt_section]
  680. \&
  681. \& email=steve@here
  682. \& email=steve@there
  683. .Ve
  684. .PP
  685. will only recognize the last value. This can be worked around by using the form:
  686. .PP
  687. .Vb 1
  688. \& [alt_section]
  689. \&
  690. \& email.1=steve@here
  691. \& email.2=steve@there
  692. .Ve
  693. .SH "SEE ALSO"
  694. .IX Header "SEE ALSO"
  695. \&\fBreq\fR\|(1), \fBca\fR\|(1), \fBx509\fR\|(1),
  696. \&\fBASN1_generate_nconf\fR\|(3)
  697. .SH "COPYRIGHT"
  698. .IX Header "COPYRIGHT"
  699. Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
  700. .PP
  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>.