New functions BN_CTX_start(), BN_CTX_get(), BN_CTX_end() to access
[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 =head1 DESCRIPTION
16
17 OpenSSL is a cryptography toolkit implementing the Secure Sockets Layer (SSL
18 v2/v3) and Transport Layer Security (TLS v1) network protocols and related
19 cryptography standards required by them.
20
21 The B<openssl> program is a command line tool for using the various
22 cryptography functions of OpenSSL's B<crypto> library from the shell. 
23 It can be used for 
24
25  o  Creation of RSA, DH and DSA key parameters
26  o  Creation of X.509 certificates, CSRs and CRLs 
27  o  Calculation of Message Digests
28  o  Encryption and Decryption with Ciphers
29  o  SSL/TLS Client and Server Tests
30  o  Handling of S/MIME signed or encrypted mail
31
32 =head1 COMMAND SUMMARY
33
34 The B<openssl> program provides a rich variety of commands (I<command> in the
35 SYNOPSIS above), each of which often has a wealth of options and arguments
36 (I<command_opts> and I<command_args> in the SYNOPSIS).
37
38 =head2 STANDARD COMMANDS
39
40 =over 10
41
42 =item B<asn1parse> 
43
44 Parse an ASN.1 sequence.
45
46 =item B<ca>
47
48 Certificate Authority (CA) Management.  
49
50 =item B<ciphers>
51
52 Cipher Suite Description Determination.
53
54 =item B<crl>
55
56 Certificate Revocation List (CRL) Management.
57
58 =item B<crl2pkcs7>      
59
60 CRL to PKCS#7 Conversion.
61
62 =item B<dgst>
63
64 Message Digest Calculation.
65
66 =item B<dh>
67
68 Diffie-Hellman Data Management.
69
70 =item B<dsa>
71
72 DSA Data Management.
73
74 =item B<dsaparam>
75
76 DSA Parameter Generation.
77
78 =item B<enc>            
79
80 Encoding with Ciphers.
81
82 =item B<errstr>
83
84 Error Number to Error String Conversion.
85
86 =item B<gendh>
87
88 Generation of Diffie-Hellman Parameters.
89
90 =item B<gendsa>
91
92 Generation of DSA Parameters.
93
94 =item B<genrsa>
95
96 Generation of RSA Parameters.
97
98 =item B<pkcs7>
99
100 PKCS#7 Data Management.
101
102 =item B<req>
103
104 X.509 Certificate Signing Request (CSR) Management.
105
106 =item B<rsa>
107
108 RSA Data Management.
109
110 =item B<s_client>
111
112 This implements a generic SSL/TLS client which can establish a transparent
113 connection to a remote server speaking SSL/TLS. It's intended for testing
114 purposes only and provides only rudimentary interface functionality but
115 internally uses mostly all functionality of the OpenSSL B<ssl> library.
116
117 =item B<s_server>
118
119 This implements a generic SSL/TLS server which accepts connections from remote
120 clients speaking SSL/TLS. It's intended for testing purposes only and provides
121 only rudimentary interface functionality but internally uses mostly all
122 functionality of the OpenSSL B<ssl> library.  It provides both an own command
123 line oriented protocol for testing SSL functions and a simple HTTP response
124 facility to emulate an SSL/TLS-aware webserver.
125
126 =item B<s_time>        
127
128 SSL Connection Timer.
129
130 =item B<sess_id>
131
132 SSL Session Data Management.
133
134 =item B<smime>
135
136 S/MIME mail processing.
137
138 =item B<speed>
139
140 Algorithm Speed Measurement.
141
142 =item B<verify>
143
144 X.509 Certificate Verification.
145
146 =item B<version>
147
148 OpenSSL Version Information.
149
150 =item B<x509>           
151
152 X.509 Certificate Data Management.
153
154 =back
155
156 =head2 MESSAGE DIGEST COMMANDS
157
158 =over 10
159
160 =item B<md2>
161
162 MD2 Digest
163
164 =item B<md5>
165
166 MD5 Digest
167
168 =item B<mdc2>
169
170 MDC2 Digest
171
172 =item B<rmd160>
173
174 RMD-160 Digest
175
176 =item B<sha>            
177
178 SHA Digest
179
180 =item B<sha1>           
181
182 SHA-1 Digest
183
184 =back
185
186 =head2 ENCODING AND CIPHER COMMANDS
187
188 =over 10
189
190 =item B<base64>
191
192 Base64 Encoding
193
194 =item B<bf bf-cbc bf-cfb bf-ecb bf-ofb>
195
196 Blowfish Cipher
197
198 =item B<cast cast-cbc>
199
200 CAST Cipher
201
202 =item B<cast5-cbc cast5-cfb cast5-ecb cast5-ofb>
203
204 CAST5 Cipher
205
206 =item B<des des-cbc des-cfb des-ecb des-ede des-ede-cbc des-ede-cfb des-ede-ofb des-ofb>
207
208 DES Cipher
209
210 =item B<des3 desx des-ede3 des-ede3-cbc des-ede3-cfb des-ede3-ofb>
211
212 Triple-DES Cipher
213
214 =item B<idea idea-cbc idea-cfb idea-ecb idea-ofb>
215
216 IDEA Cipher
217
218 =item B<rc2 rc2-cbc rc2-cfb rc2-ecb rc2-ofb>
219
220 RC2 Cipher
221
222 =item B<rc4>
223
224 RC4 Cipher
225
226 =item B<rc5 rc5-cbc rc5-cfb rc5-ecb rc5-ofb>
227
228 RC5 Cipher
229
230 =back
231
232 =head1 SEE ALSO
233
234 L<asn1parse(1)|asn1parse(1)>, L<ca(1)|ca(1)>, L<config(5)|config(5)>,
235 L<crl(1)|crl(1)>, L<crl2pkcs7(1)|crl2pkcs7(1)>, L<dgst(1)|dgst(1)>,
236 L<dhparam(1)|dhparam(1)>, L<dsa(1)|dsa(1)>, L<dsaparam(1)|dsaparam(1)>,
237 L<enc(1)|enc(1)>, L<gendsa(1)|gendsa(1)>,
238 L<genrsa(1)|genrsa(1)>, L<nseq(1)|nseq(1)>, L<openssl(1)|openssl(1)>,
239 L<pkcs12(1)|pkcs12(1)>, L<pkcs7(1)|pkcs7(1)>, L<pkcs8(1)|pkcs8(1)>,
240 L<req(1)|req(1)>, L<rsa(1)|rsa(1)>, L<s_client(1)|s_client(1)>,
241 L<s_server(1)|s_server(1)>, L<smime(1)|smime(1)>, L<spkac(1)|spkac(1)>,
242 L<verify(1)|verify(1)>, L<version(1)|version(1)>, L<x509(1)|x509(1)>,
243 L<crypto(3)|crypto(3)>, L<ssl(3)|ssl(3)> 
244
245 =head1 HISTORY
246
247 The openssl(1) document appeared in OpenSSL 0.9.2
248
249 =cut
250