Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)

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
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
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 1" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
openssl - OpenSSL command line tool Header "SYNOPSIS" \fBopenssl \fIcommand [ command_opts ] [ command_args ]

\fBopenssl list [ standard-commands | digest-commands | cipher-commands | cipher-algorithms | digest-algorithms | public-key-algorithms]

\fBopenssl no-\s-1XXX\s0 [ arbitrary 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 tool 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 o Encryption and Decryption with Ciphers o SSL/TLS Client and Server Tests o Handling of S/MIME signed or encrypted mail o Time Stamp requests, generation and verification .Ve

Header "COMMAND SUMMARY" The openssl program provides a rich variety of commands (command in the \s-1SYNOPSIS\s0 above), each of which often has a wealth of options and arguments (command_opts and command_args in the \s-1SYNOPSIS\s0).

Detailed documentation and use cases for most standard subcommands are available (e.g., x509\|(1) or openssl-x509\|(1)).

Many commands use an external configuration file for some or all of their arguments and have a -config option to specify that file. The environment variable \s-1OPENSSL_CONF\s0 can be used to specify the location of the file. If the environment variable is not specified, then the file is named \fBopenssl.cnf in the default certificate storage area, whose value depends on the configuration flags specified when the OpenSSL was built.

The list parameters standard-commands, digest-commands, and cipher-commands output a list (one entry per line) of the names of all standard commands, message digest commands, or cipher commands, respectively, that are available in the present openssl utility.

The list parameters cipher-algorithms and \fBdigest-algorithms list all cipher and message digest names, one entry per line. Aliases are listed as:

.Vb 1 from => to .Ve

The list parameter public-key-algorithms lists all supported public key algorithms.

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 "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) utility. Item "crl" Certificate Revocation List (\s-1CRL\s0) Management. Item "crl2pkcs7" \s-1CRL\s0 to PKCS#7 Conversion. Item "dgst" Message Digest Calculation. Item "dh" Diffie-Hellman Parameter Management. Obsoleted by dhparam\|(1). Item "dhparam" Generation and Management of Diffie-Hellman Parameters. Superseded by \fBgenpkey\|(1) and pkeyparam\|(1). Item "dsa" \s-1DSA\s0 Data Management. Item "dsaparam" \s-1DSA\s0 Parameter Generation and Management. Superseded by \fBgenpkey\|(1) and pkeyparam\|(1). Item "ec" \s-1EC\s0 (Elliptic curve) key processing. Item "ecparam" \s-1EC\s0 parameter manipulation and generation. Item "enc" Encoding with Ciphers. Item "engine" Engine (loadable module) information and manipulation. Item "errstr" Error Number to Error String Conversion. Item "gendh" Generation of Diffie-Hellman Parameters. Obsoleted by dhparam\|(1). Item "gendsa" Generation of \s-1DSA\s0 Private Key from Parameters. Superseded by \fBgenpkey\|(1) and pkey\|(1). Item "genpkey" Generation of Private Key or Parameters. Item "genrsa" Generation of \s-1RSA\s0 Private Key. Superseded by genpkey\|(1). Item "nseq" Create or examine a Netscape certificate sequence. Item "ocsp" Online Certificate Status Protocol utility. 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 tool. Item "pkey" Public and private key management. Item "pkeyparam" Public key algorithm parameter management. Item "pkeyutl" Public key algorithm cryptographic operation utility. 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 utility for signing, verification, encryption, and decryption. Superseded by 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 utility. Item "srp" Maintain \s-1SRP\s0 password file. Item "storeutl" Utility to list and display certificates, keys, CRLs, etc. Item "ts" Time Stamping Authority tool (client/server). Item "verify" X.509 Certificate Verification. 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 "Encoding and Cipher 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 enc\|(1) for more information and command usage.

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. Subsection "Pass Phrase Options" Several commands accept password arguments, typically using -passin and -passout for input and output passwords respectively. These allow the password to be obtained from a variety of sources. Both of these options take a single argument whose format is described below. If no password argument is given and a password is required then the user is prompted to enter one: this will typically be read from the current terminal with echoing turned off.

Note that character encoding may be relevant, please see \fBpassphrase-encoding\|(7).

Item "pass:password" The actual password is password. Since the password is visible to utilities (like 'ps' under Unix) this form should only be used where security is not important. Item "env:var" Obtain the password from the environment variable var. Since the environment of other processes is visible on certain platforms (e.g. ps under certain Unix OSes) this option should be used with caution. Item "file:pathname" The first line of pathname is the password. If the same pathname argument is supplied to -passin and -passout arguments then the first line will be used for the input password and the next line for the output password. pathname need not refer to a regular file: it could for example refer to a device or named pipe. Item "fd:number" Read the password from the file descriptor number. This can be used to send the data via a pipe for example. Item "stdin" Read the password from standard input. Header "SEE ALSO" \fBasn1parse\|(1), ca\|(1), ciphers\|(1), cms\|(1), config\|(5), \fBcrl\|(1), crl2pkcs7\|(1), dgst\|(1), \fBdhparam\|(1), dsa\|(1), dsaparam\|(1), \fBec\|(1), ecparam\|(1), \fBenc\|(1), engine\|(1), errstr\|(1), gendsa\|(1), genpkey\|(1), \fBgenrsa\|(1), nseq\|(1), ocsp\|(1), \fBpasswd\|(1), \fBpkcs12\|(1), pkcs7\|(1), pkcs8\|(1), \fBpkey\|(1), pkeyparam\|(1), pkeyutl\|(1), prime\|(1), \fBrand\|(1), rehash\|(1), req\|(1), rsa\|(1), \fBrsautl\|(1), s_client\|(1), \fBs_server\|(1), s_time\|(1), sess_id\|(1), \fBsmime\|(1), speed\|(1), spkac\|(1), srp\|(1), storeutl\|(1), \fBts\|(1), \fBverify\|(1), version\|(1), x509\|(1), \fBcrypto\|(7), ssl\|(7), x509v3_config\|(5) Header "HISTORY" The list-\s-1XXX\s0-algorithms pseudo-commands were added in OpenSSL 1.0.0; For notes on the availability of other commands, see their individual manual pages. Header "COPYRIGHT" Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (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>.