6 ca - sample minimal CA application
20 [B<-crl_reason reason>]
21 [B<-crl_hold instruction>]
22 [B<-crl_compromise time>]
23 [B<-crl_CA_compromise time>]
49 [B<-extensions section>]
62 The B<ca> command is a minimal CA application. It can be used
63 to sign certificate requests in a variety of forms and generate
64 CRLs it also maintains a text database of issued certificates
67 The options descriptions will be divided into each purpose.
75 Print out a usage message.
79 This prints extra details about the operations being performed.
81 =item B<-config filename>
83 Specifies the configuration file to use.
84 Optional; for a description of the default value,
85 see L<openssl(1)/COMMAND SUMMARY>.
87 =item B<-name section>
89 Specifies the configuration file section to use (overrides
90 B<default_ca> in the B<ca> section).
94 An input filename containing a single certificate request to be
97 =item B<-ss_cert filename>
99 A single self-signed certificate to be signed by the CA.
101 =item B<-spkac filename>
103 A file containing a single Netscape signed public key and challenge
104 and additional field values to be signed by the CA. See the B<SPKAC FORMAT>
105 section for information on the required input and output format.
109 If present this should be the last option, all subsequent arguments
110 are taken as the names of files containing certificate requests.
112 =item B<-out 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).
118 =item B<-outdir 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
126 The CA certificate file.
128 =item B<-keyfile filename>
130 The private key to sign requests with.
132 =item B<-keyform PEM|DER>
134 The format of the data in the private key file.
137 =item B<-key password>
139 The password used to encrypt the private key. Since on some
140 systems the command line arguments are visible (e.g. Unix with
141 the 'ps' utility) this option should be used with caution.
145 Indicates the issued certificates are to be signed with the key
146 the certificate requests were signed with (given with B<-keyfile>).
147 Certificate requests signed with a different key are ignored. If
148 B<-spkac>, B<-ss_cert> or B<-gencrl> are given, B<-selfsign> is
151 A consequence of using B<-selfsign> is that the self-signed
152 certificate appears among the entries in the certificate database
153 (see the configuration option B<database>), and uses the same
154 serial number counter as all other certificates sign with the
155 self-signed certificate.
159 The key password source. For more information about the format of B<arg>
160 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
164 Don't output the text form of a certificate to the output file.
166 =item B<-startdate date>
168 This allows the start date to be explicitly set. The format of the
169 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
170 YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
171 both formats, seconds SS and timezone Z must be present.
173 =item B<-enddate date>
175 This allows the expiry date to be explicitly set. The format of the
176 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
177 YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
178 both formats, seconds SS and timezone Z must be present.
182 The number of days to certify the certificate for.
186 The message digest to use.
187 Any digest supported by the OpenSSL B<dgst> command can be used.
188 This option also applies to CRLs.
192 This option defines the CA "policy" to use. This is a section in
193 the configuration file which decides which fields should be mandatory
194 or match the CA certificate. Check out the B<POLICY FORMAT> section
195 for more information.
199 This is a deprecated option to make B<ca> work with very old versions of
200 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.
206 Normally the DN order of a certificate is the same as the order of the
207 fields in the relevant policy section. When this option is set the order
208 is the same as the request. This is largely for compatibility with the
209 older IE enrollment control which would only accept certificates if their
210 DNs match the order of the request. This is not needed for Xenroll.
214 The DN of a certificate can contain the EMAIL field if present in the
215 request DN, however it is good policy just having the e-mail set into
216 the altName extension of the certificate. When this option is set the
217 EMAIL field is removed from the certificate' subject and set only in
218 the, eventually present, extensions. The B<email_in_dn> keyword can be
219 used in the configuration file to enable this behaviour.
223 This sets the batch mode. In this mode no questions will be asked
224 and all certificates will be certified automatically.
226 =item B<-extensions section>
228 The section of the configuration file containing certificate extensions
229 to be added when a certificate is issued (defaults to B<x509_extensions>
230 unless the B<-extfile> option is used). If no extension section is
231 present then, a V1 certificate is created. If the extension section
232 is present (even if it is empty), then a V3 certificate is created. See the:w
233 L<x509v3_config(5)> manual page for details of the
234 extension section format.
236 =item B<-extfile file>
238 An additional configuration file to read certificate extensions from
239 (using the default section unless the B<-extensions> option is also
244 Specifying an engine (by its unique B<id> string) will cause B<ca>
245 to attempt to obtain a functional reference to the specified engine,
246 thus initialising it if needed. The engine will then be set as the default
247 for all available algorithms.
251 Supersedes subject name given in the request.
252 The arg must be formatted as I</type0=value0/type1=value1/type2=...>,
253 characters may be escaped by \ (backslash), no spaces are skipped.
257 This option causes field values to be interpreted as UTF8 strings, by
258 default they are interpreted as ASCII. This means that the field
259 values, whether prompted from a terminal or obtained from a
260 configuration file, must be valid UTF8 strings.
262 =item B<-create_serial>
264 If reading serial from the text file as specified in the configuration
265 fails, specifying this option creates a new random serial to be used as next
267 To get random serial numbers, use the B<-rand_serial> flag instead; this
268 should only be used for simple error-recovery.
270 =item B<-rand_serial>
272 Generate a large random number to use as the serial number.
273 This overrides any option or configuration to use a serial number file.
275 =item B<-multivalue-rdn>
277 This option causes the -subj argument to be interpreted with full
278 support for multivalued RDNs. Example:
280 I</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
282 If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>.
284 =item B<-rand file...>
286 A file or files containing random data used to seed the random number
288 Multiple files can be specified separated by an OS-dependent character.
289 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
292 =item [B<-writerand file>]
294 Writes random data to the specified I<file> upon exit.
295 This can be used with a subsequent B<-rand> flag.
305 This option generates a CRL based on information in the index file.
307 =item B<-crldays num>
309 The number of days before the next CRL is due. That is the days from
310 now to place in the CRL nextUpdate field.
312 =item B<-crlhours num>
314 The number of hours before the next CRL is due.
316 =item B<-revoke filename>
318 A filename containing a certificate to revoke.
320 =item B<-valid filename>
322 A filename containing a certificate to add a Valid certificate entry.
324 =item B<-status serial>
326 Displays the revocation status of the certificate with the specified
327 serial number and exits.
331 Updates the database index to purge expired certificates.
333 =item B<-crl_reason reason>
335 Revocation reason, where B<reason> is one of: B<unspecified>, B<keyCompromise>,
336 B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>,
337 B<certificateHold> or B<removeFromCRL>. The matching of B<reason> is case
338 insensitive. Setting any revocation reason will make the CRL v2.
340 In practice B<removeFromCRL> is not particularly useful because it is only used
341 in delta CRLs which are not currently implemented.
343 =item B<-crl_hold instruction>
345 This sets the CRL revocation reason code to B<certificateHold> and the hold
346 instruction to B<instruction> which must be an OID. Although any OID can be
347 used only B<holdInstructionNone> (the use of which is discouraged by RFC2459)
348 B<holdInstructionCallIssuer> or B<holdInstructionReject> will normally be used.
350 =item B<-crl_compromise time>
352 This sets the revocation reason to B<keyCompromise> and the compromise time to
353 B<time>. B<time> should be in GeneralizedTime format that is B<YYYYMMDDHHMMSSZ>.
355 =item B<-crl_CA_compromise time>
357 This is the same as B<crl_compromise> except the revocation reason is set to
360 =item B<-crlexts section>
362 The section of the configuration file containing CRL extensions to
363 include. If no CRL extension section is present then a V1 CRL is
364 created, if the CRL extension section is present (even if it is
365 empty) then a V2 CRL is created. The CRL extensions specified are
366 CRL extensions and B<not> CRL entry extensions. It should be noted
367 that some software (for example Netscape) can't handle V2 CRLs. See
368 L<x509v3_config(5)> manual page for details of the
369 extension section format.
373 =head1 CONFIGURATION FILE OPTIONS
375 The section of the configuration file containing options for B<ca>
376 is found as follows: If the B<-name> command line option is used,
377 then it names the section to be used. Otherwise the section to
378 be used must be named in the B<default_ca> option of the B<ca> section
379 of the configuration file (or in the default section of the
380 configuration file). Besides B<default_ca>, the following options are
381 read directly from the B<ca> section:
385 With the exception of B<RANDFILE>, this is probably a bug and may
386 change in future releases.
388 Many of the configuration file options are identical to command line
389 options. Where the option is present in the configuration file
390 and the command line the command line value is used. Where an
391 option is described as mandatory then it must be present in
392 the configuration file or the command line equivalent (if
399 This specifies a file containing additional B<OBJECT IDENTIFIERS>.
400 Each line of the file should consist of the numerical form of the
401 object identifier followed by white space then the short name followed
402 by white space and finally the long name.
406 This specifies a section in the configuration file containing extra
407 object identifiers. Each line should consist of the short name of the
408 object identifier followed by B<=> and the numerical form. The short
409 and long names are the same when this option is used.
411 =item B<new_certs_dir>
413 The same as the B<-outdir> command line option. It specifies
414 the directory where new certificates will be placed. Mandatory.
418 The same as B<-cert>. It gives the file containing the CA
419 certificate. Mandatory.
423 Same as the B<-keyfile> option. The file containing the
424 CA private key. Mandatory.
428 At startup the specified file is loaded into the random number generator,
429 and at exit 256 bytes will be written to it.
431 =item B<default_days>
433 The same as the B<-days> option. The number of days to certify
436 =item B<default_startdate>
438 The same as the B<-startdate> option. The start date to certify
439 a certificate for. If not set the current time is used.
441 =item B<default_enddate>
443 The same as the B<-enddate> option. Either this option or
444 B<default_days> (or the command line equivalents) must be
447 =item B<default_crl_hours default_crl_days>
449 The same as the B<-crlhours> and the B<-crldays> options. These
450 will only be used if neither command line option is present. At
451 least one of these must be present to generate a CRL.
455 The same as the B<-md> option. Mandatory.
459 The text database file to use. Mandatory. This file must be present
460 though initially it will be empty.
462 =item B<unique_subject>
464 If the value B<yes> is given, the valid certificate entries in the
465 database must have unique subjects. if the value B<no> is given,
466 several valid certificate entries may have the exact same subject.
467 The default value is B<yes>, to be compatible with older (pre 0.9.8)
468 versions of OpenSSL. However, to make CA certificate roll-over easier,
469 it's recommended to use the value B<no>, especially if combined with
470 the B<-selfsign> command line option.
472 Note that it is valid in some circumstances for certificates to be created
473 without any subject. In the case where there are multiple certificates without
474 subjects this does not count as a duplicate.
478 A text file containing the next serial number to use in hex. Mandatory.
479 This file must be present and contain a valid serial number.
483 A text file containing the next CRL number to use in hex. The crl number
484 will be inserted in the CRLs only if this file exists. If this file is
485 present, it must contain a valid CRL number.
487 =item B<x509_extensions>
489 The same as B<-extensions>.
491 =item B<crl_extensions>
493 The same as B<-crlexts>.
497 The same as B<-preserveDN>
501 The same as B<-noemailDN>. If you want the EMAIL field to be removed
502 from the DN of the certificate simply set this to 'no'. If not present
503 the default is to allow for the EMAIL filed in the certificate's DN.
507 The same as B<-msie_hack>
511 The same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section
512 for more information.
514 =item B<name_opt>, B<cert_opt>
516 These options allow the format used to display the certificate details
517 when asking the user to confirm signing. All the options supported by
518 the B<x509> utilities B<-nameopt> and B<-certopt> switches can be used
519 here, except the B<no_signame> and B<no_sigdump> are permanently set
520 and cannot be disabled (this is because the certificate signature cannot
521 be displayed because the certificate has not been signed at this point).
523 For convenience the values B<ca_default> are accepted by both to produce
526 If neither option is present the format used in earlier versions of
527 OpenSSL is used. Use of the old format is B<strongly> discouraged because
528 it only displays fields mentioned in the B<policy> section, mishandles
529 multicharacter string types and does not display extensions.
531 =item B<copy_extensions>
533 Determines how extensions in certificate requests should be handled.
534 If set to B<none> or this option is not present then extensions are
535 ignored and not copied to the certificate. If set to B<copy> then any
536 extensions present in the request that are not already present are copied
537 to the certificate. If set to B<copyall> then all extensions in the
538 request are copied to the certificate: if the extension is already present
539 in the certificate it is deleted first. See the B<WARNINGS> section before
542 The main use of this option is to allow a certificate request to supply
543 values for certain extensions such as subjectAltName.
549 The policy section consists of a set of variables corresponding to
550 certificate DN fields. If the value is "match" then the field value
551 must match the same field in the CA certificate. If the value is
552 "supplied" then it must be present. If the value is "optional" then
553 it may be present. Any fields not mentioned in the policy section
554 are silently deleted, unless the B<-preserveDN> option is set but
555 this can be regarded more of a quirk than intended behaviour.
559 The input to the B<-spkac> command line option is a Netscape
560 signed public key and challenge. This will usually come from
561 the B<KEYGEN> tag in an HTML form to create a new private key.
562 It is however possible to create SPKACs using the B<spkac> utility.
564 The file should contain the variable SPKAC set to the value of
565 the SPKAC and also the required DN components as name value pairs.
566 If you need to include the same component twice then it can be
567 preceded by a number and a '.'.
569 When processing SPKAC format, the output is DER if the B<-out>
570 flag is used, but PEM format if sending to stdout or the B<-outdir>
575 Note: these examples assume that the B<ca> directory structure is
576 already set up and the relevant files already exist. This usually
577 involves creating a CA certificate and private key with B<req>, a
578 serial number file and an empty index file and placing them in
579 the relevant directories.
581 To use the sample configuration file below the directories demoCA,
582 demoCA/private and demoCA/newcerts would be created. The CA
583 certificate would be copied to demoCA/cacert.pem and its private
584 key to demoCA/private/cakey.pem. A file demoCA/serial would be
585 created containing for example "01" and the empty index file
589 Sign a certificate request:
591 openssl ca -in req.pem -out newcert.pem
593 Sign a certificate request, using CA extensions:
595 openssl ca -in req.pem -extensions v3_ca -out newcert.pem
599 openssl ca -gencrl -out crl.pem
601 Sign several requests:
603 openssl ca -infiles req1.pem req2.pem req3.pem
605 Certify a Netscape SPKAC:
607 openssl ca -spkac spkac.txt
609 A sample SPKAC file (the SPKAC line has been truncated for clarity):
611 SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
613 emailAddress=steve@openssl.org
617 A sample configuration file with the relevant sections for B<ca>:
620 default_ca = CA_default # The default ca section
624 dir = ./demoCA # top dir
625 database = $dir/index.txt # index file.
626 new_certs_dir = $dir/newcerts # new certs dir
628 certificate = $dir/cacert.pem # The CA cert
629 serial = $dir/serial # serial no file
630 #rand_serial = yes # for random serial#'s
631 private_key = $dir/private/cakey.pem# CA private key
632 RANDFILE = $dir/private/.rand # random number file
634 default_days = 365 # how long to certify for
635 default_crl_days= 30 # how long before next CRL
636 default_md = md5 # md to use
638 policy = policy_any # default policy
639 email_in_dn = no # Don't add the email into cert DN
641 name_opt = ca_default # Subject name display option
642 cert_opt = ca_default # Certificate display option
643 copy_extensions = none # Don't copy extensions from request
646 countryName = supplied
647 stateOrProvinceName = optional
648 organizationName = optional
649 organizationalUnitName = optional
650 commonName = supplied
651 emailAddress = optional
655 Note: the location of all files can change either by compile time options,
656 configuration file entries, environment variables or command line options.
657 The values below reflect the default values.
659 /usr/local/ssl/lib/openssl.cnf - master configuration file
660 ./demoCA - main CA directory
661 ./demoCA/cacert.pem - CA certificate
662 ./demoCA/private/cakey.pem - CA private key
663 ./demoCA/serial - CA serial number file
664 ./demoCA/serial.old - CA serial number backup file
665 ./demoCA/index.txt - CA text database file
666 ./demoCA/index.txt.old - CA text database backup file
667 ./demoCA/certs - certificate output file
668 ./demoCA/.rnd - CA random seed information
672 The text database index file is a critical part of the process and
673 if corrupted it can be difficult to fix. It is theoretically possible
674 to rebuild the index file from all the issued certificates and a current
675 CRL: however there is no option to do this.
677 V2 CRL features like delta CRLs are not currently supported.
679 Although several requests can be input and handled at once it is only
680 possible to include one SPKAC or self-signed certificate.
684 The use of an in-memory text database can cause problems when large
685 numbers of certificates are present because, as the name implies
686 the database has to be kept in memory.
688 The B<ca> command really needs rewriting or the required functionality
689 exposed at either a command or interface level so a more friendly utility
690 (perl script or GUI) can handle things properly. The script
691 B<CA.pl> helps a little but not very much.
693 Any fields in a request that are not present in a policy are silently
694 deleted. This does not happen if the B<-preserveDN> option is used. To
695 enforce the absence of the EMAIL field within the DN, as suggested by
696 RFCs, regardless the contents of the request' subject the B<-noemailDN>
697 option can be used. The behaviour should be more friendly and
700 Canceling some commands by refusing to certify a certificate can
701 create an empty file.
705 The B<ca> command is quirky and at times downright unfriendly.
707 The B<ca> utility was originally meant as an example of how to do things
708 in a CA. It was not supposed to be used as a full blown CA itself:
709 nevertheless some people are using it for this purpose.
711 The B<ca> command is effectively a single user command: no locking is
712 done on the various files and attempts to run more than one B<ca> command
713 on the same database can have unpredictable results.
715 The B<copy_extensions> option should be used with caution. If care is
716 not taken then it can be a security risk. For example if a certificate
717 request contains a basicConstraints extension with CA:TRUE and the
718 B<copy_extensions> value is set to B<copyall> and the user does not spot
719 this when the certificate is displayed then this will hand the requester
720 a valid CA certificate.
722 This situation can be avoided by setting B<copy_extensions> to B<copy>
723 and including basicConstraints with CA:FALSE in the configuration file.
724 Then if the request contains a basicConstraints extension it will be
727 It is advisable to also include values for other extensions such
728 as B<keyUsage> to prevent a request supplying its own values.
730 Additional restrictions can be placed on the CA certificate itself.
731 For example if the CA certificate has:
733 basicConstraints = CA:TRUE, pathlen:0
735 then even if a certificate is issued with CA:TRUE it will not be valid.
739 Since OpenSSL 1.1.1, the program follows RFC5280. Specifically,
740 certificate validity period (specified by any of B<-startdate>,
741 B<-enddate> and B<-days>) will be encoded as UTCTime if the dates are
742 earlier than year 2049 (included), and as GeneralizedTime if the dates
743 are in year 2050 or later.
747 L<req(1)>, L<spkac(1)>, L<x509(1)>, L<CA.pl(1)>,
748 L<config(5)>, L<x509v3_config(5)>
752 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
754 Licensed under the OpenSSL license (the "License"). You may not use
755 this file except in compliance with the License. You can obtain a copy
756 in the file LICENSE in the source distribution or at
757 L<https://www.openssl.org/source/license.html>.