This stops a compiler warning from -Wmissing-prototypes.
[openssl.git] / ssl / ssl_ciph.c
1 /* ssl/ssl_ciph.c */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
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.
8  * 
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).
15  * 
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.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
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)"
40  * 
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
51  * SUCH DAMAGE.
52  * 
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  */
58 /* ====================================================================
59  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  * ECC cipher suite support in OpenSSL originally developed by 
61  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
62  */
63 #include <stdio.h>
64 #include <openssl/objects.h>
65 #include <openssl/comp.h>
66 #include "ssl_locl.h"
67
68 #define SSL_ENC_DES_IDX         0
69 #define SSL_ENC_3DES_IDX        1
70 #define SSL_ENC_RC4_IDX         2
71 #define SSL_ENC_RC2_IDX         3
72 #define SSL_ENC_IDEA_IDX        4
73 #define SSL_ENC_eFZA_IDX        5
74 #define SSL_ENC_NULL_IDX        6
75 #define SSL_ENC_AES128_IDX      7
76 #define SSL_ENC_AES256_IDX      8
77 #define SSL_ENC_NUM_IDX         9
78
79 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX]={
80         NULL,NULL,NULL,NULL,NULL,NULL,
81         };
82
83 #define SSL_COMP_NULL_IDX       0
84 #define SSL_COMP_ZLIB_IDX       1
85 #define SSL_COMP_NUM_IDX        2
86
87 static STACK_OF(SSL_COMP) *ssl_comp_methods=NULL;
88
89 #define SSL_MD_MD5_IDX  0
90 #define SSL_MD_SHA1_IDX 1
91 #define SSL_MD_NUM_IDX  2
92 static const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX]={
93         NULL,NULL,
94         };
95
96 #define CIPHER_ADD      1
97 #define CIPHER_KILL     2
98 #define CIPHER_DEL      3
99 #define CIPHER_ORD      4
100 #define CIPHER_SPECIAL  5
101
102 typedef struct cipher_order_st
103         {
104         SSL_CIPHER *cipher;
105         int active;
106         int dead;
107         struct cipher_order_st *next,*prev;
108         } CIPHER_ORDER;
109
110 static const SSL_CIPHER cipher_aliases[]={
111         /* Don't include eNULL unless specifically enabled. */
112         /* Don't include ECC in ALL because these ciphers are not yet official. */
113         {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 */
114         /* TODO: COMPLEMENT OF ALL and COMPLEMENT OF DEFAULT do not have ECC cipher suites handled properly. */
115         {0,SSL_TXT_CMPALL,0,SSL_eNULL,0,0,0,0,SSL_ENC_MASK,0},  /* COMPLEMENT OF ALL */
116         {0,SSL_TXT_CMPDEF,0,SSL_ADH, 0,0,0,0,SSL_AUTH_MASK,0},
117         {0,SSL_TXT_kKRB5,0,SSL_kKRB5,0,0,0,0,SSL_MKEY_MASK,0},  /* VRS Kerberos5 */
118         {0,SSL_TXT_kRSA,0,SSL_kRSA,  0,0,0,0,SSL_MKEY_MASK,0},
119         {0,SSL_TXT_kDHr,0,SSL_kDHr,  0,0,0,0,SSL_MKEY_MASK,0},
120         {0,SSL_TXT_kDHd,0,SSL_kDHd,  0,0,0,0,SSL_MKEY_MASK,0},
121         {0,SSL_TXT_kEDH,0,SSL_kEDH,  0,0,0,0,SSL_MKEY_MASK,0},
122         {0,SSL_TXT_kFZA,0,SSL_kFZA,  0,0,0,0,SSL_MKEY_MASK,0},
123         {0,SSL_TXT_DH,  0,SSL_DH,    0,0,0,0,SSL_MKEY_MASK,0},
124         {0,SSL_TXT_ECC, 0,(SSL_kECDH|SSL_kECDHE), 0,0,0,0,SSL_MKEY_MASK,0},
125         {0,SSL_TXT_EDH, 0,SSL_EDH,   0,0,0,0,SSL_MKEY_MASK|SSL_AUTH_MASK,0},
126         {0,SSL_TXT_aKRB5,0,SSL_aKRB5,0,0,0,0,SSL_AUTH_MASK,0},  /* VRS Kerberos5 */
127         {0,SSL_TXT_aRSA,0,SSL_aRSA,  0,0,0,0,SSL_AUTH_MASK,0},
128         {0,SSL_TXT_aDSS,0,SSL_aDSS,  0,0,0,0,SSL_AUTH_MASK,0},
129         {0,SSL_TXT_aFZA,0,SSL_aFZA,  0,0,0,0,SSL_AUTH_MASK,0},
130         {0,SSL_TXT_aNULL,0,SSL_aNULL,0,0,0,0,SSL_AUTH_MASK,0},
131         {0,SSL_TXT_aDH, 0,SSL_aDH,   0,0,0,0,SSL_AUTH_MASK,0},
132         {0,SSL_TXT_DSS, 0,SSL_DSS,   0,0,0,0,SSL_AUTH_MASK,0},
133
134         {0,SSL_TXT_DES, 0,SSL_DES,   0,0,0,0,SSL_ENC_MASK,0},
135         {0,SSL_TXT_3DES,0,SSL_3DES,  0,0,0,0,SSL_ENC_MASK,0},
136         {0,SSL_TXT_RC4, 0,SSL_RC4,   0,0,0,0,SSL_ENC_MASK,0},
137         {0,SSL_TXT_RC2, 0,SSL_RC2,   0,0,0,0,SSL_ENC_MASK,0},
138         {0,SSL_TXT_IDEA,0,SSL_IDEA,  0,0,0,0,SSL_ENC_MASK,0},
139         {0,SSL_TXT_eNULL,0,SSL_eNULL,0,0,0,0,SSL_ENC_MASK,0},
140         {0,SSL_TXT_eFZA,0,SSL_eFZA,  0,0,0,0,SSL_ENC_MASK,0},
141         {0,SSL_TXT_AES, 0,SSL_AES,   0,0,0,0,SSL_ENC_MASK,0},
142
143         {0,SSL_TXT_MD5, 0,SSL_MD5,   0,0,0,0,SSL_MAC_MASK,0},
144         {0,SSL_TXT_SHA1,0,SSL_SHA1,  0,0,0,0,SSL_MAC_MASK,0},
145         {0,SSL_TXT_SHA, 0,SSL_SHA,   0,0,0,0,SSL_MAC_MASK,0},
146
147         {0,SSL_TXT_NULL,0,SSL_NULL,  0,0,0,0,SSL_ENC_MASK,0},
148         {0,SSL_TXT_KRB5,0,SSL_KRB5,  0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
149         {0,SSL_TXT_RSA, 0,SSL_RSA,   0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
150         {0,SSL_TXT_ADH, 0,SSL_ADH,   0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK,0},
151         {0,SSL_TXT_FZA, 0,SSL_FZA,   0,0,0,0,SSL_AUTH_MASK|SSL_MKEY_MASK|SSL_ENC_MASK,0},
152
153         {0,SSL_TXT_SSLV2, 0,SSL_SSLV2, 0,0,0,0,SSL_SSL_MASK,0},
154         {0,SSL_TXT_SSLV3, 0,SSL_SSLV3, 0,0,0,0,SSL_SSL_MASK,0},
155         {0,SSL_TXT_TLSV1, 0,SSL_TLSV1, 0,0,0,0,SSL_SSL_MASK,0},
156
157         {0,SSL_TXT_EXP   ,0, 0,SSL_EXPORT, 0,0,0,0,SSL_EXP_MASK},
158         {0,SSL_TXT_EXPORT,0, 0,SSL_EXPORT, 0,0,0,0,SSL_EXP_MASK},
159         {0,SSL_TXT_EXP40, 0, 0, SSL_EXP40, 0,0,0,0,SSL_STRONG_MASK},
160         {0,SSL_TXT_EXP56, 0, 0, SSL_EXP56, 0,0,0,0,SSL_STRONG_MASK},
161         {0,SSL_TXT_LOW,   0, 0,   SSL_LOW, 0,0,0,0,SSL_STRONG_MASK},
162         {0,SSL_TXT_MEDIUM,0, 0,SSL_MEDIUM, 0,0,0,0,SSL_STRONG_MASK},
163         {0,SSL_TXT_HIGH,  0, 0,  SSL_HIGH, 0,0,0,0,SSL_STRONG_MASK},
164         };
165
166 static int init_ciphers=1;
167
168 static void load_ciphers(void)
169         {
170         init_ciphers=0;
171         ssl_cipher_methods[SSL_ENC_DES_IDX]= 
172                 EVP_get_cipherbyname(SN_des_cbc);
173         ssl_cipher_methods[SSL_ENC_3DES_IDX]=
174                 EVP_get_cipherbyname(SN_des_ede3_cbc);
175         ssl_cipher_methods[SSL_ENC_RC4_IDX]=
176                 EVP_get_cipherbyname(SN_rc4);
177         ssl_cipher_methods[SSL_ENC_RC2_IDX]= 
178                 EVP_get_cipherbyname(SN_rc2_cbc);
179         ssl_cipher_methods[SSL_ENC_IDEA_IDX]= 
180                 EVP_get_cipherbyname(SN_idea_cbc);
181         ssl_cipher_methods[SSL_ENC_AES128_IDX]=
182           EVP_get_cipherbyname(SN_aes_128_cbc);
183         ssl_cipher_methods[SSL_ENC_AES256_IDX]=
184           EVP_get_cipherbyname(SN_aes_256_cbc);
185
186         ssl_digest_methods[SSL_MD_MD5_IDX]=
187                 EVP_get_digestbyname(SN_md5);
188         ssl_digest_methods[SSL_MD_SHA1_IDX]=
189                 EVP_get_digestbyname(SN_sha1);
190         }
191
192 static int sk_comp_cmp(const SSL_COMP * const *a,
193                         const SSL_COMP * const *b)
194         {
195         return((*a)->id-(*b)->id);
196         }
197
198 static void load_builtin_compressions(void)
199         {
200         if (ssl_comp_methods == NULL)
201                 {
202                 SSL_COMP *comp = NULL;
203
204                 MemCheck_off();
205                 ssl_comp_methods=sk_SSL_COMP_new(sk_comp_cmp);
206                 if (ssl_comp_methods != NULL)
207                         {
208                         comp=(SSL_COMP *)OPENSSL_malloc(sizeof(SSL_COMP));
209                         if (comp != NULL)
210                                 {
211                                 comp->method=COMP_zlib();
212                                 if (comp->method
213                                         && comp->method->type == NID_undef)
214                                         OPENSSL_free(comp);
215                                 else
216                                         {
217                                         comp->id=SSL_COMP_ZLIB_IDX;
218                                         comp->name=comp->method->name;
219                                         sk_SSL_COMP_push(ssl_comp_methods,comp);
220                                         }
221                                 }
222                         }
223                 MemCheck_on();
224                 }
225         }
226
227 int ssl_cipher_get_evp(SSL_SESSION *s, const EVP_CIPHER **enc,
228              const EVP_MD **md, SSL_COMP **comp)
229         {
230         int i;
231         SSL_CIPHER *c;
232
233         c=s->cipher;
234         if (c == NULL) return(0);
235         if (comp != NULL)
236                 {
237                 SSL_COMP ctmp;
238
239                 load_builtin_compressions();
240
241                 *comp=NULL;
242                 ctmp.id=s->compress_meth;
243                 if (ssl_comp_methods != NULL)
244                         {
245                         i=sk_SSL_COMP_find(ssl_comp_methods,&ctmp);
246                         if (i >= 0)
247                                 *comp=sk_SSL_COMP_value(ssl_comp_methods,i);
248                         else
249                                 *comp=NULL;
250                         }
251                 }
252
253         if ((enc == NULL) || (md == NULL)) return(0);
254
255         switch (c->algorithms & SSL_ENC_MASK)
256                 {
257         case SSL_DES:
258                 i=SSL_ENC_DES_IDX;
259                 break;
260         case SSL_3DES:
261                 i=SSL_ENC_3DES_IDX;
262                 break;
263         case SSL_RC4:
264                 i=SSL_ENC_RC4_IDX;
265                 break;
266         case SSL_RC2:
267                 i=SSL_ENC_RC2_IDX;
268                 break;
269         case SSL_IDEA:
270                 i=SSL_ENC_IDEA_IDX;
271                 break;
272         case SSL_eNULL:
273                 i=SSL_ENC_NULL_IDX;
274                 break;
275         case SSL_AES:
276                 switch(c->alg_bits)
277                         {
278                 case 128: i=SSL_ENC_AES128_IDX; break;
279                 case 256: i=SSL_ENC_AES256_IDX; break;
280                 default: i=-1; break;
281                         }
282                 break;
283         default:
284                 i= -1;
285                 break;
286                 }
287
288         if ((i < 0) || (i > SSL_ENC_NUM_IDX))
289                 *enc=NULL;
290         else
291                 {
292                 if (i == SSL_ENC_NULL_IDX)
293                         *enc=EVP_enc_null();
294                 else
295                         *enc=ssl_cipher_methods[i];
296                 }
297
298         switch (c->algorithms & SSL_MAC_MASK)
299                 {
300         case SSL_MD5:
301                 i=SSL_MD_MD5_IDX;
302                 break;
303         case SSL_SHA1:
304                 i=SSL_MD_SHA1_IDX;
305                 break;
306         default:
307                 i= -1;
308                 break;
309                 }
310         if ((i < 0) || (i > SSL_MD_NUM_IDX))
311                 *md=NULL;
312         else
313                 *md=ssl_digest_methods[i];
314
315         if ((*enc != NULL) && (*md != NULL))
316                 return(1);
317         else
318                 return(0);
319         }
320
321 #define ITEM_SEP(a) \
322         (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
323
324 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
325              CIPHER_ORDER **tail)
326         {
327         if (curr == *tail) return;
328         if (curr == *head)
329                 *head=curr->next;
330         if (curr->prev != NULL)
331                 curr->prev->next=curr->next;
332         if (curr->next != NULL) /* should always be true */
333                 curr->next->prev=curr->prev;
334         (*tail)->next=curr;
335         curr->prev= *tail;
336         curr->next=NULL;
337         *tail=curr;
338         }
339
340 static unsigned long ssl_cipher_get_disabled(void)
341         {
342         unsigned long mask;
343
344         mask = SSL_kFZA;
345 #ifdef OPENSSL_NO_RSA
346         mask |= SSL_aRSA|SSL_kRSA;
347 #endif
348 #ifdef OPENSSL_NO_DSA
349         mask |= SSL_aDSS;
350 #endif
351 #ifdef OPENSSL_NO_DH
352         mask |= SSL_kDHr|SSL_kDHd|SSL_kEDH|SSL_aDH;
353 #endif
354 #ifdef OPENSSL_NO_KRB5
355         mask |= SSL_kKRB5|SSL_aKRB5;
356 #endif
357 #ifdef OPENSSL_NO_ECDH
358         mask |= SSL_kECDH|SSL_kECDHE;
359 #endif
360 #ifdef SSL_FORBID_ENULL
361         mask |= SSL_eNULL;
362 #endif
363
364         mask |= (ssl_cipher_methods[SSL_ENC_DES_IDX ] == NULL) ? SSL_DES :0;
365         mask |= (ssl_cipher_methods[SSL_ENC_3DES_IDX] == NULL) ? SSL_3DES:0;
366         mask |= (ssl_cipher_methods[SSL_ENC_RC4_IDX ] == NULL) ? SSL_RC4 :0;
367         mask |= (ssl_cipher_methods[SSL_ENC_RC2_IDX ] == NULL) ? SSL_RC2 :0;
368         mask |= (ssl_cipher_methods[SSL_ENC_IDEA_IDX] == NULL) ? SSL_IDEA:0;
369         mask |= (ssl_cipher_methods[SSL_ENC_eFZA_IDX] == NULL) ? SSL_eFZA:0;
370         mask |= (ssl_cipher_methods[SSL_ENC_AES128_IDX] == NULL) ? SSL_AES:0;
371
372         mask |= (ssl_digest_methods[SSL_MD_MD5_IDX ] == NULL) ? SSL_MD5 :0;
373         mask |= (ssl_digest_methods[SSL_MD_SHA1_IDX] == NULL) ? SSL_SHA1:0;
374
375         return(mask);
376         }
377
378 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
379                 int num_of_ciphers, unsigned long mask, CIPHER_ORDER *list,
380                 CIPHER_ORDER **head_p, CIPHER_ORDER **tail_p)
381         {
382         int i, list_num;
383         SSL_CIPHER *c;
384
385         /*
386          * We have num_of_ciphers descriptions compiled in, depending on the
387          * method selected (SSLv2 and/or SSLv3, TLSv1 etc).
388          * These will later be sorted in a linked list with at most num
389          * entries.
390          */
391
392         /* Get the initial list of ciphers */
393         list_num = 0;   /* actual count of ciphers */
394         for (i = 0; i < num_of_ciphers; i++)
395                 {
396                 c = ssl_method->get_cipher(i);
397                 /* drop those that use any of that is not available */
398                 if ((c != NULL) && c->valid && !(c->algorithms & mask))
399                         {
400                         list[list_num].cipher = c;
401                         list[list_num].next = NULL;
402                         list[list_num].prev = NULL;
403                         list[list_num].active = 0;
404                         list_num++;
405 #ifdef KSSL_DEBUG
406                         printf("\t%d: %s %lx %lx\n",i,c->name,c->id,c->algorithms);
407 #endif  /* KSSL_DEBUG */
408                         /*
409                         if (!sk_push(ca_list,(char *)c)) goto err;
410                         */
411                         }
412                 }
413
414         /*
415          * Prepare linked list from list entries
416          */     
417         for (i = 1; i < list_num - 1; i++)
418                 {
419                 list[i].prev = &(list[i-1]);
420                 list[i].next = &(list[i+1]);
421                 }
422         if (list_num > 0)
423                 {
424                 (*head_p) = &(list[0]);
425                 (*head_p)->prev = NULL;
426                 (*head_p)->next = &(list[1]);
427                 (*tail_p) = &(list[list_num - 1]);
428                 (*tail_p)->prev = &(list[list_num - 2]);
429                 (*tail_p)->next = NULL;
430                 }
431         }
432
433 static void ssl_cipher_collect_aliases(SSL_CIPHER **ca_list,
434                         int num_of_group_aliases, unsigned long mask,
435                         CIPHER_ORDER *head)
436         {
437         CIPHER_ORDER *ciph_curr;
438         SSL_CIPHER **ca_curr;
439         int i;
440
441         /*
442          * First, add the real ciphers as already collected
443          */
444         ciph_curr = head;
445         ca_curr = ca_list;
446         while (ciph_curr != NULL)
447                 {
448                 *ca_curr = ciph_curr->cipher;
449                 ca_curr++;
450                 ciph_curr = ciph_curr->next;
451                 }
452
453         /*
454          * Now we add the available ones from the cipher_aliases[] table.
455          * They represent either an algorithm, that must be fully
456          * supported (not match any bit in mask) or represent a cipher
457          * strength value (will be added in any case because algorithms=0).
458          */
459         for (i = 0; i < num_of_group_aliases; i++)
460                 {
461                 if ((i == 0) ||         /* always fetch "ALL" */
462                     !(cipher_aliases[i].algorithms & mask))
463                         {
464                         *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
465                         ca_curr++;
466                         }
467                 }
468
469         *ca_curr = NULL;        /* end of list */
470         }
471
472 static void ssl_cipher_apply_rule(unsigned long algorithms, unsigned long mask,
473                 unsigned long algo_strength, unsigned long mask_strength,
474                 int rule, int strength_bits, CIPHER_ORDER *list,
475                 CIPHER_ORDER **head_p, CIPHER_ORDER **tail_p)
476         {
477         CIPHER_ORDER *head, *tail, *curr, *curr2, *tail2;
478         SSL_CIPHER *cp;
479         unsigned long ma, ma_s;
480
481 #ifdef CIPHER_DEBUG
482         printf("Applying rule %d with %08lx %08lx %08lx %08lx (%d)\n",
483                 rule, algorithms, mask, algo_strength, mask_strength,
484                 strength_bits);
485 #endif
486
487         curr = head = *head_p;
488         curr2 = head;
489         tail2 = tail = *tail_p;
490         for (;;)
491                 {
492                 if ((curr == NULL) || (curr == tail2)) break;
493                 curr = curr2;
494                 curr2 = curr->next;
495
496                 cp = curr->cipher;
497
498                 /*
499                  * Selection criteria is either the number of strength_bits
500                  * or the algorithm used.
501                  */
502                 if (strength_bits == -1)
503                         {
504                         ma = mask & cp->algorithms;
505                         ma_s = mask_strength & cp->algo_strength;
506
507 #ifdef CIPHER_DEBUG
508                         printf("\nName: %s:\nAlgo = %08lx Algo_strength = %08lx\nMask = %08lx Mask_strength %08lx\n", cp->name, cp->algorithms, cp->algo_strength, mask, mask_strength);
509                         printf("ma = %08lx ma_s %08lx, ma&algo=%08lx, ma_s&algos=%08lx\n", ma, ma_s, ma&algorithms, ma_s&algo_strength);
510 #endif
511                         /*
512                          * Select: if none of the mask bit was met from the
513                          * cipher or not all of the bits were met, the
514                          * selection does not apply.
515                          */
516                         if (((ma == 0) && (ma_s == 0)) ||
517                             ((ma & algorithms) != ma) ||
518                             ((ma_s & algo_strength) != ma_s))
519                                 continue; /* does not apply */
520                         }
521                 else if (strength_bits != cp->strength_bits)
522                         continue;       /* does not apply */
523
524 #ifdef CIPHER_DEBUG
525                 printf("Action = %d\n", rule);
526 #endif
527
528                 /* add the cipher if it has not been added yet. */
529                 if (rule == CIPHER_ADD)
530                         {
531                         if (!curr->active)
532                                 {
533                                 ll_append_tail(&head, curr, &tail);
534                                 curr->active = 1;
535                                 }
536                         }
537                 /* Move the added cipher to this location */
538                 else if (rule == CIPHER_ORD)
539                         {
540                         if (curr->active)
541                                 {
542                                 ll_append_tail(&head, curr, &tail);
543                                 }
544                         }
545                 else if (rule == CIPHER_DEL)
546                         curr->active = 0;
547                 else if (rule == CIPHER_KILL)
548                         {
549                         if (head == curr)
550                                 head = curr->next;
551                         else
552                                 curr->prev->next = curr->next;
553                         if (tail == curr)
554                                 tail = curr->prev;
555                         curr->active = 0;
556                         if (curr->next != NULL)
557                                 curr->next->prev = curr->prev;
558                         if (curr->prev != NULL)
559                                 curr->prev->next = curr->next;
560                         curr->next = NULL;
561                         curr->prev = NULL;
562                         }
563                 }
564
565         *head_p = head;
566         *tail_p = tail;
567         }
568
569 static int ssl_cipher_strength_sort(CIPHER_ORDER *list, CIPHER_ORDER **head_p,
570                                      CIPHER_ORDER **tail_p)
571         {
572         int max_strength_bits, i, *number_uses;
573         CIPHER_ORDER *curr;
574
575         /*
576          * This routine sorts the ciphers with descending strength. The sorting
577          * must keep the pre-sorted sequence, so we apply the normal sorting
578          * routine as '+' movement to the end of the list.
579          */
580         max_strength_bits = 0;
581         curr = *head_p;
582         while (curr != NULL)
583                 {
584                 if (curr->active &&
585                     (curr->cipher->strength_bits > max_strength_bits))
586                     max_strength_bits = curr->cipher->strength_bits;
587                 curr = curr->next;
588                 }
589
590         number_uses = OPENSSL_malloc((max_strength_bits + 1) * sizeof(int));
591         if (!number_uses)
592         {
593                 SSLerr(SSL_F_SSL_CIPHER_STRENGTH_SORT,ERR_R_MALLOC_FAILURE);
594                 return(0);
595         }
596         memset(number_uses, 0, (max_strength_bits + 1) * sizeof(int));
597
598         /*
599          * Now find the strength_bits values actually used
600          */
601         curr = *head_p;
602         while (curr != NULL)
603                 {
604                 if (curr->active)
605                         number_uses[curr->cipher->strength_bits]++;
606                 curr = curr->next;
607                 }
608         /*
609          * Go through the list of used strength_bits values in descending
610          * order.
611          */
612         for (i = max_strength_bits; i >= 0; i--)
613                 if (number_uses[i] > 0)
614                         ssl_cipher_apply_rule(0, 0, 0, 0, CIPHER_ORD, i,
615                                         list, head_p, tail_p);
616
617         OPENSSL_free(number_uses);
618         return(1);
619         }
620
621 static int ssl_cipher_process_rulestr(const char *rule_str,
622                 CIPHER_ORDER *list, CIPHER_ORDER **head_p,
623                 CIPHER_ORDER **tail_p, SSL_CIPHER **ca_list)
624         {
625         unsigned long algorithms, mask, algo_strength, mask_strength;
626         const char *l, *start, *buf;
627         int j, multi, found, rule, retval, ok, buflen;
628         char ch;
629
630         retval = 1;
631         l = rule_str;
632         for (;;)
633                 {
634                 ch = *l;
635
636                 if (ch == '\0')
637                         break;          /* done */
638                 if (ch == '-')
639                         { rule = CIPHER_DEL; l++; }
640                 else if (ch == '+')
641                         { rule = CIPHER_ORD; l++; }
642                 else if (ch == '!')
643                         { rule = CIPHER_KILL; l++; }
644                 else if (ch == '@')
645                         { rule = CIPHER_SPECIAL; l++; }
646                 else
647                         { rule = CIPHER_ADD; }
648
649                 if (ITEM_SEP(ch))
650                         {
651                         l++;
652                         continue;
653                         }
654
655                 algorithms = mask = algo_strength = mask_strength = 0;
656
657                 start=l;
658                 for (;;)
659                         {
660                         ch = *l;
661                         buf = l;
662                         buflen = 0;
663 #ifndef CHARSET_EBCDIC
664                         while ( ((ch >= 'A') && (ch <= 'Z')) ||
665                                 ((ch >= '0') && (ch <= '9')) ||
666                                 ((ch >= 'a') && (ch <= 'z')) ||
667                                  (ch == '-'))
668 #else
669                         while ( isalnum(ch) || (ch == '-'))
670 #endif
671                                  {
672                                  ch = *(++l);
673                                  buflen++;
674                                  }
675
676                         if (buflen == 0)
677                                 {
678                                 /*
679                                  * We hit something we cannot deal with,
680                                  * it is no command or separator nor
681                                  * alphanumeric, so we call this an error.
682                                  */
683                                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
684                                        SSL_R_INVALID_COMMAND);
685                                 retval = found = 0;
686                                 l++;
687                                 break;
688                                 }
689
690                         if (rule == CIPHER_SPECIAL)
691                                 {
692                                 found = 0; /* unused -- avoid compiler warning */
693                                 break;  /* special treatment */
694                                 }
695
696                         /* check for multi-part specification */
697                         if (ch == '+')
698                                 {
699                                 multi=1;
700                                 l++;
701                                 }
702                         else
703                                 multi=0;
704
705                         /*
706                          * Now search for the cipher alias in the ca_list. Be careful
707                          * with the strncmp, because the "buflen" limitation
708                          * will make the rule "ADH:SOME" and the cipher
709                          * "ADH-MY-CIPHER" look like a match for buflen=3.
710                          * So additionally check whether the cipher name found
711                          * has the correct length. We can save a strlen() call:
712                          * just checking for the '\0' at the right place is
713                          * sufficient, we have to strncmp() anyway.
714                          */
715                          j = found = 0;
716                          while (ca_list[j])
717                                 {
718                                 if ((ca_list[j]->name[buflen] == '\0') &&
719                                     !strncmp(buf, ca_list[j]->name, buflen))
720                                         {
721                                         found = 1;
722                                         break;
723                                         }
724                                 else
725                                         j++;
726                                 }
727                         if (!found)
728                                 break;  /* ignore this entry */
729
730                         algorithms |= ca_list[j]->algorithms;
731                         mask |= ca_list[j]->mask;
732                         algo_strength |= ca_list[j]->algo_strength;
733                         mask_strength |= ca_list[j]->mask_strength;
734
735                         if (!multi) break;
736                         }
737
738                 /*
739                  * Ok, we have the rule, now apply it
740                  */
741                 if (rule == CIPHER_SPECIAL)
742                         {       /* special command */
743                         ok = 0;
744                         if ((buflen == 8) &&
745                                 !strncmp(buf, "STRENGTH", 8))
746                                 ok = ssl_cipher_strength_sort(list,
747                                         head_p, tail_p);
748                         else
749                                 SSLerr(SSL_F_SSL_CIPHER_PROCESS_RULESTR,
750                                         SSL_R_INVALID_COMMAND);
751                         if (ok == 0)
752                                 retval = 0;
753                         /*
754                          * We do not support any "multi" options
755                          * together with "@", so throw away the
756                          * rest of the command, if any left, until
757                          * end or ':' is found.
758                          */
759                         while ((*l != '\0') && ITEM_SEP(*l))
760                                 l++;
761                         }
762                 else if (found)
763                         {
764                         ssl_cipher_apply_rule(algorithms, mask,
765                                 algo_strength, mask_strength, rule, -1,
766                                 list, head_p, tail_p);
767                         }
768                 else
769                         {
770                         while ((*l != '\0') && ITEM_SEP(*l))
771                                 l++;
772                         }
773                 if (*l == '\0') break; /* done */
774                 }
775
776         return(retval);
777         }
778
779 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
780                 STACK_OF(SSL_CIPHER) **cipher_list,
781                 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
782                 const char *rule_str)
783         {
784         int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases;
785         unsigned long disabled_mask;
786         STACK_OF(SSL_CIPHER) *cipherstack;
787         const char *rule_p;
788         CIPHER_ORDER *list = NULL, *head = NULL, *tail = NULL, *curr;
789         SSL_CIPHER **ca_list = NULL;
790
791         /*
792          * Return with error if nothing to do.
793          */
794         if (rule_str == NULL) return(NULL);
795
796         if (init_ciphers) load_ciphers();
797
798         /*
799          * To reduce the work to do we only want to process the compiled
800          * in algorithms, so we first get the mask of disabled ciphers.
801          */
802         disabled_mask = ssl_cipher_get_disabled();
803
804         /*
805          * Now we have to collect the available ciphers from the compiled
806          * in ciphers. We cannot get more than the number compiled in, so
807          * it is used for allocation.
808          */
809         num_of_ciphers = ssl_method->num_ciphers();
810 #ifdef KSSL_DEBUG
811         printf("ssl_create_cipher_list() for %d ciphers\n", num_of_ciphers);
812 #endif    /* KSSL_DEBUG */
813         list = (CIPHER_ORDER *)OPENSSL_malloc(sizeof(CIPHER_ORDER) * num_of_ciphers);
814         if (list == NULL)
815                 {
816                 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST,ERR_R_MALLOC_FAILURE);
817                 return(NULL);   /* Failure */
818                 }
819
820         ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers, disabled_mask,
821                                    list, &head, &tail);
822
823         /*
824          * We also need cipher aliases for selecting based on the rule_str.
825          * There might be two types of entries in the rule_str: 1) names
826          * of ciphers themselves 2) aliases for groups of ciphers.
827          * For 1) we need the available ciphers and for 2) the cipher
828          * groups of cipher_aliases added together in one list (otherwise
829          * we would be happy with just the cipher_aliases table).
830          */
831         num_of_group_aliases = sizeof(cipher_aliases) / sizeof(SSL_CIPHER);
832         num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
833         ca_list =
834                 (SSL_CIPHER **)OPENSSL_malloc(sizeof(SSL_CIPHER *) * num_of_alias_max);
835         if (ca_list == NULL)
836                 {
837                 OPENSSL_free(list);
838                 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST,ERR_R_MALLOC_FAILURE);
839                 return(NULL);   /* Failure */
840                 }
841         ssl_cipher_collect_aliases(ca_list, num_of_group_aliases, disabled_mask,
842                                    head);
843
844         /*
845          * If the rule_string begins with DEFAULT, apply the default rule
846          * before using the (possibly available) additional rules.
847          */
848         ok = 1;
849         rule_p = rule_str;
850         if (strncmp(rule_str,"DEFAULT",7) == 0)
851                 {
852                 ok = ssl_cipher_process_rulestr(SSL_DEFAULT_CIPHER_LIST,
853                         list, &head, &tail, ca_list);
854                 rule_p += 7;
855                 if (*rule_p == ':')
856                         rule_p++;
857                 }
858
859         if (ok && (strlen(rule_p) > 0))
860                 ok = ssl_cipher_process_rulestr(rule_p, list, &head, &tail,
861                                                 ca_list);
862
863         OPENSSL_free(ca_list);  /* Not needed anymore */
864
865         if (!ok)
866                 {       /* Rule processing failure */
867                 OPENSSL_free(list);
868                 return(NULL);
869                 }
870         /*
871          * Allocate new "cipherstack" for the result, return with error
872          * if we cannot get one.
873          */
874         if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL)
875                 {
876                 OPENSSL_free(list);
877                 return(NULL);
878                 }
879
880         /*
881          * The cipher selection for the list is done. The ciphers are added
882          * to the resulting precedence to the STACK_OF(SSL_CIPHER).
883          */
884         for (curr = head; curr != NULL; curr = curr->next)
885                 {
886                 if (curr->active)
887                         {
888                         sk_SSL_CIPHER_push(cipherstack, curr->cipher);
889 #ifdef CIPHER_DEBUG
890                         printf("<%s>\n",curr->cipher->name);
891 #endif
892                         }
893                 }
894         OPENSSL_free(list);     /* Not needed any longer */
895
896         /*
897          * The following passage is a little bit odd. If pointer variables
898          * were supplied to hold STACK_OF(SSL_CIPHER) return information,
899          * the old memory pointed to is free()ed. Then, however, the
900          * cipher_list entry will be assigned just a copy of the returned
901          * cipher stack. For cipher_list_by_id a copy of the cipher stack
902          * will be created. See next comment...
903          */
904         if (cipher_list != NULL)
905                 {
906                 if (*cipher_list != NULL)
907                         sk_SSL_CIPHER_free(*cipher_list);
908                 *cipher_list = cipherstack;
909                 }
910
911         if (cipher_list_by_id != NULL)
912                 {
913                 if (*cipher_list_by_id != NULL)
914                         sk_SSL_CIPHER_free(*cipher_list_by_id);
915                 *cipher_list_by_id = sk_SSL_CIPHER_dup(cipherstack);
916                 }
917
918         /*
919          * Now it is getting really strange. If something failed during
920          * the previous pointer assignment or if one of the pointers was
921          * not requested, the error condition is met. That might be
922          * discussable. The strange thing is however that in this case
923          * the memory "ret" pointed to is "free()ed" and hence the pointer
924          * cipher_list becomes wild. The memory reserved for
925          * cipher_list_by_id however is not "free()ed" and stays intact.
926          */
927         if (    (cipher_list_by_id == NULL) ||
928                 (*cipher_list_by_id == NULL) ||
929                 (cipher_list == NULL) ||
930                 (*cipher_list == NULL))
931                 {
932                 sk_SSL_CIPHER_free(cipherstack);
933                 return(NULL);
934                 }
935
936         sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id,ssl_cipher_ptr_id_cmp);
937
938         return(cipherstack);
939         }
940
941 char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int len)
942         {
943         int is_export,pkl,kl;
944         char *ver,*exp;
945         char *kx,*au,*enc,*mac;
946         unsigned long alg,alg2,alg_s;
947 #ifdef KSSL_DEBUG
948         static char *format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s AL=%lx\n";
949 #else
950         static char *format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s\n";
951 #endif /* KSSL_DEBUG */
952
953         alg=cipher->algorithms;
954         alg_s=cipher->algo_strength;
955         alg2=cipher->algorithm2;
956
957         is_export=SSL_C_IS_EXPORT(cipher);
958         pkl=SSL_C_EXPORT_PKEYLENGTH(cipher);
959         kl=SSL_C_EXPORT_KEYLENGTH(cipher);
960         exp=is_export?" export":"";
961         
962         if (alg & SSL_SSLV2)
963                 ver="SSLv2";
964         else if (alg & SSL_SSLV3)
965                 ver="SSLv3";
966         else
967                 ver="unknown";
968
969         switch (alg&SSL_MKEY_MASK)
970                 {
971         case SSL_kRSA:
972                 kx=is_export?(pkl == 512 ? "RSA(512)" : "RSA(1024)"):"RSA";
973                 break;
974         case SSL_kDHr:
975                 kx="DH/RSA";
976                 break;
977         case SSL_kDHd:
978                 kx="DH/DSS";
979                 break;
980         case SSL_kKRB5:         /* VRS */
981         case SSL_KRB5:          /* VRS */
982             kx="KRB5";
983             break;
984         case SSL_kFZA:
985                 kx="Fortezza";
986                 break;
987         case SSL_kEDH:
988                 kx=is_export?(pkl == 512 ? "DH(512)" : "DH(1024)"):"DH";
989                 break;
990         case SSL_kECDH:
991         case SSL_kECDHE:
992                 kx=is_export?"ECDH(<=163)":"ECDH";
993                 break;
994         default:
995                 kx="unknown";
996                 }
997
998         switch (alg&SSL_AUTH_MASK)
999                 {
1000         case SSL_aRSA:
1001                 au="RSA";
1002                 break;
1003         case SSL_aDSS:
1004                 au="DSS";
1005                 break;
1006         case SSL_aDH:
1007                 au="DH";
1008                 break;
1009         case SSL_aKRB5:         /* VRS */
1010         case SSL_KRB5:          /* VRS */
1011             au="KRB5";
1012             break;
1013         case SSL_aFZA:
1014         case SSL_aNULL:
1015                 au="None";
1016                 break;
1017         case SSL_aECDSA:
1018                 au="ECDSA";
1019                 break;
1020         default:
1021                 au="unknown";
1022                 break;
1023                 }
1024
1025         switch (alg&SSL_ENC_MASK)
1026                 {
1027         case SSL_DES:
1028                 enc=(is_export && kl == 5)?"DES(40)":"DES(56)";
1029                 break;
1030         case SSL_3DES:
1031                 enc="3DES(168)";
1032                 break;
1033         case SSL_RC4:
1034                 enc=is_export?(kl == 5 ? "RC4(40)" : "RC4(56)")
1035                   :((alg2&SSL2_CF_8_BYTE_ENC)?"RC4(64)":"RC4(128)");
1036                 break;
1037         case SSL_RC2:
1038                 enc=is_export?(kl == 5 ? "RC2(40)" : "RC2(56)"):"RC2(128)";
1039                 break;
1040         case SSL_IDEA:
1041                 enc="IDEA(128)";
1042                 break;
1043         case SSL_eFZA:
1044                 enc="Fortezza";
1045                 break;
1046         case SSL_eNULL:
1047                 enc="None";
1048                 break;
1049         case SSL_AES:
1050                 switch(cipher->strength_bits)
1051                         {
1052                 case 128: enc="AES(128)"; break;
1053                 case 192: enc="AES(192)"; break;
1054                 case 256: enc="AES(256)"; break;
1055                 default: enc="AES(?""?""?)"; break;
1056                         }
1057                 break;
1058         default:
1059                 enc="unknown";
1060                 break;
1061                 }
1062
1063         switch (alg&SSL_MAC_MASK)
1064                 {
1065         case SSL_MD5:
1066                 mac="MD5";
1067                 break;
1068         case SSL_SHA1:
1069                 mac="SHA1";
1070                 break;
1071         default:
1072                 mac="unknown";
1073                 break;
1074                 }
1075
1076         if (buf == NULL)
1077                 {
1078                 len=128;
1079                 buf=OPENSSL_malloc(len);
1080                 if (buf == NULL) return("OPENSSL_malloc Error");
1081                 }
1082         else if (len < 128)
1083                 return("Buffer too small");
1084
1085 #ifdef KSSL_DEBUG
1086         BIO_snprintf(buf,len,format,cipher->name,ver,kx,au,enc,mac,exp,alg);
1087 #else
1088         BIO_snprintf(buf,len,format,cipher->name,ver,kx,au,enc,mac,exp);
1089 #endif /* KSSL_DEBUG */
1090         return(buf);
1091         }
1092
1093 char *SSL_CIPHER_get_version(SSL_CIPHER *c)
1094         {
1095         int i;
1096
1097         if (c == NULL) return("(NONE)");
1098         i=(int)(c->id>>24L);
1099         if (i == 3)
1100                 return("TLSv1/SSLv3");
1101         else if (i == 2)
1102                 return("SSLv2");
1103         else
1104                 return("unknown");
1105         }
1106
1107 /* return the actual cipher being used */
1108 const char *SSL_CIPHER_get_name(SSL_CIPHER *c)
1109         {
1110         if (c != NULL)
1111                 return(c->name);
1112         return("(NONE)");
1113         }
1114
1115 /* number of bits for symmetric cipher */
1116 int SSL_CIPHER_get_bits(SSL_CIPHER *c, int *alg_bits)
1117         {
1118         int ret=0;
1119
1120         if (c != NULL)
1121                 {
1122                 if (alg_bits != NULL) *alg_bits = c->alg_bits;
1123                 ret = c->strength_bits;
1124                 }
1125         return(ret);
1126         }
1127
1128 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1129         {
1130         SSL_COMP *ctmp;
1131         int i,nn;
1132
1133         if ((n == 0) || (sk == NULL)) return(NULL);
1134         nn=sk_SSL_COMP_num(sk);
1135         for (i=0; i<nn; i++)
1136                 {
1137                 ctmp=sk_SSL_COMP_value(sk,i);
1138                 if (ctmp->id == n)
1139                         return(ctmp);
1140                 }
1141         return(NULL);
1142         }
1143
1144 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1145         {
1146         load_builtin_compressions();
1147         return(ssl_comp_methods);
1148         }
1149
1150 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1151         {
1152         SSL_COMP *comp;
1153
1154         if (cm == NULL || cm->type == NID_undef)
1155                 return 1;
1156
1157         /* According to draft-ietf-tls-compression-04.txt, the
1158            compression number ranges should be the following:
1159
1160            0 to 63:    methods defined by the IETF
1161            64 to 192:  external party methods assigned by IANA
1162            193 to 255: reserved for private use */
1163         if (id < 193 || id > 255)
1164                 {
1165                 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
1166                 return 0;
1167                 }
1168
1169         MemCheck_off();
1170         comp=(SSL_COMP *)OPENSSL_malloc(sizeof(SSL_COMP));
1171         comp->id=id;
1172         comp->method=cm;
1173         load_builtin_compressions();
1174         if ((ssl_comp_methods == NULL)
1175                 || !sk_SSL_COMP_push(ssl_comp_methods,comp))
1176                 {
1177                 OPENSSL_free(comp);
1178                 MemCheck_on();
1179                 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,ERR_R_MALLOC_FAILURE);
1180                 return(0);
1181                 }
1182         else
1183                 {
1184                 MemCheck_on();
1185                 return(1);
1186                 }
1187         }