Debian Codegraph @

upstream/debian-unstable/man1/openssl.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL 1SSL"
58 .TH OPENSSL 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl \- OpenSSL command line program
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl\fR
68 \&\fIcommand\fR
69 [ \fIoptions\fR ... ]
70 [ \fIparameters\fR ... ]
71 .PP
72 \&\fBopenssl\fR \fBno\-\fR\fIXXX\fR [ \fIoptions\fR ]
73 .PP
74 \&\fBopenssl\fR \fB\-help\fR | \fB\-version\fR
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL)
78 and Transport Layer Security (TLS) network protocols and related
79 cryptography standards required by them.
80 .PP
81 The \fBopenssl\fR program is a command line program for using the various
82 cryptography functions of OpenSSL's \fBcrypto\fR library from the shell.
83 It can be used for
84 .PP
85 .Vb 8
86 \& o Creation and management of private keys, public keys and parameters
87 \& o Public key cryptographic operations
88 \& o Creation of X.509 certificates, CSRs and CRLs
89 \& o Calculation of Message Digests and Message Authentication Codes
90 \& o Encryption and Decryption with Ciphers
91 \& o SSL/TLS Client and Server Tests
92 \& o Handling of S/MIME signed or encrypted mail
93 \& o Timestamp requests, generation and verification
94 .Ve
95 .SH "COMMAND SUMMARY"
96 .IX Header "COMMAND SUMMARY"
97 The \fBopenssl\fR program provides a rich variety of commands (\fIcommand\fR in
98 the "SYNOPSIS" above).
99 Each command can have many options and argument parameters, shown above as
100 \&\fIoptions\fR and \fIparameters\fR.
101 .PP
102 Detailed documentation and use cases for most standard subcommands are available
103 (e.g., \fBopenssl\-x509\fR\|(1)). The subcommand \fBopenssl\-list\fR\|(1) may be used to list
104 subcommands.
105 .PP
106 The command \fBno\-\fR\fIXXX\fR tests whether a command of the
107 specified name is available. If no command named \fIXXX\fR exists, it
108 returns 0 (success) and prints \fBno\-\fR\fIXXX\fR; otherwise it returns 1
109 and prints \fIXXX\fR. In both cases, the output goes to \fBstdout\fR and
110 nothing is printed to \fBstderr\fR. Additional command line arguments
111 are always ignored. Since for each cipher there is a command of the
112 same name, this provides an easy way for shell scripts to test for the
113 availability of ciphers in the \fBopenssl\fR program. (\fBno\-\fR\fIXXX\fR is
114 not able to detect pseudo-commands such as \fBquit\fR,
115 \&\fBlist\fR, or \fBno\-\fR\fIXXX\fR itself.)
116 .SS "Configuration Option"
117 .IX Subsection "Configuration Option"
118 Many commands use an external configuration file for some or all of their
119 arguments and have a \fB\-config\fR option to specify that file.
120 The default name of the file is \fIopenssl.cnf\fR in the default certificate
121 storage area, which can be determined from the \fBopenssl\-version\fR\|(1)
122 command using the \fB\-d\fR or \fB\-a\fR option.
123 The environment variable \fBOPENSSL_CONF\fR can be used to specify a different
124 file location or to disable loading a configuration (using the empty string).
125 .PP
126 Among others, the configuration file can be used to load modules
127 and to specify parameters for generating certificates and random numbers.
128 See \fBconfig\fR\|(5) for details.
129 .SS "Standard Commands"
130 .IX Subsection "Standard Commands"
131 .IP \fBasn1parse\fR 4
132 .IX Item "asn1parse"
133 Parse an ASN.1 sequence.
134 .IP \fBca\fR 4
135 .IX Item "ca"
136 Certificate Authority (CA) Management.
137 .IP \fBciphers\fR 4
138 .IX Item "ciphers"
139 Cipher Suite Description Determination.
140 .IP \fBcms\fR 4
141 .IX Item "cms"
142 CMS (Cryptographic Message Syntax) command.
143 .IP \fBcrl\fR 4
144 .IX Item "crl"
145 Certificate Revocation List (CRL) Management.
146 .IP \fBcrl2pkcs7\fR 4
147 .IX Item "crl2pkcs7"
148 CRL to PKCS#7 Conversion.
149 .IP \fBdgst\fR 4
150 .IX Item "dgst"
151 Message Digest calculation. MAC calculations are superseded by
152 \&\fBopenssl\-mac\fR\|(1).
153 .IP \fBdhparam\fR 4
154 .IX Item "dhparam"
155 Generation and Management of Diffie-Hellman Parameters. Superseded by
156 \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1).
157 .IP \fBdsa\fR 4
158 .IX Item "dsa"
159 DSA Data Management.
160 .IP \fBdsaparam\fR 4
161 .IX Item "dsaparam"
162 DSA Parameter Generation and Management. Superseded by
163 \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkeyparam\fR\|(1).
164 .IP \fBec\fR 4
165 .IX Item "ec"
166 EC (Elliptic curve) key processing.
167 .IP \fBecparam\fR 4
168 .IX Item "ecparam"
169 EC parameter manipulation and generation.
170 .IP \fBenc\fR 4
171 .IX Item "enc"
172 Encryption, decryption, and encoding.
173 .IP \fBengine\fR 4
174 .IX Item "engine"
175 Engine (loadable module) information and manipulation.
176 .IP \fBerrstr\fR 4
177 .IX Item "errstr"
178 Error Number to Error String Conversion.
179 .IP \fBfipsinstall\fR 4
180 .IX Item "fipsinstall"
181 FIPS configuration installation.
182 .IP \fBgendsa\fR 4
183 .IX Item "gendsa"
184 Generation of DSA Private Key from Parameters. Superseded by
185 \&\fBopenssl\-genpkey\fR\|(1) and \fBopenssl\-pkey\fR\|(1).
186 .IP \fBgenpkey\fR 4
187 .IX Item "genpkey"
188 Generation of Private Key or Parameters.
189 .IP \fBgenrsa\fR 4
190 .IX Item "genrsa"
191 Generation of RSA Private Key. Superseded by \fBopenssl\-genpkey\fR\|(1).
192 .IP \fBhelp\fR 4
193 .IX Item "help"
194 Display information about a command's options.
195 .IP \fBinfo\fR 4
196 .IX Item "info"
197 Display diverse information built into the OpenSSL libraries.
198 .IP \fBkdf\fR 4
199 .IX Item "kdf"
200 Key Derivation Functions.
201 .IP \fBlist\fR 4
202 .IX Item "list"
203 List algorithms and features.
204 .IP \fBmac\fR 4
205 .IX Item "mac"
206 Message Authentication Code Calculation.
207 .IP \fBnseq\fR 4
208 .IX Item "nseq"
209 Create or examine a Netscape certificate sequence.
210 .IP \fBocsp\fR 4
211 .IX Item "ocsp"
212 Online Certificate Status Protocol command.
213 .IP \fBpasswd\fR 4
214 .IX Item "passwd"
215 Generation of hashed passwords.
216 .IP \fBpkcs12\fR 4
217 .IX Item "pkcs12"
218 PKCS#12 Data Management.
219 .IP \fBpkcs7\fR 4
220 .IX Item "pkcs7"
221 PKCS#7 Data Management.
222 .IP \fBpkcs8\fR 4
223 .IX Item "pkcs8"
224 PKCS#8 format private key conversion command.
225 .IP \fBpkey\fR 4
226 .IX Item "pkey"
227 Public and private key management.
228 .IP \fBpkeyparam\fR 4
229 .IX Item "pkeyparam"
230 Public key algorithm parameter management.
231 .IP \fBpkeyutl\fR 4
232 .IX Item "pkeyutl"
233 Public key algorithm cryptographic operation command.
234 .IP \fBprime\fR 4
235 .IX Item "prime"
236 Compute prime numbers.
237 .IP \fBrand\fR 4
238 .IX Item "rand"
239 Generate pseudo-random bytes.
240 .IP \fBrehash\fR 4
241 .IX Item "rehash"
242 Create symbolic links to certificate and CRL files named by the hash values.
243 .IP \fBreq\fR 4
244 .IX Item "req"
245 PKCS#10 X.509 Certificate Signing Request (CSR) Management.
246 .IP \fBrsa\fR 4
247 .IX Item "rsa"
248 RSA key management.
249 .IP \fBrsautl\fR 4
250 .IX Item "rsautl"
251 RSA command for signing, verification, encryption, and decryption. Superseded
252 by \fBopenssl\-pkeyutl\fR\|(1).
253 .IP \fBs_client\fR 4
254 .IX Item "s_client"
255 This implements a generic SSL/TLS client which can establish a transparent
256 connection to a remote server speaking SSL/TLS. It's intended for testing
257 purposes only and provides only rudimentary interface functionality but
258 internally uses mostly all functionality of the OpenSSL \fBssl\fR library.
259 .IP \fBs_server\fR 4
260 .IX Item "s_server"
261 This implements a generic SSL/TLS server which accepts connections from remote
262 clients speaking SSL/TLS. It's intended for testing purposes only and provides
263 only rudimentary interface functionality but internally uses mostly all
264 functionality of the OpenSSL \fBssl\fR library. It provides both an own command
265 line oriented protocol for testing SSL functions and a simple HTTP response
266 facility to emulate an SSL/TLS\-aware webserver.
267 .IP \fBs_time\fR 4
268 .IX Item "s_time"
269 SSL Connection Timer.
270 .IP \fBsess_id\fR 4
271 .IX Item "sess_id"
272 SSL Session Data Management.
273 .IP \fBsmime\fR 4
274 .IX Item "smime"
275 S/MIME mail processing.
276 .IP \fBspeed\fR 4
277 .IX Item "speed"
278 Algorithm Speed Measurement.
279 .IP \fBspkac\fR 4
280 .IX Item "spkac"
281 SPKAC printing and generating command.
282 .IP \fBsrp\fR 4
283 .IX Item "srp"
284 Maintain SRP password file. This command is deprecated.
285 .IP \fBstoreutl\fR 4
286 .IX Item "storeutl"
287 Command to list and display certificates, keys, CRLs, etc.
288 .IP \fBts\fR 4
289 .IX Item "ts"
290 Time Stamping Authority command.
291 .IP \fBverify\fR 4
292 .IX Item "verify"
293 X.509 Certificate Verification.
294 See also the \fBopenssl\-verification\-options\fR\|(1) manual page.
295 .IP \fBversion\fR 4
296 .IX Item "version"
297 OpenSSL Version Information.
298 .IP \fBx509\fR 4
299 .IX Item "x509"
300 X.509 Certificate Data Management.
301 .SS "Message Digest Commands"
302 .IX Subsection "Message Digest Commands"
303 .IP \fBblake2b512\fR 4
304 .IX Item "blake2b512"
305 BLAKE2b\-512 Digest
306 .IP \fBblake2s256\fR 4
307 .IX Item "blake2s256"
308 BLAKE2s\-256 Digest
309 .IP \fBmd2\fR 4
310 .IX Item "md2"
311 MD2 Digest
312 .IP \fBmd4\fR 4
313 .IX Item "md4"
314 MD4 Digest
315 .IP \fBmd5\fR 4
316 .IX Item "md5"
317 MD5 Digest
318 .IP \fBmdc2\fR 4
319 .IX Item "mdc2"
320 MDC2 Digest
321 .IP \fBrmd160\fR 4
322 .IX Item "rmd160"
323 RMD\-160 Digest
324 .IP \fBsha1\fR 4
325 .IX Item "sha1"
326 SHA\-1 Digest
327 .IP \fBsha224\fR 4
328 .IX Item "sha224"
329 SHA\-2 224 Digest
330 .IP \fBsha256\fR 4
331 .IX Item "sha256"
332 SHA\-2 256 Digest
333 .IP \fBsha384\fR 4
334 .IX Item "sha384"
335 SHA\-2 384 Digest
336 .IP \fBsha512\fR 4
337 .IX Item "sha512"
338 SHA\-2 512 Digest
339 .IP \fBsha3\-224\fR 4
340 .IX Item "sha3-224"
341 SHA\-3 224 Digest
342 .IP \fBsha3\-256\fR 4
343 .IX Item "sha3-256"
344 SHA\-3 256 Digest
345 .IP \fBsha3\-384\fR 4
346 .IX Item "sha3-384"
347 SHA\-3 384 Digest
348 .IP \fBsha3\-512\fR 4
349 .IX Item "sha3-512"
350 SHA\-3 512 Digest
351 .IP \fBkeccak\-224\fR 4
352 .IX Item "keccak-224"
353 KECCAK 224 Digest
354 .IP \fBkeccak\-256\fR 4
355 .IX Item "keccak-256"
356 KECCAK 256 Digest
357 .IP \fBkeccak\-384\fR 4
358 .IX Item "keccak-384"
359 KECCAK 384 Digest
360 .IP \fBkeccak\-512\fR 4
361 .IX Item "keccak-512"
362 KECCAK 512 Digest
363 .IP \fBshake128\fR 4
364 .IX Item "shake128"
365 SHA\-3 SHAKE128 Digest
366 .IP \fBshake256\fR 4
367 .IX Item "shake256"
368 SHA\-3 SHAKE256 Digest
369 .IP \fBsm3\fR 4
370 .IX Item "sm3"
371 SM3 Digest
372 .SS "Encryption, Decryption, and Encoding Commands"
373 .IX Subsection "Encryption, Decryption, and Encoding Commands"
374 The following aliases provide convenient access to the most used encodings
375 and ciphers.
376 .PP
377 Depending on how OpenSSL was configured and built, not all ciphers listed
378 here may be present. See \fBopenssl\-enc\fR\|(1) for more information.
379 .IP "\fBaes128\fR, \fBaes\-128\-cbc\fR, \fBaes\-128\-cfb\fR, \fBaes\-128\-ctr\fR, \fBaes\-128\-ecb\fR, \fBaes\-128\-ofb\fR" 4
380 .IX Item "aes128, aes-128-cbc, aes-128-cfb, aes-128-ctr, aes-128-ecb, aes-128-ofb"
381 AES\-128 Cipher
382 .IP "\fBaes192\fR, \fBaes\-192\-cbc\fR, \fBaes\-192\-cfb\fR, \fBaes\-192\-ctr\fR, \fBaes\-192\-ecb\fR, \fBaes\-192\-ofb\fR" 4
383 .IX Item "aes192, aes-192-cbc, aes-192-cfb, aes-192-ctr, aes-192-ecb, aes-192-ofb"
384 AES\-192 Cipher
385 .IP "\fBaes256\fR, \fBaes\-256\-cbc\fR, \fBaes\-256\-cfb\fR, \fBaes\-256\-ctr\fR, \fBaes\-256\-ecb\fR, \fBaes\-256\-ofb\fR" 4
386 .IX Item "aes256, aes-256-cbc, aes-256-cfb, aes-256-ctr, aes-256-ecb, aes-256-ofb"
387 AES\-256 Cipher
388 .IP "\fBaria128\fR, \fBaria\-128\-cbc\fR, \fBaria\-128\-cfb\fR, \fBaria\-128\-ctr\fR, \fBaria\-128\-ecb\fR, \fBaria\-128\-ofb\fR" 4
389 .IX Item "aria128, aria-128-cbc, aria-128-cfb, aria-128-ctr, aria-128-ecb, aria-128-ofb"
390 Aria\-128 Cipher
391 .IP "\fBaria192\fR, \fBaria\-192\-cbc\fR, \fBaria\-192\-cfb\fR, \fBaria\-192\-ctr\fR, \fBaria\-192\-ecb\fR, \fBaria\-192\-ofb\fR" 4
392 .IX Item "aria192, aria-192-cbc, aria-192-cfb, aria-192-ctr, aria-192-ecb, aria-192-ofb"
393 Aria\-192 Cipher
394 .IP "\fBaria256\fR, \fBaria\-256\-cbc\fR, \fBaria\-256\-cfb\fR, \fBaria\-256\-ctr\fR, \fBaria\-256\-ecb\fR, \fBaria\-256\-ofb\fR" 4
395 .IX Item "aria256, aria-256-cbc, aria-256-cfb, aria-256-ctr, aria-256-ecb, aria-256-ofb"
396 Aria\-256 Cipher
397 .IP \fBbase64\fR 4
398 .IX Item "base64"
399 Base64 Encoding
400 .IP "\fBbf\fR, \fBbf-cbc\fR, \fBbf-cfb\fR, \fBbf-ecb\fR, \fBbf-ofb\fR" 4
401 .IX Item "bf, bf-cbc, bf-cfb, bf-ecb, bf-ofb"
402 Blowfish Cipher
403 .IP "\fBcamellia128\fR, \fBcamellia\-128\-cbc\fR, \fBcamellia\-128\-cfb\fR, \fBcamellia\-128\-ctr\fR, \fBcamellia\-128\-ecb\fR, \fBcamellia\-128\-ofb\fR" 4
404 .IX Item "camellia128, camellia-128-cbc, camellia-128-cfb, camellia-128-ctr, camellia-128-ecb, camellia-128-ofb"
405 Camellia\-128 Cipher
406 .IP "\fBcamellia192\fR, \fBcamellia\-192\-cbc\fR, \fBcamellia\-192\-cfb\fR, \fBcamellia\-192\-ctr\fR, \fBcamellia\-192\-ecb\fR, \fBcamellia\-192\-ofb\fR" 4
407 .IX Item "camellia192, camellia-192-cbc, camellia-192-cfb, camellia-192-ctr, camellia-192-ecb, camellia-192-ofb"
408 Camellia\-192 Cipher
409 .IP "\fBcamellia256\fR, \fBcamellia\-256\-cbc\fR, \fBcamellia\-256\-cfb\fR, \fBcamellia\-256\-ctr\fR, \fBcamellia\-256\-ecb\fR, \fBcamellia\-256\-ofb\fR" 4
410 .IX Item "camellia256, camellia-256-cbc, camellia-256-cfb, camellia-256-ctr, camellia-256-ecb, camellia-256-ofb"
411 Camellia\-256 Cipher
412 .IP "\fBcast\fR, \fBcast-cbc\fR" 4
413 .IX Item "cast, cast-cbc"
414 CAST Cipher
415 .IP "\fBcast5\-cbc\fR, \fBcast5\-cfb\fR, \fBcast5\-ecb\fR, \fBcast5\-ofb\fR" 4
416 .IX Item "cast5-cbc, cast5-cfb, cast5-ecb, cast5-ofb"
417 CAST5 Cipher
418 .IP \fBchacha20\fR 4
419 .IX Item "chacha20"
420 Chacha20 Cipher
421 .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
422 .IX Item "des, des-cbc, des-cfb, des-ecb, des-ede, des-ede-cbc, des-ede-cfb, des-ede-ofb, des-ofb"
423 DES Cipher
424 .IP "\fBdes3\fR, \fBdesx\fR, \fBdes\-ede3\fR, \fBdes\-ede3\-cbc\fR, \fBdes\-ede3\-cfb\fR, \fBdes\-ede3\-ofb\fR" 4
425 .IX Item "des3, desx, des-ede3, des-ede3-cbc, des-ede3-cfb, des-ede3-ofb"
426 Triple-DES Cipher
427 .IP "\fBidea\fR, \fBidea-cbc\fR, \fBidea-cfb\fR, \fBidea-ecb\fR, \fBidea-ofb\fR" 4
428 .IX Item "idea, idea-cbc, idea-cfb, idea-ecb, idea-ofb"
429 IDEA Cipher
430 .IP "\fBrc2\fR, \fBrc2\-cbc\fR, \fBrc2\-cfb\fR, \fBrc2\-ecb\fR, \fBrc2\-ofb\fR" 4
431 .IX Item "rc2, rc2-cbc, rc2-cfb, rc2-ecb, rc2-ofb"
432 RC2 Cipher
433 .IP \fBrc4\fR 4
434 .IX Item "rc4"
435 RC4 Cipher
436 .IP "\fBrc5\fR, \fBrc5\-cbc\fR, \fBrc5\-cfb\fR, \fBrc5\-ecb\fR, \fBrc5\-ofb\fR" 4
437 .IX Item "rc5, rc5-cbc, rc5-cfb, rc5-ecb, rc5-ofb"
438 RC5 Cipher
439 .IP "\fBseed\fR, \fBseed-cbc\fR, \fBseed-cfb\fR, \fBseed-ecb\fR, \fBseed-ofb\fR" 4
440 .IX Item "seed, seed-cbc, seed-cfb, seed-ecb, seed-ofb"
441 SEED Cipher
442 .IP "\fBsm4\fR, \fBsm4\-cbc\fR, \fBsm4\-cfb\fR, \fBsm4\-ctr\fR, \fBsm4\-ecb\fR, \fBsm4\-ofb\fR" 4
443 .IX Item "sm4, sm4-cbc, sm4-cfb, sm4-ctr, sm4-ecb, sm4-ofb"
444 SM4 Cipher
445 .SH OPTIONS
446 .IX Header "OPTIONS"
447 Details of which options are available depend on the specific command.
448 This section describes some common options with common behavior.
449 .SS "Program Options"
450 .IX Subsection "Program Options"
451 These options can be specified without a command specified to get help
452 or version information.
453 .IP \fB\-help\fR 4
454 .IX Item "-help"
455 Provides a terse summary of all options.
456 For more detailed information, each command supports a \fB\-help\fR option.
457 Accepts \fB\-\-help\fR as well.
458 .IP \fB\-version\fR 4
459 .IX Item "-version"
460 Provides a terse summary of the \fBopenssl\fR program version.
461 For more detailed information see \fBopenssl\-version\fR\|(1).
462 Accepts \fB\-\-version\fR as well.
463 .SS "Common Options"
464 .IX Subsection "Common Options"
465 .IP \fB\-help\fR 4
466 .IX Item "-help"
467 If an option takes an argument, the "type" of argument is also given.
468 .IP \fB\-\-\fR 4
469 .IX Item "--"
470 This terminates the list of options. It is mostly useful if any filename
471 parameters start with a minus sign:
472 .Sp
473 .Vb 1
474 \& openssl verify [flags...] \-\- \-cert1.pem...
475 .Ve
476 .SS "Format Options"
477 .IX Subsection "Format Options"
478 See \fBopenssl\-format\-options\fR\|(1) for manual page.
479 .SS "Pass Phrase Options"
480 .IX Subsection "Pass Phrase Options"
481 See the \fBopenssl\-passphrase\-options\fR\|(1) manual page.
482 .SS "Random State Options"
483 .IX Subsection "Random State Options"
484 Prior to OpenSSL 1.1.1, it was common for applications to store information
485 about the state of the random-number generator in a file that was loaded
486 at startup and rewritten upon exit. On modern operating systems, this is
487 generally no longer necessary as OpenSSL will seed itself from a trusted
488 entropy source provided by the operating system. These flags are still
489 supported for special platforms or circumstances that might require them.
490 .PP
491 It is generally an error to use the same seed file more than once and
492 every use of \fB\-rand\fR should be paired with \fB\-writerand\fR.
493 .IP "\fB\-rand\fR \fIfiles\fR" 4
494 .IX Item "-rand files"
495 A file or files containing random data used to seed the random number
496 generator.
497 Multiple files can be specified separated by an OS-dependent character.
498 The separator is \f(CW\*(C`;\*(C'\fR for MS-Windows, \f(CW\*(C`,\*(C'\fR for OpenVMS, and \f(CW\*(C`:\*(C'\fR for
499 all others. Another way to specify multiple files is to repeat this flag
500 with different filenames.
501 .IP "\fB\-writerand\fR \fIfile\fR" 4
502 .IX Item "-writerand file"
503 Writes the seed data to the specified \fIfile\fR upon exit.
504 This file can be used in a subsequent command invocation.
505 .SS "Certificate Verification Options"
506 .IX Subsection "Certificate Verification Options"
507 See the \fBopenssl\-verification\-options\fR\|(1) manual page.
508 .SS "Name Format Options"
509 .IX Subsection "Name Format Options"
510 See the \fBopenssl\-namedisplay\-options\fR\|(1) manual page.
511 .SS "TLS Version Options"
512 .IX Subsection "TLS Version Options"
513 Several commands use SSL, TLS, or DTLS. By default, the commands use TLS and
514 clients will offer the lowest and highest protocol version they support,
515 and servers will pick the highest version that the client offers that is also
516 supported by the server.
517 .PP
518 The options below can be used to limit which protocol versions are used,
519 and whether TCP (SSL and TLS) or UDP (DTLS) is used.
520 Note that not all protocols and flags may be available, depending on how
521 OpenSSL was built.
522 .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
523 .IX Item "-ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3, -no_ssl3, -no_tls1, -no_tls1_1, -no_tls1_2, -no_tls1_3"
524 These options require or disable the use of the specified SSL or TLS protocols.
525 When a specific TLS version is required, only that version will be offered or
526 accepted.
527 Only one specific protocol can be given and it cannot be combined with any of
528 the \fBno_\fR options.
529 The \fBno_*\fR options do not work with \fBs_time\fR and \fBciphers\fR commands but work with
530 \&\fBs_client\fR and \fBs_server\fR commands.
531 .IP "\fB\-dtls\fR, \fB\-dtls1\fR, \fB\-dtls1_2\fR" 4
532 .IX Item "-dtls, -dtls1, -dtls1_2"
533 These options specify to use DTLS instead of TLS.
534 With \fB\-dtls\fR, clients will negotiate any supported DTLS protocol version.
535 Use the \fB\-dtls1\fR or \fB\-dtls1_2\fR options to support only DTLS1.0 or DTLS1.2,
536 respectively.
537 .SS "Engine Options"
538 .IX Subsection "Engine Options"
539 .IP "\fB\-engine\fR \fIid\fR" 4
540 .IX Item "-engine id"
541 Load the engine identified by \fIid\fR and use all the methods it implements
542 (algorithms, key storage, etc.), unless specified otherwise in the
543 command-specific documentation or it is configured to do so, as described in
544 "Engine Configuration" in \fBconfig\fR\|(5).
545 .Sp
546 The engine will be used for key ids specified with \fB\-key\fR and similar
547 options when an option like \fB\-keyform engine\fR is given.
548 .Sp
549 A special case is the \f(CW\*(C`loader_attic\*(C'\fR engine, which
550 is meant just for internal OpenSSL testing purposes and
551 supports loading keys, parameters, certificates, and CRLs from files.
552 When this engine is used, files with such credentials are read via this engine.
553 Using the \f(CW\*(C`file:\*(C'\fR schema is optional; a plain file (path) name will do.
554 .PP
555 Options specifying keys, like \fB\-key\fR and similar, can use the generic
556 OpenSSL engine key loading URI scheme \f(CW\*(C`org.openssl.engine:\*(C'\fR to retrieve
557 private keys and public keys. The URI syntax is as follows, in simplified
558 form:
559 .PP
560 .Vb 1
561 \& org.openssl.engine:{engineid}:{keyid}
562 .Ve
563 .PP
564 Where \f(CW\*(C`{engineid}\*(C'\fR is the identity/name of the engine, and \f(CW\*(C`{keyid}\*(C'\fR is a
565 key identifier that's acceptable by that engine. For example, when using an
566 engine that interfaces against a PKCS#11 implementation, the generic key URI
567 would be something like this (this happens to be an example for the PKCS#11
568 engine that's part of OpenSC):
569 .PP
570 .Vb 1
571 \& \-key org.openssl.engine:pkcs11:label_some\-private\-key
572 .Ve
573 .PP
574 As a third possibility, for engines and providers that have implemented
575 their own \fBOSSL_STORE_LOADER\fR\|(3), \f(CW\*(C`org.openssl.engine:\*(C'\fR should not be
576 necessary. For a PKCS#11 implementation that has implemented such a loader,
577 the PKCS#11 URI as defined in RFC 7512 should be possible to use directly:
578 .PP
579 .Vb 1
580 \& \-key pkcs11:object=some\-private\-key;pin\-value=1234
581 .Ve
582 .SS "Provider Options"
583 .IX Subsection "Provider Options"
584 .IP "\fB\-provider\fR \fIname\fR" 4
585 .IX Item "-provider name"
586 Load and initialize the provider identified by \fIname\fR. The \fIname\fR
587 can be also a path to the provider module. In that case the provider name
588 will be the specified path and not just the provider module name.
589 Interpretation of relative paths is platform specific. The configured
590 "MODULESDIR" path, \fBOPENSSL_MODULES\fR environment variable, or the path
591 specified by \fB\-provider\-path\fR is prepended to relative paths.
592 See \fBprovider\fR\|(7) for a more detailed description.
593 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
594 .IX Item "-provider-path path"
595 Specifies the search path that is to be used for looking for providers.
596 Equivalently, the \fBOPENSSL_MODULES\fR environment variable may be set.
597 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
598 .IX Item "-provparam [name:]key=value"
599 Set configuration parameter \fIkey\fR to value \fIval\fR in provider \fIname\fR
600 (optional), if \fIname\fR is not specified, the setting will be applied to all
601 loaded providers.
602 This option can be specified multiple times, to set multiple parameters.
603 Options that specify nondefault providers to load should precede this option
604 if the setting is intended to apply to the to be loaded providers.
605 Parameters that only affect provider initialisation must, for now, be set in
606 the configuration file, only parameters that are also queried as needed later
607 have any affect when set via this interface.
608 Only UTF8\-string\-valued parameters are supported.
609 See the documentation of the specific provider and associated algorithms for
610 any supported parameters.
611 .IP "\fB\-propquery\fR \fIpropq\fR" 4
612 .IX Item "-propquery propq"
613 Specifies the \fIproperty query clause\fR to be used when fetching algorithms
614 from the loaded providers.
615 See \fBproperty\fR\|(7) for a more detailed description.
616 .SH ENVIRONMENT
617 .IX Header "ENVIRONMENT"
618 The OpenSSL libraries can take some configuration parameters from the
619 environment.
620 .PP
621 For information about all environment variables used by the OpenSSL libraries,
622 such as \fBOPENSSL_CONF\fR, \fBOPENSSL_MODULES\fR, and \fBOPENSSL_TRACE\fR,
623 see \fBopenssl\-env\fR\|(7).
624 .PP
625 For information about the use of environment variables in configuration,
626 see "ENVIRONMENT" in \fBconfig\fR\|(5).
627 .PP
628 For information about specific commands, see \fBopenssl\-engine\fR\|(1),
629 \&\fBopenssl\-rehash\fR\|(1), and \fBtsget\fR\|(1).
630 .PP
631 For information about querying or specifying CPU architecture flags, see
632 \&\fBOPENSSL_ia32cap\fR\|(3), \fBOPENSSL_ppccap\fR\|(3), \fBOPENSSL_s390xcap\fR\|(3),
633 and \fBOPENSSL_riscvcap\fR\|(3).
634 .SH "SEE ALSO"
635 .IX Header "SEE ALSO"
636 \&\fBopenssl\-asn1parse\fR\|(1),
637 \&\fBopenssl\-ca\fR\|(1),
638 \&\fBopenssl\-ciphers\fR\|(1),
639 \&\fBopenssl\-cms\fR\|(1),
640 \&\fBopenssl\-crl\fR\|(1),
641 \&\fBopenssl\-crl2pkcs7\fR\|(1),
642 \&\fBopenssl\-dgst\fR\|(1),
643 \&\fBopenssl\-dhparam\fR\|(1),
644 \&\fBopenssl\-dsa\fR\|(1),
645 \&\fBopenssl\-dsaparam\fR\|(1),
646 \&\fBopenssl\-ec\fR\|(1),
647 \&\fBopenssl\-ecparam\fR\|(1),
648 \&\fBopenssl\-enc\fR\|(1),
649 \&\fBopenssl\-engine\fR\|(1),
650 \&\fBopenssl\-errstr\fR\|(1),
651 \&\fBopenssl\-gendsa\fR\|(1),
652 \&\fBopenssl\-genpkey\fR\|(1),
653 \&\fBopenssl\-genrsa\fR\|(1),
654 \&\fBopenssl\-kdf\fR\|(1),
655 \&\fBopenssl\-list\fR\|(1),
656 \&\fBopenssl\-mac\fR\|(1),
657 \&\fBopenssl\-nseq\fR\|(1),
658 \&\fBopenssl\-ocsp\fR\|(1),
659 \&\fBopenssl\-passwd\fR\|(1),
660 \&\fBopenssl\-pkcs12\fR\|(1),
661 \&\fBopenssl\-pkcs7\fR\|(1),
662 \&\fBopenssl\-pkcs8\fR\|(1),
663 \&\fBopenssl\-pkey\fR\|(1),
664 \&\fBopenssl\-pkeyparam\fR\|(1),
665 \&\fBopenssl\-pkeyutl\fR\|(1),
666 \&\fBopenssl\-prime\fR\|(1),
667 \&\fBopenssl\-rand\fR\|(1),
668 \&\fBopenssl\-rehash\fR\|(1),
669 \&\fBopenssl\-req\fR\|(1),
670 \&\fBopenssl\-rsa\fR\|(1),
671 \&\fBopenssl\-rsautl\fR\|(1),
672 \&\fBopenssl\-s_client\fR\|(1),
673 \&\fBopenssl\-s_server\fR\|(1),
674 \&\fBopenssl\-s_time\fR\|(1),
675 \&\fBopenssl\-sess_id\fR\|(1),
676 \&\fBopenssl\-smime\fR\|(1),
677 \&\fBopenssl\-speed\fR\|(1),
678 \&\fBopenssl\-spkac\fR\|(1),
679 \&\fBopenssl\-srp\fR\|(1),
680 \&\fBopenssl\-storeutl\fR\|(1),
681 \&\fBopenssl\-ts\fR\|(1),
682 \&\fBopenssl\-verify\fR\|(1),
683 \&\fBopenssl\-version\fR\|(1),
684 \&\fBopenssl\-x509\fR\|(1),
685 \&\fBconfig\fR\|(5),
686 \&\fBcrypto\fR\|(7),
687 \&\fBopenssl\-env\fR\|(7).
688 \&\fBssl\fR\|(7),
689 \&\fBx509v3_config\fR\|(5)
690 .SH HISTORY
691 .IX Header "HISTORY"
692 The \fBlist\fR \-\fIXXX\fR\fB\-algorithms\fR options were added in OpenSSL 1.0.0;
693 For notes on the availability of other commands, see their individual
694 manual pages.
695 .PP
696 The \fB\-issuer_checks\fR option is deprecated as of OpenSSL 1.1.0 and
697 is silently ignored.
698 .PP
699 The \fB\-xcertform\fR and \fB\-xkeyform\fR options
700 are obsolete since OpenSSL 3.0 and have no effect.
701 .PP
702 The interactive mode, which could be invoked by running \f(CW\*(C`openssl\*(C'\fR
703 with no further arguments, was removed in OpenSSL 3.0, and running
704 that program with no arguments is now equivalent to \f(CW\*(C`openssl help\*(C'\fR.
705 .SH COPYRIGHT
706 .IX Header "COPYRIGHT"
707 Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved.
708 .PP
709 Licensed under the Apache License 2.0 (the "License"). You may not use
710 this file except in compliance with the License. You can obtain a copy
711 in the file LICENSE in the source distribution or at
712 <https://www.openssl.org/source/license.html>.