dc0f49ddca632deb7947d3b061241746f609dd68
[openssl.git] / doc / apps / openssl.pod
1
2 =pod
3
4 =head1 NAME
5
6 openssl - OpenSSL command line tool
7
8 =head1 SYNOPSIS
9
10 B<openssl>
11 I<command>
12 [ I<command_opts> ]
13 [ I<command_args> ]
14
15 B<openssl> [ B<list-standard-commands> | B<list-message-digest-commands> | B<list-cipher-commands> ]
16
17 B<openssl> B<no->I<XXX> [ I<arbitrary options> ]
18
19 =head1 DESCRIPTION
20
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.
24
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. 
27 It can be used for 
28
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
35
36 =head1 COMMAND SUMMARY
37
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).
41
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.
46
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.)
57
58 =head2 STANDARD COMMANDS
59
60 =over 10
61
62 =item L<B<asn1parse>|asn1parse(1)>
63
64 Parse an ASN.1 sequence.
65
66 =item L<B<ca>|ca(1)>
67
68 Certificate Authority (CA) Management.  
69
70 =item L<B<ciphers>|ciphers(1)>
71
72 Cipher Suite Description Determination.
73
74 =item L<B<crl>|crl(1)>
75
76 Certificate Revocation List (CRL) Management.
77
78 =item L<B<crl2pkcs7>|crl2pkcs7(1)>
79
80 CRL to PKCS#7 Conversion.
81
82 =item L<B<dgst>|dgst(1)>
83
84 Message Digest Calculation.
85
86 =item B<dh>
87
88 Diffie-Hellman Parameter Management.
89 Obsoleted by L<B<dhparam>|dhparam(1)>.
90
91 =item L<B<dsa>|dsa(1)>
92
93 DSA Data Management.
94
95 =item L<B<dsaparam>|dsaparam(1)>
96
97 DSA Parameter Generation.
98
99 =item L<B<enc>|enc(1)>
100
101 Encoding with Ciphers.
102
103 =item L<B<errstr>|errstr(1)>
104
105 Error Number to Error String Conversion.
106
107 =item L<B<dhparam>|dhparam(1)>
108
109 Generation and Management of Diffie-Hellman Parameters.
110
111 =item B<gendh>
112
113 Generation of Diffie-Hellman Parameters.
114 Obsoleted by L<B<dhparam>|dhparam(1)>.
115
116 =item L<B<gendsa>|gendsa(1)>
117
118 Generation of DSA Parameters.
119
120 =item L<B<genrsa>|genrsa(1)>
121
122 Generation of RSA Parameters.
123
124 =item L<B<ocsp>|ocsp(1)>
125
126 Online Certificate Status Protocol utility.
127
128 =item L<B<passwd>|passwd(1)>
129
130 Generation of hashed passwords.
131
132 =item L<B<pkcs12>|pkcs12(1)>
133
134 PKCS#12 Data Management.
135
136 =item L<B<pkcs7>|pkcs7(1)>
137
138 PKCS#7 Data Management.
139
140 =item L<B<rand>|rand(1)>
141
142 Generate pseudo-random bytes.
143
144 =item L<B<req>|req(1)>
145
146 X.509 Certificate Signing Request (CSR) Management.
147
148 =item L<B<rsa>|rsa(1)>
149
150 RSA Data Management.
151
152 =item L<B<rsautl>|rsautl(1)>
153
154 RSA utility for signing, verification, encryption, and decryption.
155
156 =item L<B<s_client>|s_client(1)>
157
158 This implements a generic SSL/TLS client which can establish a transparent
159 connection to a remote server speaking SSL/TLS. It's intended for testing
160 purposes only and provides only rudimentary interface functionality but
161 internally uses mostly all functionality of the OpenSSL B<ssl> library.
162
163 =item L<B<s_server>|s_server(1)>
164
165 This implements a generic SSL/TLS server which accepts connections from remote
166 clients speaking SSL/TLS. It's intended for testing purposes only and provides
167 only rudimentary interface functionality but internally uses mostly all
168 functionality of the OpenSSL B<ssl> library.  It provides both an own command
169 line oriented protocol for testing SSL functions and a simple HTTP response
170 facility to emulate an SSL/TLS-aware webserver.
171
172 =item L<B<s_time>|s_time(1)>
173
174 SSL Connection Timer.
175
176 =item L<B<sess_id>|sess_id(1)>
177
178 SSL Session Data Management.
179
180 =item L<B<smime>|smime(1)>
181
182 S/MIME mail processing.
183
184 =item L<B<speed>|speed(1)>
185
186 Algorithm Speed Measurement.
187
188 =item L<B<verify>|verify(1)>
189
190 X.509 Certificate Verification.
191
192 =item L<B<version>|version(1)>
193
194 OpenSSL Version Information.
195
196 =item L<B<x509>|x509(1)>
197
198 X.509 Certificate Data Management.
199
200 =back
201
202 =head2 MESSAGE DIGEST COMMANDS
203
204 =over 10
205
206 =item B<md2>
207
208 MD2 Digest
209
210 =item B<md5>
211
212 MD5 Digest
213
214 =item B<mdc2>
215
216 MDC2 Digest
217
218 =item B<rmd160>
219
220 RMD-160 Digest
221
222 =item B<sha>            
223
224 SHA Digest
225
226 =item B<sha1>           
227
228 SHA-1 Digest
229
230 =back
231
232 =head2 ENCODING AND CIPHER COMMANDS
233
234 =over 10
235
236 =item B<base64>
237
238 Base64 Encoding
239
240 =item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
241
242 Blowfish Cipher
243
244 =item B<cast cast-cbc>
245
246 CAST Cipher
247
248 =item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
249
250 CAST5 Cipher
251
252 =item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
253
254 DES Cipher
255
256 =item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
257
258 Triple-DES Cipher
259
260 =item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
261
262 IDEA Cipher
263
264 =item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
265
266 RC2 Cipher
267
268 =item B<rc4>
269
270 RC4 Cipher
271
272 =item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
273
274 RC5 Cipher
275
276 =back
277
278 =head1 PASS PHRASE ARGUMENTS
279
280 Several commands accept password arguments, typically using B<-passin>
281 and B<-passout> for input and output passwords respectively. These allow
282 the password to be obtained from a variety of sources. Both of these
283 options take a single argument whose format is described below. If no
284 password argument is given and a password is required then the user is
285 prompted to enter one: this will typically be read from the current
286 terminal with echoing turned off.
287
288 =over 10
289
290 =item B<pass:password>
291
292 the actual password is B<password>. Since the password is visible
293 to utilities (like 'ps' under Unix) this form should only be used
294 where security is not important.
295
296 =item B<env:var>
297
298 obtain the password from the environment variable B<var>. Since
299 the environment of other processes is visible on certain platforms
300 (e.g. ps under certain Unix OSes) this option should be used with caution.
301
302 =item B<file:pathname>
303
304 the first line of B<pathname> is the password. If the same B<pathname>
305 argument is supplied to B<-passin> and B<-passout> arguments then the first
306 line will be used for the input password and the next line for the output
307 password. B<pathname> need not refer to a regular file: it could for example
308 refer to a device or named pipe.
309
310 =item B<fd:number>
311
312 read the password from the file descriptor B<number>. This can be used to
313 send the data via a pipe for example.
314
315 =item B<stdin>
316
317 read the password from standard input.
318
319 =back
320
321 =head1 SEE ALSO
322
323 L<asn1parse(1)|asn1parse(1)>, L<ca(1)|ca(1)>, L<config(5)|config(5)>,
324 L<crl(1)|crl(1)>, L<crl2pkcs7(1)|crl2pkcs7(1)>, L<dgst(1)|dgst(1)>,
325 L<dhparam(1)|dhparam(1)>, L<dsa(1)|dsa(1)>, L<dsaparam(1)|dsaparam(1)>,
326 L<enc(1)|enc(1)>, L<gendsa(1)|gendsa(1)>,
327 L<genrsa(1)|genrsa(1)>, L<nseq(1)|nseq(1)>, L<openssl(1)|openssl(1)>,
328 L<passwd(1)|passwd(1)>,
329 L<pkcs12(1)|pkcs12(1)>, L<pkcs7(1)|pkcs7(1)>, L<pkcs8(1)|pkcs8(1)>,
330 L<rand(1)|rand(1)>, L<req(1)|req(1)>, L<rsa(1)|rsa(1)>,
331 L<rsautl(1)|rsautl(1)>, L<s_client(1)|s_client(1)>,
332 L<s_server(1)|s_server(1)>, L<s_time(1)|s_time(1)>,
333 L<smime(1)|smime(1)>, L<spkac(1)|spkac(1)>,
334 L<verify(1)|verify(1)>, L<version(1)|version(1)>, L<x509(1)|x509(1)>,
335 L<crypto(3)|crypto(3)>, L<ssl(3)|ssl(3)> 
336
337 =head1 HISTORY
338
339 The openssl(1) document appeared in OpenSSL 0.9.2.
340 The B<list->I<XXX>B<-commands> pseudo-commands were added in OpenSSL 0.9.3;
341 the B<no->I<XXX> pseudo-commands were added in OpenSSL 0.9.5a.
342 For notes on the availability of other commands, see their individual
343 manual pages.
344
345 =cut