diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/openssl.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/openssl.1 | 555 |
1 files changed, 227 insertions, 328 deletions
diff --git a/secure/usr.bin/openssl/man/openssl.1 b/secure/usr.bin/openssl/man/openssl.1 index b9c625a7d487..9c73929b1139 100644 --- a/secure/usr.bin/openssl/man/openssl.1 +++ b/secure/usr.bin/openssl/man/openssl.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. 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\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,88 +52,30 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. 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 -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. 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 -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "OPENSSL 1ossl" -.TH OPENSSL 1ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH OPENSSL 1ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME openssl \- OpenSSL command line program -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBopenssl\fR \&\fIcommand\fR [ \fIoptions\fR ... ] [ \fIparameters\fR ... ] .PP -\&\fBopenssl\fR \fBno\-\fR\fI\s-1XXX\s0\fR [ \fIoptions\fR ] -.SH "DESCRIPTION" +\&\fBopenssl\fR \fBno\-\fR\fIXXX\fR [ \fIoptions\fR ] +.PP +\&\fBopenssl\fR \fB\-help\fR | \fB\-version\fR +.SH DESCRIPTION .IX 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 +OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL) +and Transport Layer Security (TLS) network protocols and related cryptography standards required by them. .PP The \fBopenssl\fR program is a command line program for using the various @@ -169,7 +95,7 @@ It can be used for .SH "COMMAND SUMMARY" .IX Header "COMMAND SUMMARY" The \fBopenssl\fR program provides a rich variety of commands (\fIcommand\fR in -the \*(L"\s-1SYNOPSIS\*(R"\s0 above). +the "SYNOPSIS" above). Each command can have many options and argument parameters, shown above as \&\fIoptions\fR and \fIparameters\fR. .PP @@ -177,16 +103,16 @@ Detailed documentation and use cases for most standard subcommands are available (e.g., \fBopenssl\-x509\fR\|(1)). The subcommand \fBopenssl\-list\fR\|(1) may be used to list subcommands. .PP -The command \fBno\-\fR\fI\s-1XXX\s0\fR tests whether a command of the -specified name is available. If no command named \fI\s-1XXX\s0\fR exists, it -returns 0 (success) and prints \fBno\-\fR\fI\s-1XXX\s0\fR; otherwise it returns 1 -and prints \fI\s-1XXX\s0\fR. In both cases, the output goes to \fBstdout\fR and +The command \fBno\-\fR\fIXXX\fR tests whether a command of the +specified name is available. If no command named \fIXXX\fR exists, it +returns 0 (success) and prints \fBno\-\fR\fIXXX\fR; otherwise it returns 1 +and prints \fIXXX\fR. In both cases, the output goes to \fBstdout\fR and nothing is printed to \fBstderr\fR. 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 \fBopenssl\fR program. (\fBno\-\fR\fI\s-1XXX\s0\fR is +availability of ciphers in the \fBopenssl\fR program. (\fBno\-\fR\fIXXX\fR is not able to detect pseudo-commands such as \fBquit\fR, -\&\fBlist\fR, or \fBno\-\fR\fI\s-1XXX\s0\fR itself.) +\&\fBlist\fR, or \fBno\-\fR\fIXXX\fR itself.) .SS "Configuration Option" .IX Subsection "Configuration Option" Many commands use an external configuration file for some or all of their @@ -194,7 +120,7 @@ arguments and have a \fB\-config\fR option to specify that file. The default name of the file is \fIopenssl.cnf\fR in the default certificate storage area, which can be determined from the \fBopenssl\-version\fR\|(1) command using the \fB\-d\fR or \fB\-a\fR option. -The environment variable \fB\s-1OPENSSL_CONF\s0\fR can be used to specify a different +The environment variable \fBOPENSSL_CONF\fR can be used to specify a different file location or to disable loading a configuration (using the empty string). .PP Among others, the configuration file can be used to load modules @@ -202,235 +128,247 @@ and to specify parameters for generating certificates and random numbers. See \fBconfig\fR\|(5) for details. .SS "Standard Commands" .IX Subsection "Standard Commands" -.IP "\fBasn1parse\fR" 4 +.IP \fBasn1parse\fR 4 .IX Item "asn1parse" -Parse an \s-1ASN.1\s0 sequence. -.IP "\fBca\fR" 4 +Parse an ASN.1 sequence. +.IP \fBca\fR 4 .IX Item "ca" -Certificate Authority (\s-1CA\s0) Management. -.IP "\fBciphers\fR" 4 +Certificate Authority (CA) Management. +.IP \fBciphers\fR 4 .IX Item "ciphers" Cipher Suite Description Determination. -.IP "\fBcms\fR" 4 +.IP \fBcms\fR 4 .IX Item "cms" -\&\s-1CMS\s0 (Cryptographic Message Syntax) command. -.IP "\fBcrl\fR" 4 +CMS (Cryptographic Message Syntax) command. +.IP \fBcrl\fR 4 .IX Item "crl" -Certificate Revocation List (\s-1CRL\s0) Management. -.IP "\fBcrl2pkcs7\fR" 4 +Certificate Revocation List (CRL) Management. +.IP \fBcrl2pkcs7\fR 4 .IX Item "crl2pkcs7" -\&\s-1CRL\s0 to PKCS#7 Conversion. -.IP "\fBdgst\fR" 4 +CRL to PKCS#7 Conversion. +.IP \fBdgst\fR 4 .IX Item "dgst" -Message Digest calculation. \s-1MAC\s0 calculations are superseded by +Message Digest calculation. MAC calculations are superseded by \&\fBopenssl\-mac\fR\|(1). -.IP "\fBdhparam\fR" 4 +.IP \fBdhparam\fR 4 .IX Item "dhparam" Generation and Management of Diffie-Hellman Parameters. Superseded by \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1). -.IP "\fBdsa\fR" 4 +.IP \fBdsa\fR 4 .IX Item "dsa" -\&\s-1DSA\s0 Data Management. -.IP "\fBdsaparam\fR" 4 +DSA Data Management. +.IP \fBdsaparam\fR 4 .IX Item "dsaparam" -\&\s-1DSA\s0 Parameter Generation and Management. Superseded by +DSA Parameter Generation and Management. Superseded by \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1). -.IP "\fBec\fR" 4 +.IP \fBec\fR 4 .IX Item "ec" -\&\s-1EC\s0 (Elliptic curve) key processing. -.IP "\fBecparam\fR" 4 +EC (Elliptic curve) key processing. +.IP \fBecparam\fR 4 .IX Item "ecparam" -\&\s-1EC\s0 parameter manipulation and generation. -.IP "\fBenc\fR" 4 +EC parameter manipulation and generation. +.IP \fBenc\fR 4 .IX Item "enc" Encryption, decryption, and encoding. -.IP "\fBengine\fR" 4 +.IP \fBengine\fR 4 .IX Item "engine" Engine (loadable module) information and manipulation. -.IP "\fBerrstr\fR" 4 +.IP \fBerrstr\fR 4 .IX Item "errstr" Error Number to Error String Conversion. -.IP "\fBfipsinstall\fR" 4 +.IP \fBfipsinstall\fR 4 .IX Item "fipsinstall" -\&\s-1FIPS\s0 configuration installation. -.IP "\fBgendsa\fR" 4 +FIPS configuration installation. +.IP \fBgendsa\fR 4 .IX Item "gendsa" -Generation of \s-1DSA\s0 Private Key from Parameters. Superseded by +Generation of DSA Private Key from Parameters. Superseded by \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkey\fR\|(1). -.IP "\fBgenpkey\fR" 4 +.IP \fBgenpkey\fR 4 .IX Item "genpkey" Generation of Private Key or Parameters. -.IP "\fBgenrsa\fR" 4 +.IP \fBgenrsa\fR 4 .IX Item "genrsa" -Generation of \s-1RSA\s0 Private Key. Superseded by \fBopenssl\-genpkey\fR\|(1). -.IP "\fBhelp\fR" 4 +Generation of RSA Private Key. Superseded by \fBopenssl\-genpkey\fR\|(1). +.IP \fBhelp\fR 4 .IX Item "help" Display information about a command's options. -.IP "\fBinfo\fR" 4 +.IP \fBinfo\fR 4 .IX Item "info" Display diverse information built into the OpenSSL libraries. -.IP "\fBkdf\fR" 4 +.IP \fBkdf\fR 4 .IX Item "kdf" Key Derivation Functions. -.IP "\fBlist\fR" 4 +.IP \fBlist\fR 4 .IX Item "list" List algorithms and features. -.IP "\fBmac\fR" 4 +.IP \fBmac\fR 4 .IX Item "mac" Message Authentication Code Calculation. -.IP "\fBnseq\fR" 4 +.IP \fBnseq\fR 4 .IX Item "nseq" Create or examine a Netscape certificate sequence. -.IP "\fBocsp\fR" 4 +.IP \fBocsp\fR 4 .IX Item "ocsp" Online Certificate Status Protocol command. -.IP "\fBpasswd\fR" 4 +.IP \fBpasswd\fR 4 .IX Item "passwd" Generation of hashed passwords. -.IP "\fBpkcs12\fR" 4 +.IP \fBpkcs12\fR 4 .IX Item "pkcs12" PKCS#12 Data Management. -.IP "\fBpkcs7\fR" 4 +.IP \fBpkcs7\fR 4 .IX Item "pkcs7" PKCS#7 Data Management. -.IP "\fBpkcs8\fR" 4 +.IP \fBpkcs8\fR 4 .IX Item "pkcs8" PKCS#8 format private key conversion command. -.IP "\fBpkey\fR" 4 +.IP \fBpkey\fR 4 .IX Item "pkey" Public and private key management. -.IP "\fBpkeyparam\fR" 4 +.IP \fBpkeyparam\fR 4 .IX Item "pkeyparam" Public key algorithm parameter management. -.IP "\fBpkeyutl\fR" 4 +.IP \fBpkeyutl\fR 4 .IX Item "pkeyutl" Public key algorithm cryptographic operation command. -.IP "\fBprime\fR" 4 +.IP \fBprime\fR 4 .IX Item "prime" Compute prime numbers. -.IP "\fBrand\fR" 4 +.IP \fBrand\fR 4 .IX Item "rand" Generate pseudo-random bytes. -.IP "\fBrehash\fR" 4 +.IP \fBrehash\fR 4 .IX Item "rehash" -Create symbolic links to certificate and \s-1CRL\s0 files named by the hash values. -.IP "\fBreq\fR" 4 +Create symbolic links to certificate and CRL files named by the hash values. +.IP \fBreq\fR 4 .IX Item "req" -PKCS#10 X.509 Certificate Signing Request (\s-1CSR\s0) Management. -.IP "\fBrsa\fR" 4 +PKCS#10 X.509 Certificate Signing Request (CSR) Management. +.IP \fBrsa\fR 4 .IX Item "rsa" -\&\s-1RSA\s0 key management. -.IP "\fBrsautl\fR" 4 +RSA key management. +.IP \fBrsautl\fR 4 .IX Item "rsautl" -\&\s-1RSA\s0 command for signing, verification, encryption, and decryption. Superseded +RSA command for signing, verification, encryption, and decryption. Superseded by \fBopenssl\-pkeyutl\fR\|(1). -.IP "\fBs_client\fR" 4 +.IP \fBs_client\fR 4 .IX 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 +This implements a generic SSL/TLS client which can establish a transparent +connection to a remote server speaking SSL/TLS. It's intended for testing purposes only and provides only rudimentary interface functionality but internally uses mostly all functionality of the OpenSSL \fBssl\fR library. -.IP "\fBs_server\fR" 4 +.IP \fBs_server\fR 4 .IX 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 +This implements a generic SSL/TLS server which accepts connections from remote +clients speaking SSL/TLS. It's intended for testing purposes only and provides only rudimentary interface functionality but internally uses mostly all functionality of the OpenSSL \fBssl\fR library. It provides both an own command -line oriented protocol for testing \s-1SSL\s0 functions and a simple \s-1HTTP\s0 response +line oriented protocol for testing SSL functions and a simple HTTP response facility to emulate an SSL/TLS\-aware webserver. -.IP "\fBs_time\fR" 4 +.IP \fBs_time\fR 4 .IX Item "s_time" -\&\s-1SSL\s0 Connection Timer. -.IP "\fBsess_id\fR" 4 +SSL Connection Timer. +.IP \fBsess_id\fR 4 .IX Item "sess_id" -\&\s-1SSL\s0 Session Data Management. -.IP "\fBsmime\fR" 4 +SSL Session Data Management. +.IP \fBsmime\fR 4 .IX Item "smime" S/MIME mail processing. -.IP "\fBspeed\fR" 4 +.IP \fBspeed\fR 4 .IX Item "speed" Algorithm Speed Measurement. -.IP "\fBspkac\fR" 4 +.IP \fBspkac\fR 4 .IX Item "spkac" -\&\s-1SPKAC\s0 printing and generating command. -.IP "\fBsrp\fR" 4 +SPKAC printing and generating command. +.IP \fBsrp\fR 4 .IX Item "srp" -Maintain \s-1SRP\s0 password file. This command is deprecated. -.IP "\fBstoreutl\fR" 4 +Maintain SRP password file. This command is deprecated. +.IP \fBstoreutl\fR 4 .IX Item "storeutl" Command to list and display certificates, keys, CRLs, etc. -.IP "\fBts\fR" 4 +.IP \fBts\fR 4 .IX Item "ts" Time Stamping Authority command. -.IP "\fBverify\fR" 4 +.IP \fBverify\fR 4 .IX Item "verify" X.509 Certificate Verification. See also the \fBopenssl\-verification\-options\fR\|(1) manual page. -.IP "\fBversion\fR" 4 +.IP \fBversion\fR 4 .IX Item "version" OpenSSL Version Information. -.IP "\fBx509\fR" 4 +.IP \fBx509\fR 4 .IX Item "x509" X.509 Certificate Data Management. .SS "Message Digest Commands" .IX Subsection "Message Digest Commands" -.IP "\fBblake2b512\fR" 4 +.IP \fBblake2b512\fR 4 .IX Item "blake2b512" BLAKE2b\-512 Digest -.IP "\fBblake2s256\fR" 4 +.IP \fBblake2s256\fR 4 .IX Item "blake2s256" BLAKE2s\-256 Digest -.IP "\fBmd2\fR" 4 +.IP \fBmd2\fR 4 .IX Item "md2" -\&\s-1MD2\s0 Digest -.IP "\fBmd4\fR" 4 +MD2 Digest +.IP \fBmd4\fR 4 .IX Item "md4" -\&\s-1MD4\s0 Digest -.IP "\fBmd5\fR" 4 +MD4 Digest +.IP \fBmd5\fR 4 .IX Item "md5" -\&\s-1MD5\s0 Digest -.IP "\fBmdc2\fR" 4 +MD5 Digest +.IP \fBmdc2\fR 4 .IX Item "mdc2" -\&\s-1MDC2\s0 Digest -.IP "\fBrmd160\fR" 4 +MDC2 Digest +.IP \fBrmd160\fR 4 .IX Item "rmd160" -\&\s-1RMD\-160\s0 Digest -.IP "\fBsha1\fR" 4 +RMD\-160 Digest +.IP \fBsha1\fR 4 .IX Item "sha1" -\&\s-1SHA\-1\s0 Digest -.IP "\fBsha224\fR" 4 +SHA\-1 Digest +.IP \fBsha224\fR 4 .IX Item "sha224" -\&\s-1SHA\-2 224\s0 Digest -.IP "\fBsha256\fR" 4 +SHA\-2 224 Digest +.IP \fBsha256\fR 4 .IX Item "sha256" -\&\s-1SHA\-2 256\s0 Digest -.IP "\fBsha384\fR" 4 +SHA\-2 256 Digest +.IP \fBsha384\fR 4 .IX Item "sha384" -\&\s-1SHA\-2 384\s0 Digest -.IP "\fBsha512\fR" 4 +SHA\-2 384 Digest +.IP \fBsha512\fR 4 .IX Item "sha512" -\&\s-1SHA\-2 512\s0 Digest -.IP "\fBsha3\-224\fR" 4 +SHA\-2 512 Digest +.IP \fBsha3\-224\fR 4 .IX Item "sha3-224" -\&\s-1SHA\-3 224\s0 Digest -.IP "\fBsha3\-256\fR" 4 +SHA\-3 224 Digest +.IP \fBsha3\-256\fR 4 .IX Item "sha3-256" -\&\s-1SHA\-3 256\s0 Digest -.IP "\fBsha3\-384\fR" 4 +SHA\-3 256 Digest +.IP \fBsha3\-384\fR 4 .IX Item "sha3-384" -\&\s-1SHA\-3 384\s0 Digest -.IP "\fBsha3\-512\fR" 4 +SHA\-3 384 Digest +.IP \fBsha3\-512\fR 4 .IX Item "sha3-512" -\&\s-1SHA\-3 512\s0 Digest -.IP "\fBshake128\fR" 4 +SHA\-3 512 Digest +.IP \fBkeccak\-224\fR 4 +.IX Item "keccak-224" +KECCAK 224 Digest +.IP \fBkeccak\-256\fR 4 +.IX Item "keccak-256" +KECCAK 256 Digest +.IP \fBkeccak\-384\fR 4 +.IX Item "keccak-384" +KECCAK 384 Digest +.IP \fBkeccak\-512\fR 4 +.IX Item "keccak-512" +KECCAK 512 Digest +.IP \fBshake128\fR 4 .IX Item "shake128" -\&\s-1SHA\-3 SHAKE128\s0 Digest -.IP "\fBshake256\fR" 4 +SHA\-3 SHAKE128 Digest +.IP \fBshake256\fR 4 .IX Item "shake256" -\&\s-1SHA\-3 SHAKE256\s0 Digest -.IP "\fBsm3\fR" 4 +SHA\-3 SHAKE256 Digest +.IP \fBsm3\fR 4 .IX Item "sm3" -\&\s-1SM3\s0 Digest +SM3 Digest .SS "Encryption, Decryption, and Encoding Commands" .IX Subsection "Encryption, Decryption, and Encoding Commands" The following aliases provide convenient access to the most used encodings @@ -440,13 +378,13 @@ Depending on how OpenSSL was configured and built, not all ciphers listed here may be present. See \fBopenssl\-enc\fR\|(1) for more information. .IP "\fBaes128\fR, \fBaes\-128\-cbc\fR, \fBaes\-128\-cfb\fR, \fBaes\-128\-ctr\fR, \fBaes\-128\-ecb\fR, \fBaes\-128\-ofb\fR" 4 .IX Item "aes128, aes-128-cbc, aes-128-cfb, aes-128-ctr, aes-128-ecb, aes-128-ofb" -\&\s-1AES\-128\s0 Cipher +AES\-128 Cipher .IP "\fBaes192\fR, \fBaes\-192\-cbc\fR, \fBaes\-192\-cfb\fR, \fBaes\-192\-ctr\fR, \fBaes\-192\-ecb\fR, \fBaes\-192\-ofb\fR" 4 .IX Item "aes192, aes-192-cbc, aes-192-cfb, aes-192-ctr, aes-192-ecb, aes-192-ofb" -\&\s-1AES\-192\s0 Cipher +AES\-192 Cipher .IP "\fBaes256\fR, \fBaes\-256\-cbc\fR, \fBaes\-256\-cfb\fR, \fBaes\-256\-ctr\fR, \fBaes\-256\-ecb\fR, \fBaes\-256\-ofb\fR" 4 .IX Item "aes256, aes-256-cbc, aes-256-cfb, aes-256-ctr, aes-256-ecb, aes-256-ofb" -\&\s-1AES\-256\s0 Cipher +AES\-256 Cipher .IP "\fBaria128\fR, \fBaria\-128\-cbc\fR, \fBaria\-128\-cfb\fR, \fBaria\-128\-ctr\fR, \fBaria\-128\-ecb\fR, \fBaria\-128\-ofb\fR" 4 .IX Item "aria128, aria-128-cbc, aria-128-cfb, aria-128-ctr, aria-128-ecb, aria-128-ofb" Aria\-128 Cipher @@ -456,7 +394,7 @@ Aria\-192 Cipher .IP "\fBaria256\fR, \fBaria\-256\-cbc\fR, \fBaria\-256\-cfb\fR, \fBaria\-256\-ctr\fR, \fBaria\-256\-ecb\fR, \fBaria\-256\-ofb\fR" 4 .IX Item "aria256, aria-256-cbc, aria-256-cfb, aria-256-ctr, aria-256-ecb, aria-256-ofb" Aria\-256 Cipher -.IP "\fBbase64\fR" 4 +.IP \fBbase64\fR 4 .IX Item "base64" Base64 Encoding .IP "\fBbf\fR, \fBbf-cbc\fR, \fBbf-cfb\fR, \fBbf-ecb\fR, \fBbf-ofb\fR" 4 @@ -473,48 +411,61 @@ Camellia\-192 Cipher Camellia\-256 Cipher .IP "\fBcast\fR, \fBcast-cbc\fR" 4 .IX Item "cast, cast-cbc" -\&\s-1CAST\s0 Cipher +CAST Cipher .IP "\fBcast5\-cbc\fR, \fBcast5\-cfb\fR, \fBcast5\-ecb\fR, \fBcast5\-ofb\fR" 4 .IX Item "cast5-cbc, cast5-cfb, cast5-ecb, cast5-ofb" -\&\s-1CAST5\s0 Cipher -.IP "\fBchacha20\fR" 4 +CAST5 Cipher +.IP \fBchacha20\fR 4 .IX Item "chacha20" Chacha20 Cipher .IP "\fBdes\fR, \fBdes-cbc\fR, \fBdes-cfb\fR, \fBdes-ecb\fR, \fBdes-ede\fR, \fBdes-ede-cbc\fR, \fBdes-ede-cfb\fR, \fBdes-ede-ofb\fR, \fBdes-ofb\fR" 4 .IX 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 +DES Cipher .IP "\fBdes3\fR, \fBdesx\fR, \fBdes\-ede3\fR, \fBdes\-ede3\-cbc\fR, \fBdes\-ede3\-cfb\fR, \fBdes\-ede3\-ofb\fR" 4 .IX Item "des3, desx, des-ede3, des-ede3-cbc, des-ede3-cfb, des-ede3-ofb" Triple-DES Cipher .IP "\fBidea\fR, \fBidea-cbc\fR, \fBidea-cfb\fR, \fBidea-ecb\fR, \fBidea-ofb\fR" 4 .IX Item "idea, idea-cbc, idea-cfb, idea-ecb, idea-ofb" -\&\s-1IDEA\s0 Cipher +IDEA Cipher .IP "\fBrc2\fR, \fBrc2\-cbc\fR, \fBrc2\-cfb\fR, \fBrc2\-ecb\fR, \fBrc2\-ofb\fR" 4 .IX Item "rc2, rc2-cbc, rc2-cfb, rc2-ecb, rc2-ofb" -\&\s-1RC2\s0 Cipher -.IP "\fBrc4\fR" 4 +RC2 Cipher +.IP \fBrc4\fR 4 .IX Item "rc4" -\&\s-1RC4\s0 Cipher +RC4 Cipher .IP "\fBrc5\fR, \fBrc5\-cbc\fR, \fBrc5\-cfb\fR, \fBrc5\-ecb\fR, \fBrc5\-ofb\fR" 4 .IX Item "rc5, rc5-cbc, rc5-cfb, rc5-ecb, rc5-ofb" -\&\s-1RC5\s0 Cipher +RC5 Cipher .IP "\fBseed\fR, \fBseed-cbc\fR, \fBseed-cfb\fR, \fBseed-ecb\fR, \fBseed-ofb\fR" 4 .IX Item "seed, seed-cbc, seed-cfb, seed-ecb, seed-ofb" -\&\s-1SEED\s0 Cipher +SEED Cipher .IP "\fBsm4\fR, \fBsm4\-cbc\fR, \fBsm4\-cfb\fR, \fBsm4\-ctr\fR, \fBsm4\-ecb\fR, \fBsm4\-ofb\fR" 4 .IX Item "sm4, sm4-cbc, sm4-cfb, sm4-ctr, sm4-ecb, sm4-ofb" -\&\s-1SM4\s0 Cipher -.SH "OPTIONS" +SM4 Cipher +.SH OPTIONS .IX Header "OPTIONS" Details of which options are available depend on the specific command. This section describes some common options with common behavior. +.SS "Program Options" +.IX Subsection "Program Options" +These options can be specified without a command specified to get help +or version information. +.IP \fB\-help\fR 4 +.IX Item "-help" +Provides a terse summary of all options. +For more detailed information, each command supports a \fB\-help\fR option. +Accepts \fB\-\-help\fR as well. +.IP \fB\-version\fR 4 +.IX Item "-version" +Provides a terse summary of the \fBopenssl\fR program version. +For more detailed information see \fBopenssl\-version\fR\|(1). +Accepts \fB\-\-version\fR as well. .SS "Common Options" .IX Subsection "Common Options" -.IP "\fB\-help\fR" 4 +.IP \fB\-help\fR 4 .IX Item "-help" -Provides a terse summary of all options. -If an option takes an argument, the \*(L"type\*(R" of argument is also given. -.IP "\fB\-\-\fR" 4 +If an option takes an argument, the "type" of argument is also given. +.IP \fB\-\-\fR 4 .IX Item "--" This terminates the list of options. It is mostly useful if any filename parameters start with a minus sign: @@ -557,21 +508,21 @@ See the \fBopenssl\-verification\-options\fR\|(1) manual page. .SS "Name Format Options" .IX Subsection "Name Format Options" See the \fBopenssl\-namedisplay\-options\fR\|(1) manual page. -.SS "\s-1TLS\s0 Version Options" +.SS "TLS Version Options" .IX Subsection "TLS Version Options" -Several commands use \s-1SSL, TLS,\s0 or \s-1DTLS.\s0 By default, the commands use \s-1TLS\s0 and +Several commands use SSL, TLS, or DTLS. By default, the commands use TLS 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. .PP 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. +and whether TCP (SSL and TLS) or UDP (DTLS) is used. Note that not all protocols and flags may be available, depending on how OpenSSL was built. .IP "\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR, \fB\-no_ssl3\fR, \fB\-no_tls1\fR, \fB\-no_tls1_1\fR, \fB\-no_tls1_2\fR, \fB\-no_tls1_3\fR" 4 .IX 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 +These options require or disable the use of the specified SSL or TLS protocols. +When a specific TLS 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 \fBno_\fR options. @@ -579,9 +530,9 @@ The \fBno_*\fR options do not work with \fBs_time\fR and \fBciphers\fR commands \&\fBs_client\fR and \fBs_server\fR commands. .IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4 .IX Item "-dtls, -dtls1, -dtls1_2" -These options specify to use \s-1DTLS\s0 instead of \s-1TLS.\s0 -With \fB\-dtls\fR, clients will negotiate any supported \s-1DTLS\s0 protocol version. -Use the \fB\-dtls1\fR or \fB\-dtls1_2\fR options to support only \s-1DTLS1.0\s0 or \s-1DTLS1.2,\s0 +These options specify to use DTLS instead of TLS. +With \fB\-dtls\fR, clients will negotiate any supported DTLS protocol version. +Use the \fB\-dtls1\fR or \fB\-dtls1_2\fR options to support only DTLS1.0 or DTLS1.2, respectively. .SS "Engine Options" .IX Subsection "Engine Options" @@ -590,7 +541,7 @@ respectively. Load the engine identified by \fIid\fR 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 \fBconfig\fR\|(5). +"Engine Configuration" in \fBconfig\fR\|(5). .Sp The engine will be used for key ids specified with \fB\-key\fR and similar options when an option like \fB\-keyform engine\fR is given. @@ -602,8 +553,8 @@ When this engine is used, files with such credentials are read via this engine. Using the \f(CW\*(C`file:\*(C'\fR schema is optional; a plain file (path) name will do. .PP Options specifying keys, like \fB\-key\fR and similar, can use the generic -OpenSSL engine key loading \s-1URI\s0 scheme \f(CW\*(C`org.openssl.engine:\*(C'\fR to retrieve -private keys and public keys. The \s-1URI\s0 syntax is as follows, in simplified +OpenSSL engine key loading URI scheme \f(CW\*(C`org.openssl.engine:\*(C'\fR to retrieve +private keys and public keys. The URI syntax is as follows, in simplified form: .PP .Vb 1 @@ -612,7 +563,7 @@ form: .PP Where \f(CW\*(C`{engineid}\*(C'\fR is the identity/name of the engine, and \f(CW\*(C`{keyid}\*(C'\fR 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 +engine that interfaces against a PKCS#11 implementation, the generic key URI would be something like this (this happens to be an example for the PKCS#11 engine that's part of OpenSC): .PP @@ -621,9 +572,9 @@ engine that's part of OpenSC): .Ve .PP As a third possibility, for engines and providers that have implemented -their own \s-1\fBOSSL_STORE_LOADER\s0\fR\|(3), \f(CW\*(C`org.openssl.engine:\*(C'\fR should not be +their own \fBOSSL_STORE_LOADER\fR\|(3), \f(CW\*(C`org.openssl.engine:\*(C'\fR 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: +the PKCS#11 URI as defined in RFC 7512 should be possible to use directly: .PP .Vb 1 \& \-key pkcs11:object=some\-private\-key;pin\-value=1234 @@ -636,101 +587,49 @@ Load and initialize the provider identified by \fIname\fR. The \fIname\fR 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, \fB\s-1OPENSSL_MODULES\s0\fR environment variable, or the path +"MODULESDIR" path, \fBOPENSSL_MODULES\fR environment variable, or the path specified by \fB\-provider\-path\fR is prepended to relative paths. See \fBprovider\fR\|(7) for a more detailed description. .IP "\fB\-provider\-path\fR \fIpath\fR" 4 .IX Item "-provider-path path" Specifies the search path that is to be used for looking for providers. -Equivalently, the \fB\s-1OPENSSL_MODULES\s0\fR environment variable may be set. +Equivalently, the \fBOPENSSL_MODULES\fR environment variable may be set. +.IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4 +.IX Item "-provparam [name:]key=value" +Set configuration parameter \fIkey\fR to value \fIval\fR in provider \fIname\fR +(optional), if \fIname\fR is not specified, the setting will be applied to all +loaded providers. +This option can be specified multiple times, to set multiple parameters. +Options that specify nondefault providers to load should precede this option +if the setting is intended to apply to the to be loaded providers. +Parameters that only affect provider initialisation must, for now, be set in +the configuration file, only parameters that are also queried as needed later +have any affect when set via this interface. +Only UTF8\-string\-valued parameters are supported. +See the documentation of the specific provider and associated algorithms for +any supported parameters. .IP "\fB\-propquery\fR \fIpropq\fR" 4 .IX Item "-propquery propq" Specifies the \fIproperty query clause\fR to be used when fetching algorithms from the loaded providers. See \fBproperty\fR\|(7) for a more detailed description. -.SH "ENVIRONMENT" +.SH ENVIRONMENT .IX 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 \fBopenssl\-engine\fR\|(1), -\&\fBopenssl\-rehash\fR\|(1), and \fBtsget\fR\|(1). +The OpenSSL libraries can take some configuration parameters from the +environment. +.PP +For information about all environment variables used by the OpenSSL libraries, +such as \fBOPENSSL_CONF\fR, \fBOPENSSL_MODULES\fR, and \fBOPENSSL_TRACE\fR, +see \fBopenssl\-env\fR\|(7). .PP For information about the use of environment variables in configuration, -see \*(L"\s-1ENVIRONMENT\*(R"\s0 in \fBconfig\fR\|(5). +see "ENVIRONMENT" in \fBconfig\fR\|(5). .PP -For information about querying or specifying \s-1CPU\s0 architecture flags, see -\&\fBOPENSSL_ia32cap\fR\|(3), and \fBOPENSSL_s390xcap\fR\|(3). +For information about specific commands, see \fBopenssl\-engine\fR\|(1), +\&\fBopenssl\-rehash\fR\|(1), and \fBtsget\fR\|(1). .PP -For information about all environment variables used by the OpenSSL libraries, -see \fBopenssl\-env\fR\|(7). -.IP "\fBOPENSSL_TRACE=\fR\fIname\fR[,...]" 4 -.IX 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: -.RS 4 -.IP "\fB\s-1TRACE\s0\fR" 4 -.IX Item "TRACE" -Traces the OpenSSL trace \s-1API\s0 itself. -.IP "\fB\s-1INIT\s0\fR" 4 -.IX Item "INIT" -Traces OpenSSL library initialization and cleanup. -.IP "\fB\s-1TLS\s0\fR" 4 -.IX Item "TLS" -Traces the \s-1TLS/SSL\s0 protocol. -.IP "\fB\s-1TLS_CIPHER\s0\fR" 4 -.IX Item "TLS_CIPHER" -Traces the ciphers used by the \s-1TLS/SSL\s0 protocol. -.IP "\fB\s-1CONF\s0\fR" 4 -.IX Item "CONF" -Show details about provider and engine configuration. -.IP "\fB\s-1ENGINE_TABLE\s0\fR" 4 -.IX Item "ENGINE_TABLE" -The function that is used by \s-1RSA, DSA\s0 (etc) code to select registered -ENGINEs, cache defaults and functional references (etc), will generate -debugging summaries. -.IP "\fB\s-1ENGINE_REF_COUNT\s0\fR" 4 -.IX Item "ENGINE_REF_COUNT" -Reference counts in the \s-1ENGINE\s0 structure will be monitored with a line -of generated for each change. -.IP "\fB\s-1PKCS5V2\s0\fR" 4 -.IX Item "PKCS5V2" -Traces PKCS#5 v2 key generation. -.IP "\fB\s-1PKCS12_KEYGEN\s0\fR" 4 -.IX Item "PKCS12_KEYGEN" -Traces PKCS#12 key generation. -.IP "\fB\s-1PKCS12_DECRYPT\s0\fR" 4 -.IX Item "PKCS12_DECRYPT" -Traces PKCS#12 decryption. -.IP "\fBX509V3_POLICY\fR" 4 -.IX Item "X509V3_POLICY" -Generates the complete policy tree at various points during X.509 v3 -policy evaluation. -.IP "\fB\s-1BN_CTX\s0\fR" 4 -.IX Item "BN_CTX" -Traces \s-1BIGNUM\s0 context operations. -.IP "\fB\s-1CMP\s0\fR" 4 -.IX Item "CMP" -Traces \s-1CMP\s0 client and server activity. -.IP "\fB\s-1STORE\s0\fR" 4 -.IX Item "STORE" -Traces \s-1STORE\s0 operations. -.IP "\fB\s-1DECODER\s0\fR" 4 -.IX Item "DECODER" -Traces decoder operations. -.IP "\fB\s-1ENCODER\s0\fR" 4 -.IX Item "ENCODER" -Traces encoder operations. -.IP "\fB\s-1REF_COUNT\s0\fR" 4 -.IX Item "REF_COUNT" -Traces decrementing certain \s-1ASN.1\s0 structure references. -.RE -.RS 4 -.RE +For information about querying or specifying CPU architecture flags, see +\&\fBOPENSSL_ia32cap\fR\|(3), \fBOPENSSL_s390xcap\fR\|(3) and \fBOPENSSL_riscvcap\fR\|(3). .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBopenssl\-asn1parse\fR\|(1), @@ -787,9 +686,9 @@ Traces decrementing certain \s-1ASN.1\s0 structure references. \&\fBopenssl\-env\fR\|(7). \&\fBssl\fR\|(7), \&\fBx509v3_config\fR\|(5) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" -The \fBlist\fR \-\fI\s-1XXX\s0\fR\fB\-algorithms\fR options were added in OpenSSL 1.0.0; +The \fBlist\fR \-\fIXXX\fR\fB\-algorithms\fR options were added in OpenSSL 1.0.0; For notes on the availability of other commands, see their individual manual pages. .PP @@ -802,11 +701,11 @@ are obsolete since OpenSSL 3.0 and have no effect. The interactive mode, which could be invoked by running \f(CW\*(C`openssl\*(C'\fR with no further arguments, was removed in OpenSSL 3.0, and running that program with no arguments is now equivalent to \f(CW\*(C`openssl help\*(C'\fR. -.SH "COPYRIGHT" +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |