5 openssl-ca - sample minimal CA application
12 [B<-config> I<filename>]
17 [B<-status> I<serial>]
19 [B<-crl_reason> I<reason>]
20 [B<-crl_hold> I<instruction>]
21 [B<-crl_compromise> I<time>]
22 [B<-crl_CA_compromise> I<time>]
24 [B<-crlhours> I<hours>]
25 [B<-crlexts> I<section>]
26 [B<-startdate> I<date>]
32 [B<-keyform> B<DER>|B<PEM>]
48 [B<-extensions> I<section>]
49 [B<-extfile> I<section>]
53 [B<-sigopt> I<nm>:I<v>]
58 [B<-writerand> I<file>]
59 [B<-sm2-id> I<string>]
60 [B<-sm2-hex-id> I<hex-string>]
62 =for comment ifdef engine sm2-id sm2-hex-id
66 This command is a minimal CA application. It can be used
67 to sign certificate requests in a variety of forms and generate
68 CRLs it also maintains a text database of issued certificates
71 The options descriptions will be divided into each purpose.
79 Print out a usage message.
83 This prints extra details about the operations being performed.
85 =item B<-config> I<filename>
87 Specifies the configuration file to use.
88 Optional; for a description of the default value,
89 see L<openssl(1)/COMMAND SUMMARY>.
91 =item B<-name> I<section>
93 Specifies the configuration file section to use (overrides
94 B<default_ca> in the B<ca> section).
96 =item B<-in> I<filename>
98 An input filename containing a single certificate request to be
101 =item B<-ss_cert> I<filename>
103 A single self-signed certificate to be signed by the CA.
105 =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.
113 If present this should be the last option, all subsequent arguments
114 are taken as the names of files containing certificate requests.
116 =item B<-out> I<filename>
118 The output file to output certificates to. The default is standard
119 output. The certificate details will also be printed out to this
120 file in PEM format (except that B<-spkac> outputs DER format).
122 =item B<-outdir> I<directory>
124 The directory to output certificates to. The certificate will be
125 written to a filename consisting of the serial number in hex with
130 The CA certificate file.
132 =item B<-keyfile> I<filename>
134 The private key to sign requests with.
136 =item B<-keyform> B<DER>|B<PEM>
138 The format of the data in the private key file.
141 =item B<-sigopt> I<nm>:I<v>
143 Pass options to the signature algorithm during sign or verify operations.
144 Names and values of these options are algorithm-specific.
146 =item B<-key> I<password>
148 The password used to encrypt the private key. Since on some
149 systems the command line arguments are visible (e.g. Unix with
150 the L<ps(1)> utility) this option should be used with caution.
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. If
157 B<-spkac>, B<-ss_cert> or B<-gencrl> are given, B<-selfsign> is
160 A consequence of using B<-selfsign> is that the self-signed
161 certificate appears among the entries in the certificate database
162 (see the configuration option B<database>), and uses the same
163 serial number counter as all other certificates sign with the
164 self-signed certificate.
166 =item B<-passin> I<arg>
168 The key password source. For more information about the format of B<arg>
169 see L<openssl(1)/Pass phrase options>.
173 Don't output the text form of a certificate to the output file.
175 =item B<-startdate> I<date>
177 This allows the start date to be explicitly set. The format of the
178 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
179 YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
180 both formats, seconds SS and timezone Z must be present.
182 =item B<-enddate> I<date>
184 This allows the expiry date to be explicitly set. The format of the
185 date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure), or
186 YYYYMMDDHHMMSSZ (the same as an ASN1 GeneralizedTime structure). In
187 both formats, seconds SS and timezone Z must be present.
189 =item B<-days> I<arg>
191 The number of days to certify the certificate for.
195 The message digest to use.
196 Any digest supported by the L<openssl-dgst(1)> command can be used. For signing
197 algorithms that do not support a digest (i.e. Ed25519 and Ed448) any message
198 digest that is set is ignored. This option also applies to CRLs.
200 =item B<-policy> I<arg>
202 This option defines the CA "policy" to use. This is a section in
203 the configuration file which decides which fields should be mandatory
204 or match the CA certificate. Check out the B<POLICY FORMAT> section
205 for more information.
209 This is a deprecated option to make this command work with very old versions
210 of the IE certificate enrollment control "certenr3". It used UniversalStrings
211 for almost everything. Since the old control has various security bugs
212 its use is strongly discouraged.
216 Normally the DN order of a certificate is the same as the order of the
217 fields in the relevant policy section. When this option is set the order
218 is the same as the request. This is largely for compatibility with the
219 older IE enrollment control which would only accept certificates if their
220 DNs match the order of the request. This is not needed for Xenroll.
224 The DN of a certificate can contain the EMAIL field if present in the
225 request DN, however it is good policy just having the e-mail set into
226 the altName extension of the certificate. When this option is set the
227 EMAIL field is removed from the certificate' subject and set only in
228 the, eventually present, extensions. The B<email_in_dn> keyword can be
229 used in the configuration file to enable this behaviour.
233 This sets the batch mode. In this mode no questions will be asked
234 and all certificates will be certified automatically.
236 =item B<-extensions> I<section>
238 The section of the configuration file containing certificate extensions
239 to be added when a certificate is issued (defaults to B<x509_extensions>
240 unless the B<-extfile> option is used). If no extension section is
241 present then, a V1 certificate is created. If the extension section
242 is present (even if it is empty), then a V3 certificate is created. See the
243 L<x509v3_config(5)> manual page for details of the
244 extension section format.
246 =item B<-extfile> I<file>
248 An additional configuration file to read certificate extensions from
249 (using the default section unless the B<-extensions> option is also
252 =item B<-engine> I<id>
254 Specifying an engine (by its unique I<id> string) will cause B<ca>
255 to attempt to obtain a functional reference to the specified engine,
256 thus initialising it if needed. The engine will then be set as the default
257 for all available algorithms.
259 =item B<-subj> I<arg>
261 Supersedes subject name given in the request.
262 The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
263 Keyword characters may be escaped by C<\> (backslash), and whitespace is
265 Empty values are permitted, but the corresponding type will not be included
266 in the resulting certificate.
270 This option causes field values to be interpreted as UTF8 strings, by
271 default they are interpreted as ASCII. This means that the field
272 values, whether prompted from a terminal or obtained from a
273 configuration file, must be valid UTF8 strings.
275 =item B<-create_serial>
277 If reading serial from the text file as specified in the configuration
278 fails, specifying this option creates a new random serial to be used as next
280 To get random serial numbers, use the B<-rand_serial> flag instead; this
281 should only be used for simple error-recovery.
283 =item B<-rand_serial>
285 Generate a large random number to use as the serial number.
286 This overrides any option or configuration to use a serial number file.
288 =item B<-multivalue-rdn>
290 This option causes the -subj argument to be interpreted with full
291 support for multivalued RDNs. Example:
293 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
295 If B<-multi-rdn> is not used then the UID value is C<123456+CN=John Doe>.
297 =item B<-rand> I<files>
299 The files containing random data used to seed the random number generator.
300 Multiple files can be specified separated by an OS-dependent character.
301 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
304 =item B<-writerand> I<file>
306 Writes random data to the specified I<file> upon exit.
307 This can be used with a subsequent B<-rand> flag.
309 =item B<-sm2-id> I<string>
311 Specify the ID string to use when verifying an SM2 certificate. The ID string is
312 required by the SM2 signature algorithm for signing and verification.
314 =item B<-sm2-hex-id> I<hex-string>
316 Specify a binary ID string to use when signing or verifying using an SM2
317 certificate. The argument for this option is string of hexadecimal digits.
327 This option generates a CRL based on information in the index file.
329 =item B<-crldays> I<num>
331 The number of days before the next CRL is due. That is the days from
332 now to place in the CRL nextUpdate field.
334 =item B<-crlhours> I<num>
336 The number of hours before the next CRL is due.
338 =item B<-revoke> I<filename>
340 A filename containing a certificate to revoke.
342 =item B<-valid> I<filename>
344 A filename containing a certificate to add a Valid certificate entry.
346 =item B<-status> I<serial>
348 Displays the revocation status of the certificate with the specified
349 serial number and exits.
353 Updates the database index to purge expired certificates.
355 =item B<-crl_reason> I<reason>
357 Revocation reason, where I<reason> is one of: B<unspecified>, B<keyCompromise>,
358 B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>,
359 B<certificateHold> or B<removeFromCRL>. The matching of I<reason> is case
360 insensitive. Setting any revocation reason will make the CRL v2.
362 In practice B<removeFromCRL> is not particularly useful because it is only used
363 in delta CRLs which are not currently implemented.
365 =item B<-crl_hold> I<instruction>
367 This sets the CRL revocation reason code to B<certificateHold> and the hold
368 instruction to I<instruction> which must be an OID. Although any OID can be
369 used only B<holdInstructionNone> (the use of which is discouraged by RFC2459)
370 B<holdInstructionCallIssuer> or B<holdInstructionReject> will normally be used.
372 =item B<-crl_compromise> I<time>
374 This sets the revocation reason to B<keyCompromise> and the compromise time to
375 I<time>. I<time> should be in GeneralizedTime format that is I<YYYYMMDDHHMMSSZ>.
377 =item B<-crl_CA_compromise> I<time>
379 This is the same as B<crl_compromise> except the revocation reason is set to
382 =item B<-crlexts> I<section>
384 The section of the configuration file containing CRL extensions to
385 include. If no CRL extension section is present then a V1 CRL is
386 created, if the CRL extension section is present (even if it is
387 empty) then a V2 CRL is created. The CRL extensions specified are
388 CRL extensions and B<not> CRL entry extensions. It should be noted
389 that some software (for example Netscape) can't handle V2 CRLs. See
390 L<x509v3_config(5)> manual page for details of the
391 extension section format.
395 =head1 CONFIGURATION FILE OPTIONS
397 The section of the configuration file containing options for this command
398 is found as follows: If the B<-name> command line option is used,
399 then it names the section to be used. Otherwise the section to
400 be used must be named in the B<default_ca> option of the B<ca> section
401 of the configuration file (or in the default section of the
402 configuration file). Besides B<default_ca>, the following options are
403 read directly from the B<ca> section:
407 With the exception of B<RANDFILE>, this is probably a bug and may
408 change in future releases.
410 Many of the configuration file options are identical to command line
411 options. Where the option is present in the configuration file
412 and the command line the command line value is used. Where an
413 option is described as mandatory then it must be present in
414 the configuration file or the command line equivalent (if
421 This specifies a file containing additional B<OBJECT IDENTIFIERS>.
422 Each line of the file should consist of the numerical form of the
423 object identifier followed by white space then the short name followed
424 by white space and finally the long name.
428 This specifies a section in the configuration file containing extra
429 object identifiers. Each line should consist of the short name of the
430 object identifier followed by B<=> and the numerical form. The short
431 and long names are the same when this option is used.
433 =item B<new_certs_dir>
435 The same as the B<-outdir> command line option. It specifies
436 the directory where new certificates will be placed. Mandatory.
440 The same as B<-cert>. It gives the file containing the CA
441 certificate. Mandatory.
445 Same as the B<-keyfile> option. The file containing the
446 CA private key. Mandatory.
450 At startup the specified file is loaded into the random number generator,
451 and at exit 256 bytes will be written to it.
453 =item B<default_days>
455 The same as the B<-days> option. The number of days to certify
458 =item B<default_startdate>
460 The same as the B<-startdate> option. The start date to certify
461 a certificate for. If not set the current time is used.
463 =item B<default_enddate>
465 The same as the B<-enddate> option. Either this option or
466 B<default_days> (or the command line equivalents) must be
469 =item B<default_crl_hours default_crl_days>
471 The same as the B<-crlhours> and the B<-crldays> options. These
472 will only be used if neither command line option is present. At
473 least one of these must be present to generate a CRL.
477 The same as the B<-md> option. Mandatory except where the signing algorithm does
478 not require a digest (i.e. Ed25519 and Ed448).
482 The text database file to use. Mandatory. This file must be present
483 though initially it will be empty.
485 =item B<unique_subject>
487 If the value B<yes> is given, the valid certificate entries in the
488 database must have unique subjects. if the value B<no> is given,
489 several valid certificate entries may have the exact same subject.
490 The default value is B<yes>, to be compatible with older (pre 0.9.8)
491 versions of OpenSSL. However, to make CA certificate roll-over easier,
492 it's recommended to use the value B<no>, especially if combined with
493 the B<-selfsign> command line option.
495 Note that it is valid in some circumstances for certificates to be created
496 without any subject. In the case where there are multiple certificates without
497 subjects this does not count as a duplicate.
501 A text file containing the next serial number to use in hex. Mandatory.
502 This file must be present and contain a valid serial number.
506 A text file containing the next CRL number to use in hex. The crl number
507 will be inserted in the CRLs only if this file exists. If this file is
508 present, it must contain a valid CRL number.
510 =item B<x509_extensions>
512 The same as B<-extensions>.
514 =item B<crl_extensions>
516 The same as B<-crlexts>.
520 The same as B<-preserveDN>
524 The same as B<-noemailDN>. If you want the EMAIL field to be removed
525 from the DN of the certificate simply set this to 'no'. If not present
526 the default is to allow for the EMAIL filed in the certificate's DN.
530 The same as B<-msie_hack>
534 The same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section
535 for more information.
537 =item B<name_opt>, B<cert_opt>
539 These options allow the format used to display the certificate details
540 when asking the user to confirm signing. All the options supported by
541 the B<x509> utilities B<-nameopt> and B<-certopt> switches can be used
542 here, except the B<no_signame> and B<no_sigdump> are permanently set
543 and cannot be disabled (this is because the certificate signature cannot
544 be displayed because the certificate has not been signed at this point).
546 For convenience the values B<ca_default> are accepted by both to produce
549 If neither option is present the format used in earlier versions of
550 OpenSSL is used. Use of the old format is B<strongly> discouraged because
551 it only displays fields mentioned in the B<policy> section, mishandles
552 multicharacter string types and does not display extensions.
554 =item B<copy_extensions>
556 Determines how extensions in certificate requests should be handled.
557 If set to B<none> or this option is not present then extensions are
558 ignored and not copied to the certificate. If set to B<copy> then any
559 extensions present in the request that are not already present are copied
560 to the certificate. If set to B<copyall> then all extensions in the
561 request are copied to the certificate: if the extension is already present
562 in the certificate it is deleted first. See the B<WARNINGS> section before
565 The main use of this option is to allow a certificate request to supply
566 values for certain extensions such as subjectAltName.
572 The policy section consists of a set of variables corresponding to
573 certificate DN fields. If the value is "match" then the field value
574 must match the same field in the CA certificate. If the value is
575 "supplied" then it must be present. If the value is "optional" then
576 it may be present. Any fields not mentioned in the policy section
577 are silently deleted, unless the B<-preserveDN> option is set but
578 this can be regarded more of a quirk than intended behaviour.
582 The input to the B<-spkac> command line option is a Netscape
583 signed public key and challenge. This will usually come from
584 the B<KEYGEN> tag in an HTML form to create a new private key.
585 It is however possible to create SPKACs using L<openssl-spkac(1)>.
587 The file should contain the variable SPKAC set to the value of
588 the SPKAC and also the required DN components as name value pairs.
589 If you need to include the same component twice then it can be
590 preceded by a number and a '.'.
592 When processing SPKAC format, the output is DER if the B<-out>
593 flag is used, but PEM format if sending to stdout or the B<-outdir>
598 Note: these examples assume that the directory structure this command
599 assumes is already set up and the relevant files already exist. This
600 usually involves creating a CA certificate and private key with
601 L<openssl-req(1)>, a serial number file and an empty index file and
602 placing them in the relevant directories.
604 To use the sample configuration file below the directories F<demoCA>,
605 F<demoCA/private> and F<demoCA/newcerts> would be created. The CA
606 certificate would be copied to F<demoCA/cacert.pem> and its private
607 key to F<demoCA/private/cakey.pem>. A file F<demoCA/serial> would be
608 created containing for example "01" and the empty index file
612 Sign a certificate request:
614 openssl ca -in req.pem -out newcert.pem
616 Sign an SM2 certificate request:
618 openssl ca -in sm2.csr -out sm2.crt -md sm3 -sigopt "sm2_id:1234567812345678" -sm2-id "1234567812345678"
620 Sign a certificate request, using CA extensions:
622 openssl ca -in req.pem -extensions v3_ca -out newcert.pem
626 openssl ca -gencrl -out crl.pem
628 Sign several requests:
630 openssl ca -infiles req1.pem req2.pem req3.pem
632 Certify a Netscape SPKAC:
634 openssl ca -spkac spkac.txt
636 A sample SPKAC file (the SPKAC line has been truncated for clarity):
638 SPKAC=MIG0MGAwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAn7PDhCeV/xIxUg8V70YRxK2A5
640 emailAddress=steve@openssl.org
644 A sample configuration file with the relevant sections for this command:
647 default_ca = CA_default # The default ca section
651 dir = ./demoCA # top dir
652 database = $dir/index.txt # index file.
653 new_certs_dir = $dir/newcerts # new certs dir
655 certificate = $dir/cacert.pem # The CA cert
656 serial = $dir/serial # serial no file
657 #rand_serial = yes # for random serial#'s
658 private_key = $dir/private/cakey.pem# CA private key
659 RANDFILE = $dir/private/.rand # random number file
661 default_days = 365 # how long to certify for
662 default_crl_days= 30 # how long before next CRL
663 default_md = md5 # md to use
665 policy = policy_any # default policy
666 email_in_dn = no # Don't add the email into cert DN
668 name_opt = ca_default # Subject name display option
669 cert_opt = ca_default # Certificate display option
670 copy_extensions = none # Don't copy extensions from request
673 countryName = supplied
674 stateOrProvinceName = optional
675 organizationName = optional
676 organizationalUnitName = optional
677 commonName = supplied
678 emailAddress = optional
682 Note: the location of all files can change either by compile time options,
683 configuration file entries, environment variables or command line options.
684 The values below reflect the default values.
686 /usr/local/ssl/lib/openssl.cnf - master configuration file
687 ./demoCA - main CA directory
688 ./demoCA/cacert.pem - CA certificate
689 ./demoCA/private/cakey.pem - CA private key
690 ./demoCA/serial - CA serial number file
691 ./demoCA/serial.old - CA serial number backup file
692 ./demoCA/index.txt - CA text database file
693 ./demoCA/index.txt.old - CA text database backup file
694 ./demoCA/certs - certificate output file
695 ./demoCA/.rnd - CA random seed information
699 The text database index file is a critical part of the process and
700 if corrupted it can be difficult to fix. It is theoretically possible
701 to rebuild the index file from all the issued certificates and a current
702 CRL: however there is no option to do this.
704 V2 CRL features like delta CRLs are not currently supported.
706 Although several requests can be input and handled at once it is only
707 possible to include one SPKAC or self-signed certificate.
711 The use of an in-memory text database can cause problems when large
712 numbers of certificates are present because, as the name implies
713 the database has to be kept in memory.
715 This command really needs rewriting or the required functionality
716 exposed at either a command or interface level so a more friendly utility
717 (perl script or GUI) can handle things properly. The script
718 B<CA.pl> helps a little but not very much.
720 Any fields in a request that are not present in a policy are silently
721 deleted. This does not happen if the B<-preserveDN> option is used. To
722 enforce the absence of the EMAIL field within the DN, as suggested by
723 RFCs, regardless the contents of the request' subject the B<-noemailDN>
724 option can be used. The behaviour should be more friendly and
727 Canceling some commands by refusing to certify a certificate can
728 create an empty file.
732 This command is quirky and at times downright unfriendly.
734 This command was originally meant as an example of how to do
735 things in a CA. It was not supposed to be used as a full blown CA itself:
736 nevertheless some people are using it for this purpose.
738 This command command is effectively a single user command: no locking
739 is done on the various files and attempts to run more than one B<openssl ca>
740 command on the same database can have unpredictable results.
742 The B<copy_extensions> option should be used with caution. If care is
743 not taken then it can be a security risk. For example if a certificate
744 request contains a basicConstraints extension with CA:TRUE and the
745 B<copy_extensions> value is set to B<copyall> and the user does not spot
746 this when the certificate is displayed then this will hand the requester
747 a valid CA certificate.
749 This situation can be avoided by setting B<copy_extensions> to B<copy>
750 and including basicConstraints with CA:FALSE in the configuration file.
751 Then if the request contains a basicConstraints extension it will be
754 It is advisable to also include values for other extensions such
755 as B<keyUsage> to prevent a request supplying its own values.
757 Additional restrictions can be placed on the CA certificate itself.
758 For example if the CA certificate has:
760 basicConstraints = CA:TRUE, pathlen:0
762 then even if a certificate is issued with CA:TRUE it will not be valid.
766 Since OpenSSL 1.1.1, the program follows RFC5280. Specifically,
767 certificate validity period (specified by any of B<-startdate>,
768 B<-enddate> and B<-days>) will be encoded as UTCTime if the dates are
769 earlier than year 2049 (included), and as GeneralizedTime if the dates
770 are in year 2050 or later.
784 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
786 Licensed under the Apache License 2.0 (the "License"). You may not use
787 this file except in compliance with the License. You can obtain a copy
788 in the file LICENSE in the source distribution or at
789 L<https://www.openssl.org/source/license.html>.