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