openssl-ca.pod.in 29 KB

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