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