Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL 1ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
openssl - OpenSSL command line program Header "SYNOPSIS" \fBopenssl \fIcommand [ options ... ] [ parameters ... ]

\fBopenssl no-\s-1XXX\s0 [ options ]

Header "DESCRIPTION" OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (\s-1SSL\s0 v2/v3) and Transport Layer Security (\s-1TLS\s0 v1) network protocols and related cryptography standards required by them.

The openssl program is a command line program for using the various cryptography functions of OpenSSL's crypto library from the shell. It can be used for

.Vb 8 o Creation and management of private keys, public keys and parameters o Public key cryptographic operations o Creation of X.509 certificates, CSRs and CRLs o Calculation of Message Digests and Message Authentication Codes o Encryption and Decryption with Ciphers o SSL/TLS Client and Server Tests o Handling of S/MIME signed or encrypted mail o Timestamp requests, generation and verification .Ve

Header "COMMAND SUMMARY" The openssl program provides a rich variety of commands (command in the \*(L"\s-1SYNOPSIS\*(R"\s0 above). Each command can have many options and argument parameters, shown above as \fIoptions and parameters.

Detailed documentation and use cases for most standard subcommands are available (e.g., openssl-x509\|(1)). The subcommand openssl-list\|(1) may be used to list subcommands.

The command no-\s-1XXX\s0 tests whether a command of the specified name is available. If no command named \s-1XXX\s0 exists, it returns 0 (success) and prints no-\s-1XXX\s0; otherwise it returns 1 and prints \s-1XXX\s0. In both cases, the output goes to stdout and nothing is printed to stderr. Additional command line arguments are always ignored. Since for each cipher there is a command of the same name, this provides an easy way for shell scripts to test for the availability of ciphers in the openssl program. (no-\s-1XXX\s0 is not able to detect pseudo-commands such as quit, \fBlist, or no-\s-1XXX\s0 itself.)

Subsection "Configuration Option" Many commands use an external configuration file for some or all of their arguments and have a -config option to specify that file. The default name of the file is openssl.cnf in the default certificate storage area, which can be determined from the openssl-version\|(1) command using the -d or -a option. The environment variable \s-1OPENSSL_CONF\s0 can be used to specify a different file location or to disable loading a configuration (using the empty string).

Among others, the configuration file can be used to load modules and to specify parameters for generating certificates and random numbers. See config\|(5) for details.

Subsection "Standard Commands" Item "asn1parse" Parse an \s-1ASN.1\s0 sequence. Item "ca" Certificate Authority (\s-1CA\s0) Management. Item "ciphers" Cipher Suite Description Determination. Item "cms" \s-1CMS\s0 (Cryptographic Message Syntax) command. Item "crl" Certificate Revocation List (\s-1CRL\s0) Management. Item "crl2pkcs7" \s-1CRL\s0 to PKCS#7 Conversion. Item "dgst" Message Digest calculation. \s-1MAC\s0 calculations are superseded by \fBopenssl-mac\|(1). Item "dhparam" Generation and Management of Diffie-Hellman Parameters. Superseded by \fBopenssl-genpkey\|(1) and openssl-pkeyparam\|(1). Item "dsa" \s-1DSA\s0 Data Management. Item "dsaparam" \s-1DSA\s0 Parameter Generation and Management. Superseded by \fBopenssl-genpkey\|(1) and openssl-pkeyparam\|(1). Item "ec" \s-1EC\s0 (Elliptic curve) key processing. Item "ecparam" \s-1EC\s0 parameter manipulation and generation. Item "enc" Encryption, decryption, and encoding. Item "engine" Engine (loadable module) information and manipulation. Item "errstr" Error Number to Error String Conversion. Item "fipsinstall" \s-1FIPS\s0 configuration installation. Item "gendsa" Generation of \s-1DSA\s0 Private Key from Parameters. Superseded by \fBopenssl-genpkey\|(1) and openssl-pkey\|(1). Item "genpkey" Generation of Private Key or Parameters. Item "genrsa" Generation of \s-1RSA\s0 Private Key. Superseded by openssl-genpkey\|(1). Item "help" Display information about a command's options. Item "info" Display diverse information built into the OpenSSL libraries. Item "kdf" Key Derivation Functions. Item "list" List algorithms and features. Item "mac" Message Authentication Code Calculation. Item "nseq" Create or examine a Netscape certificate sequence. Item "ocsp" Online Certificate Status Protocol command. Item "passwd" Generation of hashed passwords. Item "pkcs12" PKCS#12 Data Management. Item "pkcs7" PKCS#7 Data Management. Item "pkcs8" PKCS#8 format private key conversion command. Item "pkey" Public and private key management. Item "pkeyparam" Public key algorithm parameter management. Item "pkeyutl" Public key algorithm cryptographic operation command. Item "prime" Compute prime numbers. Item "rand" Generate pseudo-random bytes. Item "rehash" Create symbolic links to certificate and \s-1CRL\s0 files named by the hash values. Item "req" PKCS#10 X.509 Certificate Signing Request (\s-1CSR\s0) Management. Item "rsa" \s-1RSA\s0 key management. Item "rsautl" \s-1RSA\s0 command for signing, verification, encryption, and decryption. Superseded by openssl-pkeyutl\|(1). Item "s_client" This implements a generic \s-1SSL/TLS\s0 client which can establish a transparent connection to a remote server speaking \s-1SSL/TLS.\s0 It's intended for testing purposes only and provides only rudimentary interface functionality but internally uses mostly all functionality of the OpenSSL ssl library. Item "s_server" This implements a generic \s-1SSL/TLS\s0 server which accepts connections from remote clients speaking \s-1SSL/TLS.\s0 It's intended for testing purposes only and provides only rudimentary interface functionality but internally uses mostly all functionality of the OpenSSL ssl library. It provides both an own command line oriented protocol for testing \s-1SSL\s0 functions and a simple \s-1HTTP\s0 response facility to emulate an SSL/TLS-aware webserver. Item "s_time" \s-1SSL\s0 Connection Timer. Item "sess_id" \s-1SSL\s0 Session Data Management. Item "smime" S/MIME mail processing. Item "speed" Algorithm Speed Measurement. Item "spkac" \s-1SPKAC\s0 printing and generating command. Item "srp" Maintain \s-1SRP\s0 password file. This command is deprecated. Item "storeutl" Command to list and display certificates, keys, CRLs, etc. Item "ts" Time Stamping Authority command. Item "verify" X.509 Certificate Verification. See also the openssl-verification-options\|(1) manual page. Item "version" OpenSSL Version Information. Item "x509" X.509 Certificate Data Management. Subsection "Message Digest Commands" Item "blake2b512" BLAKE2b-512 Digest Item "blake2s256" BLAKE2s-256 Digest Item "md2" \s-1MD2\s0 Digest Item "md4" \s-1MD4\s0 Digest Item "md5" \s-1MD5\s0 Digest Item "mdc2" \s-1MDC2\s0 Digest Item "rmd160" \s-1RMD-160\s0 Digest Item "sha1" \s-1SHA-1\s0 Digest Item "sha224" \s-1SHA-2 224\s0 Digest Item "sha256" \s-1SHA-2 256\s0 Digest Item "sha384" \s-1SHA-2 384\s0 Digest Item "sha512" \s-1SHA-2 512\s0 Digest Item "sha3-224" \s-1SHA-3 224\s0 Digest Item "sha3-256" \s-1SHA-3 256\s0 Digest Item "sha3-384" \s-1SHA-3 384\s0 Digest Item "sha3-512" \s-1SHA-3 512\s0 Digest Item "shake128" \s-1SHA-3 SHAKE128\s0 Digest Item "shake256" \s-1SHA-3 SHAKE256\s0 Digest Item "sm3" \s-1SM3\s0 Digest Subsection "Encryption, Decryption, and Encoding Commands" The following aliases provide convenient access to the most used encodings and ciphers.

Depending on how OpenSSL was configured and built, not all ciphers listed here may be present. See openssl-enc\|(1) for more information.

Item "aes128, aes-128-cbc, aes-128-cfb, aes-128-ctr, aes-128-ecb, aes-128-ofb" \s-1AES-128\s0 Cipher Item "aes192, aes-192-cbc, aes-192-cfb, aes-192-ctr, aes-192-ecb, aes-192-ofb" \s-1AES-192\s0 Cipher Item "aes256, aes-256-cbc, aes-256-cfb, aes-256-ctr, aes-256-ecb, aes-256-ofb" \s-1AES-256\s0 Cipher Item "aria128, aria-128-cbc, aria-128-cfb, aria-128-ctr, aria-128-ecb, aria-128-ofb" Aria-128 Cipher Item "aria192, aria-192-cbc, aria-192-cfb, aria-192-ctr, aria-192-ecb, aria-192-ofb" Aria-192 Cipher Item "aria256, aria-256-cbc, aria-256-cfb, aria-256-ctr, aria-256-ecb, aria-256-ofb" Aria-256 Cipher Item "base64" Base64 Encoding Item "bf, bf-cbc, bf-cfb, bf-ecb, bf-ofb" Blowfish Cipher Item "camellia128, camellia-128-cbc, camellia-128-cfb, camellia-128-ctr, camellia-128-ecb, camellia-128-ofb" Camellia-128 Cipher Item "camellia192, camellia-192-cbc, camellia-192-cfb, camellia-192-ctr, camellia-192-ecb, camellia-192-ofb" Camellia-192 Cipher Item "camellia256, camellia-256-cbc, camellia-256-cfb, camellia-256-ctr, camellia-256-ecb, camellia-256-ofb" Camellia-256 Cipher Item "cast, cast-cbc" \s-1CAST\s0 Cipher Item "cast5-cbc, cast5-cfb, cast5-ecb, cast5-ofb" \s-1CAST5\s0 Cipher Item "chacha20" Chacha20 Cipher Item "des, des-cbc, des-cfb, des-ecb, des-ede, des-ede-cbc, des-ede-cfb, des-ede-ofb, des-ofb" \s-1DES\s0 Cipher Item "des3, desx, des-ede3, des-ede3-cbc, des-ede3-cfb, des-ede3-ofb" Triple-DES Cipher Item "idea, idea-cbc, idea-cfb, idea-ecb, idea-ofb" \s-1IDEA\s0 Cipher Item "rc2, rc2-cbc, rc2-cfb, rc2-ecb, rc2-ofb" \s-1RC2\s0 Cipher Item "rc4" \s-1RC4\s0 Cipher Item "rc5, rc5-cbc, rc5-cfb, rc5-ecb, rc5-ofb" \s-1RC5\s0 Cipher Item "seed, seed-cbc, seed-cfb, seed-ecb, seed-ofb" \s-1SEED\s0 Cipher Item "sm4, sm4-cbc, sm4-cfb, sm4-ctr, sm4-ecb, sm4-ofb" \s-1SM4\s0 Cipher Header "OPTIONS" Details of which options are available depend on the specific command. This section describes some common options with common behavior. Subsection "Common Options" Item "-help" Provides a terse summary of all options. If an option takes an argument, the \*(L"type\*(R" of argument is also given. Item "--" This terminates the list of options. It is mostly useful if any filename parameters start with a minus sign: .Sp .Vb 1 openssl verify [flags...] -- -cert1.pem... .Ve Subsection "Format Options" See openssl-format-options\|(1) for manual page. Subsection "Pass Phrase Options" See the openssl-passphrase-options\|(1) manual page. Subsection "Random State Options" Prior to OpenSSL 1.1.1, it was common for applications to store information about the state of the random-number generator in a file that was loaded at startup and rewritten upon exit. On modern operating systems, this is generally no longer necessary as OpenSSL will seed itself from a trusted entropy source provided by the operating system. These flags are still supported for special platforms or circumstances that might require them.

It is generally an error to use the same seed file more than once and every use of -rand should be paired with -writerand.

Item "-rand files" A file or files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is \*(C`;\*(C' for MS-Windows, \*(C`,\*(C' for OpenVMS, and \*(C`:\*(C' for all others. Another way to specify multiple files is to repeat this flag with different filenames. Item "-writerand file" Writes the seed data to the specified file upon exit. This file can be used in a subsequent command invocation. Subsection "Certificate Verification Options" See the openssl-verification-options\|(1) manual page. Subsection "Name Format Options" See the openssl-namedisplay-options\|(1) manual page. Subsection "TLS Version Options" Several commands use \s-1SSL, TLS,\s0 or \s-1DTLS.\s0 By default, the commands use \s-1TLS\s0 and clients will offer the lowest and highest protocol version they support, and servers will pick the highest version that the client offers that is also supported by the server.

The options below can be used to limit which protocol versions are used, and whether \s-1TCP\s0 (\s-1SSL\s0 and \s-1TLS\s0) or \s-1UDP\s0 (\s-1DTLS\s0) is used. Note that not all protocols and flags may be available, depending on how OpenSSL was built.

Item "-ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3, -no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3" These options require or disable the use of the specified \s-1SSL\s0 or \s-1TLS\s0 protocols. When a specific \s-1TLS\s0 version is required, only that version will be offered or accepted. Only one specific protocol can be given and it cannot be combined with any of the no_ options. The no_* options do not work with s_time and ciphers commands but work with \fBs_client and s_server commands. Item "-dtls, -dtls1, -dtls1_2" These options specify to use \s-1DTLS\s0 instead of \s-1TLS.\s0 With -dtls, clients will negotiate any supported \s-1DTLS\s0 protocol version. Use the -dtls1 or -dtls1_2 options to support only \s-1DTLS1.0\s0 or \s-1DTLS1.2,\s0 respectively. Subsection "Engine Options" Item "-engine id" Load the engine identified by id and use all the methods it implements (algorithms, key storage, etc.), unless specified otherwise in the command-specific documentation or it is configured to do so, as described in \*(L"Engine Configuration\*(R" in config\|(5). .Sp The engine will be used for key ids specified with -key and similar options when an option like -keyform engine is given. .Sp A special case is the \*(C`loader_attic\*(C' engine, which is meant just for internal OpenSSL testing purposes and supports loading keys, parameters, certificates, and CRLs from files. When this engine is used, files with such credentials are read via this engine. Using the \*(C`file:\*(C' schema is optional; a plain file (path) name will do.

Options specifying keys, like -key and similar, can use the generic OpenSSL engine key loading \s-1URI\s0 scheme \*(C`org.openssl.engine:\*(C' to retrieve private keys and public keys. The \s-1URI\s0 syntax is as follows, in simplified form:

.Vb 1 org.openssl.engine:{engineid}:{keyid} .Ve

Where \*(C`{engineid}\*(C' is the identity/name of the engine, and \*(C`{keyid}\*(C' is a key identifier that's acceptable by that engine. For example, when using an engine that interfaces against a PKCS#11 implementation, the generic key \s-1URI\s0 would be something like this (this happens to be an example for the PKCS#11 engine that's part of OpenSC):

.Vb 1 -key org.openssl.engine:pkcs11:label_some-private-key .Ve

As a third possibility, for engines and providers that have implemented their own \s-1OSSL_STORE_LOADER\s0\|(3), \*(C`org.openssl.engine:\*(C' should not be necessary. For a PKCS#11 implementation that has implemented such a loader, the PKCS#11 \s-1URI\s0 as defined in \s-1RFC 7512\s0 should be possible to use directly:

.Vb 1 -key pkcs11:object=some-private-key;pin-value=1234 .Ve

Subsection "Provider Options" Item "-provider name" Load and initialize the provider identified by name. The name can be also a path to the provider module. In that case the provider name will be the specified path and not just the provider module name. Interpretation of relative paths is platform specific. The configured \*(L"\s-1MODULESDIR\*(R"\s0 path, \s-1OPENSSL_MODULES\s0 environment variable, or the path specified by -provider-path is prepended to relative paths. See provider\|(7) for a more detailed description. Item "-provider-path path" Specifies the search path that is to be used for looking for providers. Equivalently, the \s-1OPENSSL_MODULES\s0 environment variable may be set. Item "-propquery propq" Specifies the property query clause to be used when fetching algorithms from the loaded providers. See property\|(7) for a more detailed description. Header "ENVIRONMENT" The OpenSSL library can be take some configuration parameters from the environment. Some of these variables are listed below. For information about specific commands, see openssl-engine\|(1), \fBopenssl-rehash\|(1), and tsget\|(1).

For information about the use of environment variables in configuration, see \*(L"\s-1ENVIRONMENT\*(R"\s0 in config\|(5).

For information about querying or specifying \s-1CPU\s0 architecture flags, see \fBOPENSSL_ia32cap\|(3), and OPENSSL_s390xcap\|(3).

For information about all environment variables used by the OpenSSL libraries, see openssl-env\|(7).

Item "OPENSSL_TRACE=name[,...]" Enable tracing output of OpenSSL library, by name. This output will only make sense if you know OpenSSL internals well. Also, it might not give you any output at all, depending on how OpenSSL was built. .Sp The value is a comma separated list of names, with the following available: Header "SEE ALSO" \fBopenssl-asn1parse\|(1), \fBopenssl-ca\|(1), \fBopenssl-ciphers\|(1), \fBopenssl-cms\|(1), \fBopenssl-crl\|(1), \fBopenssl-crl2pkcs7\|(1), \fBopenssl-dgst\|(1), \fBopenssl-dhparam\|(1), \fBopenssl-dsa\|(1), \fBopenssl-dsaparam\|(1), \fBopenssl-ec\|(1), \fBopenssl-ecparam\|(1), \fBopenssl-enc\|(1), \fBopenssl-engine\|(1), \fBopenssl-errstr\|(1), \fBopenssl-gendsa\|(1), \fBopenssl-genpkey\|(1), \fBopenssl-genrsa\|(1), \fBopenssl-kdf\|(1), \fBopenssl-list\|(1), \fBopenssl-mac\|(1), \fBopenssl-nseq\|(1), \fBopenssl-ocsp\|(1), \fBopenssl-passwd\|(1), \fBopenssl-pkcs12\|(1), \fBopenssl-pkcs7\|(1), \fBopenssl-pkcs8\|(1), \fBopenssl-pkey\|(1), \fBopenssl-pkeyparam\|(1), \fBopenssl-pkeyutl\|(1), \fBopenssl-prime\|(1), \fBopenssl-rand\|(1), \fBopenssl-rehash\|(1), \fBopenssl-req\|(1), \fBopenssl-rsa\|(1), \fBopenssl-rsautl\|(1), \fBopenssl-s_client\|(1), \fBopenssl-s_server\|(1), \fBopenssl-s_time\|(1), \fBopenssl-sess_id\|(1), \fBopenssl-smime\|(1), \fBopenssl-speed\|(1), \fBopenssl-spkac\|(1), \fBopenssl-srp\|(1), \fBopenssl-storeutl\|(1), \fBopenssl-ts\|(1), \fBopenssl-verify\|(1), \fBopenssl-version\|(1), \fBopenssl-x509\|(1), \fBconfig\|(5), \fBcrypto\|(7), \fBopenssl-env\|(7). \fBssl\|(7), \fBx509v3_config\|(5) Header "HISTORY" The list -\s-1XXX\s0-algorithms options were added in OpenSSL 1.0.0; For notes on the availability of other commands, see their individual manual pages.

The -issuer_checks option is deprecated as of OpenSSL 1.1.0 and is silently ignored.

The -xcertform and -xkeyform options are obsolete since OpenSSL 3.0 and have no effect.

The interactive mode, which could be invoked by running \*(C`openssl\*(C' with no further arguments, was removed in OpenSSL 3.0, and running that program with no arguments is now equivalent to \*(C`openssl help\*(C'.

Header "COPYRIGHT" Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.