5 openssl - OpenSSL command line tool
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 tool 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) utility.
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 utility.
203 Generation of hashed passwords.
207 PKCS#12 Data Management.
211 PKCS#7 Data Management.
215 PKCS#8 format private key conversion tool.
219 Public and private key management.
223 Public key algorithm parameter management.
227 Public key algorithm cryptographic operation utility.
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 utility 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 utility.
296 Maintain SRP password file.
300 Utility to list and display certificates, keys, CRLs, etc.
304 Time Stamping Authority tool (client/server).
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
528 of formats. The list of acceptable formats, and the default, is
529 described in each command documentation. The list of formats is
530 described below. Both uppercase and lowercase are accepted.
536 A binary format, encoded or parsed according to Distinguished Encoding Rules
537 (DER) of the ASN.1 data language.
541 Used to specify that the cryptographic material is in an OpenSSL B<engine>.
542 An engine must be configured or specified using the B<-engine> option.
543 In addition, the B<-input> flag can be used to name a specific object in
545 A password, such as the B<-passin> flag often must be specified as well.
549 A DER-encoded file containing a PKCS#12 object.
550 It might be necessary to provide a decryption password to retrieve
555 A text format defined in IETF RFC 1421 and IETF RFC 7468. Briefly, this is
556 a block of base-64 encoding (defined in IETF RFC 4648), with specific
557 lines used to mark the start and end:
559 Text before the BEGIN line is ignored.
560 ----- BEGIN object-type -----
561 OT43gQKBgQC/2OHZoko6iRlNOAQ/tMVFNq7fL81GivoQ9F1U0Qr+DH3ZfaH8eIkX
562 xT0ToMPJUzWAn8pZv0snA0um6SIgvkCuxO84OkANCVbttzXImIsL7pFzfcwV/ERK
563 UM6j0ZuSMFOCr/lGPAoOQU0fskidGEHi1/kW+suSr28TqsyYZpwBDQ==
564 ----- END object-type -----
565 Text after the END line is also ignored
567 The I<object-type> must match the type of object that is expected.
568 For example a C<BEGIN X509 CERTIFICATE> will not match if the command
569 is trying to read a private key. The types supported include:
581 ENCRYPTED PRIVATE KEY
588 SSL SESSION PARAMETERS
593 The following legacy I<object-type>'s are also supported for compatibility
594 with earlier releases:
597 NEW CERTIFICATE REQUEST
603 An S/MIME object as described in IETF RFC 8551.
604 Earlier versions were known as CMS and are compatible.
605 Note that the parsing is simple and might fail to parse some legal data.
609 The options to specify the format are as follows. Refer to the individual
610 manpage to see which options are accepted.
614 =item B<-inform> I<format>, B<-outform> I<format>
616 The format of the input or output streams.
618 =item B<-keyform> I<format>
620 Format of a private key input source.
622 =item B<-CRLform> I<format>
624 Format of a CRL input source.
628 =head2 Pass Phrase Options
630 Several commands accept password arguments, typically using B<-passin>
631 and B<-passout> for input and output passwords respectively. These allow
632 the password to be obtained from a variety of sources. Both of these
633 options take a single argument whose format is described below. If no
634 password argument is given and a password is required then the user is
635 prompted to enter one: this will typically be read from the current
636 terminal with echoing turned off.
638 Note that character encoding may be relevant, please see
639 L<passphrase-encoding(7)>.
643 =item B<pass:>I<password>
645 The actual password is I<password>. Since the password is visible
646 to utilities (like 'ps' under Unix) this form should only be used
647 where security is not important.
651 Obtain the password from the environment variable I<var>. Since
652 the environment of other processes is visible on certain platforms
653 (e.g. ps under certain Unix OSes) this option should be used with caution.
655 =item B<file:>I<pathname>
657 The first line of I<pathname> is the password. If the same I<pathname>
658 argument is supplied to B<-passin> and B<-passout> arguments then the first
659 line will be used for the input password and the next line for the output
660 password. I<pathname> need not refer to a regular file: it could for example
661 refer to a device or named pipe.
663 =item B<fd:>I<number>
665 Read the password from the file descriptor I<number>. This can be used to
666 send the data via a pipe for example.
670 Read the password from standard input.
674 =head2 Trusted Certificate Options
676 Part of validating a certificate includes verifying that the chain of CA's
677 can be traced up to an existing trusted root. The following options specify
678 how to list the trusted roots, also known as trust anchors. A collection
679 of trusted roots is called a I<trust store>.
681 Note that OpenSSL does not provide a default set of trust anchors. Many
682 Linux distributions include a system default and configure OpenSSL to point
683 to that. Mozilla maintains an influential trust store that can be found at
684 L<https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/>.
688 =item B<-CAfile> I<file>
690 Load the specified file which contains one or more PEM-format certificates
691 of CA's that are trusted.
695 Do not load the default file of trusted certificates.
697 =item B<-CApath> I<dir>
699 Use the specified directory as a list of trust certificates. That is,
700 files should be named with the hash of the X.509 SubjectName of each
701 certificate. This is so that the library can extract the IssuerName,
702 hash it, and directly lookup the file to get the issuer certificate.
703 See L<openssl-rehash(1)> for information on creating this type of directory.
707 Do not use the default directory of trusted certificates.
709 =item B<-CAstore> I<uri>
711 Use I<uri> as a store of trusted CA certificates. The URI may
712 indicate a single certificate, as well as a collection of them.
713 With URIs in the C<file:> scheme, this acts as B<-CAfile> or
714 B<-CApath>, depending on if the URI indicates a single file or
716 See L<ossl_store-file(7)> for more information on the C<file:> scheme.
718 These certificates are also used when building the server certificate
719 chain (for example with L<openssl-s_server(1)>) or client certificate
720 chain (for example with L<openssl-s_time(1)>).
724 Do not use the default store.
728 =head2 Random State Options
730 Prior to OpenSSL 3.0, it was common for applications to store information
731 about the state of the random-number generator in a file that was loaded
732 at startup and rewritten upon exit. On modern operating systems, this is
733 generally no longer necessary as OpenSSL will seed itself from the
734 appropriate CPU flags, device files, and so on. These flags are still
735 supported for special platforms or circumstances that might require them.
737 It is generally an error to use the same seed file more than once and
738 every use of B<-rand> should be paired with B<-writerand>.
742 =item B<-rand> I<files>
744 A file or files containing random data used to seed the random number
746 Multiple files can be specified separated by an OS-dependent character.
747 The separator is C<;> for MS-Windows, C<,> for OpenVMS, and C<:> for
748 all others. Another way to specify multiple files is to repeat this flag
749 with different filenames.
751 =item B<-writerand> I<file>
753 Writes the seed data to the specified I<file> upon exit.
754 This file can be used in a subsequent command invocation.
758 =head2 Extended Verification Options
760 Sometimes there may be more than one certificate chain leading to an
761 end-entity certificate.
762 This usually happens when a root or intermediate CA signs a certificate
763 for another a CA in other organization.
764 Another reason is when a CA might have intermediates that use two different
765 signature formats, such as a SHA-1 and a SHA-256 digest.
767 The following options can be used to provide data that will allow the
768 OpenSSL command to generate an alternative chain.
772 =item B<-xchain_build>
774 Specify whether the application should build the certificate chain to be
775 provided to the server for the extra certificates via the B<-xkey>,
776 B<-xcert>, and B<-xchain> options.
778 =item B<-xkey> I<infile>, B<-xcert> I<infile>, B<-xchain>
780 Specify an extra certificate, private key and certificate chain. These behave
781 in the same manner as the B<-cert>, B<-key> and B<-cert_chain> options. When
782 specified, the callback returning the first valid chain will be in use by the
785 =item B<-xcertform> B<DER>|B<PEM>, B<-xkeyform> B<DER>|B<PEM>
787 The input format for the extra certificate and key, respectively.
788 See L<openssl(1)/Format Options> for details.
790 =item B<-xchain_build>
792 Specify whether the application should build the certificate chain to be
793 provided to the server for the extra certificates via the B<-xkey>,
794 B<-xcert>, and B<-xchain> options.
796 =item B<-xcertform> B<DER>|B<PEM>, B<-xkeyform> B<DER>|B<PEM>
798 The input format for the extra certifcate and key, respectively.
799 See L<openssl(1)/Format Options> for details.
803 =head2 Verification Options
805 Many OpenSSL commands verify certificates. The details of how each
806 command handles errors are documented on the specific command page.
808 Verification is a complicated process, consisting of a number of separate
809 steps that are detailed in the following paragraphs.
811 First, a certificate chain is built up starting from the supplied certificate
812 and ending in a root CA. It is an error if the whole chain cannot be
813 built up. The chain is built up by looking up the certificate that
814 signed (or issued) the certificate. It then repeats the process, until
815 it gets to a certificate that is self-issued.
817 The process of looking up the issuer's certificate itself involves a number
818 of steps. After all certificates whose subject name matches the issuer
819 name of the current certificate are subject to further tests. The relevant
820 authority key identifier components of the current certificate (if present)
821 must match the subject key identifier (if present) and issuer and serial
822 number of the candidate issuer, in addition the keyUsage extension of the
823 candidate issuer (if present) must permit certificate signing.
825 The lookup first looks in the list of untrusted certificates and if no match
826 is found the remaining lookups are from the trusted certificates. The root CA
827 is always looked up in the trusted certificate list: if the certificate to
828 verify is a root certificate then an exact match must be found in the trusted
831 The second step is to check every untrusted certificate's extensions
832 for consistency with the supplied purpose. If the B<-purpose> option is
833 not included then no checks are done. The supplied or "leaf" certificate
834 must have extensions compatible with the supplied purpose and all other
835 certificates must also be valid CA certificates. The precise extensions
836 required are described in more detail in
837 L<openssl-x509(1)/CERTIFICATE EXTENSIONS>.
839 The third step is to check the trust settings on the root CA. The root
840 CA should be trusted for the supplied purpose. For compatibility with
841 previous versions of OpenSSL, a certificate with no trust settings is
842 considered to be valid for all purposes.
844 The fourth, and final, step is to check the validity of the certificate
845 chain. The validity period is checked against the system time
846 and the C<notBefore> and C<notAfter> dates in the certificate. The certificate
847 signatures are also checked at this point. The B<-attime> flag may be
848 used to specify a time other than "now."
850 If all operations complete successfully then certificate is considered
851 valid. If any operation fails then the certificate is not valid.
853 The details of the processing steps can be fine-tuned with the
860 Print extra information about the operations being performed.
862 =item B<-attime> I<timestamp>
864 Perform validation checks using time specified by I<timestamp> and not
865 current system time. I<timestamp> is the number of seconds since
866 January 1, 1970 (i.e., the Unix Epoch).
868 =item B<-no_check_time>
870 This option suppresses checking the validity period of certificates and CRLs
871 against the current time. If option B<-attime> is used to specify
872 a verification time, the check is not suppressed.
874 =item B<-x509_strict>
876 This disables non-compliant workarounds for broken certificates.
878 =item B<-ignore_critical>
880 Normally if an unhandled critical extension is present which is not
881 supported by OpenSSL the certificate is rejected (as required by RFC5280).
882 If this option is set critical extensions are ignored.
884 =item B<-issuer_checks>
890 Checks end entity certificate validity by attempting to look up a valid CRL.
891 If a valid CRL cannot be found an error occurs.
893 =item B<-crl_check_all>
895 Checks the validity of B<all> certificates in the chain by attempting
896 to look up valid CRLs.
900 Enable support for delta CRLs.
902 =item B<-extended_crl>
904 Enable extended CRL features such as indirect CRLs and alternate CRL
907 =item B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192>
909 Enable the Suite B mode operation at 128 bit Level of Security, 128 bit or
910 192 bit, or only 192 bit Level of Security respectively.
911 See RFC6460 for details. In particular the supported signature algorithms are
912 reduced to support only ECDSA and SHA256 or SHA384 and only the elliptic curves
915 =item B<-auth_level> I<level>
917 Set the certificate chain authentication security level to I<level>.
918 The authentication security level determines the acceptable signature and
919 public key strength when verifying certificate chains. For a certificate
920 chain to validate, the public keys of all the certificates must meet the
921 specified security I<level>. The signature algorithm security level is
922 enforced for all the certificates in the chain except for the chain's
923 I<trust anchor>, which is either directly trusted or validated by means
924 other than its signature. See L<SSL_CTX_set_security_level(3)> for the
925 definitions of the available levels. The default security level is -1,
926 or "not set". At security level 0 or lower all algorithms are acceptable.
927 Security level 1 requires at least 80-bit-equivalent security and is broadly
928 interoperable, though it will, for example, reject MD5 signatures or RSA
929 keys shorter than 1024 bits.
931 =item B<-partial_chain>
933 Allow verification to succeed even if a I<complete> chain cannot be built to a
934 self-signed trust-anchor, provided it is possible to construct a chain to a
935 trusted certificate that might not be self-signed.
937 =item B<-check_ss_sig>
939 Verify the signature on the self-signed root CA. This is disabled by default
940 because it doesn't add any security.
942 =item B<-allow_proxy_certs>
944 Allow the verification of proxy certificates.
946 =item B<-trusted_first>
948 As of OpenSSL 1.1.0 this option is on by default and cannot be disabled.
950 =item B<-no_alt_chains>
952 As of OpenSSL 1.1.0, since B<-trusted_first> always on, this option has no
955 =item B<-trusted> I<file>
957 Parse I<file> as a set of one or more certificates in PEM format.
958 All certificates must be self-signed, unless the
959 B<-partial_chain> option is specified.
960 This option implies the B<-no-CAfile> and B<-no-CApath> options and it
961 cannot be used with either the B<-CAfile> or B<-CApath> options, so
962 only certificates in the file are trust anchors.
963 This option may be used multiple times.
965 =item B<-untrusted> I<file>
967 Parse I<file> as a set of one or more certificates in PEM format.
968 All certificates are untrusted certificates that may be used to
969 construct a certificate chain from the subject certificate to a trust anchor.
970 This option may be used multiple times.
972 =item B<-policy> I<arg>
974 Enable policy processing and add I<arg> to the user-initial-policy-set (see
975 RFC5280). The policy I<arg> can be an object name an OID in numeric form.
976 This argument can appear more than once.
978 =item B<-explicit_policy>
980 Set policy variable require-explicit-policy (see RFC5280).
982 =item B<-policy_check>
984 Enables certificate policy processing.
986 =item B<-policy_print>
988 Print out diagnostics related to policy processing.
990 =item B<-inhibit_any>
992 Set policy variable inhibit-any-policy (see RFC5280).
994 =item B<-inhibit_map>
996 Set policy variable inhibit-policy-mapping (see RFC5280).
998 =item B<-purpose> I<purpose>
1000 The intended use for the certificate. If this option is not specified, this
1001 command will not consider certificate purpose during chain verification.
1002 Currently accepted uses are B<sslclient>, B<sslserver>, B<nssslserver>,
1003 B<smimesign>, B<smimeencrypt>.
1005 =item B<-verify_depth> I<num>
1007 Limit the certificate chain to I<num> intermediate CA certificates.
1008 A maximal depth chain can have up to I<num>+2 certificates, since neither the
1009 end-entity certificate nor the trust-anchor certificate count against the
1010 B<-verify_depth> limit.
1012 =item B<-verify_email> I<email>
1014 Verify if I<email> matches the email address in Subject Alternative Name or
1015 the email in the subject Distinguished Name.
1017 =item B<-verify_hostname> I<hostname>
1019 Verify if I<hostname> matches DNS name in Subject Alternative Name or
1020 Common Name in the subject certificate.
1022 =item B<-verify_ip> I<ip>
1024 Verify if I<ip> matches the IP address in Subject Alternative Name of
1025 the subject certificate.
1027 =item B<-verify_name> I<name>
1029 Use default verification policies like trust model and required certificate
1030 policies identified by I<name>.
1031 The trust model determines which auxiliary trust or reject OIDs are applicable
1032 to verifying the given certificate chain.
1033 See the B<-addtrust> and B<-addreject> options for L<openssl-x509(1)>.
1034 Supported policy names include: B<default>, B<pkcs7>, B<smime_sign>,
1035 B<ssl_client>, B<ssl_server>.
1036 These mimics the combinations of purpose and trust settings used in SSL, CMS
1038 As of OpenSSL 1.1.0, the trust model is inferred from the purpose when not
1039 specified, so the B<-verify_name> options are functionally equivalent to the
1040 corresponding B<-purpose> settings.
1044 =head2 Name Format Options
1046 OpenSSL provides fine-grain control over how the subject and issuer DN's are
1048 This is specified by using the B<-nameopt> option, which takes a
1049 comma-separated list of options from the following set.
1050 An option may be preceeded by a minus sign, C<->, to turn it off.
1051 The default value is C<oneline>.
1052 The first four are the most commonly used.
1058 Display the name using an old format from previous OpenSSL versions.
1062 Display the name using the format defined in RFC 2253.
1063 It is equivalent to B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>,
1064 B<dump_nostr>, B<dump_unknown>, B<dump_der>, B<sep_comma_plus>, B<dn_rev>
1069 Display the name in one line, using a format that is more readable
1071 It is equivalent to B<esc_2253>, B<esc_ctrl>, B<esc_msb>, B<utf8>,
1072 B<dump_nostr>, B<dump_der>, B<use_quote>, B<sep_comma_plus_space>,
1073 B<space_eq> and B<sname> options.
1077 Display the name using multiple lines.
1078 It is equivalent to B<esc_ctrl>, B<esc_msb>, B<sep_multiline>, B<space_eq>,
1079 B<lname> and B<align>.
1083 Escape the "special" characters in a field, as required by RFC 2253.
1084 That is, any of the characters C<,+"E<lt>E<gt>;>, C<#> at the beginning of
1085 a string and leading or trailing spaces.
1089 Escape the "special" characters in a field as required by RFC 2254 in a field.
1090 That is, the B<NUL> character and and of C<()*>.
1094 Escape non-printable ASCII characters, codes less than 0x20 (space)
1095 or greater than 0x7F (DELETE). They are displayed using RFC 2253 C<\XX>
1096 notation where B<XX> are the two hex digits representing the character value.
1100 Escape any characters with the most significant bit set, that is with
1101 values larger than 127, as described in B<esc_ctrl>.
1105 Escapes some characters by surrounding the entire string with quotation
1107 Without this option, individual special characters are preceeded with
1108 a backslash character, C<\>.
1112 Convert all strings to UTF-8 format first as required by RFC 2253.
1113 If the output device is UTF-8 compatible, then using this option (and
1114 not setting B<esc_msb>) may give the correct display of multibyte
1116 If this option is not set, then multibyte characters larger than 0xFF
1117 will be output as C<\UXXXX> for 16 bits or C<\WXXXXXXXX> for 32 bits.
1118 In addition, any UTF8Strings will be converted to their character form first.
1120 =item B<ignore_type>
1122 This option does not attempt to interpret multibyte characters in any
1123 way. That is, the content octets are merely dumped as though one octet
1124 represents each character. This is useful for diagnostic purposes but
1125 will result in rather odd looking output.
1129 Display the type of the ASN1 character string before the value,
1130 such as C<BMPSTRING: Hello World>.
1134 Any fields that would be output in hex format are displayed using
1135 the DER encoding of the field.
1136 If not set, just the content octets are displayed.
1137 Either way, the B<#XXXX...> format of RFC 2253 is used.
1141 Dump non-character strings, such as ASN.1 B<OCTET STRING>.
1142 If this option is not set, then non character string types will be displayed
1143 as though each content octet represents a single character.
1147 Dump all fields. When this used with B<dump_der>, this allows the
1148 DER encoding of the structure to be unambiguously determined.
1150 =item B<dump_unknown>
1152 Dump any field whose OID is not recognised by OpenSSL.
1154 =item B<sep_comma_plus>, B<sep_comma_plus_space>, B<sep_semi_plus_space>,
1157 Specify the field separators. The first word is used between the
1158 Relative Distinguished Names (RDNs) and the second is between
1159 multiple Attribute Value Assertions (AVAs). Multiple AVAs are
1160 very rare and their use is discouraged.
1161 The options ending in "space" additionally place a space after the separator to make it more readable.
1162 The B<sep_multiline> starts each field on its own line, and uses "plus space"
1163 for the AVA separator.
1164 It also indents the fields by four characters.
1165 The default value is B<sep_comma_plus_space>.
1169 Reverse the fields of the DN as required by RFC 2253.
1170 This also reverses the order of multiple AVAs in a field, but this is
1171 permissible as there is no ordering on values.
1173 =item B<nofname>, B<sname>, B<lname>, B<oid>
1175 Specify how the field name is displayed.
1176 B<nofname> does not display the field at all.
1177 B<sname> uses the "short name" form (CN for commonName for example).
1178 B<lname> uses the long form.
1179 B<oid> represents the OID in numerical form and is useful for
1184 Align field values for a more readable output. Only usable with
1189 Places spaces round the equal sign, C<=>, character which follows the field
1194 =head2 TLS Version Options
1196 Several commands use SSL, TLS, or DTLS. By default, the commands use TLS and
1197 clients will offer the lowest and highest protocol version they support,
1198 and servers will pick the highest version that the client offers that is also
1199 supported by the server.
1201 The options below can be used to limit which protocol versions are used,
1202 and whether TCP (SSL and TLS) or UDP (DTLS) is used.
1203 Note that not all protocols and flags may be available, depending on how
1208 =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>
1210 These options require or disable the use of the specified SSL or TLS protocols.
1211 When a specific TLS version is required, only that version will be offered or
1213 Only one specific protocol can be given and it cannot be combined with any of
1216 =item B<-dtls>, B<-dtls1>, B<-dtls1_2>
1218 These options specify to use DTLS instead of DLTS.
1219 With B<-dtls>, clients will negotiate any supported DTLS protocol version.
1220 Use the B<-dtls1> or B<-dtls1_2> options to support only DTLS1.0 or DTLS1.2,
1225 =head2 Engine Options
1229 =item B<-engine> I<id>
1231 Use the engine identified by I<id> and use all the methods it
1232 implements (algorithms, key storage, etc.), unless specified otherwise in
1233 the command-specific documentation or it is configured to do so, as described
1234 in L<config(5)/Engine Configuration Module>.
1240 The OpenSSL library can be take some configuration parameters from the
1241 environment. Some of these variables are listed below. For information
1242 about specific commands, see L<openssl-engine(1)>, L<openssl-provider(1)>,
1243 L<openssl-rehash(1)>, and L<tsget(1)>.
1245 For information about the use of environment variables in configuration,
1246 see L<config(5)/ENVIRONMENT>.
1248 For information about querying or specifying CPU architecture flags, see
1249 L<OPENSSL_ia32cap(3)>, and L<OPENSSL_s390xcap(3)>.
1251 For information about all environment variables used by the OpenSSL libraries,
1252 see L<openssl-env(7)>.
1256 =item B<OPENSSL_TRACE=>I<name>[,...]
1258 Enable tracing output of OpenSSL library, by name.
1259 This output will only make sense if you know OpenSSL internals well.
1260 Also, it might not give you any output at all, depending on how
1263 The value is a comma separated list of names, with the following
1270 The tracing functionality.
1280 =item B<ENGINE_CONF>
1282 ENGINE configuration.
1284 =item B<ENGINE_TABLE>
1286 The function that is used by RSA, DSA (etc) code to select registered
1287 ENGINEs, cache defaults and functional references (etc), will generate
1288 debugging summaries.
1290 =item B<ENGINE_REF_COUNT>
1292 Reference counts in the ENGINE structure will be monitored with a line
1293 of generated for each change.
1299 =item B<PKCS12_KEYGEN>
1301 PKCS#12 key generation.
1303 =item B<PKCS12_DECRYPT>
1307 =item B<X509V3_POLICY>
1309 Generates the complete policy tree at various point during X.509 v3
1322 L<openssl-asn1parse(1)>,
1324 L<openssl-ciphers(1)>,
1327 L<openssl-crl2pkcs7(1)>,
1329 L<openssl-dhparam(1)>,
1331 L<openssl-dsaparam(1)>,
1333 L<openssl-ecparam(1)>,
1335 L<openssl-engine(1)>,
1336 L<openssl-errstr(1)>,
1337 L<openssl-gendsa(1)>,
1338 L<openssl-genpkey(1)>,
1339 L<openssl-genrsa(1)>,
1344 L<openssl-passwd(1)>,
1345 L<openssl-pkcs12(1)>,
1346 L<openssl-pkcs7(1)>,
1347 L<openssl-pkcs8(1)>,
1349 L<openssl-pkeyparam(1)>,
1350 L<openssl-pkeyutl(1)>,
1351 L<openssl-prime(1)>,
1353 L<openssl-rehash(1)>,
1356 L<openssl-rsautl(1)>,
1357 L<openssl-s_client(1)>,
1358 L<openssl-s_server(1)>,
1359 L<openssl-s_time(1)>,
1360 L<openssl-sess_id(1)>,
1361 L<openssl-smime(1)>,
1362 L<openssl-speed(1)>,
1363 L<openssl-spkac(1)>,
1365 L<openssl-storeutl(1)>,
1367 L<openssl-verify(1)>,
1368 L<openssl-version(1)>,
1379 The B<list> -I<XXX>B<-algorithms> options were added in OpenSSL 1.0.0;
1380 For notes on the availability of other commands, see their individual
1383 The B<-issuer_checks> option is deprecated as of OpenSSL 1.1.0 and
1384 is silently ignored.
1388 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
1390 Licensed under the Apache License 2.0 (the "License"). You may not use
1391 this file except in compliance with the License. You can obtain a copy
1392 in the file LICENSE in the source distribution or at
1393 L<https://www.openssl.org/source/license.html>.
projects / openssl.git / blob