openssl-ca.pod.in 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-ca - sample minimal CA application
  5. =head1 SYNOPSIS
  6. B<openssl> B<ca>
  7. [B<-help>]
  8. [B<-verbose>]
  9. [B<-quiet>]
  10. [B<-config> I<filename>]
  11. [B<-name> I<section>]
  12. [B<-section> I<section>]
  13. [B<-gencrl>]
  14. [B<-revoke> I<file>]
  15. [B<-valid> I<file>]
  16. [B<-status> I<serial>]
  17. [B<-updatedb>]
  18. [B<-crl_reason> I<reason>]
  19. [B<-crl_hold> I<instruction>]
  20. [B<-crl_compromise> I<time>]
  21. [B<-crl_CA_compromise> I<time>]
  22. [B<-crl_lastupdate> I<date>]
  23. [B<-crl_nextupdate> I<date>]
  24. [B<-crldays> I<days>]
  25. [B<-crlhours> I<hours>]
  26. [B<-crlsec> I<seconds>]
  27. [B<-crlexts> I<section>]
  28. [B<-startdate> I<date>]
  29. [B<-not_before> I<date>]
  30. [B<-enddate> I<date>]
  31. [B<-not_after> I<date>]
  32. [B<-days> I<arg>]
  33. [B<-md> I<arg>]
  34. [B<-policy> I<arg>]
  35. [B<-keyfile> I<filename>|I<uri>]
  36. [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  37. [B<-key> I<arg>]
  38. [B<-passin> I<arg>]
  39. [B<-cert> I<file>]
  40. [B<-certform> B<DER>|B<PEM>|B<P12>]
  41. [B<-selfsign>]
  42. [B<-in> I<file>]
  43. [B<-inform> B<DER>|<PEM>]
  44. [B<-out> I<file>]
  45. [B<-notext>]
  46. [B<-dateopt>]
  47. [B<-outdir> I<dir>]
  48. [B<-infiles>]
  49. [B<-spkac> I<file>]
  50. [B<-ss_cert> I<file>]
  51. [B<-preserveDN>]
  52. [B<-noemailDN>]
  53. [B<-batch>]
  54. [B<-msie_hack>]
  55. [B<-extensions> I<section>]
  56. [B<-extfile> I<section>]
  57. [B<-subj> I<arg>]
  58. [B<-utf8>]
  59. [B<-sigopt> I<nm>:I<v>]
  60. [B<-vfyopt> I<nm>:I<v>]
  61. [B<-create_serial>]
  62. [B<-rand_serial>]
  63. [B<-multivalue-rdn>]
  64. {- $OpenSSL::safe::opt_r_synopsis -}
  65. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  66. [I<certreq>...]
  67. =head1 DESCRIPTION
  68. This command emulates a CA application.
  69. See the B<WARNINGS> especially when considering to use it productively.
  70. It generates certificates bearing X.509 version 3.
  71. Unless specified otherwise,
  72. key identifier extensions are included as described in L<x509v3_config(5)>.
  73. It can be used to sign certificate requests (CSRs) in a variety of forms
  74. and generate certificate revocation lists (CRLs).
  75. It also maintains a text database of issued certificates and their status.
  76. When signing certificates, a single request can be specified
  77. with the B<-in> option, or multiple requests can be processed by
  78. specifying a set of B<certreq> files after all options.
  79. Note that there are also very lean ways of generating certificates:
  80. the B<req> and B<x509> commands can be used for directly creating certificates.
  81. See L<openssl-req(1)> and L<openssl-x509(1)> for details.
  82. The descriptions of the B<ca> command options are divided into each purpose.
  83. =head1 OPTIONS
  84. =over 4
  85. =item B<-help>
  86. Print out a usage message.
  87. =item B<-verbose>
  88. This prints extra details about the operations being performed.
  89. =item B<-quiet>
  90. This prints fewer details about the operations being performed, which may
  91. be handy during batch scripts or pipelines.
  92. =item B<-config> I<filename>
  93. Specifies the configuration file to use.
  94. Optional; for a description of the default value,
  95. see L<openssl(1)/COMMAND SUMMARY>.
  96. =item B<-name> I<section>, B<-section> I<section>
  97. Specifies the configuration file section to use (overrides
  98. B<default_ca> in the B<ca> section).
  99. =item B<-in> I<filename>
  100. An input filename containing a single certificate request (CSR) to be
  101. signed by the CA.
  102. =item B<-inform> B<DER>|B<PEM>
  103. The format to use when loading certificate request (CSR) input files;
  104. by default PEM is tried first.
  105. See L<openssl-format-options(1)> for details.
  106. =item B<-ss_cert> I<filename>
  107. A single self-signed certificate to be signed by the CA.
  108. =item B<-spkac> I<filename>
  109. A file containing a single Netscape signed public key and challenge
  110. and additional field values to be signed by the CA. See the B<SPKAC FORMAT>
  111. section for information on the required input and output format.
  112. =item B<-infiles>
  113. If present this should be the last option, all subsequent arguments
  114. are taken as the names of files containing certificate requests.
  115. =item B<-out> I<filename>
  116. The output file to output certificates to. The default is standard
  117. output. The certificate details will also be printed out to this
  118. file in PEM format (except that B<-spkac> outputs DER format).
  119. =item B<-outdir> I<directory>
  120. The directory to output certificates to. The certificate will be
  121. written to a filename consisting of the serial number in hex with
  122. F<.pem> appended.
  123. =item B<-cert> I<filename>
  124. The CA certificate, which must match with B<-keyfile>.
  125. =item B<-certform> B<DER>|B<PEM>|B<P12>
  126. The format of the data in certificate input files; unspecified by default.
  127. See L<openssl-format-options(1)> for details.
  128. =item B<-keyfile> I<filename>|I<uri>
  129. The CA private key to sign certificate requests with.
  130. This must match with B<-cert>.
  131. =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  132. The format of the private key input file; unspecified by default.
  133. See L<openssl-format-options(1)> for details.
  134. =item B<-sigopt> I<nm>:I<v>
  135. Pass options to the signature algorithm during sign operations.
  136. Names and values of these options are algorithm-specific.
  137. =item B<-vfyopt> I<nm>:I<v>
  138. Pass options to the signature algorithm during verify operations.
  139. Names and values of these options are algorithm-specific.
  140. This often needs to be given while signing too, because the self-signature of
  141. a certificate signing request (CSR) is verified against the included public key,
  142. and that verification may need its own set of options.
  143. =item B<-key> I<password>
  144. =for openssl foreign manual ps(1)
  145. The password used to encrypt the private key. Since on some
  146. systems the command line arguments are visible (e.g., when using
  147. L<ps(1)> on Unix),
  148. this option should be used with caution.
  149. Better use B<-passin>.
  150. =item B<-passin> I<arg>
  151. The key password source for key files and certificate PKCS#12 files.
  152. For more information about the format of B<arg>
  153. see L<openssl-passphrase-options(1)>.
  154. =item B<-selfsign>
  155. Indicates the issued certificates are to be signed with the key
  156. the certificate requests were signed with (given with B<-keyfile>).
  157. Certificate requests signed with a different key are ignored.
  158. If B<-spkac>, B<-ss_cert> or B<-gencrl> are given, B<-selfsign> is ignored.
  159. A consequence of using B<-selfsign> is that the self-signed
  160. certificate appears among the entries in the certificate database
  161. (see the configuration option B<database>), and uses the same
  162. serial number counter as all other certificates sign with the
  163. self-signed certificate.
  164. =item B<-notext>
  165. Don't output the text form of a certificate to the output file.
  166. =item B<-dateopt>
  167. Specify the date output format. Values are: rfc_822 and iso_8601.
  168. Defaults to rfc_822.
  169. =item B<-startdate> I<date>, B<-not_before> I<date>
  170. This allows the start date to be explicitly set. The format of the
  171. date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
  172. YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
  173. both formats, seconds SS and timezone Z must be present.
  174. Alternatively, you can also use "today".
  175. =item B<-enddate> I<date>, B<-not_after> I<date>
  176. This allows the expiry date to be explicitly set. The format of the
  177. date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
  178. YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
  179. both formats, seconds SS and timezone Z must be present.
  180. Alternatively, you can also use "today".
  181. This overrides the B<-days> option.
  182. =item B<-days> I<arg>
  183. The number of days from today to certify the certificate for.
  184. Regardless of the option B<-not_before>, the days are always counted from
  185. today.
  186. When used together with the option B<-not_after>/B<-startdate>, the explicit
  187. expiry date takes precedence.
  188. =item B<-md> I<alg>
  189. The message digest to use.
  190. Any digest supported by the L<openssl-dgst(1)> command can be used. For signing
  191. algorithms that do not support a digest (i.e. Ed25519 and Ed448) any message
  192. digest that is set is ignored. This option also applies to CRLs.
  193. =item B<-policy> I<arg>
  194. This option defines the CA "policy" to use. This is a section in
  195. the configuration file which decides which fields should be mandatory
  196. or match the CA certificate. Check out the B<POLICY FORMAT> section
  197. for more information.
  198. =item B<-msie_hack>
  199. This is a deprecated option to make this command work with very old versions
  200. of the IE certificate enrollment control "certenr3". It used UniversalStrings
  201. for almost everything. Since the old control has various security bugs
  202. its use is strongly discouraged.
  203. =item B<-preserveDN>
  204. Normally the DN order of a certificate is the same as the order of the
  205. fields in the relevant policy section. When this option is set the order
  206. is the same as the request. This is largely for compatibility with the
  207. older IE enrollment control which would only accept certificates if their
  208. DNs match the order of the request. This is not needed for Xenroll.
  209. =item B<-noemailDN>
  210. The DN of a certificate can contain the EMAIL field if present in the
  211. request DN, however, it is good policy just having the e-mail set into
  212. the altName extension of the certificate. When this option is set the
  213. EMAIL field is removed from the certificate' subject and set only in
  214. the, eventually present, extensions. The B<email_in_dn> keyword can be
  215. used in the configuration file to enable this behaviour.
  216. =item B<-batch>
  217. This sets the batch mode. In this mode no questions will be asked
  218. and all certificates will be certified automatically.
  219. =item B<-extensions> I<section>
  220. The section of the configuration file containing certificate extensions
  221. to be added when a certificate is issued (defaults to B<x509_extensions>
  222. unless the B<-extfile> option is used).
  223. See the L<x509v3_config(5)> manual page for details of the
  224. extension section format.
  225. =item B<-extfile> I<file>
  226. An additional configuration file to read certificate extensions from
  227. (using the default section unless the B<-extensions> option is also
  228. used).
  229. =item B<-subj> I<arg>
  230. Supersedes subject name given in the request.
  231. The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
  232. Special characters may be escaped by C<\> (backslash), whitespace is retained.
  233. Empty values are permitted, but the corresponding type will not be included
  234. in the resulting certificate.
  235. Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
  236. Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
  237. between the AttributeValueAssertions (AVAs) that specify the members of the set.
  238. Example:
  239. C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
  240. =item B<-utf8>
  241. This option causes field values to be interpreted as UTF8 strings, by
  242. default they are interpreted as ASCII. This means that the field
  243. values, whether prompted from a terminal or obtained from a
  244. configuration file, must be valid UTF8 strings.
  245. =item B<-create_serial>
  246. If reading serial from the text file as specified in the configuration
  247. fails, specifying this option creates a new random serial to be used as next
  248. serial number.
  249. To get random serial numbers, use the B<-rand_serial> flag instead; this
  250. should only be used for simple error-recovery.
  251. =item B<-rand_serial>
  252. Generate a large random number to use as the serial number.
  253. This overrides any option or configuration to use a serial number file.
  254. =item B<-multivalue-rdn>
  255. This option has been deprecated and has no effect.
  256. {- $OpenSSL::safe::opt_r_item -}
  257. {- $OpenSSL::safe::opt_engine_item -}
  258. {- $OpenSSL::safe::opt_provider_item -}
  259. =back
  260. =head1 CRL OPTIONS
  261. =over 4
  262. =item B<-gencrl>
  263. This option generates a CRL based on information in the index file.
  264. =item B<-crl_lastupdate> I<time>
  265. Allows the value of the CRL's lastUpdate field to be explicitly set; if
  266. this option is not present, the current time is used. Accepts times in
  267. YYMMDDHHMMSSZ format (the same as an ASN1 UTCTime structure) or
  268. YYYYMMDDHHMMSSZ format (the same as an ASN1 GeneralizedTime structure).
  269. =item B<-crl_nextupdate> I<time>
  270. Allows the value of the CRL's nextUpdate field to be explicitly set; if
  271. this option is present, any values given for B<-crldays>, B<-crlhours>
  272. and B<-crlsec> are ignored. Accepts times in the same formats as
  273. B<-crl_lastupdate>.
  274. =item B<-crldays> I<num>
  275. The number of days before the next CRL is due. That is the days from
  276. now to place in the CRL nextUpdate field.
  277. =item B<-crlhours> I<num>
  278. The number of hours before the next CRL is due.
  279. =item B<-crlsec> I<num>
  280. The number of seconds before the next CRL is due.
  281. =item B<-revoke> I<filename>
  282. A filename containing a certificate to revoke.
  283. =item B<-valid> I<filename>
  284. A filename containing a certificate to add a Valid certificate entry.
  285. =item B<-status> I<serial>
  286. Displays the revocation status of the certificate with the specified
  287. serial number and exits.
  288. =item B<-updatedb>
  289. Updates the database index to purge expired certificates.
  290. =item B<-crl_reason> I<reason>
  291. Revocation reason, where I<reason> is one of: B<unspecified>, B<keyCompromise>,
  292. B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>,
  293. B<certificateHold> or B<removeFromCRL>. The matching of I<reason> is case
  294. insensitive. Setting any revocation reason will make the CRL v2.
  295. In practice B<removeFromCRL> is not particularly useful because it is only used
  296. in delta CRLs which are not currently implemented.
  297. =item B<-crl_hold> I<instruction>
  298. This sets the CRL revocation reason code to B<certificateHold> and the hold
  299. instruction to I<instruction> which must be an OID. Although any OID can be
  300. used only B<holdInstructionNone> (the use of which is discouraged by RFC2459)
  301. B<holdInstructionCallIssuer> or B<holdInstructionReject> will normally be used.
  302. =item B<-crl_compromise> I<time>
  303. This sets the revocation reason to B<keyCompromise> and the compromise time to
  304. I<time>. I<time> should be in GeneralizedTime format that is I<YYYYMMDDHHMMSSZ>.
  305. =item B<-crl_CA_compromise> I<time>
  306. This is the same as B<crl_compromise> except the revocation reason is set to
  307. B<CACompromise>.
  308. =item B<-crlexts> I<section>
  309. The section of the configuration file containing CRL extensions to
  310. include. If no CRL extension section is present then a V1 CRL is
  311. created, if the CRL extension section is present (even if it is
  312. empty) then a V2 CRL is created. The CRL extensions specified are
  313. CRL extensions and B<not> CRL entry extensions. It should be noted
  314. that some software (for example Netscape) can't handle V2 CRLs. See
  315. L<x509v3_config(5)> manual page for details of the
  316. extension section format.
  317. =back
  318. =head1 CONFIGURATION FILE OPTIONS
  319. The section of the configuration file containing options for this command
  320. is found as follows: If the B<-name> command line option is used,
  321. then it names the section to be used. Otherwise the section to
  322. be used must be named in the B<default_ca> option of the B<ca> section
  323. of the configuration file (or in the default section of the
  324. configuration file). Besides B<default_ca>, the following options are
  325. read directly from the B<ca> section:
  326. RANDFILE
  327. preserve
  328. msie_hack
  329. With the exception of B<RANDFILE>, this is probably a bug and may
  330. change in future releases.
  331. Many of the configuration file options are identical to command line
  332. options. Where the option is present in the configuration file
  333. and the command line the command line value is used. Where an
  334. option is described as mandatory then it must be present in
  335. the configuration file or the command line equivalent (if
  336. any) used.
  337. =over 4
  338. =item B<oid_file>
  339. This specifies a file containing additional B<OBJECT IDENTIFIERS>.
  340. Each line of the file should consist of the numerical form of the
  341. object identifier followed by whitespace then the short name followed
  342. by whitespace and finally the long name.
  343. =item B<oid_section>
  344. This specifies a section in the configuration file containing extra
  345. object identifiers. Each line should consist of the short name of the
  346. object identifier followed by B<=> and the numerical form. The short
  347. and long names are the same when this option is used.
  348. =item B<new_certs_dir>
  349. The same as the B<-outdir> command line option. It specifies
  350. the directory where new certificates will be placed. Mandatory.
  351. =item B<certificate>
  352. The same as B<-cert>. It gives the file containing the CA
  353. certificate. Mandatory.
  354. =item B<private_key>
  355. Same as the B<-keyfile> option. The file containing the
  356. CA private key. Mandatory.
  357. =item B<RANDFILE>
  358. At startup the specified file is loaded into the random number generator,
  359. and at exit 256 bytes will be written to it. (Note: Using a RANDFILE is
  360. not necessary anymore, see the L</HISTORY> section.
  361. =item B<default_days>
  362. The same as the B<-days> option. The number of days from today to certify
  363. a certificate for.
  364. =item B<default_startdate>
  365. The same as the B<-startdate> option. The start date to certify
  366. a certificate for. If not set the current time is used.
  367. =item B<default_enddate>
  368. The same as the B<-enddate> option. Either this option or
  369. B<default_days> (or the command line equivalents) must be
  370. present.
  371. =item B<default_crl_hours default_crl_days>
  372. The same as the B<-crlhours> and the B<-crldays> options. These
  373. will only be used if neither command line option is present. At
  374. least one of these must be present to generate a CRL.
  375. =item B<default_md>
  376. The same as the B<-md> option. Mandatory except where the signing algorithm does
  377. not require a digest (i.e. Ed25519 and Ed448).
  378. =item B<database>
  379. The text database file to use. Mandatory. This file must be present
  380. though initially it will be empty.
  381. =item B<unique_subject>
  382. If the value B<yes> is given, the valid certificate entries in the
  383. database must have unique subjects. if the value B<no> is given,
  384. several valid certificate entries may have the exact same subject.
  385. The default value is B<yes>, to be compatible with older (pre 0.9.8)
  386. versions of OpenSSL. However, to make CA certificate roll-over easier,
  387. it's recommended to use the value B<no>, especially if combined with
  388. the B<-selfsign> command line option.
  389. Note that it is valid in some circumstances for certificates to be created
  390. without any subject. In the case where there are multiple certificates without
  391. subjects this does not count as a duplicate.
  392. =item B<serial>
  393. A text file containing the next serial number to use in hex. Mandatory.
  394. This file must be present and contain a valid serial number.
  395. =item B<crlnumber>
  396. A text file containing the next CRL number to use in hex. The crl number
  397. will be inserted in the CRLs only if this file exists. If this file is
  398. present, it must contain a valid CRL number.
  399. =item B<x509_extensions>
  400. A fallback to the B<-extensions> option.
  401. =item B<crl_extensions>
  402. A fallback to the B<-crlexts> option.
  403. =item B<preserve>
  404. The same as B<-preserveDN>
  405. =item B<email_in_dn>
  406. The same as B<-noemailDN>. If you want the EMAIL field to be removed
  407. from the DN of the certificate simply set this to 'no'. If not present
  408. the default is to allow for the EMAIL filed in the certificate's DN.
  409. =item B<msie_hack>
  410. The same as B<-msie_hack>
  411. =item B<policy>
  412. The same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section
  413. for more information.
  414. =item B<name_opt>, B<cert_opt>
  415. These options allow the format used to display the certificate details
  416. when asking the user to confirm signing. All the options supported by
  417. the B<x509> utilities B<-nameopt> and B<-certopt> switches can be used
  418. here, except the B<no_signame> and B<no_sigdump> are permanently set
  419. and cannot be disabled (this is because the certificate signature cannot
  420. be displayed because the certificate has not been signed at this point).
  421. For convenience the values B<ca_default> are accepted by both to produce
  422. a reasonable output.
  423. If neither option is present the format used in earlier versions of
  424. OpenSSL is used. Use of the old format is B<strongly> discouraged because
  425. it only displays fields mentioned in the B<policy> section, mishandles
  426. multicharacter string types and does not display extensions.
  427. =item B<copy_extensions>
  428. Determines how extensions in certificate requests should be handled.
  429. If set to B<none> or this option is not present then extensions are
  430. ignored and not copied to the certificate. If set to B<copy> then any
  431. extensions present in the request that are not already present are copied
  432. to the certificate. If set to B<copyall> then all extensions in the
  433. request are copied to the certificate: if the extension is already present
  434. in the certificate it is deleted first. See the B<WARNINGS> section before
  435. using this option.
  436. The main use of this option is to allow a certificate request to supply
  437. values for certain extensions such as subjectAltName.
  438. =back
  439. =head1 POLICY FORMAT
  440. The policy section consists of a set of variables corresponding to
  441. certificate DN fields. If the value is "match" then the field value
  442. must match the same field in the CA certificate. If the value is
  443. "supplied" then it must be present. If the value is "optional" then
  444. it may be present. Any fields not mentioned in the policy section
  445. are silently deleted, unless the B<-preserveDN> option is set but
  446. this can be regarded more of a quirk than intended behaviour.
  447. =head1 SPKAC FORMAT
  448. The input to the B<-spkac> command line option is a Netscape
  449. signed public key and challenge. This will usually come from
  450. the B<KEYGEN> tag in an HTML form to create a new private key.
  451. It is however possible to create SPKACs using L<openssl-spkac(1)>.
  452. The file should contain the variable SPKAC set to the value of
  453. the SPKAC and also the required DN components as name value pairs.
  454. If you need to include the same component twice then it can be
  455. preceded by a number and a '.'.
  456. When processing SPKAC format, the output is DER if the B<-out>
  457. flag is used, but PEM format if sending to stdout or the B<-outdir>
  458. flag is used.
  459. =head1 EXAMPLES
  460. Note: these examples assume that the directory structure this command
  461. assumes is already set up and the relevant files already exist. This
  462. usually involves creating a CA certificate and private key with
  463. L<openssl-req(1)>, a serial number file and an empty index file and
  464. placing them in the relevant directories.
  465. To use the sample configuration file below the directories F<demoCA>,
  466. F<demoCA/private> and F<demoCA/newcerts> would be created. The CA
  467. certificate would be copied to F<demoCA/cacert.pem> and its private
  468. key to F<demoCA/private/cakey.pem>. A file F<demoCA/serial> would be
  469. created containing for example "01" and the empty index file
  470. F<demoCA/index.txt>.
  471. Sign a certificate request:
  472. openssl ca -in req.pem -out newcert.pem
  473. Sign an SM2 certificate request:
  474. openssl ca -in sm2.csr -out sm2.crt -md sm3 \
  475. -sigopt "distid:1234567812345678" \
  476. -vfyopt "distid:1234567812345678"
  477. Sign a certificate request, using CA extensions:
  478. openssl ca -in req.pem -extensions v3_ca -out newcert.pem
  479. Generate a CRL
  480. openssl ca -gencrl -out crl.pem
  481. Sign several requests:
  482. openssl ca -infiles req1.pem req2.pem req3.pem
  483. Certify a Netscape SPKAC:
  484. openssl ca -spkac spkac.txt
  485. A sample SPKAC file (the SPKAC line has been truncated for clarity):
  486. SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
  487. CN=Steve Test
  488. emailAddress=steve@openssl.org
  489. 0.OU=OpenSSL Group
  490. 1.OU=Another Group
  491. A sample configuration file with the relevant sections for this command:
  492. [ ca ]
  493. default_ca = CA_default # The default ca section
  494. [ CA_default ]
  495. dir = ./demoCA # top dir
  496. database = $dir/index.txt # index file.
  497. new_certs_dir = $dir/newcerts # new certs dir
  498. certificate = $dir/cacert.pem # The CA cert
  499. serial = $dir/serial # serial no file
  500. #rand_serial = yes # for random serial#'s
  501. private_key = $dir/private/cakey.pem# CA private key
  502. default_days = 365 # how long to certify for
  503. default_crl_days= 30 # how long before next CRL
  504. default_md = md5 # md to use
  505. policy = policy_any # default policy
  506. email_in_dn = no # Don't add the email into cert DN
  507. name_opt = ca_default # Subject name display option
  508. cert_opt = ca_default # Certificate display option
  509. copy_extensions = none # Don't copy extensions from request
  510. [ policy_any ]
  511. countryName = supplied
  512. stateOrProvinceName = optional
  513. organizationName = optional
  514. organizationalUnitName = optional
  515. commonName = supplied
  516. emailAddress = optional
  517. =head1 FILES
  518. Note: the location of all files can change either by compile time options,
  519. configuration file entries, environment variables or command line options.
  520. The values below reflect the default values.
  521. /usr/local/ssl/lib/openssl.cnf - master configuration file
  522. ./demoCA - main CA directory
  523. ./demoCA/cacert.pem - CA certificate
  524. ./demoCA/private/cakey.pem - CA private key
  525. ./demoCA/serial - CA serial number file
  526. ./demoCA/serial.old - CA serial number backup file
  527. ./demoCA/index.txt - CA text database file
  528. ./demoCA/index.txt.old - CA text database backup file
  529. ./demoCA/certs - certificate output file
  530. =head1 RESTRICTIONS
  531. The text database index file is a critical part of the process and
  532. if corrupted it can be difficult to fix. It is theoretically possible
  533. to rebuild the index file from all the issued certificates and a current
  534. CRL: however there is no option to do this.
  535. V2 CRL features like delta CRLs are not currently supported.
  536. Although several requests can be input and handled at once it is only
  537. possible to include one SPKAC or self-signed certificate.
  538. =head1 BUGS
  539. This command is quirky and at times downright unfriendly.
  540. The use of an in-memory text database can cause problems when large
  541. numbers of certificates are present because, as the name implies
  542. the database has to be kept in memory.
  543. This command really needs rewriting or the required functionality
  544. exposed at either a command or interface level so that a more user-friendly
  545. replacement could handle things properly. The script
  546. B<CA.pl> helps a little but not very much.
  547. Any fields in a request that are not present in a policy are silently
  548. deleted. This does not happen if the B<-preserveDN> option is used. To
  549. enforce the absence of the EMAIL field within the DN, as suggested by
  550. RFCs, regardless the contents of the request' subject the B<-noemailDN>
  551. option can be used. The behaviour should be more friendly and
  552. configurable.
  553. Canceling some commands by refusing to certify a certificate can
  554. create an empty file.
  555. =head1 WARNINGS
  556. This command was originally meant as an example of how to do things in a CA.
  557. Its code does not have production quality.
  558. It was not supposed to be used as a full blown CA itself,
  559. nevertheless some people are using it for this purpose at least internally.
  560. When doing so, specific care should be taken to
  561. properly secure the private key(s) used for signing certificates.
  562. It is advisable to keep them in a secure HW storage such as a smart card or HSM
  563. and access them via a suitable engine or crypto provider.
  564. This command is effectively a single user command: no locking
  565. is done on the various files and attempts to run more than one B<openssl ca>
  566. command on the same database can have unpredictable results.
  567. The B<copy_extensions> option should be used with caution. If care is
  568. not taken then it can be a security risk. For example if a certificate
  569. request contains a basicConstraints extension with CA:TRUE and the
  570. B<copy_extensions> value is set to B<copyall> and the user does not spot
  571. this when the certificate is displayed then this will hand the requester
  572. a valid CA certificate.
  573. This situation can be avoided by setting B<copy_extensions> to B<copy>
  574. and including basicConstraints with CA:FALSE in the configuration file.
  575. Then if the request contains a basicConstraints extension it will be
  576. ignored.
  577. It is advisable to also include values for other extensions such
  578. as B<keyUsage> to prevent a request supplying its own values.
  579. Additional restrictions can be placed on the CA certificate itself.
  580. For example if the CA certificate has:
  581. basicConstraints = CA:TRUE, pathlen:0
  582. then even if a certificate is issued with CA:TRUE it will not be valid.
  583. =head1 HISTORY
  584. Since OpenSSL 1.1.1, the program follows RFC5280. Specifically,
  585. certificate validity period (specified by any of B<-startdate>,
  586. B<-enddate> and B<-days>) and CRL last/next update time (specified by
  587. any of B<-crl_lastupdate>, B<-crl_nextupdate>, B<-crldays>, B<-crlhours>
  588. and B<-crlsec>) will be encoded as UTCTime if the dates are
  589. earlier than year 2049 (included), and as GeneralizedTime if the dates
  590. are in year 2050 or later.
  591. OpenSSL 1.1.1 introduced a new random generator (CSPRNG) with an improved
  592. seeding mechanism. The new seeding mechanism makes it unnecessary to
  593. define a RANDFILE for saving and restoring randomness. This option is
  594. retained mainly for compatibility reasons.
  595. The B<-section> option was added in OpenSSL 3.0.0.
  596. The B<-multivalue-rdn> option has become obsolete in OpenSSL 3.0.0 and
  597. has no effect.
  598. The B<-engine> option was deprecated in OpenSSL 3.0.
  599. Since OpenSSL 3.2, generated certificates bear X.509 version 3,
  600. and key identifier extensions are included by default.
  601. =head1 SEE ALSO
  602. L<openssl(1)>,
  603. L<openssl-req(1)>,
  604. L<openssl-spkac(1)>,
  605. L<openssl-x509(1)>,
  606. L<CA.pl(1)>,
  607. L<config(5)>,
  608. L<x509v3_config(5)>
  609. =head1 COPYRIGHT
  610. Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
  611. Licensed under the Apache License 2.0 (the "License"). You may not use
  612. this file except in compliance with the License. You can obtain a copy
  613. in the file LICENSE in the source distribution or at
  614. L<https://www.openssl.org/source/license.html>.
  615. =cut