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