Ensure compressdata is always initialised
[openssl.git] / ssl / record / rec_layer_s3.c
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include <limits.h>
12 #include <errno.h>
13 #define USE_SOCKETS
14 #include "../ssl_locl.h"
15 #include <openssl/evp.h>
16 #include <openssl/buffer.h>
17 #include <openssl/rand.h>
18 #include "record_locl.h"
19
20 #ifndef  EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
21 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
22 #endif
23
24 #if     defined(OPENSSL_SMALL_FOOTPRINT) || \
25         !(      defined(AES_ASM) &&     ( \
26                 defined(__x86_64)       || defined(__x86_64__)  || \
27                 defined(_M_AMD64)       || defined(_M_X64)      ) \
28         )
29 # undef EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
30 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
31 #endif
32
33 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s)
34 {
35     rl->s = s;
36     RECORD_LAYER_set_first_record(&s->rlayer);
37     SSL3_RECORD_clear(rl->rrec, SSL_MAX_PIPELINES);
38 }
39
40 void RECORD_LAYER_clear(RECORD_LAYER *rl)
41 {
42     unsigned int pipes;
43
44     rl->rstate = SSL_ST_READ_HEADER;
45
46     /*
47      * Do I need to clear read_ahead? As far as I can tell read_ahead did not
48      * previously get reset by SSL_clear...so I'll keep it that way..but is
49      * that right?
50      */
51
52     rl->packet = NULL;
53     rl->packet_length = 0;
54     rl->wnum = 0;
55     memset(rl->alert_fragment, 0, sizeof(rl->alert_fragment));
56     rl->alert_fragment_len = 0;
57     memset(rl->handshake_fragment, 0, sizeof(rl->handshake_fragment));
58     rl->handshake_fragment_len = 0;
59     rl->wpend_tot = 0;
60     rl->wpend_type = 0;
61     rl->wpend_ret = 0;
62     rl->wpend_buf = NULL;
63
64     SSL3_BUFFER_clear(&rl->rbuf);
65     for (pipes = 0; pipes < rl->numwpipes; pipes++)
66         SSL3_BUFFER_clear(&rl->wbuf[pipes]);
67     rl->numwpipes = 0;
68     rl->numrpipes = 0;
69     SSL3_RECORD_clear(rl->rrec, SSL_MAX_PIPELINES);
70
71     RECORD_LAYER_reset_read_sequence(rl);
72     RECORD_LAYER_reset_write_sequence(rl);
73
74     if (rl->d)
75         DTLS_RECORD_LAYER_clear(rl);
76 }
77
78 void RECORD_LAYER_release(RECORD_LAYER *rl)
79 {
80     if (SSL3_BUFFER_is_initialised(&rl->rbuf))
81         ssl3_release_read_buffer(rl->s);
82     if (rl->numwpipes > 0)
83         ssl3_release_write_buffer(rl->s);
84     SSL3_RECORD_release(rl->rrec, SSL_MAX_PIPELINES);
85 }
86
87 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl)
88 {
89     return SSL3_BUFFER_get_left(&rl->rbuf) != 0;
90 }
91
92 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl)
93 {
94     return (rl->numwpipes > 0)
95         && SSL3_BUFFER_get_left(&rl->wbuf[rl->numwpipes - 1]) != 0;
96 }
97
98 int RECORD_LAYER_set_data(RECORD_LAYER *rl, const unsigned char *buf,
99                           size_t len)
100 {
101     rl->packet_length = len;
102     if (len != 0) {
103         rl->rstate = SSL_ST_READ_HEADER;
104         if (!SSL3_BUFFER_is_initialised(&rl->rbuf))
105             if (!ssl3_setup_read_buffer(rl->s))
106                 return 0;
107     }
108
109     rl->packet = SSL3_BUFFER_get_buf(&rl->rbuf);
110     SSL3_BUFFER_set_data(&rl->rbuf, buf, len);
111
112     return 1;
113 }
114
115 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl)
116 {
117     memset(rl->read_sequence, 0, sizeof(rl->read_sequence));
118 }
119
120 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl)
121 {
122     memset(rl->write_sequence, 0, sizeof(rl->write_sequence));
123 }
124
125 size_t ssl3_pending(const SSL *s)
126 {
127     size_t i, num = 0;
128
129     if (s->rlayer.rstate == SSL_ST_READ_BODY)
130         return 0;
131
132     for (i = 0; i < RECORD_LAYER_get_numrpipes(&s->rlayer); i++) {
133         if (SSL3_RECORD_get_type(&s->rlayer.rrec[i])
134             != SSL3_RT_APPLICATION_DATA)
135             return 0;
136         num += SSL3_RECORD_get_length(&s->rlayer.rrec[i]);
137     }
138
139     return num;
140 }
141
142 void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len)
143 {
144     ctx->default_read_buf_len = len;
145 }
146
147 void SSL_set_default_read_buffer_len(SSL *s, size_t len)
148 {
149     SSL3_BUFFER_set_default_len(RECORD_LAYER_get_rbuf(&s->rlayer), len);
150 }
151
152 const char *SSL_rstate_string_long(const SSL *s)
153 {
154     switch (s->rlayer.rstate) {
155     case SSL_ST_READ_HEADER:
156         return "read header";
157     case SSL_ST_READ_BODY:
158         return "read body";
159     case SSL_ST_READ_DONE:
160         return "read done";
161     default:
162         return "unknown";
163     }
164 }
165
166 const char *SSL_rstate_string(const SSL *s)
167 {
168     switch (s->rlayer.rstate) {
169     case SSL_ST_READ_HEADER:
170         return "RH";
171     case SSL_ST_READ_BODY:
172         return "RB";
173     case SSL_ST_READ_DONE:
174         return "RD";
175     default:
176         return "unknown";
177     }
178 }
179
180 /*
181  * Return values are as per SSL_read()
182  */
183 int ssl3_read_n(SSL *s, size_t n, size_t max, int extend, int clearold,
184                 size_t *readbytes)
185 {
186     /*
187      * If extend == 0, obtain new n-byte packet; if extend == 1, increase
188      * packet by another n bytes. The packet will be in the sub-array of
189      * s->s3->rbuf.buf specified by s->packet and s->packet_length. (If
190      * s->rlayer.read_ahead is set, 'max' bytes may be stored in rbuf [plus
191      * s->packet_length bytes if extend == 1].)
192      * if clearold == 1, move the packet to the start of the buffer; if
193      * clearold == 0 then leave any old packets where they were
194      */
195     size_t len, left, align = 0;
196     unsigned char *pkt;
197     SSL3_BUFFER *rb;
198
199     if (n == 0)
200         return 0;
201
202     rb = &s->rlayer.rbuf;
203     if (rb->buf == NULL)
204         if (!ssl3_setup_read_buffer(s))
205             return -1;
206
207     left = rb->left;
208 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
209     align = (size_t)rb->buf + SSL3_RT_HEADER_LENGTH;
210     align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
211 #endif
212
213     if (!extend) {
214         /* start with empty packet ... */
215         if (left == 0)
216             rb->offset = align;
217         else if (align != 0 && left >= SSL3_RT_HEADER_LENGTH) {
218             /*
219              * check if next packet length is large enough to justify payload
220              * alignment...
221              */
222             pkt = rb->buf + rb->offset;
223             if (pkt[0] == SSL3_RT_APPLICATION_DATA
224                 && (pkt[3] << 8 | pkt[4]) >= 128) {
225                 /*
226                  * Note that even if packet is corrupted and its length field
227                  * is insane, we can only be led to wrong decision about
228                  * whether memmove will occur or not. Header values has no
229                  * effect on memmove arguments and therefore no buffer
230                  * overrun can be triggered.
231                  */
232                 memmove(rb->buf + align, pkt, left);
233                 rb->offset = align;
234             }
235         }
236         s->rlayer.packet = rb->buf + rb->offset;
237         s->rlayer.packet_length = 0;
238         /* ... now we can act as if 'extend' was set */
239     }
240
241     len = s->rlayer.packet_length;
242     pkt = rb->buf + align;
243     /*
244      * Move any available bytes to front of buffer: 'len' bytes already
245      * pointed to by 'packet', 'left' extra ones at the end
246      */
247     if (s->rlayer.packet != pkt && clearold == 1) {
248         memmove(pkt, s->rlayer.packet, len + left);
249         s->rlayer.packet = pkt;
250         rb->offset = len + align;
251     }
252
253     /*
254      * For DTLS/UDP reads should not span multiple packets because the read
255      * operation returns the whole packet at once (as long as it fits into
256      * the buffer).
257      */
258     if (SSL_IS_DTLS(s)) {
259         if (left == 0 && extend)
260             return 0;
261         if (left > 0 && n > left)
262             n = left;
263     }
264
265     /* if there is enough in the buffer from a previous read, take some */
266     if (left >= n) {
267         s->rlayer.packet_length += n;
268         rb->left = left - n;
269         rb->offset += n;
270         *readbytes = n;
271         return 1;
272     }
273
274     /* else we need to read more data */
275
276     if (n > rb->len - rb->offset) { /* does not happen */
277         SSLerr(SSL_F_SSL3_READ_N, ERR_R_INTERNAL_ERROR);
278         return -1;
279     }
280
281     /* We always act like read_ahead is set for DTLS */
282     if (!s->rlayer.read_ahead && !SSL_IS_DTLS(s))
283         /* ignore max parameter */
284         max = n;
285     else {
286         if (max < n)
287             max = n;
288         if (max > rb->len - rb->offset)
289             max = rb->len - rb->offset;
290     }
291
292     while (left < n) {
293         size_t bioread = 0;
294         int ret;
295
296         /*
297          * Now we have len+left bytes at the front of s->s3->rbuf.buf and
298          * need to read in more until we have len+n (up to len+max if
299          * possible)
300          */
301
302         clear_sys_error();
303         if (s->rbio != NULL) {
304             s->rwstate = SSL_READING;
305             /* TODO(size_t): Convert this function */
306             ret = BIO_read(s->rbio, pkt + len + left, max - left);
307             if (ret >= 0)
308                 bioread = ret;
309         } else {
310             SSLerr(SSL_F_SSL3_READ_N, SSL_R_READ_BIO_NOT_SET);
311             ret = -1;
312         }
313
314         if (ret <= 0) {
315             rb->left = left;
316             if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
317                 if (len + left == 0)
318                     ssl3_release_read_buffer(s);
319             return ret;
320         }
321         left += bioread;
322         /*
323          * reads should *never* span multiple packets for DTLS because the
324          * underlying transport protocol is message oriented as opposed to
325          * byte oriented as in the TLS case.
326          */
327         if (SSL_IS_DTLS(s)) {
328             if (n > left)
329                 n = left;       /* makes the while condition false */
330         }
331     }
332
333     /* done reading, now the book-keeping */
334     rb->offset += n;
335     rb->left = left - n;
336     s->rlayer.packet_length += n;
337     s->rwstate = SSL_NOTHING;
338     *readbytes = n;
339     return 1;
340 }
341
342 /*
343  * Call this to write data in records of type 'type' It will return <= 0 if
344  * not all data has been sent or non-blocking IO.
345  */
346 int ssl3_write_bytes(SSL *s, int type, const void *buf_, size_t len,
347                      size_t *written)
348 {
349     const unsigned char *buf = buf_;
350     size_t tot;
351     size_t n, split_send_fragment, maxpipes;
352 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
353     size_t max_send_fragment, nw;
354 #endif
355     SSL3_BUFFER *wb = &s->rlayer.wbuf[0];
356     int i;
357     size_t tmpwrit;
358
359     s->rwstate = SSL_NOTHING;
360     tot = s->rlayer.wnum;
361     /*
362      * ensure that if we end up with a smaller value of data to write out
363      * than the the original len from a write which didn't complete for
364      * non-blocking I/O and also somehow ended up avoiding the check for
365      * this in ssl3_write_pending/SSL_R_BAD_WRITE_RETRY as it must never be
366      * possible to end up with (len-tot) as a large number that will then
367      * promptly send beyond the end of the users buffer ... so we trap and
368      * report the error in a way the user will notice
369      */
370     if (len < s->rlayer.wnum) {
371         SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_BAD_LENGTH);
372         return -1;
373     }
374
375     s->rlayer.wnum = 0;
376
377     if (SSL_in_init(s) && !ossl_statem_get_in_handshake(s)) {
378         i = s->handshake_func(s);
379         if (i < 0)
380             return i;
381         if (i == 0) {
382             SSLerr(SSL_F_SSL3_WRITE_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
383             return -1;
384         }
385     }
386
387     /*
388      * first check if there is a SSL3_BUFFER still being written out.  This
389      * will happen with non blocking IO
390      */
391     if (wb->left != 0) {
392         i = ssl3_write_pending(s, type, &buf[tot], s->rlayer.wpend_tot,
393                                &tmpwrit);
394         if (i <= 0) {
395             /* XXX should we ssl3_release_write_buffer if i<0? */
396             s->rlayer.wnum = tot;
397             return i;
398         }
399         tot += tmpwrit;               /* this might be last fragment */
400     }
401 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
402     /*
403      * Depending on platform multi-block can deliver several *times*
404      * better performance. Downside is that it has to allocate
405      * jumbo buffer to accommodate up to 8 records, but the
406      * compromise is considered worthy.
407      */
408     if (type == SSL3_RT_APPLICATION_DATA &&
409         len >= 4 * (max_send_fragment = s->max_send_fragment) &&
410         s->compress == NULL && s->msg_callback == NULL &&
411         !SSL_USE_ETM(s) && SSL_USE_EXPLICIT_IV(s) &&
412         EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx)) &
413         EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK) {
414         unsigned char aad[13];
415         EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM mb_param;
416         size_t packlen;
417         int packleni;
418
419         /* minimize address aliasing conflicts */
420         if ((max_send_fragment & 0xfff) == 0)
421             max_send_fragment -= 512;
422
423         if (tot == 0 || wb->buf == NULL) { /* allocate jumbo buffer */
424             ssl3_release_write_buffer(s);
425
426             packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
427                                           EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE,
428                                           (int)max_send_fragment, NULL);
429
430             if (len >= 8 * max_send_fragment)
431                 packlen *= 8;
432             else
433                 packlen *= 4;
434
435             if (!ssl3_setup_write_buffer(s, 1, packlen)) {
436                 SSLerr(SSL_F_SSL3_WRITE_BYTES, ERR_R_MALLOC_FAILURE);
437                 return -1;
438             }
439         } else if (tot == len) { /* done? */
440             /* free jumbo buffer */
441             ssl3_release_write_buffer(s);
442             *written = tot;
443             return 1;
444         }
445
446         n = (len - tot);
447         for (;;) {
448             if (n < 4 * max_send_fragment) {
449                 /* free jumbo buffer */
450                 ssl3_release_write_buffer(s);
451                 break;
452             }
453
454             if (s->s3->alert_dispatch) {
455                 i = s->method->ssl_dispatch_alert(s);
456                 if (i <= 0) {
457                     s->rlayer.wnum = tot;
458                     return i;
459                 }
460             }
461
462             if (n >= 8 * max_send_fragment)
463                 nw = max_send_fragment * (mb_param.interleave = 8);
464             else
465                 nw = max_send_fragment * (mb_param.interleave = 4);
466
467             memcpy(aad, s->rlayer.write_sequence, 8);
468             aad[8] = type;
469             aad[9] = (unsigned char)(s->version >> 8);
470             aad[10] = (unsigned char)(s->version);
471             aad[11] = 0;
472             aad[12] = 0;
473             mb_param.out = NULL;
474             mb_param.inp = aad;
475             mb_param.len = nw;
476
477             packleni = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
478                                           EVP_CTRL_TLS1_1_MULTIBLOCK_AAD,
479                                           sizeof(mb_param), &mb_param);
480             packlen = (size_t)packleni;
481             if (packleni <= 0 || packlen > wb->len) { /* never happens */
482                 /* free jumbo buffer */
483                 ssl3_release_write_buffer(s);
484                 break;
485             }
486
487             mb_param.out = wb->buf;
488             mb_param.inp = &buf[tot];
489             mb_param.len = nw;
490
491             if (EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
492                                     EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT,
493                                     sizeof(mb_param), &mb_param) <= 0)
494                 return -1;
495
496             s->rlayer.write_sequence[7] += mb_param.interleave;
497             if (s->rlayer.write_sequence[7] < mb_param.interleave) {
498                 int j = 6;
499                 while (j >= 0 && (++s->rlayer.write_sequence[j--]) == 0) ;
500             }
501
502             wb->offset = 0;
503             wb->left = packlen;
504
505             s->rlayer.wpend_tot = nw;
506             s->rlayer.wpend_buf = &buf[tot];
507             s->rlayer.wpend_type = type;
508             s->rlayer.wpend_ret = nw;
509
510             i = ssl3_write_pending(s, type, &buf[tot], nw, &tmpwrit);
511             if (i <= 0) {
512                 if (i < 0 && (!s->wbio || !BIO_should_retry(s->wbio))) {
513                     /* free jumbo buffer */
514                     ssl3_release_write_buffer(s);
515                 }
516                 s->rlayer.wnum = tot;
517                 return i;
518             }
519             if (tmpwrit == n) {
520                 /* free jumbo buffer */
521                 ssl3_release_write_buffer(s);
522                 *written = tot + tmpwrit;
523                 return 1;
524             }
525             n -= tmpwrit;
526             tot += tmpwrit;
527         }
528     } else
529 #endif
530     if (tot == len) {           /* done? */
531         if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
532             ssl3_release_write_buffer(s);
533
534         *written = tot;
535         return 1;
536     }
537
538     n = (len - tot);
539
540     split_send_fragment = s->split_send_fragment;
541     /*
542      * If max_pipelines is 0 then this means "undefined" and we default to
543      * 1 pipeline. Similarly if the cipher does not support pipelined
544      * processing then we also only use 1 pipeline, or if we're not using
545      * explicit IVs
546      */
547     maxpipes = s->max_pipelines;
548     if (maxpipes > SSL_MAX_PIPELINES) {
549         /*
550          * We should have prevented this when we set max_pipelines so we
551          * shouldn't get here
552          */
553         SSLerr(SSL_F_SSL3_WRITE_BYTES, ERR_R_INTERNAL_ERROR);
554         return -1;
555     }
556     if (maxpipes == 0
557         || s->enc_write_ctx == NULL
558         || !(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx))
559              & EVP_CIPH_FLAG_PIPELINE)
560         || !SSL_USE_EXPLICIT_IV(s))
561         maxpipes = 1;
562     if (s->max_send_fragment == 0 || split_send_fragment > s->max_send_fragment
563         || split_send_fragment == 0) {
564         /*
565          * We should have prevented this when we set the split and max send
566          * fragments so we shouldn't get here
567          */
568         SSLerr(SSL_F_SSL3_WRITE_BYTES, ERR_R_INTERNAL_ERROR);
569         return -1;
570     }
571
572     for (;;) {
573         size_t pipelens[SSL_MAX_PIPELINES], tmppipelen, remain;
574         size_t numpipes, j;
575
576         if (n == 0)
577             numpipes = 1;
578         else
579             numpipes = ((n - 1) / split_send_fragment) + 1;
580         if (numpipes > maxpipes)
581             numpipes = maxpipes;
582
583         if (n / numpipes >= s->max_send_fragment) {
584             /*
585              * We have enough data to completely fill all available
586              * pipelines
587              */
588             for (j = 0; j < numpipes; j++) {
589                 pipelens[j] = s->max_send_fragment;
590             }
591         } else {
592             /* We can partially fill all available pipelines */
593             tmppipelen = n / numpipes;
594             remain = n % numpipes;
595             for (j = 0; j < numpipes; j++) {
596                 pipelens[j] = tmppipelen;
597                 if (j < remain)
598                     pipelens[j]++;
599             }
600         }
601
602         i = do_ssl3_write(s, type, &(buf[tot]), pipelens, numpipes, 0,
603                           &tmpwrit);
604         if (i <= 0) {
605             /* XXX should we ssl3_release_write_buffer if i<0? */
606             s->rlayer.wnum = tot;
607             return i;
608         }
609
610         if (tmpwrit == n ||
611             (type == SSL3_RT_APPLICATION_DATA &&
612              (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE))) {
613             /*
614              * next chunk of data should get another prepended empty fragment
615              * in ciphersuites with known-IV weakness:
616              */
617             s->s3->empty_fragment_done = 0;
618
619             if ((i == (int)n) && s->mode & SSL_MODE_RELEASE_BUFFERS &&
620                 !SSL_IS_DTLS(s))
621                 ssl3_release_write_buffer(s);
622
623             *written = tot + tmpwrit;
624             return 1;
625         }
626
627         n -= tmpwrit;
628         tot += tmpwrit;
629     }
630 }
631
632 int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
633                   size_t *pipelens, size_t numpipes,
634                   int create_empty_fragment, size_t *written)
635 {
636     WPACKET pkt[SSL_MAX_PIPELINES];
637     SSL3_RECORD wr[SSL_MAX_PIPELINES];
638     unsigned char *recordstart;
639     int i, mac_size, clear = 0;
640     size_t prefix_len = 0;
641     int eivlen;
642     size_t align = 0;
643     SSL3_BUFFER *wb;
644     SSL_SESSION *sess;
645     size_t totlen = 0, len, wpinited = 0;
646     size_t j;
647
648     for (j = 0; j < numpipes; j++)
649         totlen += pipelens[j];
650     /*
651      * first check if there is a SSL3_BUFFER still being written out.  This
652      * will happen with non blocking IO
653      */
654     if (RECORD_LAYER_write_pending(&s->rlayer))
655         return ssl3_write_pending(s, type, buf, totlen, written);
656
657     /* If we have an alert to send, lets send it */
658     if (s->s3->alert_dispatch) {
659         i = s->method->ssl_dispatch_alert(s);
660         if (i <= 0)
661             return (i);
662         /* if it went, fall through and send more stuff */
663     }
664
665     if (s->rlayer.numwpipes < numpipes)
666         if (!ssl3_setup_write_buffer(s, numpipes, 0))
667             return -1;
668
669     if (totlen == 0 && !create_empty_fragment)
670         return 0;
671
672     sess = s->session;
673
674     if ((sess == NULL) ||
675         (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL)) {
676         clear = s->enc_write_ctx ? 0 : 1; /* must be AEAD cipher */
677         mac_size = 0;
678     } else {
679         /* TODO(siz_t): Convert me */
680         mac_size = EVP_MD_CTX_size(s->write_hash);
681         if (mac_size < 0)
682             goto err;
683     }
684
685     /*
686      * 'create_empty_fragment' is true only when this function calls itself
687      */
688     if (!clear && !create_empty_fragment && !s->s3->empty_fragment_done) {
689         /*
690          * countermeasure against known-IV weakness in CBC ciphersuites (see
691          * http://www.openssl.org/~bodo/tls-cbc.txt)
692          */
693
694         if (s->s3->need_empty_fragments && type == SSL3_RT_APPLICATION_DATA) {
695             /*
696              * recursive function call with 'create_empty_fragment' set; this
697              * prepares and buffers the data for an empty fragment (these
698              * 'prefix_len' bytes are sent out later together with the actual
699              * payload)
700              */
701             size_t tmppipelen = 0;
702             int ret;
703
704             ret = do_ssl3_write(s, type, buf, &tmppipelen, 1, 1, &prefix_len);
705             if (ret <= 0)
706                 goto err;
707
708             if (prefix_len >
709                 (SSL3_RT_HEADER_LENGTH + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD)) {
710                 /* insufficient space */
711                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
712                 goto err;
713             }
714         }
715
716         s->s3->empty_fragment_done = 1;
717     }
718
719     if (create_empty_fragment) {
720         wb = &s->rlayer.wbuf[0];
721 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
722         /*
723          * extra fragment would be couple of cipher blocks, which would be
724          * multiple of SSL3_ALIGN_PAYLOAD, so if we want to align the real
725          * payload, then we can just pretend we simply have two headers.
726          */
727         align = (size_t)SSL3_BUFFER_get_buf(wb) + 2 * SSL3_RT_HEADER_LENGTH;
728         align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
729 #endif
730         SSL3_BUFFER_set_offset(wb, align);
731         if (!WPACKET_init_static_len(&pkt[0], SSL3_BUFFER_get_buf(wb),
732                                      SSL3_BUFFER_get_len(wb), 0)
733                 || !WPACKET_allocate_bytes(&pkt[0], align, NULL)) {
734             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
735             goto err;
736         }
737         wpinited = 1;
738     } else if (prefix_len) {
739         wb = &s->rlayer.wbuf[0];
740         if (!WPACKET_init_static_len(&pkt[0], SSL3_BUFFER_get_buf(wb),
741                                      SSL3_BUFFER_get_len(wb), 0)
742                 || !WPACKET_allocate_bytes(&pkt[0], SSL3_BUFFER_get_offset(wb)
743                                                     + prefix_len, NULL)) {
744             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
745             goto err;
746         }
747         wpinited = 1;
748     } else {
749         for (j = 0; j < numpipes; j++) {
750             wb = &s->rlayer.wbuf[j];
751 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
752             align = (size_t)SSL3_BUFFER_get_buf(wb) + SSL3_RT_HEADER_LENGTH;
753             align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
754 #endif
755             SSL3_BUFFER_set_offset(wb, align);
756             if (!WPACKET_init_static_len(&pkt[j], SSL3_BUFFER_get_buf(wb),
757                                          SSL3_BUFFER_get_len(wb), 0)
758                     || !WPACKET_allocate_bytes(&pkt[j], align, NULL)) {
759                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
760                 goto err;
761             }
762             wpinited++;
763         }
764     }
765
766     /* Explicit IV length, block ciphers appropriate version flag */
767     if (s->enc_write_ctx && SSL_USE_EXPLICIT_IV(s)) {
768         int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
769         if (mode == EVP_CIPH_CBC_MODE) {
770             /* TODO(size_t): Convert me */
771             eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
772             if (eivlen <= 1)
773                 eivlen = 0;
774         } else if (mode == EVP_CIPH_GCM_MODE) {
775             /* Need explicit part of IV for GCM mode */
776             eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
777         } else if (mode == EVP_CIPH_CCM_MODE) {
778             eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
779         } else {
780             eivlen = 0;
781         }
782     } else {
783         eivlen = 0;
784     }
785
786     totlen = 0;
787     /* Clear our SSL3_RECORD structures */
788     memset(wr, 0, sizeof wr);
789     for (j = 0; j < numpipes; j++) {
790         unsigned int version = s->version;
791         unsigned char *compressdata = NULL;
792         size_t maxcomplen;
793         unsigned int rectype;
794
795         SSL3_RECORD_set_type(&wr[j], type);
796         /*
797          * In TLSv1.3, once encrypting, we always use application data for the
798          * record type
799          */
800         if (SSL_IS_TLS13(s) && s->enc_write_ctx != NULL)
801             rectype = SSL3_RT_APPLICATION_DATA;
802         else
803             rectype = type;
804         /*
805          * Some servers hang if initial client hello is larger than 256 bytes
806          * and record version number > TLS 1.0
807          */
808         if (SSL_get_state(s) == TLS_ST_CW_CLNT_HELLO
809             && !s->renegotiate && TLS1_get_version(s) > TLS1_VERSION)
810             version = TLS1_VERSION;
811
812         maxcomplen = pipelens[j] + (s->compress != NULL
813                                     ? SSL3_RT_MAX_COMPRESSED_OVERHEAD : 0);
814         /* write the header */
815         if (!WPACKET_put_bytes_u8(&pkt[j], rectype)
816                 || !WPACKET_put_bytes_u16(&pkt[j], version)
817                 || !WPACKET_start_sub_packet_u16(&pkt[j])
818                 || (eivlen > 0
819                     && !WPACKET_allocate_bytes(&pkt[j], eivlen, NULL))
820                 || (maxcomplen > 0
821                     && !WPACKET_reserve_bytes(&pkt[j], maxcomplen,
822                                               &compressdata))) {
823             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
824             goto err;
825         }
826
827         /* lets setup the record stuff. */
828         SSL3_RECORD_set_data(&wr[j], compressdata);
829         SSL3_RECORD_set_length(&wr[j], pipelens[j]);
830         SSL3_RECORD_set_input(&wr[j], (unsigned char *)&buf[totlen]);
831         totlen += pipelens[j];
832
833         /*
834          * we now 'read' from wr->input, wr->length bytes into wr->data
835          */
836
837         /* first we compress */
838         if (s->compress != NULL) {
839             /*
840              * TODO(TLS1.3): Make sure we prevent compression!!!
841              */
842             if (!ssl3_do_compress(s, &wr[j])
843                     || !WPACKET_allocate_bytes(&pkt[j], wr[j].length, NULL)) {
844                 SSLerr(SSL_F_DO_SSL3_WRITE, SSL_R_COMPRESSION_FAILURE);
845                 goto err;
846             }
847         } else {
848             if (!WPACKET_memcpy(&pkt[j], wr[j].input, wr[j].length)) {
849                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
850                 goto err;
851             }
852             SSL3_RECORD_reset_input(&wr[j]);
853         }
854
855         if (SSL_IS_TLS13(s) && s->enc_write_ctx != NULL) {
856             if (!WPACKET_put_bytes_u8(&pkt[j], type)) {
857                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
858                 goto err;
859             }
860             SSL3_RECORD_add_length(&wr[j], 1);
861             /*
862              * TODO(TLS1.3): Padding goes here. Do we need an API to add this?
863              * For now, use no padding
864              */
865         }
866
867         /*
868          * we should still have the output to wr->data and the input from
869          * wr->input.  Length should be wr->length. wr->data still points in the
870          * wb->buf
871          */
872
873         if (!SSL_USE_ETM(s) && mac_size != 0) {
874             unsigned char *mac;
875
876             if (!WPACKET_allocate_bytes(&pkt[j], mac_size, &mac)
877                     || !s->method->ssl3_enc->mac(s, &wr[j], mac, 1)) {
878                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
879                 goto err;
880             }
881         }
882
883         /*
884          * Reserve some bytes for any growth that may occur during encryption.
885          * This will be at most one cipher block or the tag length if using
886          * AEAD. SSL_RT_MAX_CIPHER_BLOCK_SIZE covers either case.
887          */
888         if(!WPACKET_reserve_bytes(&pkt[j], SSL_RT_MAX_CIPHER_BLOCK_SIZE,
889                                   NULL)
890                    /*
891                     * We also need next the amount of bytes written to this
892                     * sub-packet
893                     */
894                 || !WPACKET_get_length(&pkt[j], &len)) {
895             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
896             goto err;
897         }
898
899         /* Get a pointer to the start of this record excluding header */
900         recordstart = WPACKET_get_curr(&pkt[j]) - len;
901
902         SSL3_RECORD_set_data(&wr[j], recordstart);
903         SSL3_RECORD_reset_input(&wr[j]);
904         SSL3_RECORD_set_length(&wr[j], len);
905     }
906
907     if (s->method->ssl3_enc->enc(s, wr, numpipes, 1) < 1)
908         goto err;
909
910     for (j = 0; j < numpipes; j++) {
911         size_t origlen;
912
913         /* Allocate bytes for the encryption overhead */
914         if (!WPACKET_get_length(&pkt[j], &origlen)
915                    /* Encryption should never shrink the data! */
916                 || origlen > wr[j].length
917                 || (wr[j].length > origlen
918                     && !WPACKET_allocate_bytes(&pkt[j],
919                                                wr[j].length - origlen, NULL))) {
920             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
921             goto err;
922         }
923         if (SSL_USE_ETM(s) && mac_size != 0) {
924             unsigned char *mac;
925
926             if (!WPACKET_allocate_bytes(&pkt[j], mac_size, &mac)
927                     || !s->method->ssl3_enc->mac(s, &wr[j], mac, 1)) {
928                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
929                 goto err;
930             }
931             SSL3_RECORD_add_length(&wr[j], mac_size);
932         }
933
934         if (!WPACKET_get_length(&pkt[j], &len)
935                 || !WPACKET_close(&pkt[j])) {
936             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
937             goto err;
938         }
939
940         if (s->msg_callback) {
941             recordstart = WPACKET_get_curr(&pkt[j]) - len
942                           - SSL3_RT_HEADER_LENGTH;
943             s->msg_callback(1, 0, SSL3_RT_HEADER, recordstart,
944                             SSL3_RT_HEADER_LENGTH, s,
945                             s->msg_callback_arg);
946         }
947
948         if (!WPACKET_finish(&pkt[j])) {
949             SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
950             goto err;
951         }
952
953         /*
954          * we should now have wr->data pointing to the encrypted data, which is
955          * wr->length long
956          */
957         SSL3_RECORD_set_type(&wr[j], type); /* not needed but helps for
958                                              * debugging */
959         SSL3_RECORD_add_length(&wr[j], SSL3_RT_HEADER_LENGTH);
960
961         if (create_empty_fragment) {
962             /*
963              * we are in a recursive call; just return the length, don't write
964              * out anything here
965              */
966             if (j > 0) {
967                 /* We should never be pipelining an empty fragment!! */
968                 SSLerr(SSL_F_DO_SSL3_WRITE, ERR_R_INTERNAL_ERROR);
969                 goto err;
970             }
971             *written = SSL3_RECORD_get_length(wr);
972             return 1;
973         }
974
975         /* now let's set up wb */
976         SSL3_BUFFER_set_left(&s->rlayer.wbuf[j],
977                              prefix_len + SSL3_RECORD_get_length(&wr[j]));
978     }
979
980     /*
981      * memorize arguments so that ssl3_write_pending can detect bad write
982      * retries later
983      */
984     s->rlayer.wpend_tot = totlen;
985     s->rlayer.wpend_buf = buf;
986     s->rlayer.wpend_type = type;
987     s->rlayer.wpend_ret = totlen;
988
989     /* we now just need to write the buffer */
990     return ssl3_write_pending(s, type, buf, totlen, written);
991  err:
992     for (j = 0; j < wpinited; j++)
993         WPACKET_cleanup(&pkt[j]);
994     return -1;
995 }
996
997 /* if s->s3->wbuf.left != 0, we need to call this
998  *
999  * Return values are as per SSL_write()
1000  */
1001 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf, size_t len,
1002                        size_t *written)
1003 {
1004     int i;
1005     SSL3_BUFFER *wb = s->rlayer.wbuf;
1006     size_t currbuf = 0;
1007     size_t tmpwrit = 0;
1008
1009     if ((s->rlayer.wpend_tot > len)
1010         || ((s->rlayer.wpend_buf != buf) &&
1011             !(s->mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER))
1012         || (s->rlayer.wpend_type != type)) {
1013         SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BAD_WRITE_RETRY);
1014         return -1;
1015     }
1016
1017     for (;;) {
1018         /* Loop until we find a buffer we haven't written out yet */
1019         if (SSL3_BUFFER_get_left(&wb[currbuf]) == 0
1020             && currbuf < s->rlayer.numwpipes - 1) {
1021             currbuf++;
1022             continue;
1023         }
1024         clear_sys_error();
1025         if (s->wbio != NULL) {
1026             s->rwstate = SSL_WRITING;
1027             /* TODO(size_t): Convert this call */
1028             i = BIO_write(s->wbio, (char *)
1029                           &(SSL3_BUFFER_get_buf(&wb[currbuf])
1030                             [SSL3_BUFFER_get_offset(&wb[currbuf])]),
1031                           (unsigned int)SSL3_BUFFER_get_left(&wb[currbuf]));
1032             if (i >= 0)
1033                 tmpwrit = i;
1034         } else {
1035             SSLerr(SSL_F_SSL3_WRITE_PENDING, SSL_R_BIO_NOT_SET);
1036             i = -1;
1037         }
1038         if (i > 0 && tmpwrit == SSL3_BUFFER_get_left(&wb[currbuf])) {
1039             SSL3_BUFFER_set_left(&wb[currbuf], 0);
1040             SSL3_BUFFER_add_offset(&wb[currbuf], tmpwrit);
1041             if (currbuf + 1 < s->rlayer.numwpipes)
1042                 continue;
1043             s->rwstate = SSL_NOTHING;
1044             *written = s->rlayer.wpend_ret;
1045             return 1;
1046         } else if (i <= 0) {
1047             if (SSL_IS_DTLS(s)) {
1048                 /*
1049                  * For DTLS, just drop it. That's kind of the whole point in
1050                  * using a datagram service
1051                  */
1052                 SSL3_BUFFER_set_left(&wb[currbuf], 0);
1053             }
1054             return (i);
1055         }
1056         SSL3_BUFFER_add_offset(&wb[currbuf], tmpwrit);
1057         SSL3_BUFFER_sub_left(&wb[currbuf], tmpwrit);
1058     }
1059 }
1060
1061 /*-
1062  * Return up to 'len' payload bytes received in 'type' records.
1063  * 'type' is one of the following:
1064  *
1065  *   -  SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
1066  *   -  SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
1067  *   -  0 (during a shutdown, no data has to be returned)
1068  *
1069  * If we don't have stored data to work from, read a SSL/TLS record first
1070  * (possibly multiple records if we still don't have anything to return).
1071  *
1072  * This function must handle any surprises the peer may have for us, such as
1073  * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
1074  * messages are treated as if they were handshake messages *if* the |recd_type|
1075  * argument is non NULL.
1076  * Also if record payloads contain fragments too small to process, we store
1077  * them until there is enough for the respective protocol (the record protocol
1078  * may use arbitrary fragmentation and even interleaving):
1079  *     Change cipher spec protocol
1080  *             just 1 byte needed, no need for keeping anything stored
1081  *     Alert protocol
1082  *             2 bytes needed (AlertLevel, AlertDescription)
1083  *     Handshake protocol
1084  *             4 bytes needed (HandshakeType, uint24 length) -- we just have
1085  *             to detect unexpected Client Hello and Hello Request messages
1086  *             here, anything else is handled by higher layers
1087  *     Application data protocol
1088  *             none of our business
1089  */
1090 int ssl3_read_bytes(SSL *s, int type, int *recvd_type, unsigned char *buf,
1091                     size_t len, int peek, size_t *readbytes)
1092 {
1093     int al, i, j, ret;
1094     size_t n, curr_rec, num_recs, totalbytes;
1095     SSL3_RECORD *rr;
1096     SSL3_BUFFER *rbuf;
1097     void (*cb) (const SSL *ssl, int type2, int val) = NULL;
1098
1099     rbuf = &s->rlayer.rbuf;
1100
1101     if (!SSL3_BUFFER_is_initialised(rbuf)) {
1102         /* Not initialized yet */
1103         if (!ssl3_setup_read_buffer(s))
1104             return -1;
1105     }
1106
1107     if ((type && (type != SSL3_RT_APPLICATION_DATA)
1108          && (type != SSL3_RT_HANDSHAKE)) || (peek
1109                                              && (type !=
1110                                                  SSL3_RT_APPLICATION_DATA))) {
1111         SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1112         return -1;
1113     }
1114
1115     if ((type == SSL3_RT_HANDSHAKE) && (s->rlayer.handshake_fragment_len > 0))
1116         /* (partially) satisfy request from storage */
1117     {
1118         unsigned char *src = s->rlayer.handshake_fragment;
1119         unsigned char *dst = buf;
1120         unsigned int k;
1121
1122         /* peek == 0 */
1123         n = 0;
1124         while ((len > 0) && (s->rlayer.handshake_fragment_len > 0)) {
1125             *dst++ = *src++;
1126             len--;
1127             s->rlayer.handshake_fragment_len--;
1128             n++;
1129         }
1130         /* move any remaining fragment bytes: */
1131         for (k = 0; k < s->rlayer.handshake_fragment_len; k++)
1132             s->rlayer.handshake_fragment[k] = *src++;
1133
1134         if (recvd_type != NULL)
1135             *recvd_type = SSL3_RT_HANDSHAKE;
1136
1137         *readbytes = n;
1138         return 1;
1139     }
1140
1141     /*
1142      * Now s->rlayer.handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
1143      */
1144
1145     if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s)) {
1146         /* type == SSL3_RT_APPLICATION_DATA */
1147         i = s->handshake_func(s);
1148         if (i < 0)
1149             return i;
1150         if (i == 0) {
1151             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1152             return -1;
1153         }
1154     }
1155  start:
1156     s->rwstate = SSL_NOTHING;
1157
1158     /*-
1159      * For each record 'i' up to |num_recs]
1160      * rr[i].type     - is the type of record
1161      * rr[i].data,    - data
1162      * rr[i].off,     - offset into 'data' for next read
1163      * rr[i].length,  - number of bytes.
1164      */
1165     rr = s->rlayer.rrec;
1166     num_recs = RECORD_LAYER_get_numrpipes(&s->rlayer);
1167
1168     do {
1169         /* get new records if necessary */
1170         if (num_recs == 0) {
1171             ret = ssl3_get_record(s);
1172             if (ret <= 0)
1173                 return ret;
1174             num_recs = RECORD_LAYER_get_numrpipes(&s->rlayer);
1175             if (num_recs == 0) {
1176                 /* Shouldn't happen */
1177                 al = SSL_AD_INTERNAL_ERROR;
1178                 SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1179                 goto f_err;
1180             }
1181         }
1182         /* Skip over any records we have already read */
1183         for (curr_rec = 0;
1184              curr_rec < num_recs && SSL3_RECORD_is_read(&rr[curr_rec]);
1185              curr_rec++) ;
1186         if (curr_rec == num_recs) {
1187             RECORD_LAYER_set_numrpipes(&s->rlayer, 0);
1188             num_recs = 0;
1189             curr_rec = 0;
1190         }
1191     } while (num_recs == 0);
1192     rr = &rr[curr_rec];
1193
1194     /*
1195      * Reset the count of consecutive warning alerts if we've got a non-empty
1196      * record that isn't an alert.
1197      */
1198     if (SSL3_RECORD_get_type(rr) != SSL3_RT_ALERT
1199             && SSL3_RECORD_get_length(rr) != 0)
1200         s->rlayer.alert_count = 0;
1201
1202     /* we now have a packet which can be read and processed */
1203
1204     if (s->s3->change_cipher_spec /* set when we receive ChangeCipherSpec,
1205                                    * reset by ssl3_get_finished */
1206         && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
1207         al = SSL_AD_UNEXPECTED_MESSAGE;
1208         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
1209         goto f_err;
1210     }
1211
1212     /*
1213      * If the other end has shut down, throw anything we read away (even in
1214      * 'peek' mode)
1215      */
1216     if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1217         SSL3_RECORD_set_length(rr, 0);
1218         s->rwstate = SSL_NOTHING;
1219         return 0;
1220     }
1221
1222     if (type == SSL3_RECORD_get_type(rr)
1223         || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
1224             && type == SSL3_RT_HANDSHAKE && recvd_type != NULL)) {
1225         /*
1226          * SSL3_RT_APPLICATION_DATA or
1227          * SSL3_RT_HANDSHAKE or
1228          * SSL3_RT_CHANGE_CIPHER_SPEC
1229          */
1230         /*
1231          * make sure that we are not getting application data when we are
1232          * doing a handshake for the first time
1233          */
1234         if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
1235             (s->enc_read_ctx == NULL)) {
1236             al = SSL_AD_UNEXPECTED_MESSAGE;
1237             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_APP_DATA_IN_HANDSHAKE);
1238             goto f_err;
1239         }
1240
1241         if (type == SSL3_RT_HANDSHAKE
1242             && SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
1243             && s->rlayer.handshake_fragment_len > 0) {
1244             al = SSL_AD_UNEXPECTED_MESSAGE;
1245             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1246             goto f_err;
1247         }
1248
1249         if (recvd_type != NULL)
1250             *recvd_type = SSL3_RECORD_get_type(rr);
1251
1252         if (len == 0)
1253             return 0;
1254
1255         totalbytes = 0;
1256         do {
1257             if (len - totalbytes > SSL3_RECORD_get_length(rr))
1258                 n = SSL3_RECORD_get_length(rr);
1259             else
1260                 n = len - totalbytes;
1261
1262             memcpy(buf, &(rr->data[rr->off]), n);
1263             buf += n;
1264             if (peek) {
1265                 /* Mark any zero length record as consumed CVE-2016-6305 */
1266                 if (SSL3_RECORD_get_length(rr) == 0)
1267                     SSL3_RECORD_set_read(rr);
1268             } else {
1269                 SSL3_RECORD_sub_length(rr, n);
1270                 SSL3_RECORD_add_off(rr, n);
1271                 if (SSL3_RECORD_get_length(rr) == 0) {
1272                     s->rlayer.rstate = SSL_ST_READ_HEADER;
1273                     SSL3_RECORD_set_off(rr, 0);
1274                     SSL3_RECORD_set_read(rr);
1275                 }
1276             }
1277             if (SSL3_RECORD_get_length(rr) == 0
1278                 || (peek && n == SSL3_RECORD_get_length(rr))) {
1279                 curr_rec++;
1280                 rr++;
1281             }
1282             totalbytes += n;
1283         } while (type == SSL3_RT_APPLICATION_DATA && curr_rec < num_recs
1284                  && totalbytes < len);
1285         if (totalbytes == 0) {
1286             /* We must have read empty records. Get more data */
1287             goto start;
1288         }
1289         if (!peek && curr_rec == num_recs
1290             && (s->mode & SSL_MODE_RELEASE_BUFFERS)
1291             && SSL3_BUFFER_get_left(rbuf) == 0)
1292             ssl3_release_read_buffer(s);
1293         *readbytes = totalbytes;
1294         return 1;
1295     }
1296
1297     /*
1298      * If we get here, then type != rr->type; if we have a handshake message,
1299      * then it was unexpected (Hello Request or Client Hello) or invalid (we
1300      * were actually expecting a CCS).
1301      */
1302
1303     /*
1304      * Lets just double check that we've not got an SSLv2 record
1305      */
1306     if (rr->rec_version == SSL2_VERSION) {
1307         /*
1308          * Should never happen. ssl3_get_record() should only give us an SSLv2
1309          * record back if this is the first packet and we are looking for an
1310          * initial ClientHello. Therefore |type| should always be equal to
1311          * |rr->type|. If not then something has gone horribly wrong
1312          */
1313         al = SSL_AD_INTERNAL_ERROR;
1314         SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1315         goto f_err;
1316     }
1317
1318     if (s->method->version == TLS_ANY_VERSION
1319         && (s->server || rr->type != SSL3_RT_ALERT)) {
1320         /*
1321          * If we've got this far and still haven't decided on what version
1322          * we're using then this must be a client side alert we're dealing with
1323          * (we don't allow heartbeats yet). We shouldn't be receiving anything
1324          * other than a ClientHello if we are a server.
1325          */
1326         s->version = rr->rec_version;
1327         al = SSL_AD_UNEXPECTED_MESSAGE;
1328         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_MESSAGE);
1329         goto f_err;
1330     }
1331
1332     /*
1333      * In case of record types for which we have 'fragment' storage, fill
1334      * that so that we can process the data at a fixed place.
1335      */
1336     {
1337         size_t dest_maxlen = 0;
1338         unsigned char *dest = NULL;
1339         size_t *dest_len = NULL;
1340
1341         if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
1342             dest_maxlen = sizeof s->rlayer.handshake_fragment;
1343             dest = s->rlayer.handshake_fragment;
1344             dest_len = &s->rlayer.handshake_fragment_len;
1345         } else if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
1346             dest_maxlen = sizeof s->rlayer.alert_fragment;
1347             dest = s->rlayer.alert_fragment;
1348             dest_len = &s->rlayer.alert_fragment_len;
1349         }
1350
1351         if (dest_maxlen > 0) {
1352             n = dest_maxlen - *dest_len; /* available space in 'dest' */
1353             if (SSL3_RECORD_get_length(rr) < n)
1354                 n = SSL3_RECORD_get_length(rr); /* available bytes */
1355
1356             /* now move 'n' bytes: */
1357             while (n-- > 0) {
1358                 dest[(*dest_len)++] =
1359                     SSL3_RECORD_get_data(rr)[SSL3_RECORD_get_off(rr)];
1360                 SSL3_RECORD_add_off(rr, 1);
1361                 SSL3_RECORD_add_length(rr, -1);
1362             }
1363
1364             if (*dest_len < dest_maxlen) {
1365                 SSL3_RECORD_set_read(rr);
1366                 goto start;     /* fragment was too small */
1367             }
1368         }
1369     }
1370
1371     /*-
1372      * s->rlayer.handshake_fragment_len == 4  iff  rr->type == SSL3_RT_HANDSHAKE;
1373      * s->rlayer.alert_fragment_len == 2      iff  rr->type == SSL3_RT_ALERT.
1374      * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1375      */
1376
1377     /* If we are a client, check for an incoming 'Hello Request': */
1378     if ((!s->server) &&
1379         (s->rlayer.handshake_fragment_len >= 4) &&
1380         (s->rlayer.handshake_fragment[0] == SSL3_MT_HELLO_REQUEST) &&
1381         (s->session != NULL) && (s->session->cipher != NULL)) {
1382         s->rlayer.handshake_fragment_len = 0;
1383
1384         if ((s->rlayer.handshake_fragment[1] != 0) ||
1385             (s->rlayer.handshake_fragment[2] != 0) ||
1386             (s->rlayer.handshake_fragment[3] != 0)) {
1387             al = SSL_AD_DECODE_ERROR;
1388             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_BAD_HELLO_REQUEST);
1389             goto f_err;
1390         }
1391
1392         if (s->msg_callback)
1393             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
1394                             s->rlayer.handshake_fragment, 4, s,
1395                             s->msg_callback_arg);
1396
1397         if (SSL_is_init_finished(s) &&
1398             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS) &&
1399             !s->s3->renegotiate) {
1400             ssl3_renegotiate(s);
1401             if (ssl3_renegotiate_check(s)) {
1402                 i = s->handshake_func(s);
1403                 if (i < 0)
1404                     return i;
1405                 if (i == 0) {
1406                     SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1407                     return -1;
1408                 }
1409
1410                 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1411                     if (SSL3_BUFFER_get_left(rbuf) == 0) {
1412                         /* no read-ahead left? */
1413                         BIO *bio;
1414                         /*
1415                          * In the case where we try to read application data,
1416                          * but we trigger an SSL handshake, we return -1 with
1417                          * the retry option set.  Otherwise renegotiation may
1418                          * cause nasty problems in the blocking world
1419                          */
1420                         s->rwstate = SSL_READING;
1421                         bio = SSL_get_rbio(s);
1422                         BIO_clear_retry_flags(bio);
1423                         BIO_set_retry_read(bio);
1424                         return -1;
1425                     }
1426                 }
1427             }
1428         }
1429         /*
1430          * we either finished a handshake or ignored the request, now try
1431          * again to obtain the (application) data we were asked for
1432          */
1433         goto start;
1434     }
1435     /*
1436      * If we are a server and get a client hello when renegotiation isn't
1437      * allowed send back a no renegotiation alert and carry on. WARNING:
1438      * experimental code, needs reviewing (steve)
1439      */
1440     if (s->server &&
1441         SSL_is_init_finished(s) &&
1442         !s->s3->send_connection_binding &&
1443         (s->version > SSL3_VERSION) &&
1444         (s->rlayer.handshake_fragment_len >= 4) &&
1445         (s->rlayer.handshake_fragment[0] == SSL3_MT_CLIENT_HELLO) &&
1446         (s->session != NULL) && (s->session->cipher != NULL) &&
1447         !(s->ctx->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
1448         SSL3_RECORD_set_length(rr, 0);
1449         SSL3_RECORD_set_read(rr);
1450         ssl3_send_alert(s, SSL3_AL_WARNING, SSL_AD_NO_RENEGOTIATION);
1451         goto start;
1452     }
1453     if (s->rlayer.alert_fragment_len >= 2) {
1454         int alert_level = s->rlayer.alert_fragment[0];
1455         int alert_descr = s->rlayer.alert_fragment[1];
1456
1457         s->rlayer.alert_fragment_len = 0;
1458
1459         if (s->msg_callback)
1460             s->msg_callback(0, s->version, SSL3_RT_ALERT,
1461                             s->rlayer.alert_fragment, 2, s,
1462                             s->msg_callback_arg);
1463
1464         if (s->info_callback != NULL)
1465             cb = s->info_callback;
1466         else if (s->ctx->info_callback != NULL)
1467             cb = s->ctx->info_callback;
1468
1469         if (cb != NULL) {
1470             j = (alert_level << 8) | alert_descr;
1471             cb(s, SSL_CB_READ_ALERT, j);
1472         }
1473
1474         if (alert_level == SSL3_AL_WARNING) {
1475             s->s3->warn_alert = alert_descr;
1476             SSL3_RECORD_set_read(rr);
1477
1478             s->rlayer.alert_count++;
1479             if (s->rlayer.alert_count == MAX_WARN_ALERT_COUNT) {
1480                 al = SSL_AD_UNEXPECTED_MESSAGE;
1481                 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_TOO_MANY_WARN_ALERTS);
1482                 goto f_err;
1483             }
1484
1485             if (alert_descr == SSL_AD_CLOSE_NOTIFY) {
1486                 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1487                 return 0;
1488             }
1489             /*
1490              * This is a warning but we receive it if we requested
1491              * renegotiation and the peer denied it. Terminate with a fatal
1492              * alert because if application tried to renegotiate it
1493              * presumably had a good reason and expects it to succeed. In
1494              * future we might have a renegotiation where we don't care if
1495              * the peer refused it where we carry on.
1496              */
1497             else if (alert_descr == SSL_AD_NO_RENEGOTIATION) {
1498                 al = SSL_AD_HANDSHAKE_FAILURE;
1499                 SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_NO_RENEGOTIATION);
1500                 goto f_err;
1501             }
1502 #ifdef SSL_AD_MISSING_SRP_USERNAME
1503             else if (alert_descr == SSL_AD_MISSING_SRP_USERNAME)
1504                 return (0);
1505 #endif
1506         } else if (alert_level == SSL3_AL_FATAL) {
1507             char tmp[16];
1508
1509             s->rwstate = SSL_NOTHING;
1510             s->s3->fatal_alert = alert_descr;
1511             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_AD_REASON_OFFSET + alert_descr);
1512             BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
1513             ERR_add_error_data(2, "SSL alert number ", tmp);
1514             s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1515             SSL3_RECORD_set_read(rr);
1516             SSL_CTX_remove_session(s->session_ctx, s->session);
1517             return 0;
1518         } else {
1519             al = SSL_AD_ILLEGAL_PARAMETER;
1520             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNKNOWN_ALERT_TYPE);
1521             goto f_err;
1522         }
1523
1524         goto start;
1525     }
1526
1527     if (s->shutdown & SSL_SENT_SHUTDOWN) { /* but we have not received a
1528                                             * shutdown */
1529         s->rwstate = SSL_NOTHING;
1530         SSL3_RECORD_set_length(rr, 0);
1531         SSL3_RECORD_set_read(rr);
1532         return 0;
1533     }
1534
1535     if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
1536         al = SSL_AD_UNEXPECTED_MESSAGE;
1537         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_CCS_RECEIVED_EARLY);
1538         goto f_err;
1539     }
1540
1541     /*
1542      * Unexpected handshake message (Client Hello, or protocol violation)
1543      */
1544     if ((s->rlayer.handshake_fragment_len >= 4)
1545         && !ossl_statem_get_in_handshake(s)) {
1546         if (SSL_is_init_finished(s) &&
1547             !(s->s3->flags & SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS)) {
1548             ossl_statem_set_in_init(s, 1);
1549             s->renegotiate = 1;
1550             s->new_session = 1;
1551         }
1552         i = s->handshake_func(s);
1553         if (i < 0)
1554             return i;
1555         if (i == 0) {
1556             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_SSL_HANDSHAKE_FAILURE);
1557             return -1;
1558         }
1559
1560         if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1561             if (SSL3_BUFFER_get_left(rbuf) == 0) {
1562                 /* no read-ahead left? */
1563                 BIO *bio;
1564                 /*
1565                  * In the case where we try to read application data, but we
1566                  * trigger an SSL handshake, we return -1 with the retry
1567                  * option set.  Otherwise renegotiation may cause nasty
1568                  * problems in the blocking world
1569                  */
1570                 s->rwstate = SSL_READING;
1571                 bio = SSL_get_rbio(s);
1572                 BIO_clear_retry_flags(bio);
1573                 BIO_set_retry_read(bio);
1574                 return -1;
1575             }
1576         }
1577         goto start;
1578     }
1579
1580     switch (SSL3_RECORD_get_type(rr)) {
1581     default:
1582         /*
1583          * TLS 1.0 and 1.1 say you SHOULD ignore unrecognised record types, but
1584          * TLS 1.2 says you MUST send an unexpected message alert. We use the
1585          * TLS 1.2 behaviour for all protocol versions to prevent issues where
1586          * no progress is being made and the peer continually sends unrecognised
1587          * record types, using up resources processing them.
1588          */
1589         al = SSL_AD_UNEXPECTED_MESSAGE;
1590         SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1591         goto f_err;
1592     case SSL3_RT_CHANGE_CIPHER_SPEC:
1593     case SSL3_RT_ALERT:
1594     case SSL3_RT_HANDSHAKE:
1595         /*
1596          * we already handled all of these, with the possible exception of
1597          * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
1598          * that should not happen when type != rr->type
1599          */
1600         al = SSL_AD_UNEXPECTED_MESSAGE;
1601         SSLerr(SSL_F_SSL3_READ_BYTES, ERR_R_INTERNAL_ERROR);
1602         goto f_err;
1603     case SSL3_RT_APPLICATION_DATA:
1604         /*
1605          * At this point, we were expecting handshake data, but have
1606          * application data.  If the library was running inside ssl3_read()
1607          * (i.e. in_read_app_data is set) and it makes sense to read
1608          * application data at this point (session renegotiation not yet
1609          * started), we will indulge it.
1610          */
1611         if (ossl_statem_app_data_allowed(s)) {
1612             s->s3->in_read_app_data = 2;
1613             return -1;
1614         } else {
1615             al = SSL_AD_UNEXPECTED_MESSAGE;
1616             SSLerr(SSL_F_SSL3_READ_BYTES, SSL_R_UNEXPECTED_RECORD);
1617             goto f_err;
1618         }
1619     }
1620     /* not reached */
1621
1622  f_err:
1623     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1624     return -1;
1625 }
1626
1627 void ssl3_record_sequence_update(unsigned char *seq)
1628 {
1629     int i;
1630
1631     for (i = 7; i >= 0; i--) {
1632         ++seq[i];
1633         if (seq[i] != 0)
1634             break;
1635     }
1636 }
1637
1638 /*
1639  * Returns true if the current rrec was sent in SSLv2 backwards compatible
1640  * format and false otherwise.
1641  */
1642 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl)
1643 {
1644     return SSL3_RECORD_is_sslv2_record(&rl->rrec[0]);
1645 }
1646
1647 /*
1648  * Returns the length in bytes of the current rrec
1649  */
1650 size_t RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl)
1651 {
1652     return SSL3_RECORD_get_length(&rl->rrec[0]);
1653 }