Optimize bn_correct_top.
[openssl.git] / ssl / d1_pkt.c
1 /* ssl/d1_pkt.c */
2 /* 
3  * DTLS implementation written by Nagendra Modadugu
4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.  
5  */
6 /* ====================================================================
7  * Copyright (c) 1998-2005 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer. 
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    openssl-core@openssl.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60  * All rights reserved.
61  *
62  * This package is an SSL implementation written
63  * by Eric Young (eay@cryptsoft.com).
64  * The implementation was written so as to conform with Netscapes SSL.
65  * 
66  * This library is free for commercial and non-commercial use as long as
67  * the following conditions are aheared to.  The following conditions
68  * apply to all code found in this distribution, be it the RC4, RSA,
69  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
70  * included with this distribution is covered by the same copyright terms
71  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
72  * 
73  * Copyright remains Eric Young's, and as such any Copyright notices in
74  * the code are not to be removed.
75  * If this package is used in a product, Eric Young should be given attribution
76  * as the author of the parts of the library used.
77  * This can be in the form of a textual message at program startup or
78  * in documentation (online or textual) provided with the package.
79  * 
80  * Redistribution and use in source and binary forms, with or without
81  * modification, are permitted provided that the following conditions
82  * are met:
83  * 1. Redistributions of source code must retain the copyright
84  *    notice, this list of conditions and the following disclaimer.
85  * 2. Redistributions in binary form must reproduce the above copyright
86  *    notice, this list of conditions and the following disclaimer in the
87  *    documentation and/or other materials provided with the distribution.
88  * 3. All advertising materials mentioning features or use of this software
89  *    must display the following acknowledgement:
90  *    "This product includes cryptographic software written by
91  *     Eric Young (eay@cryptsoft.com)"
92  *    The word 'cryptographic' can be left out if the rouines from the library
93  *    being used are not cryptographic related :-).
94  * 4. If you include any Windows specific code (or a derivative thereof) from 
95  *    the apps directory (application code) you must include an acknowledgement:
96  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
97  * 
98  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
99  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
100  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
101  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
102  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
103  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
104  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
105  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
106  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
107  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
108  * SUCH DAMAGE.
109  * 
110  * The licence and distribution terms for any publically available version or
111  * derivative of this code cannot be changed.  i.e. this code cannot simply be
112  * copied and put under another distribution licence
113  * [including the GNU Public Licence.]
114  */
115
116 #include <stdio.h>
117 #include <errno.h>
118 #define USE_SOCKETS
119 #include "ssl_locl.h"
120 #include <openssl/evp.h>
121 #include <openssl/buffer.h>
122 #include <openssl/pqueue.h>
123 #include <openssl/rand.h>
124
125 /* mod 128 saturating subtract of two 64-bit values in big-endian order */
126 static int satsub64be(const unsigned char *v1,const unsigned char *v2)
127 {       int ret,sat,brw,i;
128
129         if (sizeof(long) == 8) do
130         {       const union { long one; char little; } is_endian = {1};
131                 long l;
132
133                 if (is_endian.little)                   break;
134                 /* not reached on little-endians */
135                 /* following test is redundant, because input is
136                  * always aligned, but I take no chances... */
137                 if (((size_t)v1|(size_t)v2)&0x7)        break;
138
139                 l  = *((long *)v1);
140                 l -= *((long *)v2);
141                 if (l>128)              return 128;
142                 else if (l<-128)        return -128;
143                 else                    return (int)l;
144         } while (0);
145
146         ret = (int)v1[7]-(int)v2[7];
147         sat = 0;
148         brw = ret>>8;   /* brw is either 0 or -1 */
149         if (ret & 0x80)
150         {       for (i=6;i>=0;i--)
151                 {       brw += (int)v1[i]-(int)v2[i];
152                         sat |= ~brw;
153                         brw >>= 8;
154                 }
155         }
156         else
157         {       for (i=6;i>=0;i--)
158                 {       brw += (int)v1[i]-(int)v2[i];
159                         sat |= brw;
160                         brw >>= 8;
161                 }
162         }
163         brw <<= 8;      /* brw is either 0 or -256 */
164
165         if (sat&0xff)   return brw | 0x80;
166         else            return brw + (ret&0xFF);
167 }
168
169 static int have_handshake_fragment(SSL *s, int type, unsigned char *buf, 
170         int len, int peek);
171 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap);
172 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap);
173 static DTLS1_BITMAP *dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr, 
174     unsigned int *is_next_epoch);
175 #if 0
176 static int dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr,
177         unsigned short *priority, unsigned long *offset);
178 #endif
179 static int dtls1_buffer_record(SSL *s, record_pqueue *q,
180         unsigned char *priority);
181 static int dtls1_process_record(SSL *s);
182 static void dtls1_clear_timeouts(SSL *s);
183
184 /* copy buffered record into SSL structure */
185 static int
186 dtls1_copy_record(SSL *s, pitem *item)
187     {
188     DTLS1_RECORD_DATA *rdata;
189
190     rdata = (DTLS1_RECORD_DATA *)item->data;
191     
192     if (s->s3->rbuf.buf != NULL)
193         OPENSSL_free(s->s3->rbuf.buf);
194     
195     s->packet = rdata->packet;
196     s->packet_length = rdata->packet_length;
197     memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
198     memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
199     
200     return(1);
201     }
202
203
204 static int
205 dtls1_buffer_record(SSL *s, record_pqueue *queue, unsigned char *priority)
206         {
207         DTLS1_RECORD_DATA *rdata;
208         pitem *item;
209
210         rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
211         item = pitem_new(priority, rdata);
212         if (rdata == NULL || item == NULL)
213                 {
214                 if (rdata != NULL) OPENSSL_free(rdata);
215                 if (item != NULL) pitem_free(item);
216                 
217                 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
218                 return(0);
219                 }
220         
221         rdata->packet = s->packet;
222         rdata->packet_length = s->packet_length;
223         memcpy(&(rdata->rbuf), &(s->s3->rbuf), sizeof(SSL3_BUFFER));
224         memcpy(&(rdata->rrec), &(s->s3->rrec), sizeof(SSL3_RECORD));
225
226         item->data = rdata;
227
228         /* insert should not fail, since duplicates are dropped */
229         if (pqueue_insert(queue->q, item) == NULL)
230                 {
231                 OPENSSL_free(rdata);
232                 pitem_free(item);
233                 return(0);
234                 }
235
236         s->packet = NULL;
237         s->packet_length = 0;
238         memset(&(s->s3->rbuf), 0, sizeof(SSL3_BUFFER));
239         memset(&(s->s3->rrec), 0, sizeof(SSL3_RECORD));
240         
241         if (!ssl3_setup_buffers(s))
242                 {
243                 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
244                 OPENSSL_free(rdata);
245                 pitem_free(item);
246                 return(0);
247                 }
248         
249         return(1);
250         }
251
252
253 static int
254 dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
255     {
256     pitem *item;
257
258     item = pqueue_pop(queue->q);
259     if (item)
260         {
261         dtls1_copy_record(s, item);
262
263         OPENSSL_free(item->data);
264                 pitem_free(item);
265
266         return(1);
267         }
268
269     return(0);
270     }
271
272
273 /* retrieve a buffered record that belongs to the new epoch, i.e., not processed 
274  * yet */
275 #define dtls1_get_unprocessed_record(s) \
276                    dtls1_retrieve_buffered_record((s), \
277                    &((s)->d1->unprocessed_rcds))
278
279 /* retrieve a buffered record that belongs to the current epoch, ie, processed */
280 #define dtls1_get_processed_record(s) \
281                    dtls1_retrieve_buffered_record((s), \
282                    &((s)->d1->processed_rcds))
283
284 static int
285 dtls1_process_buffered_records(SSL *s)
286     {
287     pitem *item;
288     
289     item = pqueue_peek(s->d1->unprocessed_rcds.q);
290     if (item)
291         {
292         DTLS1_RECORD_DATA *rdata;
293         rdata = (DTLS1_RECORD_DATA *)item->data;
294         
295         /* Check if epoch is current. */
296         if (s->d1->unprocessed_rcds.epoch != s->d1->r_epoch)
297             return(1);  /* Nothing to do. */
298         
299         /* Process all the records. */
300         while (pqueue_peek(s->d1->unprocessed_rcds.q))
301             {
302             dtls1_get_unprocessed_record(s);
303             if ( ! dtls1_process_record(s))
304                 return(0);
305             dtls1_buffer_record(s, &(s->d1->processed_rcds), 
306                 s->s3->rrec.seq_num);
307             }
308         }
309
310     /* sync epoch numbers once all the unprocessed records 
311      * have been processed */
312     s->d1->processed_rcds.epoch = s->d1->r_epoch;
313     s->d1->unprocessed_rcds.epoch = s->d1->r_epoch + 1;
314
315     return(1);
316     }
317
318
319 #if 0
320
321 static int
322 dtls1_get_buffered_record(SSL *s)
323         {
324         pitem *item;
325         PQ_64BIT priority = 
326                 (((PQ_64BIT)s->d1->handshake_read_seq) << 32) | 
327                 ((PQ_64BIT)s->d1->r_msg_hdr.frag_off);
328         
329         if ( ! SSL_in_init(s))  /* if we're not (re)negotiating, 
330                                                            nothing buffered */
331                 return 0;
332
333
334         item = pqueue_peek(s->d1->rcvd_records);
335         if (item && item->priority == priority)
336                 {
337                 /* Check if we've received the record of interest.  It must be
338                  * a handshake record, since data records as passed up without
339                  * buffering */
340                 DTLS1_RECORD_DATA *rdata;
341                 item = pqueue_pop(s->d1->rcvd_records);
342                 rdata = (DTLS1_RECORD_DATA *)item->data;
343                 
344                 if (s->s3->rbuf.buf != NULL)
345                         OPENSSL_free(s->s3->rbuf.buf);
346                 
347                 s->packet = rdata->packet;
348                 s->packet_length = rdata->packet_length;
349                 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
350                 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
351                 
352                 OPENSSL_free(item->data);
353                 pitem_free(item);
354                 
355                 /* s->d1->next_expected_seq_num++; */
356                 return(1);
357                 }
358         
359         return 0;
360         }
361
362 #endif
363
364 static int
365 dtls1_process_record(SSL *s)
366 {
367         int i,al;
368         int clear=0;
369         int enc_err;
370         SSL_SESSION *sess;
371         SSL3_RECORD *rr;
372         unsigned int mac_size;
373         unsigned char md[EVP_MAX_MD_SIZE];
374
375
376         rr= &(s->s3->rrec);
377         sess = s->session;
378
379         /* At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
380          * and we have that many bytes in s->packet
381          */
382         rr->input= &(s->packet[DTLS1_RT_HEADER_LENGTH]);
383
384         /* ok, we can now read from 's->packet' data into 'rr'
385          * rr->input points at rr->length bytes, which
386          * need to be copied into rr->data by either
387          * the decryption or by the decompression
388          * When the data is 'copied' into the rr->data buffer,
389          * rr->input will be pointed at the new buffer */ 
390
391         /* We now have - encrypted [ MAC [ compressed [ plain ] ] ]
392          * rr->length bytes of encrypted compressed stuff. */
393
394         /* check is not needed I believe */
395         if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
396                 {
397                 al=SSL_AD_RECORD_OVERFLOW;
398                 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
399                 goto f_err;
400                 }
401
402         /* decrypt in place in 'rr->input' */
403         rr->data=rr->input;
404
405         enc_err = s->method->ssl3_enc->enc(s,0);
406         if (enc_err <= 0)
407                 {
408                 if (enc_err == 0)
409                         /* SSLerr() and ssl3_send_alert() have been called */
410                         goto err;
411
412                 /* otherwise enc_err == -1 */
413                 goto decryption_failed_or_bad_record_mac;
414                 }
415
416 #ifdef TLS_DEBUG
417 printf("dec %d\n",rr->length);
418 { unsigned int z; for (z=0; z<rr->length; z++) printf("%02X%c",rr->data[z],((z+1)%16)?' ':'\n'); }
419 printf("\n");
420 #endif
421
422         /* r->length is now the compressed data plus mac */
423         if (    (sess == NULL) ||
424                 (s->enc_read_ctx == NULL) ||
425                 (s->read_hash == NULL))
426         clear=1;
427
428         if (!clear)
429                 {
430                 mac_size=EVP_MD_CTX_size(s->read_hash);
431
432                 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH+mac_size)
433                         {
434 #if 0 /* OK only for stream ciphers (then rr->length is visible from ciphertext anyway) */
435                         al=SSL_AD_RECORD_OVERFLOW;
436                         SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_PRE_MAC_LENGTH_TOO_LONG);
437                         goto f_err;
438 #else
439                         goto decryption_failed_or_bad_record_mac;
440 #endif                  
441                         }
442                 /* check the MAC for rr->input (it's in mac_size bytes at the tail) */
443                 if (rr->length < mac_size)
444                         {
445 #if 0 /* OK only for stream ciphers */
446                         al=SSL_AD_DECODE_ERROR;
447                         SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_LENGTH_TOO_SHORT);
448                         goto f_err;
449 #else
450                         goto decryption_failed_or_bad_record_mac;
451 #endif
452                         }
453                 rr->length-=mac_size;
454                 i=s->method->ssl3_enc->mac(s,md,0);
455                 if (memcmp(md,&(rr->data[rr->length]),mac_size) != 0)
456                         {
457                         goto decryption_failed_or_bad_record_mac;
458                         }
459                 }
460
461         /* r->length is now just compressed */
462         if (s->expand != NULL)
463                 {
464                 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH)
465                         {
466                         al=SSL_AD_RECORD_OVERFLOW;
467                         SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_COMPRESSED_LENGTH_TOO_LONG);
468                         goto f_err;
469                         }
470                 if (!ssl3_do_uncompress(s))
471                         {
472                         al=SSL_AD_DECOMPRESSION_FAILURE;
473                         SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_BAD_DECOMPRESSION);
474                         goto f_err;
475                         }
476                 }
477
478         if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH)
479                 {
480                 al=SSL_AD_RECORD_OVERFLOW;
481                 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DATA_LENGTH_TOO_LONG);
482                 goto f_err;
483                 }
484
485         rr->off=0;
486         /* So at this point the following is true
487          * ssl->s3->rrec.type   is the type of record
488          * ssl->s3->rrec.length == number of bytes in record
489          * ssl->s3->rrec.off    == offset to first valid byte
490          * ssl->s3->rrec.data   == where to take bytes from, increment
491          *                         after use :-).
492          */
493
494         /* we have pulled in a full packet so zero things */
495         s->packet_length=0;
496         dtls1_record_bitmap_update(s, &(s->d1->bitmap));/* Mark receipt of record. */
497         return(1);
498
499 decryption_failed_or_bad_record_mac:
500         /* Separate 'decryption_failed' alert was introduced with TLS 1.0,
501          * SSL 3.0 only has 'bad_record_mac'.  But unless a decryption
502          * failure is directly visible from the ciphertext anyway,
503          * we should not reveal which kind of error occured -- this
504          * might become visible to an attacker (e.g. via logfile) */
505         al=SSL_AD_BAD_RECORD_MAC;
506         SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
507 f_err:
508         ssl3_send_alert(s,SSL3_AL_FATAL,al);
509 err:
510         return(0);
511 }
512
513
514 /* Call this to get a new input record.
515  * It will return <= 0 if more data is needed, normally due to an error
516  * or non-blocking IO.
517  * When it finishes, one packet has been decoded and can be found in
518  * ssl->s3->rrec.type    - is the type of record
519  * ssl->s3->rrec.data,   - data
520  * ssl->s3->rrec.length, - number of bytes
521  */
522 /* used only by dtls1_read_bytes */
523 int dtls1_get_record(SSL *s)
524         {
525         int ssl_major,ssl_minor,al;
526         int i,n;
527         SSL3_RECORD *rr;
528         SSL_SESSION *sess;
529         unsigned char *p;
530         unsigned short version;
531         DTLS1_BITMAP *bitmap;
532         unsigned int is_next_epoch;
533
534         rr= &(s->s3->rrec);
535         sess=s->session;
536
537         /* The epoch may have changed.  If so, process all the
538          * pending records.  This is a non-blocking operation. */
539         if ( ! dtls1_process_buffered_records(s))
540             return 0;
541
542         /* if we're renegotiating, then there may be buffered records */
543         if (dtls1_get_processed_record(s))
544                 return 1;
545
546         /* get something from the wire */
547 again:
548         /* check if we have the header */
549         if (    (s->rstate != SSL_ST_READ_BODY) ||
550                 (s->packet_length < DTLS1_RT_HEADER_LENGTH)) 
551                 {
552                 n=ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
553                 /* read timeout is handled by dtls1_read_bytes */
554                 if (n <= 0) return(n); /* error or non-blocking */
555
556                 OPENSSL_assert(s->packet_length == DTLS1_RT_HEADER_LENGTH);
557
558                 s->rstate=SSL_ST_READ_BODY;
559
560                 p=s->packet;
561
562                 /* Pull apart the header into the DTLS1_RECORD */
563                 rr->type= *(p++);
564                 ssl_major= *(p++);
565                 ssl_minor= *(p++);
566                 version=(ssl_major<<8)|ssl_minor;
567
568                 /* sequence number is 64 bits, with top 2 bytes = epoch */ 
569                 n2s(p,rr->epoch);
570
571                 memcpy(&(s->s3->read_sequence[2]), p, 6);
572                 p+=6;
573
574                 n2s(p,rr->length);
575
576                 /* Lets check version */
577                 if (!s->first_packet)
578                         {
579                         if (version != s->version)
580                                 {
581                                 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
582                                 /* Send back error using their
583                                  * version number :-) */
584                                 s->version=version;
585                                 al=SSL_AD_PROTOCOL_VERSION;
586                                 goto f_err;
587                                 }
588                         }
589
590                 if ((version & 0xff00) != (DTLS1_VERSION & 0xff00))
591                         {
592                         SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
593                         goto err;
594                         }
595
596                 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
597                         {
598                         al=SSL_AD_RECORD_OVERFLOW;
599                         SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_PACKET_LENGTH_TOO_LONG);
600                         goto f_err;
601                         }
602
603                 /* now s->rstate == SSL_ST_READ_BODY */
604                 }
605
606         /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
607
608         if (rr->length > s->packet_length-DTLS1_RT_HEADER_LENGTH)
609                 {
610                 /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
611                 i=rr->length;
612                 n=ssl3_read_n(s,i,i,1);
613                 if (n <= 0) return(n); /* error or non-blocking io */
614
615                 /* this packet contained a partial record, dump it */
616                 if ( n != i)
617                         {
618                         s->packet_length = 0;
619                         goto again;
620                         }
621
622                 /* now n == rr->length,
623                  * and s->packet_length == DTLS1_RT_HEADER_LENGTH + rr->length */
624                 }
625         s->rstate=SSL_ST_READ_HEADER; /* set state for later operations */
626
627         /* match epochs.  NULL means the packet is dropped on the floor */
628         bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
629         if ( bitmap == NULL)
630                 {
631                 s->packet_length = 0;  /* dump this record */
632                 goto again;   /* get another record */
633                 }
634
635         /* check whether this is a repeat, or aged record */
636         if ( ! dtls1_record_replay_check(s, bitmap))
637                 {
638                 rr->length = 0;
639                 s->packet_length=0; /* dump this record */
640                 goto again;     /* get another record */
641                 }
642
643         /* just read a 0 length packet */
644         if (rr->length == 0) goto again;
645
646         /* If this record is from the next epoch (either HM or ALERT),
647          * buffer it since it cannot be processed at this time. Records
648          * from the next epoch are marked as received even though they
649          * are not processed, so as to prevent any potential resource
650          * DoS attack */
651         if (is_next_epoch)
652                 {
653                 dtls1_record_bitmap_update(s, bitmap);
654                 dtls1_buffer_record(s, &(s->d1->unprocessed_rcds), rr->seq_num);
655                 s->packet_length = 0;
656                 goto again;
657                 }
658
659         if ( ! dtls1_process_record(s))
660                 return(0);
661
662         dtls1_clear_timeouts(s);  /* done waiting */
663         return(1);
664
665 f_err:
666         ssl3_send_alert(s,SSL3_AL_FATAL,al);
667 err:
668         return(0);
669         }
670
671 /* Return up to 'len' payload bytes received in 'type' records.
672  * 'type' is one of the following:
673  *
674  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
675  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
676  *   -  0 (during a shutdown, no data has to be returned)
677  *
678  * If we don't have stored data to work from, read a SSL/TLS record first
679  * (possibly multiple records if we still don't have anything to return).
680  *
681  * This function must handle any surprises the peer may have for us, such as
682  * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
683  * a surprise, but handled as if it were), or renegotiation requests.
684  * Also if record payloads contain fragments too small to process, we store
685  * them until there is enough for the respective protocol (the record protocol
686  * may use arbitrary fragmentation and even interleaving):
687  *     Change cipher spec protocol
688  *             just 1 byte needed, no need for keeping anything stored
689  *     Alert protocol
690  *             2 bytes needed (AlertLevel, AlertDescription)
691  *     Handshake protocol
692  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
693  *             to detect unexpected Client Hello and Hello Request messages
694  *             here, anything else is handled by higher layers
695  *     Application data protocol
696  *             none of our business
697  */
698 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
699         {
700         int al,i,j,ret;
701         unsigned int n;
702         SSL3_RECORD *rr;
703         void (*cb)(const SSL *ssl,int type2,int val)=NULL;
704
705         if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
706                 if (!ssl3_setup_buffers(s))
707                         return(-1);
708
709     /* XXX: check what the second '&& type' is about */
710         if ((type && (type != SSL3_RT_APPLICATION_DATA) && 
711                 (type != SSL3_RT_HANDSHAKE) && type) ||
712             (peek && (type != SSL3_RT_APPLICATION_DATA)))
713                 {
714                 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
715                 return -1;
716                 }
717
718         /* check whether there's a handshake message (client hello?) waiting */
719         if ( (ret = have_handshake_fragment(s, type, buf, len, peek)))
720                 return ret;
721
722         /* Now s->d1->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE. */
723
724         if (!s->in_handshake && SSL_in_init(s))
725                 {
726                 /* type == SSL3_RT_APPLICATION_DATA */
727                 i=s->handshake_func(s);
728                 if (i < 0) return(i);
729                 if (i == 0)
730                         {
731                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
732                         return(-1);
733                         }
734                 }
735
736 start:
737         s->rwstate=SSL_NOTHING;
738
739         /* s->s3->rrec.type         - is the type of record
740          * s->s3->rrec.data,    - data
741          * s->s3->rrec.off,     - offset into 'data' for next read
742          * s->s3->rrec.length,  - number of bytes. */
743         rr = &(s->s3->rrec);
744
745         /* get new packet if necessary */
746         if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY))
747                 {
748                 ret=dtls1_get_record(s);
749                 if (ret <= 0) 
750                         {
751                         ret = dtls1_read_failed(s, ret);
752                         /* anything other than a timeout is an error */
753                         if (ret <= 0)  
754                                 return(ret);
755                         else
756                                 goto start;
757                         }
758                 }
759
760         /* we now have a packet which can be read and processed */
761
762         if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
763                                        * reset by ssl3_get_finished */
764                 && (rr->type != SSL3_RT_HANDSHAKE))
765                 {
766                 al=SSL_AD_UNEXPECTED_MESSAGE;
767                 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
768                 goto err;
769                 }
770
771         /* If the other end has shut down, throw anything we read away
772          * (even in 'peek' mode) */
773         if (s->shutdown & SSL_RECEIVED_SHUTDOWN)
774                 {
775                 rr->length=0;
776                 s->rwstate=SSL_NOTHING;
777                 return(0);
778                 }
779
780
781         if (type == rr->type) /* SSL3_RT_APPLICATION_DATA or SSL3_RT_HANDSHAKE */
782                 {
783                 /* make sure that we are not getting application data when we
784                  * are doing a handshake for the first time */
785                 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
786                         (s->enc_read_ctx == NULL))
787                         {
788                         al=SSL_AD_UNEXPECTED_MESSAGE;
789                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_APP_DATA_IN_HANDSHAKE);
790                         goto f_err;
791                         }
792
793                 if (len <= 0) return(len);
794
795                 if ((unsigned int)len > rr->length)
796                         n = rr->length;
797                 else
798                         n = (unsigned int)len;
799
800                 memcpy(buf,&(rr->data[rr->off]),n);
801                 if (!peek)
802                         {
803                         rr->length-=n;
804                         rr->off+=n;
805                         if (rr->length == 0)
806                                 {
807                                 s->rstate=SSL_ST_READ_HEADER;
808                                 rr->off=0;
809                                 }
810                         }
811                 return(n);
812                 }
813
814
815         /* If we get here, then type != rr->type; if we have a handshake
816          * message, then it was unexpected (Hello Request or Client Hello). */
817
818         /* In case of record types for which we have 'fragment' storage,
819          * fill that so that we can process the data at a fixed place.
820          */
821                 {
822                 unsigned int k, dest_maxlen = 0;
823                 unsigned char *dest = NULL;
824                 unsigned int *dest_len = NULL;
825
826                 if (rr->type == SSL3_RT_HANDSHAKE)
827                         {
828                         dest_maxlen = sizeof s->d1->handshake_fragment;
829                         dest = s->d1->handshake_fragment;
830                         dest_len = &s->d1->handshake_fragment_len;
831                         }
832                 else if (rr->type == SSL3_RT_ALERT)
833                         {
834                         dest_maxlen = sizeof(s->d1->alert_fragment);
835                         dest = s->d1->alert_fragment;
836                         dest_len = &s->d1->alert_fragment_len;
837                         }
838                 /* else it's a CCS message, or it's wrong */
839                 else if (rr->type != SSL3_RT_CHANGE_CIPHER_SPEC)
840                         {
841                           /* Not certain if this is the right error handling */
842                           al=SSL_AD_UNEXPECTED_MESSAGE;
843                           SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
844                           goto f_err;
845                         }
846
847
848                 if (dest_maxlen > 0)
849                         {
850             /* XDTLS:  In a pathalogical case, the Client Hello
851              *  may be fragmented--don't always expect dest_maxlen bytes */
852                         if ( rr->length < dest_maxlen)
853                                 {
854 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
855                                 /*
856                                  * for normal alerts rr->length is 2, while
857                                  * dest_maxlen is 7 if we were to handle this
858                                  * non-existing alert...
859                                  */
860                                 FIX ME
861 #endif
862                                 s->rstate=SSL_ST_READ_HEADER;
863                                 rr->length = 0;
864                                 goto start;
865                                 }
866
867                         /* now move 'n' bytes: */
868                         for ( k = 0; k < dest_maxlen; k++)
869                                 {
870                                 dest[k] = rr->data[rr->off++];
871                                 rr->length--;
872                                 }
873                         *dest_len = dest_maxlen;
874                         }
875                 }
876
877         /* s->d1->handshake_fragment_len == 12  iff  rr->type == SSL3_RT_HANDSHAKE;
878          * s->d1->alert_fragment_len == 7      iff  rr->type == SSL3_RT_ALERT.
879          * (Possibly rr is 'empty' now, i.e. rr->length may be 0.) */
880
881         /* If we are a client, check for an incoming 'Hello Request': */
882         if ((!s->server) &&
883                 (s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
884                 (s->d1->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
885                 (s->session != NULL) && (s->session->cipher != NULL))
886                 {
887                 s->d1->handshake_fragment_len = 0;
888
889                 if ((s->d1->handshake_fragment[1] != 0) ||
890                         (s->d1->handshake_fragment[2] != 0) ||
891                         (s->d1->handshake_fragment[3] != 0))
892                         {
893                         al=SSL_AD_DECODE_ERROR;
894                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_HELLO_REQUEST);
895                         goto err;
896                         }
897
898                 /* no need to check sequence number on HELLO REQUEST messages */
899
900                 if (s->msg_callback)
901                         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, 
902                                 s->d1->handshake_fragment, 4, s, s->msg_callback_arg);
903
904                 if (SSL_is_init_finished(s) &&
905                         !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
906                         !s->s3->renegotiate)
907                         {
908                         ssl3_renegotiate(s);
909                         if (ssl3_renegotiate_check(s))
910                                 {
911                                 i=s->handshake_func(s);
912                                 if (i < 0) return(i);
913                                 if (i == 0)
914                                         {
915                                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
916                                         return(-1);
917                                         }
918
919                                 if (!(s->mode & SSL_MODE_AUTO_RETRY))
920                                         {
921                                         if (s->s3->rbuf.left == 0) /* no read-ahead left? */
922                                                 {
923                                                 BIO *bio;
924                                                 /* In the case where we try to read application data,
925                                                  * but we trigger an SSL handshake, we return -1 with
926                                                  * the retry option set.  Otherwise renegotiation may
927                                                  * cause nasty problems in the blocking world */
928                                                 s->rwstate=SSL_READING;
929                                                 bio=SSL_get_rbio(s);
930                                                 BIO_clear_retry_flags(bio);
931                                                 BIO_set_retry_read(bio);
932                                                 return(-1);
933                                                 }
934                                         }
935                                 }
936                         }
937                 /* we either finished a handshake or ignored the request,
938                  * now try again to obtain the (application) data we were asked for */
939                 goto start;
940                 }
941
942         if (s->d1->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH)
943                 {
944                 int alert_level = s->d1->alert_fragment[0];
945                 int alert_descr = s->d1->alert_fragment[1];
946
947                 s->d1->alert_fragment_len = 0;
948
949                 if (s->msg_callback)
950                         s->msg_callback(0, s->version, SSL3_RT_ALERT, 
951                                 s->d1->alert_fragment, 2, s, s->msg_callback_arg);
952
953                 if (s->info_callback != NULL)
954                         cb=s->info_callback;
955                 else if (s->ctx->info_callback != NULL)
956                         cb=s->ctx->info_callback;
957
958                 if (cb != NULL)
959                         {
960                         j = (alert_level << 8) | alert_descr;
961                         cb(s, SSL_CB_READ_ALERT, j);
962                         }
963
964                 if (alert_level == 1) /* warning */
965                         {
966                         s->s3->warn_alert = alert_descr;
967                         if (alert_descr == SSL_AD_CLOSE_NOTIFY)
968                                 {
969                                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
970                                 return(0);
971                                 }
972 #if 0
973             /* XXX: this is a possible improvement in the future */
974                         /* now check if it's a missing record */
975                         if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
976                                 {
977                                 unsigned short seq;
978                                 unsigned int frag_off;
979                                 unsigned char *p = &(s->d1->alert_fragment[2]);
980
981                                 n2s(p, seq);
982                                 n2l3(p, frag_off);
983
984                                 dtls1_retransmit_message(s, seq, frag_off, &found);
985                                 if ( ! found  && SSL_in_init(s))
986                                         {
987                                         /* fprintf( stderr,"in init = %d\n", SSL_in_init(s)); */
988                                         /* requested a message not yet sent, 
989                                            send an alert ourselves */
990                                         ssl3_send_alert(s,SSL3_AL_WARNING,
991                                                 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
992                                         }
993                                 }
994 #endif
995                         }
996                 else if (alert_level == 2) /* fatal */
997                         {
998                         char tmp[16];
999
1000                         s->rwstate=SSL_NOTHING;
1001                         s->s3->fatal_alert = alert_descr;
1002                         SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1003                         BIO_snprintf(tmp,sizeof tmp,"%d",alert_descr);
1004                         ERR_add_error_data(2,"SSL alert number ",tmp);
1005                         s->shutdown|=SSL_RECEIVED_SHUTDOWN;
1006                         SSL_CTX_remove_session(s->ctx,s->session);
1007                         return(0);
1008                         }
1009                 else
1010                         {
1011                         al=SSL_AD_ILLEGAL_PARAMETER;
1012                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNKNOWN_ALERT_TYPE);
1013                         goto f_err;
1014                         }
1015
1016                 goto start;
1017                 }
1018
1019         if (s->shutdown & SSL_SENT_SHUTDOWN) /* but we have not received a shutdown */
1020                 {
1021                 s->rwstate=SSL_NOTHING;
1022                 rr->length=0;
1023                 return(0);
1024                 }
1025
1026         if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1027                 {
1028                 struct ccs_header_st ccs_hdr;
1029
1030                 dtls1_get_ccs_header(rr->data, &ccs_hdr);
1031
1032                 /* 'Change Cipher Spec' is just a single byte, so we know
1033                  * exactly what the record payload has to look like */
1034                 /* XDTLS: check that epoch is consistent */
1035                 if (    (rr->length != DTLS1_CCS_HEADER_LENGTH) || 
1036                         (rr->off != 0) || (rr->data[0] != SSL3_MT_CCS))
1037                         {
1038                         i=SSL_AD_ILLEGAL_PARAMETER;
1039                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_CHANGE_CIPHER_SPEC);
1040                         goto err;
1041                         }
1042
1043                 rr->length=0;
1044
1045                 if (s->msg_callback)
1046                         s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC, 
1047                                 rr->data, 1, s, s->msg_callback_arg);
1048
1049                 s->s3->change_cipher_spec=1;
1050                 if (!ssl3_do_change_cipher_spec(s))
1051                         goto err;
1052
1053                 /* do this whenever CCS is processed */
1054                 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
1055
1056                 goto start;
1057                 }
1058
1059         /* Unexpected handshake message (Client Hello, or protocol violation) */
1060         if ((s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) && 
1061                 !s->in_handshake)
1062                 {
1063                 struct hm_header_st msg_hdr;
1064                 
1065                 /* this may just be a stale retransmit */
1066                 dtls1_get_message_header(rr->data, &msg_hdr);
1067                 if( rr->epoch != s->d1->r_epoch)
1068                         {
1069                         rr->length = 0;
1070                         goto start;
1071                         }
1072
1073                 if (((s->state&SSL_ST_MASK) == SSL_ST_OK) &&
1074                         !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS))
1075                         {
1076 #if 0 /* worked only because C operator preferences are not as expected (and
1077        * because this is not really needed for clients except for detecting
1078        * protocol violations): */
1079                         s->state=SSL_ST_BEFORE|(s->server)
1080                                 ?SSL_ST_ACCEPT
1081                                 :SSL_ST_CONNECT;
1082 #else
1083                         s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1084 #endif
1085                         s->new_session=1;
1086                         }
1087                 i=s->handshake_func(s);
1088                 if (i < 0) return(i);
1089                 if (i == 0)
1090                         {
1091                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1092                         return(-1);
1093                         }
1094
1095                 if (!(s->mode & SSL_MODE_AUTO_RETRY))
1096                         {
1097                         if (s->s3->rbuf.left == 0) /* no read-ahead left? */
1098                                 {
1099                                 BIO *bio;
1100                                 /* In the case where we try to read application data,
1101                                  * but we trigger an SSL handshake, we return -1 with
1102                                  * the retry option set.  Otherwise renegotiation may
1103                                  * cause nasty problems in the blocking world */
1104                                 s->rwstate=SSL_READING;
1105                                 bio=SSL_get_rbio(s);
1106                                 BIO_clear_retry_flags(bio);
1107                                 BIO_set_retry_read(bio);
1108                                 return(-1);
1109                                 }
1110                         }
1111                 goto start;
1112                 }
1113
1114         switch (rr->type)
1115                 {
1116         default:
1117 #ifndef OPENSSL_NO_TLS
1118                 /* TLS just ignores unknown message types */
1119                 if (s->version == TLS1_VERSION)
1120                         {
1121                         rr->length = 0;
1122                         goto start;
1123                         }
1124 #endif
1125                 al=SSL_AD_UNEXPECTED_MESSAGE;
1126                 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1127                 goto f_err;
1128         case SSL3_RT_CHANGE_CIPHER_SPEC:
1129         case SSL3_RT_ALERT:
1130         case SSL3_RT_HANDSHAKE:
1131                 /* we already handled all of these, with the possible exception
1132                  * of SSL3_RT_HANDSHAKE when s->in_handshake is set, but that
1133                  * should not happen when type != rr->type */
1134                 al=SSL_AD_UNEXPECTED_MESSAGE;
1135                 SSLerr(SSL_F_DTLS1_READ_BYTES,ERR_R_INTERNAL_ERROR);
1136                 goto f_err;
1137         case SSL3_RT_APPLICATION_DATA:
1138                 /* At this point, we were expecting handshake data,
1139                  * but have application data.  If the library was
1140                  * running inside ssl3_read() (i.e. in_read_app_data
1141                  * is set) and it makes sense to read application data
1142                  * at this point (session renegotiation not yet started),
1143                  * we will indulge it.
1144                  */
1145                 if (s->s3->in_read_app_data &&
1146                         (s->s3->total_renegotiations != 0) &&
1147                         ((
1148                                 (s->state & SSL_ST_CONNECT) &&
1149                                 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1150                                 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1151                                 ) || (
1152                                         (s->state & SSL_ST_ACCEPT) &&
1153                                         (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1154                                         (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1155                                         )
1156                                 ))
1157                         {
1158                         s->s3->in_read_app_data=2;
1159                         return(-1);
1160                         }
1161                 else
1162                         {
1163                         al=SSL_AD_UNEXPECTED_MESSAGE;
1164                         SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1165                         goto f_err;
1166                         }
1167                 }
1168         /* not reached */
1169
1170 f_err:
1171         ssl3_send_alert(s,SSL3_AL_FATAL,al);
1172 err:
1173         return(-1);
1174         }
1175
1176 int
1177 dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, int len)
1178         {
1179         unsigned int n,tot;
1180         int i;
1181
1182         if (SSL_in_init(s) && !s->in_handshake)
1183                 {
1184                 i=s->handshake_func(s);
1185                 if (i < 0) return(i);
1186                 if (i == 0)
1187                         {
1188                         SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1189                         return -1;
1190                         }
1191                 }
1192
1193         tot = s->s3->wnum;
1194         n = len - tot;
1195
1196         while( n)
1197                 {
1198                 /* dtls1_write_bytes sends one record at a time, sized according to 
1199                  * the currently known MTU */
1200                 i = dtls1_write_bytes(s, type, buf_, len);
1201                 if (i <= 0) return i;
1202                 
1203                 if ((i == (int)n) ||
1204                         (type == SSL3_RT_APPLICATION_DATA &&
1205                                 (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE)))
1206                         {
1207                         /* next chunk of data should get another prepended empty fragment
1208                          * in ciphersuites with known-IV weakness: */
1209                         s->s3->empty_fragment_done = 0;
1210                         return tot+i;
1211                         }
1212
1213                 tot += i;
1214                 n-=i;
1215                 }
1216
1217         return tot;
1218         }
1219
1220
1221         /* this only happens when a client hello is received and a handshake 
1222          * is started. */
1223 static int
1224 have_handshake_fragment(SSL *s, int type, unsigned char *buf, 
1225         int len, int peek)
1226         {
1227         
1228         if ((type == SSL3_RT_HANDSHAKE) && (s->d1->handshake_fragment_len > 0))
1229                 /* (partially) satisfy request from storage */
1230                 {
1231                 unsigned char *src = s->d1->handshake_fragment;
1232                 unsigned char *dst = buf;
1233                 unsigned int k,n;
1234                 
1235                 /* peek == 0 */
1236                 n = 0;
1237                 while ((len > 0) && (s->d1->handshake_fragment_len > 0))
1238                         {
1239                         *dst++ = *src++;
1240                         len--; s->d1->handshake_fragment_len--;
1241                         n++;
1242                         }
1243                 /* move any remaining fragment bytes: */
1244                 for (k = 0; k < s->d1->handshake_fragment_len; k++)
1245                         s->d1->handshake_fragment[k] = *src++;
1246                 return n;
1247                 }
1248         
1249         return 0;
1250         }
1251
1252
1253
1254
1255 /* Call this to write data in records of type 'type'
1256  * It will return <= 0 if not all data has been sent or non-blocking IO.
1257  */
1258 int dtls1_write_bytes(SSL *s, int type, const void *buf_, int len)
1259         {
1260         const unsigned char *buf=buf_;
1261         unsigned int tot,n,nw;
1262         int i;
1263         unsigned int mtu;
1264
1265         s->rwstate=SSL_NOTHING;
1266         tot=s->s3->wnum;
1267
1268         n=(len-tot);
1269
1270         /* handshake layer figures out MTU for itself, but data records
1271          * are also sent through this interface, so need to figure out MTU */
1272 #if 0
1273         mtu = BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_MTU, 0, NULL);
1274         mtu += DTLS1_HM_HEADER_LENGTH;  /* HM already inserted */
1275 #endif
1276         mtu = s->d1->mtu;
1277
1278         if (mtu > SSL3_RT_MAX_PLAIN_LENGTH)
1279                 mtu = SSL3_RT_MAX_PLAIN_LENGTH;
1280
1281         if (n > mtu)
1282                 nw=mtu;
1283         else
1284                 nw=n;
1285         
1286         i=do_dtls1_write(s, type, &(buf[tot]), nw, 0);
1287         if (i <= 0)
1288                 {
1289                 s->s3->wnum=tot;
1290                 return i;
1291                 }
1292
1293         if ( (int)s->s3->wnum + i == len)
1294                 s->s3->wnum = 0;
1295         else 
1296                 s->s3->wnum += i;
1297
1298         return i;
1299         }
1300
1301 int do_dtls1_write(SSL *s, int type, const unsigned char *buf, unsigned int len, int create_empty_fragment)
1302         {
1303         unsigned char *p,*pseq;
1304         int i,mac_size,clear=0;
1305         int prefix_len = 0;
1306         SSL3_RECORD *wr;
1307         SSL3_BUFFER *wb;
1308         SSL_SESSION *sess;
1309         int bs;
1310
1311         /* first check if there is a SSL3_BUFFER still being written
1312          * out.  This will happen with non blocking IO */
1313         if (s->s3->wbuf.left != 0)
1314                 {
1315                 OPENSSL_assert(0); /* XDTLS:  want to see if we ever get here */
1316                 return(ssl3_write_pending(s,type,buf,len));
1317                 }
1318
1319         /* If we have an alert to send, lets send it */
1320         if (s->s3->alert_dispatch)
1321                 {
1322                 i=s->method->ssl_dispatch_alert(s);
1323                 if (i <= 0)
1324                         return(i);
1325                 /* if it went, fall through and send more stuff */
1326                 }
1327
1328         if (len == 0 && !create_empty_fragment)
1329                 return 0;
1330
1331         wr= &(s->s3->wrec);
1332         wb= &(s->s3->wbuf);
1333         sess=s->session;
1334
1335         if (    (sess == NULL) ||
1336                 (s->enc_write_ctx == NULL) ||
1337                 (EVP_MD_CTX_md(s->write_hash) == NULL))
1338                 clear=1;
1339
1340         if (clear)
1341                 mac_size=0;
1342         else
1343                 mac_size=EVP_MD_CTX_size(s->write_hash);
1344
1345         /* DTLS implements explicit IV, so no need for empty fragments */
1346 #if 0
1347         /* 'create_empty_fragment' is true only when this function calls itself */
1348         if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done
1349                 && SSL_version(s) != DTLS1_VERSION)
1350                 {
1351                 /* countermeasure against known-IV weakness in CBC ciphersuites
1352                  * (see http://www.openssl.org/~bodo/tls-cbc.txt) 
1353                  */
1354
1355                 if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA)
1356                         {
1357                         /* recursive function call with 'create_empty_fragment' set;
1358                          * this prepares and buffers the data for an empty fragment
1359                          * (these 'prefix_len' bytes are sent out later
1360                          * together with the actual payload) */
1361                         prefix_len = s->method->do_ssl_write(s, type, buf, 0, 1);
1362                         if (prefix_len <= 0)
1363                                 goto err;
1364
1365                         if (s->s3->wbuf.len < (size_t)prefix_len + SSL3_RT_MAX_PACKET_SIZE)
1366                                 {
1367                                 /* insufficient space */
1368                                 SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
1369                                 goto err;
1370                                 }
1371                         }
1372                 
1373                 s->s3->empty_fragment_done = 1;
1374                 }
1375 #endif
1376
1377         p = wb->buf + prefix_len;
1378
1379         /* write the header */
1380
1381         *(p++)=type&0xff;
1382         wr->type=type;
1383
1384         *(p++)=(s->version>>8);
1385         *(p++)=s->version&0xff;
1386
1387         /* field where we are to write out packet epoch, seq num and len */
1388         pseq=p; 
1389         p+=10;
1390
1391         /* lets setup the record stuff. */
1392
1393         /* Make space for the explicit IV in case of CBC.
1394          * (this is a bit of a boundary violation, but what the heck).
1395          */
1396         if ( s->enc_write_ctx && 
1397                 (EVP_CIPHER_mode( s->enc_write_ctx->cipher ) & EVP_CIPH_CBC_MODE))
1398                 bs = EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
1399         else
1400                 bs = 0;
1401
1402         wr->data=p + bs;  /* make room for IV in case of CBC */
1403         wr->length=(int)len;
1404         wr->input=(unsigned char *)buf;
1405
1406         /* we now 'read' from wr->input, wr->length bytes into
1407          * wr->data */
1408
1409         /* first we compress */
1410         if (s->compress != NULL)
1411                 {
1412                 if (!ssl3_do_compress(s))
1413                         {
1414                         SSLerr(SSL_F_DO_DTLS1_WRITE,SSL_R_COMPRESSION_FAILURE);
1415                         goto err;
1416                         }
1417                 }
1418         else
1419                 {
1420                 memcpy(wr->data,wr->input,wr->length);
1421                 wr->input=wr->data;
1422                 }
1423
1424         /* we should still have the output to wr->data and the input
1425          * from wr->input.  Length should be wr->length.
1426          * wr->data still points in the wb->buf */
1427
1428         if (mac_size != 0)
1429                 {
1430                 s->method->ssl3_enc->mac(s,&(p[wr->length + bs]),1);
1431                 wr->length+=mac_size;
1432                 }
1433
1434         /* this is true regardless of mac size */
1435         wr->input=p;
1436         wr->data=p;
1437
1438
1439         /* ssl3_enc can only have an error on read */
1440         if (bs) /* bs != 0 in case of CBC */
1441                 {
1442                 RAND_pseudo_bytes(p,bs);
1443                 /* master IV and last CBC residue stand for
1444                  * the rest of randomness */
1445                 wr->length += bs;
1446                 }
1447
1448         s->method->ssl3_enc->enc(s,1);
1449
1450         /* record length after mac and block padding */
1451 /*      if (type == SSL3_RT_APPLICATION_DATA ||
1452         (type == SSL3_RT_ALERT && ! SSL_in_init(s))) */
1453         
1454         /* there's only one epoch between handshake and app data */
1455         
1456         s2n(s->d1->w_epoch, pseq);
1457
1458         /* XDTLS: ?? */
1459 /*      else
1460         s2n(s->d1->handshake_epoch, pseq); */
1461
1462         memcpy(pseq, &(s->s3->write_sequence[2]), 6);
1463         pseq+=6;
1464         s2n(wr->length,pseq);
1465
1466         /* we should now have
1467          * wr->data pointing to the encrypted data, which is
1468          * wr->length long */
1469         wr->type=type; /* not needed but helps for debugging */
1470         wr->length+=DTLS1_RT_HEADER_LENGTH;
1471
1472 #if 0  /* this is now done at the message layer */
1473         /* buffer the record, making it easy to handle retransmits */
1474         if ( type == SSL3_RT_HANDSHAKE || type == SSL3_RT_CHANGE_CIPHER_SPEC)
1475                 dtls1_buffer_record(s, wr->data, wr->length, 
1476                         *((PQ_64BIT *)&(s->s3->write_sequence[0])));
1477 #endif
1478
1479         ssl3_record_sequence_update(&(s->s3->write_sequence[0]));
1480
1481         if (create_empty_fragment)
1482                 {
1483                 /* we are in a recursive call;
1484                  * just return the length, don't write out anything here
1485                  */
1486                 return wr->length;
1487                 }
1488
1489         /* now let's set up wb */
1490         wb->left = prefix_len + wr->length;
1491         wb->offset = 0;
1492
1493         /* memorize arguments so that ssl3_write_pending can detect bad write retries later */
1494         s->s3->wpend_tot=len;
1495         s->s3->wpend_buf=buf;
1496         s->s3->wpend_type=type;
1497         s->s3->wpend_ret=len;
1498
1499         /* we now just need to write the buffer */
1500         return ssl3_write_pending(s,type,buf,len);
1501 err:
1502         return -1;
1503         }
1504
1505
1506
1507 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap)
1508         {
1509         int cmp;
1510         unsigned int shift;
1511         const unsigned char *seq = s->s3->read_sequence;
1512
1513         cmp = satsub64be(seq,bitmap->max_seq_num);
1514         if (cmp > 0)
1515                 {
1516                 memcpy (s->s3->rrec.seq_num,seq,8);
1517                 return 1; /* this record in new */
1518                 }
1519         shift = -cmp;
1520         if (shift >= sizeof(bitmap->map)*8)
1521                 return 0; /* stale, outside the window */
1522         else if (bitmap->map & (1UL<<shift))
1523                 return 0; /* record previously received */
1524
1525         memcpy (s->s3->rrec.seq_num,seq,8);
1526         return 1;
1527         }
1528
1529
1530 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
1531         {
1532         int cmp;
1533         unsigned int shift;
1534         const unsigned char *seq = s->s3->read_sequence;
1535
1536         cmp = satsub64be(seq,bitmap->max_seq_num);
1537         if (cmp > 0)
1538                 {
1539                 shift = cmp;
1540                 if (shift < sizeof(bitmap->map)*8)
1541                         bitmap->map <<= shift, bitmap->map |= 1UL;
1542                 else
1543                         bitmap->map = 1UL;
1544                 memcpy(bitmap->max_seq_num,seq,8);
1545                 }
1546         else    {
1547                 shift = -cmp;
1548                 if (shift < sizeof(bitmap->map)*8)
1549                         bitmap->map |= 1UL<<shift;
1550                 }
1551         }
1552
1553
1554 int dtls1_dispatch_alert(SSL *s)
1555         {
1556         int i,j;
1557         void (*cb)(const SSL *ssl,int type,int val)=NULL;
1558         unsigned char buf[DTLS1_AL_HEADER_LENGTH];
1559         unsigned char *ptr = &buf[0];
1560
1561         s->s3->alert_dispatch=0;
1562
1563         memset(buf, 0x00, sizeof(buf));
1564         *ptr++ = s->s3->send_alert[0];
1565         *ptr++ = s->s3->send_alert[1];
1566
1567 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1568         if (s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
1569                 {       
1570                 s2n(s->d1->handshake_read_seq, ptr);
1571 #if 0
1572                 if ( s->d1->r_msg_hdr.frag_off == 0)  /* waiting for a new msg */
1573
1574                 else
1575                         s2n(s->d1->r_msg_hdr.seq, ptr); /* partial msg read */
1576 #endif
1577
1578 #if 0
1579                 fprintf(stderr, "s->d1->handshake_read_seq = %d, s->d1->r_msg_hdr.seq = %d\n",s->d1->handshake_read_seq,s->d1->r_msg_hdr.seq);
1580 #endif
1581                 l2n3(s->d1->r_msg_hdr.frag_off, ptr);
1582                 }
1583 #endif
1584
1585         i = do_dtls1_write(s, SSL3_RT_ALERT, &buf[0], sizeof(buf), 0);
1586         if (i <= 0)
1587                 {
1588                 s->s3->alert_dispatch=1;
1589                 /* fprintf( stderr, "not done with alert\n" ); */
1590                 }
1591         else
1592                 {
1593                 if (s->s3->send_alert[0] == SSL3_AL_FATAL
1594 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1595                     || s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1596 #endif
1597                     )
1598                         (void)BIO_flush(s->wbio);
1599
1600                 if (s->msg_callback)
1601                         s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert, 
1602                                 2, s, s->msg_callback_arg);
1603
1604                 if (s->info_callback != NULL)
1605                         cb=s->info_callback;
1606                 else if (s->ctx->info_callback != NULL)
1607                         cb=s->ctx->info_callback;
1608
1609                 if (cb != NULL)
1610                         {
1611                         j=(s->s3->send_alert[0]<<8)|s->s3->send_alert[1];
1612                         cb(s,SSL_CB_WRITE_ALERT,j);
1613                         }
1614                 }
1615         return(i);
1616         }
1617
1618
1619 static DTLS1_BITMAP *
1620 dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr, unsigned int *is_next_epoch)
1621     {
1622     
1623     *is_next_epoch = 0;
1624
1625     /* In current epoch, accept HM, CCS, DATA, & ALERT */
1626     if (rr->epoch == s->d1->r_epoch)
1627         return &s->d1->bitmap;
1628
1629     /* Only HM and ALERT messages can be from the next epoch */
1630     else if (rr->epoch == (unsigned long)(s->d1->r_epoch + 1) &&
1631         (rr->type == SSL3_RT_HANDSHAKE ||
1632             rr->type == SSL3_RT_ALERT))
1633         {
1634         *is_next_epoch = 1;
1635         return &s->d1->next_bitmap;
1636         }
1637
1638     return NULL;
1639     }
1640
1641 #if 0
1642 static int
1643 dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr, unsigned short *priority,
1644         unsigned long *offset)
1645         {
1646
1647         /* alerts are passed up immediately */
1648         if ( rr->type == SSL3_RT_APPLICATION_DATA ||
1649                 rr->type == SSL3_RT_ALERT)
1650                 return 0;
1651
1652         /* Only need to buffer if a handshake is underway.
1653          * (this implies that Hello Request and Client Hello are passed up
1654          * immediately) */
1655         if ( SSL_in_init(s))
1656                 {
1657                 unsigned char *data = rr->data;
1658                 /* need to extract the HM/CCS sequence number here */
1659                 if ( rr->type == SSL3_RT_HANDSHAKE ||
1660                         rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1661                         {
1662                         unsigned short seq_num;
1663                         struct hm_header_st msg_hdr;
1664                         struct ccs_header_st ccs_hdr;
1665
1666                         if ( rr->type == SSL3_RT_HANDSHAKE)
1667                                 {
1668                                 dtls1_get_message_header(data, &msg_hdr);
1669                                 seq_num = msg_hdr.seq;
1670                                 *offset = msg_hdr.frag_off;
1671                                 }
1672                         else
1673                                 {
1674                                 dtls1_get_ccs_header(data, &ccs_hdr);
1675                                 seq_num = ccs_hdr.seq;
1676                                 *offset = 0;
1677                                 }
1678                                 
1679                         /* this is either a record we're waiting for, or a
1680                          * retransmit of something we happened to previously 
1681                          * receive (higher layers will drop the repeat silently */
1682                         if ( seq_num < s->d1->handshake_read_seq)
1683                                 return 0;
1684                         if (rr->type == SSL3_RT_HANDSHAKE && 
1685                                 seq_num == s->d1->handshake_read_seq &&
1686                                 msg_hdr.frag_off < s->d1->r_msg_hdr.frag_off)
1687                                 return 0;
1688                         else if ( seq_num == s->d1->handshake_read_seq &&
1689                                 (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC ||
1690                                         msg_hdr.frag_off == s->d1->r_msg_hdr.frag_off))
1691                                 return 0;
1692                         else
1693                                 {
1694                                 *priority = seq_num;
1695                                 return 1;
1696                                 }
1697                         }
1698                 else /* unknown record type */
1699                         return 0;
1700                 }
1701
1702         return 0;
1703         }
1704 #endif
1705
1706 void
1707 dtls1_reset_seq_numbers(SSL *s, int rw)
1708         {
1709         unsigned char *seq;
1710         unsigned int seq_bytes = sizeof(s->s3->read_sequence);
1711
1712         if ( rw & SSL3_CC_READ)
1713                 {
1714                 seq = s->s3->read_sequence;
1715                 s->d1->r_epoch++;
1716                 memcpy(&(s->d1->bitmap), &(s->d1->next_bitmap), sizeof(DTLS1_BITMAP));
1717                 memset(&(s->d1->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1718                 }
1719         else
1720                 {
1721                 seq = s->s3->write_sequence;
1722                 s->d1->w_epoch++;
1723                 }
1724
1725         memset(seq, 0x00, seq_bytes);
1726         }
1727
1728
1729 static void
1730 dtls1_clear_timeouts(SSL *s)
1731         {
1732         memset(&(s->d1->timeout), 0x00, sizeof(struct dtls1_timeout_st));
1733         }