6 openssl - OpenSSL command line tool
15 B<openssl> [ B<list-standard-commands> | B<list-message-digest-commands> | B<list-cipher-commands> ]
17 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
21 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
22 v2/v3) and Transport Layer Security (TLS v1) network protocols and related
23 cryptography standards required by them.
25 The B<openssl> program is a command line tool for using the various
26 cryptography functions of OpenSSL's B<crypto> library from the shell.
29 o Creation of RSA, DH and DSA key parameters
30 o Creation of X.509 certificates, CSRs and CRLs
31 o Calculation of Message Digests
32 o Encryption and Decryption with Ciphers
33 o SSL/TLS Client and Server Tests
34 o Handling of S/MIME signed or encrypted mail
36 =head1 COMMAND SUMMARY
38 The B<openssl> program provides a rich variety of commands (I<command> in the
39 SYNOPSIS above), each of which often has a wealth of options and arguments
40 (I<command_opts> and I<command_args> in the SYNOPSIS).
42 The pseudo-commands B<list-standard-commands>, B<list-message-digest-commands>,
43 and B<list-cipher-commands> output a list (one entry per line) of the names
44 of all standard commands, message digest commands, or cipher commands,
45 respectively, that are available in the present B<openssl> utility.
47 The pseudo-command B<no->I<XXX> tests whether a command of the
48 specified name is available. If no command named I<XXX> exists, it
49 returns 0 (success) and prints B<no->I<XXX>; otherwise it returns 1
50 and prints I<XXX>. In both cases, the output goes to B<stdout> and
51 nothing is printed to B<stderr>. Additional command line arguments
52 are always ignored. Since for each cipher there is a command of the
53 same name, this provides an easy way for shell scripts to test for the
54 availability of ciphers in the B<openssl> program. (B<no->I<XXX> is
55 not able to detect pseudo-commands such as B<quit>,
56 B<list->I<...>B<-commands>, or B<no->I<XXX> itself.)
58 =head2 STANDARD COMMANDS
62 =item L<B<asn1parse>|asn1parse(1)>
64 Parse an ASN.1 sequence.
68 Certificate Authority (CA) Management.
70 =item L<B<ciphers>|ciphers(1)>
72 Cipher Suite Description Determination.
74 =item L<B<crl>|crl(1)>
76 Certificate Revocation List (CRL) Management.
78 =item L<B<crl2pkcs7>|crl2pkcs7(1)>
80 CRL to PKCS#7 Conversion.
82 =item L<B<dgst>|dgst(1)>
84 Message Digest Calculation.
88 Diffie-Hellman Parameter Management.
89 Obsoleted by L<B<dhparam>|dhparam(1)>.
91 =item L<B<dsa>|dsa(1)>
95 =item L<B<dsaparam>|dsaparam(1)>
97 DSA Parameter Generation.
99 =item L<B<enc>|enc(1)>
101 Encoding with Ciphers.
103 =item L<B<errstr>|errstr(1)>
105 Error Number to Error String Conversion.
107 =item L<B<dhparam>|dhparam(1)>
109 Generation and Management of Diffie-Hellman Parameters.
113 Generation of Diffie-Hellman Parameters.
114 Obsoleted by L<B<dhparam>|dhparam(1)>.
116 =item L<B<gendsa>|gendsa(1)>
118 Generation of DSA Parameters.
120 =item L<B<genrsa>|genrsa(1)>
122 Generation of RSA Parameters.
124 =item L<B<ocsp>|ocsp(1)>
126 Online Certificate Status Protocol utility.
128 =item L<B<passwd>|passwd(1)>
130 Generation of hashed passwords.
132 =item L<B<pkcs7>|pkcs7(1)>
134 PKCS#7 Data Management.
136 =item L<B<rand>|rand(1)>
138 Generate pseudo-random bytes.
140 =item L<B<req>|req(1)>
142 X.509 Certificate Signing Request (CSR) Management.
144 =item L<B<rsa>|rsa(1)>
148 =item L<B<rsautl>|rsautl(1)>
150 RSA utility for signing, verification, encryption, and decryption.
152 =item L<B<s_client>|s_client(1)>
154 This implements a generic SSL/TLS client which can establish a transparent
155 connection to a remote server speaking SSL/TLS. It's intended for testing
156 purposes only and provides only rudimentary interface functionality but
157 internally uses mostly all functionality of the OpenSSL B<ssl> library.
159 =item L<B<s_server>|s_server(1)>
161 This implements a generic SSL/TLS server which accepts connections from remote
162 clients speaking SSL/TLS. It's intended for testing purposes only and provides
163 only rudimentary interface functionality but internally uses mostly all
164 functionality of the OpenSSL B<ssl> library. It provides both an own command
165 line oriented protocol for testing SSL functions and a simple HTTP response
166 facility to emulate an SSL/TLS-aware webserver.
168 =item L<B<s_time>|s_time(1)>
170 SSL Connection Timer.
172 =item L<B<sess_id>|sess_id(1)>
174 SSL Session Data Management.
176 =item L<B<smime>|smime(1)>
178 S/MIME mail processing.
180 =item L<B<speed>|speed(1)>
182 Algorithm Speed Measurement.
184 =item L<B<verify>|verify(1)>
186 X.509 Certificate Verification.
188 =item L<B<version>|version(1)>
190 OpenSSL Version Information.
192 =item L<B<x509>|x509(1)>
194 X.509 Certificate Data Management.
198 =head2 MESSAGE DIGEST COMMANDS
228 =head2 ENCODING AND CIPHER COMMANDS
236 =item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
240 =item B<cast cast-cbc>
244 =item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
248 =item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
252 =item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
256 =item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
260 =item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
268 =item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
274 =head1 PASS PHRASE ARGUMENTS
276 Several commands accept password arguments, typically using B<-passin>
277 and B<-passout> for input and output passwords respectively. These allow
278 the password to be obtained from a variety of sources. Both of these
279 options take a single argument whose format is described below. If no
280 password argument is given and a password is required then the user is
281 prompted to enter one: this will typically be read from the current
282 terminal with echoing turned off.
286 =item B<pass:password>
288 the actual password is B<password>. Since the password is visible
289 to utilities (like 'ps' under Unix) this form should only be used
290 where security is not important.
294 obtain the password from the environment variable B<var>. Since
295 the environment of other processes is visible on certain platforms
296 (e.g. ps under certain Unix OSes) this option should be used with caution.
298 =item B<file:pathname>
300 the first line of B<pathname> is the password. If the same B<pathname>
301 argument is supplied to B<-passin> and B<-passout> arguments then the first
302 line will be used for the input password and the next line for the output
303 password. B<pathname> need not refer to a regular file: it could for example
304 refer to a device or named pipe.
308 read the password from the file descriptor B<number>. This can be used to
309 send the data via a pipe for example.
313 read the password from standard input.
319 L<asn1parse(1)|asn1parse(1)>, L<ca(1)|ca(1)>, L<config(5)|config(5)>,
320 L<crl(1)|crl(1)>, L<crl2pkcs7(1)|crl2pkcs7(1)>, L<dgst(1)|dgst(1)>,
321 L<dhparam(1)|dhparam(1)>, L<dsa(1)|dsa(1)>, L<dsaparam(1)|dsaparam(1)>,
322 L<enc(1)|enc(1)>, L<gendsa(1)|gendsa(1)>,
323 L<genrsa(1)|genrsa(1)>, L<nseq(1)|nseq(1)>, L<openssl(1)|openssl(1)>,
324 L<passwd(1)|passwd(1)>,
325 L<pkcs12(1)|pkcs12(1)>, L<pkcs7(1)|pkcs7(1)>, L<pkcs8(1)|pkcs8(1)>,
326 L<rand(1)|rand(1)>, L<req(1)|req(1)>, L<rsa(1)|rsa(1)>,
327 L<rsautl(1)|rsautl(1)>, L<s_client(1)|s_client(1)>,
328 L<s_server(1)|s_server(1)>, L<smime(1)|smime(1)>, L<spkac(1)|spkac(1)>,
329 L<verify(1)|verify(1)>, L<version(1)|version(1)>, L<x509(1)|x509(1)>,
330 L<crypto(3)|crypto(3)>, L<ssl(3)|ssl(3)>
334 The openssl(1) document appeared in OpenSSL 0.9.2.
335 The B<list->I<XXX>B<-commands> pseudo-commands were added in OpenSSL 0.9.3;
336 the B<no->I<XXX> pseudo-commands were added in OpenSSL 0.9.5a.
337 For notes on the availability of other commands, see their individual