2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include <openssl/objects.h>
61 #include <openssl/comp.h>
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
73 static const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX]={
74 NULL,NULL,NULL,NULL,NULL,NULL,
77 static STACK_OF(SSL_COMP) *ssl_comp_methods=NULL;
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]={
86 typedef struct cipher_sort_st
97 typedef struct cipher_choice_st
100 unsigned long algorithms;
105 typedef struct cipher_order_st
110 struct cipher_order_st *next,*prev;
113 static SSL_CIPHER cipher_aliases[]={
114 /* Don't include eNULL unless specifically enabled */
115 {0,SSL_TXT_ALL, 0,SSL_ALL & ~SSL_eNULL, 0,SSL_ALL}, /* must be first */
116 {0,SSL_TXT_kRSA,0,SSL_kRSA, 0,SSL_MKEY_MASK},
117 {0,SSL_TXT_kDHr,0,SSL_kDHr, 0,SSL_MKEY_MASK},
118 {0,SSL_TXT_kDHd,0,SSL_kDHd, 0,SSL_MKEY_MASK},
119 {0,SSL_TXT_kEDH,0,SSL_kEDH, 0,SSL_MKEY_MASK},
120 {0,SSL_TXT_kFZA,0,SSL_kFZA, 0,SSL_MKEY_MASK},
121 {0,SSL_TXT_DH, 0,SSL_DH, 0,SSL_MKEY_MASK},
122 {0,SSL_TXT_EDH, 0,SSL_EDH, 0,SSL_MKEY_MASK|SSL_AUTH_MASK},
124 {0,SSL_TXT_aRSA,0,SSL_aRSA, 0,SSL_AUTH_MASK},
125 {0,SSL_TXT_aDSS,0,SSL_aDSS, 0,SSL_AUTH_MASK},
126 {0,SSL_TXT_aFZA,0,SSL_aFZA, 0,SSL_AUTH_MASK},
127 {0,SSL_TXT_aNULL,0,SSL_aNULL,0,SSL_AUTH_MASK},
128 {0,SSL_TXT_aDH, 0,SSL_aDH, 0,SSL_AUTH_MASK},
129 {0,SSL_TXT_DSS, 0,SSL_DSS, 0,SSL_AUTH_MASK},
131 {0,SSL_TXT_DES, 0,SSL_DES, 0,SSL_ENC_MASK},
132 {0,SSL_TXT_3DES,0,SSL_3DES, 0,SSL_ENC_MASK},
133 {0,SSL_TXT_RC4, 0,SSL_RC4, 0,SSL_ENC_MASK},
134 {0,SSL_TXT_RC2, 0,SSL_RC2, 0,SSL_ENC_MASK},
135 {0,SSL_TXT_IDEA,0,SSL_IDEA, 0,SSL_ENC_MASK},
136 {0,SSL_TXT_eNULL,0,SSL_eNULL,0,SSL_ENC_MASK},
137 {0,SSL_TXT_eFZA,0,SSL_eFZA, 0,SSL_ENC_MASK},
139 {0,SSL_TXT_MD5, 0,SSL_MD5, 0,SSL_MAC_MASK},
140 {0,SSL_TXT_SHA1,0,SSL_SHA1, 0,SSL_MAC_MASK},
141 {0,SSL_TXT_SHA, 0,SSL_SHA, 0,SSL_MAC_MASK},
143 {0,SSL_TXT_NULL,0,SSL_NULL, 0,SSL_ENC_MASK},
144 {0,SSL_TXT_RSA, 0,SSL_RSA, 0,SSL_AUTH_MASK|SSL_MKEY_MASK},
145 {0,SSL_TXT_ADH, 0,SSL_ADH, 0,SSL_AUTH_MASK|SSL_MKEY_MASK},
146 {0,SSL_TXT_FZA, 0,SSL_FZA, 0,SSL_AUTH_MASK|SSL_MKEY_MASK|SSL_ENC_MASK},
148 {0,SSL_TXT_EXP40, 0,SSL_EXP40, 0,SSL_EXP_MASK},
149 {0,SSL_TXT_EXPORT,0,SSL_EXP40, 0,SSL_EXP_MASK},
150 {0,SSL_TXT_EXP56, 0,SSL_EXP56, 0,SSL_EXP_MASK},
151 {0,SSL_TXT_SSLV2, 0,SSL_SSLV2, 0,SSL_SSL_MASK},
152 {0,SSL_TXT_SSLV3, 0,SSL_SSLV3, 0,SSL_SSL_MASK},
153 {0,SSL_TXT_TLSV1, 0,SSL_TLSV1, 0,SSL_SSL_MASK},
154 {0,SSL_TXT_LOW, 0,SSL_LOW, 0,SSL_STRONG_MASK},
155 {0,SSL_TXT_MEDIUM,0,SSL_MEDIUM,0,SSL_STRONG_MASK},
156 {0,SSL_TXT_HIGH, 0,SSL_HIGH, 0,SSL_STRONG_MASK},
159 static int init_ciphers=1;
160 static void load_ciphers();
162 static int cmp_by_name(SSL_CIPHER **a, SSL_CIPHER **b)
164 return(strcmp((*a)->name,(*b)->name));
167 static void load_ciphers(void)
170 ssl_cipher_methods[SSL_ENC_DES_IDX]=
171 EVP_get_cipherbyname(SN_des_cbc);
172 ssl_cipher_methods[SSL_ENC_3DES_IDX]=
173 EVP_get_cipherbyname(SN_des_ede3_cbc);
174 ssl_cipher_methods[SSL_ENC_RC4_IDX]=
175 EVP_get_cipherbyname(SN_rc4);
176 ssl_cipher_methods[SSL_ENC_RC2_IDX]=
177 EVP_get_cipherbyname(SN_rc2_cbc);
178 ssl_cipher_methods[SSL_ENC_IDEA_IDX]=
179 EVP_get_cipherbyname(SN_idea_cbc);
181 ssl_digest_methods[SSL_MD_MD5_IDX]=
182 EVP_get_digestbyname(SN_md5);
183 ssl_digest_methods[SSL_MD_SHA1_IDX]=
184 EVP_get_digestbyname(SN_sha1);
187 int ssl_cipher_get_evp(SSL_SESSION *s, const EVP_CIPHER **enc,
188 const EVP_MD **md, SSL_COMP **comp)
194 if (c == NULL) return(0);
199 if (s->compress_meth == 0)
201 else if (ssl_comp_methods == NULL)
209 ctmp.id=s->compress_meth;
210 i=sk_SSL_COMP_find(ssl_comp_methods,&ctmp);
212 *comp=sk_SSL_COMP_value(ssl_comp_methods,i);
218 if ((enc == NULL) || (md == NULL)) return(0);
220 switch (c->algorithms & SSL_ENC_MASK)
245 if ((i < 0) || (i > SSL_ENC_NUM_IDX))
249 if (i == SSL_ENC_NULL_IDX)
252 *enc=ssl_cipher_methods[i];
255 switch (c->algorithms & SSL_MAC_MASK)
267 if ((i < 0) || (i > SSL_MD_NUM_IDX))
270 *md=ssl_digest_methods[i];
272 if ((*enc != NULL) && (*md != NULL))
278 #define ITEM_SEP(a) \
279 (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
281 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
284 if (curr == *tail) return;
287 if (curr->prev != NULL)
288 curr->prev->next=curr->next;
289 if (curr->next != NULL) /* should always be true */
290 curr->next->prev=curr->prev;
297 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_METHOD *ssl_method,
298 STACK_OF(SSL_CIPHER) **cipher_list,
299 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
304 STACK_OF(SSL_CIPHER) *ret=NULL,*ok=NULL;
308 unsigned long mask,algorithms,ma;
310 int i,j,k,num=0,ch,multi;
314 CIPHER_CHOICE *ops=NULL;
315 CIPHER_ORDER *list=NULL,*head=NULL,*tail=NULL,*curr,*tail2,*curr2;
318 SSL_CIPHER c_tmp,*cp;
320 if (str == NULL) return(NULL);
322 if (strncmp(str,"DEFAULT",7) == 0)
324 i=strlen(str)+2+strlen(SSL_DEFAULT_CIPHER_LIST);
325 if ((tmp_str=Malloc(i)) == NULL)
327 SSLerr(SSL_F_SSL_CREATE_CIPHER_LIST,ERR_R_MALLOC_FAILURE);
330 strcpy(tmp_str,SSL_DEFAULT_CIPHER_LIST);
332 strcat(tmp_str,&(str[7]));
335 if (init_ciphers) load_ciphers();
337 num=ssl_method->num_ciphers();
339 if ((ret=sk_SSL_CIPHER_new(NULL)) == NULL) goto err;
340 if ((ca_list=(STACK *)sk_new(cmp_by_name)) == NULL) goto err;
344 mask|=SSL_aRSA|SSL_kRSA;
350 mask|=SSL_kDHr|SSL_kDHd|SSL_kEDH|SSL_aDH;
353 #ifdef SSL_FORBID_ENULL
357 mask|=(ssl_cipher_methods[SSL_ENC_DES_IDX ] == NULL)?SSL_DES :0;
358 mask|=(ssl_cipher_methods[SSL_ENC_3DES_IDX] == NULL)?SSL_3DES:0;
359 mask|=(ssl_cipher_methods[SSL_ENC_RC4_IDX ] == NULL)?SSL_RC4 :0;
360 mask|=(ssl_cipher_methods[SSL_ENC_RC2_IDX ] == NULL)?SSL_RC2 :0;
361 mask|=(ssl_cipher_methods[SSL_ENC_IDEA_IDX] == NULL)?SSL_IDEA:0;
362 mask|=(ssl_cipher_methods[SSL_ENC_eFZA_IDX] == NULL)?SSL_eFZA:0;
364 mask|=(ssl_digest_methods[SSL_MD_MD5_IDX ] == NULL)?SSL_MD5 :0;
365 mask|=(ssl_digest_methods[SSL_MD_SHA1_IDX] == NULL)?SSL_SHA1:0;
367 if ((list=(CIPHER_ORDER *)Malloc(sizeof(CIPHER_ORDER)*num)) == NULL)
370 /* Get the initial list of ciphers */
372 for (i=0; i<num; i++)
374 c=ssl_method->get_cipher((unsigned int)i);
375 /* drop those that use any of that is not available */
376 if ((c != NULL) && c->valid && !(c->algorithms & mask))
378 list[list_num].cipher=c;
379 list[list_num].next=NULL;
380 list[list_num].prev=NULL;
381 list[list_num].active=0;
383 if (!sk_push(ca_list,(char *)c)) goto err;
387 for (i=1; i<list_num-1; i++)
389 list[i].prev= &(list[i-1]);
390 list[i].next= &(list[i+1]);
396 head->next= &(list[1]);
397 tail= &(list[list_num-1]);
398 tail->prev= &(list[list_num-2]);
403 cipher_aliases[0].algorithms &= ~mask;
405 /* get the aliases */
406 k=sizeof(cipher_aliases)/sizeof(SSL_CIPHER);
409 al=cipher_aliases[j].algorithms;
410 /* Drop those that are not relevent */
411 if ((al & mask) == al) continue;
412 if (!sk_push(ca_list,(char *)&(cipher_aliases[j]))) goto err;
415 /* ca_list now holds a 'stack' of SSL_CIPHERS, some real, some
418 /* how many parameters are there? */
423 ops=(CIPHER_CHOICE *)Malloc(sizeof(CIPHER_CHOICE)*num);
424 if (ops == NULL) goto err;
425 memset(ops,0,sizeof(CIPHER_CHOICE)*num);
427 /* we now parse the input string and create our operations */
436 if (ch == '\0') break;
439 { j=CIPHER_DEL; l++; }
441 { j=CIPHER_ORD; l++; }
443 { j=CIPHER_KILL; l++; }
452 ops[current_x].type=j;
453 ops[current_x].algorithms=0;
454 ops[current_x].mask=0;
461 while ( ((ch >= 'A') && (ch <= 'Z')) ||
462 ((ch >= '0') && (ch <= '9')) ||
463 ((ch >= 'a') && (ch <= 'z')) ||
469 if (i >= (CL_BUF-2)) break;
473 /* check for multi-part specification */
483 j=sk_find(ca_list,(char *)&c_tmp);
487 cp=(SSL_CIPHER *)sk_value(ca_list,j);
488 ops[current_x].algorithms|=cp->algorithms;
489 /* We add the SSL_SSL_MASK so we can match the
490 * SSLv2 and SSLv3 versions of RC4-MD5 */
491 ops[current_x].mask|=cp->mask;
495 if (ch == '\0') break;
497 /* Make sure we scan until the next valid start point */
498 while ((*l != '\0') && ITEM_SEP(*l))
505 /* We will now process the list of ciphers, once for each category, to
506 * decide what we should do with it. */
507 for (j=0; j<num_x; j++)
509 algorithms=ops[j].algorithms;
518 if ((curr == NULL) || (curr == tail2)) break;
523 ma=mask & cp->algorithms;
524 if ((ma == 0) || ((ma & algorithms) != ma))
530 /* add the cipher if it has not been added yet. */
531 if (type == CIPHER_ADD)
535 ll_append_tail(&head,curr,&tail);
539 /* Move the added cipher to this location */
540 else if (type == CIPHER_ORD)
544 ll_append_tail(&head,curr,&tail);
547 else if (type == CIPHER_DEL)
549 if (type == CIPHER_KILL)
554 curr->prev->next=curr->next;
558 if (curr->next != NULL)
559 curr->next->prev=curr->prev;
560 if (curr->prev != NULL)
561 curr->prev->next=curr->next;
568 for (curr=head; curr != NULL; curr=curr->next)
572 sk_SSL_CIPHER_push(ret,curr->cipher);
574 printf("<%s>\n",curr->cipher->name);
579 if (cipher_list != NULL)
581 if (*cipher_list != NULL)
582 sk_SSL_CIPHER_free(*cipher_list);
586 if (cipher_list_by_id != NULL)
588 if (*cipher_list_by_id != NULL)
589 sk_SSL_CIPHER_free(*cipher_list_by_id);
590 *cipher_list_by_id=sk_SSL_CIPHER_dup(ret);
593 if ( (cipher_list_by_id == NULL) ||
594 (*cipher_list_by_id == NULL) ||
595 (cipher_list == NULL) ||
596 (*cipher_list == NULL))
598 sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id,ssl_cipher_ptr_id_cmp);
603 if (tmp_str) Free(tmp_str);
604 if (ops != NULL) Free(ops);
605 if (ret != NULL) sk_SSL_CIPHER_free(ret);
606 if (ca_list != NULL) sk_free(ca_list);
607 if (list != NULL) Free(list);
611 char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int len)
613 int is_export,pkl,kl;
615 char *kx,*au,*enc,*mac;
616 unsigned long alg,alg2;
617 static char *format="%-23s %s Kx=%-8s Au=%-4s Enc=%-9s Mac=%-4s%s\n";
619 alg=cipher->algorithms;
620 alg2=cipher->algorithm2;
622 is_export=SSL_IS_EXPORT(alg);
623 pkl=SSL_EXPORT_PKEYLENGTH(alg);
624 kl=SSL_EXPORT_KEYLENGTH(alg);
625 exp=is_export?" export":"";
629 else if (alg & SSL_SSLV3)
634 switch (alg&SSL_MKEY_MASK)
637 kx=is_export?(pkl == 512 ? "RSA(512)" : "RSA(1024)"):"RSA";
649 kx=is_export?(pkl == 512 ? "DH(512)" : "DH(1024)"):"DH";
655 switch (alg&SSL_AUTH_MASK)
675 switch (alg&SSL_ENC_MASK)
678 enc=(is_export && kl == 5)?"DES(40)":"DES(56)";
684 enc=is_export?(kl == 5 ? "RC4(40)" : "RC4(56)")
685 :((alg2&SSL2_CF_8_BYTE_ENC)?"RC4(64)":"RC4(128)");
688 enc=is_export?(kl == 5 ? "RC2(40)" : "RC2(56)"):"RC2(128)";
704 switch (alg&SSL_MAC_MASK)
720 if (buf == NULL) return("Malloc Error");
723 return("Buffer too small");
725 sprintf(buf,format,cipher->name,ver,kx,au,enc,mac,exp);
729 char *SSL_CIPHER_get_version(SSL_CIPHER *c)
733 if (c == NULL) return("(NONE)");
736 return("TLSv1/SSLv3");
743 /* return the actual cipher being used */
744 const char *SSL_CIPHER_get_name(SSL_CIPHER *c)
751 /* number of bits for symetric cipher */
752 int SSL_CIPHER_get_bits(SSL_CIPHER *c, int *alg_bits)
755 const EVP_CIPHER *enc;
762 if (!ssl_cipher_get_evp(&ss,&enc,&md,NULL))
765 a=EVP_CIPHER_key_length(enc)*8;
767 if (SSL_C_IS_EXPORT(c))
769 ret=SSL_C_EXPORT_KEYLENGTH(c)*8;
773 if (c->algorithm2 & SSL2_CF_8_BYTE_ENC)
780 if (alg_bits != NULL) *alg_bits=a;
785 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
790 if ((n == 0) || (sk == NULL)) return(NULL);
791 nn=sk_SSL_COMP_num(sk);
794 ctmp=sk_SSL_COMP_value(sk,i);
801 static int sk_comp_cmp(SSL_COMP **a,SSL_COMP **b)
803 return((*a)->id-(*b)->id);
806 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
808 return(ssl_comp_methods);
811 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
814 STACK_OF(SSL_COMP) *sk;
816 comp=(SSL_COMP *)Malloc(sizeof(SSL_COMP));
819 if (ssl_comp_methods == NULL)
820 sk=ssl_comp_methods=sk_SSL_COMP_new(sk_comp_cmp);
823 if ((sk == NULL) || !sk_SSL_COMP_push(sk,comp))
825 SSLerr(SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD,ERR_R_MALLOC_FAILURE);