doc/apps/x509.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 x509 - Certificate display and signing utility
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<x509>
  11 [B<-inform DER|PEM|NET>]
  12 [B<-outform DER|PEM|NET>]
  13 [B<-keyform DER|PEM>]
  14 [B<-CAform DER|PEM>]
  15 [B<-CAkeyform DER|PEM>]
  16 [B<-in filename>]
  17 [B<-out filename>]
  18 [B<-serial>]
  19 [B<-hash>]
  20 [B<-subject_hash>]
  21 [B<-issuer_hash>]
  22 [B<-ocspid>]
  23 [B<-subject>]
  24 [B<-issuer>]
  25 [B<-nameopt option>]
  26 [B<-email>]
  27 [B<-ocsp_uri>]
  28 [B<-startdate>]
  29 [B<-enddate>]
  30 [B<-purpose>]
  31 [B<-dates>]
  32 [B<-checkend num>]
  33 [B<-modulus>]
  34 [B<-pubkey>]
  35 [B<-fingerprint>]
  36 [B<-alias>]
  37 [B<-noout>]
  38 [B<-trustout>]
  39 [B<-clrtrust>]
  40 [B<-clrreject>]
  41 [B<-addtrust arg>]
  42 [B<-addreject arg>]
  43 [B<-setalias arg>]
  44 [B<-days arg>]
  45 [B<-set_serial n>]
  46 [B<-signkey filename>]
  47 [B<-passin arg>]
  48 [B<-x509toreq>]
  49 [B<-req>]
  50 [B<-CA filename>]
  51 [B<-CAkey filename>]
  52 [B<-CAcreateserial>]
  53 [B<-CAserial filename>]
  54 [B<-force_pubkey key>]
  55 [B<-text>]
  56 [B<-certopt option>]
  57 [B<-C>]
  58 [B<-[digest]>]
  59 [B<-clrext>]
  60 [B<-extfile filename>]
  61 [B<-extensions section>]
  62 [B<-engine id>]
  63
  64 =head1 DESCRIPTION
  65
  66 The B<x509> command is a multi purpose certificate utility. It can be
  67 used to display certificate information, convert certificates to
  68 various forms, sign certificate requests like a "mini CA" or edit
  69 certificate trust settings.
  70
  71 Since there are a large number of options they will split up into
  72 various sections.
  73
  74 =head1 OPTIONS
  75
  76 =head2 INPUT, OUTPUT AND GENERAL PURPOSE OPTIONS
  77
  78 =over 4
  79
  80 =item B<-inform DER|PEM|NET>
  81
  82 This specifies the input format normally the command will expect an X509
  83 certificate but this can change if other options such as B<-req> are
  84 present. The DER format is the DER encoding of the certificate and PEM
  85 is the base64 encoding of the DER encoding with header and footer lines
  86 added. The NET option is an obscure Netscape server format that is now
  87 obsolete.
  88
  89 =item B<-outform DER|PEM|NET>
  90
  91 This specifies the output format, the options have the same meaning as the
  92 B<-inform> option.
  93
  94 =item B<-in filename>
  95
  96 This specifies the input filename to read a certificate from or standard input
  97 if this option is not specified.
  98
  99 =item B<-out filename>
 100
 101 This specifies the output filename to write to or standard output by
 102 default.
 103
 104 =item B<-[digest]>
 105
 106 the digest to use.
 107 This affects any signing or display option that uses a message
 108 digest, such as the B<-fingerprint>, B<-signkey> and B<-CA> options.
 109 Any digest supported by the OpenSSL B<dgst> command can be used.
 110 If not specified then SHA1 is used.
 111 Note that if a DSA key is used for signing, then this flag is ignored
 112 and SHA1 is used.
 113
 114 =item B<-engine id>
 115
 116 specifying an engine (by its unique B<id> string) will cause B<x509>
 117 to attempt to obtain a functional reference to the specified engine,
 118 thus initialising it if needed. The engine will then be set as the default
 119 for all available algorithms.
 120
 121 =back
 122
 123 =head2 DISPLAY OPTIONS
 124
 125 Note: the B<-alias> and B<-purpose> options are also display options
 126 but are described in the B<TRUST SETTINGS> section.
 127
 128 =over 4
 129
 130 =item B<-text>
 131
 132 prints out the certificate in text form. Full details are output including the
 133 public key, signature algorithms, issuer and subject names, serial number
 134 any extensions present and any trust settings.
 135
 136 =item B<-certopt option>
 137
 138 customise the output format used with B<-text>. The B<option> argument can be
 139 a single option or multiple options separated by commas. The B<-certopt> switch
 140 may be also be used more than once to set multiple options. See the B<TEXT OPTIONS>
 141 section for more information.
 142
 143 =item B<-noout>
 144
 145 this option prevents output of the encoded version of the request.
 146
 147 =item B<-pubkey>
 148
 149 outputs the the certificate's SubjectPublicKeyInfo block in PEM format.
 150
 151 =item B<-modulus>
 152
 153 this option prints out the value of the modulus of the public key
 154 contained in the certificate.
 155
 156 =item B<-serial>
 157
 158 outputs the certificate serial number.
 159
 160 =item B<-subject_hash>
 161
 162 outputs the "hash" of the certificate subject name. This is used in OpenSSL to
 163 form an index to allow certificates in a directory to be looked up by subject
 164 name.
 165
 166 =item B<-issuer_hash>
 167
 168 outputs the "hash" of the certificate issuer name.
 169
 170 =item B<-ocspid>
 171
 172 outputs the OCSP hash values for the subject name and public key.
 173
 174 =item B<-hash>
 175
 176 synonym for "-subject_hash" for backward compatibility reasons.
 177
 178 =item B<-subject_hash_old>
 179
 180 outputs the "hash" of the certificate subject name using the older algorithm
 181 as used by OpenSSL versions before 1.0.0.
 182
 183 =item B<-issuer_hash_old>
 184
 185 outputs the "hash" of the certificate issuer name using the older algorithm
 186 as used by OpenSSL versions before 1.0.0.
 187
 188 =item B<-subject>
 189
 190 outputs the subject name.
 191
 192 =item B<-issuer>
 193
 194 outputs the issuer name.
 195
 196 =item B<-nameopt option>
 197
 198 option which determines how the subject or issuer names are displayed. The
 199 B<option> argument can be a single option or multiple options separated by
 200 commas.  Alternatively the B<-nameopt> switch may be used more than once to
 201 set multiple options. See the B<NAME OPTIONS> section for more information.
 202
 203 =item B<-email>
 204
 205 outputs the email address(es) if any.
 206
 207 =item B<-ocsp_uri>
 208
 209 outputs the OCSP responder address(es) if any.
 210
 211 =item B<-startdate>
 212
 213 prints out the start date of the certificate, that is the notBefore date.
 214
 215 =item B<-enddate>
 216
 217 prints out the expiry date of the certificate, that is the notAfter date.
 218
 219 =item B<-dates>
 220
 221 prints out the start and expiry dates of a certificate.
 222
 223 =item B<-checkend arg>
 224
 225 checks if the certificate expires within the next B<arg> seconds and exits
 226 non-zero if yes it will expire or zero if not.
 227
 228 =item B<-fingerprint>
 229
 230 prints out the digest of the DER encoded version of the whole certificate
 231 (see digest options).
 232
 233 =item B<-C>
 234
 235 this outputs the certificate in the form of a C source file.
 236
 237 =back
 238
 239 =head2 TRUST SETTINGS
 240
 241 Please note these options are currently experimental and may well change.
 242
 243 A B<trusted certificate> is an ordinary certificate which has several
 244 additional pieces of information attached to it such as the permitted
 245 and prohibited uses of the certificate and an "alias".
 246
 247 Normally when a certificate is being verified at least one certificate
 248 must be "trusted". By default a trusted certificate must be stored
 249 locally and must be a root CA: any certificate chain ending in this CA
 250 is then usable for any purpose.
 251
 252 Trust settings currently are only used with a root CA. They allow a finer
 253 control over the purposes the root CA can be used for. For example a CA
 254 may be trusted for SSL client but not SSL server use.
 255
 256 See the description of the B<verify> utility for more information on the
 257 meaning of trust settings.
 258
 259 Future versions of OpenSSL will recognize trust settings on any
 260 certificate: not just root CAs.
 261
 262
 263 =over 4
 264
 265 =item B<-trustout>
 266
 267 this causes B<x509> to output a B<trusted> certificate. An ordinary
 268 or trusted certificate can be input but by default an ordinary
 269 certificate is output and any trust settings are discarded. With the
 270 B<-trustout> option a trusted certificate is output. A trusted
 271 certificate is automatically output if any trust settings are modified.
 272
 273 =item B<-setalias arg>
 274
 275 sets the alias of the certificate. This will allow the certificate
 276 to be referred to using a nickname for example "Steve's Certificate".
 277
 278 =item B<-alias>
 279
 280 outputs the certificate alias, if any.
 281
 282 =item B<-clrtrust>
 283
 284 clears all the permitted or trusted uses of the certificate.
 285
 286 =item B<-clrreject>
 287
 288 clears all the prohibited or rejected uses of the certificate.
 289
 290 =item B<-addtrust arg>
 291
 292 adds a trusted certificate use. Any object name can be used here
 293 but currently only B<clientAuth> (SSL client use), B<serverAuth>
 294 (SSL server use) and B<emailProtection> (S/MIME email) are used.
 295 Other OpenSSL applications may define additional uses.
 296
 297 =item B<-addreject arg>
 298
 299 adds a prohibited use. It accepts the same values as the B<-addtrust>
 300 option.
 301
 302 =item B<-purpose>
 303
 304 this option performs tests on the certificate extensions and outputs
 305 the results. For a more complete description see the B<CERTIFICATE
 306 EXTENSIONS> section.
 307
 308 =back
 309
 310 =head2 SIGNING OPTIONS
 311
 312 The B<x509> utility can be used to sign certificates and requests: it
 313 can thus behave like a "mini CA".
 314
 315 =over 4
 316
 317 =item B<-signkey filename>
 318
 319 this option causes the input file to be self signed using the supplied
 320 private key.
 321
 322 If the input file is a certificate it sets the issuer name to the
 323 subject name (i.e.  makes it self signed) changes the public key to the
 324 supplied value and changes the start and end dates. The start date is
 325 set to the current time and the end date is set to a value determined
 326 by the B<-days> option. Any certificate extensions are retained unless
 327 the B<-clrext> option is supplied.
 328
 329 If the input is a certificate request then a self signed certificate
 330 is created using the supplied private key using the subject name in
 331 the request.
 332
 333 =item B<-passin arg>
 334
 335 the key password source. For more information about the format of B<arg>
 336 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
 337
 338 =item B<-clrext>
 339
 340 delete any extensions from a certificate. This option is used when a
 341 certificate is being created from another certificate (for example with
 342 the B<-signkey> or the B<-CA> options). Normally all extensions are
 343 retained.
 344
 345 =item B<-keyform PEM|DER>
 346
 347 specifies the format (DER or PEM) of the private key file used in the
 348 B<-signkey> option.
 349
 350 =item B<-days arg>
 351
 352 specifies the number of days to make a certificate valid for. The default
 353 is 30 days.
 354
 355 =item B<-x509toreq>
 356
 357 converts a certificate into a certificate request. The B<-signkey> option
 358 is used to pass the required private key.
 359
 360 =item B<-req>
 361
 362 by default a certificate is expected on input. With this option a
 363 certificate request is expected instead.
 364
 365 =item B<-set_serial n>
 366
 367 specifies the serial number to use. This option can be used with either
 368 the B<-signkey> or B<-CA> options. If used in conjunction with the B<-CA>
 369 option the serial number file (as specified by the B<-CAserial> or
 370 B<-CAcreateserial> options) is not used.
 371
 372 The serial number can be decimal or hex (if preceded by B<0x>).
 373
 374 =item B<-CA filename>
 375
 376 specifies the CA certificate to be used for signing. When this option is
 377 present B<x509> behaves like a "mini CA". The input file is signed by this
 378 CA using this option: that is its issuer name is set to the subject name
 379 of the CA and it is digitally signed using the CAs private key.
 380
 381 This option is normally combined with the B<-req> option. Without the
 382 B<-req> option the input is a certificate which must be self signed.
 383
 384 =item B<-CAkey filename>
 385
 386 sets the CA private key to sign a certificate with. If this option is
 387 not specified then it is assumed that the CA private key is present in
 388 the CA certificate file.
 389
 390 =item B<-CAserial filename>
 391
 392 sets the CA serial number file to use.
 393
 394 When the B<-CA> option is used to sign a certificate it uses a serial
 395 number specified in a file. This file consist of one line containing
 396 an even number of hex digits with the serial number to use. After each
 397 use the serial number is incremented and written out to the file again.
 398
 399 The default filename consists of the CA certificate file base name with
 400 ".srl" appended. For example if the CA certificate file is called
 401 "mycacert.pem" it expects to find a serial number file called "mycacert.srl".
 402
 403 =item B<-CAcreateserial>
 404
 405 with this option the CA serial number file is created if it does not exist:
 406 it will contain the serial number "02" and the certificate being signed will
 407 have the 1 as its serial number. If the B<-CA> option is specified
 408 and the serial number file does not exist a random number is generated;
 409 this is the recommended practice.
 410
 411 =item B<-extfile filename>
 412
 413 file containing certificate extensions to use. If not specified then
 414 no extensions are added to the certificate.
 415
 416 =item B<-extensions section>
 417
 418 the section to add certificate extensions from. If this option is not
 419 specified then the extensions should either be contained in the unnamed
 420 (default) section or the default section should contain a variable called
 421 "extensions" which contains the section to use. See the
 422 L<x509v3_config(5)> manual page for details of the
 423 extension section format.
 424
 425 =item B<-force_pubkey key>
 426
 427 when a certificate is created set its public key to B<key> instead of the
 428 key in the certificate or certificate request. This option is useful for
 429 creating certificates where the algorithm can't normally sign requests, for
 430 example DH.
 431
 432 The format or B<key> can be specified using the B<-keyform> option.
 433
 434 =back
 435
 436 =head2 NAME OPTIONS
 437
 438 The B<nameopt> command line switch determines how the subject and issuer
 439 names are displayed. If no B<nameopt> switch is present the default "oneline"
 440 format is used which is compatible with previous versions of OpenSSL.
 441 Each option is described in detail below, all options can be preceded by
 442 a B<-> to turn the option off. Only the first four will normally be used.
 443
 444 =over 4
 445
 446 =item B<compat>
 447
 448 use the old format.
 449
 450 =item B<RFC2253>
 451
 452 displays names compatible with RFC2253 equivalent to B<esc_2253>, B<esc_ctrl>,
 453 B<esc_msb>, B<utf8>, B<dump_nostr>, B<dump_unknown>, B<dump_der>,
 454 B<sep_comma_plus>, B<dn_rev> and B<sname>.
 455
 456 =item B<oneline>
 457
 458 a oneline format which is more readable than RFC2253. It is equivalent to
 459 specifying the  B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>, B<dump_nostr>,
 460 B<dump_der>, B<use_quote>, B<sep_comma_plus_space>, B<space_eq> and B<sname>
 461 options.  This is the I<default> of no name options are given explicitely.
 462
 463 =item B<multiline>
 464
 465 a multiline format. It is equivalent B<esc_ctrl>, B<esc_msb>, B<sep_multiline>,
 466 B<space_eq>, B<lname> and B<align>.
 467
 468 =item B<esc_2253>
 469
 470 escape the "special" characters required by RFC2253 in a field That is
 471 B<,+"E<lt>E<gt>;>. Additionally B<#> is escaped at the beginning of a string
 472 and a space character at the beginning or end of a string.
 473
 474 =item B<esc_ctrl>
 475
 476 escape control characters. That is those with ASCII values less than
 477 0x20 (space) and the delete (0x7f) character. They are escaped using the
 478 RFC2253 \XX notation (where XX are two hex digits representing the
 479 character value).
 480
 481 =item B<esc_msb>
 482
 483 escape characters with the MSB set, that is with ASCII values larger than
 484 127.
 485
 486 =item B<use_quote>
 487
 488 escapes some characters by surrounding the whole string with B<"> characters,
 489 without the option all escaping is done with the B<\> character.
 490
 491 =item B<utf8>
 492
 493 convert all strings to UTF8 format first. This is required by RFC2253. If
 494 you are lucky enough to have a UTF8 compatible terminal then the use
 495 of this option (and B<not> setting B<esc_msb>) may result in the correct
 496 display of multibyte (international) characters. Is this option is not
 497 present then multibyte characters larger than 0xff will be represented
 498 using the format \UXXXX for 16 bits and \WXXXXXXXX for 32 bits.
 499 Also if this option is off any UTF8Strings will be converted to their
 500 character form first.
 501
 502 =item B<ignore_type>
 503
 504 this option does not attempt to interpret multibyte characters in any
 505 way. That is their content octets are merely dumped as though one octet
 506 represents each character. This is useful for diagnostic purposes but
 507 will result in rather odd looking output.
 508
 509 =item B<show_type>
 510
 511 show the type of the ASN1 character string. The type precedes the
 512 field contents. For example "BMPSTRING: Hello World".
 513
 514 =item B<dump_der>
 515
 516 when this option is set any fields that need to be hexdumped will
 517 be dumped using the DER encoding of the field. Otherwise just the
 518 content octets will be displayed. Both options use the RFC2253
 519 B<#XXXX...> format.
 520
 521 =item B<dump_nostr>
 522
 523 dump non character string types (for example OCTET STRING) if this
 524 option is not set then non character string types will be displayed
 525 as though each content octet represents a single character.
 526
 527 =item B<dump_all>
 528
 529 dump all fields. This option when used with B<dump_der> allows the
 530 DER encoding of the structure to be unambiguously determined.
 531
 532 =item B<dump_unknown>
 533
 534 dump any field whose OID is not recognised by OpenSSL.
 535
 536 =item B<sep_comma_plus>, B<sep_comma_plus_space>, B<sep_semi_plus_space>,
 537 B<sep_multiline>
 538
 539 these options determine the field separators. The first character is
 540 between RDNs and the second between multiple AVAs (multiple AVAs are
 541 very rare and their use is discouraged). The options ending in
 542 "space" additionally place a space after the separator to make it
 543 more readable. The B<sep_multiline> uses a linefeed character for
 544 the RDN separator and a spaced B<+> for the AVA separator. It also
 545 indents the fields by four characters.
 546
 547 =item B<dn_rev>
 548
 549 reverse the fields of the DN. This is required by RFC2253. As a side
 550 effect this also reverses the order of multiple AVAs but this is
 551 permissible.
 552
 553 =item B<nofname>, B<sname>, B<lname>, B<oid>
 554
 555 these options alter how the field name is displayed. B<nofname> does
 556 not display the field at all. B<sname> uses the "short name" form
 557 (CN for commonName for example). B<lname> uses the long form.
 558 B<oid> represents the OID in numerical form and is useful for
 559 diagnostic purpose.
 560
 561 =item B<align>
 562
 563 align field values for a more readable output. Only usable with
 564 B<sep_multiline>.
 565
 566 =item B<space_eq>
 567
 568 places spaces round the B<=> character which follows the field
 569 name.
 570
 571 =back
 572
 573 =head2 TEXT OPTIONS
 574
 575 As well as customising the name output format, it is also possible to
 576 customise the actual fields printed using the B<certopt> options when
 577 the B<text> option is present. The default behaviour is to print all fields.
 578
 579 =over 4
 580
 581 =item B<compatible>
 582
 583 use the old format. This is equivalent to specifying no output options at all.
 584
 585 =item B<no_header>
 586
 587 don't print header information: that is the lines saying "Certificate" and "Data".
 588
 589 =item B<no_version>
 590
 591 don't print out the version number.
 592
 593 =item B<no_serial>
 594
 595 don't print out the serial number.
 596
 597 =item B<no_signame>
 598
 599 don't print out the signature algorithm used.
 600
 601 =item B<no_validity>
 602
 603 don't print the validity, that is the B<notBefore> and B<notAfter> fields.
 604
 605 =item B<no_subject>
 606
 607 don't print out the subject name.
 608
 609 =item B<no_issuer>
 610
 611 don't print out the issuer name.
 612
 613 =item B<no_pubkey>
 614
 615 don't print out the public key.
 616
 617 =item B<no_sigdump>
 618
 619 don't give a hexadecimal dump of the certificate signature.
 620
 621 =item B<no_aux>
 622
 623 don't print out certificate trust information.
 624
 625 =item B<no_extensions>
 626
 627 don't print out any X509V3 extensions.
 628
 629 =item B<ext_default>
 630
 631 retain default extension behaviour: attempt to print out unsupported certificate extensions.
 632
 633 =item B<ext_error>
 634
 635 print an error message for unsupported certificate extensions.
 636
 637 =item B<ext_parse>
 638
 639 ASN1 parse unsupported extensions.
 640
 641 =item B<ext_dump>
 642
 643 hex dump unsupported extensions.
 644
 645 =item B<ca_default>
 646
 647 the value used by the B<ca> utility, equivalent to B<no_issuer>, B<no_pubkey>, B<no_header>,
 648 B<no_version>, B<no_sigdump> and B<no_signame>.
 649
 650 =back
 651
 652 =head1 EXAMPLES
 653
 654 Note: in these examples the '\' means the example should be all on one
 655 line.
 656
 657 Display the contents of a certificate:
 658
 659  openssl x509 -in cert.pem -noout -text
 660
 661 Display the certificate serial number:
 662
 663  openssl x509 -in cert.pem -noout -serial
 664
 665 Display the certificate subject name:
 666
 667  openssl x509 -in cert.pem -noout -subject
 668
 669 Display the certificate subject name in RFC2253 form:
 670
 671  openssl x509 -in cert.pem -noout -subject -nameopt RFC2253
 672
 673 Display the certificate subject name in oneline form on a terminal
 674 supporting UTF8:
 675
 676  openssl x509 -in cert.pem -noout -subject -nameopt oneline,-esc_msb
 677
 678 Display the certificate MD5 fingerprint:
 679
 680  openssl x509 -in cert.pem -noout -fingerprint
 681
 682 Display the certificate SHA1 fingerprint:
 683
 684  openssl x509 -sha1 -in cert.pem -noout -fingerprint
 685
 686 Convert a certificate from PEM to DER format:
 687
 688  openssl x509 -in cert.pem -inform PEM -out cert.der -outform DER
 689
 690 Convert a certificate to a certificate request:
 691
 692  openssl x509 -x509toreq -in cert.pem -out req.pem -signkey key.pem
 693
 694 Convert a certificate request into a self signed certificate using
 695 extensions for a CA:
 696
 697  openssl x509 -req -in careq.pem -extfile openssl.cnf -extensions v3_ca \
 698         -signkey key.pem -out cacert.pem
 699
 700 Sign a certificate request using the CA certificate above and add user
 701 certificate extensions:
 702
 703  openssl x509 -req -in req.pem -extfile openssl.cnf -extensions v3_usr \
 704         -CA cacert.pem -CAkey key.pem -CAcreateserial
 705
 706
 707 Set a certificate to be trusted for SSL client use and change set its alias to
 708 "Steve's Class 1 CA"
 709
 710  openssl x509 -in cert.pem -addtrust clientAuth \
 711         -setalias "Steve's Class 1 CA" -out trust.pem
 712
 713 =head1 NOTES
 714
 715 The PEM format uses the header and footer lines:
 716
 717  -----BEGIN CERTIFICATE-----
 718  -----END CERTIFICATE-----
 719
 720 it will also handle files containing:
 721
 722  -----BEGIN X509 CERTIFICATE-----
 723  -----END X509 CERTIFICATE-----
 724
 725 Trusted certificates have the lines
 726
 727  -----BEGIN TRUSTED CERTIFICATE-----
 728  -----END TRUSTED CERTIFICATE-----
 729
 730 The conversion to UTF8 format used with the name options assumes that
 731 T61Strings use the ISO8859-1 character set. This is wrong but Netscape
 732 and MSIE do this as do many certificates. So although this is incorrect
 733 it is more likely to display the majority of certificates correctly.
 734
 735 The B<-fingerprint> option takes the digest of the DER encoded certificate.
 736 This is commonly called a "fingerprint". Because of the nature of message
 737 digests the fingerprint of a certificate is unique to that certificate and
 738 two certificates with the same fingerprint can be considered to be the same.
 739
 740 The Netscape fingerprint uses MD5 whereas MSIE uses SHA1.
 741
 742 The B<-email> option searches the subject name and the subject alternative
 743 name extension. Only unique email addresses will be printed out: it will
 744 not print the same address more than once.
 745
 746 =head1 CERTIFICATE EXTENSIONS
 747
 748 The B<-purpose> option checks the certificate extensions and determines
 749 what the certificate can be used for. The actual checks done are rather
 750 complex and include various hacks and workarounds to handle broken
 751 certificates and software.
 752
 753 The same code is used when verifying untrusted certificates in chains
 754 so this section is useful if a chain is rejected by the verify code.
 755
 756 The basicConstraints extension CA flag is used to determine whether the
 757 certificate can be used as a CA. If the CA flag is true then it is a CA,
 758 if the CA flag is false then it is not a CA. B<All> CAs should have the
 759 CA flag set to true.
 760
 761 If the basicConstraints extension is absent then the certificate is
 762 considered to be a "possible CA" other extensions are checked according
 763 to the intended use of the certificate. A warning is given in this case
 764 because the certificate should really not be regarded as a CA: however
 765 it is allowed to be a CA to work around some broken software.
 766
 767 If the certificate is a V1 certificate (and thus has no extensions) and
 768 it is self signed it is also assumed to be a CA but a warning is again
 769 given: this is to work around the problem of Verisign roots which are V1
 770 self signed certificates.
 771
 772 If the keyUsage extension is present then additional restraints are
 773 made on the uses of the certificate. A CA certificate B<must> have the
 774 keyCertSign bit set if the keyUsage extension is present.
 775
 776 The extended key usage extension places additional restrictions on the
 777 certificate uses. If this extension is present (whether critical or not)
 778 the key can only be used for the purposes specified.
 779
 780 A complete description of each test is given below. The comments about
 781 basicConstraints and keyUsage and V1 certificates above apply to B<all>
 782 CA certificates.
 783
 784
 785 =over 4
 786
 787 =item B<SSL Client>
 788
 789 The extended key usage extension must be absent or include the "web client
 790 authentication" OID.  keyUsage must be absent or it must have the
 791 digitalSignature bit set. Netscape certificate type must be absent or it must
 792 have the SSL client bit set.
 793
 794 =item B<SSL Client CA>
 795
 796 The extended key usage extension must be absent or include the "web client
 797 authentication" OID. Netscape certificate type must be absent or it must have
 798 the SSL CA bit set: this is used as a work around if the basicConstraints
 799 extension is absent.
 800
 801 =item B<SSL Server>
 802
 803 The extended key usage extension must be absent or include the "web server
 804 authentication" and/or one of the SGC OIDs.  keyUsage must be absent or it
 805 must have the digitalSignature, the keyEncipherment set or both bits set.
 806 Netscape certificate type must be absent or have the SSL server bit set.
 807
 808 =item B<SSL Server CA>
 809
 810 The extended key usage extension must be absent or include the "web server
 811 authentication" and/or one of the SGC OIDs.  Netscape certificate type must
 812 be absent or the SSL CA bit must be set: this is used as a work around if the
 813 basicConstraints extension is absent.
 814
 815 =item B<Netscape SSL Server>
 816
 817 For Netscape SSL clients to connect to an SSL server it must have the
 818 keyEncipherment bit set if the keyUsage extension is present. This isn't
 819 always valid because some cipher suites use the key for digital signing.
 820 Otherwise it is the same as a normal SSL server.
 821
 822 =item B<Common S/MIME Client Tests>
 823
 824 The extended key usage extension must be absent or include the "email
 825 protection" OID. Netscape certificate type must be absent or should have the
 826 S/MIME bit set. If the S/MIME bit is not set in netscape certificate type
 827 then the SSL client bit is tolerated as an alternative but a warning is shown:
 828 this is because some Verisign certificates don't set the S/MIME bit.
 829
 830 =item B<S/MIME Signing>
 831
 832 In addition to the common S/MIME client tests the digitalSignature bit must
 833 be set if the keyUsage extension is present.
 834
 835 =item B<S/MIME Encryption>
 836
 837 In addition to the common S/MIME tests the keyEncipherment bit must be set
 838 if the keyUsage extension is present.
 839
 840 =item B<S/MIME CA>
 841
 842 The extended key usage extension must be absent or include the "email
 843 protection" OID. Netscape certificate type must be absent or must have the
 844 S/MIME CA bit set: this is used as a work around if the basicConstraints
 845 extension is absent.
 846
 847 =item B<CRL Signing>
 848
 849 The keyUsage extension must be absent or it must have the CRL signing bit
 850 set.
 851
 852 =item B<CRL Signing CA>
 853
 854 The normal CA tests apply. Except in this case the basicConstraints extension
 855 must be present.
 856
 857 =back
 858
 859 =head1 BUGS
 860
 861 Extensions in certificates are not transferred to certificate requests and
 862 vice versa.
 863
 864 It is possible to produce invalid certificates or requests by specifying the
 865 wrong private key or using inconsistent options in some cases: these should
 866 be checked.
 867
 868 There should be options to explicitly set such things as start and end
 869 dates rather than an offset from the current time.
 870
 871 The code to implement the verify behaviour described in the B<TRUST SETTINGS>
 872 is currently being developed. It thus describes the intended behaviour rather
 873 than the current behaviour. It is hoped that it will represent reality in
 874 OpenSSL 0.9.5 and later.
 875
 876 =head1 SEE ALSO
 877
 878 L<req(1)>, L<ca(1)>, L<genrsa(1)>,
 879 L<gendsa(1)>, L<verify(1)>,
 880 L<x509v3_config(5)>
 881
 882 =head1 HISTORY
 883
 884 Before OpenSSL 0.9.8, the default digest for RSA keys was MD5.
 885
 886 The hash algorithm used in the B<-subject_hash> and B<-issuer_hash> options
 887 before OpenSSL 1.0.0 was based on the deprecated MD5 algorithm and the encoding
 888 of the distinguished name. In OpenSSL 1.0.0 and later it is based on a
 889 canonical version of the DN using SHA1. This means that any directories using
 890 the old form must have their links rebuilt using B<c_rehash> or similar.
 891
 892 =cut