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