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