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