ciphers.pod revision 68651
1284285Sjkim=pod 2110010Smarkm 3110010Smarkm=head1 NAME 4160819Ssimon 5110010Smarkmciphers - SSL cipher display and cipher list tool. 6110010Smarkm 7110010Smarkm=head1 SYNOPSIS 8110010Smarkm 9110010SmarkmB<openssl> B<ciphers> 10110010Smarkm[B<-v>] 11110010Smarkm[B<-ssl2>] 12110010Smarkm[B<-ssl3>] 13110010Smarkm[B<-tls1>] 14110010Smarkm[B<cipherlist>] 15110010Smarkm 16110010Smarkm=head1 DESCRIPTION 17110010Smarkm 18110010SmarkmThe B<cipherlist> command converts OpenSSL cipher lists into ordered 19110010SmarkmSSL cipher preference lists. It can be used as a test tool to determine 20215698Ssimonthe appropriate cipherlist. 21215698Ssimon 22215698Ssimon=head1 COMMAND OPTIONS 23215698Ssimon 24215698Ssimon=over 4 25110010Smarkm 26110010Smarkm=item B<-v> 27110010Smarkm 28110010Smarkmverbose option. List ciphers with a complete description of 29110010Smarkmprotocol version (SSLv2 or SSLv3; the latter includes TLS), key exchange, 30110010Smarkmauthentication, encryption and mac algorithms used along with any key size 31110010Smarkmrestrictions and whether the algorithm is classed as an "export" cipher. 32110010SmarkmNote that without the B<-v> option, ciphers may seem to appear twice 33110010Smarkmin a cipher list; this is when similar ciphers are available for 34110010SmarkmSSL v2 and for SSL v3/TLS v1. 35110010Smarkm 36110010Smarkm=item B<-ssl3> 37110010Smarkm 38110010Smarkmonly include SSL v3 ciphers. 39110010Smarkm 40110010Smarkm=item B<-ssl2> 41276864Sjkim 42276864Sjkimonly include SSL v2 ciphers. 43110010Smarkm 44110010Smarkm=item B<-tls1> 45215698Ssimon 46215698Ssimononly include TLS v1 ciphers. 47215698Ssimon 48215698Ssimon=item B<-h>, B<-?> 49160819Ssimon 50215698Ssimonprint a brief usage message. 51160819Ssimon 52160819Ssimon=item B<cipherlist> 53276864Sjkim 54276864Sjkima cipher list to convert to a cipher preference list. If it is not included 55276864Sjkimthen the default cipher list will be used. The format is described below. 56110010Smarkm 57276864Sjkim=back 58276864Sjkim 59276864Sjkim=head1 CIPHER LIST FORMAT 60276864Sjkim 61276864SjkimThe cipher list consists of one or more I<cipher strings> separated by colons. 62276864SjkimCommas or spaces are also acceptable separators but colons are normally used. 63215698Ssimon 64276864SjkimThe actual cipher string can take several different forms. 65276864Sjkim 66276864SjkimIt can consist of a single cipher suite such as B<RC4-SHA>. 67276864Sjkim 68276864SjkimIt can represent a list of cipher suites containing a certain algorithm, or 69215698Ssimoncipher suites of a certain type. For example B<SHA1> represents all ciphers 70276864Sjkimsuites using the digest algorithm SHA1 and B<SSLv3> represents all SSL v3 71110010Smarkmalgorithms. 72110010Smarkm 73110010SmarkmLists of cipher suites can be combined in a single cipher string using the 74110010SmarkmB<+> character. This is used as a logical B<and> operation. For example 75110010SmarkmB<SHA1+DES> represents all cipher suites containing the SHA1 B<and> the DES 76110010Smarkmalgorithms. 77110010Smarkm 78110010SmarkmEach cipher string can be optionally preceded by the characters B<!>, 79110010SmarkmB<-> or B<+>. 80110010Smarkm 81110010SmarkmIf B<!> is used then the ciphers are permanently deleted from the list. 82110010SmarkmThe ciphers deleted can never reappear in the list even if they are 83110010Smarkmexplicitly stated. 84110010Smarkm 85110010SmarkmIf B<-> is used then the ciphers are deleted from the list, but some or 86110010Smarkmall of the ciphers can be added again by later options. 87110010Smarkm 88110010SmarkmIf B<+> is used then the ciphers are moved to the end of the list. This 89110010Smarkmoption doesn't add any new ciphers it just moves matching existing ones. 90110010Smarkm 91110010SmarkmIf none of these characters is present then the string is just interpreted 92110010Smarkmas a list of ciphers to be appended to the current preference list. If the 93110010Smarkmlist includes any ciphers already present they will be ignored: that is they 94110010Smarkmwill not moved to the end of the list. 95110010Smarkm 96110010SmarkmAdditionally the cipher string B<@STRENGTH> can be used at any point to sort 97110010Smarkmthe current cipher list in order of encryption algorithm key length. 98110010Smarkm 99110010Smarkm=head1 CIPHER STRINGS 100110010Smarkm 101110010SmarkmThe following is a list of all permitted cipher strings and their meanings. 102110010Smarkm 103110010Smarkm=over 4 104110010Smarkm 105110010Smarkm=item B<DEFAULT> 106110010Smarkm 107110010Smarkmthe default cipher list. This is determined at compile time and is normally 108110010SmarkmB<ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH>. This must be the first cipher string 109110010Smarkmspecified. 110110010Smarkm 111110010Smarkm=item B<ALL> 112110010Smarkm 113110010Smarkmall ciphers suites except the B<eNULL> ciphers which must be explicitly enabled. 114110010Smarkm 115110010Smarkm=item B<HIGH> 116110010Smarkm 117110010Smarkm"high" encryption cipher suites. This currently means those with key lengths larger 118110010Smarkmthan 128 bits. 119110010Smarkm 120110010Smarkm=item B<MEDIUM> 121110010Smarkm 122110010Smarkm"medium" encryption cipher suites, currently those using 128 bit encryption. 123110010Smarkm 124110010Smarkm=item B<LOW> 125110010Smarkm 126110010Smarkm"low" encryption cipher suites, currently those using 64 or 56 bit encryption algorithms 127110010Smarkmbut excluding export cipher suites. 128110010Smarkm 129110010Smarkm=item B<EXP>, B<EXPORT> 130110010Smarkm 131110010Smarkmexport encryption algorithms. Including 40 and 56 bits algorithms. 132110010Smarkm 133160819Ssimon=item B<EXPORT40> 134110010Smarkm 135110010Smarkm40 bit export encryption algorithms 136285330Sjkim 137215698Ssimon=item B<EXPORT56> 138215698Ssimon 139215698Ssimon56 bit export encryption algorithms. 140215698Ssimon 141110010Smarkm=item B<eNULL>, B<NULL> 142160819Ssimon 143110010Smarkmthe "NULL" ciphers that is those offering no encryption. Because these offer no 144110010Smarkmencryption at all and are a security risk they are disabled unless explicitly 145110010Smarkmincluded. 146110010Smarkm 147215698Ssimon=item B<aNULL> 148110010Smarkm 149110010Smarkmthe cipher suites offering no authentication. This is currently the anonymous 150110010SmarkmDH algorithms. These cipher suites are vulnerable to a "man in the middle" 151110010Smarkmattack and so their use is normally discouraged. 152110010Smarkm 153110010Smarkm=item B<kRSA>, B<RSA> 154110010Smarkm 155110010Smarkmcipher suites using RSA key exchange. 156110010Smarkm 157110010Smarkm=item B<kEDH> 158110010Smarkm 159160819Ssimoncipher suites using ephemeral DH key agreement. 160160819Ssimon 161160819Ssimon=item B<kDHr>, B<kDHd> 162160819Ssimon 163160819Ssimoncipher suites using DH key agreement and DH certificates signed by CAs with RSA 164160819Ssimonand DSS keys respectively. Not implemented. 165160819Ssimon 166160819Ssimon=item B<aRSA> 167110010Smarkm 168110010Smarkmcipher suites using RSA authentication, i.e. the certificates carry RSA keys. 169110010Smarkm 170110010Smarkm=item B<aDSS>, B<DSS> 171110010Smarkm 172160819Ssimoncipher suites using DSS authentication, i.e. the certificates carry DSS keys. 173160819Ssimon 174=item B<aDH> 175 176cipher suites effectively using DH authentication, i.e. the certificates carry 177DH keys. Not implemented. 178 179=item B<kFZA>, B<aFZA>, B<eFZA>, B<FZA> 180 181ciphers suites using FORTEZZA key exchange, authentication, encryption or all 182FORTEZZA algorithms. Not implemented. 183 184=item B<TLSv1>, B<SSLv3>, B<SSLv2> 185 186TLS v1.0, SSL v3.0 or SSL v2.0 cipher suites respectively. 187 188=item B<DH> 189 190cipher suites using DH, including anonymous DH. 191 192=item B<ADH> 193 194anonymous DH cipher suites. 195 196=item B<3DES> 197 198cipher suites using triple DES. 199 200=item B<DES> 201 202cipher suites using DES (not triple DES). 203 204=item B<RC4> 205 206cipher suites using RC4. 207 208=item B<RC2> 209 210cipher suites using RC2. 211 212=item B<IDEA> 213 214cipher suites using IDEA. 215 216=item B<MD5> 217 218cipher suites using MD5. 219 220=item B<SHA1>, B<SHA> 221 222cipher suites using SHA1. 223 224=back 225 226=head1 CIPHER SUITE NAMES 227 228The following lists give the SSL or TLS cipher suites names from the 229relevant specification and their OpenSSL equivalents. 230 231=head2 SSL v3.0 cipher suites. 232 233 SSL_RSA_WITH_NULL_MD5 NULL-MD5 234 SSL_RSA_WITH_NULL_SHA NULL-SHA 235 SSL_RSA_EXPORT_WITH_RC4_40_MD5 EXP-RC4-MD5 236 SSL_RSA_WITH_RC4_128_MD5 RC4-MD5 237 SSL_RSA_WITH_RC4_128_SHA RC4-SHA 238 SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5 EXP-RC2-CBC-MD5 239 SSL_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA 240 SSL_RSA_EXPORT_WITH_DES40_CBC_SHA EXP-DES-CBC-SHA 241 SSL_RSA_WITH_DES_CBC_SHA DES-CBC-SHA 242 SSL_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA 243 244 SSL_DH_DSS_EXPORT_WITH_DES40_CBC_SHA Not implemented. 245 SSL_DH_DSS_WITH_DES_CBC_SHA Not implemented. 246 SSL_DH_DSS_WITH_3DES_EDE_CBC_SHA Not implemented. 247 SSL_DH_RSA_EXPORT_WITH_DES40_CBC_SHA Not implemented. 248 SSL_DH_RSA_WITH_DES_CBC_SHA Not implemented. 249 SSL_DH_RSA_WITH_3DES_EDE_CBC_SHA Not implemented. 250 SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA EXP-EDH-DSS-DES-CBC-SHA 251 SSL_DHE_DSS_WITH_DES_CBC_SHA EDH-DSS-CBC-SHA 252 SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA EDH-DSS-DES-CBC3-SHA 253 SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA EXP-EDH-RSA-DES-CBC-SHA 254 SSL_DHE_RSA_WITH_DES_CBC_SHA EDH-RSA-DES-CBC-SHA 255 SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA EDH-RSA-DES-CBC3-SHA 256 257 SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 EXP-ADH-RC4-MD5 258 SSL_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 259 SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA EXP-ADH-DES-CBC-SHA 260 SSL_DH_anon_WITH_DES_CBC_SHA ADH-DES-CBC-SHA 261 SSL_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA 262 263 SSL_FORTEZZA_KEA_WITH_NULL_SHA Not implemented. 264 SSL_FORTEZZA_KEA_WITH_FORTEZZA_CBC_SHA Not implemented. 265 SSL_FORTEZZA_KEA_WITH_RC4_128_SHA Not implemented. 266 267=head2 TLS v1.0 cipher suites. 268 269 TLS_RSA_WITH_NULL_MD5 NULL-MD5 270 TLS_RSA_WITH_NULL_SHA NULL-SHA 271 TLS_RSA_EXPORT_WITH_RC4_40_MD5 EXP-RC4-MD5 272 TLS_RSA_WITH_RC4_128_MD5 RC4-MD5 273 TLS_RSA_WITH_RC4_128_SHA RC4-SHA 274 TLS_RSA_EXPORT_WITH_RC2_CBC_40_MD5 EXP-RC2-CBC-MD5 275 TLS_RSA_WITH_IDEA_CBC_SHA IDEA-CBC-SHA 276 TLS_RSA_EXPORT_WITH_DES40_CBC_SHA EXP-DES-CBC-SHA 277 TLS_RSA_WITH_DES_CBC_SHA DES-CBC-SHA 278 TLS_RSA_WITH_3DES_EDE_CBC_SHA DES-CBC3-SHA 279 280 TLS_DH_DSS_EXPORT_WITH_DES40_CBC_SHA Not implemented. 281 TLS_DH_DSS_WITH_DES_CBC_SHA Not implemented. 282 TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA Not implemented. 283 TLS_DH_RSA_EXPORT_WITH_DES40_CBC_SHA Not implemented. 284 TLS_DH_RSA_WITH_DES_CBC_SHA Not implemented. 285 TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA Not implemented. 286 TLS_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA EXP-EDH-DSS-DES-CBC-SHA 287 TLS_DHE_DSS_WITH_DES_CBC_SHA EDH-DSS-CBC-SHA 288 TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA EDH-DSS-DES-CBC3-SHA 289 TLS_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA EXP-EDH-RSA-DES-CBC-SHA 290 TLS_DHE_RSA_WITH_DES_CBC_SHA EDH-RSA-DES-CBC-SHA 291 TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA EDH-RSA-DES-CBC3-SHA 292 293 TLS_DH_anon_EXPORT_WITH_RC4_40_MD5 EXP-ADH-RC4-MD5 294 TLS_DH_anon_WITH_RC4_128_MD5 ADH-RC4-MD5 295 TLS_DH_anon_EXPORT_WITH_DES40_CBC_SHA EXP-ADH-DES-CBC-SHA 296 TLS_DH_anon_WITH_DES_CBC_SHA ADH-DES-CBC-SHA 297 TLS_DH_anon_WITH_3DES_EDE_CBC_SHA ADH-DES-CBC3-SHA 298 299=head2 Additional Export 1024 and other cipher suites 300 301Note: these ciphers can also be used in SSL v3. 302 303 TLS_RSA_EXPORT1024_WITH_DES_CBC_SHA EXP1024-DES-CBC-SHA 304 TLS_RSA_EXPORT1024_WITH_RC4_56_SHA EXP1024-RC4-SHA 305 TLS_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA EXP1024-DHE-DSS-DES-CBC-SHA 306 TLS_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA EXP1024-DHE-DSS-RC4-SHA 307 TLS_DHE_DSS_WITH_RC4_128_SHA DHE-DSS-RC4-SHA 308 309=head2 SSL v2.0 cipher suites. 310 311 SSL_CK_RC4_128_WITH_MD5 RC4-MD5 312 SSL_CK_RC4_128_EXPORT40_WITH_MD5 EXP-RC4-MD5 313 SSL_CK_RC2_128_CBC_WITH_MD5 RC2-MD5 314 SSL_CK_RC2_128_CBC_EXPORT40_WITH_MD5 EXP-RC2-MD5 315 SSL_CK_IDEA_128_CBC_WITH_MD5 IDEA-CBC-MD5 316 SSL_CK_DES_64_CBC_WITH_MD5 DES-CBC-MD5 317 SSL_CK_DES_192_EDE3_CBC_WITH_MD5 DES-CBC3-MD5 318 319=head1 NOTES 320 321The non-ephemeral DH modes are currently unimplemented in OpenSSL 322because there is no support for DH certificates. 323 324Some compiled versions of OpenSSL may not include all the ciphers 325listed here because some ciphers were excluded at compile time. 326 327=head1 EXAMPLES 328 329Verbose listing of all OpenSSL ciphers including NULL ciphers: 330 331 openssl ciphers -v 'ALL:eNULL' 332 333Include all ciphers except NULL and anonymous DH then sort by 334strength: 335 336 openssl ciphers -v 'ALL:!ADH:@STRENGTH' 337 338Include only 3DES ciphers and then place RSA ciphers last: 339 340 openssl ciphers -v '3DES:+RSA' 341 342=head1 SEE ALSO 343 344L<s_client(1)|s_client(1)>, L<s_server(1)|s_server(1)>, L<ssl(3)|ssl(3)> 345 346=cut 347