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