blob: 299be3278210026d3ba8a2597b48c77fbbba47e5 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Hanno Beckerccc13d02020-05-04 12:30:04 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
297 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100298
299static size_t ssl_compute_padding_length( size_t len,
300 size_t granularity )
301{
302 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
303}
304
Hanno Becker581bc1b2020-05-04 12:20:03 +0100305/* This functions transforms a (D)TLS plaintext fragment and a record content
306 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
307 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
308 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100309 *
310 * struct {
311 * opaque content[DTLSPlaintext.length];
312 * ContentType real_type;
313 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100314 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100315 *
316 * Input:
317 * - `content`: The beginning of the buffer holding the
318 * plaintext to be wrapped.
319 * - `*content_size`: The length of the plaintext in Bytes.
320 * - `max_len`: The number of Bytes available starting from
321 * `content`. This must be `>= *content_size`.
322 * - `rec_type`: The desired record content type.
323 *
324 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100325 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
326 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100327 *
328 * Returns:
329 * - `0` on success.
330 * - A negative error code if `max_len` didn't offer enough space
331 * for the expansion.
332 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333static int ssl_build_inner_plaintext( unsigned char *content,
334 size_t *content_size,
335 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100336 uint8_t rec_type,
337 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338{
339 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340
341 /* Write real content type */
342 if( remaining == 0 )
343 return( -1 );
344 content[ len ] = rec_type;
345 len++;
346 remaining--;
347
348 if( remaining < pad )
349 return( -1 );
350 memset( content + len, 0, pad );
351 len += pad;
352 remaining -= pad;
353
354 *content_size = len;
355 return( 0 );
356}
357
Hanno Becker581bc1b2020-05-04 12:20:03 +0100358/* This function parses a (D)TLSInnerPlaintext structure.
359 * See ssl_build_inner_plaintext() for details. */
360static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 size_t *content_size,
362 uint8_t *rec_type )
363{
364 size_t remaining = *content_size;
365
366 /* Determine length of padding by skipping zeroes from the back. */
367 do
368 {
369 if( remaining == 0 )
370 return( -1 );
371 remaining--;
372 } while( content[ remaining ] == 0 );
373
374 *content_size = remaining;
375 *rec_type = content[ remaining ];
376
377 return( 0 );
378}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
380 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100381
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100382/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100383 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000384static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100385 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100386 mbedtls_record *rec,
387 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000388{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100389 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100390 *
391 * additional_data = seq_num + TLSCompressed.type +
392 * TLSCompressed.version + TLSCompressed.length;
393 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100394 * For the CID extension, this is extended as follows
395 * (quoting draft-ietf-tls-dtls-connection-id-05,
396 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100397 *
398 * additional_data = seq_num + DTLSPlaintext.type +
399 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100400 * cid +
401 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100402 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100403 *
404 * For TLS 1.3, the record sequence number is dropped from the AAD
405 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100406 */
407
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100408 unsigned char *cur = add_data;
409
410#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
411 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
412#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
413 {
414 ((void) minor_ver);
415 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
416 cur += sizeof( rec->ctr );
417 }
418
419 *cur = rec->type;
420 cur++;
421
422 memcpy( cur, rec->ver, sizeof( rec->ver ) );
423 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100424
Hanno Beckera0e20d02019-05-15 14:03:01 +0100425#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100426 if( rec->cid_len != 0 )
427 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100428 memcpy( cur, rec->cid, rec->cid_len );
429 cur += rec->cid_len;
430
431 *cur = rec->cid_len;
432 cur++;
433
434 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
435 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
436 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100437 }
438 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100439#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100440 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100441 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
442 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
443 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100444 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100445
446 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000447}
448
Hanno Becker67a37db2020-05-28 16:27:07 +0100449#if defined(MBEDTLS_GCM_C) || \
450 defined(MBEDTLS_CCM_C) || \
451 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100452static int ssl_transform_aead_dynamic_iv_is_explicit(
453 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100454{
Hanno Becker17263802020-05-28 07:05:48 +0100455 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100456}
457
Hanno Becker17263802020-05-28 07:05:48 +0100458/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
459 *
460 * Concretely, this occurs in two variants:
461 *
462 * a) Fixed and dynamic IV lengths add up to total IV length, giving
463 * IV = fixed_iv || dynamic_iv
464 *
Hanno Becker15952812020-06-04 13:31:46 +0100465 * This variant is used in TLS 1.2 when used with GCM or CCM.
466 *
Hanno Becker17263802020-05-28 07:05:48 +0100467 * b) Fixed IV lengths matches total IV length, giving
468 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100469 *
470 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
471 *
472 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100473 *
474 * This function has the precondition that
475 *
476 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
477 *
478 * which has to be ensured by the caller. If this precondition
479 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100480 */
481static void ssl_build_record_nonce( unsigned char *dst_iv,
482 size_t dst_iv_len,
483 unsigned char const *fixed_iv,
484 size_t fixed_iv_len,
485 unsigned char const *dynamic_iv,
486 size_t dynamic_iv_len )
487{
488 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100489
490 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100491 memset( dst_iv, 0, dst_iv_len );
492 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100493
Hanno Becker17263802020-05-28 07:05:48 +0100494 dst_iv += dst_iv_len - dynamic_iv_len;
495 for( i = 0; i < dynamic_iv_len; i++ )
496 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100497}
Hanno Becker67a37db2020-05-28 16:27:07 +0100498#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100499
Hanno Beckera18d1322018-01-03 14:27:32 +0000500int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
501 mbedtls_ssl_transform *transform,
502 mbedtls_record *rec,
503 int (*f_rng)(void *, unsigned char *, size_t),
504 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000505{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100507 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000508 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100509 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100510 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000511 size_t post_avail;
512
513 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000514#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200515 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000516 ((void) ssl);
517#endif
518
519 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200520 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200521#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200522 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000523 ((void) f_rng);
524 ((void) p_rng);
525#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000526
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000528
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100530 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
532 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
533 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100534 if( rec == NULL
535 || rec->buf == NULL
536 || rec->buf_len < rec->data_offset
537 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100538#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100539 || rec->cid_len != 0
540#endif
541 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000542 {
543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100545 }
546
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000547 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100548 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 data, rec->data_len );
551
552 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
553
554 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
555 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000556 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
557 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000558 rec->data_len,
559 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000560 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
561 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100562
Hanno Becker92313402020-05-20 13:58:58 +0100563 /* The following two code paths implement the (D)TLSInnerPlaintext
564 * structure present in TLS 1.3 and DTLS 1.2 + CID.
565 *
566 * See ssl_build_inner_plaintext() for more information.
567 *
568 * Note that this changes `rec->data_len`, and hence
569 * `post_avail` needs to be recalculated afterwards.
570 *
571 * Note also that the two code paths cannot occur simultaneously
572 * since they apply to different versions of the protocol. There
573 * is hence no risk of double-addition of the inner plaintext.
574 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100575#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
576 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
577 {
Hanno Becker13996922020-05-28 16:15:19 +0100578 size_t padding =
579 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200580 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100581 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100582 &rec->data_len,
583 post_avail,
584 rec->type,
585 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100586 {
587 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
588 }
589
590 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
591 }
592#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
593
Hanno Beckera0e20d02019-05-15 14:03:01 +0100594#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100595 /*
596 * Add CID information
597 */
598 rec->cid_len = transform->out_cid_len;
599 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
600 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100601
602 if( rec->cid_len != 0 )
603 {
Hanno Becker13996922020-05-28 16:15:19 +0100604 size_t padding =
605 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200606 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100607 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100608 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100609 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100610 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100611 * Note that this changes `rec->data_len`, and hence
612 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100613 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100614 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100615 &rec->data_len,
616 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100617 rec->type,
618 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100619 {
620 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
621 }
622
623 rec->type = MBEDTLS_SSL_MSG_CID;
624 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100625#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100626
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100627 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
628
Paul Bakker5121ce52009-01-03 21:22:43 +0000629 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100630 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000631 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000632#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 if( mode == MBEDTLS_MODE_STREAM ||
634 ( mode == MBEDTLS_MODE_CBC
635#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000636 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100637#endif
638 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000639 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000640 if( post_avail < transform->maclen )
641 {
642 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200645#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200646 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000647
TRodziewicz345165c2021-07-06 13:42:11 +0200648 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
649 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000650
TRodziewicz345165c2021-07-06 13:42:11 +0200651 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
652 add_data_len );
653 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
654 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
655 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000656
TRodziewicz345165c2021-07-06 13:42:11 +0200657 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200658#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200659
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000660 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
661 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200662
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000663 rec->data_len += transform->maclen;
664 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100665 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200666 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000667#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000668
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200669 /*
670 * Encrypt
671 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000672#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000674 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000676 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000677 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678 "including %d bytes of padding",
679 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000680
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000681 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
682 transform->iv_enc, transform->ivlen,
683 data, rec->data_len,
684 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200687 return( ret );
688 }
689
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000690 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
693 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200694 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000695 }
Paul Bakker68884e32013-01-07 18:20:04 +0100696 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000697#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000698
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200699#if defined(MBEDTLS_GCM_C) || \
700 defined(MBEDTLS_CCM_C) || \
701 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200703 mode == MBEDTLS_MODE_CCM ||
704 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000705 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200707 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100708 unsigned char *dynamic_iv;
709 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100710 int dynamic_iv_is_explicit =
711 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000712
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100713 /* Check that there's space for the authentication tag. */
714 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 {
716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
717 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
718 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000719
Paul Bakker68884e32013-01-07 18:20:04 +0100720 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100721 * Build nonce for AEAD encryption.
722 *
723 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
724 * part of the IV is prepended to the ciphertext and
725 * can be chosen freely - in particular, it need not
726 * agree with the record sequence number.
727 * However, since ChaChaPoly as well as all AEAD modes
728 * in TLS 1.3 use the record sequence number as the
729 * dynamic part of the nonce, we uniformly use the
730 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100731 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100732 dynamic_iv = rec->ctr;
733 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200734
Hanno Becker17263802020-05-28 07:05:48 +0100735 ssl_build_record_nonce( iv, sizeof( iv ),
736 transform->iv_enc,
737 transform->fixed_ivlen,
738 dynamic_iv,
739 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100740
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100741 /*
742 * Build additional data for AEAD encryption.
743 * This depends on the TLS version.
744 */
745 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
746 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100747
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200748 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100749 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200750 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100751 dynamic_iv,
752 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100754 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000755 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200756 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000758
Paul Bakker68884e32013-01-07 18:20:04 +0100759 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200760 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200761 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000762
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100763 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000764 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100765 add_data, add_data_len,
766 data, rec->data_len, /* src */
767 data, rec->buf_len - (data - rec->buf), /* dst */
768 &rec->data_len,
769 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200770 {
TRodziewicz18efb732021-04-29 23:12:19 +0200771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200772 return( ret );
773 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000774 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100775 data + rec->data_len - transform->taglen,
776 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100777 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000778 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100779
780 /*
781 * Prefix record content with dynamic IV in case it is explicit.
782 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100783 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100784 {
785 if( rec->data_offset < dynamic_iv_len )
786 {
787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
788 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
789 }
790
791 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
792 rec->data_offset -= dynamic_iv_len;
793 rec->data_len += dynamic_iv_len;
794 }
795
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100796 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000797 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000798 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100799#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200800#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000802 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000803 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 size_t padlen, i;
805 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000806
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000807 /* Currently we're always using minimal padding
808 * (up to 255 bytes would be allowed). */
809 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
810 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000811 padlen = 0;
812
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000813 /* Check there's enough space in the buffer for the padding. */
814 if( post_avail < padlen + 1 )
815 {
816 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
817 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
818 }
819
Paul Bakker5121ce52009-01-03 21:22:43 +0000820 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000821 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000822
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000823 rec->data_len += padlen + 1;
824 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000825
TRodziewicz0f82ec62021-05-12 17:49:18 +0200826#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000827 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200828 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000829 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000830 */
TRodziewicz345165c2021-07-06 13:42:11 +0200831 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000832 {
TRodziewicz345165c2021-07-06 13:42:11 +0200833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
834 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000835 }
TRodziewicz345165c2021-07-06 13:42:11 +0200836
837 if( rec->data_offset < transform->ivlen )
838 {
839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
840 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
841 }
842
843 /*
844 * Generate IV
845 */
846 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
847 if( ret != 0 )
848 return( ret );
849
850 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200851#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000852
Paul Elliottd48d5c62021-01-07 14:47:05 +0000853 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
854 "including %" MBEDTLS_PRINTF_SIZET
855 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000856 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200857 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000858
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000859 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
860 transform->iv_enc,
861 transform->ivlen,
862 data, rec->data_len,
863 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200864 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200866 return( ret );
867 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200868
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000869 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
872 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200873 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200874
TRodziewicz0f82ec62021-05-12 17:49:18 +0200875 data -= transform->ivlen;
876 rec->data_offset -= transform->ivlen;
877 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100880 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100881 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000882 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
883
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100884 /*
885 * MAC(MAC_write_key, seq_num +
886 * TLSCipherText.type +
887 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100888 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200889 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100890 * ENC(content + padding + padding_length));
891 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892
893 if( post_avail < transform->maclen)
894 {
895 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
896 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
897 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100898
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100899 ssl_extract_add_data_from_record( add_data, &add_data_len,
900 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100904 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100905
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000906 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100907 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000908 mbedtls_md_hmac_update( &transform->md_ctx_enc,
909 data, rec->data_len );
910 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
911 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100912
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000913 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100914
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915 rec->data_len += transform->maclen;
916 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100917 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100918 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000920 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200921 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200922#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200923 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200926 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000927
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100928 /* Make extra sure authentication was performed, exactly once */
929 if( auth_done != 1 )
930 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
932 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100933 }
934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000936
937 return( 0 );
938}
939
Hanno Becker605949f2019-07-12 08:23:59 +0100940int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000941 mbedtls_ssl_transform *transform,
942 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000943{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000944 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000946 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000947#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100948 size_t padlen = 0, correct = 1;
949#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000950 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100951 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100952 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000953
Hanno Beckera18d1322018-01-03 14:27:32 +0000954#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200955 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000956 ((void) ssl);
957#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000960 if( rec == NULL ||
961 rec->buf == NULL ||
962 rec->buf_len < rec->data_offset ||
963 rec->buf_len - rec->data_offset < rec->data_len )
964 {
965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100967 }
968
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000969 data = rec->buf + rec->data_offset;
970 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000971
Hanno Beckera0e20d02019-05-15 14:03:01 +0100972#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100973 /*
974 * Match record's CID with incoming CID.
975 */
Hanno Becker938489a2019-05-08 13:02:22 +0100976 if( rec->cid_len != transform->in_cid_len ||
977 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
978 {
Hanno Becker8367ccc2019-05-14 11:30:10 +0100979 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +0100980 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100981#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100982
Hanno Beckerd086bf02021-03-22 13:01:27 +0000983#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +0100985 {
986 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000987 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
988 transform->iv_dec,
989 transform->ivlen,
990 data, rec->data_len,
991 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200994 return( ret );
995 }
996
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000997 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1000 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001001 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001002 }
Paul Bakker68884e32013-01-07 18:20:04 +01001003 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001004#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001005#if defined(MBEDTLS_GCM_C) || \
1006 defined(MBEDTLS_CCM_C) || \
1007 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001009 mode == MBEDTLS_MODE_CCM ||
1010 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001011 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001012 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001013 unsigned char *dynamic_iv;
1014 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001015
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001016 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001017 * Extract dynamic part of nonce for AEAD decryption.
1018 *
1019 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1020 * part of the IV is prepended to the ciphertext and
1021 * can be chosen freely - in particular, it need not
1022 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001023 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001024 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001025 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001026 {
1027 if( rec->data_len < dynamic_iv_len )
1028 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1030 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001031 rec->data_len,
1032 dynamic_iv_len ) );
1033 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1034 }
1035 dynamic_iv = data;
1036
1037 data += dynamic_iv_len;
1038 rec->data_offset += dynamic_iv_len;
1039 rec->data_len -= dynamic_iv_len;
1040 }
Hanno Becker17263802020-05-28 07:05:48 +01001041 else
1042 {
1043 dynamic_iv = rec->ctr;
1044 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001045
1046 /* Check that there's space for the authentication tag. */
1047 if( rec->data_len < transform->taglen )
1048 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001049 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1050 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001051 rec->data_len,
1052 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001054 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001055 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001056
Hanno Beckerdf8be222020-05-21 15:30:57 +01001057 /*
1058 * Prepare nonce from dynamic and static parts.
1059 */
Hanno Becker17263802020-05-28 07:05:48 +01001060 ssl_build_record_nonce( iv, sizeof( iv ),
1061 transform->iv_dec,
1062 transform->fixed_ivlen,
1063 dynamic_iv,
1064 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001065
Hanno Beckerdf8be222020-05-21 15:30:57 +01001066 /*
1067 * Build additional data for AEAD encryption.
1068 * This depends on the TLS version.
1069 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001070 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1071 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001072 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001073 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001074
Hanno Beckerd96a6522019-07-10 13:55:25 +01001075 /* Because of the check above, we know that there are
1076 * explicit_iv_len Bytes preceeding data, and taglen
1077 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001078 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001079 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001080
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001081 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001082 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001083 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001084
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001085 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001086 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001087 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001088 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001089 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001090 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001091 data, rec->data_len + transform->taglen, /* src */
1092 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001093 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001094 {
TRodziewicz18efb732021-04-29 23:12:19 +02001095 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1098 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001099
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001100 return( ret );
1101 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001102 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001103
Hanno Beckerd96a6522019-07-10 13:55:25 +01001104 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001105 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001109 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001110 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001111 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001113#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001115 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001116 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001117
Paul Bakker5121ce52009-01-03 21:22:43 +00001118 /*
Paul Bakker45829992013-01-03 14:52:21 +01001119 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001120 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001121#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001122 /* The ciphertext is prefixed with the CBC IV. */
1123 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001124#endif
Paul Bakker45829992013-01-03 14:52:21 +01001125
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001126 /* Size considerations:
1127 *
1128 * - The CBC cipher text must not be empty and hence
1129 * at least of size transform->ivlen.
1130 *
1131 * Together with the potential IV-prefix, this explains
1132 * the first of the two checks below.
1133 *
1134 * - The record must contain a MAC, either in plain or
1135 * encrypted, depending on whether Encrypt-then-MAC
1136 * is used or not.
1137 * - If it is, the message contains the IV-prefix,
1138 * the CBC ciphertext, and the MAC.
1139 * - If it is not, the padded plaintext, and hence
1140 * the CBC ciphertext, has at least length maclen + 1
1141 * because there is at least the padding length byte.
1142 *
1143 * As the CBC ciphertext is not empty, both cases give the
1144 * lower bound minlen + maclen + 1 on the record size, which
1145 * we test for in the second check below.
1146 */
1147 if( rec->data_len < minlen + transform->ivlen ||
1148 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001149 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1151 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1152 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001153 "+ 1 ) ( + expl IV )", rec->data_len,
1154 transform->ivlen,
1155 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001157 }
1158
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001159 /*
1160 * Authenticate before decrypt if enabled
1161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001163 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001164 {
Hanno Becker992b6872017-11-09 18:57:39 +00001165 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001168
Hanno Beckerd96a6522019-07-10 13:55:25 +01001169 /* Update data_len in tandem with add_data.
1170 *
1171 * The subtraction is safe because of the previous check
1172 * data_len >= minlen + maclen + 1.
1173 *
1174 * Afterwards, we know that data + data_len is followed by at
1175 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001176 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001177 *
1178 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001179 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001180 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1181 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001182
Hanno Beckerd96a6522019-07-10 13:55:25 +01001183 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001184 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1185 add_data_len );
1186 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1187 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001188 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1189 data, rec->data_len );
1190 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1191 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001192
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001193 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1194 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001195 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001196 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001197
Hanno Beckerd96a6522019-07-10 13:55:25 +01001198 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001199 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001200 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001204 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001205 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001206 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001208
1209 /*
1210 * Check length sanity
1211 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001212
1213 /* We know from above that data_len > minlen >= 0,
1214 * so the following check in particular implies that
1215 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001217 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001218 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1219 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001220 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001222 }
1223
TRodziewicz0f82ec62021-05-12 17:49:18 +02001224#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001225 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001226 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001227 */
TRodziewicz345165c2021-07-06 13:42:11 +02001228 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1229 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001230
TRodziewicz345165c2021-07-06 13:42:11 +02001231 data += transform->ivlen;
1232 rec->data_offset += transform->ivlen;
1233 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001234#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001235
Hanno Beckerd96a6522019-07-10 13:55:25 +01001236 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1237
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001238 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1239 transform->iv_dec, transform->ivlen,
1240 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001241 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001243 return( ret );
1244 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001245
Hanno Beckerd96a6522019-07-10 13:55:25 +01001246 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001247 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001248 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1250 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001251 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001252
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001253 /* Safe since data_len >= minlen + maclen + 1, so after having
1254 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001255 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1256 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001257 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001258
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001259 if( auth_done == 1 )
1260 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001261 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001262 rec->data_len,
1263 padlen + 1 );
1264 correct &= mask;
1265 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001266 }
1267 else
Paul Bakker45829992013-01-03 14:52:21 +01001268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001270 if( rec->data_len < transform->maclen + padlen + 1 )
1271 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1273 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1274 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 rec->data_len,
1276 transform->maclen,
1277 padlen + 1 ) );
1278 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001279#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001280
Gabor Mezei90437e32021-10-20 11:59:27 +02001281 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001282 rec->data_len,
1283 transform->maclen + padlen + 1 );
1284 correct &= mask;
1285 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001286 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001287
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001288 padlen++;
1289
1290 /* Regardless of the validity of the padding,
1291 * we have data_len >= padlen here. */
1292
TRodziewicz0f82ec62021-05-12 17:49:18 +02001293#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001294 /* The padding check involves a series of up to 256
1295 * consecutive memory reads at the end of the record
1296 * plaintext buffer. In order to hide the length and
1297 * validity of the padding, always perform exactly
1298 * `min(256,plaintext_len)` reads (but take into account
1299 * only the last `padlen` bytes for the padding check). */
1300 size_t pad_count = 0;
1301 volatile unsigned char* const check = data;
1302
1303 /* Index of first padding byte; it has been ensured above
1304 * that the subtraction is safe. */
1305 size_t const padding_idx = rec->data_len - padlen;
1306 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1307 size_t const start_idx = rec->data_len - num_checks;
1308 size_t idx;
1309
1310 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001311 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001312 /* pad_count += (idx >= padding_idx) &&
1313 * (check[idx] == padlen - 1);
1314 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001315 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1316 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001317 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001318 pad_count += mask & equal;
1319 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001320 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001323 if( padlen > 0 && correct == 0 )
1324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001325#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001326 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001327
TRodziewicz0f82ec62021-05-12 17:49:18 +02001328#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001329
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001330 /* If the padding was found to be invalid, padlen == 0
1331 * and the subtraction is safe. If the padding was found valid,
1332 * padlen hasn't been changed and the previous assertion
1333 * data_len >= padlen still holds. */
1334 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001335 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001336 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001337#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1340 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001341 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001342
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001343#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001345 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001346#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001347
1348 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001349 * Authenticate if not done yet.
1350 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001351 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001353 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001354 {
Hanno Becker992b6872017-11-09 18:57:39 +00001355 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001356 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001357
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001358 /* If the initial value of padlen was such that
1359 * data_len < maclen + padlen + 1, then padlen
1360 * got reset to 1, and the initial check
1361 * data_len >= minlen + maclen + 1
1362 * guarantees that at this point we still
1363 * have at least data_len >= maclen.
1364 *
1365 * If the initial value of padlen was such that
1366 * data_len >= maclen + padlen + 1, then we have
1367 * subtracted either padlen + 1 (if the padding was correct)
1368 * or 0 (if the padding was incorrect) since then,
1369 * hence data_len >= maclen in any case.
1370 */
1371 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001372 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1373 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374
TRodziewicz0f82ec62021-05-12 17:49:18 +02001375#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001376 /*
1377 * The next two sizes are the minimum and maximum values of
1378 * data_len over all padlen values.
1379 *
1380 * They're independent of padlen, since we previously did
1381 * data_len -= padlen.
1382 *
1383 * Note that max_len + maclen is never more than the buffer
1384 * length, as we previously did in_msglen -= maclen too.
1385 */
1386 const size_t max_len = rec->data_len + padlen;
1387 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1388
Gabor Mezei90437e32021-10-20 11:59:27 +02001389 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001390 add_data, add_data_len,
1391 data, rec->data_len, min_len, max_len,
1392 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001393 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001394 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001395 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001396 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001397 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001398
Gabor Mezei90437e32021-10-20 11:59:27 +02001399 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001400 rec->data_len,
1401 min_len, max_len,
1402 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001403#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001404
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001405#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001406 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001407 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001408#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001409
Gabor Mezei90437e32021-10-20 11:59:27 +02001410 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001411 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413#if defined(MBEDTLS_SSL_DEBUG_ALL)
1414 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001415#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001416 correct = 0;
1417 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001418 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001419 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001420
1421 /*
1422 * Finally check the correct flag
1423 */
1424 if( correct == 0 )
1425 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001426#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001427
1428 /* Make extra sure authentication was performed, exactly once */
1429 if( auth_done != 1 )
1430 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1432 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001433 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001434
Hanno Beckerccc13d02020-05-04 12:30:04 +01001435#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1436 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1437 {
1438 /* Remove inner padding and infer true content type. */
1439 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1440 &rec->type );
1441
1442 if( ret != 0 )
1443 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1444 }
1445#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1446
Hanno Beckera0e20d02019-05-15 14:03:01 +01001447#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001448 if( rec->cid_len != 0 )
1449 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001450 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1451 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001452 if( ret != 0 )
1453 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1454 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001455#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001458
1459 return( 0 );
1460}
1461
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001462#undef MAC_NONE
1463#undef MAC_PLAINTEXT
1464#undef MAC_CIPHERTEXT
1465
Paul Bakker5121ce52009-01-03 21:22:43 +00001466/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001467 * Fill the input message buffer by appending data to it.
1468 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001469 *
1470 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1471 * available (from this read and/or a previous one). Otherwise, an error code
1472 * is returned (possibly EOF or WANT_READ).
1473 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001474 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1475 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1476 * since we always read a whole datagram at once.
1477 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001478 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001479 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001482{
Janos Follath865b3eb2019-12-16 11:46:15 +00001483 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001484 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001485#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1486 size_t in_buf_len = ssl->in_buf_len;
1487#else
1488 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1489#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001492
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001493 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1494 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001496 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001498 }
1499
Darryl Greenb33cc762019-11-28 14:29:44 +00001500 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001501 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001504 }
1505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001507 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001508 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001509 uint32_t timeout;
1510
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001511 /*
1512 * The point is, we need to always read a full datagram at once, so we
1513 * sometimes read more then requested, and handle the additional data.
1514 * It could be the rest of the current record (while fetching the
1515 * header) and/or some other records in the same datagram.
1516 */
1517
1518 /*
1519 * Move to the next record in the already read datagram if applicable
1520 */
1521 if( ssl->next_record_offset != 0 )
1522 {
1523 if( ssl->in_left < ssl->next_record_offset )
1524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1526 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001527 }
1528
1529 ssl->in_left -= ssl->next_record_offset;
1530
1531 if( ssl->in_left != 0 )
1532 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001533 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1534 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001535 ssl->next_record_offset ) );
1536 memmove( ssl->in_hdr,
1537 ssl->in_hdr + ssl->next_record_offset,
1538 ssl->in_left );
1539 }
1540
1541 ssl->next_record_offset = 0;
1542 }
1543
Paul Elliottd48d5c62021-01-07 14:47:05 +00001544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1545 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001546 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001547
1548 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001549 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001550 */
1551 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001552 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001554 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001555 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001556
1557 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001558 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001559 * are not at the beginning of a new record, the caller did something
1560 * wrong.
1561 */
1562 if( ssl->in_left != 0 )
1563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001566 }
1567
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001568 /*
1569 * Don't even try to read if time's out already.
1570 * This avoids by-passing the timer when repeatedly receiving messages
1571 * that will end up being dropped.
1572 */
Hanno Becker7876d122020-02-05 10:39:31 +00001573 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001574 {
1575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001576 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001577 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001578 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001579 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001580 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001583 timeout = ssl->handshake->retransmit_timeout;
1584 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001585 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001586
Paul Elliott9f352112020-12-09 14:55:45 +00001587 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001588
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001589 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001590 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1591 timeout );
1592 else
1593 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001596
1597 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001599 }
1600
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001601 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001602 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001604 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001607 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001608 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1609 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001611 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001612 }
1613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001615 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001617 return( ret );
1618 }
1619
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001620 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001621 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001623 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001625 {
Hanno Becker786300f2020-02-05 10:46:40 +00001626 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001627 {
Hanno Becker786300f2020-02-05 10:46:40 +00001628 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1629 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001630 return( ret );
1631 }
1632
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001633 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001634 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001636 }
1637
Paul Bakker5121ce52009-01-03 21:22:43 +00001638 if( ret < 0 )
1639 return( ret );
1640
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001641 ssl->in_left = ret;
1642 }
1643 else
1644#endif
1645 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001646 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1647 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001648 ssl->in_left, nb_want ) );
1649
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001650 while( ssl->in_left < nb_want )
1651 {
1652 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001653
Hanno Becker7876d122020-02-05 10:39:31 +00001654 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001655 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1656 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001657 {
1658 if( ssl->f_recv_timeout != NULL )
1659 {
1660 ret = ssl->f_recv_timeout( ssl->p_bio,
1661 ssl->in_hdr + ssl->in_left, len,
1662 ssl->conf->read_timeout );
1663 }
1664 else
1665 {
1666 ret = ssl->f_recv( ssl->p_bio,
1667 ssl->in_hdr + ssl->in_left, len );
1668 }
1669 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001670
Paul Elliottd48d5c62021-01-07 14:47:05 +00001671 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1672 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001673 ssl->in_left, nb_want ) );
1674 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001675
1676 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001678
1679 if( ret < 0 )
1680 return( ret );
1681
makise-homuraaf9513b2020-08-24 18:26:27 +03001682 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001683 {
Darryl Green11999bb2018-03-13 15:22:58 +00001684 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001685 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001686 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1688 }
1689
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001690 ssl->in_left += ret;
1691 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001692 }
1693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001695
1696 return( 0 );
1697}
1698
1699/*
1700 * Flush any data not yet written
1701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001703{
Janos Follath865b3eb2019-12-16 11:46:15 +00001704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001705 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001708
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001709 if( ssl->f_send == NULL )
1710 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001712 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001714 }
1715
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001716 /* Avoid incrementing counter if data is flushed */
1717 if( ssl->out_left == 0 )
1718 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001720 return( 0 );
1721 }
1722
Paul Bakker5121ce52009-01-03 21:22:43 +00001723 while( ssl->out_left > 0 )
1724 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1726 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001727 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Hanno Becker2b1e3542018-08-06 11:19:13 +01001729 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001730 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
1734 if( ret <= 0 )
1735 return( ret );
1736
makise-homuraaf9513b2020-08-24 18:26:27 +03001737 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001738 {
Darryl Green11999bb2018-03-13 15:22:58 +00001739 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001740 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001741 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001742 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1743 }
1744
Paul Bakker5121ce52009-01-03 21:22:43 +00001745 ssl->out_left -= ret;
1746 }
1747
Hanno Becker2b1e3542018-08-06 11:19:13 +01001748#if defined(MBEDTLS_SSL_PROTO_DTLS)
1749 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001750 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001751 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001752 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001753 else
1754#endif
1755 {
1756 ssl->out_hdr = ssl->out_buf + 8;
1757 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001758 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001759
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001761
1762 return( 0 );
1763}
1764
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001765/*
1766 * Functions to handle the DTLS retransmission state machine
1767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001769/*
1770 * Append current handshake message to current outgoing flight
1771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001773{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1776 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1777 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001778
1779 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001780 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001781 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001784 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001785 }
1786
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001787 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001788 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1790 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001792 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001793 }
1794
1795 /* Copy current handshake message with headers */
1796 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1797 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001798 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001799 msg->next = NULL;
1800
1801 /* Append to the current flight */
1802 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001803 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001804 else
1805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001807 while( cur->next != NULL )
1808 cur = cur->next;
1809 cur->next = msg;
1810 }
1811
Hanno Becker3b235902018-08-06 09:54:53 +01001812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001813 return( 0 );
1814}
1815
1816/*
1817 * Free the current flight of handshake messages
1818 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001819void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001820{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 mbedtls_ssl_flight_item *cur = flight;
1822 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001823
1824 while( cur != NULL )
1825 {
1826 next = cur->next;
1827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 mbedtls_free( cur->p );
1829 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001830
1831 cur = next;
1832 }
1833}
1834
1835/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001836 * Swap transform_out and out_ctr with the alternative ones
1837 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001838static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001839{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001841 unsigned char tmp_out_ctr[8];
1842
1843 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1844 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001846 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001847 }
1848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001850
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001851 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001852 tmp_transform = ssl->transform_out;
1853 ssl->transform_out = ssl->handshake->alt_transform_out;
1854 ssl->handshake->alt_transform_out = tmp_transform;
1855
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001856 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01001857 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
1858 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001859 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001860
1861 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001862 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001863
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001864 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001865}
1866
1867/*
1868 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001869 */
1870int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1871{
1872 int ret = 0;
1873
1874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1875
1876 ret = mbedtls_ssl_flight_transmit( ssl );
1877
1878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1879
1880 return( ret );
1881}
1882
1883/*
1884 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001885 *
1886 * Need to remember the current message in case flush_output returns
1887 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001888 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001889 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001890int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001891{
Janos Follath865b3eb2019-12-16 11:46:15 +00001892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001896 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001898
1899 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001900 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001901 ret = ssl_swap_epochs( ssl );
1902 if( ret != 0 )
1903 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001906 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001907
1908 while( ssl->handshake->cur_msg != NULL )
1909 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001910 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001911 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001912
Hanno Beckere1dcb032018-08-17 16:47:58 +01001913 int const is_finished =
1914 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
1915 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
1916
Hanno Becker04da1892018-08-14 13:22:10 +01001917 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
1918 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
1919
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001920 /* Swap epochs before sending Finished: we can't do it after
1921 * sending ChangeCipherSpec, in case write returns WANT_READ.
1922 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01001923 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001924 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001926 ret = ssl_swap_epochs( ssl );
1927 if( ret != 0 )
1928 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001929 }
1930
Hanno Becker67bc7c32018-08-06 11:33:50 +01001931 ret = ssl_get_remaining_payload_in_datagram( ssl );
1932 if( ret < 0 )
1933 return( ret );
1934 max_frag_len = (size_t) ret;
1935
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001936 /* CCS is copied as is, while HS messages may need fragmentation */
1937 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
1938 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001939 if( max_frag_len == 0 )
1940 {
1941 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1942 return( ret );
1943
1944 continue;
1945 }
1946
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001947 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01001948 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001949 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001950
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001951 /* Update position inside current message */
1952 ssl->handshake->cur_msg_p += cur->len;
1953 }
1954 else
1955 {
1956 const unsigned char * const p = ssl->handshake->cur_msg_p;
1957 const size_t hs_len = cur->len - 12;
1958 const size_t frag_off = p - ( cur->p + 12 );
1959 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001960 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001961
Hanno Beckere1dcb032018-08-17 16:47:58 +01001962 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02001963 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01001964 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001965 {
1966 ret = ssl_swap_epochs( ssl );
1967 if( ret != 0 )
1968 return( ret );
1969 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001970
Hanno Becker67bc7c32018-08-06 11:33:50 +01001971 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1972 return( ret );
1973
1974 continue;
1975 }
1976 max_hs_frag_len = max_frag_len - 12;
1977
1978 cur_hs_frag_len = rem_len > max_hs_frag_len ?
1979 max_hs_frag_len : rem_len;
1980
1981 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001982 {
1983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01001984 (unsigned) cur_hs_frag_len,
1985 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001986 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02001987
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001988 /* Messages are stored with handshake headers as if not fragmented,
1989 * copy beginning of headers then fill fragmentation fields.
1990 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
1991 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001992
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001993 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
1994 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
1995 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
1996
Hanno Becker67bc7c32018-08-06 11:33:50 +01001997 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
1998 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
1999 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002000
2001 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2002
Hanno Becker3f7b9732018-08-28 09:53:25 +01002003 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002004 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2005 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002006 ssl->out_msgtype = cur->type;
2007
2008 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002009 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002010 }
2011
2012 /* If done with the current message move to the next one if any */
2013 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2014 {
2015 if( cur->next != NULL )
2016 {
2017 ssl->handshake->cur_msg = cur->next;
2018 ssl->handshake->cur_msg_p = cur->next->p + 12;
2019 }
2020 else
2021 {
2022 ssl->handshake->cur_msg = NULL;
2023 ssl->handshake->cur_msg_p = NULL;
2024 }
2025 }
2026
2027 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002028 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002029 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002031 return( ret );
2032 }
2033 }
2034
Hanno Becker67bc7c32018-08-06 11:33:50 +01002035 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2036 return( ret );
2037
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002038 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2040 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002041 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002042 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002044 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002045 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002046
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048
2049 return( 0 );
2050}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002051
2052/*
2053 * To be called when the last message of an incoming flight is received.
2054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002056{
2057 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002058 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002059 ssl->handshake->flight = NULL;
2060 ssl->handshake->cur_msg = NULL;
2061
2062 /* The next incoming flight will start with this msg_seq */
2063 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2064
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002065 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002066 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002067
Hanno Becker0271f962018-08-16 13:23:47 +01002068 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002069 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002070
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002071 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002072 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2075 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002076 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002078 }
2079 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002081}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002082
2083/*
2084 * To be called when the last message of an outgoing flight is send.
2085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002087{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002088 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002089 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2092 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002093 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002095 }
2096 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002098}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002100
Paul Bakker5121ce52009-01-03 21:22:43 +00002101/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002102 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002104
2105/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002106 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002107 *
2108 * - fill in handshake headers
2109 * - update handshake checksum
2110 * - DTLS: save message for resending
2111 * - then pass to the record layer
2112 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002113 * DTLS: except for HelloRequest, messages are only queued, and will only be
2114 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002115 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002116 * Inputs:
2117 * - ssl->out_msglen: 4 + actual handshake message len
2118 * (4 is the size of handshake headers for TLS)
2119 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2120 * - ssl->out_msg + 4: the handshake message body
2121 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002122 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002123 * - ssl->out_msglen: the length of the record contents
2124 * (including handshake headers but excluding record headers)
2125 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002126 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002127int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002128{
Janos Follath865b3eb2019-12-16 11:46:15 +00002129 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002130 const size_t hs_len = ssl->out_msglen - 4;
2131 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002132
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2134
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002135 /*
2136 * Sanity checks
2137 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002138 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002139 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2140 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2142 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002143 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002145 /* Whenever we send anything different from a
2146 * HelloRequest we should be in a handshake - double check. */
2147 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2148 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002149 ssl->handshake == NULL )
2150 {
2151 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2152 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2153 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002156 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2161 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002164
Hanno Beckerb50a2532018-08-06 11:52:54 +01002165 /* Double-check that we did not exceed the bounds
2166 * of the outgoing record buffer.
2167 * This should never fail as the various message
2168 * writing functions must obey the bounds of the
2169 * outgoing record buffer, but better be safe.
2170 *
2171 * Note: We deliberately do not check for the MTU or MFL here.
2172 */
2173 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2174 {
2175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002176 "size %" MBEDTLS_PRINTF_SIZET
2177 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002178 ssl->out_msglen,
2179 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2181 }
2182
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002183 /*
2184 * Fill handshake headers
2185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002187 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002188 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2189 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2190 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002191
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002192 /*
2193 * DTLS has additional fields in the Handshake layer,
2194 * between the length field and the actual payload:
2195 * uint16 message_seq;
2196 * uint24 fragment_offset;
2197 * uint24 fragment_length;
2198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002200 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002201 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002202 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002203 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002204 {
2205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002206 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002207 hs_len,
2208 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002209 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2210 }
2211
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002212 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002213 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002214
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002215 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002216 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002217 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002218 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2219 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2220 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002221 }
2222 else
2223 {
2224 ssl->out_msg[4] = 0;
2225 ssl->out_msg[5] = 0;
2226 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002227
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002228 /* Handshake hashes are computed without fragmentation,
2229 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002230 memset( ssl->out_msg + 6, 0x00, 3 );
2231 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002232 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002234
Hanno Becker0207e532018-08-28 10:28:28 +01002235 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002236 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2237 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 }
2239
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002240 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002242 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002243 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2244 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002245 {
2246 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2247 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249 return( ret );
2250 }
2251 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002252 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002253#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002254 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002255 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002256 {
2257 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2258 return( ret );
2259 }
2260 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002261
2262 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2263
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002264 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002265}
2266
2267/*
2268 * Record layer functions
2269 */
2270
2271/*
2272 * Write current record.
2273 *
2274 * Uses:
2275 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2276 * - ssl->out_msglen: length of the record content (excl headers)
2277 * - ssl->out_msg: record content
2278 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002279int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002280{
2281 int ret, done = 0;
2282 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002283 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002284
2285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002286
Paul Bakker05ef8352012-05-08 09:17:57 +00002287 if( !done )
2288 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002289 unsigned i;
2290 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002291#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2292 size_t out_buf_len = ssl->out_buf_len;
2293#else
2294 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2295#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002296 /* Skip writing the record content type to after the encryption,
2297 * as it may change when using the CID extension. */
2298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002300 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002301
Hanno Becker19859472018-08-06 09:40:20 +01002302 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002303 ssl->out_len[0] = (unsigned char)( len >> 8 );
2304 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002305
Paul Bakker48916f92012-09-16 19:57:18 +00002306 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002307 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002308 mbedtls_record rec;
2309
2310 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002311 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002312 rec.data_len = ssl->out_msglen;
2313 rec.data_offset = ssl->out_msg - rec.buf;
2314
2315 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2316 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2317 ssl->conf->transport, rec.ver );
2318 rec.type = ssl->out_msgtype;
2319
Hanno Beckera0e20d02019-05-15 14:03:01 +01002320#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002321 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002322 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002323#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002324
Hanno Beckera18d1322018-01-03 14:27:32 +00002325 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002326 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002329 return( ret );
2330 }
2331
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002332 if( rec.data_offset != 0 )
2333 {
2334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2335 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2336 }
2337
Hanno Becker6430faf2019-05-08 11:57:13 +01002338 /* Update the record content type and CID. */
2339 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002340#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002341 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002342#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002343 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002344 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2345 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002346 }
2347
Hanno Becker5903de42019-05-03 14:46:38 +01002348 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002349
2350#if defined(MBEDTLS_SSL_PROTO_DTLS)
2351 /* In case of DTLS, double-check that we don't exceed
2352 * the remaining space in the datagram. */
2353 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2354 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002355 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002356 if( ret < 0 )
2357 return( ret );
2358
2359 if( protected_record_size > (size_t) ret )
2360 {
2361 /* Should never happen */
2362 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2363 }
2364 }
2365#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002366
Hanno Becker6430faf2019-05-08 11:57:13 +01002367 /* Now write the potentially updated record content type. */
2368 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2369
Paul Elliott9f352112020-12-09 14:55:45 +00002370 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002371 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002372 ssl->out_hdr[0], ssl->out_hdr[1],
2373 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002376 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002377
2378 ssl->out_left += protected_record_size;
2379 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002380 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002381
Hanno Beckerdd772292020-02-05 10:38:31 +00002382 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002383 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2384 break;
2385
2386 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002387 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002388 {
2389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2390 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 }
2393
Hanno Becker67bc7c32018-08-06 11:33:50 +01002394#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002395 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2396 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002397 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002398 size_t remaining;
2399 ret = ssl_get_remaining_payload_in_datagram( ssl );
2400 if( ret < 0 )
2401 {
2402 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2403 ret );
2404 return( ret );
2405 }
2406
2407 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002408 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002409 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002410 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002411 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002412 else
2413 {
Hanno Becker513815a2018-08-20 11:56:09 +01002414 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002415 }
2416 }
2417#endif /* MBEDTLS_SSL_PROTO_DTLS */
2418
2419 if( ( flush == SSL_FORCE_FLUSH ) &&
2420 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002423 return( ret );
2424 }
2425
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002427
2428 return( 0 );
2429}
2430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002432
2433static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2434{
2435 if( ssl->in_msglen < ssl->in_hslen ||
2436 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2437 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2438 {
2439 return( 1 );
2440 }
2441 return( 0 );
2442}
Hanno Becker44650b72018-08-16 12:51:11 +01002443
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002444static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002445{
2446 return( ( ssl->in_msg[9] << 16 ) |
2447 ( ssl->in_msg[10] << 8 ) |
2448 ssl->in_msg[11] );
2449}
2450
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002451static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002452{
2453 return( ( ssl->in_msg[6] << 16 ) |
2454 ( ssl->in_msg[7] << 8 ) |
2455 ssl->in_msg[8] );
2456}
2457
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002458static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002459{
2460 uint32_t msg_len, frag_off, frag_len;
2461
2462 msg_len = ssl_get_hs_total_len( ssl );
2463 frag_off = ssl_get_hs_frag_off( ssl );
2464 frag_len = ssl_get_hs_frag_len( ssl );
2465
2466 if( frag_off > msg_len )
2467 return( -1 );
2468
2469 if( frag_len > msg_len - frag_off )
2470 return( -1 );
2471
2472 if( frag_len + 12 > ssl->in_msglen )
2473 return( -1 );
2474
2475 return( 0 );
2476}
2477
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002478/*
2479 * Mark bits in bitmask (used for DTLS HS reassembly)
2480 */
2481static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2482{
2483 unsigned int start_bits, end_bits;
2484
2485 start_bits = 8 - ( offset % 8 );
2486 if( start_bits != 8 )
2487 {
2488 size_t first_byte_idx = offset / 8;
2489
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002490 /* Special case */
2491 if( len <= start_bits )
2492 {
2493 for( ; len != 0; len-- )
2494 mask[first_byte_idx] |= 1 << ( start_bits - len );
2495
2496 /* Avoid potential issues with offset or len becoming invalid */
2497 return;
2498 }
2499
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002500 offset += start_bits; /* Now offset % 8 == 0 */
2501 len -= start_bits;
2502
2503 for( ; start_bits != 0; start_bits-- )
2504 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2505 }
2506
2507 end_bits = len % 8;
2508 if( end_bits != 0 )
2509 {
2510 size_t last_byte_idx = ( offset + len ) / 8;
2511
2512 len -= end_bits; /* Now len % 8 == 0 */
2513
2514 for( ; end_bits != 0; end_bits-- )
2515 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2516 }
2517
2518 memset( mask + offset / 8, 0xFF, len / 8 );
2519}
2520
2521/*
2522 * Check that bitmask is full
2523 */
2524static int ssl_bitmask_check( unsigned char *mask, size_t len )
2525{
2526 size_t i;
2527
2528 for( i = 0; i < len / 8; i++ )
2529 if( mask[i] != 0xFF )
2530 return( -1 );
2531
2532 for( i = 0; i < len % 8; i++ )
2533 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2534 return( -1 );
2535
2536 return( 0 );
2537}
2538
Hanno Becker56e205e2018-08-16 09:06:12 +01002539/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002540static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002541 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002542{
Hanno Becker56e205e2018-08-16 09:06:12 +01002543 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002544
Hanno Becker56e205e2018-08-16 09:06:12 +01002545 alloc_len = 12; /* Handshake header */
2546 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002547
Hanno Beckerd07df862018-08-16 09:14:58 +01002548 if( add_bitmap )
2549 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002550
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002551 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002552}
Hanno Becker56e205e2018-08-16 09:06:12 +01002553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002555
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002556static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002557{
2558 return( ( ssl->in_msg[1] << 16 ) |
2559 ( ssl->in_msg[2] << 8 ) |
2560 ssl->in_msg[3] );
2561}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002562
Simon Butcher99000142016-10-13 17:21:01 +01002563int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002564{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002566 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002567 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002568 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002570 }
2571
Hanno Becker12555c62018-08-16 12:47:53 +01002572 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002574 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002575 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002576 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002579 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002580 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002581 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002582 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002583
Hanno Becker44650b72018-08-16 12:51:11 +01002584 if( ssl_check_hs_header( ssl ) != 0 )
2585 {
2586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2587 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2588 }
2589
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002590 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002591 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2592 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2593 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2594 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002595 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002596 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2597 {
2598 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2599 recv_msg_seq,
2600 ssl->handshake->in_msg_seq ) );
2601 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2602 }
2603
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002604 /* Retransmit only on last message from previous flight, to avoid
2605 * too many retransmissions.
2606 * Besides, No sane server ever retransmits HelloVerifyRequest */
2607 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002609 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002611 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002612 recv_msg_seq,
2613 ssl->handshake->in_flight_start_seq ) );
2614
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002616 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002618 return( ret );
2619 }
2620 }
2621 else
2622 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002624 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002625 recv_msg_seq,
2626 ssl->handshake->in_msg_seq ) );
2627 }
2628
Hanno Becker90333da2017-10-10 11:27:13 +01002629 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002630 }
2631 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002632
Hanno Becker6d97ef52018-08-16 13:09:04 +01002633 /* Message reassembly is handled alongside buffering of future
2634 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002635 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002636 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002637 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002638 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002640 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002641 }
2642 }
2643 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002645 /* With TLS we don't handle fragmentation (for now) */
2646 if( ssl->in_msglen < ssl->in_hslen )
2647 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2649 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002650 }
2651
Simon Butcher99000142016-10-13 17:21:01 +01002652 return( 0 );
2653}
2654
2655void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2656{
Hanno Becker0271f962018-08-16 13:23:47 +01002657 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002658
Hanno Becker0271f962018-08-16 13:23:47 +01002659 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002660 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002661 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002662 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002663
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002664 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002666 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002667 ssl->handshake != NULL )
2668 {
Hanno Becker0271f962018-08-16 13:23:47 +01002669 unsigned offset;
2670 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002671
Hanno Becker0271f962018-08-16 13:23:47 +01002672 /* Increment handshake sequence number */
2673 hs->in_msg_seq++;
2674
2675 /*
2676 * Clear up handshake buffering and reassembly structure.
2677 */
2678
2679 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002680 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002681
2682 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002683 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2684 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002685 offset++, hs_buf++ )
2686 {
2687 *hs_buf = *(hs_buf + 1);
2688 }
2689
2690 /* Create a fresh last entry */
2691 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002692 }
2693#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002694}
2695
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002696/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002697 * DTLS anti-replay: RFC 6347 4.1.2.6
2698 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002699 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2700 * Bit n is set iff record number in_window_top - n has been seen.
2701 *
2702 * Usually, in_window_top is the last record number seen and the lsb of
2703 * in_window is set. The only exception is the initial state (record number 0
2704 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002706#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002707void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002708{
2709 ssl->in_window_top = 0;
2710 ssl->in_window = 0;
2711}
2712
2713static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2714{
2715 return( ( (uint64_t) buf[0] << 40 ) |
2716 ( (uint64_t) buf[1] << 32 ) |
2717 ( (uint64_t) buf[2] << 24 ) |
2718 ( (uint64_t) buf[3] << 16 ) |
2719 ( (uint64_t) buf[4] << 8 ) |
2720 ( (uint64_t) buf[5] ) );
2721}
2722
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002723static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2724{
Janos Follath865b3eb2019-12-16 11:46:15 +00002725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002726 unsigned char *original_in_ctr;
2727
2728 // save original in_ctr
2729 original_in_ctr = ssl->in_ctr;
2730
2731 // use counter from record
2732 ssl->in_ctr = record_in_ctr;
2733
2734 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2735
2736 // restore the counter
2737 ssl->in_ctr = original_in_ctr;
2738
2739 return ret;
2740}
2741
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002742/*
2743 * Return 0 if sequence number is acceptable, -1 otherwise
2744 */
Hanno Becker0183d692019-07-12 08:50:37 +01002745int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002746{
2747 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2748 uint64_t bit;
2749
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002750 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002751 return( 0 );
2752
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002753 if( rec_seqnum > ssl->in_window_top )
2754 return( 0 );
2755
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002756 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002757
2758 if( bit >= 64 )
2759 return( -1 );
2760
2761 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2762 return( -1 );
2763
2764 return( 0 );
2765}
2766
2767/*
2768 * Update replay window on new validated record
2769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002771{
2772 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2773
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002774 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002775 return;
2776
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002777 if( rec_seqnum > ssl->in_window_top )
2778 {
2779 /* Update window_top and the contents of the window */
2780 uint64_t shift = rec_seqnum - ssl->in_window_top;
2781
2782 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002783 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002784 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002785 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002786 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002787 ssl->in_window |= 1;
2788 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002789
2790 ssl->in_window_top = rec_seqnum;
2791 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002792 else
2793 {
2794 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002795 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002796
2797 if( bit < 64 ) /* Always true, but be extra sure */
2798 ssl->in_window |= (uint64_t) 1 << bit;
2799 }
2800}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002802
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002803#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002804/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002805 * Without any SSL context, check if a datagram looks like a ClientHello with
2806 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002807 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002808 *
2809 * - if cookie is valid, return 0
2810 * - if ClientHello looks superficially valid but cookie is not,
2811 * fill obuf and set olen, then
2812 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2813 * - otherwise return a specific error code
2814 */
2815static int ssl_check_dtls_clihlo_cookie(
2816 mbedtls_ssl_cookie_write_t *f_cookie_write,
2817 mbedtls_ssl_cookie_check_t *f_cookie_check,
2818 void *p_cookie,
2819 const unsigned char *cli_id, size_t cli_id_len,
2820 const unsigned char *in, size_t in_len,
2821 unsigned char *obuf, size_t buf_len, size_t *olen )
2822{
2823 size_t sid_len, cookie_len;
2824 unsigned char *p;
2825
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002826 /*
2827 * Structure of ClientHello with record and handshake headers,
2828 * and expected values. We don't need to check a lot, more checks will be
2829 * done when actually parsing the ClientHello - skipping those checks
2830 * avoids code duplication and does not make cookie forging any easier.
2831 *
2832 * 0-0 ContentType type; copied, must be handshake
2833 * 1-2 ProtocolVersion version; copied
2834 * 3-4 uint16 epoch; copied, must be 0
2835 * 5-10 uint48 sequence_number; copied
2836 * 11-12 uint16 length; (ignored)
2837 *
2838 * 13-13 HandshakeType msg_type; (ignored)
2839 * 14-16 uint24 length; (ignored)
2840 * 17-18 uint16 message_seq; copied
2841 * 19-21 uint24 fragment_offset; copied, must be 0
2842 * 22-24 uint24 fragment_length; (ignored)
2843 *
2844 * 25-26 ProtocolVersion client_version; (ignored)
2845 * 27-58 Random random; (ignored)
2846 * 59-xx SessionID session_id; 1 byte len + sid_len content
2847 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2848 * ...
2849 *
2850 * Minimum length is 61 bytes.
2851 */
2852 if( in_len < 61 ||
2853 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2854 in[3] != 0 || in[4] != 0 ||
2855 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2856 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002857 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002858 }
2859
2860 sid_len = in[59];
2861 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002862 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002863
2864 cookie_len = in[60 + sid_len];
2865 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002866 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002867
2868 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2869 cli_id, cli_id_len ) == 0 )
2870 {
2871 /* Valid cookie */
2872 return( 0 );
2873 }
2874
2875 /*
2876 * If we get here, we've got an invalid cookie, let's prepare HVR.
2877 *
2878 * 0-0 ContentType type; copied
2879 * 1-2 ProtocolVersion version; copied
2880 * 3-4 uint16 epoch; copied
2881 * 5-10 uint48 sequence_number; copied
2882 * 11-12 uint16 length; olen - 13
2883 *
2884 * 13-13 HandshakeType msg_type; hello_verify_request
2885 * 14-16 uint24 length; olen - 25
2886 * 17-18 uint16 message_seq; copied
2887 * 19-21 uint24 fragment_offset; copied
2888 * 22-24 uint24 fragment_length; olen - 25
2889 *
2890 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2891 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2892 *
2893 * Minimum length is 28.
2894 */
2895 if( buf_len < 28 )
2896 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2897
2898 /* Copy most fields and adapt others */
2899 memcpy( obuf, in, 25 );
2900 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2901 obuf[25] = 0xfe;
2902 obuf[26] = 0xff;
2903
2904 /* Generate and write actual cookie */
2905 p = obuf + 28;
2906 if( f_cookie_write( p_cookie,
2907 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
2908 {
2909 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2910 }
2911
2912 *olen = p - obuf;
2913
2914 /* Go back and fill length fields */
2915 obuf[27] = (unsigned char)( *olen - 28 );
2916
2917 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
2918 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
2919 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
2920
2921 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
2922 obuf[12] = (unsigned char)( ( *olen - 13 ) );
2923
2924 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
2925}
2926
2927/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002928 * Handle possible client reconnect with the same UDP quadruplet
2929 * (RFC 6347 Section 4.2.8).
2930 *
2931 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
2932 * that looks like a ClientHello.
2933 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002934 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002935 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002936 * - if the input looks like a ClientHello with a valid cookie,
2937 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02002938 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002939 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002940 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002941 * This function is called (through ssl_check_client_reconnect()) when an
2942 * unexpected record is found in ssl_get_next_record(), which will discard the
2943 * record if we return 0, and bubble up the return value otherwise (this
2944 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
2945 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002946 */
2947static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
2948{
Janos Follath865b3eb2019-12-16 11:46:15 +00002949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002950 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002951
Hanno Becker2fddd372019-07-10 14:37:41 +01002952 if( ssl->conf->f_cookie_write == NULL ||
2953 ssl->conf->f_cookie_check == NULL )
2954 {
2955 /* If we can't use cookies to verify reachability of the peer,
2956 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
2958 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01002959 return( 0 );
2960 }
2961
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002962 ret = ssl_check_dtls_clihlo_cookie(
2963 ssl->conf->f_cookie_write,
2964 ssl->conf->f_cookie_check,
2965 ssl->conf->p_cookie,
2966 ssl->cli_id, ssl->cli_id_len,
2967 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10002968 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002969
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002970 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
2971
2972 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002973 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002974 int send_ret;
2975 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
2976 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
2977 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08002978 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002979 * If the error is permanent we'll catch it later,
2980 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002981 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
2982 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
2983 (void) send_ret;
2984
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002985 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002986 }
2987
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002988 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002989 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02002990 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00002991 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002992 {
2993 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
2994 return( ret );
2995 }
2996
2997 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002998 }
2999
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003000 return( ret );
3001}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003002#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003003
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003004static int ssl_check_record_type( uint8_t record_type )
3005{
3006 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3007 record_type != MBEDTLS_SSL_MSG_ALERT &&
3008 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3009 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3010 {
3011 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3012 }
3013
3014 return( 0 );
3015}
3016
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003017/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003018 * ContentType type;
3019 * ProtocolVersion version;
3020 * uint16 epoch; // DTLS only
3021 * uint48 sequence_number; // DTLS only
3022 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003023 *
3024 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003025 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003026 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3027 *
3028 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003029 * 1. proceed with the record if this function returns 0
3030 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3031 * 3. return CLIENT_RECONNECT if this function return that value
3032 * 4. drop the whole datagram if this function returns anything else.
3033 * Point 2 is needed when the peer is resending, and we have already received
3034 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003035 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003036static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003037 unsigned char *buf,
3038 size_t len,
3039 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003040{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003041 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003042
Hanno Beckere5e7e782019-07-11 12:29:35 +01003043 size_t const rec_hdr_type_offset = 0;
3044 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003045
Hanno Beckere5e7e782019-07-11 12:29:35 +01003046 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3047 rec_hdr_type_len;
3048 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003049
Hanno Beckere5e7e782019-07-11 12:29:35 +01003050 size_t const rec_hdr_ctr_len = 8;
3051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003052 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003053 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3054 rec_hdr_version_len;
3055
Hanno Beckera0e20d02019-05-15 14:03:01 +01003056#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003057 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3058 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003059 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003060#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3061#endif /* MBEDTLS_SSL_PROTO_DTLS */
3062
3063 size_t rec_hdr_len_offset; /* To be determined */
3064 size_t const rec_hdr_len_len = 2;
3065
3066 /*
3067 * Check minimum lengths for record header.
3068 */
3069
3070#if defined(MBEDTLS_SSL_PROTO_DTLS)
3071 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3072 {
3073 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3074 }
3075 else
3076#endif /* MBEDTLS_SSL_PROTO_DTLS */
3077 {
3078 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3079 }
3080
3081 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3082 {
3083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3084 (unsigned) len,
3085 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3086 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3087 }
3088
3089 /*
3090 * Parse and validate record content type
3091 */
3092
3093 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003094
3095 /* Check record content type */
3096#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3097 rec->cid_len = 0;
3098
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003099 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003100 ssl->conf->cid_len != 0 &&
3101 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003102 {
3103 /* Shift pointers to account for record header including CID
3104 * struct {
3105 * ContentType special_type = tls12_cid;
3106 * ProtocolVersion version;
3107 * uint16 epoch;
3108 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003109 * opaque cid[cid_length]; // Additional field compared to
3110 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003111 * uint16 length;
3112 * opaque enc_content[DTLSCiphertext.length];
3113 * } DTLSCiphertext;
3114 */
3115
3116 /* So far, we only support static CID lengths
3117 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003118 rec_hdr_cid_len = ssl->conf->cid_len;
3119 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003120
Hanno Beckere5e7e782019-07-11 12:29:35 +01003121 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003122 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3124 (unsigned) len,
3125 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003126 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003127 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003128
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003129 /* configured CID len is guaranteed at most 255, see
3130 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3131 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003132 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003133 }
3134 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003135#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003136 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003137 if( ssl_check_record_type( rec->type ) )
3138 {
Hanno Becker54229812019-07-12 14:40:00 +01003139 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3140 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003141 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3142 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003143 }
3144
Hanno Beckere5e7e782019-07-11 12:29:35 +01003145 /*
3146 * Parse and validate record version
3147 */
3148
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003149 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3150 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003151 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3152 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003153 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003154
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003155 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003156 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003157 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3158 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003159 }
3160
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003161 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3164 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003165 }
3166
Hanno Beckere5e7e782019-07-11 12:29:35 +01003167 /*
3168 * Parse/Copy record sequence number.
3169 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003170
Hanno Beckere5e7e782019-07-11 12:29:35 +01003171#if defined(MBEDTLS_SSL_PROTO_DTLS)
3172 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003173 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003174 /* Copy explicit record sequence number from input buffer. */
3175 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3176 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003177 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003178 else
3179#endif /* MBEDTLS_SSL_PROTO_DTLS */
3180 {
3181 /* Copy implicit record sequence number from SSL context structure. */
3182 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3183 }
Paul Bakker40e46942009-01-03 21:51:57 +00003184
Hanno Beckere5e7e782019-07-11 12:29:35 +01003185 /*
3186 * Parse record length.
3187 */
3188
Hanno Beckere5e7e782019-07-11 12:29:35 +01003189 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003190 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3191 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003192 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003193
Paul Elliott9f352112020-12-09 14:55:45 +00003194 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003195 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003196 rec->type,
3197 major_ver, minor_ver, rec->data_len ) );
3198
3199 rec->buf = buf;
3200 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003201
Hanno Beckerd417cc92019-07-26 08:20:27 +01003202 if( rec->data_len == 0 )
3203 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003204
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003205 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003206 * DTLS-related tests.
3207 * Check epoch before checking length constraint because
3208 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3209 * message gets duplicated before the corresponding Finished message,
3210 * the second ChangeCipherSpec should be discarded because it belongs
3211 * to an old epoch, but not because its length is shorter than
3212 * the minimum record length for packets using the new record transform.
3213 * Note that these two kinds of failures are handled differently,
3214 * as an unexpected record is silently skipped but an invalid
3215 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003216 */
3217#if defined(MBEDTLS_SSL_PROTO_DTLS)
3218 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3219 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003220 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003221
Hanno Becker955a5c92019-07-10 17:12:07 +01003222 /* Check that the datagram is large enough to contain a record
3223 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003224 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003225 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003226 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3227 (unsigned) len,
3228 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003229 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3230 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003231
Hanno Becker37cfe732019-07-10 17:20:01 +01003232 /* Records from other, non-matching epochs are silently discarded.
3233 * (The case of same-port Client reconnects must be considered in
3234 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003235 if( rec_epoch != ssl->in_epoch )
3236 {
3237 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003238 "expected %u, received %lu",
3239 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003240
Hanno Becker552f7472019-07-19 10:59:12 +01003241 /* Records from the next epoch are considered for buffering
3242 * (concretely: early Finished messages). */
3243 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003244 {
Hanno Becker552f7472019-07-19 10:59:12 +01003245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3246 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003247 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003248
Hanno Becker2fddd372019-07-10 14:37:41 +01003249 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003250 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003251#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003252 /* For records from the correct epoch, check whether their
3253 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003254 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3255 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003256 {
3257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3258 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3259 }
3260#endif
3261 }
3262#endif /* MBEDTLS_SSL_PROTO_DTLS */
3263
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003264 return( 0 );
3265}
Paul Bakker5121ce52009-01-03 21:22:43 +00003266
Paul Bakker5121ce52009-01-03 21:22:43 +00003267
Hanno Becker2fddd372019-07-10 14:37:41 +01003268#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3269static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3270{
3271 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3272
3273 /*
3274 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3275 * access the first byte of record content (handshake type), as we
3276 * have an active transform (possibly iv_len != 0), so use the
3277 * fact that the record header len is 13 instead.
3278 */
3279 if( rec_epoch == 0 &&
3280 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3281 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3282 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3283 ssl->in_left > 13 &&
3284 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3285 {
3286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3287 "from the same port" ) );
3288 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003289 }
3290
3291 return( 0 );
3292}
Hanno Becker2fddd372019-07-10 14:37:41 +01003293#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003294
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003295/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003296 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003297 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003298static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3299 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003300{
3301 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003304 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003305
Paul Bakker48916f92012-09-16 19:57:18 +00003306 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003307 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003308 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003309
Hanno Beckera18d1322018-01-03 14:27:32 +00003310 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003311 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003314
Hanno Beckera0e20d02019-05-15 14:03:01 +01003315#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003316 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3317 ssl->conf->ignore_unexpected_cid
3318 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3319 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003320 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003321 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003322 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003323#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003324
Paul Bakker5121ce52009-01-03 21:22:43 +00003325 return( ret );
3326 }
3327
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003328 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003329 {
3330 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003331 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003332 }
3333
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003334 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003335 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003336
Hanno Beckera0e20d02019-05-15 14:03:01 +01003337#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003338 /* We have already checked the record content type
3339 * in ssl_parse_record_header(), failing or silently
3340 * dropping the record in the case of an unknown type.
3341 *
3342 * Since with the use of CIDs, the record content type
3343 * might change during decryption, re-check the record
3344 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003345 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003346 {
3347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3348 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3349 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003350#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003351
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003352 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003353 {
3354#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3355 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003356 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003357 {
3358 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3359 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3360 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3361 }
3362#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3363
3364 ssl->nb_zero++;
3365
3366 /*
3367 * Three or more empty messages may be a DoS attack
3368 * (excessive CPU consumption).
3369 */
3370 if( ssl->nb_zero > 3 )
3371 {
3372 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003373 "messages, possible DoS attack" ) );
3374 /* Treat the records as if they were not properly authenticated,
3375 * thereby failing the connection if we see more than allowed
3376 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003377 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3378 }
3379 }
3380 else
3381 ssl->nb_zero = 0;
3382
3383#if defined(MBEDTLS_SSL_PROTO_DTLS)
3384 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3385 {
3386 ; /* in_ctr read from peer, not maintained internally */
3387 }
3388 else
3389#endif
3390 {
3391 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003392 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003393 if( ++ssl->in_ctr[i - 1] != 0 )
3394 break;
3395
3396 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003397 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003398 {
3399 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3400 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3401 }
3402 }
3403
Paul Bakker5121ce52009-01-03 21:22:43 +00003404 }
3405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003407 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003408 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003410 }
3411#endif
3412
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003413 /* Check actual (decrypted) record content length against
3414 * configured maximum. */
3415 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3416 {
3417 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3418 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3419 }
3420
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003421 return( 0 );
3422}
3423
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003424/*
3425 * Read a record.
3426 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003427 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3428 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3429 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003430 */
Hanno Becker1097b342018-08-15 14:09:41 +01003431
3432/* Helper functions for mbedtls_ssl_read_record(). */
3433static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003434static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3435static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003436
Hanno Becker327c93b2018-08-15 13:56:18 +01003437int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003438 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003439{
Janos Follath865b3eb2019-12-16 11:46:15 +00003440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003443
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003444 if( ssl->keep_current_message == 0 )
3445 {
3446 do {
Simon Butcher99000142016-10-13 17:21:01 +01003447
Hanno Becker26994592018-08-15 14:14:59 +01003448 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003449 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003450 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003451
Hanno Beckere74d5562018-08-15 14:26:08 +01003452 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003453 {
Hanno Becker40f50842018-08-15 14:48:01 +01003454#if defined(MBEDTLS_SSL_PROTO_DTLS)
3455 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003456
Hanno Becker40f50842018-08-15 14:48:01 +01003457 /* We only check for buffered messages if the
3458 * current datagram is fully consumed. */
3459 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003460 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003461 {
Hanno Becker40f50842018-08-15 14:48:01 +01003462 if( ssl_load_buffered_message( ssl ) == 0 )
3463 have_buffered = 1;
3464 }
3465
3466 if( have_buffered == 0 )
3467#endif /* MBEDTLS_SSL_PROTO_DTLS */
3468 {
3469 ret = ssl_get_next_record( ssl );
3470 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3471 continue;
3472
3473 if( ret != 0 )
3474 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003475 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003476 return( ret );
3477 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003478 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003479 }
3480
3481 ret = mbedtls_ssl_handle_message_type( ssl );
3482
Hanno Becker40f50842018-08-15 14:48:01 +01003483#if defined(MBEDTLS_SSL_PROTO_DTLS)
3484 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3485 {
3486 /* Buffer future message */
3487 ret = ssl_buffer_message( ssl );
3488 if( ret != 0 )
3489 return( ret );
3490
3491 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3492 }
3493#endif /* MBEDTLS_SSL_PROTO_DTLS */
3494
Hanno Becker90333da2017-10-10 11:27:13 +01003495 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3496 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003497
3498 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003499 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003500 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003501 return( ret );
3502 }
3503
Hanno Becker327c93b2018-08-15 13:56:18 +01003504 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003505 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003506 {
3507 mbedtls_ssl_update_handshake_status( ssl );
3508 }
Simon Butcher99000142016-10-13 17:21:01 +01003509 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003510 else
Simon Butcher99000142016-10-13 17:21:01 +01003511 {
Hanno Becker02f59072018-08-15 14:00:24 +01003512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003513 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003514 }
3515
3516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3517
3518 return( 0 );
3519}
3520
Hanno Becker40f50842018-08-15 14:48:01 +01003521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003522static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003523{
Hanno Becker40f50842018-08-15 14:48:01 +01003524 if( ssl->in_left > ssl->next_record_offset )
3525 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003526
Hanno Becker40f50842018-08-15 14:48:01 +01003527 return( 0 );
3528}
3529
3530static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3531{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003532 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003533 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003534 int ret = 0;
3535
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003536 if( hs == NULL )
3537 return( -1 );
3538
Hanno Beckere00ae372018-08-20 09:39:42 +01003539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3540
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003541 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3542 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3543 {
3544 /* Check if we have seen a ChangeCipherSpec before.
3545 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003546 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003547 {
3548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3549 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003550 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003551 }
3552
Hanno Becker39b8bc92018-08-28 17:17:13 +01003553 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003554 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3555 ssl->in_msglen = 1;
3556 ssl->in_msg[0] = 1;
3557
3558 /* As long as they are equal, the exact value doesn't matter. */
3559 ssl->in_left = 0;
3560 ssl->next_record_offset = 0;
3561
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003562 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003563 goto exit;
3564 }
Hanno Becker37f95322018-08-16 13:55:32 +01003565
Hanno Beckerb8f50142018-08-28 10:01:34 +01003566#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003567 /* Debug only */
3568 {
3569 unsigned offset;
3570 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3571 {
3572 hs_buf = &hs->buffering.hs[offset];
3573 if( hs_buf->is_valid == 1 )
3574 {
3575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3576 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003577 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003578 }
3579 }
3580 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003581#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003582
3583 /* Check if we have buffered and/or fully reassembled the
3584 * next handshake message. */
3585 hs_buf = &hs->buffering.hs[0];
3586 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3587 {
3588 /* Synthesize a record containing the buffered HS message. */
3589 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3590 ( hs_buf->data[2] << 8 ) |
3591 hs_buf->data[3];
3592
3593 /* Double-check that we haven't accidentally buffered
3594 * a message that doesn't fit into the input buffer. */
3595 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3596 {
3597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3598 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3599 }
3600
3601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3602 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3603 hs_buf->data, msg_len + 12 );
3604
3605 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3606 ssl->in_hslen = msg_len + 12;
3607 ssl->in_msglen = msg_len + 12;
3608 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3609
3610 ret = 0;
3611 goto exit;
3612 }
3613 else
3614 {
3615 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3616 hs->in_msg_seq ) );
3617 }
3618
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003619 ret = -1;
3620
3621exit:
3622
3623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3624 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003625}
3626
Hanno Beckera02b0b42018-08-21 17:20:27 +01003627static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3628 size_t desired )
3629{
3630 int offset;
3631 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3633 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003634
Hanno Becker01315ea2018-08-21 17:22:17 +01003635 /* Get rid of future records epoch first, if such exist. */
3636 ssl_free_buffered_record( ssl );
3637
3638 /* Check if we have enough space available now. */
3639 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3640 hs->buffering.total_bytes_buffered ) )
3641 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003643 return( 0 );
3644 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003645
Hanno Becker4f432ad2018-08-28 10:02:32 +01003646 /* We don't have enough space to buffer the next expected handshake
3647 * message. Remove buffers used for future messages to gain space,
3648 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003649 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3650 offset >= 0; offset-- )
3651 {
3652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3653 offset ) );
3654
Hanno Beckerb309b922018-08-23 13:18:05 +01003655 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003656
3657 /* Check if we have enough space available now. */
3658 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3659 hs->buffering.total_bytes_buffered ) )
3660 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003662 return( 0 );
3663 }
3664 }
3665
3666 return( -1 );
3667}
3668
Hanno Becker40f50842018-08-15 14:48:01 +01003669static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3670{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003671 int ret = 0;
3672 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3673
3674 if( hs == NULL )
3675 return( 0 );
3676
3677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3678
3679 switch( ssl->in_msgtype )
3680 {
3681 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003683
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003684 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003685 break;
3686
3687 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003688 {
3689 unsigned recv_msg_seq_offset;
3690 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3691 mbedtls_ssl_hs_buffer *hs_buf;
3692 size_t msg_len = ssl->in_hslen - 12;
3693
3694 /* We should never receive an old handshake
3695 * message - double-check nonetheless. */
3696 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3697 {
3698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3699 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3700 }
3701
3702 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3703 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3704 {
3705 /* Silently ignore -- message too far in the future */
3706 MBEDTLS_SSL_DEBUG_MSG( 2,
3707 ( "Ignore future HS message with sequence number %u, "
3708 "buffering window %u - %u",
3709 recv_msg_seq, ssl->handshake->in_msg_seq,
3710 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3711
3712 goto exit;
3713 }
3714
3715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3716 recv_msg_seq, recv_msg_seq_offset ) );
3717
3718 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3719
3720 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003721 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003722 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003723 size_t reassembly_buf_sz;
3724
Hanno Becker37f95322018-08-16 13:55:32 +01003725 hs_buf->is_fragmented =
3726 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3727
3728 /* We copy the message back into the input buffer
3729 * after reassembly, so check that it's not too large.
3730 * This is an implementation-specific limitation
3731 * and not one from the standard, hence it is not
3732 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003733 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003734 {
3735 /* Ignore message */
3736 goto exit;
3737 }
3738
Hanno Beckere0b150f2018-08-21 15:51:03 +01003739 /* Check if we have enough space to buffer the message. */
3740 if( hs->buffering.total_bytes_buffered >
3741 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3742 {
3743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3744 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3745 }
3746
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003747 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3748 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003749
3750 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3751 hs->buffering.total_bytes_buffered ) )
3752 {
3753 if( recv_msg_seq_offset > 0 )
3754 {
3755 /* If we can't buffer a future message because
3756 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003757 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3758 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3759 " (already %" MBEDTLS_PRINTF_SIZET
3760 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003761 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003762 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003763 goto exit;
3764 }
Hanno Beckere1801392018-08-21 16:51:05 +01003765 else
3766 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3768 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3769 " (already %" MBEDTLS_PRINTF_SIZET
3770 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003771 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003772 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003773 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003774
Hanno Beckera02b0b42018-08-21 17:20:27 +01003775 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003776 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3778 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3779 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3780 " (already %" MBEDTLS_PRINTF_SIZET
3781 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003782 msg_len,
3783 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003784 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003785 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003786 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3787 goto exit;
3788 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003789 }
3790
Paul Elliottd48d5c62021-01-07 14:47:05 +00003791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003792 msg_len ) );
3793
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003794 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3795 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003796 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003797 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003798 goto exit;
3799 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003800 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003801
3802 /* Prepare final header: copy msg_type, length and message_seq,
3803 * then add standardised fragment_offset and fragment_length */
3804 memcpy( hs_buf->data, ssl->in_msg, 6 );
3805 memset( hs_buf->data + 6, 0, 3 );
3806 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3807
3808 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003809
3810 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003811 }
3812 else
3813 {
3814 /* Make sure msg_type and length are consistent */
3815 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3816 {
3817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3818 /* Ignore */
3819 goto exit;
3820 }
3821 }
3822
Hanno Becker4422bbb2018-08-20 09:40:19 +01003823 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003824 {
3825 size_t frag_len, frag_off;
3826 unsigned char * const msg = hs_buf->data + 12;
3827
3828 /*
3829 * Check and copy current fragment
3830 */
3831
3832 /* Validation of header fields already done in
3833 * mbedtls_ssl_prepare_handshake_record(). */
3834 frag_off = ssl_get_hs_frag_off( ssl );
3835 frag_len = ssl_get_hs_frag_len( ssl );
3836
Paul Elliottd48d5c62021-01-07 14:47:05 +00003837 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3838 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003839 frag_off, frag_len ) );
3840 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3841
3842 if( hs_buf->is_fragmented )
3843 {
3844 unsigned char * const bitmask = msg + msg_len;
3845 ssl_bitmask_set( bitmask, frag_off, frag_len );
3846 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3847 msg_len ) == 0 );
3848 }
3849 else
3850 {
3851 hs_buf->is_complete = 1;
3852 }
3853
3854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3855 hs_buf->is_complete ? "" : "not yet " ) );
3856 }
3857
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003858 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003859 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003860
3861 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003862 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003863 break;
3864 }
3865
3866exit:
3867
3868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3869 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003870}
3871#endif /* MBEDTLS_SSL_PROTO_DTLS */
3872
Hanno Becker1097b342018-08-15 14:09:41 +01003873static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003874{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003875 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003876 * Consume last content-layer message and potentially
3877 * update in_msglen which keeps track of the contents'
3878 * consumption state.
3879 *
3880 * (1) Handshake messages:
3881 * Remove last handshake message, move content
3882 * and adapt in_msglen.
3883 *
3884 * (2) Alert messages:
3885 * Consume whole record content, in_msglen = 0.
3886 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003887 * (3) Change cipher spec:
3888 * Consume whole record content, in_msglen = 0.
3889 *
3890 * (4) Application data:
3891 * Don't do anything - the record layer provides
3892 * the application data as a stream transport
3893 * and consumes through mbedtls_ssl_read only.
3894 *
3895 */
3896
3897 /* Case (1): Handshake messages */
3898 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003899 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003900 /* Hard assertion to be sure that no application data
3901 * is in flight, as corrupting ssl->in_msglen during
3902 * ssl->in_offt != NULL is fatal. */
3903 if( ssl->in_offt != NULL )
3904 {
3905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3906 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3907 }
3908
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003909 /*
3910 * Get next Handshake message in the current record
3911 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003912
Hanno Becker4a810fb2017-05-24 16:27:30 +01003913 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01003914 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01003915 * current handshake content: If DTLS handshake
3916 * fragmentation is used, that's the fragment
3917 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01003918 * size here is faulty and should be changed at
3919 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003920 * (2) While it doesn't seem to cause problems, one
3921 * has to be very careful not to assume that in_hslen
3922 * is always <= in_msglen in a sensible communication.
3923 * Again, it's wrong for DTLS handshake fragmentation.
3924 * The following check is therefore mandatory, and
3925 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003926 * Additionally, ssl->in_hslen might be arbitrarily out of
3927 * bounds after handling a DTLS message with an unexpected
3928 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003929 */
3930 if( ssl->in_hslen < ssl->in_msglen )
3931 {
3932 ssl->in_msglen -= ssl->in_hslen;
3933 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
3934 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003935
Hanno Becker4a810fb2017-05-24 16:27:30 +01003936 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
3937 ssl->in_msg, ssl->in_msglen );
3938 }
3939 else
3940 {
3941 ssl->in_msglen = 0;
3942 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02003943
Hanno Becker4a810fb2017-05-24 16:27:30 +01003944 ssl->in_hslen = 0;
3945 }
3946 /* Case (4): Application data */
3947 else if( ssl->in_offt != NULL )
3948 {
3949 return( 0 );
3950 }
3951 /* Everything else (CCS & Alerts) */
3952 else
3953 {
3954 ssl->in_msglen = 0;
3955 }
3956
Hanno Becker1097b342018-08-15 14:09:41 +01003957 return( 0 );
3958}
Hanno Becker4a810fb2017-05-24 16:27:30 +01003959
Hanno Beckere74d5562018-08-15 14:26:08 +01003960static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
3961{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003962 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003963 return( 1 );
3964
3965 return( 0 );
3966}
3967
Hanno Becker5f066e72018-08-16 14:56:31 +01003968#if defined(MBEDTLS_SSL_PROTO_DTLS)
3969
3970static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
3971{
3972 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3973 if( hs == NULL )
3974 return;
3975
Hanno Becker01315ea2018-08-21 17:22:17 +01003976 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01003977 {
Hanno Becker01315ea2018-08-21 17:22:17 +01003978 hs->buffering.total_bytes_buffered -=
3979 hs->buffering.future_record.len;
3980
3981 mbedtls_free( hs->buffering.future_record.data );
3982 hs->buffering.future_record.data = NULL;
3983 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003984}
3985
3986static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
3987{
3988 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3989 unsigned char * rec;
3990 size_t rec_len;
3991 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00003992#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3993 size_t in_buf_len = ssl->in_buf_len;
3994#else
3995 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3996#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01003997 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3998 return( 0 );
3999
4000 if( hs == NULL )
4001 return( 0 );
4002
Hanno Becker5f066e72018-08-16 14:56:31 +01004003 rec = hs->buffering.future_record.data;
4004 rec_len = hs->buffering.future_record.len;
4005 rec_epoch = hs->buffering.future_record.epoch;
4006
4007 if( rec == NULL )
4008 return( 0 );
4009
Hanno Becker4cb782d2018-08-20 11:19:05 +01004010 /* Only consider loading future records if the
4011 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004012 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004013 return( 0 );
4014
Hanno Becker5f066e72018-08-16 14:56:31 +01004015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4016
4017 if( rec_epoch != ssl->in_epoch )
4018 {
4019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4020 goto exit;
4021 }
4022
4023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4024
4025 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004026 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004027 {
4028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4029 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4030 }
4031
4032 memcpy( ssl->in_hdr, rec, rec_len );
4033 ssl->in_left = rec_len;
4034 ssl->next_record_offset = 0;
4035
4036 ssl_free_buffered_record( ssl );
4037
4038exit:
4039 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4040 return( 0 );
4041}
4042
Hanno Becker519f15d2019-07-11 12:43:20 +01004043static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4044 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004045{
4046 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004047
4048 /* Don't buffer future records outside handshakes. */
4049 if( hs == NULL )
4050 return( 0 );
4051
4052 /* Only buffer handshake records (we are only interested
4053 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004054 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004055 return( 0 );
4056
4057 /* Don't buffer more than one future epoch record. */
4058 if( hs->buffering.future_record.data != NULL )
4059 return( 0 );
4060
Hanno Becker01315ea2018-08-21 17:22:17 +01004061 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004062 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004063 hs->buffering.total_bytes_buffered ) )
4064 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4066 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4067 " (already %" MBEDTLS_PRINTF_SIZET
4068 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004069 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004070 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004071 return( 0 );
4072 }
4073
Hanno Becker5f066e72018-08-16 14:56:31 +01004074 /* Buffer record */
4075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004076 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004077 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004078
4079 /* ssl_parse_record_header() only considers records
4080 * of the next epoch as candidates for buffering. */
4081 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004082 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004083
4084 hs->buffering.future_record.data =
4085 mbedtls_calloc( 1, hs->buffering.future_record.len );
4086 if( hs->buffering.future_record.data == NULL )
4087 {
4088 /* If we run out of RAM trying to buffer a
4089 * record from the next epoch, just ignore. */
4090 return( 0 );
4091 }
4092
Hanno Becker519f15d2019-07-11 12:43:20 +01004093 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004094
Hanno Becker519f15d2019-07-11 12:43:20 +01004095 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004096 return( 0 );
4097}
4098
4099#endif /* MBEDTLS_SSL_PROTO_DTLS */
4100
Hanno Beckere74d5562018-08-15 14:26:08 +01004101static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004102{
Janos Follath865b3eb2019-12-16 11:46:15 +00004103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004104 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004105
Hanno Becker5f066e72018-08-16 14:56:31 +01004106#if defined(MBEDTLS_SSL_PROTO_DTLS)
4107 /* We might have buffered a future record; if so,
4108 * and if the epoch matches now, load it.
4109 * On success, this call will set ssl->in_left to
4110 * the length of the buffered record, so that
4111 * the calls to ssl_fetch_input() below will
4112 * essentially be no-ops. */
4113 ret = ssl_load_buffered_record( ssl );
4114 if( ret != 0 )
4115 return( ret );
4116#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004117
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004118 /* Ensure that we have enough space available for the default form
4119 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4120 * with no space for CIDs counted in). */
4121 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4122 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004123 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004124 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004125 return( ret );
4126 }
4127
Hanno Beckere5e7e782019-07-11 12:29:35 +01004128 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4129 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004130 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004133 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004134 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4135 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004136 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004137 if( ret != 0 )
4138 return( ret );
4139
4140 /* Fall through to handling of unexpected records */
4141 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4142 }
4143
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004144 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4145 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004146#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004147 /* Reset in pointers to default state for TLS/DTLS records,
4148 * assuming no CID and no offset between record content and
4149 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004150 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004151
Hanno Becker7ae20e02019-07-12 08:33:49 +01004152 /* Setup internal message pointers from record structure. */
4153 ssl->in_msgtype = rec.type;
4154#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4155 ssl->in_len = ssl->in_cid + rec.cid_len;
4156#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4157 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4158 ssl->in_msglen = rec.data_len;
4159
Hanno Becker2fddd372019-07-10 14:37:41 +01004160 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004161 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004162 if( ret != 0 )
4163 return( ret );
4164#endif
4165
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004166 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004167 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004168
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4170 "(header)" ) );
4171 }
4172 else
4173 {
4174 /* Skip invalid record and the rest of the datagram */
4175 ssl->next_record_offset = 0;
4176 ssl->in_left = 0;
4177
4178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4179 "(header)" ) );
4180 }
4181
4182 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004183 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004184 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004185 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004186#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004187 {
4188 return( ret );
4189 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004190 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004192#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004193 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004194 {
Hanno Beckera8814792019-07-10 15:01:45 +01004195 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004196 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004197 if( ssl->next_record_offset < ssl->in_left )
4198 {
4199 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4200 }
4201 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004202 else
4203#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004204 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004205 /*
4206 * Fetch record contents from underlying transport.
4207 */
Hanno Beckera3175662019-07-11 12:50:29 +01004208 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004209 if( ret != 0 )
4210 {
4211 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4212 return( ret );
4213 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004214
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004215 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004216 }
4217
4218 /*
4219 * Decrypt record contents.
4220 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004221
Hanno Beckerfdf66042019-07-11 13:07:45 +01004222 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004223 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004224#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004225 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004226 {
4227 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004228 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004229 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004230 /* Except when waiting for Finished as a bad mac here
4231 * probably means something went wrong in the handshake
4232 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4233 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4234 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4235 {
4236#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4237 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4238 {
4239 mbedtls_ssl_send_alert_message( ssl,
4240 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4241 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4242 }
4243#endif
4244 return( ret );
4245 }
4246
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004247 if( ssl->conf->badmac_limit != 0 &&
4248 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004249 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4251 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004252 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004253
Hanno Becker4a810fb2017-05-24 16:27:30 +01004254 /* As above, invalid records cause
4255 * dismissal of the whole datagram. */
4256
4257 ssl->next_record_offset = 0;
4258 ssl->in_left = 0;
4259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004260 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004261 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004262 }
4263
4264 return( ret );
4265 }
4266 else
4267#endif
4268 {
4269 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004270#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4271 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004272 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004273 mbedtls_ssl_send_alert_message( ssl,
4274 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4275 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004276 }
4277#endif
4278 return( ret );
4279 }
4280 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004281
Hanno Becker44d89b22019-07-12 09:40:44 +01004282
4283 /* Reset in pointers to default state for TLS/DTLS records,
4284 * assuming no CID and no offset between record content and
4285 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004286 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004287#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4288 ssl->in_len = ssl->in_cid + rec.cid_len;
4289#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004290 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004291
Hanno Becker8685c822019-07-12 09:37:30 +01004292 /* The record content type may change during decryption,
4293 * so re-read it. */
4294 ssl->in_msgtype = rec.type;
4295 /* Also update the input buffer, because unfortunately
4296 * the server-side ssl_parse_client_hello() reparses the
4297 * record header when receiving a ClientHello initiating
4298 * a renegotiation. */
4299 ssl->in_hdr[0] = rec.type;
4300 ssl->in_msg = rec.buf + rec.data_offset;
4301 ssl->in_msglen = rec.data_len;
4302 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4303 ssl->in_len[1] = (unsigned char)( rec.data_len );
4304
Simon Butcher99000142016-10-13 17:21:01 +01004305 return( 0 );
4306}
4307
4308int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4309{
Janos Follath865b3eb2019-12-16 11:46:15 +00004310 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004311
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004312 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004313 * Handle particular types of records
4314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004315 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004316 {
Simon Butcher99000142016-10-13 17:21:01 +01004317 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4318 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004319 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004320 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004321 }
4322
Hanno Beckere678eaa2018-08-21 14:57:46 +01004323 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004324 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004325 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004326 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004327 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004328 ssl->in_msglen ) );
4329 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004330 }
4331
Hanno Beckere678eaa2018-08-21 14:57:46 +01004332 if( ssl->in_msg[0] != 1 )
4333 {
4334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4335 ssl->in_msg[0] ) );
4336 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4337 }
4338
4339#if defined(MBEDTLS_SSL_PROTO_DTLS)
4340 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4341 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4342 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4343 {
4344 if( ssl->handshake == NULL )
4345 {
4346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4347 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4348 }
4349
4350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4351 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4352 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004353#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004354 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004357 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004358 if( ssl->in_msglen != 2 )
4359 {
4360 /* Note: Standard allows for more than one 2 byte alert
4361 to be packed in a single message, but Mbed TLS doesn't
4362 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004364 ssl->in_msglen ) );
4365 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4366 }
4367
Paul Elliott9f352112020-12-09 14:55:45 +00004368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004369 ssl->in_msg[0], ssl->in_msg[1] ) );
4370
4371 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004372 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004374 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004375 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004377 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004378 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004379 }
4380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004381 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4382 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4385 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004386 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004387
4388#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4389 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4390 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4391 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004393 /* Will be handled when trying to parse ServerHello */
4394 return( 0 );
4395 }
4396#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004397 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004398 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004399 }
4400
Hanno Beckerc76c6192017-06-06 10:03:17 +01004401#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004402 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004403 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004404 /* Drop unexpected ApplicationData records,
4405 * except at the beginning of renegotiations */
4406 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4407 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4408#if defined(MBEDTLS_SSL_RENEGOTIATION)
4409 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4410 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004411#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004412 )
4413 {
4414 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4415 return( MBEDTLS_ERR_SSL_NON_FATAL );
4416 }
4417
4418 if( ssl->handshake != NULL &&
4419 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4420 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004421 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004422 }
4423 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004424#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004425
Paul Bakker5121ce52009-01-03 21:22:43 +00004426 return( 0 );
4427}
4428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004429int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004430{
irwir6c0da642019-09-26 21:07:41 +03004431 return( mbedtls_ssl_send_alert_message( ssl,
4432 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4433 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004434}
4435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004436int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004437 unsigned char level,
4438 unsigned char message )
4439{
Janos Follath865b3eb2019-12-16 11:46:15 +00004440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004441
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004442 if( ssl == NULL || ssl->conf == NULL )
4443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004445 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004446 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004448 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004449 ssl->out_msglen = 2;
4450 ssl->out_msg[0] = level;
4451 ssl->out_msg[1] = message;
4452
Hanno Becker67bc7c32018-08-06 11:33:50 +01004453 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004455 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004456 return( ret );
4457 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004459
4460 return( 0 );
4461}
4462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004463int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004464{
Janos Follath865b3eb2019-12-16 11:46:15 +00004465 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004467 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004469 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004470 ssl->out_msglen = 1;
4471 ssl->out_msg[0] = 1;
4472
Paul Bakker5121ce52009-01-03 21:22:43 +00004473 ssl->state++;
4474
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004475 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004476 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004477 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004478 return( ret );
4479 }
4480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004481 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004482
4483 return( 0 );
4484}
4485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004486int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004487{
Janos Follath865b3eb2019-12-16 11:46:15 +00004488 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004490 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004491
Hanno Becker327c93b2018-08-15 13:56:18 +01004492 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004494 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004495 return( ret );
4496 }
4497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004498 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004499 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004501 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4502 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004503 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004504 }
4505
Hanno Beckere678eaa2018-08-21 14:57:46 +01004506 /* CCS records are only accepted if they have length 1 and content '1',
4507 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004508
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004509 /*
4510 * Switch to our negotiated transform and session parameters for inbound
4511 * data.
4512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004513 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004514 ssl->transform_in = ssl->transform_negotiate;
4515 ssl->session_in = ssl->session_negotiate;
4516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004518 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004521 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004522#endif
4523
4524 /* Increment epoch */
4525 if( ++ssl->in_epoch == 0 )
4526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004527 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004528 /* This is highly unlikely to happen for legitimate reasons, so
4529 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004531 }
4532 }
4533 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004534#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004535 memset( ssl->in_ctr, 0, 8 );
4536
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004537 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004538
Paul Bakker5121ce52009-01-03 21:22:43 +00004539 ssl->state++;
4540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004542
4543 return( 0 );
4544}
4545
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004546/* Once ssl->out_hdr as the address of the beginning of the
4547 * next outgoing record is set, deduce the other pointers.
4548 *
4549 * Note: For TLS, we save the implicit record sequence number
4550 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4551 * and the caller has to make sure there's space for this.
4552 */
4553
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004554static size_t ssl_transform_get_explicit_iv_len(
4555 mbedtls_ssl_transform const *transform )
4556{
TRodziewiczef73f012021-05-13 14:53:36 +02004557 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004558 return( 0 );
4559
4560 return( transform->ivlen - transform->fixed_ivlen );
4561}
4562
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004563void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4564 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004565{
4566#if defined(MBEDTLS_SSL_PROTO_DTLS)
4567 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4568 {
4569 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004570#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004571 ssl->out_cid = ssl->out_ctr + 8;
4572 ssl->out_len = ssl->out_cid;
4573 if( transform != NULL )
4574 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004575#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004576 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004577#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004578 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004579 }
4580 else
4581#endif
4582 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004583 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004584#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004585 ssl->out_cid = ssl->out_len;
4586#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004587 ssl->out_iv = ssl->out_hdr + 5;
4588 }
4589
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004590 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004591 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004592 if( transform != NULL )
4593 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004594}
4595
4596/* Once ssl->in_hdr as the address of the beginning of the
4597 * next incoming record is set, deduce the other pointers.
4598 *
4599 * Note: For TLS, we save the implicit record sequence number
4600 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4601 * and the caller has to make sure there's space for this.
4602 */
4603
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004604void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004605{
Hanno Becker79594fd2019-05-08 09:38:41 +01004606 /* This function sets the pointers to match the case
4607 * of unprotected TLS/DTLS records, with both ssl->in_iv
4608 * and ssl->in_msg pointing to the beginning of the record
4609 * content.
4610 *
4611 * When decrypting a protected record, ssl->in_msg
4612 * will be shifted to point to the beginning of the
4613 * record plaintext.
4614 */
4615
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004616#if defined(MBEDTLS_SSL_PROTO_DTLS)
4617 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4618 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004619 /* This sets the header pointers to match records
4620 * without CID. When we receive a record containing
4621 * a CID, the fields are shifted accordingly in
4622 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004623 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004624#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004625 ssl->in_cid = ssl->in_ctr + 8;
4626 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004627#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004628 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004629#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004630 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004631 }
4632 else
4633#endif
4634 {
4635 ssl->in_ctr = ssl->in_hdr - 8;
4636 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004637#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004638 ssl->in_cid = ssl->in_len;
4639#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004640 ssl->in_iv = ssl->in_hdr + 5;
4641 }
4642
Hanno Becker79594fd2019-05-08 09:38:41 +01004643 /* This will be adjusted at record decryption time. */
4644 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004645}
4646
Paul Bakker5121ce52009-01-03 21:22:43 +00004647/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004648 * Setup an SSL context
4649 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004650
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004651void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004652{
4653 /* Set the incoming and outgoing record pointers. */
4654#if defined(MBEDTLS_SSL_PROTO_DTLS)
4655 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4656 {
4657 ssl->out_hdr = ssl->out_buf;
4658 ssl->in_hdr = ssl->in_buf;
4659 }
4660 else
4661#endif /* MBEDTLS_SSL_PROTO_DTLS */
4662 {
Hanno Becker12078f42021-03-02 15:28:41 +00004663 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004664 ssl->out_hdr = ssl->out_buf + 8;
4665 ssl->in_hdr = ssl->in_buf + 8;
4666 }
4667
4668 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004669 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4670 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004671}
4672
Paul Bakker5121ce52009-01-03 21:22:43 +00004673/*
4674 * SSL get accessors
4675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004676size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004677{
4678 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4679}
4680
Hanno Becker8b170a02017-10-10 11:51:19 +01004681int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4682{
4683 /*
4684 * Case A: We're currently holding back
4685 * a message for further processing.
4686 */
4687
4688 if( ssl->keep_current_message == 1 )
4689 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004690 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004691 return( 1 );
4692 }
4693
4694 /*
4695 * Case B: Further records are pending in the current datagram.
4696 */
4697
4698#if defined(MBEDTLS_SSL_PROTO_DTLS)
4699 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4700 ssl->in_left > ssl->next_record_offset )
4701 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004702 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004703 return( 1 );
4704 }
4705#endif /* MBEDTLS_SSL_PROTO_DTLS */
4706
4707 /*
4708 * Case C: A handshake message is being processed.
4709 */
4710
Hanno Becker8b170a02017-10-10 11:51:19 +01004711 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4712 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004713 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004714 return( 1 );
4715 }
4716
4717 /*
4718 * Case D: An application data message is being processed
4719 */
4720 if( ssl->in_offt != NULL )
4721 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004722 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004723 return( 1 );
4724 }
4725
4726 /*
4727 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004728 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004729 * we implement support for multiple alerts in single records.
4730 */
4731
4732 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4733 return( 0 );
4734}
4735
Paul Bakker43ca69c2011-01-15 17:35:19 +00004736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004738{
Hanno Becker3136ede2018-08-17 15:28:19 +01004739 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004741 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004742
Hanno Becker5903de42019-05-03 14:46:38 +01004743 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4744
Hanno Becker78640902018-08-13 16:35:15 +01004745 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004746 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004748 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750 case MBEDTLS_MODE_GCM:
4751 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004752 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004754 transform_expansion = transform->minlen;
4755 break;
4756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004758
4759 block_size = mbedtls_cipher_get_block_size(
4760 &transform->cipher_ctx_enc );
4761
Hanno Becker3136ede2018-08-17 15:28:19 +01004762 /* Expansion due to the addition of the MAC. */
4763 transform_expansion += transform->maclen;
4764
4765 /* Expansion due to the addition of CBC padding;
4766 * Theoretically up to 256 bytes, but we never use
4767 * more than the block size of the underlying cipher. */
4768 transform_expansion += block_size;
4769
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004770 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004771 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004772#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004773 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004774#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004775
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004776 break;
4777
4778 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004779 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004780 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004781 }
4782
Hanno Beckera0e20d02019-05-15 14:03:01 +01004783#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004784 if( transform->out_cid_len != 0 )
4785 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004786#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004787
Hanno Becker5903de42019-05-03 14:46:38 +01004788 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004789}
4790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004792/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004793 * Check record counters and renegotiate if they're above the limit.
4794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004796{
Hanno Beckerdd772292020-02-05 10:38:31 +00004797 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004798 int in_ctr_cmp;
4799 int out_ctr_cmp;
4800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004801 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4802 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004803 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004804 {
4805 return( 0 );
4806 }
4807
Andres AG2196c7f2016-12-15 17:01:16 +00004808 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
4809 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01004810 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00004811 ssl->conf->renego_period + ep_len, 8 - ep_len );
4812
4813 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004814 {
4815 return( 0 );
4816 }
4817
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004820}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004821#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004822
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004823/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004824 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004825 * may only be sent for the purpose of initiating renegotiations.
4826 *
4827 * This function is introduced as a separate helper since the handling
4828 * of post-handshake handshake messages changes significantly in TLS 1.3,
4829 * and having a helper function allows to distinguish between TLS <= 1.2 and
4830 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4831 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004832static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004833{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004835
4836 /*
4837 * - For client-side, expect SERVER_HELLO_REQUEST.
4838 * - For server-side, expect CLIENT_HELLO.
4839 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4840 */
4841
4842#if defined(MBEDTLS_SSL_CLI_C)
4843 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4844 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4845 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4846 {
4847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4848
4849 /* With DTLS, drop the packet (probably from last handshake) */
4850#if defined(MBEDTLS_SSL_PROTO_DTLS)
4851 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4852 {
4853 return( 0 );
4854 }
4855#endif
4856 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4857 }
4858#endif /* MBEDTLS_SSL_CLI_C */
4859
4860#if defined(MBEDTLS_SSL_SRV_C)
4861 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4862 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4863 {
4864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4865
4866 /* With DTLS, drop the packet (probably from last handshake) */
4867#if defined(MBEDTLS_SSL_PROTO_DTLS)
4868 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4869 {
4870 return( 0 );
4871 }
4872#endif
4873 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4874 }
4875#endif /* MBEDTLS_SSL_SRV_C */
4876
4877#if defined(MBEDTLS_SSL_RENEGOTIATION)
4878 /* Determine whether renegotiation attempt should be accepted */
4879 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
4880 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
4881 ssl->conf->allow_legacy_renegotiation ==
4882 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
4883 {
4884 /*
4885 * Accept renegotiation request
4886 */
4887
4888 /* DTLS clients need to know renego is server-initiated */
4889#if defined(MBEDTLS_SSL_PROTO_DTLS)
4890 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4891 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
4892 {
4893 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
4894 }
4895#endif
4896 ret = mbedtls_ssl_start_renegotiation( ssl );
4897 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4898 ret != 0 )
4899 {
4900 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
4901 ret );
4902 return( ret );
4903 }
4904 }
4905 else
4906#endif /* MBEDTLS_SSL_RENEGOTIATION */
4907 {
4908 /*
4909 * Refuse renegotiation
4910 */
4911
4912 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
4913
TRodziewicz0f82ec62021-05-12 17:49:18 +02004914#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004915 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
4916 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
4917 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004918 {
TRodziewicz345165c2021-07-06 13:42:11 +02004919 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004920 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02004921#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004922 }
4923
4924 return( 0 );
4925}
4926
Paul Bakker48916f92012-09-16 19:57:18 +00004927/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004928 * Receive application data decrypted from the SSL layer
4929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00004931{
Janos Follath865b3eb2019-12-16 11:46:15 +00004932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00004933 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00004934
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004935 if( ssl == NULL || ssl->conf == NULL )
4936 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004941 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004942 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004943 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004944 return( ret );
4945
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004946 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004947 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004948 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02004949 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02004950 return( ret );
4951 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004952 }
4953#endif
4954
Hanno Becker4a810fb2017-05-24 16:27:30 +01004955 /*
4956 * Check if renegotiation is necessary and/or handshake is
4957 * in process. If yes, perform/continue, and fall through
4958 * if an unexpected packet is received while the client
4959 * is waiting for the ServerHello.
4960 *
4961 * (There is no equivalent to the last condition on
4962 * the server-side as it is not treated as within
4963 * a handshake while waiting for the ClientHello
4964 * after a renegotiation request.)
4965 */
4966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01004968 ret = ssl_check_ctr_renegotiate( ssl );
4969 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4970 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004971 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004973 return( ret );
4974 }
4975#endif
4976
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004977 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004979 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01004980 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4981 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004982 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004983 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004984 return( ret );
4985 }
4986 }
4987
Hanno Beckere41158b2017-10-23 13:30:32 +01004988 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01004989 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004990 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02004991 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02004992 if( ssl->f_get_timer != NULL &&
4993 ssl->f_get_timer( ssl->p_timer ) == -1 )
4994 {
Hanno Becker0f57a652020-02-05 10:37:26 +00004995 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02004996 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02004997
Hanno Becker327c93b2018-08-15 13:56:18 +01004998 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004999 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005000 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5001 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005002
Hanno Becker4a810fb2017-05-24 16:27:30 +01005003 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5004 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005005 }
5006
5007 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005008 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005009 {
5010 /*
5011 * OpenSSL sends empty messages to randomize the IV
5012 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005013 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005016 return( 0 );
5017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005019 return( ret );
5020 }
5021 }
5022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005023 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005024 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005025 ret = ssl_handle_hs_message_post_handshake( ssl );
5026 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005027 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005028 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5029 ret );
5030 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005031 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005032
Hanno Beckerf26cc722021-04-21 07:30:13 +01005033 /* At this point, we don't know whether the renegotiation triggered
5034 * by the post-handshake message has been completed or not. The cases
5035 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005036 * 1) The renegotiation is complete. In this case, no new record
5037 * has been read yet.
5038 * 2) The renegotiation is incomplete because the client received
5039 * an application data record while awaiting the ServerHello.
5040 * 3) The renegotiation is incomplete because the client received
5041 * a non-handshake, non-application data message while awaiting
5042 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005043 *
5044 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005045 * - For 1), the next iteration will read a new record and check
5046 * if it's application data.
5047 * - For 2), the loop condition isn't satisfied as application data
5048 * is present, hence continue is the same as break
5049 * - For 3), the loop condition is satisfied and read_record
5050 * will re-deliver the message that was held back by the client
5051 * when expecting the ServerHello.
5052 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005053
Hanno Becker90333da2017-10-10 11:27:13 +01005054 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005055 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005056#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005057 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005058 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005059 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005060 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005061 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005064 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005065 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005066 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005067 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005068 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005069#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5072 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005073 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005075 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005076 }
5077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005078 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005079 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5081 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005082 }
5083
5084 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005085
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005086 /* We're going to return something now, cancel timer,
5087 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005089 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005090
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005091#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005092 /* If we requested renego but received AppData, resend HelloRequest.
5093 * Do it now, after setting in_offt, to avoid taking this branch
5094 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005096 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005097 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005098 {
Hanno Becker786300f2020-02-05 10:46:40 +00005099 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005100 {
Hanno Becker786300f2020-02-05 10:46:40 +00005101 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5102 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005103 return( ret );
5104 }
5105 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005106#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005107#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005108 }
5109
5110 n = ( len < ssl->in_msglen )
5111 ? len : ssl->in_msglen;
5112
5113 memcpy( buf, ssl->in_offt, n );
5114 ssl->in_msglen -= n;
5115
gabor-mezei-arma3214132020-07-15 10:55:00 +02005116 /* Zeroising the plaintext buffer to erase unused application data
5117 from the memory. */
5118 mbedtls_platform_zeroize( ssl->in_offt, n );
5119
Paul Bakker5121ce52009-01-03 21:22:43 +00005120 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005121 {
5122 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005123 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005124 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005125 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005126 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005127 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005128 /* more data available */
5129 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005130 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005133
Paul Bakker23986e52011-04-24 08:57:21 +00005134 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005135}
5136
5137/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005138 * Send application data to be encrypted by the SSL layer, taking care of max
5139 * fragment length and buffer size.
5140 *
5141 * According to RFC 5246 Section 6.2.1:
5142 *
5143 * Zero-length fragments of Application data MAY be sent as they are
5144 * potentially useful as a traffic analysis countermeasure.
5145 *
5146 * Therefore, it is possible that the input message length is 0 and the
5147 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005148 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005149static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005150 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005151{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005152 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5153 const size_t max_len = (size_t) ret;
5154
5155 if( ret < 0 )
5156 {
5157 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5158 return( ret );
5159 }
5160
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005161 if( len > max_len )
5162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005163#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005164 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005165 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005167 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5168 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005169 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005170 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005171 }
5172 else
5173#endif
5174 len = max_len;
5175 }
Paul Bakker887bd502011-06-08 13:10:54 +00005176
Paul Bakker5121ce52009-01-03 21:22:43 +00005177 if( ssl->out_left != 0 )
5178 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005179 /*
5180 * The user has previously tried to send the data and
5181 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5182 * written. In this case, we expect the high-level write function
5183 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005185 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005186 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005188 return( ret );
5189 }
5190 }
Paul Bakker887bd502011-06-08 13:10:54 +00005191 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005192 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005193 /*
5194 * The user is trying to send a message the first time, so we need to
5195 * copy the data into the internal buffers and setup the data structure
5196 * to keep track of partial writes
5197 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005198 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005200 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005201
Hanno Becker67bc7c32018-08-06 11:33:50 +01005202 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005203 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005204 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005205 return( ret );
5206 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005207 }
5208
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005209 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005210}
5211
5212/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005213 * Write application data (public-facing wrapper)
5214 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005215int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005216{
Janos Follath865b3eb2019-12-16 11:46:15 +00005217 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005218
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005219 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005220
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005221 if( ssl == NULL || ssl->conf == NULL )
5222 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5223
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005224#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005225 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5226 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005227 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005228 return( ret );
5229 }
5230#endif
5231
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005232 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005233 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005234 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005235 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005236 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005237 return( ret );
5238 }
5239 }
5240
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005241 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005242
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005244
5245 return( ret );
5246}
5247
5248/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 * Notify the peer that the connection is being closed
5250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005251int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005252{
Janos Follath865b3eb2019-12-16 11:46:15 +00005253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005254
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005255 if( ssl == NULL || ssl->conf == NULL )
5256 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005259
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005260 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5266 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5267 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005269 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005270 return( ret );
5271 }
5272 }
5273
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005275
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005276 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005277}
5278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005280{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005281 if( transform == NULL )
5282 return;
5283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005284 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5285 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005286
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005287#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288 mbedtls_md_free( &transform->md_ctx_enc );
5289 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005290#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005291
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005292 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005293}
5294
Hanno Becker0271f962018-08-16 13:23:47 +01005295#if defined(MBEDTLS_SSL_PROTO_DTLS)
5296
Hanno Becker533ab5f2020-02-05 10:49:13 +00005297void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005298{
5299 unsigned offset;
5300 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5301
5302 if( hs == NULL )
5303 return;
5304
Hanno Becker283f5ef2018-08-24 09:34:47 +01005305 ssl_free_buffered_record( ssl );
5306
Hanno Becker0271f962018-08-16 13:23:47 +01005307 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005308 ssl_buffering_free_slot( ssl, offset );
5309}
5310
5311static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5312 uint8_t slot )
5313{
5314 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5315 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005316
5317 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5318 return;
5319
Hanno Beckere605b192018-08-21 15:59:07 +01005320 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005321 {
Hanno Beckere605b192018-08-21 15:59:07 +01005322 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005323 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005324 mbedtls_free( hs_buf->data );
5325 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005326 }
5327}
5328
5329#endif /* MBEDTLS_SSL_PROTO_DTLS */
5330
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005331/*
5332 * Convert version numbers to/from wire format
5333 * and, for DTLS, to/from TLS equivalent.
5334 *
5335 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005336 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005337 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005340 unsigned char ver[2] )
5341{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342#if defined(MBEDTLS_SSL_PROTO_DTLS)
5343 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005346 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5347
5348 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5349 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5350 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005351 else
5352#else
5353 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005354#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005355 {
5356 ver[0] = (unsigned char) major;
5357 ver[1] = (unsigned char) minor;
5358 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005359}
5360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005362 const unsigned char ver[2] )
5363{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364#if defined(MBEDTLS_SSL_PROTO_DTLS)
5365 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005366 {
5367 *major = 255 - ver[0] + 2;
5368 *minor = 255 - ver[1] + 1;
5369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005371 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5372 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005373 else
5374#else
5375 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005376#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005377 {
5378 *major = ver[0];
5379 *minor = ver[1];
5380 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005381}
5382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383#endif /* MBEDTLS_SSL_TLS_C */