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