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