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