Another comment change. (Previous comment does not apply
[openssl.git] / ssl / s2_lib.c
1 /* ssl/s2_lib.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 "ssl_locl.h"
60 #ifndef NO_SSL2
61 #include <stdio.h>
62 #include <openssl/rsa.h>
63 #include <openssl/objects.h>
64 #include <openssl/md5.h>
65
66 static long ssl2_default_timeout(void );
67 const char *ssl2_version_str="SSLv2" OPENSSL_VERSION_PTEXT;
68
69 #define SSL2_NUM_CIPHERS (sizeof(ssl2_ciphers)/sizeof(SSL_CIPHER))
70
71 OPENSSL_GLOBAL SSL_CIPHER ssl2_ciphers[]={
72 /* NULL_WITH_MD5 v3 */
73 #if 0
74         {
75         1,
76         SSL2_TXT_NULL_WITH_MD5,
77         SSL2_CK_NULL_WITH_MD5,
78         SSL_kRSA|SSL_aRSA|SSL_eNULL|SSL_MD5|SSL_SSLV2,
79         SSL_EXPORT|SSL_EXP40,
80         0,
81         0,
82         SSL_ALL_CIPHERS,
83         SSL_ALL_STRENGTHS,
84         },
85 #endif
86 /* RC4_128_EXPORT40_WITH_MD5 */
87         {
88         1,
89         SSL2_TXT_RC4_128_EXPORT40_WITH_MD5,
90         SSL2_CK_RC4_128_EXPORT40_WITH_MD5,
91         SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5|SSL_SSLV2,
92         SSL_EXPORT|SSL_EXP40,
93         SSL2_CF_5_BYTE_ENC,
94         40,
95         128,
96         SSL_ALL_CIPHERS,
97         SSL_ALL_STRENGTHS,
98         },
99 /* RC4_128_WITH_MD5 */
100         {
101         1,
102         SSL2_TXT_RC4_128_WITH_MD5,
103         SSL2_CK_RC4_128_WITH_MD5,
104         SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5|SSL_SSLV2,
105         SSL_NOT_EXP|SSL_MEDIUM,
106         0,
107         128,
108         128,
109         SSL_ALL_CIPHERS,
110         SSL_ALL_STRENGTHS,
111         },
112 /* RC2_128_CBC_EXPORT40_WITH_MD5 */
113         {
114         1,
115         SSL2_TXT_RC2_128_CBC_EXPORT40_WITH_MD5,
116         SSL2_CK_RC2_128_CBC_EXPORT40_WITH_MD5,
117         SSL_kRSA|SSL_aRSA|SSL_RC2|SSL_MD5|SSL_SSLV2,
118         SSL_EXPORT|SSL_EXP40,
119         SSL2_CF_5_BYTE_ENC,
120         40,
121         128,
122         SSL_ALL_CIPHERS,
123         SSL_ALL_STRENGTHS,
124         },
125 /* RC2_128_CBC_WITH_MD5 */
126         {
127         1,
128         SSL2_TXT_RC2_128_CBC_WITH_MD5,
129         SSL2_CK_RC2_128_CBC_WITH_MD5,
130         SSL_kRSA|SSL_aRSA|SSL_RC2|SSL_MD5|SSL_SSLV2,
131         SSL_NOT_EXP|SSL_MEDIUM,
132         0,
133         128,
134         128,
135         SSL_ALL_CIPHERS,
136         SSL_ALL_STRENGTHS,
137         },
138 /* IDEA_128_CBC_WITH_MD5 */
139         {
140         1,
141         SSL2_TXT_IDEA_128_CBC_WITH_MD5,
142         SSL2_CK_IDEA_128_CBC_WITH_MD5,
143         SSL_kRSA|SSL_aRSA|SSL_IDEA|SSL_MD5|SSL_SSLV2,
144         SSL_NOT_EXP|SSL_MEDIUM,
145         0,
146         128,
147         128,
148         SSL_ALL_CIPHERS,
149         SSL_ALL_STRENGTHS,
150         },
151 /* DES_64_CBC_WITH_MD5 */
152         {
153         1,
154         SSL2_TXT_DES_64_CBC_WITH_MD5,
155         SSL2_CK_DES_64_CBC_WITH_MD5,
156         SSL_kRSA|SSL_aRSA|SSL_DES|SSL_MD5|SSL_SSLV2,
157         SSL_NOT_EXP|SSL_LOW,
158         0,
159         56,
160         56,
161         SSL_ALL_CIPHERS,
162         SSL_ALL_STRENGTHS,
163         },
164 /* DES_192_EDE3_CBC_WITH_MD5 */
165         {
166         1,
167         SSL2_TXT_DES_192_EDE3_CBC_WITH_MD5,
168         SSL2_CK_DES_192_EDE3_CBC_WITH_MD5,
169         SSL_kRSA|SSL_aRSA|SSL_3DES|SSL_MD5|SSL_SSLV2,
170         SSL_NOT_EXP|SSL_HIGH,
171         0,
172         168,
173         168,
174         SSL_ALL_CIPHERS,
175         SSL_ALL_STRENGTHS,
176         },
177 /* RC4_64_WITH_MD5 */
178 #if 1
179         {
180         1,
181         SSL2_TXT_RC4_64_WITH_MD5,
182         SSL2_CK_RC4_64_WITH_MD5,
183         SSL_kRSA|SSL_aRSA|SSL_RC4|SSL_MD5|SSL_SSLV2,
184         SSL_NOT_EXP|SSL_LOW,
185         SSL2_CF_8_BYTE_ENC,
186         64,
187         64,
188         SSL_ALL_CIPHERS,
189         SSL_ALL_STRENGTHS,
190         },
191 #endif
192 /* NULL SSLeay (testing) */
193 #if 0
194         {       
195         0,
196         SSL2_TXT_NULL,
197         SSL2_CK_NULL,
198         0,
199         0,
200         0,
201         0,
202         SSL_ALL_CIPHERS,
203         SSL_ALL_STRENGTHS,
204         },
205 #endif
206
207 /* end of list :-) */
208         };
209
210 static SSL_METHOD SSLv2_data= {
211         SSL2_VERSION,
212         ssl2_new,       /* local */
213         ssl2_clear,     /* local */
214         ssl2_free,      /* local */
215         ssl_undefined_function,
216         ssl_undefined_function,
217         ssl2_read,
218         ssl2_peek,
219         ssl2_write,
220         ssl2_shutdown,
221         ssl_ok, /* NULL - renegotiate */
222         ssl_ok, /* NULL - check renegotiate */
223         ssl2_ctrl,      /* local */
224         ssl2_ctx_ctrl,  /* local */
225         ssl2_get_cipher_by_char,
226         ssl2_put_cipher_by_char,
227         ssl2_pending,
228         ssl2_num_ciphers,
229         ssl2_get_cipher,
230         ssl_bad_method,
231         ssl2_default_timeout,
232         &ssl3_undef_enc_method,
233         ssl_undefined_function,
234         ssl2_callback_ctrl,     /* local */
235         ssl2_ctx_callback_ctrl, /* local */
236         };
237
238 static long ssl2_default_timeout(void)
239         {
240         return(300);
241         }
242
243 SSL_METHOD *sslv2_base_method(void)
244         {
245         return(&SSLv2_data);
246         }
247
248 int ssl2_num_ciphers(void)
249         {
250         return(SSL2_NUM_CIPHERS);
251         }
252
253 SSL_CIPHER *ssl2_get_cipher(unsigned int u)
254         {
255         if (u < SSL2_NUM_CIPHERS)
256                 return(&(ssl2_ciphers[SSL2_NUM_CIPHERS-1-u]));
257         else
258                 return(NULL);
259         }
260
261 int ssl2_pending(SSL *s)
262         {
263         return SSL_in_init(s) ? 0 : s->s2->ract_data_length;
264         }
265
266 int ssl2_new(SSL *s)
267         {
268         SSL2_STATE *s2;
269
270         if ((s2=OPENSSL_malloc(sizeof *s2)) == NULL) goto err;
271         memset(s2,0,sizeof *s2);
272
273 #if SSL2_MAX_RECORD_LENGTH_3_BYTE_HEADER + 3 > SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER + 2
274 #  error "assertion failed"
275 #endif
276
277         if ((s2->rbuf=OPENSSL_malloc(
278                 SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER+2)) == NULL) goto err;
279         /* wbuf needs one byte more because when using two-byte headers,
280          * we leave the first byte unused in do_ssl_write (s2_pkt.c) */
281         if ((s2->wbuf=OPENSSL_malloc(
282                 SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER+3)) == NULL) goto err;
283         s->s2=s2;
284
285         ssl2_clear(s);
286         return(1);
287 err:
288         if (s2 != NULL)
289                 {
290                 if (s2->wbuf != NULL) OPENSSL_free(s2->wbuf);
291                 if (s2->rbuf != NULL) OPENSSL_free(s2->rbuf);
292                 OPENSSL_free(s2);
293                 }
294         return(0);
295         }
296
297 void ssl2_free(SSL *s)
298         {
299         SSL2_STATE *s2;
300
301         if(s == NULL)
302             return;
303
304         s2=s->s2;
305         if (s2->rbuf != NULL) OPENSSL_free(s2->rbuf);
306         if (s2->wbuf != NULL) OPENSSL_free(s2->wbuf);
307         memset(s2,0,sizeof *s2);
308         OPENSSL_free(s2);
309         s->s2=NULL;
310         }
311
312 void ssl2_clear(SSL *s)
313         {
314         SSL2_STATE *s2;
315         unsigned char *rbuf,*wbuf;
316
317         s2=s->s2;
318
319         rbuf=s2->rbuf;
320         wbuf=s2->wbuf;
321
322         memset(s2,0,sizeof *s2);
323
324         s2->rbuf=rbuf;
325         s2->wbuf=wbuf;
326         s2->clear_text=1;
327         s->packet=s2->rbuf;
328         s->version=SSL2_VERSION;
329         s->packet_length=0;
330         }
331
332 long ssl2_ctrl(SSL *s, int cmd, long larg, char *parg)
333         {
334         int ret=0;
335
336         switch(cmd)
337                 {
338         case SSL_CTRL_GET_SESSION_REUSED:
339                 ret=s->hit;
340                 break;
341         default:
342                 break;
343                 }
344         return(ret);
345         }
346
347 long ssl2_callback_ctrl(SSL *s, int cmd, void (*fp)())
348         {
349         return(0);
350         }
351
352 long ssl2_ctx_ctrl(SSL_CTX *ctx, int cmd, long larg, char *parg)
353         {
354         return(0);
355         }
356
357 long ssl2_ctx_callback_ctrl(SSL_CTX *ctx, int cmd, void (*fp)())
358         {
359         return(0);
360         }
361
362 /* This function needs to check if the ciphers required are actually
363  * available */
364 SSL_CIPHER *ssl2_get_cipher_by_char(const unsigned char *p)
365         {
366         static int init=1;
367         static SSL_CIPHER *sorted[SSL2_NUM_CIPHERS];
368         SSL_CIPHER c,*cp= &c,**cpp;
369         unsigned long id;
370         int i;
371
372         if (init)
373                 {
374                 CRYPTO_w_lock(CRYPTO_LOCK_SSL);
375
376                 for (i=0; i<SSL2_NUM_CIPHERS; i++)
377                         sorted[i]= &(ssl2_ciphers[i]);
378
379                 qsort(  (char *)sorted,
380                         SSL2_NUM_CIPHERS,sizeof(SSL_CIPHER *),
381                         FP_ICC ssl_cipher_ptr_id_cmp);
382
383                 CRYPTO_w_unlock(CRYPTO_LOCK_SSL);
384                 init=0;
385                 }
386
387         id=0x02000000L|((unsigned long)p[0]<<16L)|
388                 ((unsigned long)p[1]<<8L)|(unsigned long)p[2];
389         c.id=id;
390         cpp=(SSL_CIPHER **)OBJ_bsearch((char *)&cp,
391                 (char *)sorted,
392                 SSL2_NUM_CIPHERS,sizeof(SSL_CIPHER *),
393                 FP_ICC ssl_cipher_ptr_id_cmp);
394         if ((cpp == NULL) || !(*cpp)->valid)
395                 return(NULL);
396         else
397                 return(*cpp);
398         }
399
400 int ssl2_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p)
401         {
402         long l;
403
404         if (p != NULL)
405                 {
406                 l=c->id;
407                 if ((l & 0xff000000) != 0x02000000) return(0);
408                 p[0]=((unsigned char)(l>>16L))&0xFF;
409                 p[1]=((unsigned char)(l>> 8L))&0xFF;
410                 p[2]=((unsigned char)(l     ))&0xFF;
411                 }
412         return(3);
413         }
414
415 void ssl2_generate_key_material(SSL *s)
416         {
417         unsigned int i;
418         MD5_CTX ctx;
419         unsigned char *km;
420         unsigned char c='0';
421
422 #ifdef CHARSET_EBCDIC
423         c = os_toascii['0']; /* Must be an ASCII '0', not EBCDIC '0',
424                                 see SSLv2 docu */
425 #endif
426
427         km=s->s2->key_material;
428         for (i=0; i<s->s2->key_material_length; i+=MD5_DIGEST_LENGTH)
429                 {
430                 MD5_Init(&ctx);
431
432                 MD5_Update(&ctx,s->session->master_key,s->session->master_key_length);
433                 MD5_Update(&ctx,&c,1);
434                 c++;
435                 MD5_Update(&ctx,s->s2->challenge,s->s2->challenge_length);
436                 MD5_Update(&ctx,s->s2->conn_id,s->s2->conn_id_length);
437                 MD5_Final(km,&ctx);
438                 km+=MD5_DIGEST_LENGTH;
439                 }
440         }
441
442 void ssl2_return_error(SSL *s, int err)
443         {
444         if (!s->error)
445                 {
446                 s->error=3;
447                 s->error_code=err;
448
449                 ssl2_write_error(s);
450                 }
451         }
452
453
454 void ssl2_write_error(SSL *s)
455         {
456         unsigned char buf[3];
457         int i,error;
458
459         buf[0]=SSL2_MT_ERROR;
460         buf[1]=(s->error_code>>8)&0xff;
461         buf[2]=(s->error_code)&0xff;
462
463 /*      state=s->rwstate;*/
464         error=s->error;
465         s->error=0;
466         i=ssl2_write(s,&(buf[3-error]),error);
467 /*      if (i == error) s->rwstate=state; */
468
469         if (i < 0)
470                 s->error=error;
471         else if (i != s->error)
472                 s->error=error-i;
473         /* else
474                 s->error=0; */
475         }
476
477 int ssl2_shutdown(SSL *s)
478         {
479         s->shutdown=(SSL_SENT_SHUTDOWN|SSL_RECEIVED_SHUTDOWN);
480         return(1);
481         }
482 #else /* !NO_SSL2 */
483
484 # if PEDANTIC
485 static void *dummy=&dummy;
486 # endif
487
488 #endif