6 x509 - Certificate display and signing utility
12 [B<-inform DER|PEM|NET>]
13 [B<-outform DER|PEM|NET>]
16 [B<-CAkeyform DER|PEM>]
47 [B<-signkey filename>]
54 [B<-CAserial filename>]
55 [B<-force_pubkey key>]
61 [B<-extfile filename>]
62 [B<-extensions section>]
67 The B<x509> command is a multi purpose certificate utility. It can be
68 used to display certificate information, convert certificates to
69 various forms, sign certificate requests like a "mini CA" or edit
70 certificate trust settings.
72 Since there are a large number of options they will split up into
77 =head2 INPUT, OUTPUT AND GENERAL PURPOSE OPTIONS
83 Print out a usage message.
85 =item B<-inform DER|PEM|NET>
87 This specifies the input format normally the command will expect an X509
88 certificate but this can change if other options such as B<-req> are
89 present. The DER format is the DER encoding of the certificate and PEM
90 is the base64 encoding of the DER encoding with header and footer lines
91 added. The NET option is an obscure Netscape server format that is now
94 =item B<-outform DER|PEM|NET>
96 This specifies the output format, the options have the same meaning as the
101 This specifies the input filename to read a certificate from or standard input
102 if this option is not specified.
104 =item B<-out filename>
106 This specifies the output filename to write to or standard output by
112 This affects any signing or display option that uses a message
113 digest, such as the B<-fingerprint>, B<-signkey> and B<-CA> options.
114 Any digest supported by the OpenSSL B<dgst> command can be used.
115 If not specified then SHA1 is used.
116 Note that if a DSA key is used for signing, then this flag is ignored
121 specifying an engine (by its unique B<id> string) will cause B<x509>
122 to attempt to obtain a functional reference to the specified engine,
123 thus initialising it if needed. The engine will then be set as the default
124 for all available algorithms.
128 =head2 DISPLAY OPTIONS
130 Note: the B<-alias> and B<-purpose> options are also display options
131 but are described in the B<TRUST SETTINGS> section.
137 prints out the certificate in text form. Full details are output including the
138 public key, signature algorithms, issuer and subject names, serial number
139 any extensions present and any trust settings.
141 =item B<-certopt option>
143 customise the output format used with B<-text>. The B<option> argument can be
144 a single option or multiple options separated by commas. The B<-certopt> switch
145 may be also be used more than once to set multiple options. See the B<TEXT OPTIONS>
146 section for more information.
150 this option prevents output of the encoded version of the request.
154 outputs the the certificate's SubjectPublicKeyInfo block in PEM format.
158 this option prints out the value of the modulus of the public key
159 contained in the certificate.
163 outputs the certificate serial number.
165 =item B<-subject_hash>
167 outputs the "hash" of the certificate subject name. This is used in OpenSSL to
168 form an index to allow certificates in a directory to be looked up by subject
171 =item B<-issuer_hash>
173 outputs the "hash" of the certificate issuer name.
177 outputs the OCSP hash values for the subject name and public key.
181 synonym for "-subject_hash" for backward compatibility reasons.
183 =item B<-subject_hash_old>
185 outputs the "hash" of the certificate subject name using the older algorithm
186 as used by OpenSSL versions before 1.0.0.
188 =item B<-issuer_hash_old>
190 outputs the "hash" of the certificate issuer name using the older algorithm
191 as used by OpenSSL versions before 1.0.0.
195 outputs the subject name.
199 outputs the issuer name.
201 =item B<-nameopt option>
203 option which determines how the subject or issuer names are displayed. The
204 B<option> argument can be a single option or multiple options separated by
205 commas. Alternatively the B<-nameopt> switch may be used more than once to
206 set multiple options. See the B<NAME OPTIONS> section for more information.
210 outputs the email address(es) if any.
214 outputs the OCSP responder address(es) if any.
218 prints out the start date of the certificate, that is the notBefore date.
222 prints out the expiry date of the certificate, that is the notAfter date.
226 prints out the start and expiry dates of a certificate.
228 =item B<-checkend arg>
230 checks if the certificate expires within the next B<arg> seconds and exits
231 non-zero if yes it will expire or zero if not.
233 =item B<-fingerprint>
235 prints out the digest of the DER encoded version of the whole certificate
236 (see digest options).
240 this outputs the certificate in the form of a C source file.
244 =head2 TRUST SETTINGS
246 Please note these options are currently experimental and may well change.
248 A B<trusted certificate> is an ordinary certificate which has several
249 additional pieces of information attached to it such as the permitted
250 and prohibited uses of the certificate and an "alias".
252 Normally when a certificate is being verified at least one certificate
253 must be "trusted". By default a trusted certificate must be stored
254 locally and must be a root CA: any certificate chain ending in this CA
255 is then usable for any purpose.
257 Trust settings currently are only used with a root CA. They allow a finer
258 control over the purposes the root CA can be used for. For example a CA
259 may be trusted for SSL client but not SSL server use.
261 See the description of the B<verify> utility for more information on the
262 meaning of trust settings.
264 Future versions of OpenSSL will recognize trust settings on any
265 certificate: not just root CAs.
272 this causes B<x509> to output a B<trusted> certificate. An ordinary
273 or trusted certificate can be input but by default an ordinary
274 certificate is output and any trust settings are discarded. With the
275 B<-trustout> option a trusted certificate is output. A trusted
276 certificate is automatically output if any trust settings are modified.
278 =item B<-setalias arg>
280 sets the alias of the certificate. This will allow the certificate
281 to be referred to using a nickname for example "Steve's Certificate".
285 outputs the certificate alias, if any.
289 clears all the permitted or trusted uses of the certificate.
293 clears all the prohibited or rejected uses of the certificate.
295 =item B<-addtrust arg>
297 adds a trusted certificate use.
298 Any object name can be used here but currently only B<clientAuth> (SSL client
299 use), B<serverAuth> (SSL server use), B<emailProtection> (S/MIME email) and
300 B<anyExtendedKeyUsage> are used.
301 As of OpenSSL 1.1.0, the last of these blocks all purposes when rejected or
302 enables all purposes when trusted.
303 Other OpenSSL applications may define additional uses.
305 =item B<-addreject arg>
307 adds a prohibited use. It accepts the same values as the B<-addtrust>
312 this option performs tests on the certificate extensions and outputs
313 the results. For a more complete description see the B<CERTIFICATE
318 =head2 SIGNING OPTIONS
320 The B<x509> utility can be used to sign certificates and requests: it
321 can thus behave like a "mini CA".
325 =item B<-signkey filename>
327 this option causes the input file to be self signed using the supplied
330 If the input file is a certificate it sets the issuer name to the
331 subject name (i.e. makes it self signed) changes the public key to the
332 supplied value and changes the start and end dates. The start date is
333 set to the current time and the end date is set to a value determined
334 by the B<-days> option. Any certificate extensions are retained unless
335 the B<-clrext> option is supplied.
337 If the input is a certificate request then a self signed certificate
338 is created using the supplied private key using the subject name in
343 the key password source. For more information about the format of B<arg>
344 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
348 delete any extensions from a certificate. This option is used when a
349 certificate is being created from another certificate (for example with
350 the B<-signkey> or the B<-CA> options). Normally all extensions are
353 =item B<-keyform PEM|DER>
355 specifies the format (DER or PEM) of the private key file used in the
360 specifies the number of days to make a certificate valid for. The default
365 converts a certificate into a certificate request. The B<-signkey> option
366 is used to pass the required private key.
370 by default a certificate is expected on input. With this option a
371 certificate request is expected instead.
373 =item B<-set_serial n>
375 specifies the serial number to use. This option can be used with either
376 the B<-signkey> or B<-CA> options. If used in conjunction with the B<-CA>
377 option the serial number file (as specified by the B<-CAserial> or
378 B<-CAcreateserial> options) is not used.
380 The serial number can be decimal or hex (if preceded by B<0x>).
382 =item B<-CA filename>
384 specifies the CA certificate to be used for signing. When this option is
385 present B<x509> behaves like a "mini CA". The input file is signed by this
386 CA using this option: that is its issuer name is set to the subject name
387 of the CA and it is digitally signed using the CAs private key.
389 This option is normally combined with the B<-req> option. Without the
390 B<-req> option the input is a certificate which must be self signed.
392 =item B<-CAkey filename>
394 sets the CA private key to sign a certificate with. If this option is
395 not specified then it is assumed that the CA private key is present in
396 the CA certificate file.
398 =item B<-CAserial filename>
400 sets the CA serial number file to use.
402 When the B<-CA> option is used to sign a certificate it uses a serial
403 number specified in a file. This file consist of one line containing
404 an even number of hex digits with the serial number to use. After each
405 use the serial number is incremented and written out to the file again.
407 The default filename consists of the CA certificate file base name with
408 ".srl" appended. For example if the CA certificate file is called
409 "mycacert.pem" it expects to find a serial number file called "mycacert.srl".
411 =item B<-CAcreateserial>
413 with this option the CA serial number file is created if it does not exist:
414 it will contain the serial number "02" and the certificate being signed will
415 have the 1 as its serial number. If the B<-CA> option is specified
416 and the serial number file does not exist a random number is generated;
417 this is the recommended practice.
419 =item B<-extfile filename>
421 file containing certificate extensions to use. If not specified then
422 no extensions are added to the certificate.
424 =item B<-extensions section>
426 the section to add certificate extensions from. If this option is not
427 specified then the extensions should either be contained in the unnamed
428 (default) section or the default section should contain a variable called
429 "extensions" which contains the section to use. See the
430 L<x509v3_config(5)> manual page for details of the
431 extension section format.
433 =item B<-force_pubkey key>
435 when a certificate is created set its public key to B<key> instead of the
436 key in the certificate or certificate request. This option is useful for
437 creating certificates where the algorithm can't normally sign requests, for
440 The format or B<key> can be specified using the B<-keyform> option.
446 The B<nameopt> command line switch determines how the subject and issuer
447 names are displayed. If no B<nameopt> switch is present the default "oneline"
448 format is used which is compatible with previous versions of OpenSSL.
449 Each option is described in detail below, all options can be preceded by
450 a B<-> to turn the option off. Only the first four will normally be used.
460 displays names compatible with RFC2253 equivalent to B<esc_2253>, B<esc_ctrl>,
461 B<esc_msb>, B<utf8>, B<dump_nostr>, B<dump_unknown>, B<dump_der>,
462 B<sep_comma_plus>, B<dn_rev> and B<sname>.
466 a oneline format which is more readable than RFC2253. It is equivalent to
467 specifying the B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>, B<dump_nostr>,
468 B<dump_der>, B<use_quote>, B<sep_comma_plus_space>, B<space_eq> and B<sname>
469 options. This is the I<default> of no name options are given explicitely.
473 a multiline format. It is equivalent B<esc_ctrl>, B<esc_msb>, B<sep_multiline>,
474 B<space_eq>, B<lname> and B<align>.
478 escape the "special" characters required by RFC2253 in a field That is
479 B<,+"E<lt>E<gt>;>. Additionally B<#> is escaped at the beginning of a string
480 and a space character at the beginning or end of a string.
484 escape control characters. That is those with ASCII values less than
485 0x20 (space) and the delete (0x7f) character. They are escaped using the
486 RFC2253 \XX notation (where XX are two hex digits representing the
491 escape characters with the MSB set, that is with ASCII values larger than
496 escapes some characters by surrounding the whole string with B<"> characters,
497 without the option all escaping is done with the B<\> character.
501 convert all strings to UTF8 format first. This is required by RFC2253. If
502 you are lucky enough to have a UTF8 compatible terminal then the use
503 of this option (and B<not> setting B<esc_msb>) may result in the correct
504 display of multibyte (international) characters. Is this option is not
505 present then multibyte characters larger than 0xff will be represented
506 using the format \UXXXX for 16 bits and \WXXXXXXXX for 32 bits.
507 Also if this option is off any UTF8Strings will be converted to their
508 character form first.
512 this option does not attempt to interpret multibyte characters in any
513 way. That is their content octets are merely dumped as though one octet
514 represents each character. This is useful for diagnostic purposes but
515 will result in rather odd looking output.
519 show the type of the ASN1 character string. The type precedes the
520 field contents. For example "BMPSTRING: Hello World".
524 when this option is set any fields that need to be hexdumped will
525 be dumped using the DER encoding of the field. Otherwise just the
526 content octets will be displayed. Both options use the RFC2253
531 dump non character string types (for example OCTET STRING) if this
532 option is not set then non character string types will be displayed
533 as though each content octet represents a single character.
537 dump all fields. This option when used with B<dump_der> allows the
538 DER encoding of the structure to be unambiguously determined.
540 =item B<dump_unknown>
542 dump any field whose OID is not recognised by OpenSSL.
544 =item B<sep_comma_plus>, B<sep_comma_plus_space>, B<sep_semi_plus_space>,
547 these options determine the field separators. The first character is
548 between RDNs and the second between multiple AVAs (multiple AVAs are
549 very rare and their use is discouraged). The options ending in
550 "space" additionally place a space after the separator to make it
551 more readable. The B<sep_multiline> uses a linefeed character for
552 the RDN separator and a spaced B<+> for the AVA separator. It also
553 indents the fields by four characters. If no field separator is specified
554 then B<sep_comma_plus_space> is used by default.
558 reverse the fields of the DN. This is required by RFC2253. As a side
559 effect this also reverses the order of multiple AVAs but this is
562 =item B<nofname>, B<sname>, B<lname>, B<oid>
564 these options alter how the field name is displayed. B<nofname> does
565 not display the field at all. B<sname> uses the "short name" form
566 (CN for commonName for example). B<lname> uses the long form.
567 B<oid> represents the OID in numerical form and is useful for
572 align field values for a more readable output. Only usable with
577 places spaces round the B<=> character which follows the field
584 As well as customising the name output format, it is also possible to
585 customise the actual fields printed using the B<certopt> options when
586 the B<text> option is present. The default behaviour is to print all fields.
592 use the old format. This is equivalent to specifying no output options at all.
596 don't print header information: that is the lines saying "Certificate" and "Data".
600 don't print out the version number.
604 don't print out the serial number.
608 don't print out the signature algorithm used.
612 don't print the validity, that is the B<notBefore> and B<notAfter> fields.
616 don't print out the subject name.
620 don't print out the issuer name.
624 don't print out the public key.
628 don't give a hexadecimal dump of the certificate signature.
632 don't print out certificate trust information.
634 =item B<no_extensions>
636 don't print out any X509V3 extensions.
640 retain default extension behaviour: attempt to print out unsupported certificate extensions.
644 print an error message for unsupported certificate extensions.
648 ASN1 parse unsupported extensions.
652 hex dump unsupported extensions.
656 the value used by the B<ca> utility, equivalent to B<no_issuer>, B<no_pubkey>, B<no_header>,
657 B<no_version>, B<no_sigdump> and B<no_signame>.
663 Note: in these examples the '\' means the example should be all on one
666 Display the contents of a certificate:
668 openssl x509 -in cert.pem -noout -text
670 Display the certificate serial number:
672 openssl x509 -in cert.pem -noout -serial
674 Display the certificate subject name:
676 openssl x509 -in cert.pem -noout -subject
678 Display the certificate subject name in RFC2253 form:
680 openssl x509 -in cert.pem -noout -subject -nameopt RFC2253
682 Display the certificate subject name in oneline form on a terminal
685 openssl x509 -in cert.pem -noout -subject -nameopt oneline,-esc_msb
687 Display the certificate MD5 fingerprint:
689 openssl x509 -in cert.pem -noout -fingerprint
691 Display the certificate SHA1 fingerprint:
693 openssl x509 -sha1 -in cert.pem -noout -fingerprint
695 Convert a certificate from PEM to DER format:
697 openssl x509 -in cert.pem -inform PEM -out cert.der -outform DER
699 Convert a certificate to a certificate request:
701 openssl x509 -x509toreq -in cert.pem -out req.pem -signkey key.pem
703 Convert a certificate request into a self signed certificate using
706 openssl x509 -req -in careq.pem -extfile openssl.cnf -extensions v3_ca \
707 -signkey key.pem -out cacert.pem
709 Sign a certificate request using the CA certificate above and add user
710 certificate extensions:
712 openssl x509 -req -in req.pem -extfile openssl.cnf -extensions v3_usr \
713 -CA cacert.pem -CAkey key.pem -CAcreateserial
716 Set a certificate to be trusted for SSL client use and change set its alias to
719 openssl x509 -in cert.pem -addtrust clientAuth \
720 -setalias "Steve's Class 1 CA" -out trust.pem
724 The PEM format uses the header and footer lines:
726 -----BEGIN CERTIFICATE-----
727 -----END CERTIFICATE-----
729 it will also handle files containing:
731 -----BEGIN X509 CERTIFICATE-----
732 -----END X509 CERTIFICATE-----
734 Trusted certificates have the lines
736 -----BEGIN TRUSTED CERTIFICATE-----
737 -----END TRUSTED CERTIFICATE-----
739 The conversion to UTF8 format used with the name options assumes that
740 T61Strings use the ISO8859-1 character set. This is wrong but Netscape
741 and MSIE do this as do many certificates. So although this is incorrect
742 it is more likely to display the majority of certificates correctly.
744 The B<-fingerprint> option takes the digest of the DER encoded certificate.
745 This is commonly called a "fingerprint". Because of the nature of message
746 digests the fingerprint of a certificate is unique to that certificate and
747 two certificates with the same fingerprint can be considered to be the same.
749 The Netscape fingerprint uses MD5 whereas MSIE uses SHA1.
751 The B<-email> option searches the subject name and the subject alternative
752 name extension. Only unique email addresses will be printed out: it will
753 not print the same address more than once.
755 =head1 CERTIFICATE EXTENSIONS
757 The B<-purpose> option checks the certificate extensions and determines
758 what the certificate can be used for. The actual checks done are rather
759 complex and include various hacks and workarounds to handle broken
760 certificates and software.
762 The same code is used when verifying untrusted certificates in chains
763 so this section is useful if a chain is rejected by the verify code.
765 The basicConstraints extension CA flag is used to determine whether the
766 certificate can be used as a CA. If the CA flag is true then it is a CA,
767 if the CA flag is false then it is not a CA. B<All> CAs should have the
770 If the basicConstraints extension is absent then the certificate is
771 considered to be a "possible CA" other extensions are checked according
772 to the intended use of the certificate. A warning is given in this case
773 because the certificate should really not be regarded as a CA: however
774 it is allowed to be a CA to work around some broken software.
776 If the certificate is a V1 certificate (and thus has no extensions) and
777 it is self signed it is also assumed to be a CA but a warning is again
778 given: this is to work around the problem of Verisign roots which are V1
779 self signed certificates.
781 If the keyUsage extension is present then additional restraints are
782 made on the uses of the certificate. A CA certificate B<must> have the
783 keyCertSign bit set if the keyUsage extension is present.
785 The extended key usage extension places additional restrictions on the
786 certificate uses. If this extension is present (whether critical or not)
787 the key can only be used for the purposes specified.
789 A complete description of each test is given below. The comments about
790 basicConstraints and keyUsage and V1 certificates above apply to B<all>
798 The extended key usage extension must be absent or include the "web client
799 authentication" OID. keyUsage must be absent or it must have the
800 digitalSignature bit set. Netscape certificate type must be absent or it must
801 have the SSL client bit set.
803 =item B<SSL Client CA>
805 The extended key usage extension must be absent or include the "web client
806 authentication" OID. Netscape certificate type must be absent or it must have
807 the SSL CA bit set: this is used as a work around if the basicConstraints
812 The extended key usage extension must be absent or include the "web server
813 authentication" and/or one of the SGC OIDs. keyUsage must be absent or it
814 must have the digitalSignature, the keyEncipherment set or both bits set.
815 Netscape certificate type must be absent or have the SSL server bit set.
817 =item B<SSL Server CA>
819 The extended key usage extension must be absent or include the "web server
820 authentication" and/or one of the SGC OIDs. Netscape certificate type must
821 be absent or the SSL CA bit must be set: this is used as a work around if the
822 basicConstraints extension is absent.
824 =item B<Netscape SSL Server>
826 For Netscape SSL clients to connect to an SSL server it must have the
827 keyEncipherment bit set if the keyUsage extension is present. This isn't
828 always valid because some cipher suites use the key for digital signing.
829 Otherwise it is the same as a normal SSL server.
831 =item B<Common S/MIME Client Tests>
833 The extended key usage extension must be absent or include the "email
834 protection" OID. Netscape certificate type must be absent or should have the
835 S/MIME bit set. If the S/MIME bit is not set in netscape certificate type
836 then the SSL client bit is tolerated as an alternative but a warning is shown:
837 this is because some Verisign certificates don't set the S/MIME bit.
839 =item B<S/MIME Signing>
841 In addition to the common S/MIME client tests the digitalSignature bit must
842 be set if the keyUsage extension is present.
844 =item B<S/MIME Encryption>
846 In addition to the common S/MIME tests the keyEncipherment bit must be set
847 if the keyUsage extension is present.
851 The extended key usage extension must be absent or include the "email
852 protection" OID. Netscape certificate type must be absent or must have the
853 S/MIME CA bit set: this is used as a work around if the basicConstraints
858 The keyUsage extension must be absent or it must have the CRL signing bit
861 =item B<CRL Signing CA>
863 The normal CA tests apply. Except in this case the basicConstraints extension
870 Extensions in certificates are not transferred to certificate requests and
873 It is possible to produce invalid certificates or requests by specifying the
874 wrong private key or using inconsistent options in some cases: these should
877 There should be options to explicitly set such things as start and end
878 dates rather than an offset from the current time.
882 L<req(1)>, L<ca(1)>, L<genrsa(1)>,
883 L<gendsa(1)>, L<verify(1)>,
888 The hash algorithm used in the B<-subject_hash> and B<-issuer_hash> options
889 before OpenSSL 1.0.0 was based on the deprecated MD5 algorithm and the encoding
890 of the distinguished name. In OpenSSL 1.0.0 and later it is based on a
891 canonical version of the DN using SHA1. This means that any directories using
892 the old form must have their links rebuilt using B<c_rehash> or similar.