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