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