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