1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
53 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "OPENSSL 1"
127 .TH OPENSSL 1 "2014-04-07" "1.0.1g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 openssl \- OpenSSL command line tool
135 .IX Header "SYNOPSIS"
138 [ \fIcommand_opts\fR ]
139 [ \fIcommand_args\fR ]
141 \&\fBopenssl\fR [ \fBlist-standard-commands\fR | \fBlist-message-digest-commands\fR | \fBlist-cipher-commands\fR | \fBlist-cipher-algorithms\fR | \fBlist-message-digest-algorithms\fR | \fBlist-public-key-algorithms\fR]
143 \&\fBopenssl\fR \fBno\-\fR\fI\s-1XXX\s0\fR [ \fIarbitrary options\fR ]
145 .IX Header "DESCRIPTION"
146 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (\s-1SSL\s0
147 v2/v3) and Transport Layer Security (\s-1TLS\s0 v1) network protocols and related
148 cryptography standards required by them.
150 The \fBopenssl\fR program is a command line tool for using the various
151 cryptography functions of OpenSSL's \fBcrypto\fR library from the shell.
155 \& o Creation and management of private keys, public keys and parameters
156 \& o Public key cryptographic operations
157 \& o Creation of X.509 certificates, CSRs and CRLs
158 \& o Calculation of Message Digests
159 \& o Encryption and Decryption with Ciphers
160 \& o SSL/TLS Client and Server Tests
161 \& o Handling of S/MIME signed or encrypted mail
162 \& o Time Stamp requests, generation and verification
164 .SH "COMMAND SUMMARY"
165 .IX Header "COMMAND SUMMARY"
166 The \fBopenssl\fR program provides a rich variety of commands (\fIcommand\fR in the
167 \&\s-1SYNOPSIS\s0 above), each of which often has a wealth of options and arguments
168 (\fIcommand_opts\fR and \fIcommand_args\fR in the \s-1SYNOPSIS\s0).
170 The pseudo-commands \fBlist-standard-commands\fR, \fBlist-message-digest-commands\fR,
171 and \fBlist-cipher-commands\fR output a list (one entry per line) of the names
172 of all standard commands, message digest commands, or cipher commands,
173 respectively, that are available in the present \fBopenssl\fR utility.
175 The pseudo-commands \fBlist-cipher-algorithms\fR and
176 \&\fBlist-message-digest-algorithms\fR list all cipher and message digest names, one entry per line. Aliases are listed as:
182 The pseudo-command \fBlist-public-key-algorithms\fR lists all supported public
185 The pseudo-command \fBno\-\fR\fI\s-1XXX\s0\fR tests whether a command of the
186 specified name is available. If no command named \fI\s-1XXX\s0\fR exists, it
187 returns 0 (success) and prints \fBno\-\fR\fI\s-1XXX\s0\fR; otherwise it returns 1
188 and prints \fI\s-1XXX\s0\fR. In both cases, the output goes to \fBstdout\fR and
189 nothing is printed to \fBstderr\fR. Additional command line arguments
190 are always ignored. Since for each cipher there is a command of the
191 same name, this provides an easy way for shell scripts to test for the
192 availability of ciphers in the \fBopenssl\fR program. (\fBno\-\fR\fI\s-1XXX\s0\fR is
193 not able to detect pseudo-commands such as \fBquit\fR,
194 \&\fBlist\-\fR\fI...\fR\fB\-commands\fR, or \fBno\-\fR\fI\s-1XXX\s0\fR itself.)
195 .SS "\s-1STANDARD\s0 \s-1COMMANDS\s0"
196 .IX Subsection "STANDARD COMMANDS"
197 .IP "\fBasn1parse\fR" 10
199 Parse an \s-1ASN\s0.1 sequence.
202 Certificate Authority (\s-1CA\s0) Management.
203 .IP "\fBciphers\fR" 10
205 Cipher Suite Description Determination.
208 \&\s-1CMS\s0 (Cryptographic Message Syntax) utility
211 Certificate Revocation List (\s-1CRL\s0) Management.
212 .IP "\fBcrl2pkcs7\fR" 10
214 \&\s-1CRL\s0 to PKCS#7 Conversion.
217 Message Digest Calculation.
220 Diffie-Hellman Parameter Management.
221 Obsoleted by \fBdhparam\fR.
222 .IP "\fBdhparam\fR" 10
224 Generation and Management of Diffie-Hellman Parameters. Superseded by
225 \&\fBgenpkey\fR and \fBpkeyparam\fR
228 \&\s-1DSA\s0 Data Management.
229 .IP "\fBdsaparam\fR" 10
231 \&\s-1DSA\s0 Parameter Generation and Management. Superseded by
232 \&\fBgenpkey\fR and \fBpkeyparam\fR
235 \&\s-1EC\s0 (Elliptic curve) key processing
236 .IP "\fBecparam\fR" 10
238 \&\s-1EC\s0 parameter manipulation and generation
241 Encoding with Ciphers.
242 .IP "\fBengine\fR" 10
244 Engine (loadble module) information and manipulation.
245 .IP "\fBerrstr\fR" 10
247 Error Number to Error String Conversion.
250 Generation of Diffie-Hellman Parameters.
251 Obsoleted by \fBdhparam\fR.
252 .IP "\fBgendsa\fR" 10
254 Generation of \s-1DSA\s0 Private Key from Parameters. Superseded by
255 \&\fBgenpkey\fR and \fBpkey\fR
256 .IP "\fBgenpkey\fR" 10
258 Generation of Private Key or Parameters.
259 .IP "\fBgenrsa\fR" 10
261 Generation of \s-1RSA\s0 Private Key. Superceded by \fBgenpkey\fR.
264 Create or examine a netscape certificate sequence
267 Online Certificate Status Protocol utility.
268 .IP "\fBpasswd\fR" 10
270 Generation of hashed passwords.
271 .IP "\fBpkcs12\fR" 10
273 PKCS#12 Data Management.
276 PKCS#7 Data Management.
279 Public and private key management.
280 .IP "\fBpkeyparam\fR" 10
282 Public key algorithm parameter management.
283 .IP "\fBpkeyutl\fR" 10
285 Public key algorithm cryptographic operation utility.
288 Generate pseudo-random bytes.
291 PKCS#10 X.509 Certificate Signing Request (\s-1CSR\s0) Management.
294 \&\s-1RSA\s0 key management.
295 .IP "\fBrsautl\fR" 10
297 \&\s-1RSA\s0 utility for signing, verification, encryption, and decryption. Superseded
299 .IP "\fBs_client\fR" 10
301 This implements a generic \s-1SSL/TLS\s0 client which can establish a transparent
302 connection to a remote server speaking \s-1SSL/TLS\s0. It's intended for testing
303 purposes only and provides only rudimentary interface functionality but
304 internally uses mostly all functionality of the OpenSSL \fBssl\fR library.
305 .IP "\fBs_server\fR" 10
307 This implements a generic \s-1SSL/TLS\s0 server which accepts connections from remote
308 clients speaking \s-1SSL/TLS\s0. It's intended for testing purposes only and provides
309 only rudimentary interface functionality but internally uses mostly all
310 functionality of the OpenSSL \fBssl\fR library. It provides both an own command
311 line oriented protocol for testing \s-1SSL\s0 functions and a simple \s-1HTTP\s0 response
312 facility to emulate an SSL/TLS\-aware webserver.
313 .IP "\fBs_time\fR" 10
315 \&\s-1SSL\s0 Connection Timer.
316 .IP "\fBsess_id\fR" 10
318 \&\s-1SSL\s0 Session Data Management.
321 S/MIME mail processing.
324 Algorithm Speed Measurement.
327 \&\s-1SPKAC\s0 printing and generating utility
330 Time Stamping Authority tool (client/server)
331 .IP "\fBverify\fR" 10
333 X.509 Certificate Verification.
334 .IP "\fBversion\fR" 10
336 OpenSSL Version Information.
339 X.509 Certificate Data Management.
340 .SS "\s-1MESSAGE\s0 \s-1DIGEST\s0 \s-1COMMANDS\s0"
341 .IX Subsection "MESSAGE DIGEST COMMANDS"
351 .IP "\fBrmd160\fR" 10
353 \&\s-1RMD\-160\s0 Digest
359 \&\s-1SHA\-1\s0 Digest
360 .IP "\fBsha224\fR" 10
362 \&\s-1SHA\-224\s0 Digest
363 .IP "\fBsha256\fR" 10
365 \&\s-1SHA\-256\s0 Digest
366 .IP "\fBsha384\fR" 10
368 \&\s-1SHA\-384\s0 Digest
369 .IP "\fBsha512\fR" 10
371 \&\s-1SHA\-512\s0 Digest
372 .SS "\s-1ENCODING\s0 \s-1AND\s0 \s-1CIPHER\s0 \s-1COMMANDS\s0"
373 .IX Subsection "ENCODING AND CIPHER COMMANDS"
374 .IP "\fBbase64\fR" 10
377 .IP "\fBbf bf-cbc bf-cfb bf-ecb bf-ofb\fR" 10
378 .IX Item "bf bf-cbc bf-cfb bf-ecb bf-ofb"
380 .IP "\fBcast cast-cbc\fR" 10
381 .IX Item "cast cast-cbc"
383 .IP "\fBcast5\-cbc cast5\-cfb cast5\-ecb cast5\-ofb\fR" 10
384 .IX Item "cast5-cbc cast5-cfb cast5-ecb cast5-ofb"
385 \&\s-1CAST5\s0 Cipher
386 .IP "\fBdes des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb\fR" 10
387 .IX Item "des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb"
389 .IP "\fBdes3 desx des\-ede3 des\-ede3\-cbc des\-ede3\-cfb des\-ede3\-ofb\fR" 10
390 .IX Item "des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb"
392 .IP "\fBidea idea-cbc idea-cfb idea-ecb idea-ofb\fR" 10
393 .IX Item "idea idea-cbc idea-cfb idea-ecb idea-ofb"
395 .IP "\fBrc2 rc2\-cbc rc2\-cfb rc2\-ecb rc2\-ofb\fR" 10
396 .IX Item "rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb"
401 .IP "\fBrc5 rc5\-cbc rc5\-cfb rc5\-ecb rc5\-ofb\fR" 10
402 .IX Item "rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb"
404 .SH "PASS PHRASE ARGUMENTS"
405 .IX Header "PASS PHRASE ARGUMENTS"
406 Several commands accept password arguments, typically using \fB\-passin\fR
407 and \fB\-passout\fR for input and output passwords respectively. These allow
408 the password to be obtained from a variety of sources. Both of these
409 options take a single argument whose format is described below. If no
410 password argument is given and a password is required then the user is
411 prompted to enter one: this will typically be read from the current
412 terminal with echoing turned off.
413 .IP "\fBpass:password\fR" 10
414 .IX Item "pass:password"
415 the actual password is \fBpassword\fR. Since the password is visible
416 to utilities (like 'ps' under Unix) this form should only be used
417 where security is not important.
418 .IP "\fBenv:var\fR" 10
420 obtain the password from the environment variable \fBvar\fR. Since
421 the environment of other processes is visible on certain platforms
422 (e.g. ps under certain Unix OSes) this option should be used with caution.
423 .IP "\fBfile:pathname\fR" 10
424 .IX Item "file:pathname"
425 the first line of \fBpathname\fR is the password. If the same \fBpathname\fR
426 argument is supplied to \fB\-passin\fR and \fB\-passout\fR arguments then the first
427 line will be used for the input password and the next line for the output
428 password. \fBpathname\fR need not refer to a regular file: it could for example
429 refer to a device or named pipe.
430 .IP "\fBfd:number\fR" 10
432 read the password from the file descriptor \fBnumber\fR. This can be used to
433 send the data via a pipe for example.
436 read the password from standard input.
438 .IX Header "SEE ALSO"
439 \&\fIasn1parse\fR\|(1), \fIca\fR\|(1), \fIconfig\fR\|(5),
440 \&\fIcrl\fR\|(1), \fIcrl2pkcs7\fR\|(1), \fIdgst\fR\|(1),
441 \&\fIdhparam\fR\|(1), \fIdsa\fR\|(1), \fIdsaparam\fR\|(1),
442 \&\fIenc\fR\|(1), \fIgendsa\fR\|(1), \fIgenpkey\fR\|(1),
443 \&\fIgenrsa\fR\|(1), \fInseq\fR\|(1), \fIopenssl\fR\|(1),
445 \&\fIpkcs12\fR\|(1), \fIpkcs7\fR\|(1), \fIpkcs8\fR\|(1),
446 \&\fIrand\fR\|(1), \fIreq\fR\|(1), \fIrsa\fR\|(1),
447 \&\fIrsautl\fR\|(1), \fIs_client\fR\|(1),
448 \&\fIs_server\fR\|(1), \fIs_time\fR\|(1),
449 \&\fIsmime\fR\|(1), \fIspkac\fR\|(1),
450 \&\fIverify\fR\|(1), \fIversion\fR\|(1), \fIx509\fR\|(1),
451 \&\fIcrypto\fR\|(3), \fIssl\fR\|(3), \fIx509v3_config\fR\|(5)
454 The \fIopenssl\fR\|(1) document appeared in OpenSSL 0.9.2.
455 The \fBlist\-\fR\fI\s-1XXX\s0\fR\fB\-commands\fR pseudo-commands were added in OpenSSL 0.9.3;
456 The \fBlist\-\fR\fI\s-1XXX\s0\fR\fB\-algorithms\fR pseudo-commands were added in OpenSSL 1.0.0;
457 the \fBno\-\fR\fI\s-1XXX\s0\fR pseudo-commands were added in OpenSSL 0.9.5a.
458 For notes on the availability of other commands, see their individual