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 "../packet_locl.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 * When writing early data on the server side we could be "in_init" in
382 * between receiving the EoED and the CF - but we don't want to handle those
385 if (SSL_in_init(s
) && !ossl_statem_get_in_handshake(s
)
386 && s
->early_data_state
!= SSL_EARLY_DATA_UNAUTH_WRITING
) {
387 i
= s
->handshake_func(s
);
388 /* SSLfatal() already called */
397 * first check if there is a SSL3_BUFFER still being written out. This
398 * will happen with non blocking IO
401 /* SSLfatal() already called if appropriate */
402 i
= ssl3_write_pending(s
, type
, &buf
[tot
], s
->rlayer
.wpend_tot
,
405 /* XXX should we ssl3_release_write_buffer if i<0? */
406 s
->rlayer
.wnum
= tot
;
409 tot
+= tmpwrit
; /* this might be last fragment */
411 #if !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
413 * Depending on platform multi-block can deliver several *times*
414 * better performance. Downside is that it has to allocate
415 * jumbo buffer to accommodate up to 8 records, but the
416 * compromise is considered worthy.
418 if (type
== SSL3_RT_APPLICATION_DATA
&&
419 len
>= 4 * (max_send_fragment
= ssl_get_max_send_fragment(s
)) &&
420 s
->compress
== NULL
&& s
->msg_callback
== NULL
&&
421 !SSL_WRITE_ETM(s
) && SSL_USE_EXPLICIT_IV(s
) &&
422 EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s
->enc_write_ctx
)) &
423 EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
) {
424 unsigned char aad
[13];
425 EVP_CTRL_TLS1_1_MULTIBLOCK_PARAM mb_param
;
429 /* minimize address aliasing conflicts */
430 if ((max_send_fragment
& 0xfff) == 0)
431 max_send_fragment
-= 512;
433 if (tot
== 0 || wb
->buf
== NULL
) { /* allocate jumbo buffer */
434 ssl3_release_write_buffer(s
);
436 packlen
= EVP_CIPHER_CTX_ctrl(s
->enc_write_ctx
,
437 EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE
,
438 (int)max_send_fragment
, NULL
);
440 if (len
>= 8 * max_send_fragment
)
445 if (!ssl3_setup_write_buffer(s
, 1, packlen
)) {
446 /* SSLfatal() already called */
449 } else if (tot
== len
) { /* done? */
450 /* free jumbo buffer */
451 ssl3_release_write_buffer(s
);
458 if (n
< 4 * max_send_fragment
) {
459 /* free jumbo buffer */
460 ssl3_release_write_buffer(s
);
464 if (s
->s3
->alert_dispatch
) {
465 i
= s
->method
->ssl_dispatch_alert(s
);
467 /* SSLfatal() already called if appropriate */
468 s
->rlayer
.wnum
= tot
;
473 if (n
>= 8 * max_send_fragment
)
474 nw
= max_send_fragment
* (mb_param
.interleave
= 8);
476 nw
= max_send_fragment
* (mb_param
.interleave
= 4);
478 memcpy(aad
, s
->rlayer
.write_sequence
, 8);
480 aad
[9] = (unsigned char)(s
->version
>> 8);
481 aad
[10] = (unsigned char)(s
->version
);
488 packleni
= EVP_CIPHER_CTX_ctrl(s
->enc_write_ctx
,
489 EVP_CTRL_TLS1_1_MULTIBLOCK_AAD
,
490 sizeof(mb_param
), &mb_param
);
491 packlen
= (size_t)packleni
;
492 if (packleni
<= 0 || packlen
> wb
->len
) { /* never happens */
493 /* free jumbo buffer */
494 ssl3_release_write_buffer(s
);
498 mb_param
.out
= wb
->buf
;
499 mb_param
.inp
= &buf
[tot
];
502 if (EVP_CIPHER_CTX_ctrl(s
->enc_write_ctx
,
503 EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT
,
504 sizeof(mb_param
), &mb_param
) <= 0)
507 s
->rlayer
.write_sequence
[7] += mb_param
.interleave
;
508 if (s
->rlayer
.write_sequence
[7] < mb_param
.interleave
) {
510 while (j
>= 0 && (++s
->rlayer
.write_sequence
[j
--]) == 0) ;
516 s
->rlayer
.wpend_tot
= nw
;
517 s
->rlayer
.wpend_buf
= &buf
[tot
];
518 s
->rlayer
.wpend_type
= type
;
519 s
->rlayer
.wpend_ret
= nw
;
521 i
= ssl3_write_pending(s
, type
, &buf
[tot
], nw
, &tmpwrit
);
523 /* SSLfatal() already called if appropriate */
524 if (i
< 0 && (!s
->wbio
|| !BIO_should_retry(s
->wbio
))) {
525 /* free jumbo buffer */
526 ssl3_release_write_buffer(s
);
528 s
->rlayer
.wnum
= tot
;
532 /* free jumbo buffer */
533 ssl3_release_write_buffer(s
);
534 *written
= tot
+ tmpwrit
;
541 #endif /* !defined(OPENSSL_NO_MULTIBLOCK) && EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK */
542 if (tot
== len
) { /* done? */
543 if (s
->mode
& SSL_MODE_RELEASE_BUFFERS
&& !SSL_IS_DTLS(s
))
544 ssl3_release_write_buffer(s
);
552 max_send_fragment
= ssl_get_max_send_fragment(s
);
553 split_send_fragment
= ssl_get_split_send_fragment(s
);
555 * If max_pipelines is 0 then this means "undefined" and we default to
556 * 1 pipeline. Similarly if the cipher does not support pipelined
557 * processing then we also only use 1 pipeline, or if we're not using
560 maxpipes
= s
->max_pipelines
;
561 if (maxpipes
> SSL_MAX_PIPELINES
) {
563 * We should have prevented this when we set max_pipelines so we
566 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_WRITE_BYTES
,
567 ERR_R_INTERNAL_ERROR
);
571 || s
->enc_write_ctx
== NULL
572 || !(EVP_CIPHER_flags(EVP_CIPHER_CTX_cipher(s
->enc_write_ctx
))
573 & EVP_CIPH_FLAG_PIPELINE
)
574 || !SSL_USE_EXPLICIT_IV(s
))
576 if (max_send_fragment
== 0 || split_send_fragment
== 0
577 || split_send_fragment
> max_send_fragment
) {
579 * We should have prevented this when we set/get the split and max send
580 * fragments so we shouldn't get here
582 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_WRITE_BYTES
,
583 ERR_R_INTERNAL_ERROR
);
588 size_t pipelens
[SSL_MAX_PIPELINES
], tmppipelen
, remain
;
594 numpipes
= ((n
- 1) / split_send_fragment
) + 1;
595 if (numpipes
> maxpipes
)
598 if (n
/ numpipes
>= max_send_fragment
) {
600 * We have enough data to completely fill all available
603 for (j
= 0; j
< numpipes
; j
++) {
604 pipelens
[j
] = max_send_fragment
;
607 /* We can partially fill all available pipelines */
608 tmppipelen
= n
/ numpipes
;
609 remain
= n
% numpipes
;
610 for (j
= 0; j
< numpipes
; j
++) {
611 pipelens
[j
] = tmppipelen
;
617 i
= do_ssl3_write(s
, type
, &(buf
[tot
]), pipelens
, numpipes
, 0,
620 /* SSLfatal() already called if appropriate */
621 /* XXX should we ssl3_release_write_buffer if i<0? */
622 s
->rlayer
.wnum
= tot
;
627 (type
== SSL3_RT_APPLICATION_DATA
&&
628 (s
->mode
& SSL_MODE_ENABLE_PARTIAL_WRITE
))) {
630 * next chunk of data should get another prepended empty fragment
631 * in ciphersuites with known-IV weakness:
633 s
->s3
->empty_fragment_done
= 0;
635 if ((i
== (int)n
) && s
->mode
& SSL_MODE_RELEASE_BUFFERS
&&
637 ssl3_release_write_buffer(s
);
639 *written
= tot
+ tmpwrit
;
648 int do_ssl3_write(SSL
*s
, int type
, const unsigned char *buf
,
649 size_t *pipelens
, size_t numpipes
,
650 int create_empty_fragment
, size_t *written
)
652 WPACKET pkt
[SSL_MAX_PIPELINES
];
653 SSL3_RECORD wr
[SSL_MAX_PIPELINES
];
656 unsigned char *recordstart
;
657 int i
, mac_size
, clear
= 0;
658 size_t prefix_len
= 0;
663 size_t totlen
= 0, len
, wpinited
= 0;
666 for (j
= 0; j
< numpipes
; j
++)
667 totlen
+= pipelens
[j
];
669 * first check if there is a SSL3_BUFFER still being written out. This
670 * will happen with non blocking IO
672 if (RECORD_LAYER_write_pending(&s
->rlayer
)) {
673 /* Calls SSLfatal() as required */
674 return ssl3_write_pending(s
, type
, buf
, totlen
, written
);
677 /* If we have an alert to send, lets send it */
678 if (s
->s3
->alert_dispatch
) {
679 i
= s
->method
->ssl_dispatch_alert(s
);
681 /* SSLfatal() already called if appropriate */
684 /* if it went, fall through and send more stuff */
687 if (s
->rlayer
.numwpipes
< numpipes
) {
688 if (!ssl3_setup_write_buffer(s
, numpipes
, 0)) {
689 /* SSLfatal() already called */
694 if (totlen
== 0 && !create_empty_fragment
)
699 if ((sess
== NULL
) ||
700 (s
->enc_write_ctx
== NULL
) || (EVP_MD_CTX_md(s
->write_hash
) == NULL
)) {
701 clear
= s
->enc_write_ctx
? 0 : 1; /* must be AEAD cipher */
704 /* TODO(siz_t): Convert me */
705 mac_size
= EVP_MD_CTX_size(s
->write_hash
);
707 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
708 ERR_R_INTERNAL_ERROR
);
714 * 'create_empty_fragment' is true only when this function calls itself
716 if (!clear
&& !create_empty_fragment
&& !s
->s3
->empty_fragment_done
) {
718 * countermeasure against known-IV weakness in CBC ciphersuites (see
719 * http://www.openssl.org/~bodo/tls-cbc.txt)
722 if (s
->s3
->need_empty_fragments
&& type
== SSL3_RT_APPLICATION_DATA
) {
724 * recursive function call with 'create_empty_fragment' set; this
725 * prepares and buffers the data for an empty fragment (these
726 * 'prefix_len' bytes are sent out later together with the actual
729 size_t tmppipelen
= 0;
732 ret
= do_ssl3_write(s
, type
, buf
, &tmppipelen
, 1, 1, &prefix_len
);
734 /* SSLfatal() already called if appropriate */
739 (SSL3_RT_HEADER_LENGTH
+ SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD
)) {
740 /* insufficient space */
741 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
742 ERR_R_INTERNAL_ERROR
);
747 s
->s3
->empty_fragment_done
= 1;
750 if (BIO_get_ktls_send(s
->wbio
)) {
752 * ktls doesn't modify the buffer, but to avoid a warning we need to
753 * discard the const qualifier.
754 * This doesn't leak memory because the buffers have been released when
757 SSL3_BUFFER_set_buf(&s
->rlayer
.wbuf
[0], (unsigned char *)buf
);
758 SSL3_BUFFER_set_offset(&s
->rlayer
.wbuf
[0], 0);
759 goto wpacket_init_complete
;
762 if (create_empty_fragment
) {
763 wb
= &s
->rlayer
.wbuf
[0];
764 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD!=0
766 * extra fragment would be couple of cipher blocks, which would be
767 * multiple of SSL3_ALIGN_PAYLOAD, so if we want to align the real
768 * payload, then we can just pretend we simply have two headers.
770 align
= (size_t)SSL3_BUFFER_get_buf(wb
) + 2 * SSL3_RT_HEADER_LENGTH
;
771 align
= SSL3_ALIGN_PAYLOAD
- 1 - ((align
- 1) % SSL3_ALIGN_PAYLOAD
);
773 SSL3_BUFFER_set_offset(wb
, align
);
774 if (!WPACKET_init_static_len(&pkt
[0], SSL3_BUFFER_get_buf(wb
),
775 SSL3_BUFFER_get_len(wb
), 0)
776 || !WPACKET_allocate_bytes(&pkt
[0], align
, NULL
)) {
777 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
778 ERR_R_INTERNAL_ERROR
);
782 } else if (prefix_len
) {
783 wb
= &s
->rlayer
.wbuf
[0];
784 if (!WPACKET_init_static_len(&pkt
[0],
785 SSL3_BUFFER_get_buf(wb
),
786 SSL3_BUFFER_get_len(wb
), 0)
787 || !WPACKET_allocate_bytes(&pkt
[0], SSL3_BUFFER_get_offset(wb
)
788 + prefix_len
, NULL
)) {
789 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
790 ERR_R_INTERNAL_ERROR
);
795 for (j
= 0; j
< numpipes
; j
++) {
798 wb
= &s
->rlayer
.wbuf
[j
];
799 #if defined(SSL3_ALIGN_PAYLOAD) && SSL3_ALIGN_PAYLOAD != 0
800 align
= (size_t)SSL3_BUFFER_get_buf(wb
) + SSL3_RT_HEADER_LENGTH
;
801 align
= SSL3_ALIGN_PAYLOAD
- 1 - ((align
- 1) % SSL3_ALIGN_PAYLOAD
);
803 SSL3_BUFFER_set_offset(wb
, align
);
804 if (!WPACKET_init_static_len(thispkt
, SSL3_BUFFER_get_buf(wb
),
805 SSL3_BUFFER_get_len(wb
), 0)
806 || !WPACKET_allocate_bytes(thispkt
, align
, NULL
)) {
807 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
808 ERR_R_INTERNAL_ERROR
);
815 /* Explicit IV length, block ciphers appropriate version flag */
816 if (s
->enc_write_ctx
&& SSL_USE_EXPLICIT_IV(s
) && !SSL_TREAT_AS_TLS13(s
)) {
817 int mode
= EVP_CIPHER_CTX_mode(s
->enc_write_ctx
);
818 if (mode
== EVP_CIPH_CBC_MODE
) {
819 /* TODO(size_t): Convert me */
820 eivlen
= EVP_CIPHER_CTX_iv_length(s
->enc_write_ctx
);
823 } else if (mode
== EVP_CIPH_GCM_MODE
) {
824 /* Need explicit part of IV for GCM mode */
825 eivlen
= EVP_GCM_TLS_EXPLICIT_IV_LEN
;
826 } else if (mode
== EVP_CIPH_CCM_MODE
) {
827 eivlen
= EVP_CCM_TLS_EXPLICIT_IV_LEN
;
831 wpacket_init_complete
:
834 /* Clear our SSL3_RECORD structures */
835 memset(wr
, 0, sizeof(wr
));
836 for (j
= 0; j
< numpipes
; j
++) {
837 unsigned int version
= (s
->version
== TLS1_3_VERSION
) ? TLS1_2_VERSION
839 unsigned char *compressdata
= NULL
;
841 unsigned int rectype
;
847 * In TLSv1.3, once encrypting, we always use application data for the
850 if (SSL_TREAT_AS_TLS13(s
)
851 && s
->enc_write_ctx
!= NULL
852 && (s
->statem
.enc_write_state
!= ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
853 || type
!= SSL3_RT_ALERT
))
854 rectype
= SSL3_RT_APPLICATION_DATA
;
857 SSL3_RECORD_set_type(thiswr
, rectype
);
860 * Some servers hang if initial client hello is larger than 256 bytes
861 * and record version number > TLS 1.0
863 if (SSL_get_state(s
) == TLS_ST_CW_CLNT_HELLO
865 && TLS1_get_version(s
) > TLS1_VERSION
866 && s
->hello_retry_request
== SSL_HRR_NONE
)
867 version
= TLS1_VERSION
;
868 SSL3_RECORD_set_rec_version(thiswr
, version
);
870 maxcomplen
= pipelens
[j
];
871 if (s
->compress
!= NULL
)
872 maxcomplen
+= SSL3_RT_MAX_COMPRESSED_OVERHEAD
;
875 * When using offload kernel will write the header.
876 * Otherwise write the header now
878 if (!BIO_get_ktls_send(s
->wbio
)
879 && (!WPACKET_put_bytes_u8(thispkt
, rectype
)
880 || !WPACKET_put_bytes_u16(thispkt
, version
)
881 || !WPACKET_start_sub_packet_u16(thispkt
)
883 && !WPACKET_allocate_bytes(thispkt
, eivlen
, NULL
))
885 && !WPACKET_reserve_bytes(thispkt
, maxcomplen
,
887 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
888 ERR_R_INTERNAL_ERROR
);
892 /* lets setup the record stuff. */
893 SSL3_RECORD_set_data(thiswr
, compressdata
);
894 SSL3_RECORD_set_length(thiswr
, pipelens
[j
]);
895 SSL3_RECORD_set_input(thiswr
, (unsigned char *)&buf
[totlen
]);
896 totlen
+= pipelens
[j
];
899 * we now 'read' from thiswr->input, thiswr->length bytes into
903 /* first we compress */
904 if (s
->compress
!= NULL
) {
905 if (!ssl3_do_compress(s
, thiswr
)
906 || !WPACKET_allocate_bytes(thispkt
, thiswr
->length
, NULL
)) {
907 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
908 SSL_R_COMPRESSION_FAILURE
);
912 if (BIO_get_ktls_send(s
->wbio
)) {
913 SSL3_RECORD_reset_data(&wr
[j
]);
915 if (!WPACKET_memcpy(thispkt
, thiswr
->input
, thiswr
->length
)) {
916 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
917 ERR_R_INTERNAL_ERROR
);
920 SSL3_RECORD_reset_input(&wr
[j
]);
924 if (SSL_TREAT_AS_TLS13(s
)
925 && s
->enc_write_ctx
!= NULL
926 && (s
->statem
.enc_write_state
!= ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
927 || type
!= SSL3_RT_ALERT
)) {
928 size_t rlen
, max_send_fragment
;
930 if (!WPACKET_put_bytes_u8(thispkt
, type
)) {
931 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
932 ERR_R_INTERNAL_ERROR
);
935 SSL3_RECORD_add_length(thiswr
, 1);
937 /* Add TLS1.3 padding */
938 max_send_fragment
= ssl_get_max_send_fragment(s
);
939 rlen
= SSL3_RECORD_get_length(thiswr
);
940 if (rlen
< max_send_fragment
) {
942 size_t max_padding
= max_send_fragment
- rlen
;
943 if (s
->record_padding_cb
!= NULL
) {
944 padding
= s
->record_padding_cb(s
, type
, rlen
, s
->record_padding_arg
);
945 } else if (s
->block_padding
> 0) {
946 size_t mask
= s
->block_padding
- 1;
949 /* optimize for power of 2 */
950 if ((s
->block_padding
& mask
) == 0)
951 remainder
= rlen
& mask
;
953 remainder
= rlen
% s
->block_padding
;
954 /* don't want to add a block of padding if we don't have to */
958 padding
= s
->block_padding
- remainder
;
961 /* do not allow the record to exceed max plaintext length */
962 if (padding
> max_padding
)
963 padding
= max_padding
;
964 if (!WPACKET_memset(thispkt
, 0, padding
)) {
965 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
966 ERR_R_INTERNAL_ERROR
);
969 SSL3_RECORD_add_length(thiswr
, padding
);
975 * we should still have the output to thiswr->data and the input from
976 * wr->input. Length should be thiswr->length. thiswr->data still points
980 if (!SSL_WRITE_ETM(s
) && mac_size
!= 0) {
983 if (!WPACKET_allocate_bytes(thispkt
, mac_size
, &mac
)
984 || !s
->method
->ssl3_enc
->mac(s
, thiswr
, mac
, 1)) {
985 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
986 ERR_R_INTERNAL_ERROR
);
992 * Reserve some bytes for any growth that may occur during encryption.
993 * This will be at most one cipher block or the tag length if using
994 * AEAD. SSL_RT_MAX_CIPHER_BLOCK_SIZE covers either case.
996 if (!BIO_get_ktls_send(s
->wbio
)) {
997 if (!WPACKET_reserve_bytes(thispkt
,
998 SSL_RT_MAX_CIPHER_BLOCK_SIZE
,
1001 * We also need next the amount of bytes written to this
1004 || !WPACKET_get_length(thispkt
, &len
)) {
1005 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1006 ERR_R_INTERNAL_ERROR
);
1010 /* Get a pointer to the start of this record excluding header */
1011 recordstart
= WPACKET_get_curr(thispkt
) - len
;
1012 SSL3_RECORD_set_data(thiswr
, recordstart
);
1013 SSL3_RECORD_reset_input(thiswr
);
1014 SSL3_RECORD_set_length(thiswr
, len
);
1018 if (s
->statem
.enc_write_state
== ENC_WRITE_STATE_WRITE_PLAIN_ALERTS
) {
1020 * We haven't actually negotiated the version yet, but we're trying to
1021 * send early data - so we need to use the tls13enc function.
1023 if (tls13_enc(s
, wr
, numpipes
, 1) < 1) {
1024 if (!ossl_statem_in_error(s
)) {
1025 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1026 ERR_R_INTERNAL_ERROR
);
1031 if (!BIO_get_ktls_send(s
->wbio
)) {
1032 if (s
->method
->ssl3_enc
->enc(s
, wr
, numpipes
, 1) < 1) {
1033 if (!ossl_statem_in_error(s
)) {
1034 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1035 ERR_R_INTERNAL_ERROR
);
1042 for (j
= 0; j
< numpipes
; j
++) {
1048 if (BIO_get_ktls_send(s
->wbio
))
1051 /* Allocate bytes for the encryption overhead */
1052 if (!WPACKET_get_length(thispkt
, &origlen
)
1053 /* Encryption should never shrink the data! */
1054 || origlen
> thiswr
->length
1055 || (thiswr
->length
> origlen
1056 && !WPACKET_allocate_bytes(thispkt
,
1057 thiswr
->length
- origlen
,
1059 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1060 ERR_R_INTERNAL_ERROR
);
1063 if (SSL_WRITE_ETM(s
) && mac_size
!= 0) {
1066 if (!WPACKET_allocate_bytes(thispkt
, mac_size
, &mac
)
1067 || !s
->method
->ssl3_enc
->mac(s
, thiswr
, mac
, 1)) {
1068 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1069 ERR_R_INTERNAL_ERROR
);
1072 SSL3_RECORD_add_length(thiswr
, mac_size
);
1075 if (!WPACKET_get_length(thispkt
, &len
)
1076 || !WPACKET_close(thispkt
)) {
1077 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1078 ERR_R_INTERNAL_ERROR
);
1082 if (s
->msg_callback
) {
1083 recordstart
= WPACKET_get_curr(thispkt
) - len
1084 - SSL3_RT_HEADER_LENGTH
;
1085 s
->msg_callback(1, 0, SSL3_RT_HEADER
, recordstart
,
1086 SSL3_RT_HEADER_LENGTH
, s
,
1087 s
->msg_callback_arg
);
1089 if (SSL_TREAT_AS_TLS13(s
) && s
->enc_write_ctx
!= NULL
) {
1090 unsigned char ctype
= type
;
1092 s
->msg_callback(1, s
->version
, SSL3_RT_INNER_CONTENT_TYPE
,
1093 &ctype
, 1, s
, s
->msg_callback_arg
);
1097 if (!WPACKET_finish(thispkt
)) {
1098 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1099 ERR_R_INTERNAL_ERROR
);
1103 /* header is added by the kernel when using offload */
1104 SSL3_RECORD_add_length(&wr
[j
], SSL3_RT_HEADER_LENGTH
);
1106 if (create_empty_fragment
) {
1108 * we are in a recursive call; just return the length, don't write
1112 /* We should never be pipelining an empty fragment!! */
1113 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_DO_SSL3_WRITE
,
1114 ERR_R_INTERNAL_ERROR
);
1117 *written
= SSL3_RECORD_get_length(thiswr
);
1123 * we should now have thiswr->data pointing to the encrypted data, which
1124 * is thiswr->length long
1126 SSL3_RECORD_set_type(thiswr
, type
); /* not needed but helps for
1129 /* now let's set up wb */
1130 SSL3_BUFFER_set_left(&s
->rlayer
.wbuf
[j
],
1131 prefix_len
+ SSL3_RECORD_get_length(thiswr
));
1135 * memorize arguments so that ssl3_write_pending can detect bad write
1138 s
->rlayer
.wpend_tot
= totlen
;
1139 s
->rlayer
.wpend_buf
= buf
;
1140 s
->rlayer
.wpend_type
= type
;
1141 s
->rlayer
.wpend_ret
= totlen
;
1143 /* we now just need to write the buffer */
1144 return ssl3_write_pending(s
, type
, buf
, totlen
, written
);
1146 for (j
= 0; j
< wpinited
; j
++)
1147 WPACKET_cleanup(&pkt
[j
]);
1151 /* if s->s3->wbuf.left != 0, we need to call this
1153 * Return values are as per SSL_write()
1155 int ssl3_write_pending(SSL
*s
, int type
, const unsigned char *buf
, size_t len
,
1159 SSL3_BUFFER
*wb
= s
->rlayer
.wbuf
;
1163 if ((s
->rlayer
.wpend_tot
> len
)
1164 || (!(s
->mode
& SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER
)
1165 && (s
->rlayer
.wpend_buf
!= buf
))
1166 || (s
->rlayer
.wpend_type
!= type
)) {
1167 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_WRITE_PENDING
,
1168 SSL_R_BAD_WRITE_RETRY
);
1173 /* Loop until we find a buffer we haven't written out yet */
1174 if (SSL3_BUFFER_get_left(&wb
[currbuf
]) == 0
1175 && currbuf
< s
->rlayer
.numwpipes
- 1) {
1180 if (s
->wbio
!= NULL
) {
1181 s
->rwstate
= SSL_WRITING
;
1184 * To prevent coalescing of control and data messages,
1185 * such as in buffer_write, we flush the BIO
1187 if (BIO_get_ktls_send(s
->wbio
) && type
!= SSL3_RT_APPLICATION_DATA
) {
1188 i
= BIO_flush(s
->wbio
);
1193 if (BIO_get_ktls_send(s
->wbio
)
1194 && type
!= SSL3_RT_APPLICATION_DATA
) {
1195 BIO_set_ktls_ctrl_msg(s
->wbio
, type
);
1197 /* TODO(size_t): Convert this call */
1198 i
= BIO_write(s
->wbio
, (char *)
1199 &(SSL3_BUFFER_get_buf(&wb
[currbuf
])
1200 [SSL3_BUFFER_get_offset(&wb
[currbuf
])]),
1201 (unsigned int)SSL3_BUFFER_get_left(&wb
[currbuf
]));
1205 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_WRITE_PENDING
,
1209 if (i
> 0 && tmpwrit
== SSL3_BUFFER_get_left(&wb
[currbuf
])) {
1210 SSL3_BUFFER_set_left(&wb
[currbuf
], 0);
1211 SSL3_BUFFER_add_offset(&wb
[currbuf
], tmpwrit
);
1212 if (currbuf
+ 1 < s
->rlayer
.numwpipes
)
1214 s
->rwstate
= SSL_NOTHING
;
1215 *written
= s
->rlayer
.wpend_ret
;
1217 } else if (i
<= 0) {
1218 if (SSL_IS_DTLS(s
)) {
1220 * For DTLS, just drop it. That's kind of the whole point in
1221 * using a datagram service
1223 SSL3_BUFFER_set_left(&wb
[currbuf
], 0);
1227 SSL3_BUFFER_add_offset(&wb
[currbuf
], tmpwrit
);
1228 SSL3_BUFFER_sub_left(&wb
[currbuf
], tmpwrit
);
1233 * Return up to 'len' payload bytes received in 'type' records.
1234 * 'type' is one of the following:
1236 * - SSL3_RT_HANDSHAKE (when ssl3_get_message calls us)
1237 * - SSL3_RT_APPLICATION_DATA (when ssl3_read calls us)
1238 * - 0 (during a shutdown, no data has to be returned)
1240 * If we don't have stored data to work from, read a SSL/TLS record first
1241 * (possibly multiple records if we still don't have anything to return).
1243 * This function must handle any surprises the peer may have for us, such as
1244 * Alert records (e.g. close_notify) or renegotiation requests. ChangeCipherSpec
1245 * messages are treated as if they were handshake messages *if* the |recd_type|
1246 * argument is non NULL.
1247 * Also if record payloads contain fragments too small to process, we store
1248 * them until there is enough for the respective protocol (the record protocol
1249 * may use arbitrary fragmentation and even interleaving):
1250 * Change cipher spec protocol
1251 * just 1 byte needed, no need for keeping anything stored
1253 * 2 bytes needed (AlertLevel, AlertDescription)
1254 * Handshake protocol
1255 * 4 bytes needed (HandshakeType, uint24 length) -- we just have
1256 * to detect unexpected Client Hello and Hello Request messages
1257 * here, anything else is handled by higher layers
1258 * Application data protocol
1259 * none of our business
1261 int ssl3_read_bytes(SSL
*s
, int type
, int *recvd_type
, unsigned char *buf
,
1262 size_t len
, int peek
, size_t *readbytes
)
1265 size_t n
, curr_rec
, num_recs
, totalbytes
;
1268 void (*cb
) (const SSL
*ssl
, int type2
, int val
) = NULL
;
1269 int is_tls13
= SSL_IS_TLS13(s
);
1271 rbuf
= &s
->rlayer
.rbuf
;
1273 if (!SSL3_BUFFER_is_initialised(rbuf
)) {
1274 /* Not initialized yet */
1275 if (!ssl3_setup_read_buffer(s
)) {
1276 /* SSLfatal() already called */
1281 if ((type
&& (type
!= SSL3_RT_APPLICATION_DATA
)
1282 && (type
!= SSL3_RT_HANDSHAKE
)) || (peek
1284 SSL3_RT_APPLICATION_DATA
))) {
1285 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_READ_BYTES
,
1286 ERR_R_INTERNAL_ERROR
);
1290 if ((type
== SSL3_RT_HANDSHAKE
) && (s
->rlayer
.handshake_fragment_len
> 0))
1291 /* (partially) satisfy request from storage */
1293 unsigned char *src
= s
->rlayer
.handshake_fragment
;
1294 unsigned char *dst
= buf
;
1299 while ((len
> 0) && (s
->rlayer
.handshake_fragment_len
> 0)) {
1302 s
->rlayer
.handshake_fragment_len
--;
1305 /* move any remaining fragment bytes: */
1306 for (k
= 0; k
< s
->rlayer
.handshake_fragment_len
; k
++)
1307 s
->rlayer
.handshake_fragment
[k
] = *src
++;
1309 if (recvd_type
!= NULL
)
1310 *recvd_type
= SSL3_RT_HANDSHAKE
;
1317 * Now s->rlayer.handshake_fragment_len == 0 if type == SSL3_RT_HANDSHAKE.
1320 if (!ossl_statem_get_in_handshake(s
) && SSL_in_init(s
)) {
1321 /* type == SSL3_RT_APPLICATION_DATA */
1322 i
= s
->handshake_func(s
);
1323 /* SSLfatal() already called */
1330 s
->rwstate
= SSL_NOTHING
;
1333 * For each record 'i' up to |num_recs]
1334 * rr[i].type - is the type of record
1335 * rr[i].data, - data
1336 * rr[i].off, - offset into 'data' for next read
1337 * rr[i].length, - number of bytes.
1339 rr
= s
->rlayer
.rrec
;
1340 num_recs
= RECORD_LAYER_get_numrpipes(&s
->rlayer
);
1343 /* get new records if necessary */
1344 if (num_recs
== 0) {
1345 ret
= ssl3_get_record(s
);
1347 /* SSLfatal() already called if appropriate */
1350 num_recs
= RECORD_LAYER_get_numrpipes(&s
->rlayer
);
1351 if (num_recs
== 0) {
1352 /* Shouldn't happen */
1353 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_READ_BYTES
,
1354 ERR_R_INTERNAL_ERROR
);
1358 /* Skip over any records we have already read */
1360 curr_rec
< num_recs
&& SSL3_RECORD_is_read(&rr
[curr_rec
]);
1362 if (curr_rec
== num_recs
) {
1363 RECORD_LAYER_set_numrpipes(&s
->rlayer
, 0);
1367 } while (num_recs
== 0);
1370 if (s
->rlayer
.handshake_fragment_len
> 0
1371 && SSL3_RECORD_get_type(rr
) != SSL3_RT_HANDSHAKE
1372 && SSL_IS_TLS13(s
)) {
1373 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1374 SSL_R_MIXED_HANDSHAKE_AND_NON_HANDSHAKE_DATA
);
1379 * Reset the count of consecutive warning alerts if we've got a non-empty
1380 * record that isn't an alert.
1382 if (SSL3_RECORD_get_type(rr
) != SSL3_RT_ALERT
1383 && SSL3_RECORD_get_length(rr
) != 0)
1384 s
->rlayer
.alert_count
= 0;
1386 /* we now have a packet which can be read and processed */
1388 if (s
->s3
->change_cipher_spec
/* set when we receive ChangeCipherSpec,
1389 * reset by ssl3_get_finished */
1390 && (SSL3_RECORD_get_type(rr
) != SSL3_RT_HANDSHAKE
)) {
1391 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1392 SSL_R_DATA_BETWEEN_CCS_AND_FINISHED
);
1397 * If the other end has shut down, throw anything we read away (even in
1400 if (s
->shutdown
& SSL_RECEIVED_SHUTDOWN
) {
1401 SSL3_RECORD_set_length(rr
, 0);
1402 s
->rwstate
= SSL_NOTHING
;
1406 if (type
== SSL3_RECORD_get_type(rr
)
1407 || (SSL3_RECORD_get_type(rr
) == SSL3_RT_CHANGE_CIPHER_SPEC
1408 && type
== SSL3_RT_HANDSHAKE
&& recvd_type
!= NULL
1411 * SSL3_RT_APPLICATION_DATA or
1412 * SSL3_RT_HANDSHAKE or
1413 * SSL3_RT_CHANGE_CIPHER_SPEC
1416 * make sure that we are not getting application data when we are
1417 * doing a handshake for the first time
1419 if (SSL_in_init(s
) && (type
== SSL3_RT_APPLICATION_DATA
) &&
1420 (s
->enc_read_ctx
== NULL
)) {
1421 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1422 SSL_R_APP_DATA_IN_HANDSHAKE
);
1426 if (type
== SSL3_RT_HANDSHAKE
1427 && SSL3_RECORD_get_type(rr
) == SSL3_RT_CHANGE_CIPHER_SPEC
1428 && s
->rlayer
.handshake_fragment_len
> 0) {
1429 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1430 SSL_R_CCS_RECEIVED_EARLY
);
1434 if (recvd_type
!= NULL
)
1435 *recvd_type
= SSL3_RECORD_get_type(rr
);
1439 * Mark a zero length record as read. This ensures multiple calls to
1440 * SSL_read() with a zero length buffer will eventually cause
1441 * SSL_pending() to report data as being available.
1443 if (SSL3_RECORD_get_length(rr
) == 0)
1444 SSL3_RECORD_set_read(rr
);
1450 if (len
- totalbytes
> SSL3_RECORD_get_length(rr
))
1451 n
= SSL3_RECORD_get_length(rr
);
1453 n
= len
- totalbytes
;
1455 memcpy(buf
, &(rr
->data
[rr
->off
]), n
);
1458 /* Mark any zero length record as consumed CVE-2016-6305 */
1459 if (SSL3_RECORD_get_length(rr
) == 0)
1460 SSL3_RECORD_set_read(rr
);
1462 SSL3_RECORD_sub_length(rr
, n
);
1463 SSL3_RECORD_add_off(rr
, n
);
1464 if (SSL3_RECORD_get_length(rr
) == 0) {
1465 s
->rlayer
.rstate
= SSL_ST_READ_HEADER
;
1466 SSL3_RECORD_set_off(rr
, 0);
1467 SSL3_RECORD_set_read(rr
);
1470 if (SSL3_RECORD_get_length(rr
) == 0
1471 || (peek
&& n
== SSL3_RECORD_get_length(rr
))) {
1476 } while (type
== SSL3_RT_APPLICATION_DATA
&& curr_rec
< num_recs
1477 && totalbytes
< len
);
1478 if (totalbytes
== 0) {
1479 /* We must have read empty records. Get more data */
1482 if (!peek
&& curr_rec
== num_recs
1483 && (s
->mode
& SSL_MODE_RELEASE_BUFFERS
)
1484 && SSL3_BUFFER_get_left(rbuf
) == 0)
1485 ssl3_release_read_buffer(s
);
1486 *readbytes
= totalbytes
;
1491 * If we get here, then type != rr->type; if we have a handshake message,
1492 * then it was unexpected (Hello Request or Client Hello) or invalid (we
1493 * were actually expecting a CCS).
1497 * Lets just double check that we've not got an SSLv2 record
1499 if (rr
->rec_version
== SSL2_VERSION
) {
1501 * Should never happen. ssl3_get_record() should only give us an SSLv2
1502 * record back if this is the first packet and we are looking for an
1503 * initial ClientHello. Therefore |type| should always be equal to
1504 * |rr->type|. If not then something has gone horribly wrong
1506 SSLfatal(s
, SSL_AD_INTERNAL_ERROR
, SSL_F_SSL3_READ_BYTES
,
1507 ERR_R_INTERNAL_ERROR
);
1511 if (s
->method
->version
== TLS_ANY_VERSION
1512 && (s
->server
|| rr
->type
!= SSL3_RT_ALERT
)) {
1514 * If we've got this far and still haven't decided on what version
1515 * we're using then this must be a client side alert we're dealing
1516 * with. We shouldn't be receiving anything other than a ClientHello
1517 * if we are a server.
1519 s
->version
= rr
->rec_version
;
1520 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1521 SSL_R_UNEXPECTED_MESSAGE
);
1526 * s->rlayer.handshake_fragment_len == 4 iff rr->type == SSL3_RT_HANDSHAKE;
1527 * (Possibly rr is 'empty' now, i.e. rr->length may be 0.)
1530 if (SSL3_RECORD_get_type(rr
) == SSL3_RT_ALERT
) {
1531 unsigned int alert_level
, alert_descr
;
1532 unsigned char *alert_bytes
= SSL3_RECORD_get_data(rr
)
1533 + SSL3_RECORD_get_off(rr
);
1536 if (!PACKET_buf_init(&alert
, alert_bytes
, SSL3_RECORD_get_length(rr
))
1537 || !PACKET_get_1(&alert
, &alert_level
)
1538 || !PACKET_get_1(&alert
, &alert_descr
)
1539 || PACKET_remaining(&alert
) != 0) {
1540 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1541 SSL_R_INVALID_ALERT
);
1545 if (s
->msg_callback
)
1546 s
->msg_callback(0, s
->version
, SSL3_RT_ALERT
, alert_bytes
, 2, s
,
1547 s
->msg_callback_arg
);
1549 if (s
->info_callback
!= NULL
)
1550 cb
= s
->info_callback
;
1551 else if (s
->ctx
->info_callback
!= NULL
)
1552 cb
= s
->ctx
->info_callback
;
1555 j
= (alert_level
<< 8) | alert_descr
;
1556 cb(s
, SSL_CB_READ_ALERT
, j
);
1559 if (alert_level
== SSL3_AL_WARNING
1560 || (is_tls13
&& alert_descr
== SSL_AD_USER_CANCELLED
)) {
1561 s
->s3
->warn_alert
= alert_descr
;
1562 SSL3_RECORD_set_read(rr
);
1564 s
->rlayer
.alert_count
++;
1565 if (s
->rlayer
.alert_count
== MAX_WARN_ALERT_COUNT
) {
1566 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1567 SSL_R_TOO_MANY_WARN_ALERTS
);
1573 * Apart from close_notify the only other warning alert in TLSv1.3
1574 * is user_cancelled - which we just ignore.
1576 if (is_tls13
&& alert_descr
== SSL_AD_USER_CANCELLED
) {
1578 } else if (alert_descr
== SSL_AD_CLOSE_NOTIFY
1579 && (is_tls13
|| alert_level
== SSL3_AL_WARNING
)) {
1580 s
->shutdown
|= SSL_RECEIVED_SHUTDOWN
;
1582 } else if (alert_level
== SSL3_AL_FATAL
|| is_tls13
) {
1585 s
->rwstate
= SSL_NOTHING
;
1586 s
->s3
->fatal_alert
= alert_descr
;
1587 SSLfatal(s
, SSL_AD_NO_ALERT
, SSL_F_SSL3_READ_BYTES
,
1588 SSL_AD_REASON_OFFSET
+ alert_descr
);
1589 BIO_snprintf(tmp
, sizeof tmp
, "%d", alert_descr
);
1590 ERR_add_error_data(2, "SSL alert number ", tmp
);
1591 s
->shutdown
|= SSL_RECEIVED_SHUTDOWN
;
1592 SSL3_RECORD_set_read(rr
);
1593 SSL_CTX_remove_session(s
->session_ctx
, s
->session
);
1595 } else if (alert_descr
== SSL_AD_NO_RENEGOTIATION
) {
1597 * This is a warning but we receive it if we requested
1598 * renegotiation and the peer denied it. Terminate with a fatal
1599 * alert because if application tried to renegotiate it
1600 * presumably had a good reason and expects it to succeed. In
1601 * future we might have a renegotiation where we don't care if
1602 * the peer refused it where we carry on.
1604 SSLfatal(s
, SSL_AD_HANDSHAKE_FAILURE
, SSL_F_SSL3_READ_BYTES
,
1605 SSL_R_NO_RENEGOTIATION
);
1607 } else if (alert_level
== SSL3_AL_WARNING
) {
1608 /* We ignore any other warning alert in TLSv1.2 and below */
1612 SSLfatal(s
, SSL_AD_ILLEGAL_PARAMETER
, SSL_F_SSL3_READ_BYTES
,
1613 SSL_R_UNKNOWN_ALERT_TYPE
);
1617 if ((s
->shutdown
& SSL_SENT_SHUTDOWN
) != 0) {
1618 if (SSL3_RECORD_get_type(rr
) == SSL3_RT_HANDSHAKE
) {
1622 * We ignore any handshake messages sent to us unless they are
1623 * TLSv1.3 in which case we want to process them. For all other
1624 * handshake messages we can't do anything reasonable with them
1625 * because we are unable to write any response due to having already
1626 * sent close_notify.
1628 if (!SSL_IS_TLS13(s
)) {
1629 SSL3_RECORD_set_length(rr
, 0);
1630 SSL3_RECORD_set_read(rr
);
1632 if ((s
->mode
& SSL_MODE_AUTO_RETRY
) != 0)
1635 s
->rwstate
= SSL_READING
;
1636 rbio
= SSL_get_rbio(s
);
1637 BIO_clear_retry_flags(rbio
);
1638 BIO_set_retry_read(rbio
);
1643 * The peer is continuing to send application data, but we have
1644 * already sent close_notify. If this was expected we should have
1645 * been called via SSL_read() and this would have been handled
1647 * No alert sent because we already sent close_notify
1649 SSL3_RECORD_set_length(rr
, 0);
1650 SSL3_RECORD_set_read(rr
);
1651 SSLfatal(s
, SSL_AD_NO_ALERT
, SSL_F_SSL3_READ_BYTES
,
1652 SSL_R_APPLICATION_DATA_AFTER_CLOSE_NOTIFY
);
1658 * For handshake data we have 'fragment' storage, so fill that so that we
1659 * can process the header at a fixed place. This is done after the
1660 * "SHUTDOWN" code above to avoid filling the fragment storage with data
1661 * that we're just going to discard.
1663 if (SSL3_RECORD_get_type(rr
) == SSL3_RT_HANDSHAKE
) {
1664 size_t dest_maxlen
= sizeof(s
->rlayer
.handshake_fragment
);
1665 unsigned char *dest
= s
->rlayer
.handshake_fragment
;
1666 size_t *dest_len
= &s
->rlayer
.handshake_fragment_len
;
1668 n
= dest_maxlen
- *dest_len
; /* available space in 'dest' */
1669 if (SSL3_RECORD_get_length(rr
) < n
)
1670 n
= SSL3_RECORD_get_length(rr
); /* available bytes */
1672 /* now move 'n' bytes: */
1673 memcpy(dest
+ *dest_len
,
1674 SSL3_RECORD_get_data(rr
) + SSL3_RECORD_get_off(rr
), n
);
1675 SSL3_RECORD_add_off(rr
, n
);
1676 SSL3_RECORD_sub_length(rr
, n
);
1678 if (SSL3_RECORD_get_length(rr
) == 0)
1679 SSL3_RECORD_set_read(rr
);
1681 if (*dest_len
< dest_maxlen
)
1682 goto start
; /* fragment was too small */
1685 if (SSL3_RECORD_get_type(rr
) == SSL3_RT_CHANGE_CIPHER_SPEC
) {
1686 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1687 SSL_R_CCS_RECEIVED_EARLY
);
1692 * Unexpected handshake message (ClientHello, NewSessionTicket (TLS1.3) or
1693 * protocol violation)
1695 if ((s
->rlayer
.handshake_fragment_len
>= 4)
1696 && !ossl_statem_get_in_handshake(s
)) {
1697 int ined
= (s
->early_data_state
== SSL_EARLY_DATA_READING
);
1699 /* We found handshake data, so we're going back into init */
1700 ossl_statem_set_in_init(s
, 1);
1702 i
= s
->handshake_func(s
);
1703 /* SSLfatal() already called if appropriate */
1711 * If we were actually trying to read early data and we found a
1712 * handshake message, then we don't want to continue to try and read
1713 * the application data any more. It won't be "early" now.
1718 if (!(s
->mode
& SSL_MODE_AUTO_RETRY
)) {
1719 if (SSL3_BUFFER_get_left(rbuf
) == 0) {
1720 /* no read-ahead left? */
1723 * In the case where we try to read application data, but we
1724 * trigger an SSL handshake, we return -1 with the retry
1725 * option set. Otherwise renegotiation may cause nasty
1726 * problems in the blocking world
1728 s
->rwstate
= SSL_READING
;
1729 bio
= SSL_get_rbio(s
);
1730 BIO_clear_retry_flags(bio
);
1731 BIO_set_retry_read(bio
);
1738 switch (SSL3_RECORD_get_type(rr
)) {
1741 * TLS 1.0 and 1.1 say you SHOULD ignore unrecognised record types, but
1742 * TLS 1.2 says you MUST send an unexpected message alert. We use the
1743 * TLS 1.2 behaviour for all protocol versions to prevent issues where
1744 * no progress is being made and the peer continually sends unrecognised
1745 * record types, using up resources processing them.
1747 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1748 SSL_R_UNEXPECTED_RECORD
);
1750 case SSL3_RT_CHANGE_CIPHER_SPEC
:
1752 case SSL3_RT_HANDSHAKE
:
1754 * we already handled all of these, with the possible exception of
1755 * SSL3_RT_HANDSHAKE when ossl_statem_get_in_handshake(s) is true, but
1756 * that should not happen when type != rr->type
1758 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1759 ERR_R_INTERNAL_ERROR
);
1761 case SSL3_RT_APPLICATION_DATA
:
1763 * At this point, we were expecting handshake data, but have
1764 * application data. If the library was running inside ssl3_read()
1765 * (i.e. in_read_app_data is set) and it makes sense to read
1766 * application data at this point (session renegotiation not yet
1767 * started), we will indulge it.
1769 if (ossl_statem_app_data_allowed(s
)) {
1770 s
->s3
->in_read_app_data
= 2;
1772 } else if (ossl_statem_skip_early_data(s
)) {
1774 * This can happen after a client sends a CH followed by early_data,
1775 * but the server responds with a HelloRetryRequest. The server
1776 * reads the next record from the client expecting to find a
1777 * plaintext ClientHello but gets a record which appears to be
1778 * application data. The trial decrypt "works" because null
1779 * decryption was applied. We just skip it and move on to the next
1782 if (!early_data_count_ok(s
, rr
->length
,
1783 EARLY_DATA_CIPHERTEXT_OVERHEAD
, 0)) {
1784 /* SSLfatal() already called */
1787 SSL3_RECORD_set_read(rr
);
1790 SSLfatal(s
, SSL_AD_UNEXPECTED_MESSAGE
, SSL_F_SSL3_READ_BYTES
,
1791 SSL_R_UNEXPECTED_RECORD
);
1797 void ssl3_record_sequence_update(unsigned char *seq
)
1801 for (i
= 7; i
>= 0; i
--) {
1809 * Returns true if the current rrec was sent in SSLv2 backwards compatible
1810 * format and false otherwise.
1812 int RECORD_LAYER_is_sslv2_record(RECORD_LAYER
*rl
)
1814 return SSL3_RECORD_is_sslv2_record(&rl
->rrec
[0]);
1818 * Returns the length in bytes of the current rrec
1820 size_t RECORD_LAYER_get_rrec_length(RECORD_LAYER
*rl
)
1822 return SSL3_RECORD_get_length(&rl
->rrec
[0]);