2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
13 #include "../ssl_locl.h"
14 #include <openssl/evp.h>
15 #include <openssl/buffer.h>
16 #include <openssl/rand.h>
17 #include "record_locl.h"
18 #include "internal/packet.h"
20 #if defined(OPENSSL_SMALL_FOOTPRINT) || \
21 !( defined(AES_ASM) && ( \
22 defined(__x86_64) || defined(__x86_64__) || \
23 defined(_M_AMD64) || defined(_M_X64) ) \
25 # undef EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
26 # define EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK 0
29 void RECORD_LAYER_init(RECORD_LAYER *rl, SSL *s)
32 RECORD_LAYER_set_first_record(&s->rlayer);
33 SSL3_RECORD_clear(rl->rrec, SSL_MAX_PIPELINES);
36 void RECORD_LAYER_clear(RECORD_LAYER *rl)
38 rl->rstate = SSL_ST_READ_HEADER;
41 * Do I need to clear read_ahead? As far as I can tell read_ahead did not
42 * previously get reset by SSL_clear...so I'll keep it that way..but is
47 rl->packet_length = 0;
49 memset(rl->handshake_fragment, 0, sizeof(rl->handshake_fragment));
50 rl->handshake_fragment_len = 0;
56 SSL3_BUFFER_clear(&rl->rbuf);
57 ssl3_release_write_buffer(rl->s);
59 SSL3_RECORD_clear(rl->rrec, SSL_MAX_PIPELINES);
61 RECORD_LAYER_reset_read_sequence(rl);
62 RECORD_LAYER_reset_write_sequence(rl);
65 DTLS_RECORD_LAYER_clear(rl);
68 void RECORD_LAYER_release(RECORD_LAYER *rl)
70 if (SSL3_BUFFER_is_initialised(&rl->rbuf))
71 ssl3_release_read_buffer(rl->s);
72 if (rl->numwpipes > 0)
73 ssl3_release_write_buffer(rl->s);
74 SSL3_RECORD_release(rl->rrec, SSL_MAX_PIPELINES);
77 /* Checks if we have unprocessed read ahead data pending */
78 int RECORD_LAYER_read_pending(const RECORD_LAYER *rl)
80 return SSL3_BUFFER_get_left(&rl->rbuf) != 0;
83 /* Checks if we have decrypted unread record data pending */
84 int RECORD_LAYER_processed_read_pending(const RECORD_LAYER *rl)
86 size_t curr_rec = 0, num_recs = RECORD_LAYER_get_numrpipes(rl);
87 const SSL3_RECORD *rr = rl->rrec;
89 while (curr_rec < num_recs && SSL3_RECORD_is_read(&rr[curr_rec]))
92 return curr_rec < num_recs;
95 int RECORD_LAYER_write_pending(const RECORD_LAYER *rl)
97 return (rl->numwpipes > 0)
98 && SSL3_BUFFER_get_left(&rl->wbuf[rl->numwpipes - 1]) != 0;
101 void RECORD_LAYER_reset_read_sequence(RECORD_LAYER *rl)
103 memset(rl->read_sequence, 0, sizeof(rl->read_sequence));
106 void RECORD_LAYER_reset_write_sequence(RECORD_LAYER *rl)
108 memset(rl->write_sequence, 0, sizeof(rl->write_sequence));
111 size_t ssl3_pending(const SSL *s)
115 if (s->rlayer.rstate == SSL_ST_READ_BODY)
118 for (i = 0; i < RECORD_LAYER_get_numrpipes(&s->rlayer); i++) {
119 if (SSL3_RECORD_get_type(&s->rlayer.rrec[i])
120 != SSL3_RT_APPLICATION_DATA)
122 num += SSL3_RECORD_get_length(&s->rlayer.rrec[i]);
128 void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len)
130 ctx->default_read_buf_len = len;
133 void SSL_set_default_read_buffer_len(SSL *s, size_t len)
135 SSL3_BUFFER_set_default_len(RECORD_LAYER_get_rbuf(&s->rlayer), len);
138 const char *SSL_rstate_string_long(const SSL *s)
140 switch (s->rlayer.rstate) {
141 case SSL_ST_READ_HEADER:
142 return "read header";
143 case SSL_ST_READ_BODY:
145 case SSL_ST_READ_DONE:
152 const char *SSL_rstate_string(const SSL *s)
154 switch (s->rlayer.rstate) {
155 case SSL_ST_READ_HEADER:
157 case SSL_ST_READ_BODY:
159 case SSL_ST_READ_DONE:
167 * Return values are as per SSL_read()
169 int ssl3_read_n(SSL *s, size_t n, size_t max, int extend, int clearold,
173 * If extend == 0, obtain new n-byte packet; if extend == 1, increase
174 * packet by another n bytes. The packet will be in the sub-array of
175 * s->s3.rbuf.buf specified by s->packet and s->packet_length. (If
176 * s->rlayer.read_ahead is set, 'max' bytes may be stored in rbuf [plus
177 * s->packet_length bytes if extend == 1].)
178 * if clearold == 1, move the packet to the start of the buffer; if
179 * clearold == 0 then leave any old packets where they were
181 size_t len, left, align = 0;
188 rb = &s->rlayer.rbuf;
190 if (!ssl3_setup_read_buffer(s)) {
191 /* SSLfatal() already called */
196 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
197 align = (size_t)rb->buf + SSL3_RT_HEADER_LENGTH;
198 align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
202 /* start with empty packet ... */
205 else if (align != 0 && left >= SSL3_RT_HEADER_LENGTH) {
207 * check if next packet length is large enough to justify payload
210 pkt = rb->buf + rb->offset;
211 if (pkt[0] == SSL3_RT_APPLICATION_DATA
212 && (pkt[3] << 8 | pkt[4]) >= 128) {
214 * Note that even if packet is corrupted and its length field
215 * is insane, we can only be led to wrong decision about
216 * whether memmove will occur or not. Header values has no
217 * effect on memmove arguments and therefore no buffer
218 * overrun can be triggered.
220 memmove(rb->buf + align, pkt, left);
224 s->rlayer.packet = rb->buf + rb->offset;
225 s->rlayer.packet_length = 0;
226 /* ... now we can act as if 'extend' was set */
229 len = s->rlayer.packet_length;
230 pkt = rb->buf + align;
232 * Move any available bytes to front of buffer: 'len' bytes already
233 * pointed to by 'packet', 'left' extra ones at the end
235 if (s->rlayer.packet != pkt && clearold == 1) {
236 memmove(pkt, s->rlayer.packet, len + left);
237 s->rlayer.packet = pkt;
238 rb->offset = len + align;
242 * For DTLS/UDP reads should not span multiple packets because the read
243 * operation returns the whole packet at once (as long as it fits into
246 if (SSL_IS_DTLS(s)) {
247 if (left == 0 && extend)
249 if (left > 0 && n > left)
253 /* if there is enough in the buffer from a previous read, take some */
255 s->rlayer.packet_length += n;
262 /* else we need to read more data */
264 if (n > rb->len - rb->offset) {
265 /* does not happen */
266 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_READ_N,
267 ERR_R_INTERNAL_ERROR);
272 * Ktls always reads full records.
273 * Also, we always act like read_ahead is set for DTLS.
275 if (!BIO_get_ktls_recv(s->rbio) && !s->rlayer.read_ahead
276 && !SSL_IS_DTLS(s)) {
277 /* ignore max parameter */
282 if (max > rb->len - rb->offset)
283 max = rb->len - rb->offset;
291 * Now we have len+left bytes at the front of s->s3.rbuf.buf and
292 * need to read in more until we have len+n (up to len+max if
297 if (s->rbio != NULL) {
298 s->rwstate = SSL_READING;
299 /* TODO(size_t): Convert this function */
300 ret = BIO_read(s->rbio, pkt + len + left, max - left);
304 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_READ_N,
305 SSL_R_READ_BIO_NOT_SET);
311 if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
313 ssl3_release_read_buffer(s);
318 * reads should *never* span multiple packets for DTLS because the
319 * underlying transport protocol is message oriented as opposed to
320 * byte oriented as in the TLS case.
322 if (SSL_IS_DTLS(s)) {
324 n = left; /* makes the while condition false */
328 /* done reading, now the book-keeping */
331 s->rlayer.packet_length += n;
332 s->rwstate = SSL_NOTHING;
338 * Call this to write data in records of type 'type' It will return <= 0 if
339 * not all data has been sent or non-blocking IO.
341 int ssl3_write_bytes(SSL *s, int type, const void *buf_, size_t len,
344 const unsigned char *buf = buf_;
346 size_t n, max_send_fragment, split_send_fragment, maxpipes;
347 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
350 SSL3_BUFFER *wb = &s->rlayer.wbuf[0];
354 s->rwstate = SSL_NOTHING;
355 tot = s->rlayer.wnum;
357 * ensure that if we end up with a smaller value of data to write out
358 * than the original len from a write which didn't complete for
359 * non-blocking I/O and also somehow ended up avoiding the check for
360 * this in ssl3_write_pending/SSL_R_BAD_WRITE_RETRY as it must never be
361 * possible to end up with (len-tot) as a large number that will then
362 * promptly send beyond the end of the users buffer ... so we trap and
363 * report the error in a way the user will notice
365 if ((len < s->rlayer.wnum)
366 || ((wb->left != 0) && (len < (s->rlayer.wnum + s->rlayer.wpend_tot)))) {
367 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_WRITE_BYTES,
372 if (s->early_data_state == SSL_EARLY_DATA_WRITING
373 && !early_data_count_ok(s, len, 0, 1)) {
374 /* SSLfatal() already called */
381 * If we are supposed to be sending a KeyUpdate then go into init unless we
382 * have writes pending - in which case we should finish doing that first.
384 if (wb->left == 0 && s->key_update != SSL_KEY_UPDATE_NONE)
385 ossl_statem_set_in_init(s, 1);
388 * When writing early data on the server side we could be "in_init" in
389 * between receiving the EoED and the CF - but we don't want to handle those
392 if (SSL_in_init(s) && !ossl_statem_get_in_handshake(s)
393 && s->early_data_state != SSL_EARLY_DATA_UNAUTH_WRITING) {
394 i = s->handshake_func(s);
395 /* SSLfatal() already called */
404 * first check if there is a SSL3_BUFFER still being written out. This
405 * will happen with non blocking IO
408 /* SSLfatal() already called if appropriate */
409 i = ssl3_write_pending(s, type, &buf[tot], s->rlayer.wpend_tot,
412 /* XXX should we ssl3_release_write_buffer if i<0? */
413 s->rlayer.wnum = tot;
416 tot += tmpwrit; /* this might be last fragment */
418 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
420 * Depending on platform multi-block can deliver several *times*
421 * better performance. Downside is that it has to allocate
422 * jumbo buffer to accommodate up to 8 records, but the
423 * compromise is considered worthy.
425 if (type == SSL3_RT_APPLICATION_DATA &&
426 len >= 4 * (max_send_fragment = ssl_get_max_send_fragment(s)) &&
427 s->compress == NULL && s->msg_callback == NULL &&
428 !SSL_WRITE_ETM(s) && SSL_USE_EXPLICIT_IV(s) &&
429 EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx)) &
430 EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK) {
431 unsigned char aad[13];
432 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM mb_param;
436 /* minimize address aliasing conflicts */
437 if ((max_send_fragment & 0xfff) == 0)
438 max_send_fragment -= 512;
440 if (tot == 0 || wb->buf == NULL) { /* allocate jumbo buffer */
441 ssl3_release_write_buffer(s);
443 packlen = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
444 EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE,
445 (int)max_send_fragment, NULL);
447 if (len >= 8 * max_send_fragment)
452 if (!ssl3_setup_write_buffer(s, 1, packlen)) {
453 /* SSLfatal() already called */
456 } else if (tot == len) { /* done? */
457 /* free jumbo buffer */
458 ssl3_release_write_buffer(s);
465 if (n < 4 * max_send_fragment) {
466 /* free jumbo buffer */
467 ssl3_release_write_buffer(s);
471 if (s->s3.alert_dispatch) {
472 i = s->method->ssl_dispatch_alert(s);
474 /* SSLfatal() already called if appropriate */
475 s->rlayer.wnum = tot;
480 if (n >= 8 * max_send_fragment)
481 nw = max_send_fragment * (mb_param.interleave = 8);
483 nw = max_send_fragment * (mb_param.interleave = 4);
485 memcpy(aad, s->rlayer.write_sequence, 8);
487 aad[9] = (unsigned char)(s->version >> 8);
488 aad[10] = (unsigned char)(s->version);
495 packleni = EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
496 EVP_CTRL_TLS1_1_MULTIBLOCK_AAD,
497 sizeof(mb_param), &mb_param);
498 packlen = (size_t)packleni;
499 if (packleni <= 0 || packlen > wb->len) { /* never happens */
500 /* free jumbo buffer */
501 ssl3_release_write_buffer(s);
505 mb_param.out = wb->buf;
506 mb_param.inp = &buf[tot];
509 if (EVP_CIPHER_CTX_ctrl(s->enc_write_ctx,
510 EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT,
511 sizeof(mb_param), &mb_param) <= 0)
514 s->rlayer.write_sequence[7] += mb_param.interleave;
515 if (s->rlayer.write_sequence[7] < mb_param.interleave) {
517 while (j >= 0 && (++s->rlayer.write_sequence[j--]) == 0) ;
523 s->rlayer.wpend_tot = nw;
524 s->rlayer.wpend_buf = &buf[tot];
525 s->rlayer.wpend_type = type;
526 s->rlayer.wpend_ret = nw;
528 i = ssl3_write_pending(s, type, &buf[tot], nw, &tmpwrit);
530 /* SSLfatal() already called if appropriate */
531 if (i < 0 && (!s->wbio || !BIO_should_retry(s->wbio))) {
532 /* free jumbo buffer */
533 ssl3_release_write_buffer(s);
535 s->rlayer.wnum = tot;
539 /* free jumbo buffer */
540 ssl3_release_write_buffer(s);
541 *written = tot + tmpwrit;
548 #endif /* !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK */
549 if (tot == len) { /* done? */
550 if (s->mode & SSL_MODE_RELEASE_BUFFERS && !SSL_IS_DTLS(s))
551 ssl3_release_write_buffer(s);
559 max_send_fragment = ssl_get_max_send_fragment(s);
560 split_send_fragment = ssl_get_split_send_fragment(s);
562 * If max_pipelines is 0 then this means "undefined" and we default to
563 * 1 pipeline. Similarly if the cipher does not support pipelined
564 * processing then we also only use 1 pipeline, or if we're not using
567 maxpipes = s->max_pipelines;
568 if (maxpipes > SSL_MAX_PIPELINES) {
570 * We should have prevented this when we set max_pipelines so we
573 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_WRITE_BYTES,
574 ERR_R_INTERNAL_ERROR);
578 || s->enc_write_ctx == NULL
579 || !(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s->enc_write_ctx))
580 & EVP_CIPH_FLAG_PIPELINE)
581 || !SSL_USE_EXPLICIT_IV(s))
583 if (max_send_fragment == 0 || split_send_fragment == 0
584 || split_send_fragment > max_send_fragment) {
586 * We should have prevented this when we set/get the split and max send
587 * fragments so we shouldn't get here
589 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_WRITE_BYTES,
590 ERR_R_INTERNAL_ERROR);
595 size_t pipelens[SSL_MAX_PIPELINES], tmppipelen, remain;
601 numpipes = ((n - 1) / split_send_fragment) + 1;
602 if (numpipes > maxpipes)
605 if (n / numpipes >= max_send_fragment) {
607 * We have enough data to completely fill all available
610 for (j = 0; j < numpipes; j++) {
611 pipelens[j] = max_send_fragment;
614 /* We can partially fill all available pipelines */
615 tmppipelen = n / numpipes;
616 remain = n % numpipes;
617 for (j = 0; j < numpipes; j++) {
618 pipelens[j] = tmppipelen;
624 i = do_ssl3_write(s, type, &(buf[tot]), pipelens, numpipes, 0,
627 /* SSLfatal() already called if appropriate */
628 /* XXX should we ssl3_release_write_buffer if i<0? */
629 s->rlayer.wnum = tot;
634 (type == SSL3_RT_APPLICATION_DATA &&
635 (s->mode & SSL_MODE_ENABLE_PARTIAL_WRITE))) {
637 * next chunk of data should get another prepended empty fragment
638 * in ciphersuites with known-IV weakness:
640 s->s3.empty_fragment_done = 0;
642 if ((i == (int)n) && s->mode & SSL_MODE_RELEASE_BUFFERS &&
644 ssl3_release_write_buffer(s);
646 *written = tot + tmpwrit;
655 int do_ssl3_write(SSL *s, int type, const unsigned char *buf,
656 size_t *pipelens, size_t numpipes,
657 int create_empty_fragment, size_t *written)
659 WPACKET pkt[SSL_MAX_PIPELINES];
660 SSL3_RECORD wr[SSL_MAX_PIPELINES];
663 unsigned char *recordstart;
664 int i, mac_size, clear = 0;
665 size_t prefix_len = 0;
670 size_t totlen = 0, len, wpinited = 0;
673 for (j = 0; j < numpipes; j++)
674 totlen += pipelens[j];
676 * first check if there is a SSL3_BUFFER still being written out. This
677 * will happen with non blocking IO
679 if (RECORD_LAYER_write_pending(&s->rlayer)) {
680 /* Calls SSLfatal() as required */
681 return ssl3_write_pending(s, type, buf, totlen, written);
684 /* If we have an alert to send, lets send it */
685 if (s->s3.alert_dispatch) {
686 i = s->method->ssl_dispatch_alert(s);
688 /* SSLfatal() already called if appropriate */
691 /* if it went, fall through and send more stuff */
694 if (s->rlayer.numwpipes < numpipes) {
695 if (!ssl3_setup_write_buffer(s, numpipes, 0)) {
696 /* SSLfatal() already called */
701 if (totlen == 0 && !create_empty_fragment)
706 if ((sess == NULL) ||
707 (s->enc_write_ctx == NULL) || (EVP_MD_CTX_md(s->write_hash) == NULL)) {
708 clear = s->enc_write_ctx ? 0 : 1; /* must be AEAD cipher */
711 /* TODO(siz_t): Convert me */
712 mac_size = EVP_MD_CTX_size(s->write_hash);
714 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
715 ERR_R_INTERNAL_ERROR);
721 * 'create_empty_fragment' is true only when this function calls itself
723 if (!clear && !create_empty_fragment && !s->s3.empty_fragment_done) {
725 * countermeasure against known-IV weakness in CBC ciphersuites (see
726 * http://www.openssl.org/~bodo/tls-cbc.txt)
729 if (s->s3.need_empty_fragments && type == SSL3_RT_APPLICATION_DATA) {
731 * recursive function call with 'create_empty_fragment' set; this
732 * prepares and buffers the data for an empty fragment (these
733 * 'prefix_len' bytes are sent out later together with the actual
736 size_t tmppipelen = 0;
739 ret = do_ssl3_write(s, type, buf, &tmppipelen, 1, 1, &prefix_len);
741 /* SSLfatal() already called if appropriate */
746 (SSL3_RT_HEADER_LENGTH + SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD)) {
747 /* insufficient space */
748 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
749 ERR_R_INTERNAL_ERROR);
754 s->s3.empty_fragment_done = 1;
757 if (BIO_get_ktls_send(s->wbio)) {
759 * ktls doesn't modify the buffer, but to avoid a warning we need to
760 * discard the const qualifier.
761 * This doesn't leak memory because the buffers have been released when
764 SSL3_BUFFER_set_buf(&s->rlayer.wbuf[0], (unsigned char *)buf);
765 SSL3_BUFFER_set_offset(&s->rlayer.wbuf[0], 0);
766 goto wpacket_init_complete;
769 if (create_empty_fragment) {
770 wb = &s->rlayer.wbuf[0];
771 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
773 * extra fragment would be couple of cipher blocks, which would be
774 * multiple of SSL3_ALIGN_PAYLOAD, so if we want to align the real
775 * payload, then we can just pretend we simply have two headers.
777 align = (size_t)SSL3_BUFFER_get_buf(wb) + 2 * SSL3_RT_HEADER_LENGTH;
778 align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
780 SSL3_BUFFER_set_offset(wb, align);
781 if (!WPACKET_init_static_len(&pkt[0], SSL3_BUFFER_get_buf(wb),
782 SSL3_BUFFER_get_len(wb), 0)
783 || !WPACKET_allocate_bytes(&pkt[0], align, NULL)) {
784 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
785 ERR_R_INTERNAL_ERROR);
789 } else if (prefix_len) {
790 wb = &s->rlayer.wbuf[0];
791 if (!WPACKET_init_static_len(&pkt[0],
792 SSL3_BUFFER_get_buf(wb),
793 SSL3_BUFFER_get_len(wb), 0)
794 || !WPACKET_allocate_bytes(&pkt[0], SSL3_BUFFER_get_offset(wb)
795 + prefix_len, NULL)) {
796 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
797 ERR_R_INTERNAL_ERROR);
802 for (j = 0; j < numpipes; j++) {
805 wb = &s->rlayer.wbuf[j];
806 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD != 0
807 align = (size_t)SSL3_BUFFER_get_buf(wb) + SSL3_RT_HEADER_LENGTH;
808 align = SSL3_ALIGN_PAYLOAD - 1 - ((align - 1) % SSL3_ALIGN_PAYLOAD);
810 SSL3_BUFFER_set_offset(wb, align);
811 if (!WPACKET_init_static_len(thispkt, SSL3_BUFFER_get_buf(wb),
812 SSL3_BUFFER_get_len(wb), 0)
813 || !WPACKET_allocate_bytes(thispkt, align, NULL)) {
814 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
815 ERR_R_INTERNAL_ERROR);
822 /* Explicit IV length, block ciphers appropriate version flag */
823 if (s->enc_write_ctx && SSL_USE_EXPLICIT_IV(s) && !SSL_TREAT_AS_TLS13(s)) {
824 int mode = EVP_CIPHER_CTX_mode(s->enc_write_ctx);
825 if (mode == EVP_CIPH_CBC_MODE) {
826 /* TODO(size_t): Convert me */
827 eivlen = EVP_CIPHER_CTX_iv_length(s->enc_write_ctx);
830 } else if (mode == EVP_CIPH_GCM_MODE) {
831 /* Need explicit part of IV for GCM mode */
832 eivlen = EVP_GCM_TLS_EXPLICIT_IV_LEN;
833 } else if (mode == EVP_CIPH_CCM_MODE) {
834 eivlen = EVP_CCM_TLS_EXPLICIT_IV_LEN;
838 wpacket_init_complete:
841 /* Clear our SSL3_RECORD structures */
842 memset(wr, 0, sizeof(wr));
843 for (j = 0; j < numpipes; j++) {
844 unsigned int version = (s->version == TLS1_3_VERSION) ? TLS1_2_VERSION
846 unsigned char *compressdata = NULL;
848 unsigned int rectype;
854 * In TLSv1.3, once encrypting, we always use application data for the
857 if (SSL_TREAT_AS_TLS13(s)
858 && s->enc_write_ctx != NULL
859 && (s->statem.enc_write_state != ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
860 || type != SSL3_RT_ALERT))
861 rectype = SSL3_RT_APPLICATION_DATA;
864 SSL3_RECORD_set_type(thiswr, rectype);
867 * Some servers hang if initial client hello is larger than 256 bytes
868 * and record version number > TLS 1.0
870 if (SSL_get_state(s) == TLS_ST_CW_CLNT_HELLO
872 && TLS1_get_version(s) > TLS1_VERSION
873 && s->hello_retry_request == SSL_HRR_NONE)
874 version = TLS1_VERSION;
875 SSL3_RECORD_set_rec_version(thiswr, version);
877 maxcomplen = pipelens[j];
878 if (s->compress != NULL)
879 maxcomplen += SSL3_RT_MAX_COMPRESSED_OVERHEAD;
882 * When using offload kernel will write the header.
883 * Otherwise write the header now
885 if (!BIO_get_ktls_send(s->wbio)
886 && (!WPACKET_put_bytes_u8(thispkt, rectype)
887 || !WPACKET_put_bytes_u16(thispkt, version)
888 || !WPACKET_start_sub_packet_u16(thispkt)
890 && !WPACKET_allocate_bytes(thispkt, eivlen, NULL))
892 && !WPACKET_reserve_bytes(thispkt, maxcomplen,
894 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
895 ERR_R_INTERNAL_ERROR);
899 /* lets setup the record stuff. */
900 SSL3_RECORD_set_data(thiswr, compressdata);
901 SSL3_RECORD_set_length(thiswr, pipelens[j]);
902 SSL3_RECORD_set_input(thiswr, (unsigned char *)&buf[totlen]);
903 totlen += pipelens[j];
906 * we now 'read' from thiswr->input, thiswr->length bytes into
910 /* first we compress */
911 if (s->compress != NULL) {
912 if (!ssl3_do_compress(s, thiswr)
913 || !WPACKET_allocate_bytes(thispkt, thiswr->length, NULL)) {
914 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
915 SSL_R_COMPRESSION_FAILURE);
919 if (BIO_get_ktls_send(s->wbio)) {
920 SSL3_RECORD_reset_data(&wr[j]);
922 if (!WPACKET_memcpy(thispkt, thiswr->input, thiswr->length)) {
923 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
924 ERR_R_INTERNAL_ERROR);
927 SSL3_RECORD_reset_input(&wr[j]);
931 if (SSL_TREAT_AS_TLS13(s)
932 && s->enc_write_ctx != NULL
933 && (s->statem.enc_write_state != ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
934 || type != SSL3_RT_ALERT)) {
935 size_t rlen, max_send_fragment;
937 if (!WPACKET_put_bytes_u8(thispkt, type)) {
938 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
939 ERR_R_INTERNAL_ERROR);
942 SSL3_RECORD_add_length(thiswr, 1);
944 /* Add TLS1.3 padding */
945 max_send_fragment = ssl_get_max_send_fragment(s);
946 rlen = SSL3_RECORD_get_length(thiswr);
947 if (rlen < max_send_fragment) {
949 size_t max_padding = max_send_fragment - rlen;
950 if (s->record_padding_cb != NULL) {
951 padding = s->record_padding_cb(s, type, rlen, s->record_padding_arg);
952 } else if (s->block_padding > 0) {
953 size_t mask = s->block_padding - 1;
956 /* optimize for power of 2 */
957 if ((s->block_padding & mask) == 0)
958 remainder = rlen & mask;
960 remainder = rlen % s->block_padding;
961 /* don't want to add a block of padding if we don't have to */
965 padding = s->block_padding - remainder;
968 /* do not allow the record to exceed max plaintext length */
969 if (padding > max_padding)
970 padding = max_padding;
971 if (!WPACKET_memset(thispkt, 0, padding)) {
972 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
973 ERR_R_INTERNAL_ERROR);
976 SSL3_RECORD_add_length(thiswr, padding);
982 * we should still have the output to thiswr->data and the input from
983 * wr->input. Length should be thiswr->length. thiswr->data still points
987 if (!SSL_WRITE_ETM(s) && mac_size != 0) {
990 if (!WPACKET_allocate_bytes(thispkt, mac_size, &mac)
991 || !s->method->ssl3_enc->mac(s, thiswr, mac, 1)) {
992 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
993 ERR_R_INTERNAL_ERROR);
999 * Reserve some bytes for any growth that may occur during encryption.
1000 * This will be at most one cipher block or the tag length if using
1001 * AEAD. SSL_RT_MAX_CIPHER_BLOCK_SIZE covers either case.
1003 if (!BIO_get_ktls_send(s->wbio)) {
1004 if (!WPACKET_reserve_bytes(thispkt,
1005 SSL_RT_MAX_CIPHER_BLOCK_SIZE,
1008 * We also need next the amount of bytes written to this
1011 || !WPACKET_get_length(thispkt, &len)) {
1012 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1013 ERR_R_INTERNAL_ERROR);
1017 /* Get a pointer to the start of this record excluding header */
1018 recordstart = WPACKET_get_curr(thispkt) - len;
1019 SSL3_RECORD_set_data(thiswr, recordstart);
1020 SSL3_RECORD_reset_input(thiswr);
1021 SSL3_RECORD_set_length(thiswr, len);
1025 if (s->statem.enc_write_state == ENC_WRITE_STATE_WRITE_PLAIN_ALERTS) {
1027 * We haven't actually negotiated the version yet, but we're trying to
1028 * send early data - so we need to use the tls13enc function.
1030 if (tls13_enc(s, wr, numpipes, 1) < 1) {
1031 if (!ossl_statem_in_error(s)) {
1032 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1033 ERR_R_INTERNAL_ERROR);
1038 if (!BIO_get_ktls_send(s->wbio)) {
1039 if (s->method->ssl3_enc->enc(s, wr, numpipes, 1) < 1) {
1040 if (!ossl_statem_in_error(s)) {
1041 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1042 ERR_R_INTERNAL_ERROR);
1049 for (j = 0; j < numpipes; j++) {
1055 if (BIO_get_ktls_send(s->wbio))
1058 /* Allocate bytes for the encryption overhead */
1059 if (!WPACKET_get_length(thispkt, &origlen)
1060 /* Encryption should never shrink the data! */
1061 || origlen > thiswr->length
1062 || (thiswr->length > origlen
1063 && !WPACKET_allocate_bytes(thispkt,
1064 thiswr->length - origlen,
1066 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1067 ERR_R_INTERNAL_ERROR);
1070 if (SSL_WRITE_ETM(s) && mac_size != 0) {
1073 if (!WPACKET_allocate_bytes(thispkt, mac_size, &mac)
1074 || !s->method->ssl3_enc->mac(s, thiswr, mac, 1)) {
1075 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1076 ERR_R_INTERNAL_ERROR);
1079 SSL3_RECORD_add_length(thiswr, mac_size);
1082 if (!WPACKET_get_length(thispkt, &len)
1083 || !WPACKET_close(thispkt)) {
1084 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1085 ERR_R_INTERNAL_ERROR);
1089 if (s->msg_callback) {
1090 recordstart = WPACKET_get_curr(thispkt) - len
1091 - SSL3_RT_HEADER_LENGTH;
1092 s->msg_callback(1, 0, SSL3_RT_HEADER, recordstart,
1093 SSL3_RT_HEADER_LENGTH, s,
1094 s->msg_callback_arg);
1096 if (SSL_TREAT_AS_TLS13(s) && s->enc_write_ctx != NULL) {
1097 unsigned char ctype = type;
1099 s->msg_callback(1, s->version, SSL3_RT_INNER_CONTENT_TYPE,
1100 &ctype, 1, s, s->msg_callback_arg);
1104 if (!WPACKET_finish(thispkt)) {
1105 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1106 ERR_R_INTERNAL_ERROR);
1110 /* header is added by the kernel when using offload */
1111 SSL3_RECORD_add_length(&wr[j], SSL3_RT_HEADER_LENGTH);
1113 if (create_empty_fragment) {
1115 * we are in a recursive call; just return the length, don't write
1119 /* We should never be pipelining an empty fragment!! */
1120 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_DO_SSL3_WRITE,
1121 ERR_R_INTERNAL_ERROR);
1124 *written = SSL3_RECORD_get_length(thiswr);
1130 * we should now have thiswr->data pointing to the encrypted data, which
1131 * is thiswr->length long
1133 SSL3_RECORD_set_type(thiswr, type); /* not needed but helps for
1136 /* now let's set up wb */
1137 SSL3_BUFFER_set_left(&s->rlayer.wbuf[j],
1138 prefix_len + SSL3_RECORD_get_length(thiswr));
1142 * memorize arguments so that ssl3_write_pending can detect bad write
1145 s->rlayer.wpend_tot = totlen;
1146 s->rlayer.wpend_buf = buf;
1147 s->rlayer.wpend_type = type;
1148 s->rlayer.wpend_ret = totlen;
1150 /* we now just need to write the buffer */
1151 return ssl3_write_pending(s, type, buf, totlen, written);
1153 for (j = 0; j < wpinited; j++)
1154 WPACKET_cleanup(&pkt[j]);
1158 /* if s->s3.wbuf.left != 0, we need to call this
1160 * Return values are as per SSL_write()
1162 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf, size_t len,
1166 SSL3_BUFFER *wb = s->rlayer.wbuf;
1170 if ((s->rlayer.wpend_tot > len)
1171 || (!(s->mode & SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER)
1172 && (s->rlayer.wpend_buf != buf))
1173 || (s->rlayer.wpend_type != type)) {
1174 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_WRITE_PENDING,
1175 SSL_R_BAD_WRITE_RETRY);
1180 /* Loop until we find a buffer we haven't written out yet */
1181 if (SSL3_BUFFER_get_left(&wb[currbuf]) == 0
1182 && currbuf < s->rlayer.numwpipes - 1) {
1187 if (s->wbio != NULL) {
1188 s->rwstate = SSL_WRITING;
1191 * To prevent coalescing of control and data messages,
1192 * such as in buffer_write, we flush the BIO
1194 if (BIO_get_ktls_send(s->wbio) && type != SSL3_RT_APPLICATION_DATA) {
1195 i = BIO_flush(s->wbio);
1200 if (BIO_get_ktls_send(s->wbio)
1201 && type != SSL3_RT_APPLICATION_DATA) {
1202 BIO_set_ktls_ctrl_msg(s->wbio, type);
1204 /* TODO(size_t): Convert this call */
1205 i = BIO_write(s->wbio, (char *)
1206 &(SSL3_BUFFER_get_buf(&wb[currbuf])
1207 [SSL3_BUFFER_get_offset(&wb[currbuf])]),
1208 (unsigned int)SSL3_BUFFER_get_left(&wb[currbuf]));
1212 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_WRITE_PENDING,
1216 if (i > 0 && tmpwrit == SSL3_BUFFER_get_left(&wb[currbuf])) {
1217 SSL3_BUFFER_set_left(&wb[currbuf], 0);
1218 SSL3_BUFFER_add_offset(&wb[currbuf], tmpwrit);
1219 if (currbuf + 1 < s->rlayer.numwpipes)
1221 s->rwstate = SSL_NOTHING;
1222 *written = s->rlayer.wpend_ret;
1224 } else if (i <= 0) {
1225 if (SSL_IS_DTLS(s)) {
1227 * For DTLS, just drop it. That's kind of the whole point in
1228 * using a datagram service
1230 SSL3_BUFFER_set_left(&wb[currbuf], 0);
1234 SSL3_BUFFER_add_offset(&wb[currbuf], tmpwrit);
1235 SSL3_BUFFER_sub_left(&wb[currbuf], tmpwrit);
1240 * Return up to 'len' payload bytes received in 'type' records.
1241 * 'type' is one of the following:
1243 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
1244 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
1245 * - 0 (during a shutdown, no data has to be returned)
1247 * If we don't have stored data to work from, read a SSL/TLS record first
1248 * (possibly multiple records if we still don't have anything to return).
1250 * This function must handle any surprises the peer may have for us, such as
1251 * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
1252 * messages are treated as if they were handshake messages *if* the |recd_type|
1253 * argument is non NULL.
1254 * Also if record payloads contain fragments too small to process, we store
1255 * them until there is enough for the respective protocol (the record protocol
1256 * may use arbitrary fragmentation and even interleaving):
1257 * Change cipher spec protocol
1258 * just 1 byte needed, no need for keeping anything stored
1260 * 2 bytes needed (AlertLevel, AlertDescription)
1261 * Handshake protocol
1262 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
1263 * to detect unexpected Client Hello and Hello Request messages
1264 * here, anything else is handled by higher layers
1265 * Application data protocol
1266 * none of our business
1268 int ssl3_read_bytes(SSL *s, int type, int *recvd_type, unsigned char *buf,
1269 size_t len, int peek, size_t *readbytes)
1272 size_t n, curr_rec, num_recs, totalbytes;
1275 void (*cb) (const SSL *ssl, int type2, int val) = NULL;
1276 int is_tls13 = SSL_IS_TLS13(s);
1278 rbuf = &s->rlayer.rbuf;
1280 if (!SSL3_BUFFER_is_initialised(rbuf)) {
1281 /* Not initialized yet */
1282 if (!ssl3_setup_read_buffer(s)) {
1283 /* SSLfatal() already called */
1288 if ((type && (type != SSL3_RT_APPLICATION_DATA)
1289 && (type != SSL3_RT_HANDSHAKE)) || (peek
1291 SSL3_RT_APPLICATION_DATA))) {
1292 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_READ_BYTES,
1293 ERR_R_INTERNAL_ERROR);
1297 if ((type == SSL3_RT_HANDSHAKE) && (s->rlayer.handshake_fragment_len > 0))
1298 /* (partially) satisfy request from storage */
1300 unsigned char *src = s->rlayer.handshake_fragment;
1301 unsigned char *dst = buf;
1306 while ((len > 0) && (s->rlayer.handshake_fragment_len > 0)) {
1309 s->rlayer.handshake_fragment_len--;
1312 /* move any remaining fragment bytes: */
1313 for (k = 0; k < s->rlayer.handshake_fragment_len; k++)
1314 s->rlayer.handshake_fragment[k] = *src++;
1316 if (recvd_type != NULL)
1317 *recvd_type = SSL3_RT_HANDSHAKE;
1324 * Now s->rlayer.handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
1327 if (!ossl_statem_get_in_handshake(s) && SSL_in_init(s)) {
1328 /* type == SSL3_RT_APPLICATION_DATA */
1329 i = s->handshake_func(s);
1330 /* SSLfatal() already called */
1337 s->rwstate = SSL_NOTHING;
1340 * For each record 'i' up to |num_recs]
1341 * rr[i].type - is the type of record
1342 * rr[i].data, - data
1343 * rr[i].off, - offset into 'data' for next read
1344 * rr[i].length, - number of bytes.
1346 rr = s->rlayer.rrec;
1347 num_recs = RECORD_LAYER_get_numrpipes(&s->rlayer);
1350 /* get new records if necessary */
1351 if (num_recs == 0) {
1352 ret = ssl3_get_record(s);
1354 /* SSLfatal() already called if appropriate */
1357 num_recs = RECORD_LAYER_get_numrpipes(&s->rlayer);
1358 if (num_recs == 0) {
1359 /* Shouldn't happen */
1360 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_READ_BYTES,
1361 ERR_R_INTERNAL_ERROR);
1365 /* Skip over any records we have already read */
1367 curr_rec < num_recs && SSL3_RECORD_is_read(&rr[curr_rec]);
1369 if (curr_rec == num_recs) {
1370 RECORD_LAYER_set_numrpipes(&s->rlayer, 0);
1374 } while (num_recs == 0);
1377 if (s->rlayer.handshake_fragment_len > 0
1378 && SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE
1379 && SSL_IS_TLS13(s)) {
1380 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1381 SSL_R_MIXED_HANDSHAKE_AND_NON_HANDSHAKE_DATA);
1386 * Reset the count of consecutive warning alerts if we've got a non-empty
1387 * record that isn't an alert.
1389 if (SSL3_RECORD_get_type(rr) != SSL3_RT_ALERT
1390 && SSL3_RECORD_get_length(rr) != 0)
1391 s->rlayer.alert_count = 0;
1393 /* we now have a packet which can be read and processed */
1395 if (s->s3.change_cipher_spec /* set when we receive ChangeCipherSpec,
1396 * reset by ssl3_get_finished */
1397 && (SSL3_RECORD_get_type(rr) != SSL3_RT_HANDSHAKE)) {
1398 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1399 SSL_R_DATA_BETWEEN_CCS_AND_FINISHED);
1404 * If the other end has shut down, throw anything we read away (even in
1407 if (s->shutdown & SSL_RECEIVED_SHUTDOWN) {
1408 SSL3_RECORD_set_length(rr, 0);
1409 s->rwstate = SSL_NOTHING;
1413 if (type == SSL3_RECORD_get_type(rr)
1414 || (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
1415 && type == SSL3_RT_HANDSHAKE && recvd_type != NULL
1418 * SSL3_RT_APPLICATION_DATA or
1419 * SSL3_RT_HANDSHAKE or
1420 * SSL3_RT_CHANGE_CIPHER_SPEC
1423 * make sure that we are not getting application data when we are
1424 * doing a handshake for the first time
1426 if (SSL_in_init(s) && (type == SSL3_RT_APPLICATION_DATA) &&
1427 (s->enc_read_ctx == NULL)) {
1428 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1429 SSL_R_APP_DATA_IN_HANDSHAKE);
1433 if (type == SSL3_RT_HANDSHAKE
1434 && SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC
1435 && s->rlayer.handshake_fragment_len > 0) {
1436 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1437 SSL_R_CCS_RECEIVED_EARLY);
1441 if (recvd_type != NULL)
1442 *recvd_type = SSL3_RECORD_get_type(rr);
1446 * Mark a zero length record as read. This ensures multiple calls to
1447 * SSL_read() with a zero length buffer will eventually cause
1448 * SSL_pending() to report data as being available.
1450 if (SSL3_RECORD_get_length(rr) == 0)
1451 SSL3_RECORD_set_read(rr);
1457 if (len - totalbytes > SSL3_RECORD_get_length(rr))
1458 n = SSL3_RECORD_get_length(rr);
1460 n = len - totalbytes;
1462 memcpy(buf, &(rr->data[rr->off]), n);
1465 /* Mark any zero length record as consumed CVE-2016-6305 */
1466 if (SSL3_RECORD_get_length(rr) == 0)
1467 SSL3_RECORD_set_read(rr);
1469 SSL3_RECORD_sub_length(rr, n);
1470 SSL3_RECORD_add_off(rr, n);
1471 if (SSL3_RECORD_get_length(rr) == 0) {
1472 s->rlayer.rstate = SSL_ST_READ_HEADER;
1473 SSL3_RECORD_set_off(rr, 0);
1474 SSL3_RECORD_set_read(rr);
1477 if (SSL3_RECORD_get_length(rr) == 0
1478 || (peek && n == SSL3_RECORD_get_length(rr))) {
1483 } while (type == SSL3_RT_APPLICATION_DATA && curr_rec < num_recs
1484 && totalbytes < len);
1485 if (totalbytes == 0) {
1486 /* We must have read empty records. Get more data */
1489 if (!peek && curr_rec == num_recs
1490 && (s->mode & SSL_MODE_RELEASE_BUFFERS)
1491 && SSL3_BUFFER_get_left(rbuf) == 0)
1492 ssl3_release_read_buffer(s);
1493 *readbytes = totalbytes;
1498 * If we get here, then type != rr->type; if we have a handshake message,
1499 * then it was unexpected (Hello Request or Client Hello) or invalid (we
1500 * were actually expecting a CCS).
1504 * Lets just double check that we've not got an SSLv2 record
1506 if (rr->rec_version == SSL2_VERSION) {
1508 * Should never happen. ssl3_get_record() should only give us an SSLv2
1509 * record back if this is the first packet and we are looking for an
1510 * initial ClientHello. Therefore |type| should always be equal to
1511 * |rr->type|. If not then something has gone horribly wrong
1513 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_READ_BYTES,
1514 ERR_R_INTERNAL_ERROR);
1518 if (s->method->version == TLS_ANY_VERSION
1519 && (s->server || rr->type != SSL3_RT_ALERT)) {
1521 * If we've got this far and still haven't decided on what version
1522 * we're using then this must be a client side alert we're dealing
1523 * with. We shouldn't be receiving anything other than a ClientHello
1524 * if we are a server.
1526 s->version = rr->rec_version;
1527 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1528 SSL_R_UNEXPECTED_MESSAGE);
1533 * s->rlayer.handshake_fragment_len == 4 iff rr->type == SSL3_RT_HANDSHAKE;
1534 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1537 if (SSL3_RECORD_get_type(rr) == SSL3_RT_ALERT) {
1538 unsigned int alert_level, alert_descr;
1539 unsigned char *alert_bytes = SSL3_RECORD_get_data(rr)
1540 + SSL3_RECORD_get_off(rr);
1543 if (!PACKET_buf_init(&alert, alert_bytes, SSL3_RECORD_get_length(rr))
1544 || !PACKET_get_1(&alert, &alert_level)
1545 || !PACKET_get_1(&alert, &alert_descr)
1546 || PACKET_remaining(&alert) != 0) {
1547 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1548 SSL_R_INVALID_ALERT);
1552 if (s->msg_callback)
1553 s->msg_callback(0, s->version, SSL3_RT_ALERT, alert_bytes, 2, s,
1554 s->msg_callback_arg);
1556 if (s->info_callback != NULL)
1557 cb = s->info_callback;
1558 else if (s->ctx->info_callback != NULL)
1559 cb = s->ctx->info_callback;
1562 j = (alert_level << 8) | alert_descr;
1563 cb(s, SSL_CB_READ_ALERT, j);
1566 if (alert_level == SSL3_AL_WARNING
1567 || (is_tls13 && alert_descr == SSL_AD_USER_CANCELLED)) {
1568 s->s3.warn_alert = alert_descr;
1569 SSL3_RECORD_set_read(rr);
1571 s->rlayer.alert_count++;
1572 if (s->rlayer.alert_count == MAX_WARN_ALERT_COUNT) {
1573 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1574 SSL_R_TOO_MANY_WARN_ALERTS);
1580 * Apart from close_notify the only other warning alert in TLSv1.3
1581 * is user_cancelled - which we just ignore.
1583 if (is_tls13 && alert_descr == SSL_AD_USER_CANCELLED) {
1585 } else if (alert_descr == SSL_AD_CLOSE_NOTIFY
1586 && (is_tls13 || alert_level == SSL3_AL_WARNING)) {
1587 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1589 } else if (alert_level == SSL3_AL_FATAL || is_tls13) {
1592 s->rwstate = SSL_NOTHING;
1593 s->s3.fatal_alert = alert_descr;
1594 SSLfatal(s, SSL_AD_NO_ALERT, SSL_F_SSL3_READ_BYTES,
1595 SSL_AD_REASON_OFFSET + alert_descr);
1596 BIO_snprintf(tmp, sizeof tmp, "%d", alert_descr);
1597 ERR_add_error_data(2, "SSL alert number ", tmp);
1598 s->shutdown |= SSL_RECEIVED_SHUTDOWN;
1599 SSL3_RECORD_set_read(rr);
1600 SSL_CTX_remove_session(s->session_ctx, s->session);
1602 } else if (alert_descr == SSL_AD_NO_RENEGOTIATION) {
1604 * This is a warning but we receive it if we requested
1605 * renegotiation and the peer denied it. Terminate with a fatal
1606 * alert because if application tried to renegotiate it
1607 * presumably had a good reason and expects it to succeed. In
1608 * future we might have a renegotiation where we don't care if
1609 * the peer refused it where we carry on.
1611 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_SSL3_READ_BYTES,
1612 SSL_R_NO_RENEGOTIATION);
1614 } else if (alert_level == SSL3_AL_WARNING) {
1615 /* We ignore any other warning alert in TLSv1.2 and below */
1619 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_SSL3_READ_BYTES,
1620 SSL_R_UNKNOWN_ALERT_TYPE);
1624 if ((s->shutdown & SSL_SENT_SHUTDOWN) != 0) {
1625 if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
1629 * We ignore any handshake messages sent to us unless they are
1630 * TLSv1.3 in which case we want to process them. For all other
1631 * handshake messages we can't do anything reasonable with them
1632 * because we are unable to write any response due to having already
1633 * sent close_notify.
1635 if (!SSL_IS_TLS13(s)) {
1636 SSL3_RECORD_set_length(rr, 0);
1637 SSL3_RECORD_set_read(rr);
1639 if ((s->mode & SSL_MODE_AUTO_RETRY) != 0)
1642 s->rwstate = SSL_READING;
1643 rbio = SSL_get_rbio(s);
1644 BIO_clear_retry_flags(rbio);
1645 BIO_set_retry_read(rbio);
1650 * The peer is continuing to send application data, but we have
1651 * already sent close_notify. If this was expected we should have
1652 * been called via SSL_read() and this would have been handled
1654 * No alert sent because we already sent close_notify
1656 SSL3_RECORD_set_length(rr, 0);
1657 SSL3_RECORD_set_read(rr);
1658 SSLfatal(s, SSL_AD_NO_ALERT, SSL_F_SSL3_READ_BYTES,
1659 SSL_R_APPLICATION_DATA_AFTER_CLOSE_NOTIFY);
1665 * For handshake data we have 'fragment' storage, so fill that so that we
1666 * can process the header at a fixed place. This is done after the
1667 * "SHUTDOWN" code above to avoid filling the fragment storage with data
1668 * that we're just going to discard.
1670 if (SSL3_RECORD_get_type(rr) == SSL3_RT_HANDSHAKE) {
1671 size_t dest_maxlen = sizeof(s->rlayer.handshake_fragment);
1672 unsigned char *dest = s->rlayer.handshake_fragment;
1673 size_t *dest_len = &s->rlayer.handshake_fragment_len;
1675 n = dest_maxlen - *dest_len; /* available space in 'dest' */
1676 if (SSL3_RECORD_get_length(rr) < n)
1677 n = SSL3_RECORD_get_length(rr); /* available bytes */
1679 /* now move 'n' bytes: */
1680 memcpy(dest + *dest_len,
1681 SSL3_RECORD_get_data(rr) + SSL3_RECORD_get_off(rr), n);
1682 SSL3_RECORD_add_off(rr, n);
1683 SSL3_RECORD_sub_length(rr, n);
1685 if (SSL3_RECORD_get_length(rr) == 0)
1686 SSL3_RECORD_set_read(rr);
1688 if (*dest_len < dest_maxlen)
1689 goto start; /* fragment was too small */
1692 if (SSL3_RECORD_get_type(rr) == SSL3_RT_CHANGE_CIPHER_SPEC) {
1693 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1694 SSL_R_CCS_RECEIVED_EARLY);
1699 * Unexpected handshake message (ClientHello, NewSessionTicket (TLS1.3) or
1700 * protocol violation)
1702 if ((s->rlayer.handshake_fragment_len >= 4)
1703 && !ossl_statem_get_in_handshake(s)) {
1704 int ined = (s->early_data_state == SSL_EARLY_DATA_READING);
1706 /* We found handshake data, so we're going back into init */
1707 ossl_statem_set_in_init(s, 1);
1709 i = s->handshake_func(s);
1710 /* SSLfatal() already called if appropriate */
1718 * If we were actually trying to read early data and we found a
1719 * handshake message, then we don't want to continue to try and read
1720 * the application data any more. It won't be "early" now.
1725 if (!(s->mode & SSL_MODE_AUTO_RETRY)) {
1726 if (SSL3_BUFFER_get_left(rbuf) == 0) {
1727 /* no read-ahead left? */
1730 * In the case where we try to read application data, but we
1731 * trigger an SSL handshake, we return -1 with the retry
1732 * option set. Otherwise renegotiation may cause nasty
1733 * problems in the blocking world
1735 s->rwstate = SSL_READING;
1736 bio = SSL_get_rbio(s);
1737 BIO_clear_retry_flags(bio);
1738 BIO_set_retry_read(bio);
1745 switch (SSL3_RECORD_get_type(rr)) {
1748 * TLS 1.0 and 1.1 say you SHOULD ignore unrecognised record types, but
1749 * TLS 1.2 says you MUST send an unexpected message alert. We use the
1750 * TLS 1.2 behaviour for all protocol versions to prevent issues where
1751 * no progress is being made and the peer continually sends unrecognised
1752 * record types, using up resources processing them.
1754 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1755 SSL_R_UNEXPECTED_RECORD);
1757 case SSL3_RT_CHANGE_CIPHER_SPEC:
1759 case SSL3_RT_HANDSHAKE:
1761 * we already handled all of these, with the possible exception of
1762 * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
1763 * that should not happen when type != rr->type
1765 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1766 ERR_R_INTERNAL_ERROR);
1768 case SSL3_RT_APPLICATION_DATA:
1770 * At this point, we were expecting handshake data, but have
1771 * application data. If the library was running inside ssl3_read()
1772 * (i.e. in_read_app_data is set) and it makes sense to read
1773 * application data at this point (session renegotiation not yet
1774 * started), we will indulge it.
1776 if (ossl_statem_app_data_allowed(s)) {
1777 s->s3.in_read_app_data = 2;
1779 } else if (ossl_statem_skip_early_data(s)) {
1781 * This can happen after a client sends a CH followed by early_data,
1782 * but the server responds with a HelloRetryRequest. The server
1783 * reads the next record from the client expecting to find a
1784 * plaintext ClientHello but gets a record which appears to be
1785 * application data. The trial decrypt "works" because null
1786 * decryption was applied. We just skip it and move on to the next
1789 if (!early_data_count_ok(s, rr->length,
1790 EARLY_DATA_CIPHERTEXT_OVERHEAD, 0)) {
1791 /* SSLfatal() already called */
1794 SSL3_RECORD_set_read(rr);
1797 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_SSL3_READ_BYTES,
1798 SSL_R_UNEXPECTED_RECORD);
1804 void ssl3_record_sequence_update(unsigned char *seq)
1808 for (i = 7; i >= 0; i--) {
1816 * Returns true if the current rrec was sent in SSLv2 backwards compatible
1817 * format and false otherwise.
1819 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER *rl)
1821 return SSL3_RECORD_is_sslv2_record(&rl->rrec[0]);
1825 * Returns the length in bytes of the current rrec
1827 size_t RECORD_LAYER_get_rrec_length(RECORD_LAYER *rl)
1829 return SSL3_RECORD_get_length(&rl->rrec[0]);