Add references to the new passwd utility.
[openssl.git] / doc / apps / ciphers.pod
1 =pod
2
3 =head1 NAME
4
5 ciphers - SSL cipher display and cipher list tool.
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<ciphers>
10 [B<-v>]
11 [B<-ssl2>]
12 [B<-ssl3>]
13 [B<-tls1>]
14 [B<cipherlist>]
15
16 =head1 DESCRIPTION
17
18 The B<cipherlist> command converts OpenSSL cipher lists into ordered
19 SSL cipher preference lists. It can be used as a test tool to determine
20 the appropriate cipherlist.
21
22 =head1 COMMAND OPTIONS
23
24 =over 4
25
26 =item B<-v>
27
28 verbose option. List ciphers with a complete description of the authentication,
29 key exchange, encryption and mac algorithms used along with any key size
30 restrictions and whether the algorithm is classed as an "export" cipher.
31
32 =item B<-ssl3>
33
34 only include SSL v3 ciphers.
35
36 =item B<-ssl2>
37
38 only include SSL v2 ciphers.
39
40 =item B<-tls1>
41
42 only include TLS v1 ciphers.
43
44 =item B<-h>, B<-?>
45
46 print a brief usage message.
47
48 =item B<cipherlist>
49
50 a cipher list to convert to a cipher preference list. If it is not included
51 then the default cipher list will be used. The format is described below.
52
53 =back
54
55 =head1 CIPHER LIST FORMAT
56
57 The cipher list consists of one or more I<cipher strings> separated by colons.
58 Commas or spaces are also acceptable separators but colons are normally used.
59
60 The actual cipher string can take several different forms.
61
62 It can consist of a single cipher suite such as B<RC4-SHA>.
63
64 It can represent a list of cipher suites containing a certain algorithm, or
65 cipher suites of a certain type. For example B<SHA1> represents all ciphers
66 suites using the digest algorithm SHA1 and B<SSLv3> represents all SSL v3
67 algorithms.
68
69 Lists of cipher suites can be combined in a single cipher string using the
70 B<+> character. This is used as a logical B<and> operation. For example
71 B<SHA1+DES> represents all cipher suites containing the SHA1 B<and> the DES
72 algorithms.
73
74 Each cipher string can be optionally preceded by the characters B<!>,
75 B<-> or B<+>.
76
77 If B<!> is used then the ciphers are permanently deleted from the list.
78 The ciphers deleted can never reappear in the list even if they are
79 explicitly stated.
80
81 If B<-> is used then the ciphers are deleted from the list, but some or
82 all of the ciphers can be added again by later options.
83
84 If B<+> is used then the ciphers are moved to the end of the list. This
85 option doesn't add any new ciphers it just moves matching existing ones.
86
87 If none of these characters is present then the string is just interpreted
88 as a list of ciphers to be appended to the current preference list. If the
89 list includes any ciphers already present they will be ignored: that is they
90 will not moved to the end of the list.
91
92 Additionally the cipher string B<@STRENGTH> can be used at any point to sort
93 the current cipher list in order of encryption algorithm key length.
94
95 =head1 CIPHER STRINGS
96
97 The following is a list of all permitted cipher strings and their meanings.
98
99 =over 4
100
101 =item B<DEFAULT>
102
103 the default cipher list. This is determined at compile time and is normally
104 B<TBA>. This must be the first cipher string specified.
105
106 =item B<ALL>
107
108 all ciphers suites except the B<eNULL> ciphers which must be explicitly enabled.
109
110 =item B<HIGH>
111
112 "high" encryption cipher suites. This currently means those with key lengths larger
113 than 128 bits.
114
115 =item B<MEDIUM>
116
117 "medium" encryption cipher suites, currently those using 128 bit encryption.
118
119 =item B<LOW>
120
121 "low" encryption cipher suites, currently those using 64 or 56 bit encryption algorithms
122 but excluding export cipher suites.
123
124 =item B<EXP>, B<EXPORT>
125
126 export encryption algorithms. Including 40 and 56 bits algorithms.
127
128 =item B<EXPORT40>
129
130 40 bit export encryption algorithms
131
132 =item B<EXPORT56>
133
134 56 bit export encryption algorithms.
135
136 =item B<eNULL>, B<NULL>
137
138 the "NULL" ciphers that is those offering no encryption. Because these offer no
139 encryption at all and are a security risk they are disabled unless explicitly
140 included.
141
142 =item B<aNULL>
143
144 the cipher suites offering no authentication. This is currently the anonymous
145 DH algorithms. These cipher suites are vulnerable to a "man in the middle"
146 attack and so there use is normally discouraged.
147
148 =item B<kRSA>, B<RSA>
149
150 cipher suites using RSA key exchange.
151
152 =item B<kEDH>
153
154 cipher suites using ephemeral DH key agreement.
155
156 =item B<kDHr>, B<kDHd>
157
158 cipher suites using DH key agreement and DH certificates signed by CAs with RSA
159 and DSS keys respectively. Not implemented.
160
161 =item B<aRSA>
162
163 cipher suites using RSA authentication, i.e. the certificates carry RSA keys.
164
165 =item B<aDSS>, B<DSS>
166
167 cipher suites using DSS authentication, i.e. the certificates carry DSS keys.
168
169 =item B<aDH>
170
171 cipher suites effectively using DH authentication, i.e. the certificates carry
172 DH keys.  Not implemented.
173
174 =item B<kFZA>, B<aFZA>, B<eFZA>, B<FZA>
175
176 ciphers suites using FORTEZZA key exchange, authentication, encryption or all
177 FORTEZZA algorithms. Not implemented.
178
179 =item B<TLSv1>, B<SSLv3>, B<SSLv2>
180
181 TLS v1.0, SSL v3.0 or SSL v2.0 cipher suites respectively.
182
183 =item B<DH>
184
185 cipher suites using DH, including anonymous DH.
186
187 =item B<ADH>
188
189 anonymous DH cipher suites.
190
191 =item B<3DES>
192
193 cipher suites using triple DES.
194
195 =item B<DES>
196
197 cipher suites using DES (not triple DES).
198
199 =item B<RC4>
200
201 cipher suites using RC4.
202
203 =item B<RC2>
204
205 cipher suites using RC2.
206
207 =item B<IDEA>
208
209 cipher suites using IDEA.
210
211 =item B<MD5>
212
213 cipher suites using MD5.
214
215 =item B<SHA1>, B<SHA>
216
217 cipher suites using SHA1.
218
219 =back
220
221 =head1 CIPHER SUITE NAMES
222
223 The following lists give the SSL or TLS cipher suites names from the
224 relevant specification and their OpenSSL equivalents.
225
226 =head2 SSL v3.0 cipher suites.
227
228  SSL_RSA_WITH_NULL_MD5                   NULL-MD5
229  SSL_RSA_WITH_NULL_SHA                   NULL-SHA
230  SSL_RSA_EXPORT_WITH_RC4_40_MD5          EXP-RC4-MD5
231  SSL_RSA_WITH_RC4_128_MD5                RC4-MD5
232  SSL_RSA_WITH_RC4_128_SHA                RC4-SHA
233  SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5      EXP-RC2-CBC-MD5
234  SSL_RSA_WITH_IDEA_CBC_SHA               IDEA-CBC-SHA
235  SSL_RSA_EXPORT_WITH_DES40_CBC_SHA       EXP-DES-CBC-SHA
236  SSL_RSA_WITH_DES_CBC_SHA                DES-CBC-SHA
237  SSL_RSA_WITH_3DES_EDE_CBC_SHA           DES-CBC3-SHA
238
239  SSL_DH_DSS_EXPORT_WITH_DES40_CBC_SHA    Not implemented.
240  SSL_DH_DSS_WITH_DES_CBC_SHA             Not implemented.
241  SSL_DH_DSS_WITH_3DES_EDE_CBC_SHA        Not implemented.
242  SSL_DH_RSA_EXPORT_WITH_DES40_CBC_SHA    Not implemented.
243  SSL_DH_RSA_WITH_DES_CBC_SHA             Not implemented.
244  SSL_DH_RSA_WITH_3DES_EDE_CBC_SHA        Not implemented.
245  SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA   EXP-EDH-DSS-DES-CBC-SHA
246  SSL_DHE_DSS_WITH_DES_CBC_SHA            EDH-DSS-CBC-SHA
247  SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA       EDH-DSS-DES-CBC3-SHA
248  SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA   EXP-EDH-RSA-DES-CBC-SHA
249  SSL_DHE_RSA_WITH_DES_CBC_SHA            EDH-RSA-DES-CBC-SHA
250  SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA       EDH-RSA-DES-CBC3-SHA
251
252  SSL_DH_anon_EXPORT_WITH_RC4_40_MD5      EXP-ADH-RC4-MD5
253  SSL_DH_anon_WITH_RC4_128_MD5            ADH-RC4-MD5
254  SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA   EXP-ADH-DES-CBC-SHA
255  SSL_DH_anon_WITH_DES_CBC_SHA            ADH-DES-CBC-SHA
256  SSL_DH_anon_WITH_3DES_EDE_CBC_SHA       ADH-DES-CBC3-SHA
257
258  SSL_FORTEZZA_KEA_WITH_NULL_SHA          Not implemented.
259  SSL_FORTEZZA_KEA_WITH_FORTEZZA_CBC_SHA  Not implemented.
260  SSL_FORTEZZA_KEA_WITH_RC4_128_SHA       Not implemented.
261
262 =head2 TLS v1.0 cipher suites.
263
264  TLS_RSA_WITH_NULL_MD5                   NULL-MD5
265  TLS_RSA_WITH_NULL_SHA                   NULL-SHA
266  TLS_RSA_EXPORT_WITH_RC4_40_MD5          EXP-RC4-MD5
267  TLS_RSA_WITH_RC4_128_MD5                RC4-MD5
268  TLS_RSA_WITH_RC4_128_SHA                RC4-SHA
269  TLS_RSA_EXPORT_WITH_RC2_CBC_40_MD5      EXP-RC2-CBC-MD5
270  TLS_RSA_WITH_IDEA_CBC_SHA               IDEA-CBC-SHA
271  TLS_RSA_EXPORT_WITH_DES40_CBC_SHA       EXP-DES-CBC-SHA
272  TLS_RSA_WITH_DES_CBC_SHA                DES-CBC-SHA
273  TLS_RSA_WITH_3DES_EDE_CBC_SHA           DES-CBC3-SHA
274
275  TLS_DH_DSS_EXPORT_WITH_DES40_CBC_SHA    Not implemented.
276  TLS_DH_DSS_WITH_DES_CBC_SHA             Not implemented.
277  TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA        Not implemented.
278  TLS_DH_RSA_EXPORT_WITH_DES40_CBC_SHA    Not implemented.
279  TLS_DH_RSA_WITH_DES_CBC_SHA             Not implemented.
280  TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA        Not implemented.
281  TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA   EXP-EDH-DSS-DES-CBC-SHA
282  TLS_DHE_DSS_WITH_DES_CBC_SHA            EDH-DSS-CBC-SHA
283  TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA       EDH-DSS-DES-CBC3-SHA
284  TLS_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA   EXP-EDH-RSA-DES-CBC-SHA
285  TLS_DHE_RSA_WITH_DES_CBC_SHA            EDH-RSA-DES-CBC-SHA
286  TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA       EDH-RSA-DES-CBC3-SHA
287
288  TLS_DH_anon_EXPORT_WITH_RC4_40_MD5      EXP-ADH-RC4-MD5
289  TLS_DH_anon_WITH_RC4_128_MD5            ADH-RC4-MD5
290  TLS_DH_anon_EXPORT_WITH_DES40_CBC_SHA   EXP-ADH-DES-CBC-SHA
291  TLS_DH_anon_WITH_DES_CBC_SHA            ADH-DES-CBC-SHA
292  TLS_DH_anon_WITH_3DES_EDE_CBC_SHA       ADH-DES-CBC3-SHA
293
294 =head2 Additional Export 1024 and other cipher suites
295
296 Note: these ciphers can also be used in SSL v3.
297
298  TLS_RSA_EXPORT1024_WITH_DES_CBC_SHA     EXP1024-DES-CBC-SHA
299  TLS_RSA_EXPORT1024_WITH_RC4_56_SHA      EXP1024-RC4-SHA
300  TLS_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA EXP1024-DHE-DSS-DES-CBC-SHA
301  TLS_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA  EXP1024-DHE-DSS-RC4-SHA
302  TLS_DHE_DSS_WITH_RC4_128_SHA            DHE-DSS-RC4-SHA
303
304 =head2 SSL v2.0 cipher suites.
305
306  SSL_CK_RC4_128_WITH_MD5                 RC4-MD5
307  SSL_CK_RC4_128_EXPORT40_WITH_MD5        EXP-RC4-MD5
308  SSL_CK_RC2_128_CBC_WITH_MD5             RC2-MD5
309  SSL_CK_RC2_128_CBC_EXPORT40_WITH_MD5    EXP-RC2-MD5
310  SSL_CK_IDEA_128_CBC_WITH_MD5            IDEA-CBC-MD5
311  SSL_CK_DES_64_CBC_WITH_MD5              DES-CBC-MD5
312  SSL_CK_DES_192_EDE3_CBC_WITH_MD5        DES-CBC3-MD5
313
314 =head1 NOTES
315
316 The non-ephemeral DH modes are currently unimplemented in OpenSSL
317 because there is no support for DH certificates.
318
319 Some compiled versions of OpenSSL may not include all the ciphers
320 listed here because some ciphers were excluded at compile time.
321
322 =head1 EXAMPLES
323
324 Verbose listing of all OpenSSL ciphers including NULL ciphers:
325
326  openssl ciphers -v 'ALL:eNULL'
327
328 Include all ciphers except NULL and anonymous DH then sort by
329 strength:
330
331  openssl ciphers -v 'ALL:!ADH:@STRENGTH'
332
333 Include only 3DES ciphers and then place RSA ciphers last:
334
335  openssl ciphers -v '3DES:+RSA'
336
337 =head1 SEE ALSO
338
339 L<s_client(1)|s_client(1)>, L<s_server(1)|s_server(1)>, L<ssl(3)|ssl(3)>
340
341 =cut