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