doc/apps/ca.pod

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