First public contribution.
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
59 * Redistribution and use in source and binary forms, with or without
60 * modification, are permitted provided that the following conditions
63 * 1. Redistributions of source code must retain the above copyright
64 * notice, this list of conditions and the following disclaimer.
66 * 2. Redistributions in binary form must reproduce the above copyright
67 * notice, this list of conditions and the following disclaimer in
68 * the documentation and/or other materials provided with the
71 * 3. All advertising materials mentioning features or use of this
72 * software must display the following acknowledgment:
73 * "This product includes software developed by the OpenSSL Project
74 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
77 * endorse or promote products derived from this software without
78 * prior written permission. For written permission, please contact
79 * openssl-core@openssl.org.
81 * 5. Products derived from this software may not be called "OpenSSL"
82 * nor may "OpenSSL" appear in their names without prior written
83 * permission of the OpenSSL Project.
85 * 6. Redistributions of any form whatsoever must retain the following
87 * "This product includes software developed by the OpenSSL Project
88 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
91 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
92 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
93 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
94 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
95 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
96 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
97 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
98 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
99 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
100 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
101 * OF THE POSSIBILITY OF SUCH DAMAGE.
102 * ====================================================================
104 * This product includes cryptographic software written by Eric Young
105 * (eay@cryptsoft.com). This product includes software written by Tim
106 * Hudson (tjh@cryptsoft.com).
109 /* ====================================================================
111 /* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113 * ECC cipher suite support in OpenSSL originally developed by
114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
117 © Portions copyright (c) 2006 Nokia Corporation. All rights reserved.
121 #include <openssl/objects.h>
122 #include <openssl/comp.h>
123 #include "ssl_locl.h"
125 #define SSL_ENC_DES_IDX 0
126 #define SSL_ENC_3DES_IDX 1
127 #define SSL_ENC_RC4_IDX 2
128 #define SSL_ENC_RC2_IDX 3
129 #define SSL_ENC_IDEA_IDX 4
130 #define SSL_ENC_eFZA_IDX 5
131 #define SSL_ENC_NULL_IDX 6
132 #define SSL_ENC_AES128_IDX 7
133 #define SSL_ENC_AES256_IDX 8
134 #define SSL_ENC_NUM_IDX 9
137 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX]={
138 NULL,NULL,NULL,NULL,NULL,NULL,
141 GET_STATIC_ARRAY_FROM_TLS(ssl_cipher_methods,ssl_ciph,const EVP_CIPHER *)
143 #define ssl_cipher_methods (GET_WSD_VAR_NAME(ssl_cipher_methods,ssl_ciph,s)())
146 #define SSL_COMP_NULL_IDX 0
147 #define SSL_COMP_ZLIB_IDX 1
148 #define SSL_COMP_NUM_IDX 2
151 static STACK_OF(SSL_COMP) *ssl_comp_methods=NULL;
153 GET_STATIC_VAR_FROM_TLS(ssl_comp_methods,ssl_ciph,STACK_OF(SSL_COMP) *)
155 #define ssl_comp_methods (*GET_WSD_VAR_NAME(ssl_comp_methods,ssl_ciph,s)())
158 #define SSL_MD_MD5_IDX 0
159 #define SSL_MD_SHA1_IDX 1
160 #define SSL_MD_NUM_IDX 2
162 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX]={
166 GET_STATIC_ARRAY_FROM_TLS(ssl_digest_methods,ssl_ciph,const EVP_MD *)
168 #define ssl_digest_methods (GET_WSD_VAR_NAME(ssl_digest_methods,ssl_ciph,s)())
171 #define CIPHER_KILL 2
174 #define CIPHER_SPECIAL 5
176 typedef struct cipher_order_st
181 struct cipher_order_st *next,*prev;
184 static const SSL_CIPHER cipher_aliases[]={
185 /* Don't include eNULL unless specifically enabled. */
186 /* Don't include ECC in ALL because these ciphers are not yet official. */
187 {0,SSL_TXT_ALL, 0,SSL_ALL & ~SSL_eNULL & ~SSL_kECDH & ~SSL_kECDHE, SSL_ALL ,0,0,0,SSL_ALL,SSL_ALL}, /* must be first */
188 /* TODO: COMPLEMENT OF ALL and COMPLEMENT OF DEFAULT do not have ECC cipher suites handled properly. */
189 {0,SSL_TXT_CMPALL,0,SSL_eNULL,0,0,0,0,SSL_ENC_MASK,0}, /* COMPLEMENT OF ALL */
190 {0,SSL_TXT_CMPDEF,0,SSL_ADH, 0,0,0,0,SSL_AUTH_MASK,0},
191 {0,SSL_TXT_kKRB5,0,SSL_kKRB5,0,0,0,0,SSL_MKEY_MASK,0}, /* VRS Kerberos5 */
192 {0,SSL_TXT_kRSA,0,SSL_kRSA, 0,0,0,0,SSL_MKEY_MASK,0},
193 {0,SSL_TXT_kDHr,0,SSL_kDHr, 0,0,0,0,SSL_MKEY_MASK,0},
194 {0,SSL_TXT_kDHd,0,SSL_kDHd, 0,0,0,0,SSL_MKEY_MASK,0},
195 {0,SSL_TXT_kEDH,0,SSL_kEDH, 0,0,0,0,SSL_MKEY_MASK,0},
196 {0,SSL_TXT_kFZA,0,SSL_kFZA, 0,0,0,0,SSL_MKEY_MASK,0},
197 {0,SSL_TXT_DH, 0,SSL_DH, 0,0,0,0,SSL_MKEY_MASK,0},
198 {0,SSL_TXT_ECC, 0,(SSL_kECDH|SSL_kECDHE), 0,0,0,0,SSL_MKEY_MASK,0},
199 {0,SSL_TXT_EDH, 0,SSL_EDH, 0,0,0,0,SSL_MKEY_MASK|SSL_AUTH_MASK,0},
200 {0,SSL_TXT_aKRB5,0,SSL_aKRB5,0,0,0,0,SSL_AUTH_MASK,0}, /* VRS Kerberos5 */
201 {0,SSL_TXT_aRSA,0,SSL_aRSA, 0,0,0,0,SSL_AUTH_MASK,0},
202 {0,SSL_TXT_aDSS,0,SSL_aDSS, 0,0,0,0,SSL_AUTH_MASK,0},
203 {0,SSL_TXT_aFZA,0,SSL_aFZA, 0,0,0,0,SSL_AUTH_MASK,0},
204 {0,SSL_TXT_aNULL,0,SSL_aNULL,0,0,0,0,SSL_AUTH_MASK,0},
205 {0,SSL_TXT_aDH, 0,SSL_aDH, 0,0,0,0,SSL_AUTH_MASK,0},
206 {0,SSL_TXT_DSS, 0,SSL_DSS, 0,0,0,0,SSL_AUTH_MASK,0},
208 {0,SSL_TXT_DES, 0,SSL_DES, 0,0,0,0,SSL_ENC_MASK,0},
209 {0,SSL_TXT_3DES,0,SSL_3DES, 0,0,0,0,SSL_ENC_MASK,0},
210 {0,SSL_TXT_RC4, 0,SSL_RC4, 0,0,0,0,SSL_ENC_MASK,0},
211 {0,SSL_TXT_RC2, 0,SSL_RC2, 0,0,0,0,SSL_ENC_MASK,0},
212 #ifndef OPENSSL_NO_IDEA
213 {0,SSL_TXT_IDEA,0,SSL_IDEA, 0,0,0,0,SSL_ENC_MASK,0},
215 {0,SSL_TXT_eNULL,0,SSL_eNULL,0,0,0,0,SSL_ENC_MASK,0},
216 {0,SSL_TXT_eFZA,0,SSL_eFZA, 0,0,0,0,SSL_ENC_MASK,0},
217 {0,SSL_TXT_AES, 0,SSL_AES, 0,0,0,0,SSL_ENC_MASK,0},
219 {0,SSL_TXT_MD5, 0,SSL_MD5, 0,0,0,0,SSL_MAC_MASK,0},
220 {0,SSL_TXT_SHA1,0,SSL_SHA1, 0,0,0,0,SSL_MAC_MASK,0},
221 {0,SSL_TXT_SHA, 0,SSL_SHA, 0,0,0,0,SSL_MAC_MASK,0},
223 {0,SSL_TXT_NULL,0,SSL_NULL, 0,0,0,0,SSL_ENC_MASK,0},
224 {0,SSL_TXT_KRB5,0,SSL_KRB5, 0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
225 {0,SSL_TXT_RSA, 0,SSL_RSA, 0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
226 {0,SSL_TXT_ADH, 0,SSL_ADH, 0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
227 {0,SSL_TXT_FZA, 0,SSL_FZA, 0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK|SSL_ENC_MASK,0},
229 {0,SSL_TXT_SSLV2, 0,SSL_SSLV2, 0,0,0,0,SSL_SSL_MASK,0},
230 {0,SSL_TXT_SSLV3, 0,SSL_SSLV3, 0,0,0,0,SSL_SSL_MASK,0},
231 {0,SSL_TXT_TLSV1, 0,SSL_TLSV1, 0,0,0,0,SSL_SSL_MASK,0},
233 {0,SSL_TXT_EXP ,0, 0,SSL_EXPORT, 0,0,0,0,SSL_EXP_MASK},
234 {0,SSL_TXT_EXPORT,0, 0,SSL_EXPORT, 0,0,0,0,SSL_EXP_MASK},
235 {0,SSL_TXT_EXP40, 0, 0, SSL_EXP40, 0,0,0,0,SSL_STRONG_MASK},
236 {0,SSL_TXT_EXP56, 0, 0, SSL_EXP56, 0,0,0,0,SSL_STRONG_MASK},
237 {0,SSL_TXT_LOW, 0, 0, SSL_LOW, 0,0,0,0,SSL_STRONG_MASK},
238 {0,SSL_TXT_MEDIUM,0, 0,SSL_MEDIUM, 0,0,0,0,SSL_STRONG_MASK},
239 {0,SSL_TXT_HIGH, 0, 0, SSL_HIGH, 0,0,0,0,SSL_STRONG_MASK},
242 void ssl_load_ciphers(void)
244 ssl_cipher_methods[SSL_ENC_DES_IDX]=
245 EVP_get_cipherbyname(SN_des_cbc);
246 ssl_cipher_methods[SSL_ENC_3DES_IDX]=
247 EVP_get_cipherbyname(SN_des_ede3_cbc);
248 ssl_cipher_methods[SSL_ENC_RC4_IDX]=
249 EVP_get_cipherbyname(SN_rc4);
250 ssl_cipher_methods[SSL_ENC_RC2_IDX]=
251 EVP_get_cipherbyname(SN_rc2_cbc);
252 #ifndef OPENSSL_NO_IDEA
253 ssl_cipher_methods[SSL_ENC_IDEA_IDX]=
254 EVP_get_cipherbyname(SN_idea_cbc);
256 ssl_cipher_methods[SSL_ENC_IDEA_IDX]= NULL;
258 ssl_cipher_methods[SSL_ENC_AES128_IDX]=
259 EVP_get_cipherbyname(SN_aes_128_cbc);
260 ssl_cipher_methods[SSL_ENC_AES256_IDX]=
261 EVP_get_cipherbyname(SN_aes_256_cbc);
263 ssl_digest_methods[SSL_MD_MD5_IDX]=
264 EVP_get_digestbyname(SN_md5);
265 ssl_digest_methods[SSL_MD_SHA1_IDX]=
266 EVP_get_digestbyname(SN_sha1);
270 #ifndef OPENSSL_NO_COMP
272 static int sk_comp_cmp(const SSL_COMP * const *a,
273 const SSL_COMP * const *b)
275 return((*a)->id-(*b)->id);
278 static void load_builtin_compressions(void)
280 int got_write_lock = 0;
282 CRYPTO_r_lock(CRYPTO_LOCK_SSL);
283 if (ssl_comp_methods == NULL)
285 CRYPTO_r_unlock(CRYPTO_LOCK_SSL);
286 CRYPTO_w_lock(CRYPTO_LOCK_SSL);
289 if (ssl_comp_methods == NULL)
291 SSL_COMP *comp = NULL;
294 ssl_comp_methods=sk_SSL_COMP_new(sk_comp_cmp);
295 if (ssl_comp_methods != NULL)
297 comp=(SSL_COMP *)OPENSSL_malloc(sizeof(SSL_COMP));
300 comp->method=COMP_zlib();
302 && comp->method->type == NID_undef)
306 comp->id=SSL_COMP_ZLIB_IDX;
307 comp->name=comp->method->name;
308 sk_SSL_COMP_push(ssl_comp_methods,comp);
317 CRYPTO_w_unlock(CRYPTO_LOCK_SSL);
319 CRYPTO_r_unlock(CRYPTO_LOCK_SSL);
323 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
324 const EVP_MD **md, SSL_COMP **comp)
330 if (c == NULL) return(0);
334 #ifndef OPENSSL_NO_COMP
335 load_builtin_compressions();
339 ctmp.id=s->compress_meth;
340 if (ssl_comp_methods != NULL)
342 i=sk_SSL_COMP_find(ssl_comp_methods,&ctmp);
344 *comp=sk_SSL_COMP_value(ssl_comp_methods,i);
350 if ((enc == NULL) || (md == NULL)) return(0);
352 switch (c->algorithms & SSL_ENC_MASK)
375 case 128: i=SSL_ENC_AES128_IDX; break;
376 case 256: i=SSL_ENC_AES256_IDX; break;
377 default: i=-1; break;
385 if ((i < 0) || (i > SSL_ENC_NUM_IDX))
389 if (i == SSL_ENC_NULL_IDX)
392 *enc=ssl_cipher_methods[i];
395 switch (c->algorithms & SSL_MAC_MASK)
407 if ((i < 0) || (i > SSL_MD_NUM_IDX))
410 *md=ssl_digest_methods[i];
412 if ((*enc != NULL) && (*md != NULL))
418 #define ITEM_SEP(a) \
419 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
421 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
424 if (curr == *tail) return;
427 if (curr->prev != NULL)
428 curr->prev->next=curr->next;
429 if (curr->next != NULL) /* should always be true */
430 curr->next->prev=curr->prev;
437 static unsigned long ssl_cipher_get_disabled(void)
442 #ifdef OPENSSL_NO_RSA
443 mask |= SSL_aRSA|SSL_kRSA;
445 #ifdef OPENSSL_NO_DSA
449 mask |= SSL_kDHr|SSL_kDHd|SSL_kEDH|SSL_aDH;
451 #ifdef OPENSSL_NO_KRB5
452 mask |= SSL_kKRB5|SSL_aKRB5;
454 #ifdef OPENSSL_NO_ECDH
455 mask |= SSL_kECDH|SSL_kECDHE;
457 #ifdef SSL_FORBID_ENULL
461 mask |= (ssl_cipher_methods[SSL_ENC_DES_IDX ] == NULL) ? SSL_DES :0;
462 mask |= (ssl_cipher_methods[SSL_ENC_3DES_IDX] == NULL) ? SSL_3DES:0;
463 mask |= (ssl_cipher_methods[SSL_ENC_RC4_IDX ] == NULL) ? SSL_RC4 :0;
464 mask |= (ssl_cipher_methods[SSL_ENC_RC2_IDX ] == NULL) ? SSL_RC2 :0;
465 mask |= (ssl_cipher_methods[SSL_ENC_IDEA_IDX] == NULL) ? SSL_IDEA:0;
466 mask |= (ssl_cipher_methods[SSL_ENC_eFZA_IDX] == NULL) ? SSL_eFZA:0;
467 mask |= (ssl_cipher_methods[SSL_ENC_AES128_IDX] == NULL) ? SSL_AES:0;
469 mask |= (ssl_digest_methods[SSL_MD_MD5_IDX ] == NULL) ? SSL_MD5 :0;
470 mask |= (ssl_digest_methods[SSL_MD_SHA1_IDX] == NULL) ? SSL_SHA1:0;
475 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
476 int num_of_ciphers, unsigned long mask, CIPHER_ORDER *co_list,
477 CIPHER_ORDER **head_p, CIPHER_ORDER **tail_p)
483 * We have num_of_ciphers descriptions compiled in, depending on the
484 * method selected (SSLv2 and/or SSLv3, TLSv1 etc).
485 * These will later be sorted in a linked list with at most num
489 /* Get the initial list of ciphers */
490 co_list_num = 0; /* actual count of ciphers */
491 for (i = 0; i < num_of_ciphers; i++)
493 c = ssl_method->get_cipher(i);
494 /* drop those that use any of that is not available */
495 if ((c != NULL) && c->valid && !(c->algorithms & mask))
497 co_list[co_list_num].cipher = c;
498 co_list[co_list_num].next = NULL;
499 co_list[co_list_num].prev = NULL;
500 co_list[co_list_num].active = 0;
503 printf("\t%d: %s %lx %lx\n",i,c->name,c->id,c->algorithms);
504 #endif /* KSSL_DEBUG */
506 if (!sk_push(ca_list,(char *)c)) goto err;
512 * Prepare linked list from list entries
514 for (i = 1; i < co_list_num - 1; i++)
516 co_list[i].prev = &(co_list[i-1]);
517 co_list[i].next = &(co_list[i+1]);
521 (*head_p) = &(co_list[0]);
522 (*head_p)->prev = NULL;
523 (*head_p)->next = &(co_list[1]);
524 (*tail_p) = &(co_list[co_list_num - 1]);
525 (*tail_p)->prev = &(co_list[co_list_num - 2]);
526 (*tail_p)->next = NULL;
530 static void ssl_cipher_collect_aliases(SSL_CIPHER **ca_list,
531 int num_of_group_aliases, unsigned long mask,
534 CIPHER_ORDER *ciph_curr;
535 SSL_CIPHER **ca_curr;
539 * First, add the real ciphers as already collected
543 while (ciph_curr != NULL)
545 *ca_curr = ciph_curr->cipher;
547 ciph_curr = ciph_curr->next;
551 * Now we add the available ones from the cipher_aliases[] table.
552 * They represent either an algorithm, that must be fully
553 * supported (not match any bit in mask) or represent a cipher
554 * strength value (will be added in any case because algorithms=0).
556 for (i = 0; i < num_of_group_aliases; i++)
558 if ((i == 0) || /* always fetch "ALL" */
559 !(cipher_aliases[i].algorithms & mask))
561 *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
566 *ca_curr = NULL; /* end of list */
569 static void ssl_cipher_apply_rule(unsigned long cipher_id, unsigned long ssl_version,
570 unsigned long algorithms, unsigned long mask,
571 unsigned long algo_strength, unsigned long mask_strength,
572 int rule, int strength_bits, CIPHER_ORDER *co_list,
573 CIPHER_ORDER **head_p, CIPHER_ORDER **tail_p)
575 CIPHER_ORDER *head, *tail, *curr, *curr2, *tail2;
577 unsigned long ma, ma_s;
580 printf("Applying rule %d with %08lx %08lx %08lx %08lx (%d)\n",
581 rule, algorithms, mask, algo_strength, mask_strength,
585 curr = head = *head_p;
587 tail2 = tail = *tail_p;
590 if ((curr == NULL) || (curr == tail2)) break;
596 /* If explicit cipher suite, match only that one for its own protocol version.
597 * Usual selection criteria will be used for similar ciphersuites from other version! */
599 if (cipher_id && (cp->algorithms & SSL_SSL_MASK) == ssl_version)
601 if (cp->id != cipher_id)
606 * Selection criteria is either the number of strength_bits
607 * or the algorithm used.
609 else if (strength_bits == -1)
611 ma = mask & cp->algorithms;
612 ma_s = mask_strength & cp->algo_strength;
615 printf("\nName: %s:\nAlgo = %08lx Algo_strength = %08lx\nMask = %08lx Mask_strength %08lx\n", cp->name, cp->algorithms, cp->algo_strength, mask, mask_strength);
616 printf("ma = %08lx ma_s %08lx, ma&algo=%08lx, ma_s&algos=%08lx\n", ma, ma_s, ma&algorithms, ma_s&algo_strength);
619 * Select: if none of the mask bit was met from the
620 * cipher or not all of the bits were met, the
621 * selection does not apply.
623 if (((ma == 0) && (ma_s == 0)) ||
624 ((ma & algorithms) != ma) ||
625 ((ma_s & algo_strength) != ma_s))
626 continue; /* does not apply */
628 else if (strength_bits != cp->strength_bits)
629 continue; /* does not apply */
632 printf("Action = %d\n", rule);
635 /* add the cipher if it has not been added yet. */
636 if (rule == CIPHER_ADD)
640 int add_this_cipher = 1;
642 if (((cp->algorithms & (SSL_kECDHE|SSL_kECDH|SSL_aECDSA)) != 0))
644 /* Make sure "ECCdraft" ciphersuites are activated only if
645 * *explicitly* requested, but not implicitly (such as
646 * as part of the "AES" alias). */
648 add_this_cipher = (mask & (SSL_kECDHE|SSL_kECDH|SSL_aECDSA)) != 0 || cipher_id != 0;
653 ll_append_tail(&head, curr, &tail);
658 /* Move the added cipher to this location */
659 else if (rule == CIPHER_ORD)
663 ll_append_tail(&head, curr, &tail);
666 else if (rule == CIPHER_DEL)
668 else if (rule == CIPHER_KILL)
673 curr->prev->next = curr->next;
677 if (curr->next != NULL)
678 curr->next->prev = curr->prev;
679 if (curr->prev != NULL)
680 curr->prev->next = curr->next;
690 static int ssl_cipher_strength_sort(CIPHER_ORDER *co_list,
691 CIPHER_ORDER **head_p,
692 CIPHER_ORDER **tail_p)
694 int max_strength_bits, i, *number_uses;
698 * This routine sorts the ciphers with descending strength. The sorting
699 * must keep the pre-sorted sequence, so we apply the normal sorting
700 * routine as '+' movement to the end of the list.
702 max_strength_bits = 0;
707 (curr->cipher->strength_bits > max_strength_bits))
708 max_strength_bits = curr->cipher->strength_bits;
712 number_uses = OPENSSL_malloc((max_strength_bits + 1) * sizeof(int));
715 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT,ERR_R_MALLOC_FAILURE);
718 memset(number_uses, 0, (max_strength_bits + 1) * sizeof(int));
721 * Now find the strength_bits values actually used
727 number_uses[curr->cipher->strength_bits]++;
731 * Go through the list of used strength_bits values in descending
734 for (i = max_strength_bits; i >= 0; i--)
735 if (number_uses[i] > 0)
736 ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, CIPHER_ORD, i,
737 co_list, head_p, tail_p);
739 OPENSSL_free(number_uses);
743 static int ssl_cipher_process_rulestr(const char *rule_str,
744 CIPHER_ORDER *co_list, CIPHER_ORDER **head_p,
745 CIPHER_ORDER **tail_p, SSL_CIPHER **ca_list)
747 unsigned long algorithms, mask, algo_strength, mask_strength;
748 const char *l, *start, *buf;
749 int j, multi, found, rule, retval, ok, buflen;
750 unsigned long cipher_id = 0, ssl_version = 0;
762 { rule = CIPHER_DEL; l++; }
764 { rule = CIPHER_ORD; l++; }
766 { rule = CIPHER_KILL; l++; }
768 { rule = CIPHER_SPECIAL; l++; }
770 { rule = CIPHER_ADD; }
778 algorithms = mask = algo_strength = mask_strength = 0;
786 #ifndef CHARSET_EBCDIC
787 while ( ((ch >= 'A') && (ch <= 'Z')) ||
788 ((ch >= '0') && (ch <= '9')) ||
789 ((ch >= 'a') && (ch <= 'z')) ||
792 while ( isalnum(ch) || (ch == '-'))
802 * We hit something we cannot deal with,
803 * it is no command or separator nor
804 * alphanumeric, so we call this an error.
806 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
807 SSL_R_INVALID_COMMAND);
813 if (rule == CIPHER_SPECIAL)
815 found = 0; /* unused -- avoid compiler warning */
816 break; /* special treatment */
819 /* check for multi-part specification */
829 * Now search for the cipher alias in the ca_list. Be careful
830 * with the strncmp, because the "buflen" limitation
831 * will make the rule "ADH:SOME" and the cipher
832 * "ADH-MY-CIPHER" look like a match for buflen=3.
833 * So additionally check whether the cipher name found
834 * has the correct length. We can save a strlen() call:
835 * just checking for the '\0' at the right place is
836 * sufficient, we have to strncmp() anyway. (We cannot
837 * use strcmp(), because buf is not '\0' terminated.)
845 if (!strncmp(buf, ca_list[j]->name, buflen) &&
846 (ca_list[j]->name[buflen] == '\0'))
855 break; /* ignore this entry */
858 * 1 - any old restrictions apply outside new mask
859 * 2 - any new restrictions apply outside old mask
860 * 3 - enforce old & new where masks intersect
862 algorithms = (algorithms & ~ca_list[j]->mask) | /* 1 */
863 (ca_list[j]->algorithms & ~mask) | /* 2 */
864 (algorithms & ca_list[j]->algorithms); /* 3 */
865 mask |= ca_list[j]->mask;
866 algo_strength = (algo_strength & ~ca_list[j]->mask_strength) |
867 (ca_list[j]->algo_strength & ~mask_strength) |
868 (algo_strength & ca_list[j]->algo_strength);
869 mask_strength |= ca_list[j]->mask_strength;
871 /* explicit ciphersuite found */
872 if (ca_list[j]->valid)
874 cipher_id = ca_list[j]->id;
875 ssl_version = ca_list[j]->algorithms & SSL_SSL_MASK;
883 * Ok, we have the rule, now apply it
885 if (rule == CIPHER_SPECIAL)
886 { /* special command */
889 !strncmp(buf, "STRENGTH", 8))
890 ok = ssl_cipher_strength_sort(co_list,
893 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
894 SSL_R_INVALID_COMMAND);
898 * We do not support any "multi" options
899 * together with "@", so throw away the
900 * rest of the command, if any left, until
901 * end or ':' is found.
903 while ((*l != '\0') && !ITEM_SEP(*l))
908 ssl_cipher_apply_rule(cipher_id, ssl_version, algorithms, mask,
909 algo_strength, mask_strength, rule, -1,
910 co_list, head_p, tail_p);
914 while ((*l != '\0') && !ITEM_SEP(*l))
917 if (*l == '\0') break; /* done */
923 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
924 STACK_OF(SSL_CIPHER) **cipher_list,
925 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
926 const char *rule_str)
928 int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
929 unsigned long disabled_mask;
930 STACK_OF(SSL_CIPHER) *cipherstack, *tmp_cipher_list;
932 CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
933 SSL_CIPHER **ca_list = NULL;
936 * Return with error if nothing to do.
938 if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
942 * To reduce the work to do we only want to process the compiled
943 * in algorithms, so we first get the mask of disabled ciphers.
945 disabled_mask = ssl_cipher_get_disabled();
948 * Now we have to collect the available ciphers from the compiled
949 * in ciphers. We cannot get more than the number compiled in, so
950 * it is used for allocation.
952 num_of_ciphers = ssl_method->num_ciphers();
954 printf("ssl_create_cipher_list() for %d ciphers\n", num_of_ciphers);
955 #endif /* KSSL_DEBUG */
956 co_list = (CIPHER_ORDER *)OPENSSL_malloc(sizeof(CIPHER_ORDER) * num_of_ciphers);
959 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST,ERR_R_MALLOC_FAILURE);
960 return(NULL); /* Failure */
963 ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers, disabled_mask,
964 co_list, &head, &tail);
967 * We also need cipher aliases for selecting based on the rule_str.
968 * There might be two types of entries in the rule_str: 1) names
969 * of ciphers themselves 2) aliases for groups of ciphers.
970 * For 1) we need the available ciphers and for 2) the cipher
971 * groups of cipher_aliases added together in one list (otherwise
972 * we would be happy with just the cipher_aliases table).
974 num_of_group_aliases = sizeof(cipher_aliases) / sizeof(SSL_CIPHER);
975 num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
977 (SSL_CIPHER **)OPENSSL_malloc(sizeof(SSL_CIPHER *) * num_of_alias_max);
980 OPENSSL_free(co_list);
981 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST,ERR_R_MALLOC_FAILURE);
982 return(NULL); /* Failure */
984 ssl_cipher_collect_aliases(ca_list, num_of_group_aliases, disabled_mask,
988 * If the rule_string begins with DEFAULT, apply the default rule
989 * before using the (possibly available) additional rules.
993 if (strncmp(rule_str,"DEFAULT",7) == 0)
995 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
996 co_list, &head, &tail, ca_list);
1002 if (ok && (strlen(rule_p) > 0))
1003 ok = ssl_cipher_process_rulestr(rule_p, co_list, &head, &tail,
1006 OPENSSL_free(ca_list); /* Not needed anymore */
1009 { /* Rule processing failure */
1010 OPENSSL_free(co_list);
1014 * Allocate new "cipherstack" for the result, return with error
1015 * if we cannot get one.
1017 if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL)
1019 OPENSSL_free(co_list);
1024 * The cipher selection for the list is done. The ciphers are added
1025 * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1027 for (curr = head; curr != NULL; curr = curr->next)
1031 sk_SSL_CIPHER_push(cipherstack, curr->cipher);
1033 printf("<%s>\n",curr->cipher->name);
1037 OPENSSL_free(co_list); /* Not needed any longer */
1039 tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1040 if (tmp_cipher_list == NULL)
1042 sk_SSL_CIPHER_free(cipherstack);
1045 if (*cipher_list != NULL)
1046 sk_SSL_CIPHER_free(*cipher_list);
1047 *cipher_list = cipherstack;
1048 if (*cipher_list_by_id != NULL)
1049 sk_SSL_CIPHER_free(*cipher_list_by_id);
1050 *cipher_list_by_id = tmp_cipher_list;
1051 (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id,ssl_cipher_ptr_id_cmp);
1053 return(cipherstack);
1056 EXPORT_C char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int len)
1058 int is_export,pkl,kl;
1059 const char *ver,*exp_str;
1060 const char *kx,*au,*enc,*mac;
1061 unsigned long alg,alg2,alg_s;
1064 static const char *format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s AL=%lx\n";
1066 static const char *format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s\n";
1067 #endif /* KSSL_DEBUG */
1068 #else /* EMULATOR */
1070 static const char *const format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s AL=%lx\n";
1072 static const char *const format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s\n";
1073 #endif /* KSSL_DEBUG */
1075 #endif /* EMULATOR */
1076 alg=cipher->algorithms;
1077 alg_s=cipher->algo_strength;
1078 alg2=cipher->algorithm2;
1080 is_export=SSL_C_IS_EXPORT(cipher);
1081 pkl=SSL_C_EXPORT_PKEYLENGTH(cipher);
1082 kl=SSL_C_EXPORT_KEYLENGTH(cipher);
1083 exp_str=is_export?" export":"";
1085 if (alg & SSL_SSLV2)
1087 else if (alg & SSL_SSLV3)
1092 switch (alg&SSL_MKEY_MASK)
1095 kx=is_export?(pkl == 512 ? "RSA(512)" : "RSA(1024)"):"RSA";
1103 case SSL_kKRB5: /* VRS */
1104 case SSL_KRB5: /* VRS */
1111 kx=is_export?(pkl == 512 ? "DH(512)" : "DH(1024)"):"DH";
1115 kx=is_export?"ECDH(<=163)":"ECDH";
1121 switch (alg&SSL_AUTH_MASK)
1132 case SSL_aKRB5: /* VRS */
1133 case SSL_KRB5: /* VRS */
1148 switch (alg&SSL_ENC_MASK)
1151 enc=(is_export && kl == 5)?"DES(40)":"DES(56)";
1157 enc=is_export?(kl == 5 ? "RC4(40)" : "RC4(56)")
1158 :((alg2&SSL2_CF_8_BYTE_ENC)?"RC4(64)":"RC4(128)");
1161 enc=is_export?(kl == 5 ? "RC2(40)" : "RC2(56)"):"RC2(128)";
1173 switch(cipher->strength_bits)
1175 case 128: enc="AES(128)"; break;
1176 case 192: enc="AES(192)"; break;
1177 case 256: enc="AES(256)"; break;
1178 default: enc="AES(?""?""?)"; break;
1186 switch (alg&SSL_MAC_MASK)
1202 buf=OPENSSL_malloc(len);
1203 if (buf == NULL) return("OPENSSL_malloc Error");
1206 return("Buffer too small");
1209 BIO_snprintf(buf,len,format,cipher->name,ver,kx,au,enc,mac,exp_str,alg);
1211 BIO_snprintf(buf,len,format,cipher->name,ver,kx,au,enc,mac,exp_str);
1212 #endif /* KSSL_DEBUG */
1216 EXPORT_C char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1220 if (c == NULL) return("(NONE)");
1221 i=(int)(c->id>>24L);
1223 return("TLSv1/SSLv3");
1230 /* return the actual cipher being used */
1231 EXPORT_C const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1238 /* number of bits for symmetric cipher */
1239 EXPORT_C int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1245 if (alg_bits != NULL) *alg_bits = c->alg_bits;
1246 ret = c->strength_bits;
1251 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1256 if ((n == 0) || (sk == NULL)) return(NULL);
1257 nn=sk_SSL_COMP_num(sk);
1258 for (i=0; i<nn; i++)
1260 ctmp=sk_SSL_COMP_value(sk,i);
1267 #ifdef OPENSSL_NO_COMP
1268 EXPORT_C void *SSL_COMP_get_compression_methods(void)
1272 EXPORT_C int SSL_COMP_add_compression_method(int id, void *cm)
1277 EXPORT_C const char *SSL_COMP_get_name(const void *comp)
1282 EXPORT_C STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1284 load_builtin_compressions();
1285 return(ssl_comp_methods);
1288 EXPORT_C int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1292 if (cm == NULL || cm->type == NID_undef)
1295 /* According to draft-ietf-tls-compression-04.txt, the
1296 compression number ranges should be the following:
1298 0 to 63: methods defined by the IETF
1299 64 to 192: external party methods assigned by IANA
1300 193 to 255: reserved for private use */
1301 if (id < 193 || id > 255)
1303 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1308 comp=(SSL_COMP *)OPENSSL_malloc(sizeof(SSL_COMP));
1311 load_builtin_compressions();
1312 if (ssl_comp_methods
1313 && !sk_SSL_COMP_find(ssl_comp_methods,comp))
1317 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,SSL_R_DUPLICATE_COMPRESSION_ID);
1320 else if ((ssl_comp_methods == NULL)
1321 || !sk_SSL_COMP_push(ssl_comp_methods,comp))
1325 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,ERR_R_MALLOC_FAILURE);
1335 EXPORT_C const char *SSL_COMP_get_name(const COMP_METHOD *comp)