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