5 openssl - OpenSSL command line program
16 B<-standard-commands> |
19 B<-cipher-algorithms> |
20 B<-digest-algorithms> |
22 B<-public-key-algorithms>
24 B<openssl> B<no->I<XXX> [ I<options> ]
28 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
29 v2/v3) and Transport Layer Security (TLS v1) network protocols and related
30 cryptography standards required by them.
32 The B<openssl> program is a command line program for using the various
33 cryptography functions of OpenSSL's B<crypto> library from the shell.
36 o Creation and management of private keys, public keys and parameters
37 o Public key cryptographic operations
38 o Creation of X.509 certificates, CSRs and CRLs
39 o Calculation of Message Digests and Message Authentication Codes
40 o Encryption and Decryption with Ciphers
41 o SSL/TLS Client and Server Tests
42 o Handling of S/MIME signed or encrypted mail
43 o Timestamp requests, generation and verification
45 =head1 COMMAND SUMMARY
47 The B<openssl> program provides a rich variety of commands (I<command> in
48 the L</SYNOPSIS> above).
49 Each command can have many options and argument parameters, shown above as
50 I<options> and I<parameters>.
52 Detailed documentation and use cases for most standard subcommands are available
53 (e.g., L<openssl-x509(1)>).
55 Many commands use an external configuration file for some or all of their
56 arguments and have a B<-config> option to specify that file.
57 The default name of the file is F<openssl.cnf> in the default certificate
58 storage area, which can be determined from the L<openssl-version(1)>
60 The environment variable B<OPENSSL_CONF> can be used to specify
61 a different location of the file.
62 See L<openssl-env(7)>.
64 The list options B<-standard-commands>, B<-digest-commands>,
65 and B<-cipher-commands> output a list (one entry per line) of the names
66 of all standard commands, message digest commands, or cipher commands,
67 respectively, that are available.
69 The list parameters B<-cipher-algorithms>, B<-digest-algorithms>,
70 and B<-mac-algorithms> list all cipher, message digest, and message
71 authentication code names, one entry per line. Aliases are listed as:
75 The list parameter B<-public-key-algorithms> lists all supported public
78 The command B<no->I<XXX> tests whether a command of the
79 specified name is available. If no command named I<XXX> exists, it
80 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
81 and prints I<XXX>. In both cases, the output goes to B<stdout> and
82 nothing is printed to B<stderr>. Additional command line arguments
83 are always ignored. Since for each cipher there is a command of the
84 same name, this provides an easy way for shell scripts to test for the
85 availability of ciphers in the B<openssl> program. (B<no->I<XXX> is
86 not able to detect pseudo-commands such as B<quit>,
87 B<list>, or B<no->I<XXX> itself.)
89 =head2 Standard Commands
95 Parse an ASN.1 sequence.
99 Certificate Authority (CA) Management.
103 Cipher Suite Description Determination.
107 CMS (Cryptographic Message Syntax) command.
111 Certificate Revocation List (CRL) Management.
115 CRL to PKCS#7 Conversion.
119 Message Digest calculation. MAC calculations are superseded by
124 Generation and Management of Diffie-Hellman Parameters. Superseded by
125 L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)>.
133 DSA Parameter Generation and Management. Superseded by
134 L<openssl-genpkey(1)> and L<openssl-pkeyparam(1)>.
138 EC (Elliptic curve) key processing.
142 EC parameter manipulation and generation.
146 Encryption, decryption, and encoding.
150 Engine (loadable module) information and manipulation.
154 Error Number to Error String Conversion.
158 FIPS configuration installation.
162 Generation of DSA Private Key from Parameters. Superseded by
163 L<openssl-genpkey(1)> and L<openssl-pkey(1)>.
167 Generation of Private Key or Parameters.
171 Generation of RSA Private Key. Superseded by L<openssl-genpkey(1)>.
175 Display information about a command's options.
179 Display diverse information built into the OpenSSL libraries.
183 Key Derivation Functions.
187 List algorithms and features.
191 Message Authentication Code Calculation.
195 Create or examine a Netscape certificate sequence.
199 Online Certificate Status Protocol command.
203 Generation of hashed passwords.
207 PKCS#12 Data Management.
211 PKCS#7 Data Management.
215 PKCS#8 format private key conversion command.
219 Public and private key management.
223 Public key algorithm parameter management.
227 Public key algorithm cryptographic operation command.
231 Compute prime numbers.
235 Load and query providers.
239 Generate pseudo-random bytes.
243 Create symbolic links to certificate and CRL files named by the hash values.
247 PKCS#10 X.509 Certificate Signing Request (CSR) Management.
255 RSA command for signing, verification, encryption, and decryption. Superseded
256 by L<openssl-pkeyutl(1)>.
260 This implements a generic SSL/TLS client which can establish a transparent
261 connection to a remote server speaking SSL/TLS. It's intended for testing
262 purposes only and provides only rudimentary interface functionality but
263 internally uses mostly all functionality of the OpenSSL B<ssl> library.
267 This implements a generic SSL/TLS server which accepts connections from remote
268 clients speaking SSL/TLS. It's intended for testing purposes only and provides
269 only rudimentary interface functionality but internally uses mostly all
270 functionality of the OpenSSL B<ssl> library. It provides both an own command
271 line oriented protocol for testing SSL functions and a simple HTTP response
272 facility to emulate an SSL/TLS-aware webserver.
276 SSL Connection Timer.
280 SSL Session Data Management.
284 S/MIME mail processing.
288 Algorithm Speed Measurement.
292 SPKAC printing and generating command.
296 Maintain SRP password file.
300 Command to list and display certificates, keys, CRLs, etc.
304 Time Stamping Authority command.
308 X.509 Certificate Verification.
312 OpenSSL Version Information.
316 X.509 Certificate Data Management.
320 =head2 Message Digest Commands
390 SHA-3 SHAKE128 Digest
394 SHA-3 SHAKE256 Digest
402 =head2 Encryption, Decryption, and Encoding Commands
404 The following aliases provide convenient access to the most used encodings
407 Depending on how OpenSSL was configured and built, not all ciphers listed
408 here may be present. See L<openssl-enc(1)> for more information.
412 =item B<aes128>, B<aes-128-cbc>, B<aes-128-cfb>, B<aes-128-ctr>, B<aes-128-ecb>, B<aes-128-ofb>
416 =item B<aes192>, B<aes-192-cbc>, B<aes-192-cfb>, B<aes-192-ctr>, B<aes-192-ecb>, B<aes-192-ofb>
420 =item B<aes256>, B<aes-256-cbc>, B<aes-256-cfb>, B<aes-256-ctr>, B<aes-256-ecb>, B<aes-256-ofb>
424 =item B<aria128>, B<aria-128-cbc>, B<aria-128-cfb>, B<aria-128-ctr>, B<aria-128-ecb>, B<aria-128-ofb>
428 =item B<aria192>, B<aria-192-cbc>, B<aria-192-cfb>, B<aria-192-ctr>, B<aria-192-ecb>, B<aria-192-ofb>
432 =item B<aria256>, B<aria-256-cbc>, B<aria-256-cfb>, B<aria-256-ctr>, B<aria-256-ecb>, B<aria-256-ofb>
440 =item B<bf>, B<bf-cbc>, B<bf-cfb>, B<bf-ecb>, B<bf-ofb>
444 =item B<camellia128>, B<camellia-128-cbc>, B<camellia-128-cfb>, B<camellia-128-ctr>, B<camellia-128-ecb>, B<camellia-128-ofb>
448 =item B<camellia192>, B<camellia-192-cbc>, B<camellia-192-cfb>, B<camellia-192-ctr>, B<camellia-192-ecb>, B<camellia-192-ofb>
452 =item B<camellia256>, B<camellia-256-cbc>, B<camellia-256-cfb>, B<camellia-256-ctr>, B<camellia-256-ecb>, B<camellia-256-ofb>
456 =item B<cast>, B<cast-cbc>
460 =item B<cast5-cbc>, B<cast5-cfb>, B<cast5-ecb>, B<cast5-ofb>
468 =item B<des>, B<des-cbc>, B<des-cfb>, B<des-ecb>, B<des-ede>, B<des-ede-cbc>, B<des-ede-cfb>, B<des-ede-ofb>, B<des-ofb>
472 =item B<des3>, B<desx>, B<des-ede3>, B<des-ede3-cbc>, B<des-ede3-cfb>, B<des-ede3-ofb>
476 =item B<idea>, B<idea-cbc>, B<idea-cfb>, B<idea-ecb>, B<idea-ofb>
480 =item B<rc2>, B<rc2-cbc>, B<rc2-cfb>, B<rc2-ecb>, B<rc2-ofb>
488 =item B<rc5>, B<rc5-cbc>, B<rc5-cfb>, B<rc5-ecb>, B<rc5-ofb>
492 =item B<seed>, B<seed-cbc>, B<seed-cfb>, B<seed-ecb>, B<seed-ofb>
496 =item B<sm4>, B<sm4-cbc>, B<sm4-cfb>, B<sm4-ctr>, B<sm4-ecb>, B<sm4-ofb>
504 Details of which options are available depend on the specific command.
505 This section describes some common options with common behavior.
507 =head2 Common Options
513 Provides a terse summary of all options.
514 If an option takes an argument, the "type" of argument is also given.
518 This terminates the list of options. It is mostly useful if any filename
519 parameters start with a minus sign:
521 openssl verify [flags...] -- -cert1.pem...
525 =head2 Format Options
527 Several OpenSSL commands can take input or generate output in a variety
529 Since OpenSSL 3.0 keys, single certificates, and CRLs can be read from
530 files in any of the B<DER>, B<PEM>, or B<P12> formats,
531 while specifying their input format is no more needed.
533 The list of acceptable formats, and the default, is
534 described in each command documentation. The list of formats is
535 described below. Both uppercase and lowercase are accepted.
541 A binary format, encoded or parsed according to Distinguished Encoding Rules
542 (DER) of the ASN.1 data language.
546 Used to specify that the cryptographic material is in an OpenSSL B<engine>.
547 An engine must be configured or specified using the B<-engine> option.
548 In addition, the B<-input> flag can be used to name a specific object in
550 A password, such as the B<-passin> flag often must be specified as well.
554 A DER-encoded file containing a PKCS#12 object.
555 It might be necessary to provide a decryption password to retrieve
560 A text format defined in IETF RFC 1421 and IETF RFC 7468. Briefly, this is
561 a block of base-64 encoding (defined in IETF RFC 4648), with specific
562 lines used to mark the start and end:
564 Text before the BEGIN line is ignored.
565 ----- BEGIN object-type -----
566 OT43gQKBgQC/2OHZoko6iRlNOAQ/tMVFNq7fL81GivoQ9F1U0Qr+DH3ZfaH8eIkX
567 xT0ToMPJUzWAn8pZv0snA0um6SIgvkCuxO84OkANCVbttzXImIsL7pFzfcwV/ERK
568 UM6j0ZuSMFOCr/lGPAoOQU0fskidGEHi1/kW+suSr28TqsyYZpwBDQ==
569 ----- END object-type -----
570 Text after the END line is also ignored
572 The I<object-type> must match the type of object that is expected.
573 For example a C<BEGIN X509 CERTIFICATE> will not match if the command
574 is trying to read a private key. The types supported include:
586 ENCRYPTED PRIVATE KEY
593 SSL SESSION PARAMETERS
598 The following legacy I<object-type>'s are also supported for compatibility
599 with earlier releases:
602 NEW CERTIFICATE REQUEST
608 An S/MIME object as described in IETF RFC 8551.
609 Earlier versions were known as CMS and are compatible.
610 Note that the parsing is simple and might fail to parse some legal data.
614 The options to specify the format are as follows. Refer to the individual
615 manpage to see which options are accepted.
619 =item B<-inform> I<format>, B<-outform> I<format>
621 The format of the input or output streams.
623 =item B<-keyform> I<format>
625 Format of a private key input source.
626 The only value with effect is B<ENGINE>; all others have become obsolete.
627 See L<openssl(1)/Format Options> for details.
629 =item B<-CRLform> I<format>
631 Format of a CRL input source.
635 =head2 Pass Phrase Options
637 Several commands accept password arguments, typically using B<-passin>
638 and B<-passout> for input and output passwords respectively. These allow
639 the password to be obtained from a variety of sources. Both of these
640 options take a single argument whose format is described below. If no
641 password argument is given and a password is required then the user is
642 prompted to enter one: this will typically be read from the current
643 terminal with echoing turned off.
645 Note that character encoding may be relevant, please see
646 L<passphrase-encoding(7)>.
650 =item B<pass:>I<password>
652 The actual password is I<password>. Since the password is visible
653 to utilities (like 'ps' under Unix) this form should only be used
654 where security is not important.
658 Obtain the password from the environment variable I<var>. Since
659 the environment of other processes is visible on certain platforms
660 (e.g. ps under certain Unix OSes) this option should be used with caution.
662 =item B<file:>I<pathname>
664 The first line of I<pathname> is the password. If the same I<pathname>
665 argument is supplied to B<-passin> and B<-passout> arguments then the first
666 line will be used for the input password and the next line for the output
667 password. I<pathname> need not refer to a regular file: it could for example
668 refer to a device or named pipe.
670 =item B<fd:>I<number>
672 Read the password from the file descriptor I<number>. This can be used to
673 send the data via a pipe for example.
677 Read the password from standard input.
681 =head2 Trusted Certificate Options
683 Part of validating a certificate includes verifying that the chain of CA's
684 can be traced up to an existing trusted root. The following options specify
685 how to list the trusted roots, also known as trust anchors. A collection
686 of trusted roots is called a I<trust store>.
688 Note that OpenSSL does not provide a default set of trust anchors. Many
689 Linux distributions include a system default and configure OpenSSL to point
690 to that. Mozilla maintains an influential trust store that can be found at
691 L<https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/>.
695 =item B<-CAfile> I<file>
697 Load the specified file which contains one or more PEM-format certificates
698 of CA's that are trusted.
702 Do not load the default file of trusted certificates.
704 =item B<-CApath> I<dir>
706 Use the specified directory as a list of trust certificates. That is,
707 files should be named with the hash of the X.509 SubjectName of each
708 certificate. This is so that the library can extract the IssuerName,
709 hash it, and directly lookup the file to get the issuer certificate.
710 See L<openssl-rehash(1)> for information on creating this type of directory.
714 Do not use the default directory of trusted certificates.
716 =item B<-CAstore> I<uri>
718 Use I<uri> as a store of trusted CA certificates. The URI may
719 indicate a single certificate, as well as a collection of them.
720 With URIs in the C<file:> scheme, this acts as B<-CAfile> or
721 B<-CApath>, depending on if the URI indicates a single file or
723 See L<ossl_store-file(7)> for more information on the C<file:> scheme.
725 These certificates are also used when building the server certificate
726 chain (for example with L<openssl-s_server(1)>) or client certificate
727 chain (for example with L<openssl-s_time(1)>).
731 Do not use the default store.
735 =head2 Random State Options
737 Prior to OpenSSL 1.1.1, it was common for applications to store information
738 about the state of the random-number generator in a file that was loaded
739 at startup and rewritten upon exit. On modern operating systems, this is
740 generally no longer necessary as OpenSSL will seed itself from a trusted
741 entropy source provided by the operating system. These flags are still
742 supported for special platforms or circumstances that might require them.
744 It is generally an error to use the same seed file more than once and
745 every use of B<-rand> should be paired with B<-writerand>.
749 =item B<-rand> I<files>
751 A file or files containing random data used to seed the random number
753 Multiple files can be specified separated by an OS-dependent character.
754 The separator is C<;> for MS-Windows, C<,> for OpenVMS, and C<:> for
755 all others. Another way to specify multiple files is to repeat this flag
756 with different filenames.
758 =item B<-writerand> I<file>
760 Writes the seed data to the specified I<file> upon exit.
761 This file can be used in a subsequent command invocation.
765 =head2 Provider Options
767 With the move to provider based cryptographic operations in OpenSSL 3.0,
768 options were added to allow specific providers or sets of providers to be used.
772 =item B<-provider> I<name>
774 Use the provider identified by I<name> and use all the methods it
775 implements (algorithms, key storage, etc.). This option can be specified
776 multiple time to load more than one provider.
778 =item B<-provider_path> I<path>
780 Specify the search I<path> that is used to locate provider modules. The format
781 of I<path> varies depending on the operating system being used.
785 =head2 Extended Verification Options
787 Sometimes there may be more than one certificate chain leading to an
788 end-entity certificate.
789 This usually happens when a root or intermediate CA signs a certificate
790 for another a CA in other organization.
791 Another reason is when a CA might have intermediates that use two different
792 signature formats, such as a SHA-1 and a SHA-256 digest.
794 The following options can be used to provide data that will allow the
795 OpenSSL command to generate an alternative chain.
799 =item B<-xkey> I<infile>, B<-xcert> I<infile>, B<-xchain>
801 Specify an extra certificate, private key and certificate chain. These behave
802 in the same manner as the B<-cert>, B<-key> and B<-cert_chain> options. When
803 specified, the callback returning the first valid chain will be in use by the
806 =item B<-xchain_build>
808 Specify whether the application should build the certificate chain to be
809 provided to the server for the extra certificates via the B<-xkey>,
810 B<-xcert>, and B<-xchain> options.
812 =item B<-xcertform> B<DER>|B<PEM>|B<P12>
814 The input format for the extra certificate.
815 This option has no effect and is retained for backward compatibility only.
817 =item B<-xkeyform> B<DER>|B<PEM>|B<P12>
819 The input format for the extra key.
820 This option has no effect and is retained for backward compatibility only.
824 =head2 Verification Options
826 Many OpenSSL commands verify certificates. The details of how each
827 command handles errors are documented on the specific command page.
829 Verification is a complicated process, consisting of a number of separate
830 steps that are detailed in the following paragraphs.
832 First, a certificate chain is built up starting from the target certificate
833 and typically ending in a self-signed "root" CA certificate.
834 It is an error if the whole chain cannot be built up
835 unless the B<-partial_chain> option is given.
836 The chain is built up iteratively, looking up in turn
837 the certificate of the signer ("issuer") of the current certificate.
838 If a certificate is found that appears to be its own issuer
839 it is assumed to be the self-signed root, which must be trusted.
841 The process of looking up the issuer's certificate itself involves a number
843 All available certificates with a subject name that matches the issuer
844 name of the current certificate are subject to further tests.
845 The relevant authority key identifier components of the current certificate
846 (if present) must match the subject key identifier (if present)
847 and issuer and serial number of the candidate issuer; in addition the keyUsage
848 extension of the candidate issuer (if present) must permit certificate signing.
850 The lookup first searches for issuer certificates in the trust store.
851 If it does not find a match there it consults
852 the list of untrusted "intermediate" CA certificates (if provided).
853 The last certificate (which typically is of a root CA) is always looked up
854 in the trusted certificate list; an exact match must be found there.
856 The second step is to check the extensions of every untrusted certificate
857 for consistency with the supplied purpose.
858 If the B<-purpose> option is not included then no checks are done.
859 The target or "leaf" certificate must have extensions compatible with the
860 supplied purpose and all other certificates must also be valid CA certificates.
861 The precise extensions required are described in more detail in
862 L<openssl-x509(1)/CERTIFICATE EXTENSIONS>.
864 The third step is to check the trust settings on the last certficate,
865 typically of a root CA.
866 It should be trusted for the supplied purpose.
867 For compatibility with previous versions of OpenSSL,
868 a certificate with no trust settings is considered to be valid for all purposes.
870 The fourth, and final, step is to check the validity of the certificate chain.
871 The validity period is checked against the system time
872 and the C<notBefore> and C<notAfter> dates in each certificate.
873 The B<-attime> flag may be used to specify a time other than "now."
874 The certificate signatures are also checked at this point
875 (except for the signature of the self-signed "root CA" certificate,
876 which is verified only if the B<-check_ss_sig> option is given).
877 When verifying a certificate signature
878 the keyUsage extension (if present) of the candidate issuer certificate
879 is checked to permit digitalSignature for signing proxy certificates or
880 keyCertSign for signing other certificates, respectively.
882 If all operations complete successfully then certificate is considered
883 valid. If any operation fails then the certificate is not valid.
885 The details of the processing steps can be fine-tuned with the
892 Print extra information about the operations being performed.
894 =item B<-attime> I<timestamp>
896 Perform validation checks using time specified by I<timestamp> and not
897 current system time. I<timestamp> is the number of seconds since
898 January 1, 1970 (i.e., the Unix Epoch).
900 =item B<-no_check_time>
902 This option suppresses checking the validity period of certificates and CRLs
903 against the current time. If option B<-attime> is used to specify
904 a verification time, the check is not suppressed.
906 =item B<-x509_strict>
908 This disables non-compliant workarounds for broken certificates.
910 =item B<-ignore_critical>
912 Normally if an unhandled critical extension is present that is not
913 supported by OpenSSL the certificate is rejected (as required by RFC5280).
914 If this option is set critical extensions are ignored.
916 =item B<-issuer_checks>
922 Checks end entity certificate validity by attempting to look up a valid CRL.
923 If a valid CRL cannot be found an error occurs.
925 =item B<-crl_check_all>
927 Checks the validity of B<all> certificates in the chain by attempting
928 to look up valid CRLs.
932 Enable support for delta CRLs.
934 =item B<-extended_crl>
936 Enable extended CRL features such as indirect CRLs and alternate CRL
939 =item B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192>
941 Enable the Suite B mode operation at 128 bit Level of Security, 128 bit or
942 192 bit, or only 192 bit Level of Security respectively.
943 See RFC6460 for details. In particular the supported signature algorithms are
944 reduced to support only ECDSA and SHA256 or SHA384 and only the elliptic curves
947 =item B<-auth_level> I<level>
949 Set the certificate chain authentication security level to I<level>.
950 The authentication security level determines the acceptable signature and
951 public key strength when verifying certificate chains. For a certificate
952 chain to validate, the public keys of all the certificates must meet the
953 specified security I<level>. The signature algorithm security level is
954 enforced for all the certificates in the chain except for the chain's
955 I<trust anchor>, which is either directly trusted or validated by means
956 other than its signature. See L<SSL_CTX_set_security_level(3)> for the
957 definitions of the available levels. The default security level is -1,
958 or "not set". At security level 0 or lower all algorithms are acceptable.
959 Security level 1 requires at least 80-bit-equivalent security and is broadly
960 interoperable, though it will, for example, reject MD5 signatures or RSA
961 keys shorter than 1024 bits.
963 =item B<-partial_chain>
965 Allow verification to succeed even if a I<complete> chain cannot be built to a
966 self-signed trust-anchor, provided it is possible to construct a chain to a
967 trusted certificate that might not be self-signed.
968 This certificate may be self-issued or belong to an intermediate CA.
970 =item B<-check_ss_sig>
972 Verify the signature on the last certificate in a chain
973 even when it is a self-signed (root CA) certificate.
974 By default in this case the check is disabled
975 because it does not add any security.
977 =item B<-allow_proxy_certs>
979 Allow the verification of proxy certificates.
981 =item B<-trusted_first>
983 As of OpenSSL 1.1.0 this option is on by default and cannot be disabled.
985 When constructing the certificate chain, the trusted certificates specified
986 via B<-CAfile>, B<-CApath>, B<-CAstore> or B<-trusted> are always used
987 before any certificates specified via B<-untrusted>.
989 =item B<-no_alt_chains>
991 As of OpenSSL 1.1.0, since B<-trusted_first> always on, this option has no
994 =item B<-trusted> I<file>
996 Parse I<file> as a set of one or more certificates in PEM format.
997 All certificates must be self-signed, unless the
998 B<-partial_chain> option is specified.
999 This option implies the B<-no-CAfile>, B<-no-CApath>, and B<-no-CAstore> options
1000 and it cannot be used with the B<-CAfile>, B<-CApath> or B<-CAstore> options, so
1001 only certificates in the file are trust anchors.
1002 This option may be used multiple times.
1004 =item B<-untrusted> I<file>
1006 Parse I<file> as a set of one or more certificates in PEM format.
1007 All certificates are untrusted certificates (typically of intermedate CAs)
1009 construct a certificate chain from the subject certificate to a trust anchor.
1010 This option may be used multiple times.
1012 =item B<-policy> I<arg>
1014 Enable policy processing and add I<arg> to the user-initial-policy-set (see
1015 RFC5280). The policy I<arg> can be an object name an OID in numeric form.
1016 This argument can appear more than once.
1018 =item B<-explicit_policy>
1020 Set policy variable require-explicit-policy (see RFC5280).
1022 =item B<-policy_check>
1024 Enables certificate policy processing.
1026 =item B<-policy_print>
1028 Print out diagnostics related to policy processing.
1030 =item B<-inhibit_any>
1032 Set policy variable inhibit-any-policy (see RFC5280).
1034 =item B<-inhibit_map>
1036 Set policy variable inhibit-policy-mapping (see RFC5280).
1038 =item B<-purpose> I<purpose>
1040 The intended use for the certificate. If this option is not specified, this
1041 command will not consider certificate purpose during chain verification.
1042 Currently accepted uses are B<sslclient>, B<sslserver>, B<nssslserver>,
1043 B<smimesign>, B<smimeencrypt>.
1045 =item B<-verify_depth> I<num>
1047 Limit the certificate chain to I<num> intermediate CA certificates.
1048 A maximal depth chain can have up to I<num>+2 certificates, since neither the
1049 end-entity certificate nor the trust-anchor certificate count against the
1050 B<-verify_depth> limit.
1052 =item B<-verify_email> I<email>
1054 Verify if I<email> matches the email address in Subject Alternative Name or
1055 the email in the subject Distinguished Name.
1057 =item B<-verify_hostname> I<hostname>
1059 Verify if I<hostname> matches DNS name in Subject Alternative Name or
1060 Common Name in the subject certificate.
1062 =item B<-verify_ip> I<ip>
1064 Verify if I<ip> matches the IP address in Subject Alternative Name of
1065 the subject certificate.
1067 =item B<-verify_name> I<name>
1069 Use default verification policies like trust model and required certificate
1070 policies identified by I<name>.
1071 The trust model determines which auxiliary trust or reject OIDs are applicable
1072 to verifying the given certificate chain.
1073 See the B<-addtrust> and B<-addreject> options for L<openssl-x509(1)>.
1074 Supported policy names include: B<default>, B<pkcs7>, B<smime_sign>,
1075 B<ssl_client>, B<ssl_server>.
1076 These mimics the combinations of purpose and trust settings used in SSL, CMS
1078 As of OpenSSL 1.1.0, the trust model is inferred from the purpose when not
1079 specified, so the B<-verify_name> options are functionally equivalent to the
1080 corresponding B<-purpose> settings.
1084 =head2 Name Format Options
1086 OpenSSL provides fine-grain control over how the subject and issuer DN's are
1088 This is specified by using the B<-nameopt> option, which takes a
1089 comma-separated list of options from the following set.
1090 An option may be preceded by a minus sign, C<->, to turn it off.
1091 The default value is C<oneline>.
1092 The first four are the most commonly used.
1098 Display the name using an old format from previous OpenSSL versions.
1102 Display the name using the format defined in RFC 2253.
1103 It is equivalent to B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>,
1104 B<dump_nostr>, B<dump_unknown>, B<dump_der>, B<sep_comma_plus>, B<dn_rev>
1109 Display the name in one line, using a format that is more readable
1111 It is equivalent to B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>,
1112 B<dump_nostr>, B<dump_der>, B<use_quote>, B<sep_comma_plus_space>,
1113 B<space_eq> and B<sname> options.
1117 Display the name using multiple lines.
1118 It is equivalent to B<esc_ctrl>, B<esc_msb>, B<sep_multiline>, B<space_eq>,
1119 B<lname> and B<align>.
1123 Escape the "special" characters in a field, as required by RFC 2253.
1124 That is, any of the characters C<,+"E<lt>E<gt>;>, C<#> at the beginning of
1125 a string and leading or trailing spaces.
1129 Escape the "special" characters in a field as required by RFC 2254 in a field.
1130 That is, the B<NUL> character and and of C<()*>.
1134 Escape non-printable ASCII characters, codes less than 0x20 (space)
1135 or greater than 0x7F (DELETE). They are displayed using RFC 2253 C<\XX>
1136 notation where B<XX> are the two hex digits representing the character value.
1140 Escape any characters with the most significant bit set, that is with
1141 values larger than 127, as described in B<esc_ctrl>.
1145 Escapes some characters by surrounding the entire string with quotation
1147 Without this option, individual special characters are preceded with
1148 a backslash character, C<\>.
1152 Convert all strings to UTF-8 format first as required by RFC 2253.
1153 If the output device is UTF-8 compatible, then using this option (and
1154 not setting B<esc_msb>) may give the correct display of multibyte
1156 If this option is not set, then multibyte characters larger than 0xFF
1157 will be output as C<\UXXXX> for 16 bits or C<\WXXXXXXXX> for 32 bits.
1158 In addition, any UTF8Strings will be converted to their character form first.
1160 =item B<ignore_type>
1162 This option does not attempt to interpret multibyte characters in any
1163 way. That is, the content octets are merely dumped as though one octet
1164 represents each character. This is useful for diagnostic purposes but
1165 will result in rather odd looking output.
1169 Display the type of the ASN1 character string before the value,
1170 such as C<BMPSTRING: Hello World>.
1174 Any fields that would be output in hex format are displayed using
1175 the DER encoding of the field.
1176 If not set, just the content octets are displayed.
1177 Either way, the B<#XXXX...> format of RFC 2253 is used.
1181 Dump non-character strings, such as ASN.1 B<OCTET STRING>.
1182 If this option is not set, then non character string types will be displayed
1183 as though each content octet represents a single character.
1187 Dump all fields. When this used with B<dump_der>, this allows the
1188 DER encoding of the structure to be unambiguously determined.
1190 =item B<dump_unknown>
1192 Dump any field whose OID is not recognised by OpenSSL.
1194 =item B<sep_comma_plus>, B<sep_comma_plus_space>, B<sep_semi_plus_space>,
1197 Specify the field separators. The first word is used between the
1198 Relative Distinguished Names (RDNs) and the second is between
1199 multiple Attribute Value Assertions (AVAs). Multiple AVAs are
1200 very rare and their use is discouraged.
1201 The options ending in "space" additionally place a space after the separator to make it more readable.
1202 The B<sep_multiline> starts each field on its own line, and uses "plus space"
1203 for the AVA separator.
1204 It also indents the fields by four characters.
1205 The default value is B<sep_comma_plus_space>.
1209 Reverse the fields of the DN as required by RFC 2253.
1210 This also reverses the order of multiple AVAs in a field, but this is
1211 permissible as there is no ordering on values.
1213 =item B<nofname>, B<sname>, B<lname>, B<oid>
1215 Specify how the field name is displayed.
1216 B<nofname> does not display the field at all.
1217 B<sname> uses the "short name" form (CN for commonName for example).
1218 B<lname> uses the long form.
1219 B<oid> represents the OID in numerical form and is useful for
1224 Align field values for a more readable output. Only usable with
1229 Places spaces round the equal sign, C<=>, character which follows the field
1234 =head2 TLS Version Options
1236 Several commands use SSL, TLS, or DTLS. By default, the commands use TLS and
1237 clients will offer the lowest and highest protocol version they support,
1238 and servers will pick the highest version that the client offers that is also
1239 supported by the server.
1241 The options below can be used to limit which protocol versions are used,
1242 and whether TCP (SSL and TLS) or UDP (DTLS) is used.
1243 Note that not all protocols and flags may be available, depending on how
1248 =item B<-ssl3>, B<-tls1>, B<-tls1_1>, B<-tls1_2>, B<-tls1_3>, B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>
1250 These options require or disable the use of the specified SSL or TLS protocols.
1251 When a specific TLS version is required, only that version will be offered or
1253 Only one specific protocol can be given and it cannot be combined with any of
1256 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
1258 These options specify to use DTLS instead of DLTS.
1259 With B<-dtls>, clients will negotiate any supported DTLS protocol version.
1260 Use the B<-dtls1> or B<-dtls1_2> options to support only DTLS1.0 or DTLS1.2,
1265 =head2 Engine Options
1269 =item B<-engine> I<id>
1271 Use the engine identified by I<id> and use all the methods it
1272 implements (algorithms, key storage, etc.), unless specified otherwise in
1273 the command-specific documentation or it is configured to do so, as described
1274 in L<config(5)/Engine Configuration Module>.
1280 The OpenSSL library can be take some configuration parameters from the
1281 environment. Some of these variables are listed below. For information
1282 about specific commands, see L<openssl-engine(1)>, L<openssl-provider(1)>,
1283 L<openssl-rehash(1)>, and L<tsget(1)>.
1285 For information about the use of environment variables in configuration,
1286 see L<config(5)/ENVIRONMENT>.
1288 For information about querying or specifying CPU architecture flags, see
1289 L<OPENSSL_ia32cap(3)>, and L<OPENSSL_s390xcap(3)>.
1291 For information about all environment variables used by the OpenSSL libraries,
1292 see L<openssl-env(7)>.
1296 =item B<OPENSSL_TRACE=>I<name>[,...]
1298 Enable tracing output of OpenSSL library, by name.
1299 This output will only make sense if you know OpenSSL internals well.
1300 Also, it might not give you any output at all, depending on how
1303 The value is a comma separated list of names, with the following
1310 The tracing functionality.
1322 Show details about provider and engine configuration.
1324 =item B<ENGINE_TABLE>
1326 The function that is used by RSA, DSA (etc) code to select registered
1327 ENGINEs, cache defaults and functional references (etc), will generate
1328 debugging summaries.
1330 =item B<ENGINE_REF_COUNT>
1332 Reference counts in the ENGINE structure will be monitored with a line
1333 of generated for each change.
1339 =item B<PKCS12_KEYGEN>
1341 PKCS#12 key generation.
1343 =item B<PKCS12_DECRYPT>
1347 =item B<X509V3_POLICY>
1349 Generates the complete policy tree at various point during X.509 v3
1362 L<openssl-asn1parse(1)>,
1364 L<openssl-ciphers(1)>,
1367 L<openssl-crl2pkcs7(1)>,
1369 L<openssl-dhparam(1)>,
1371 L<openssl-dsaparam(1)>,
1373 L<openssl-ecparam(1)>,
1375 L<openssl-engine(1)>,
1376 L<openssl-errstr(1)>,
1377 L<openssl-gendsa(1)>,
1378 L<openssl-genpkey(1)>,
1379 L<openssl-genrsa(1)>,
1384 L<openssl-passwd(1)>,
1385 L<openssl-pkcs12(1)>,
1386 L<openssl-pkcs7(1)>,
1387 L<openssl-pkcs8(1)>,
1389 L<openssl-pkeyparam(1)>,
1390 L<openssl-pkeyutl(1)>,
1391 L<openssl-prime(1)>,
1393 L<openssl-rehash(1)>,
1396 L<openssl-rsautl(1)>,
1397 L<openssl-s_client(1)>,
1398 L<openssl-s_server(1)>,
1399 L<openssl-s_time(1)>,
1400 L<openssl-sess_id(1)>,
1401 L<openssl-smime(1)>,
1402 L<openssl-speed(1)>,
1403 L<openssl-spkac(1)>,
1405 L<openssl-storeutl(1)>,
1407 L<openssl-verify(1)>,
1408 L<openssl-version(1)>,
1419 The B<list> -I<XXX>B<-algorithms> options were added in OpenSSL 1.0.0;
1420 For notes on the availability of other commands, see their individual
1423 The B<-issuer_checks> option is deprecated as of OpenSSL 1.1.0 and
1424 is silently ignored.
1426 The B<-xcertform> and B<-xkeyform> options
1427 are obsolete since OpenSSL 3.0 and have no effect.
1429 The interactive mode, which could be invoked by running C<openssl>
1430 with no further arguments, was removed in OpenSSL 3.0, and running
1431 that program with no arguments is now equivalent to C<openssl help>.
1435 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
1437 Licensed under the Apache License 2.0 (the "License"). You may not use
1438 this file except in compliance with the License. You can obtain a copy
1439 in the file LICENSE in the source distribution or at
1440 L<https://www.openssl.org/source/license.html>.
projects / openssl.git / blob