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