2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
6 openssl-x509 - Certificate display and signing command
12 [B<-in> I<filename>|I<uri>]
17 [B<-copy_extensions> I<arg>]
18 [B<-inform> B<DER>|B<PEM>]
19 [B<-vfyopt> I<nm>:I<v>]
20 [B<-key> I<filename>|I<uri>]
21 [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
22 [B<-signkey> I<filename>|I<uri>]
24 [B<-outform> B<DER>|B<PEM>]
28 [B<-certopt> I<option>]
37 {- $OpenSSL::safe::opt_name_synopsis -}
41 [B<-subject_hash_old>]
44 [B<-ext> I<extensions>]
51 [B<-checkhost> I<host>]
52 [B<-checkemail> I<host>]
53 [B<-checkip> I<ipaddr>]
59 [B<-force_pubkey> I<filename>]
61 [B<-extfile> I<filename>]
62 [B<-extensions> I<section>]
63 [B<-sigopt> I<nm>:I<v>]
66 [B<-CA> I<filename>|I<uri>]
67 [B<-CAform> B<DER>|B<PEM>|B<P12>]
68 [B<-CAkey> I<filename>|I<uri>]
69 [B<-CAkeyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
70 [B<-CAserial> I<filename>]
77 [B<-addreject> I<arg>]
78 {- $OpenSSL::safe::opt_r_synopsis -}
79 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
83 This command is a multi-purposes certificate handling command.
84 It can be used to print certificate information,
85 convert certificates to various forms, edit certificate trust settings,
86 generate certificates from scratch or from certificating requests
87 and then self-signing them or signing them like a "micro CA".
89 Since there are a large number of options they will split up into
94 =head2 Input, Output, and General Purpose Options
100 Print out a usage message.
102 =item B<-in> I<filename>|I<uri>
104 If the B<-req> option is not used this specifies the input
105 to read a certificate from or standard input if this option is not specified.
106 With the B<-req> option this specifies a certificate request file.
108 =item B<-passin> I<arg>
110 The key and certificate file password source.
111 For more information about the format of I<arg>
112 see L<openssl-passphrase-options(1)>.
116 Generate a certificate from scratch, not using an input certificate
117 or certificate request. So the B<-in> option must not be used in this case.
118 Instead, the B<-subj> option needs to be given.
119 The public key to include can be given with the B<-force_pubkey> option
120 and defaults to the key given with the B<-key> option,
121 which implies self-signature.
125 Output a PKCS#10 certificate request (rather than a certificate).
126 The B<-key> option must be used to provide the private key for self-signing;
127 the corresponding public key is placed in the subjectPKInfo field.
129 X.509 extensions included in a certificate input are not copied by default.
130 X.509 extensions to be added can be specified using the B<-extfile> option.
134 By default a certificate is expected on input.
135 With this option a PKCS#10 certificate request is expected instead,
136 which must be correctly self-signed.
138 X.509 extensions included in the request are not copied by default.
139 X.509 extensions to be added can be specified using the B<-extfile> option.
141 =item B<-copy_extensions> I<arg>
143 Determines how to handle X.509 extensions
144 when converting from a certificate to a request using the B<-x509toreq> option
145 or converting from a request to a certificate using the B<-req> option.
146 If I<arg> is B<none> or this option is not present then extensions are ignored.
147 If I<arg> is B<copy> or B<copyall> then all extensions are copied,
148 except that subject identifier and authority key identifier extensions
149 are not taken over when producing a certificate request.
151 The B<-ext> option can be used to further restrict which extensions to copy.
153 =item B<-inform> B<DER>|B<PEM>
155 The input file format; unspecified by default.
156 See L<openssl-format-options(1)> for details.
158 =item B<-vfyopt> I<nm>:I<v>
160 Pass options to the signature algorithm during verify operations.
161 Names and values of these options are algorithm-specific.
163 =item B<-key> I<filename>|I<uri>
165 This option causes the new certificate or certificate request
166 to be self-signed using the supplied private key.
167 This cannot be used in conjunction with the B<-CA> option.
169 It sets the issuer name to the subject name (i.e., makes it self-issued)
170 and changes the public key to the supplied value (unless overridden
171 by B<-force_pubkey>).
172 Unless the B<-preserve_dates> option is supplied,
173 it sets the validity start date to the current time
174 and the end date to a value determined by the B<-days> option.
176 =item B<-signkey> I<filename>|I<uri>
178 This option is an alias of B<-key>.
180 =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
182 The key input format; unspecified by default.
183 See L<openssl-format-options(1)> for details.
185 =item B<-out> I<filename>
187 This specifies the output filename to write to or standard output by default.
189 =item B<-outform> B<DER>|B<PEM>
191 The output format; the default is B<PEM>.
192 See L<openssl-format-options(1)> for details.
196 Do not output a certificate (except for printing as requested by below options).
200 This option prevents output except for printing as requested by below options.
204 =head2 Certificate Printing Options
206 Note: the B<-alias> and B<-purpose> options are also printing options
207 but are described in the L</Trust Settings> section.
213 Prints out the certificate in text form. Full details are printed including the
214 public key, signature algorithms, issuer and subject names, serial number
215 any extensions present and any trust settings.
217 =item B<-certopt> I<option>
219 Customise the print format used with B<-text>. The I<option> argument
220 can be a single option or multiple options separated by commas.
221 The B<-certopt> switch may be also be used more than once to set multiple
222 options. See the L</Text Printing Flags> section for more information.
224 =item B<-fingerprint>
226 Calculates and prints the digest of the DER encoded version of the entire
227 certificate (see digest options).
228 This is commonly called a "fingerprint". Because of the nature of message
229 digests, the fingerprint of a certificate is unique to that certificate and
230 two certificates with the same fingerprint can be considered to be the same.
234 Prints the certificate "alias" (nickname), if any.
238 Prints the certificate serial number.
242 Prints out the start date of the certificate, that is the notBefore date.
246 Prints out the expiry date of the certificate, that is the notAfter date.
250 Prints out the start and expiry dates of a certificate.
254 Prints the subject name.
258 Prints the issuer name.
260 {- $OpenSSL::safe::opt_name_item -}
264 Prints the email address(es) if any.
268 Synonym for "-subject_hash" for backward compatibility reasons.
270 =item B<-subject_hash>
272 Prints the "hash" of the certificate subject name. This is used in OpenSSL to
273 form an index to allow certificates in a directory to be looked up by subject
276 =item B<-subject_hash_old>
278 Prints the "hash" of the certificate subject name using the older algorithm
279 as used by OpenSSL before version 1.0.0.
281 =item B<-issuer_hash>
283 Prints the "hash" of the certificate issuer name.
285 =item B<-issuer_hash_old>
287 Prints the "hash" of the certificate issuer name using the older algorithm
288 as used by OpenSSL before version 1.0.0.
290 =item B<-ext> I<extensions>
292 Prints out the certificate extensions in text form.
293 Can also be used to restrict which extensions to copy.
294 Extensions are specified
295 with a comma separated string, e.g., "subjectAltName,subjectKeyIdentifier".
296 See the L<x509v3_config(5)> manual page for the extension names.
300 Prints the OCSP hash values for the subject name and public key.
304 Prints the OCSP responder address(es) if any.
308 This option performs tests on the certificate extensions and outputs
309 the results. For a more complete description see
310 L<openssl-verification-options(1)/Certificate Extensions>.
314 Prints the certificate's SubjectPublicKeyInfo block in PEM format.
318 This option prints out the value of the modulus of the public key
319 contained in the certificate.
323 =head2 Certificate Checking Options
327 =item B<-checkend> I<arg>
329 Checks if the certificate expires within the next I<arg> seconds and exits
330 nonzero if yes it will expire or zero if not.
332 =item B<-checkhost> I<host>
334 Check that the certificate matches the specified host.
336 =item B<-checkemail> I<email>
338 Check that the certificate matches the specified email address.
340 =item B<-checkip> I<ipaddr>
342 Check that the certificate matches the specified IP address.
346 =head2 Certificate Output Options
350 =item B<-set_serial> I<n>
352 Specifies the serial number to use. This option can be used with either
353 the B<-key> or B<-CA> options. If used in conjunction with the B<-CA> option
354 the serial number file (as specified by the B<-CAserial> option) is not used.
356 The serial number can be decimal or hex (if preceded by C<0x>).
358 =item B<-next_serial>
360 Set the serial to be one more than the number in the certificate.
362 =item B<-days> I<arg>
364 Specifies the number of days until a newly generated certificate expires.
366 Cannot be used together with the B<-preserve_dates> option.
368 =item B<-preserve_dates>
370 When signing a certificate, preserve "notBefore" and "notAfter" dates of any
371 input certificate instead of adjusting them to current time and duration.
372 Cannot be used together with the B<-days> option.
374 =item B<-subj> I<arg>
376 When a certificate is created set its subject name to the given value.
377 When the certificate is self-signed the issuer name is set to the same value.
379 The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
380 Special characters may be escaped by C<\> (backslash), whitespace is retained.
381 Empty values are permitted, but the corresponding type will not be included
383 Giving a single C</> will lead to an empty sequence of RDNs (a NULL-DN).
384 Multi-valued RDNs can be formed by placing a C<+> character instead of a C</>
385 between the AttributeValueAssertions (AVAs) that specify the members of the set.
388 C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
390 This option can be used in conjunction with the B<-force_pubkey> option
391 to create a certificate even without providing an input certificate
392 or certificate request.
394 =item B<-force_pubkey> I<filename>
396 When a certificate is created set its public key to the key in I<filename>
397 instead of the key contained in the input or given with the B<-key> option.
399 This option is useful for creating self-issued certificates that are not
400 self-signed, for instance when the key cannot be used for signing, such as DH.
401 It can also be used in conjunction with b<-new> and B<-subj> to directly
402 generate a certificate containing any desired public key.
406 When transforming a certificate to a new certificate
407 by default all certificate extensions are retained.
409 When transforming a certificate or certificate request,
410 the B<-clrext> option prevents taking over any extensions from the source.
411 In any case, when producing a certificate request,
412 neither subject identifier nor authority key identifier extensions are included.
414 =item B<-extfile> I<filename>
416 Configuration file containing certificate and request X.509 extensions to add.
418 =item B<-extensions> I<section>
420 The section in the extfile to add X.509 extensions from.
421 If this option is not
422 specified then the extensions should either be contained in the unnamed
423 (default) section or the default section should contain a variable called
424 "extensions" which contains the section to use.
425 See the L<x509v3_config(5)> manual page for details of the
426 extension section format.
428 =item B<-sigopt> I<nm>:I<v>
430 Pass options to the signature algorithm during sign operations.
431 This option may be given multiple times.
432 Names and values provided using this option are algorithm-specific.
436 Corrupt the signature before writing it; this can be useful
442 This affects any signing or printing option that uses a message
443 digest, such as the B<-fingerprint>, B<-key> and B<-CA> options.
444 Any digest supported by the L<openssl-dgst(1)> command can be used.
445 If not specified then SHA1 is used with B<-fingerprint> or
446 the default digest for the signing algorithm is used, typically SHA256.
450 =head2 Micro-CA Options
454 =item B<-CA> I<filename>|I<uri>
456 Specifies the "CA" certificate to be used for signing.
457 When present, this behaves like a "micro CA" as follows:
458 The subject name of the "CA" certificate is placed as issuer name in the new
459 certificate, which is then signed using the "CA" key given as detailed below.
461 This option cannot be used in conjunction with the B<-key> option.
462 This option is normally combined with the B<-req> option referencing a CSR.
463 Without the B<-req> option the input must be a self-signed certificate
464 unless the B<-new> option is given, which generates a certificate from scratch.
466 =item B<-CAform> B<DER>|B<PEM>|B<P12>,
468 The format for the CA certificate; unspecifed by default.
469 See L<openssl-format-options(1)> for details.
471 =item B<-CAkey> I<filename>|I<uri>
473 Sets the CA private key to sign a certificate with.
474 The private key must match the public key of the certificate given with B<-CA>.
475 If this option is not provided then the key must be present in the B<-CA> input.
477 =item B<-CAkeyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
479 The format for the CA key; unspecified by default.
480 See L<openssl-format-options(1)> for details.
482 =item B<-CAserial> I<filename>
484 Sets the CA serial number file to use.
486 When the B<-CA> option is used to sign a certificate it uses a serial
487 number specified in a file. This file consists of one line containing
488 an even number of hex digits with the serial number to use. After each
489 use the serial number is incremented and written out to the file again.
491 The default filename consists of the CA certificate file base name with
492 F<.srl> appended. For example if the CA certificate file is called
493 F<mycacert.pem> it expects to find a serial number file called
496 =item B<-CAcreateserial>
498 With this option the CA serial number file is created if it does not exist:
499 it will contain the serial number "02" and the certificate being signed will
500 have the 1 as its serial number. If the B<-CA> option is specified
501 and the serial number file does not exist a random number is generated;
502 this is the recommended practice.
506 =head2 Trust Settings
508 A B<trusted certificate> is an ordinary certificate which has several
509 additional pieces of information attached to it such as the permitted
510 and prohibited uses of the certificate and possibly an "alias" (nickname).
512 Normally when a certificate is being verified at least one certificate
513 must be "trusted". By default a trusted certificate must be stored
514 locally and must be a root CA: any certificate chain ending in this CA
515 is then usable for any purpose.
517 Trust settings currently are only used with a root CA.
518 They allow a finer control over the purposes the root CA can be used for.
519 For example, a CA may be trusted for SSL client but not SSL server use.
521 See L<openssl-verification-options(1)> for more information
522 on the meaning of trust settings.
524 Future versions of OpenSSL will recognize trust settings on any
525 certificate: not just root CAs.
531 Mark any certificate PEM output as <trusted> certificate rather than ordinary.
532 An ordinary or trusted certificate can be input but by default an ordinary
533 certificate is output and any trust settings are discarded.
534 With the B<-trustout> option a trusted certificate is output. A trusted
535 certificate is automatically output if any trust settings are modified.
537 =item B<-setalias> I<arg>
539 Sets the "alias" of the certificate. This will allow the certificate
540 to be referred to using a nickname for example "Steve's Certificate".
544 Clears all the permitted or trusted uses of the certificate.
546 =item B<-addtrust> I<arg>
548 Adds an allowed trust anchor purpose.
549 Any object name can be used here but currently only those
550 listed in L<openssl-verification-options(1)/Trust Anchors> are supported.
551 Other OpenSSL applications may define additional purposes.
555 Clears all the prohibited or rejected uses of the certificate.
557 =item B<-addreject> I<arg>
559 Adds a prohibited trust anchor purpose.
560 It accepts the same values as the B<-addtrust> option.
564 =head2 Generic options
568 {- $OpenSSL::safe::opt_r_item -}
570 {- $OpenSSL::safe::opt_engine_item -}
572 {- $OpenSSL::safe::opt_provider_item -}
576 =head2 Text Printing Flags
578 As well as customising the name printing format, it is also possible to
579 customise the actual fields printed using the B<certopt> option when
580 the B<text> option is present. The default behaviour is to print all fields.
586 Use the old format. This is equivalent to specifying no printing options at all.
590 Don't print header information: that is the lines saying "Certificate"
595 Don't print out the version number.
599 Don't print out the serial number.
603 Don't print out the signature algorithm used.
607 Don't print the validity, that is the B<notBefore> and B<notAfter> fields.
611 Don't print out the subject name.
615 Don't print out the issuer name.
619 Don't print out the public key.
623 Don't give a hexadecimal dump of the certificate signature.
627 Don't print out certificate trust information.
629 =item B<no_extensions>
631 Don't print out any X509V3 extensions.
635 Retain default extension behaviour: attempt to print out unsupported
636 certificate extensions.
640 Print an error message for unsupported certificate extensions.
644 ASN1 parse unsupported extensions.
648 Hex dump unsupported extensions.
652 The value used by L<openssl-ca(1)>, equivalent to B<no_issuer>, B<no_pubkey>,
653 B<no_header>, and B<no_version>.
659 Note: in these examples the '\' means the example should be all on one
662 Print the contents of a certificate:
664 openssl x509 -in cert.pem -noout -text
666 Print the "Subject Alternative Name" extension of a certificate:
668 openssl x509 -in cert.pem -noout -ext subjectAltName
670 Print more extensions of a certificate:
672 openssl x509 -in cert.pem -noout -ext subjectAltName,nsCertType
674 Print the certificate serial number:
676 openssl x509 -in cert.pem -noout -serial
678 Print the certificate subject name:
680 openssl x509 -in cert.pem -noout -subject
682 Print the certificate subject name in RFC2253 form:
684 openssl x509 -in cert.pem -noout -subject -nameopt RFC2253
686 Print the certificate subject name in oneline form on a terminal
689 openssl x509 -in cert.pem -noout -subject -nameopt oneline,-esc_msb
691 Print 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 -key 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 -key 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
715 Set a certificate to be trusted for SSL client use and change set its alias to
718 openssl x509 -in cert.pem -addtrust clientAuth \
719 -setalias "Steve's Class 1 CA" -out trust.pem
723 The conversion to UTF8 format used with the name options assumes that
724 T61Strings use the ISO8859-1 character set. This is wrong but Netscape
725 and MSIE do this as do many certificates. So although this is incorrect
726 it is more likely to print the majority of certificates correctly.
728 The B<-email> option searches the subject name and the subject alternative
729 name extension. Only unique email addresses will be printed out: it will
730 not print the same address more than once.
734 It is possible to produce invalid certificates or requests by specifying the
735 wrong private key, using unsuitable X.509 extensions,
736 or using inconsistent options in some cases: these should be checked.
738 There should be options to explicitly set such things as start and end
739 dates rather than an offset from the current time.
746 L<openssl-genrsa(1)>,
747 L<openssl-gendsa(1)>,
748 L<openssl-verify(1)>,
753 The hash algorithm used in the B<-subject_hash> and B<-issuer_hash> options
754 before OpenSSL 1.0.0 was based on the deprecated MD5 algorithm and the encoding
755 of the distinguished name. In OpenSSL 1.0.0 and later it is based on a canonical
756 version of the DN using SHA1. This means that any directories using the old
757 form must have their links rebuilt using L<openssl-rehash(1)> or similar.
759 The B<-signkey> option has been renamed to B<-key> in OpenSSL 3.0,
760 keeping the old name as an alias.
762 The B<-engine> option was deprecated in OpenSSL 3.0.
764 The B<-C> option was removed in OpenSSL 3.0.
768 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
770 Licensed under the Apache License 2.0 (the "License"). You may not use
771 this file except in compliance with the License. You can obtain a copy
772 in the file LICENSE in the source distribution or at
773 L<https://www.openssl.org/source/license.html>.