Move openssl-0.9/ to openssl/.
[dragonfly.git] / crypto / openssl / ssl / d1_pkt.c
blobb2765ba8019ff70e5c05f4ff82e3db7ad1347f96
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.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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.
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/)"
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.
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.
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/)"
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 * ====================================================================
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).
59 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
60 * All rights reserved.
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.
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).
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.
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)"
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.
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.]
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>
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);
144 /* copy buffered record into SSL structure */
145 static int
146 dtls1_copy_record(SSL *s, pitem *item)
148 DTLS1_RECORD_DATA *rdata;
150 rdata = (DTLS1_RECORD_DATA *)item->data;
152 if (s->s3->rbuf.buf != NULL)
153 OPENSSL_free(s->s3->rbuf.buf);
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));
160 return(1);
164 static int
165 dtls1_buffer_record(SSL *s, record_pqueue *queue, PQ_64BIT priority)
167 DTLS1_RECORD_DATA *rdata;
168 pitem *item;
170 rdata = OPENSSL_malloc(sizeof(DTLS1_RECORD_DATA));
171 item = pitem_new(priority, rdata);
172 if (rdata == NULL || item == NULL)
174 if (rdata != NULL) OPENSSL_free(rdata);
175 if (item != NULL) pitem_free(item);
177 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
178 return(0);
181 rdata->packet = s->packet;
182 rdata->packet_length = s->packet_length;
183 memcpy(&(rdata->rbuf), &(s->s3->rbuf), sizeof(SSL3_BUFFER));
184 memcpy(&(rdata->rrec), &(s->s3->rrec), sizeof(SSL3_RECORD));
186 item->data = rdata;
188 /* insert should not fail, since duplicates are dropped */
189 if (pqueue_insert(queue->q, item) == NULL)
191 OPENSSL_free(rdata);
192 pitem_free(item);
193 return(0);
196 s->packet = NULL;
197 s->packet_length = 0;
198 memset(&(s->s3->rbuf), 0, sizeof(SSL3_BUFFER));
199 memset(&(s->s3->rrec), 0, sizeof(SSL3_RECORD));
201 if (!ssl3_setup_buffers(s))
203 SSLerr(SSL_F_DTLS1_BUFFER_RECORD, ERR_R_INTERNAL_ERROR);
204 OPENSSL_free(rdata);
205 pitem_free(item);
206 return(0);
209 return(1);
213 static int
214 dtls1_retrieve_buffered_record(SSL *s, record_pqueue *queue)
216 pitem *item;
218 item = pqueue_pop(queue->q);
219 if (item)
221 dtls1_copy_record(s, item);
223 OPENSSL_free(item->data);
224 pitem_free(item);
226 return(1);
229 return(0);
233 /* retrieve a buffered record that belongs to the new epoch, i.e., not processed
234 * yet */
235 #define dtls1_get_unprocessed_record(s) \
236 dtls1_retrieve_buffered_record((s), \
237 &((s)->d1->unprocessed_rcds))
239 /* retrieve a buffered record that belongs to the current epoch, ie, processed */
240 #define dtls1_get_processed_record(s) \
241 dtls1_retrieve_buffered_record((s), \
242 &((s)->d1->processed_rcds))
244 static int
245 dtls1_process_buffered_records(SSL *s)
247 pitem *item;
249 item = pqueue_peek(s->d1->unprocessed_rcds.q);
250 if (item)
252 DTLS1_RECORD_DATA *rdata;
253 rdata = (DTLS1_RECORD_DATA *)item->data;
255 /* Check if epoch is current. */
256 if (s->d1->unprocessed_rcds.epoch != s->d1->r_epoch)
257 return(1); /* Nothing to do. */
259 /* Process all the records. */
260 while (pqueue_peek(s->d1->unprocessed_rcds.q))
262 dtls1_get_unprocessed_record(s);
263 if ( ! dtls1_process_record(s))
264 return(0);
265 dtls1_buffer_record(s, &(s->d1->processed_rcds),
266 s->s3->rrec.seq_num);
270 /* sync epoch numbers once all the unprocessed records
271 * have been processed */
272 s->d1->processed_rcds.epoch = s->d1->r_epoch;
273 s->d1->unprocessed_rcds.epoch = s->d1->r_epoch + 1;
275 return(1);
279 #if 0
281 static int
282 dtls1_get_buffered_record(SSL *s)
284 pitem *item;
285 PQ_64BIT priority =
286 (((PQ_64BIT)s->d1->handshake_read_seq) << 32) |
287 ((PQ_64BIT)s->d1->r_msg_hdr.frag_off);
289 if ( ! SSL_in_init(s)) /* if we're not (re)negotiating,
290 nothing buffered */
291 return 0;
294 item = pqueue_peek(s->d1->rcvd_records);
295 if (item && item->priority == priority)
297 /* Check if we've received the record of interest. It must be
298 * a handshake record, since data records as passed up without
299 * buffering */
300 DTLS1_RECORD_DATA *rdata;
301 item = pqueue_pop(s->d1->rcvd_records);
302 rdata = (DTLS1_RECORD_DATA *)item->data;
304 if (s->s3->rbuf.buf != NULL)
305 OPENSSL_free(s->s3->rbuf.buf);
307 s->packet = rdata->packet;
308 s->packet_length = rdata->packet_length;
309 memcpy(&(s->s3->rbuf), &(rdata->rbuf), sizeof(SSL3_BUFFER));
310 memcpy(&(s->s3->rrec), &(rdata->rrec), sizeof(SSL3_RECORD));
312 OPENSSL_free(item->data);
313 pitem_free(item);
315 /* s->d1->next_expected_seq_num++; */
316 return(1);
319 return 0;
322 #endif
324 static int
325 dtls1_process_record(SSL *s)
327 int i,al;
328 int clear=0;
329 int enc_err;
330 SSL_SESSION *sess;
331 SSL3_RECORD *rr;
332 unsigned int mac_size;
333 unsigned char md[EVP_MAX_MD_SIZE];
336 rr= &(s->s3->rrec);
337 sess = s->session;
339 /* At this point, s->packet_length == SSL3_RT_HEADER_LNGTH + rr->length,
340 * and we have that many bytes in s->packet
342 rr->input= &(s->packet[DTLS1_RT_HEADER_LENGTH]);
344 /* ok, we can now read from 's->packet' data into 'rr'
345 * rr->input points at rr->length bytes, which
346 * need to be copied into rr->data by either
347 * the decryption or by the decompression
348 * When the data is 'copied' into the rr->data buffer,
349 * rr->input will be pointed at the new buffer */
351 /* We now have - encrypted [ MAC [ compressed [ plain ] ] ]
352 * rr->length bytes of encrypted compressed stuff. */
354 /* check is not needed I believe */
355 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
357 al=SSL_AD_RECORD_OVERFLOW;
358 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_ENCRYPTED_LENGTH_TOO_LONG);
359 goto f_err;
362 /* decrypt in place in 'rr->input' */
363 rr->data=rr->input;
365 enc_err = s->method->ssl3_enc->enc(s,0);
366 if (enc_err <= 0)
368 if (enc_err == 0)
369 /* SSLerr() and ssl3_send_alert() have been called */
370 goto err;
372 /* otherwise enc_err == -1 */
373 goto decryption_failed_or_bad_record_mac;
376 #ifdef TLS_DEBUG
377 printf("dec %d\n",rr->length);
378 { unsigned int z; for (z=0; z<rr->length; z++) printf("%02X%c",rr->data[z],((z+1)%16)?' ':'\n'); }
379 printf("\n");
380 #endif
382 /* r->length is now the compressed data plus mac */
383 if ( (sess == NULL) ||
384 (s->enc_read_ctx == NULL) ||
385 (s->read_hash == NULL))
386 clear=1;
388 if (!clear)
390 mac_size=EVP_MD_size(s->read_hash);
392 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH+mac_size)
394 #if 0 /* OK only for stream ciphers (then rr->length is visible from ciphertext anyway) */
395 al=SSL_AD_RECORD_OVERFLOW;
396 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_PRE_MAC_LENGTH_TOO_LONG);
397 goto f_err;
398 #else
399 goto decryption_failed_or_bad_record_mac;
400 #endif
402 /* check the MAC for rr->input (it's in mac_size bytes at the tail) */
403 if (rr->length < mac_size)
405 #if 0 /* OK only for stream ciphers */
406 al=SSL_AD_DECODE_ERROR;
407 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_LENGTH_TOO_SHORT);
408 goto f_err;
409 #else
410 goto decryption_failed_or_bad_record_mac;
411 #endif
413 rr->length-=mac_size;
414 i=s->method->ssl3_enc->mac(s,md,0);
415 if (memcmp(md,&(rr->data[rr->length]),mac_size) != 0)
417 goto decryption_failed_or_bad_record_mac;
421 /* r->length is now just compressed */
422 if (s->expand != NULL)
424 if (rr->length > SSL3_RT_MAX_COMPRESSED_LENGTH)
426 al=SSL_AD_RECORD_OVERFLOW;
427 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_COMPRESSED_LENGTH_TOO_LONG);
428 goto f_err;
430 if (!ssl3_do_uncompress(s))
432 al=SSL_AD_DECOMPRESSION_FAILURE;
433 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_BAD_DECOMPRESSION);
434 goto f_err;
438 if (rr->length > SSL3_RT_MAX_PLAIN_LENGTH)
440 al=SSL_AD_RECORD_OVERFLOW;
441 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DATA_LENGTH_TOO_LONG);
442 goto f_err;
445 rr->off=0;
446 /* So at this point the following is true
447 * ssl->s3->rrec.type is the type of record
448 * ssl->s3->rrec.length == number of bytes in record
449 * ssl->s3->rrec.off == offset to first valid byte
450 * ssl->s3->rrec.data == where to take bytes from, increment
451 * after use :-).
454 /* we have pulled in a full packet so zero things */
455 s->packet_length=0;
456 dtls1_record_bitmap_update(s, &(s->d1->bitmap));/* Mark receipt of record. */
457 return(1);
459 decryption_failed_or_bad_record_mac:
460 /* Separate 'decryption_failed' alert was introduced with TLS 1.0,
461 * SSL 3.0 only has 'bad_record_mac'. But unless a decryption
462 * failure is directly visible from the ciphertext anyway,
463 * we should not reveal which kind of error occured -- this
464 * might become visible to an attacker (e.g. via logfile) */
465 al=SSL_AD_BAD_RECORD_MAC;
466 SSLerr(SSL_F_DTLS1_PROCESS_RECORD,SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC);
467 f_err:
468 ssl3_send_alert(s,SSL3_AL_FATAL,al);
469 err:
470 return(0);
474 /* Call this to get a new input record.
475 * It will return <= 0 if more data is needed, normally due to an error
476 * or non-blocking IO.
477 * When it finishes, one packet has been decoded and can be found in
478 * ssl->s3->rrec.type - is the type of record
479 * ssl->s3->rrec.data, - data
480 * ssl->s3->rrec.length, - number of bytes
482 /* used only by dtls1_read_bytes */
483 int dtls1_get_record(SSL *s)
485 int ssl_major,ssl_minor,al;
486 int i,n;
487 SSL3_RECORD *rr;
488 SSL_SESSION *sess;
489 unsigned char *p;
490 unsigned short version;
491 DTLS1_BITMAP *bitmap;
492 unsigned int is_next_epoch;
494 rr= &(s->s3->rrec);
495 sess=s->session;
497 /* The epoch may have changed. If so, process all the
498 * pending records. This is a non-blocking operation. */
499 if ( ! dtls1_process_buffered_records(s))
500 return 0;
502 /* if we're renegotiating, then there may be buffered records */
503 if (dtls1_get_processed_record(s))
504 return 1;
506 /* get something from the wire */
507 again:
508 /* check if we have the header */
509 if ( (s->rstate != SSL_ST_READ_BODY) ||
510 (s->packet_length < DTLS1_RT_HEADER_LENGTH))
512 n=ssl3_read_n(s, DTLS1_RT_HEADER_LENGTH, s->s3->rbuf.len, 0);
513 /* read timeout is handled by dtls1_read_bytes */
514 if (n <= 0) return(n); /* error or non-blocking */
516 OPENSSL_assert(s->packet_length == DTLS1_RT_HEADER_LENGTH);
518 s->rstate=SSL_ST_READ_BODY;
520 p=s->packet;
522 /* Pull apart the header into the DTLS1_RECORD */
523 rr->type= *(p++);
524 ssl_major= *(p++);
525 ssl_minor= *(p++);
526 version=(ssl_major<<8)|ssl_minor;
528 /* sequence number is 64 bits, with top 2 bytes = epoch */
529 n2s(p,rr->epoch);
531 memcpy(&(s->s3->read_sequence[2]), p, 6);
532 p+=6;
534 n2s(p,rr->length);
536 /* Lets check version */
537 if (!s->first_packet)
539 if (version != s->version && version != DTLS1_BAD_VER)
541 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
542 /* Send back error using their
543 * version number :-) */
544 s->version=version;
545 al=SSL_AD_PROTOCOL_VERSION;
546 goto f_err;
550 if ((version & 0xff00) != (DTLS1_VERSION & 0xff00) &&
551 (version & 0xff00) != (DTLS1_BAD_VER & 0xff00))
553 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_WRONG_VERSION_NUMBER);
554 goto err;
557 if (rr->length > SSL3_RT_MAX_ENCRYPTED_LENGTH)
559 al=SSL_AD_RECORD_OVERFLOW;
560 SSLerr(SSL_F_DTLS1_GET_RECORD,SSL_R_PACKET_LENGTH_TOO_LONG);
561 goto f_err;
564 s->client_version = version;
565 /* now s->rstate == SSL_ST_READ_BODY */
568 /* s->rstate == SSL_ST_READ_BODY, get and decode the data */
570 if (rr->length > s->packet_length-DTLS1_RT_HEADER_LENGTH)
572 /* now s->packet_length == DTLS1_RT_HEADER_LENGTH */
573 i=rr->length;
574 n=ssl3_read_n(s,i,i,1);
575 if (n <= 0) return(n); /* error or non-blocking io */
577 /* this packet contained a partial record, dump it */
578 if ( n != i)
580 s->packet_length = 0;
581 goto again;
584 /* now n == rr->length,
585 * and s->packet_length == DTLS1_RT_HEADER_LENGTH + rr->length */
587 s->rstate=SSL_ST_READ_HEADER; /* set state for later operations */
589 /* match epochs. NULL means the packet is dropped on the floor */
590 bitmap = dtls1_get_bitmap(s, rr, &is_next_epoch);
591 if ( bitmap == NULL)
593 s->packet_length = 0; /* dump this record */
594 goto again; /* get another record */
597 /* check whether this is a repeat, or aged record */
598 if ( ! dtls1_record_replay_check(s, bitmap, &(rr->seq_num)))
600 s->packet_length=0; /* dump this record */
601 goto again; /* get another record */
604 /* just read a 0 length packet */
605 if (rr->length == 0) goto again;
607 /* If this record is from the next epoch (either HM or ALERT), buffer it
608 * since it cannot be processed at this time.
609 * Records from the next epoch are marked as received even though they are
610 * not processed, so as to prevent any potential resource DoS attack */
611 if (is_next_epoch)
613 dtls1_record_bitmap_update(s, bitmap);
614 dtls1_buffer_record(s, &(s->d1->unprocessed_rcds), rr->seq_num);
615 s->packet_length = 0;
616 goto again;
619 if ( ! dtls1_process_record(s))
620 return(0);
622 dtls1_clear_timeouts(s); /* done waiting */
623 return(1);
625 f_err:
626 ssl3_send_alert(s,SSL3_AL_FATAL,al);
627 err:
628 return(0);
631 /* Return up to 'len' payload bytes received in 'type' records.
632 * 'type' is one of the following:
634 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
635 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
636 * - 0 (during a shutdown, no data has to be returned)
638 * If we don't have stored data to work from, read a SSL/TLS record first
639 * (possibly multiple records if we still don't have anything to return).
641 * This function must handle any surprises the peer may have for us, such as
642 * Alert records (e.g. close_notify), ChangeCipherSpec records (not really
643 * a surprise, but handled as if it were), or renegotiation requests.
644 * Also if record payloads contain fragments too small to process, we store
645 * them until there is enough for the respective protocol (the record protocol
646 * may use arbitrary fragmentation and even interleaving):
647 * Change cipher spec protocol
648 * just 1 byte needed, no need for keeping anything stored
649 * Alert protocol
650 * 2 bytes needed (AlertLevel, AlertDescription)
651 * Handshake protocol
652 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
653 * to detect unexpected Client Hello and Hello Request messages
654 * here, anything else is handled by higher layers
655 * Application data protocol
656 * none of our business
658 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek)
660 int al,i,j,ret;
661 unsigned int n;
662 SSL3_RECORD *rr;
663 void (*cb)(const SSL *ssl,int type2,int val)=NULL;
665 if (s->s3->rbuf.buf == NULL) /* Not initialized yet */
666 if (!ssl3_setup_buffers(s))
667 return(-1);
669 /* XXX: check what the second '&& type' is about */
670 if ((type && (type != SSL3_RT_APPLICATION_DATA) &&
671 (type != SSL3_RT_HANDSHAKE) && type) ||
672 (peek && (type != SSL3_RT_APPLICATION_DATA)))
674 SSLerr(SSL_F_DTLS1_READ_BYTES, ERR_R_INTERNAL_ERROR);
675 return -1;
678 /* check whether there's a handshake message (client hello?) waiting */
679 if ( (ret = have_handshake_fragment(s, type, buf, len, peek)))
680 return ret;
682 /* Now s->d1->handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE. */
684 if (!s->in_handshake && SSL_in_init(s))
686 /* type == SSL3_RT_APPLICATION_DATA */
687 i=s->handshake_func(s);
688 if (i < 0) return(i);
689 if (i == 0)
691 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
692 return(-1);
696 start:
697 s->rwstate=SSL_NOTHING;
699 /* s->s3->rrec.type - is the type of record
700 * s->s3->rrec.data, - data
701 * s->s3->rrec.off, - offset into 'data' for next read
702 * s->s3->rrec.length, - number of bytes. */
703 rr = &(s->s3->rrec);
705 /* get new packet if necessary */
706 if ((rr->length == 0) || (s->rstate == SSL_ST_READ_BODY))
708 ret=dtls1_get_record(s);
709 if (ret <= 0)
711 ret = dtls1_read_failed(s, ret);
712 /* anything other than a timeout is an error */
713 if (ret <= 0)
714 return(ret);
715 else
716 goto start;
720 /* we now have a packet which can be read and processed */
722 if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
723 * reset by ssl3_get_finished */
724 && (rr->type != SSL3_RT_HANDSHAKE))
726 al=SSL_AD_UNEXPECTED_MESSAGE;
727 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
728 goto err;
731 /* If the other end has shut down, throw anything we read away
732 * (even in 'peek' mode) */
733 if (s->shutdown & SSL_RECEIVED_SHUTDOWN)
735 rr->length=0;
736 s->rwstate=SSL_NOTHING;
737 return(0);
741 if (type == rr->type) /* SSL3_RT_APPLICATION_DATA or SSL3_RT_HANDSHAKE */
743 /* make sure that we are not getting application data when we
744 * are doing a handshake for the first time */
745 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
746 (s->enc_read_ctx == NULL))
748 al=SSL_AD_UNEXPECTED_MESSAGE;
749 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_APP_DATA_IN_HANDSHAKE);
750 goto f_err;
753 if (len <= 0) return(len);
755 if ((unsigned int)len > rr->length)
756 n = rr->length;
757 else
758 n = (unsigned int)len;
760 memcpy(buf,&(rr->data[rr->off]),n);
761 if (!peek)
763 rr->length-=n;
764 rr->off+=n;
765 if (rr->length == 0)
767 s->rstate=SSL_ST_READ_HEADER;
768 rr->off=0;
771 return(n);
775 /* If we get here, then type != rr->type; if we have a handshake
776 * message, then it was unexpected (Hello Request or Client Hello). */
778 /* In case of record types for which we have 'fragment' storage,
779 * fill that so that we can process the data at a fixed place.
782 unsigned int k, dest_maxlen = 0;
783 unsigned char *dest = NULL;
784 unsigned int *dest_len = NULL;
786 if (rr->type == SSL3_RT_HANDSHAKE)
788 dest_maxlen = sizeof s->d1->handshake_fragment;
789 dest = s->d1->handshake_fragment;
790 dest_len = &s->d1->handshake_fragment_len;
792 else if (rr->type == SSL3_RT_ALERT)
794 dest_maxlen = sizeof(s->d1->alert_fragment);
795 dest = s->d1->alert_fragment;
796 dest_len = &s->d1->alert_fragment_len;
798 /* else it's a CCS message, or it's wrong */
799 else if (rr->type != SSL3_RT_CHANGE_CIPHER_SPEC)
801 /* Not certain if this is the right error handling */
802 al=SSL_AD_UNEXPECTED_MESSAGE;
803 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
804 goto f_err;
808 if (dest_maxlen > 0)
810 /* XDTLS: In a pathalogical case, the Client Hello
811 * may be fragmented--don't always expect dest_maxlen bytes */
812 if ( rr->length < dest_maxlen)
814 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
816 * for normal alerts rr->length is 2, while
817 * dest_maxlen is 7 if we were to handle this
818 * non-existing alert...
820 FIX ME
821 #endif
822 s->rstate=SSL_ST_READ_HEADER;
823 rr->length = 0;
824 goto start;
827 /* now move 'n' bytes: */
828 for ( k = 0; k < dest_maxlen; k++)
830 dest[k] = rr->data[rr->off++];
831 rr->length--;
833 *dest_len = dest_maxlen;
837 /* s->d1->handshake_fragment_len == 12 iff rr->type == SSL3_RT_HANDSHAKE;
838 * s->d1->alert_fragment_len == 7 iff rr->type == SSL3_RT_ALERT.
839 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.) */
841 /* If we are a client, check for an incoming 'Hello Request': */
842 if ((!s->server) &&
843 (s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
844 (s->d1->handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
845 (s->session != NULL) && (s->session->cipher != NULL))
847 s->d1->handshake_fragment_len = 0;
849 if ((s->d1->handshake_fragment[1] != 0) ||
850 (s->d1->handshake_fragment[2] != 0) ||
851 (s->d1->handshake_fragment[3] != 0))
853 al=SSL_AD_DECODE_ERROR;
854 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_HELLO_REQUEST);
855 goto err;
858 /* no need to check sequence number on HELLO REQUEST messages */
860 if (s->msg_callback)
861 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
862 s->d1->handshake_fragment, 4, s, s->msg_callback_arg);
864 if (SSL_is_init_finished(s) &&
865 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
866 !s->s3->renegotiate)
868 ssl3_renegotiate(s);
869 if (ssl3_renegotiate_check(s))
871 i=s->handshake_func(s);
872 if (i < 0) return(i);
873 if (i == 0)
875 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
876 return(-1);
879 if (!(s->mode & SSL_MODE_AUTO_RETRY))
881 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
883 BIO *bio;
884 /* In the case where we try to read application data,
885 * but we trigger an SSL handshake, we return -1 with
886 * the retry option set. Otherwise renegotiation may
887 * cause nasty problems in the blocking world */
888 s->rwstate=SSL_READING;
889 bio=SSL_get_rbio(s);
890 BIO_clear_retry_flags(bio);
891 BIO_set_retry_read(bio);
892 return(-1);
897 /* we either finished a handshake or ignored the request,
898 * now try again to obtain the (application) data we were asked for */
899 goto start;
902 if (s->d1->alert_fragment_len >= DTLS1_AL_HEADER_LENGTH)
904 int alert_level = s->d1->alert_fragment[0];
905 int alert_descr = s->d1->alert_fragment[1];
907 s->d1->alert_fragment_len = 0;
909 if (s->msg_callback)
910 s->msg_callback(0, s->version, SSL3_RT_ALERT,
911 s->d1->alert_fragment, 2, s, s->msg_callback_arg);
913 if (s->info_callback != NULL)
914 cb=s->info_callback;
915 else if (s->ctx->info_callback != NULL)
916 cb=s->ctx->info_callback;
918 if (cb != NULL)
920 j = (alert_level << 8) | alert_descr;
921 cb(s, SSL_CB_READ_ALERT, j);
924 if (alert_level == 1) /* warning */
926 s->s3->warn_alert = alert_descr;
927 if (alert_descr == SSL_AD_CLOSE_NOTIFY)
929 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
930 return(0);
932 #if 0
933 /* XXX: this is a possible improvement in the future */
934 /* now check if it's a missing record */
935 if (alert_descr == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
937 unsigned short seq;
938 unsigned int frag_off;
939 unsigned char *p = &(s->d1->alert_fragment[2]);
941 n2s(p, seq);
942 n2l3(p, frag_off);
944 dtls1_retransmit_message(s, seq, frag_off, &found);
945 if ( ! found && SSL_in_init(s))
947 /* fprintf( stderr,"in init = %d\n", SSL_in_init(s)); */
948 /* requested a message not yet sent,
949 send an alert ourselves */
950 ssl3_send_alert(s,SSL3_AL_WARNING,
951 DTLS1_AD_MISSING_HANDSHAKE_MESSAGE);
954 #endif
956 else if (alert_level == 2) /* fatal */
958 char tmp[16];
960 s->rwstate=SSL_NOTHING;
961 s->s3->fatal_alert = alert_descr;
962 SSLerr(SSL_F_DTLS1_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
963 BIO_snprintf(tmp,sizeof tmp,"%d",alert_descr);
964 ERR_add_error_data(2,"SSL alert number ",tmp);
965 s->shutdown|=SSL_RECEIVED_SHUTDOWN;
966 SSL_CTX_remove_session(s->ctx,s->session);
967 return(0);
969 else
971 al=SSL_AD_ILLEGAL_PARAMETER;
972 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNKNOWN_ALERT_TYPE);
973 goto f_err;
976 goto start;
979 if (s->shutdown & SSL_SENT_SHUTDOWN) /* but we have not received a shutdown */
981 s->rwstate=SSL_NOTHING;
982 rr->length=0;
983 return(0);
986 if (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
988 struct ccs_header_st ccs_hdr;
990 dtls1_get_ccs_header(rr->data, &ccs_hdr);
992 /* 'Change Cipher Spec' is just a single byte, so we know
993 * exactly what the record payload has to look like */
994 /* XDTLS: check that epoch is consistent */
995 if ( (s->client_version == DTLS1_BAD_VER && rr->length != 3) ||
996 (s->client_version != DTLS1_BAD_VER && rr->length != DTLS1_CCS_HEADER_LENGTH) ||
997 (rr->off != 0) || (rr->data[0] != SSL3_MT_CCS))
999 i=SSL_AD_ILLEGAL_PARAMETER;
1000 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_BAD_CHANGE_CIPHER_SPEC);
1001 goto err;
1004 rr->length=0;
1006 if (s->msg_callback)
1007 s->msg_callback(0, s->version, SSL3_RT_CHANGE_CIPHER_SPEC,
1008 rr->data, 1, s, s->msg_callback_arg);
1010 s->s3->change_cipher_spec=1;
1011 if (!ssl3_do_change_cipher_spec(s))
1012 goto err;
1014 /* do this whenever CCS is processed */
1015 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
1017 if (s->client_version == DTLS1_BAD_VER)
1018 s->d1->handshake_read_seq++;
1020 goto start;
1023 /* Unexpected handshake message (Client Hello, or protocol violation) */
1024 if ((s->d1->handshake_fragment_len >= DTLS1_HM_HEADER_LENGTH) &&
1025 !s->in_handshake)
1027 struct hm_header_st msg_hdr;
1029 /* this may just be a stale retransmit */
1030 dtls1_get_message_header(rr->data, &msg_hdr);
1031 if( rr->epoch != s->d1->r_epoch)
1033 rr->length = 0;
1034 goto start;
1037 if (((s->state&SSL_ST_MASK) == SSL_ST_OK) &&
1038 !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS))
1040 #if 0 /* worked only because C operator preferences are not as expected (and
1041 * because this is not really needed for clients except for detecting
1042 * protocol violations): */
1043 s->state=SSL_ST_BEFORE|(s->server)
1044 ?SSL_ST_ACCEPT
1045 :SSL_ST_CONNECT;
1046 #else
1047 s->state = s->server ? SSL_ST_ACCEPT : SSL_ST_CONNECT;
1048 #endif
1049 s->new_session=1;
1051 i=s->handshake_func(s);
1052 if (i < 0) return(i);
1053 if (i == 0)
1055 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1056 return(-1);
1059 if (!(s->mode & SSL_MODE_AUTO_RETRY))
1061 if (s->s3->rbuf.left == 0) /* no read-ahead left? */
1063 BIO *bio;
1064 /* In the case where we try to read application data,
1065 * but we trigger an SSL handshake, we return -1 with
1066 * the retry option set. Otherwise renegotiation may
1067 * cause nasty problems in the blocking world */
1068 s->rwstate=SSL_READING;
1069 bio=SSL_get_rbio(s);
1070 BIO_clear_retry_flags(bio);
1071 BIO_set_retry_read(bio);
1072 return(-1);
1075 goto start;
1078 switch (rr->type)
1080 default:
1081 #ifndef OPENSSL_NO_TLS
1082 /* TLS just ignores unknown message types */
1083 if (s->version == TLS1_VERSION)
1085 rr->length = 0;
1086 goto start;
1088 #endif
1089 al=SSL_AD_UNEXPECTED_MESSAGE;
1090 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1091 goto f_err;
1092 case SSL3_RT_CHANGE_CIPHER_SPEC:
1093 case SSL3_RT_ALERT:
1094 case SSL3_RT_HANDSHAKE:
1095 /* we already handled all of these, with the possible exception
1096 * of SSL3_RT_HANDSHAKE when s->in_handshake is set, but that
1097 * should not happen when type != rr->type */
1098 al=SSL_AD_UNEXPECTED_MESSAGE;
1099 SSLerr(SSL_F_DTLS1_READ_BYTES,ERR_R_INTERNAL_ERROR);
1100 goto f_err;
1101 case SSL3_RT_APPLICATION_DATA:
1102 /* At this point, we were expecting handshake data,
1103 * but have application data. If the library was
1104 * running inside ssl3_read() (i.e. in_read_app_data
1105 * is set) and it makes sense to read application data
1106 * at this point (session renegotiation not yet started),
1107 * we will indulge it.
1109 if (s->s3->in_read_app_data &&
1110 (s->s3->total_renegotiations != 0) &&
1112 (s->state & SSL_ST_CONNECT) &&
1113 (s->state >= SSL3_ST_CW_CLNT_HELLO_A) &&
1114 (s->state <= SSL3_ST_CR_SRVR_HELLO_A)
1115 ) || (
1116 (s->state & SSL_ST_ACCEPT) &&
1117 (s->state <= SSL3_ST_SW_HELLO_REQ_A) &&
1118 (s->state >= SSL3_ST_SR_CLNT_HELLO_A)
1122 s->s3->in_read_app_data=2;
1123 return(-1);
1125 else
1127 al=SSL_AD_UNEXPECTED_MESSAGE;
1128 SSLerr(SSL_F_DTLS1_READ_BYTES,SSL_R_UNEXPECTED_RECORD);
1129 goto f_err;
1132 /* not reached */
1134 f_err:
1135 ssl3_send_alert(s,SSL3_AL_FATAL,al);
1136 err:
1137 return(-1);
1141 dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, int len)
1143 unsigned int n,tot;
1144 int i;
1146 if (SSL_in_init(s) && !s->in_handshake)
1148 i=s->handshake_func(s);
1149 if (i < 0) return(i);
1150 if (i == 0)
1152 SSLerr(SSL_F_DTLS1_WRITE_APP_DATA_BYTES,SSL_R_SSL_HANDSHAKE_FAILURE);
1153 return -1;
1157 tot = s->s3->wnum;
1158 n = len - tot;
1160 while( n)
1162 /* dtls1_write_bytes sends one record at a time, sized according to
1163 * the currently known MTU */
1164 i = dtls1_write_bytes(s, type, buf_, len);
1165 if (i <= 0) return i;
1167 if ((i == (int)n) ||
1168 (type == SSL3_RT_APPLICATION_DATA &&
1169 (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE)))
1171 /* next chunk of data should get another prepended empty fragment
1172 * in ciphersuites with known-IV weakness: */
1173 s->s3->empty_fragment_done = 0;
1174 return tot+i;
1177 tot += i;
1178 n-=i;
1181 return tot;
1185 /* this only happens when a client hello is received and a handshake
1186 * is started. */
1187 static int
1188 have_handshake_fragment(SSL *s, int type, unsigned char *buf,
1189 int len, int peek)
1192 if ((type == SSL3_RT_HANDSHAKE) && (s->d1->handshake_fragment_len > 0))
1193 /* (partially) satisfy request from storage */
1195 unsigned char *src = s->d1->handshake_fragment;
1196 unsigned char *dst = buf;
1197 unsigned int k,n;
1199 /* peek == 0 */
1200 n = 0;
1201 while ((len > 0) && (s->d1->handshake_fragment_len > 0))
1203 *dst++ = *src++;
1204 len--; s->d1->handshake_fragment_len--;
1205 n++;
1207 /* move any remaining fragment bytes: */
1208 for (k = 0; k < s->d1->handshake_fragment_len; k++)
1209 s->d1->handshake_fragment[k] = *src++;
1210 return n;
1213 return 0;
1219 /* Call this to write data in records of type 'type'
1220 * It will return <= 0 if not all data has been sent or non-blocking IO.
1222 int dtls1_write_bytes(SSL *s, int type, const void *buf_, int len)
1224 const unsigned char *buf=buf_;
1225 unsigned int tot,n,nw;
1226 int i;
1227 unsigned int mtu;
1229 s->rwstate=SSL_NOTHING;
1230 tot=s->s3->wnum;
1232 n=(len-tot);
1234 /* handshake layer figures out MTU for itself, but data records
1235 * are also sent through this interface, so need to figure out MTU */
1236 #if 0
1237 mtu = BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_MTU, 0, NULL);
1238 mtu += DTLS1_HM_HEADER_LENGTH; /* HM already inserted */
1239 #endif
1240 mtu = s->d1->mtu;
1242 if (mtu > SSL3_RT_MAX_PLAIN_LENGTH)
1243 mtu = SSL3_RT_MAX_PLAIN_LENGTH;
1245 if (n > mtu)
1246 nw=mtu;
1247 else
1248 nw=n;
1250 i=do_dtls1_write(s, type, &(buf[tot]), nw, 0);
1251 if (i <= 0)
1253 s->s3->wnum=tot;
1254 return i;
1257 if ( (int)s->s3->wnum + i == len)
1258 s->s3->wnum = 0;
1259 else
1260 s->s3->wnum += i;
1262 return i;
1265 int do_dtls1_write(SSL *s, int type, const unsigned char *buf, unsigned int len, int create_empty_fragment)
1267 unsigned char *p,*pseq;
1268 int i,mac_size,clear=0;
1269 int prefix_len = 0;
1270 SSL3_RECORD *wr;
1271 SSL3_BUFFER *wb;
1272 SSL_SESSION *sess;
1273 int bs;
1275 /* first check if there is a SSL3_BUFFER still being written
1276 * out. This will happen with non blocking IO */
1277 if (s->s3->wbuf.left != 0)
1279 OPENSSL_assert(0); /* XDTLS: want to see if we ever get here */
1280 return(ssl3_write_pending(s,type,buf,len));
1283 /* If we have an alert to send, lets send it */
1284 if (s->s3->alert_dispatch)
1286 i=s->method->ssl_dispatch_alert(s);
1287 if (i <= 0)
1288 return(i);
1289 /* if it went, fall through and send more stuff */
1292 if (len == 0 && !create_empty_fragment)
1293 return 0;
1295 wr= &(s->s3->wrec);
1296 wb= &(s->s3->wbuf);
1297 sess=s->session;
1299 if ( (sess == NULL) ||
1300 (s->enc_write_ctx == NULL) ||
1301 (s->write_hash == NULL))
1302 clear=1;
1304 if (clear)
1305 mac_size=0;
1306 else
1307 mac_size=EVP_MD_size(s->write_hash);
1309 /* DTLS implements explicit IV, so no need for empty fragments */
1310 #if 0
1311 /* 'create_empty_fragment' is true only when this function calls itself */
1312 if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done
1313 && SSL_version(s) != DTLS1_VERSION)
1315 /* countermeasure against known-IV weakness in CBC ciphersuites
1316 * (see http://www.openssl.org/~bodo/tls-cbc.txt)
1319 if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA)
1321 /* recursive function call with 'create_empty_fragment' set;
1322 * this prepares and buffers the data for an empty fragment
1323 * (these 'prefix_len' bytes are sent out later
1324 * together with the actual payload) */
1325 prefix_len = s->method->do_ssl_write(s, type, buf, 0, 1);
1326 if (prefix_len <= 0)
1327 goto err;
1329 if (s->s3->wbuf.len < (size_t)prefix_len + SSL3_RT_MAX_PACKET_SIZE)
1331 /* insufficient space */
1332 SSLerr(SSL_F_DO_DTLS1_WRITE, ERR_R_INTERNAL_ERROR);
1333 goto err;
1337 s->s3->empty_fragment_done = 1;
1339 #endif
1341 p = wb->buf + prefix_len;
1343 /* write the header */
1345 *(p++)=type&0xff;
1346 wr->type=type;
1348 if (s->client_version == DTLS1_BAD_VER)
1349 *(p++) = DTLS1_BAD_VER>>8,
1350 *(p++) = DTLS1_BAD_VER&0xff;
1351 else
1352 *(p++)=(s->version>>8),
1353 *(p++)=s->version&0xff;
1355 /* field where we are to write out packet epoch, seq num and len */
1356 pseq=p;
1357 p+=10;
1359 /* lets setup the record stuff. */
1361 /* Make space for the explicit IV in case of CBC.
1362 * (this is a bit of a boundary violation, but what the heck).
1364 if ( s->enc_write_ctx &&
1365 (EVP_CIPHER_mode( s->enc_write_ctx->cipher ) & EVP_CIPH_CBC_MODE))
1366 bs = EVP_CIPHER_block_size(s->enc_write_ctx->cipher);
1367 else
1368 bs = 0;
1370 wr->data=p + bs; /* make room for IV in case of CBC */
1371 wr->length=(int)len;
1372 wr->input=(unsigned char *)buf;
1374 /* we now 'read' from wr->input, wr->length bytes into
1375 * wr->data */
1377 /* first we compress */
1378 if (s->compress != NULL)
1380 if (!ssl3_do_compress(s))
1382 SSLerr(SSL_F_DO_DTLS1_WRITE,SSL_R_COMPRESSION_FAILURE);
1383 goto err;
1386 else
1388 memcpy(wr->data,wr->input,wr->length);
1389 wr->input=wr->data;
1392 /* we should still have the output to wr->data and the input
1393 * from wr->input. Length should be wr->length.
1394 * wr->data still points in the wb->buf */
1396 if (mac_size != 0)
1398 s->method->ssl3_enc->mac(s,&(p[wr->length + bs]),1);
1399 wr->length+=mac_size;
1402 /* this is true regardless of mac size */
1403 wr->input=p;
1404 wr->data=p;
1407 /* ssl3_enc can only have an error on read */
1408 if (bs) /* bs != 0 in case of CBC */
1410 RAND_pseudo_bytes(p,bs);
1411 /* master IV and last CBC residue stand for
1412 * the rest of randomness */
1413 wr->length += bs;
1416 s->method->ssl3_enc->enc(s,1);
1418 /* record length after mac and block padding */
1419 /* if (type == SSL3_RT_APPLICATION_DATA ||
1420 (type == SSL3_RT_ALERT && ! SSL_in_init(s))) */
1422 /* there's only one epoch between handshake and app data */
1424 s2n(s->d1->w_epoch, pseq);
1426 /* XDTLS: ?? */
1427 /* else
1428 s2n(s->d1->handshake_epoch, pseq); */
1430 memcpy(pseq, &(s->s3->write_sequence[2]), 6);
1431 pseq+=6;
1432 s2n(wr->length,pseq);
1434 /* we should now have
1435 * wr->data pointing to the encrypted data, which is
1436 * wr->length long */
1437 wr->type=type; /* not needed but helps for debugging */
1438 wr->length+=DTLS1_RT_HEADER_LENGTH;
1440 #if 0 /* this is now done at the message layer */
1441 /* buffer the record, making it easy to handle retransmits */
1442 if ( type == SSL3_RT_HANDSHAKE || type == SSL3_RT_CHANGE_CIPHER_SPEC)
1443 dtls1_buffer_record(s, wr->data, wr->length,
1444 *((PQ_64BIT *)&(s->s3->write_sequence[0])));
1445 #endif
1447 ssl3_record_sequence_update(&(s->s3->write_sequence[0]));
1449 if (create_empty_fragment)
1451 /* we are in a recursive call;
1452 * just return the length, don't write out anything here
1454 return wr->length;
1457 /* now let's set up wb */
1458 wb->left = prefix_len + wr->length;
1459 wb->offset = 0;
1461 /* memorize arguments so that ssl3_write_pending can detect bad write retries later */
1462 s->s3->wpend_tot=len;
1463 s->s3->wpend_buf=buf;
1464 s->s3->wpend_type=type;
1465 s->s3->wpend_ret=len;
1467 /* we now just need to write the buffer */
1468 return ssl3_write_pending(s,type,buf,len);
1469 err:
1470 return -1;
1475 static int dtls1_record_replay_check(SSL *s, DTLS1_BITMAP *bitmap,
1476 PQ_64BIT *seq_num)
1478 #if PQ_64BIT_IS_INTEGER
1479 PQ_64BIT mask = 0x0000000000000001L;
1480 #endif
1481 PQ_64BIT rcd_num, tmp;
1483 pq_64bit_init(&rcd_num);
1484 pq_64bit_init(&tmp);
1486 /* this is the sequence number for the record just read */
1487 pq_64bit_bin2num(&rcd_num, s->s3->read_sequence, 8);
1490 if (pq_64bit_gt(&rcd_num, &(bitmap->max_seq_num)) ||
1491 pq_64bit_eq(&rcd_num, &(bitmap->max_seq_num)))
1493 pq_64bit_assign(seq_num, &rcd_num);
1494 pq_64bit_free(&rcd_num);
1495 pq_64bit_free(&tmp);
1496 return 1; /* this record is new */
1499 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1501 if ( pq_64bit_get_word(&tmp) > bitmap->length)
1503 pq_64bit_free(&rcd_num);
1504 pq_64bit_free(&tmp);
1505 return 0; /* stale, outside the window */
1508 #if PQ_64BIT_IS_BIGNUM
1510 int offset;
1511 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1512 pq_64bit_sub_word(&tmp, 1);
1513 offset = pq_64bit_get_word(&tmp);
1514 if ( pq_64bit_is_bit_set(&(bitmap->map), offset))
1516 pq_64bit_free(&rcd_num);
1517 pq_64bit_free(&tmp);
1518 return 0;
1521 #else
1522 mask <<= (bitmap->max_seq_num - rcd_num - 1);
1523 if (bitmap->map & mask)
1524 return 0; /* record previously received */
1525 #endif
1527 pq_64bit_assign(seq_num, &rcd_num);
1528 pq_64bit_free(&rcd_num);
1529 pq_64bit_free(&tmp);
1530 return 1;
1534 static void dtls1_record_bitmap_update(SSL *s, DTLS1_BITMAP *bitmap)
1536 unsigned int shift;
1537 PQ_64BIT rcd_num;
1538 PQ_64BIT tmp;
1539 PQ_64BIT_CTX *ctx;
1541 pq_64bit_init(&rcd_num);
1542 pq_64bit_init(&tmp);
1544 pq_64bit_bin2num(&rcd_num, s->s3->read_sequence, 8);
1546 /* unfortunate code complexity due to 64-bit manipulation support
1547 * on 32-bit machines */
1548 if ( pq_64bit_gt(&rcd_num, &(bitmap->max_seq_num)) ||
1549 pq_64bit_eq(&rcd_num, &(bitmap->max_seq_num)))
1551 pq_64bit_sub(&tmp, &rcd_num, &(bitmap->max_seq_num));
1552 pq_64bit_add_word(&tmp, 1);
1554 shift = (unsigned int)pq_64bit_get_word(&tmp);
1556 pq_64bit_lshift(&(tmp), &(bitmap->map), shift);
1557 pq_64bit_assign(&(bitmap->map), &tmp);
1559 pq_64bit_set_bit(&(bitmap->map), 0);
1560 pq_64bit_add_word(&rcd_num, 1);
1561 pq_64bit_assign(&(bitmap->max_seq_num), &rcd_num);
1563 pq_64bit_assign_word(&tmp, 1);
1564 pq_64bit_lshift(&tmp, &tmp, bitmap->length);
1565 ctx = pq_64bit_ctx_new(&ctx);
1566 pq_64bit_mod(&(bitmap->map), &(bitmap->map), &tmp, ctx);
1567 pq_64bit_ctx_free(ctx);
1569 else
1571 pq_64bit_sub(&tmp, &(bitmap->max_seq_num), &rcd_num);
1572 pq_64bit_sub_word(&tmp, 1);
1573 shift = (unsigned int)pq_64bit_get_word(&tmp);
1575 pq_64bit_set_bit(&(bitmap->map), shift);
1578 pq_64bit_free(&rcd_num);
1579 pq_64bit_free(&tmp);
1583 int dtls1_dispatch_alert(SSL *s)
1585 int i,j;
1586 void (*cb)(const SSL *ssl,int type,int val)=NULL;
1587 unsigned char buf[DTLS1_AL_HEADER_LENGTH];
1588 unsigned char *ptr = &buf[0];
1590 s->s3->alert_dispatch=0;
1592 memset(buf, 0x00, sizeof(buf));
1593 *ptr++ = s->s3->send_alert[0];
1594 *ptr++ = s->s3->send_alert[1];
1596 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1597 if (s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE)
1599 s2n(s->d1->handshake_read_seq, ptr);
1600 #if 0
1601 if ( s->d1->r_msg_hdr.frag_off == 0) /* waiting for a new msg */
1603 else
1604 s2n(s->d1->r_msg_hdr.seq, ptr); /* partial msg read */
1605 #endif
1607 #if 0
1608 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);
1609 #endif
1610 l2n3(s->d1->r_msg_hdr.frag_off, ptr);
1612 #endif
1614 i = do_dtls1_write(s, SSL3_RT_ALERT, &buf[0], sizeof(buf), 0);
1615 if (i <= 0)
1617 s->s3->alert_dispatch=1;
1618 /* fprintf( stderr, "not done with alert\n" ); */
1620 else
1622 if (s->s3->send_alert[0] == SSL3_AL_FATAL
1623 #ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1624 || s->s3->send_alert[1] == DTLS1_AD_MISSING_HANDSHAKE_MESSAGE
1625 #endif
1627 (void)BIO_flush(s->wbio);
1629 if (s->msg_callback)
1630 s->msg_callback(1, s->version, SSL3_RT_ALERT, s->s3->send_alert,
1631 2, s, s->msg_callback_arg);
1633 if (s->info_callback != NULL)
1634 cb=s->info_callback;
1635 else if (s->ctx->info_callback != NULL)
1636 cb=s->ctx->info_callback;
1638 if (cb != NULL)
1640 j=(s->s3->send_alert[0]<<8)|s->s3->send_alert[1];
1641 cb(s,SSL_CB_WRITE_ALERT,j);
1644 return(i);
1648 static DTLS1_BITMAP *
1649 dtls1_get_bitmap(SSL *s, SSL3_RECORD *rr, unsigned int *is_next_epoch)
1652 *is_next_epoch = 0;
1654 /* In current epoch, accept HM, CCS, DATA, & ALERT */
1655 if (rr->epoch == s->d1->r_epoch)
1656 return &s->d1->bitmap;
1658 /* Only HM and ALERT messages can be from the next epoch */
1659 else if (rr->epoch == (unsigned long)(s->d1->r_epoch + 1) &&
1660 (rr->type == SSL3_RT_HANDSHAKE ||
1661 rr->type == SSL3_RT_ALERT))
1663 *is_next_epoch = 1;
1664 return &s->d1->next_bitmap;
1667 return NULL;
1670 #if 0
1671 static int
1672 dtls1_record_needs_buffering(SSL *s, SSL3_RECORD *rr, unsigned short *priority,
1673 unsigned long *offset)
1676 /* alerts are passed up immediately */
1677 if ( rr->type == SSL3_RT_APPLICATION_DATA ||
1678 rr->type == SSL3_RT_ALERT)
1679 return 0;
1681 /* Only need to buffer if a handshake is underway.
1682 * (this implies that Hello Request and Client Hello are passed up
1683 * immediately) */
1684 if ( SSL_in_init(s))
1686 unsigned char *data = rr->data;
1687 /* need to extract the HM/CCS sequence number here */
1688 if ( rr->type == SSL3_RT_HANDSHAKE ||
1689 rr->type == SSL3_RT_CHANGE_CIPHER_SPEC)
1691 unsigned short seq_num;
1692 struct hm_header_st msg_hdr;
1693 struct ccs_header_st ccs_hdr;
1695 if ( rr->type == SSL3_RT_HANDSHAKE)
1697 dtls1_get_message_header(data, &msg_hdr);
1698 seq_num = msg_hdr.seq;
1699 *offset = msg_hdr.frag_off;
1701 else
1703 dtls1_get_ccs_header(data, &ccs_hdr);
1704 seq_num = ccs_hdr.seq;
1705 *offset = 0;
1708 /* this is either a record we're waiting for, or a
1709 * retransmit of something we happened to previously
1710 * receive (higher layers will drop the repeat silently */
1711 if ( seq_num < s->d1->handshake_read_seq)
1712 return 0;
1713 if (rr->type == SSL3_RT_HANDSHAKE &&
1714 seq_num == s->d1->handshake_read_seq &&
1715 msg_hdr.frag_off < s->d1->r_msg_hdr.frag_off)
1716 return 0;
1717 else if ( seq_num == s->d1->handshake_read_seq &&
1718 (rr->type == SSL3_RT_CHANGE_CIPHER_SPEC ||
1719 msg_hdr.frag_off == s->d1->r_msg_hdr.frag_off))
1720 return 0;
1721 else
1723 *priority = seq_num;
1724 return 1;
1727 else /* unknown record type */
1728 return 0;
1731 return 0;
1733 #endif
1735 void
1736 dtls1_reset_seq_numbers(SSL *s, int rw)
1738 unsigned char *seq;
1739 unsigned int seq_bytes = sizeof(s->s3->read_sequence);
1741 if ( rw & SSL3_CC_READ)
1743 seq = s->s3->read_sequence;
1744 s->d1->r_epoch++;
1746 pq_64bit_assign(&(s->d1->bitmap.map), &(s->d1->next_bitmap.map));
1747 s->d1->bitmap.length = s->d1->next_bitmap.length;
1748 pq_64bit_assign(&(s->d1->bitmap.max_seq_num),
1749 &(s->d1->next_bitmap.max_seq_num));
1751 pq_64bit_free(&(s->d1->next_bitmap.map));
1752 pq_64bit_free(&(s->d1->next_bitmap.max_seq_num));
1753 memset(&(s->d1->next_bitmap), 0x00, sizeof(DTLS1_BITMAP));
1754 pq_64bit_init(&(s->d1->next_bitmap.map));
1755 pq_64bit_init(&(s->d1->next_bitmap.max_seq_num));
1757 else
1759 seq = s->s3->write_sequence;
1760 s->d1->w_epoch++;
1763 memset(seq, 0x00, seq_bytes);
1766 #if PQ_64BIT_IS_INTEGER
1767 static PQ_64BIT
1768 bytes_to_long_long(unsigned char *bytes, PQ_64BIT *num)
1770 PQ_64BIT _num;
1772 _num = (((PQ_64BIT)bytes[0]) << 56) |
1773 (((PQ_64BIT)bytes[1]) << 48) |
1774 (((PQ_64BIT)bytes[2]) << 40) |
1775 (((PQ_64BIT)bytes[3]) << 32) |
1776 (((PQ_64BIT)bytes[4]) << 24) |
1777 (((PQ_64BIT)bytes[5]) << 16) |
1778 (((PQ_64BIT)bytes[6]) << 8) |
1779 (((PQ_64BIT)bytes[7]) );
1781 *num = _num ;
1782 return _num;
1784 #endif
1787 static void
1788 dtls1_clear_timeouts(SSL *s)
1790 memset(&(s->d1->timeout), 0x00, sizeof(struct dtls1_timeout_st));