blob: fdb647a508277197822852ef99271a63e6124842 [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"
Paul Bakker0be444a2013-08-27 21:55:01 +020043
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020044#include "ssl_invasive.h"
45
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,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 unsigned minor_ver,
388 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000407 * Moreover, the additional data involves the length of the TLS
408 * ciphertext, not the TLS plaintext as in earlier versions.
409 * Quoting RFC 8446 (TLS 1.3):
410 *
411 * additional_data = TLSCiphertext.opaque_type ||
412 * TLSCiphertext.legacy_record_version ||
413 * TLSCiphertext.length
414 *
415 * We pass the tag length to this function in order to compute the
416 * ciphertext length from the inner plaintext length rec->data_len via
417 *
418 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
419 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 */
421
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000423 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424
425#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
427 {
428 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
429 * which differs from the length of the TLSInnerPlaintext
430 * by the length of the authentication tag. */
431 ad_len_field += taglen;
432 }
433 else
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
435 {
436 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Joe Subbiani6dd73642021-07-19 11:56:54 +0100457 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100458 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 }
460 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100462 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100463 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100465 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466
467 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000468}
469
Hanno Becker67a37db2020-05-28 16:27:07 +0100470#if defined(MBEDTLS_GCM_C) || \
471 defined(MBEDTLS_CCM_C) || \
472 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100473static int ssl_transform_aead_dynamic_iv_is_explicit(
474 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475{
Hanno Becker17263802020-05-28 07:05:48 +0100476 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477}
478
Hanno Becker17263802020-05-28 07:05:48 +0100479/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
480 *
481 * Concretely, this occurs in two variants:
482 *
483 * a) Fixed and dynamic IV lengths add up to total IV length, giving
484 * IV = fixed_iv || dynamic_iv
485 *
Hanno Becker15952812020-06-04 13:31:46 +0100486 * This variant is used in TLS 1.2 when used with GCM or CCM.
487 *
Hanno Becker17263802020-05-28 07:05:48 +0100488 * b) Fixed IV lengths matches total IV length, giving
489 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100490 *
491 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
492 *
493 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100494 *
495 * This function has the precondition that
496 *
497 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
498 *
499 * which has to be ensured by the caller. If this precondition
500 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100501 */
502static void ssl_build_record_nonce( unsigned char *dst_iv,
503 size_t dst_iv_len,
504 unsigned char const *fixed_iv,
505 size_t fixed_iv_len,
506 unsigned char const *dynamic_iv,
507 size_t dynamic_iv_len )
508{
509 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100510
511 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100512 memset( dst_iv, 0, dst_iv_len );
513 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100514
Hanno Becker17263802020-05-28 07:05:48 +0100515 dst_iv += dst_iv_len - dynamic_iv_len;
516 for( i = 0; i < dynamic_iv_len; i++ )
517 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518}
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520
Hanno Beckera18d1322018-01-03 14:27:32 +0000521int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
522 mbedtls_ssl_transform *transform,
523 mbedtls_record *rec,
524 int (*f_rng)(void *, unsigned char *, size_t),
525 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000526{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
573 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
574
575 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
576 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
578 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000579 rec->data_len,
580 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
582 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100583
Hanno Becker92313402020-05-20 13:58:58 +0100584 /* The following two code paths implement the (D)TLSInnerPlaintext
585 * structure present in TLS 1.3 and DTLS 1.2 + CID.
586 *
587 * See ssl_build_inner_plaintext() for more information.
588 *
589 * Note that this changes `rec->data_len`, and hence
590 * `post_avail` needs to be recalculated afterwards.
591 *
592 * Note also that the two code paths cannot occur simultaneously
593 * since they apply to different versions of the protocol. There
594 * is hence no risk of double-addition of the inner plaintext.
595 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100596#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
597 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
598 {
Hanno Becker13996922020-05-28 16:15:19 +0100599 size_t padding =
600 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200601 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100602 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100603 &rec->data_len,
604 post_avail,
605 rec->type,
606 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100607 {
608 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
609 }
610
611 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
612 }
613#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
614
Hanno Beckera0e20d02019-05-15 14:03:01 +0100615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100616 /*
617 * Add CID information
618 */
619 rec->cid_len = transform->out_cid_len;
620 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
621 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
623 if( rec->cid_len != 0 )
624 {
Hanno Becker13996922020-05-28 16:15:19 +0100625 size_t padding =
626 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200627 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100629 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100630 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100631 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100632 * Note that this changes `rec->data_len`, and hence
633 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100635 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 &rec->data_len,
637 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100638 rec->type,
639 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100640 {
641 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
642 }
643
644 rec->type = MBEDTLS_SSL_MSG_CID;
645 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100647
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100648 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
649
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100651 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000653#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 if( mode == MBEDTLS_MODE_STREAM ||
655 ( mode == MBEDTLS_MODE_CBC
656#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100658#endif
659 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000660 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 if( post_avail < transform->maclen )
662 {
663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
664 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
665 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200667 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000668
TRodziewicz345165c2021-07-06 13:42:11 +0200669 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000670 transform->minor_ver,
671 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000672
TRodziewicz345165c2021-07-06 13:42:11 +0200673 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
674 add_data_len );
675 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
676 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
677 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678
TRodziewicz345165c2021-07-06 13:42:11 +0200679 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
683 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200684
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000685 rec->data_len += transform->maclen;
686 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100687 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200688 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000690
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200691 /*
692 * Encrypt
693 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000694#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000699 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000700 "including %d bytes of padding",
701 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000702
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000703 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
704 transform->iv_enc, transform->ivlen,
705 data, rec->data_len,
706 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200709 return( ret );
710 }
711
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000712 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
715 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200716 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000717 }
Paul Bakker68884e32013-01-07 18:20:04 +0100718 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000719#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000720
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200721#if defined(MBEDTLS_GCM_C) || \
722 defined(MBEDTLS_CCM_C) || \
723 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200725 mode == MBEDTLS_MODE_CCM ||
726 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000727 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200729 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100730 unsigned char *dynamic_iv;
731 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100732 int dynamic_iv_is_explicit =
733 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000734
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100735 /* Check that there's space for the authentication tag. */
736 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000737 {
738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
739 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
740 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000741
Paul Bakker68884e32013-01-07 18:20:04 +0100742 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100743 * Build nonce for AEAD encryption.
744 *
745 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
746 * part of the IV is prepended to the ciphertext and
747 * can be chosen freely - in particular, it need not
748 * agree with the record sequence number.
749 * However, since ChaChaPoly as well as all AEAD modes
750 * in TLS 1.3 use the record sequence number as the
751 * dynamic part of the nonce, we uniformly use the
752 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100753 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100754 dynamic_iv = rec->ctr;
755 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200756
Hanno Becker17263802020-05-28 07:05:48 +0100757 ssl_build_record_nonce( iv, sizeof( iv ),
758 transform->iv_enc,
759 transform->fixed_ivlen,
760 dynamic_iv,
761 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100762
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100763 /*
764 * Build additional data for AEAD encryption.
765 * This depends on the TLS version.
766 */
767 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000768 transform->minor_ver,
769 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100770
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200771 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100772 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100774 dynamic_iv,
775 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000776 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100777 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000778 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200779 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000781
Paul Bakker68884e32013-01-07 18:20:04 +0100782 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200783 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200784 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100786 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100788 add_data, add_data_len,
789 data, rec->data_len, /* src */
790 data, rec->buf_len - (data - rec->buf), /* dst */
791 &rec->data_len,
792 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200793 {
TRodziewicz18efb732021-04-29 23:12:19 +0200794 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200795 return( ret );
796 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000797 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100798 data + rec->data_len - transform->taglen,
799 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100800 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100802
803 /*
804 * Prefix record content with dynamic IV in case it is explicit.
805 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100806 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100807 {
808 if( rec->data_offset < dynamic_iv_len )
809 {
810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
811 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
812 }
813
814 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
815 rec->data_offset -= dynamic_iv_len;
816 rec->data_len += dynamic_iv_len;
817 }
818
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100819 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000820 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100822#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200823#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000825 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000827 size_t padlen, i;
828 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000829
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000830 /* Currently we're always using minimal padding
831 * (up to 255 bytes would be allowed). */
832 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
833 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000834 padlen = 0;
835
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000836 /* Check there's enough space in the buffer for the padding. */
837 if( post_avail < padlen + 1 )
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
Paul Bakker5121ce52009-01-03 21:22:43 +0000843 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000845
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len += padlen + 1;
847 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000848
TRodziewicz0f82ec62021-05-12 17:49:18 +0200849#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000850 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200851 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000852 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000853 */
TRodziewicz345165c2021-07-06 13:42:11 +0200854 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000855 {
TRodziewicz345165c2021-07-06 13:42:11 +0200856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
857 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000858 }
TRodziewicz345165c2021-07-06 13:42:11 +0200859
860 if( rec->data_offset < transform->ivlen )
861 {
862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
863 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
864 }
865
866 /*
867 * Generate IV
868 */
869 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
870 if( ret != 0 )
871 return( ret );
872
873 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200874#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000875
Paul Elliottd48d5c62021-01-07 14:47:05 +0000876 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
877 "including %" MBEDTLS_PRINTF_SIZET
878 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000879 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200880 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000881
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000882 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
883 transform->iv_enc,
884 transform->ivlen,
885 data, rec->data_len,
886 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200889 return( ret );
890 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200891
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000892 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
895 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200896 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200897
TRodziewicz0f82ec62021-05-12 17:49:18 +0200898 data -= transform->ivlen;
899 rec->data_offset -= transform->ivlen;
900 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100903 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100904 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000905 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
906
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100907 /*
908 * MAC(MAC_write_key, seq_num +
909 * TLSCipherText.type +
910 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100911 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200912 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100913 * ENC(content + padding + padding_length));
914 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915
916 if( post_avail < transform->maclen)
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100921
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100922 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000923 rec, transform->minor_ver,
924 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000927 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100928 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100929
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000930 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100931 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 mbedtls_md_hmac_update( &transform->md_ctx_enc,
933 data, rec->data_len );
934 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
935 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100936
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100938
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 rec->data_len += transform->maclen;
940 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100941 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100942 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000944 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200945 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200946#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
949 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200950 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100952 /* Make extra sure authentication was performed, exactly once */
953 if( auth_done != 1 )
954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
956 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100957 }
958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000960
961 return( 0 );
962}
963
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200964#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200965/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200966 * Turn a bit into a mask:
967 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
968 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200969 *
970 * This function can be used to write constant-time code by replacing branches
971 * with bit operations using masks.
972 *
973 * This function is implemented without using comparison operators, as those
974 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200975 */
976static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
977{
978 /* MSVC has a warning about unary minus on unsigned integer types,
979 * but this is well-defined and precisely what we want to do here. */
980#if defined(_MSC_VER)
981#pragma warning( push )
982#pragma warning( disable : 4146 )
983#endif
984 return -bit;
985#if defined(_MSC_VER)
986#pragma warning( pop )
987#endif
988}
989
990/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200991 * Constant-flow mask generation for "less than" comparison:
992 * - if x < y, return all bits 1, that is (size_t) -1
993 * - otherwise, return all bits 0, that is 0
994 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200995 * This function can be used to write constant-time code by replacing branches
996 * with bit operations using masks.
997 *
998 * This function is implemented without using comparison operators, as those
999 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001000 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001001static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001002{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001003 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001004 const size_t sub = x - y;
1005
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001006 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001007 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1008
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001009 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001010 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001011
1012 return( mask );
1013}
1014
1015/*
1016 * Constant-flow mask generation for "greater or equal" comparison:
1017 * - if x >= y, return all bits 1, that is (size_t) -1
1018 * - otherwise, return all bits 0, that is 0
1019 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001020 * This function can be used to write constant-time code by replacing branches
1021 * with bit operations using masks.
1022 *
1023 * This function is implemented without using comparison operators, as those
1024 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001025 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001026static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001027{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001028 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001029}
1030
1031/*
1032 * Constant-flow boolean "equal" comparison:
1033 * return x == y
1034 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001035 * This function can be used to write constant-time code by replacing branches
1036 * with bit operations - it can be used in conjunction with
1037 * mbedtls_ssl_cf_mask_from_bit().
1038 *
1039 * This function is implemented without using comparison operators, as those
1040 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001041 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001042static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001043{
1044 /* diff = 0 if x == y, non-zero otherwise */
1045 const size_t diff = x ^ y;
1046
1047 /* MSVC has a warning about unary minus on unsigned integer types,
1048 * but this is well-defined and precisely what we want to do here. */
1049#if defined(_MSC_VER)
1050#pragma warning( push )
1051#pragma warning( disable : 4146 )
1052#endif
1053
1054 /* diff_msb's most significant bit is equal to x != y */
1055 const size_t diff_msb = ( diff | -diff );
1056
1057#if defined(_MSC_VER)
1058#pragma warning( pop )
1059#endif
1060
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001061 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001062 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1063
1064 return( 1 ^ diff1 );
1065}
1066
1067/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001068 * Constant-flow conditional memcpy:
1069 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1070 * - otherwise, a no-op,
1071 * but with execution flow independent of the values of c1 and c2.
1072 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001073 * This function is implemented without using comparison operators, as those
1074 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001075 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001076static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1077 const unsigned char *src,
1078 size_t len,
1079 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001080{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001081 /* mask = c1 == c2 ? 0xff : 0x00 */
1082 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001083 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001084
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001085 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001087 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001088}
1089
1090/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001091 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001092 *
1093 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1094 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001095 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001096MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001097 mbedtls_md_context_t *ctx,
1098 const unsigned char *add_data, size_t add_data_len,
1099 const unsigned char *data, size_t data_len_secret,
1100 size_t min_data_len, size_t max_data_len,
1101 unsigned char *output )
1102{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001103 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001104 * This function breaks the HMAC abstraction and uses the md_clone()
1105 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001106 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001107 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001108 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001109 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001110 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001111 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1112 * minlen, then cloning the context, and for each byte up to maxlen
1113 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001114 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001115 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001118 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001119 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001120 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001121 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122 const unsigned char * const okey = ikey + block_size;
1123 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001124
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001125 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1126 mbedtls_md_context_t aux;
1127 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001129
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001130 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001131
1132#define MD_CHK( func_call ) \
1133 do { \
1134 ret = (func_call); \
1135 if( ret != 0 ) \
1136 goto cleanup; \
1137 } while( 0 )
1138
1139 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001140
1141 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1142 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001143 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1144 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001145
1146 /* For each possible length, compute the hash up to that point */
1147 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001148 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001149 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1150 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 /* Keep only the correct inner_hash in the output buffer */
1152 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1153 offset, data_len_secret );
1154
1155 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001156 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001157 }
1158
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001159 /* The context needs to finish() before it starts() again */
1160 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1161
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001162 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001163 MD_CHK( mbedtls_md_starts( ctx ) );
1164 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1165 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1166 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001167
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001168 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001169 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001170
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001171#undef MD_CHK
1172
1173cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001174 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001175 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001176}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001177
1178/*
1179 * Constant-flow memcpy from variable position in buffer.
1180 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001181 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001182 */
1183MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1184 unsigned char *dst,
1185 const unsigned char *src_base,
1186 size_t offset_secret,
1187 size_t offset_min, size_t offset_max,
1188 size_t len )
1189{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001190 size_t offset;
1191
1192 for( offset = offset_min; offset <= offset_max; offset++ )
1193 {
1194 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1195 offset, offset_secret );
1196 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001197}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001198#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001199
Hanno Becker605949f2019-07-12 08:23:59 +01001200int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001201 mbedtls_ssl_transform *transform,
1202 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001204 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001207#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001208 size_t padlen = 0, correct = 1;
1209#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001210 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001211 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001212 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001213
Hanno Beckera18d1322018-01-03 14:27:32 +00001214#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001215 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 ((void) ssl);
1217#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001220 if( rec == NULL ||
1221 rec->buf == NULL ||
1222 rec->buf_len < rec->data_offset ||
1223 rec->buf_len - rec->data_offset < rec->data_len )
1224 {
1225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001227 }
1228
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001229 data = rec->buf + rec->data_offset;
1230 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001231
Hanno Beckera0e20d02019-05-15 14:03:01 +01001232#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001233 /*
1234 * Match record's CID with incoming CID.
1235 */
Hanno Becker938489a2019-05-08 13:02:22 +01001236 if( rec->cid_len != transform->in_cid_len ||
1237 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1238 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001239 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001240 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001241#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001242
Hanno Beckerd086bf02021-03-22 13:01:27 +00001243#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001244 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001245 {
1246 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001247 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1248 transform->iv_dec,
1249 transform->ivlen,
1250 data, rec->data_len,
1251 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001252 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001254 return( ret );
1255 }
1256
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001257 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001258 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1260 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001261 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 }
Paul Bakker68884e32013-01-07 18:20:04 +01001263 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001264#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001265#if defined(MBEDTLS_GCM_C) || \
1266 defined(MBEDTLS_CCM_C) || \
1267 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001269 mode == MBEDTLS_MODE_CCM ||
1270 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001271 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001272 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 unsigned char *dynamic_iv;
1274 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001275
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001276 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001277 * Extract dynamic part of nonce for AEAD decryption.
1278 *
1279 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1280 * part of the IV is prepended to the ciphertext and
1281 * can be chosen freely - in particular, it need not
1282 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001283 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001284 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001285 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001286 {
1287 if( rec->data_len < dynamic_iv_len )
1288 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1290 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001291 rec->data_len,
1292 dynamic_iv_len ) );
1293 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1294 }
1295 dynamic_iv = data;
1296
1297 data += dynamic_iv_len;
1298 rec->data_offset += dynamic_iv_len;
1299 rec->data_len -= dynamic_iv_len;
1300 }
Hanno Becker17263802020-05-28 07:05:48 +01001301 else
1302 {
1303 dynamic_iv = rec->ctr;
1304 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001305
1306 /* Check that there's space for the authentication tag. */
1307 if( rec->data_len < transform->taglen )
1308 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1310 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001311 rec->data_len,
1312 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001314 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001315 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001316
Hanno Beckerdf8be222020-05-21 15:30:57 +01001317 /*
1318 * Prepare nonce from dynamic and static parts.
1319 */
Hanno Becker17263802020-05-28 07:05:48 +01001320 ssl_build_record_nonce( iv, sizeof( iv ),
1321 transform->iv_dec,
1322 transform->fixed_ivlen,
1323 dynamic_iv,
1324 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001325
Hanno Beckerdf8be222020-05-21 15:30:57 +01001326 /*
1327 * Build additional data for AEAD encryption.
1328 * This depends on the TLS version.
1329 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001330 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001331 transform->minor_ver,
1332 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001333 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001334 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335
Hanno Beckerd96a6522019-07-10 13:55:25 +01001336 /* Because of the check above, we know that there are
1337 * explicit_iv_len Bytes preceeding data, and taglen
1338 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001339 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001340 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001342 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001344 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001345
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001346 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001347 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001348 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001349 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001350 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001351 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001352 data, rec->data_len + transform->taglen, /* src */
1353 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001355 {
TRodziewicz18efb732021-04-29 23:12:19 +02001356 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1359 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001360
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001361 return( ret );
1362 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001363 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001364
Hanno Beckerd96a6522019-07-10 13:55:25 +01001365 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001367 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1369 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001370 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001371 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001372 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001376 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001377 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001378
Paul Bakker5121ce52009-01-03 21:22:43 +00001379 /*
Paul Bakker45829992013-01-03 14:52:21 +01001380 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001383 /* The ciphertext is prefixed with the CBC IV. */
1384 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001385#endif
Paul Bakker45829992013-01-03 14:52:21 +01001386
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001387 /* Size considerations:
1388 *
1389 * - The CBC cipher text must not be empty and hence
1390 * at least of size transform->ivlen.
1391 *
1392 * Together with the potential IV-prefix, this explains
1393 * the first of the two checks below.
1394 *
1395 * - The record must contain a MAC, either in plain or
1396 * encrypted, depending on whether Encrypt-then-MAC
1397 * is used or not.
1398 * - If it is, the message contains the IV-prefix,
1399 * the CBC ciphertext, and the MAC.
1400 * - If it is not, the padded plaintext, and hence
1401 * the CBC ciphertext, has at least length maclen + 1
1402 * because there is at least the padding length byte.
1403 *
1404 * As the CBC ciphertext is not empty, both cases give the
1405 * lower bound minlen + maclen + 1 on the record size, which
1406 * we test for in the second check below.
1407 */
1408 if( rec->data_len < minlen + transform->ivlen ||
1409 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001410 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1412 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1413 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001414 "+ 1 ) ( + expl IV )", rec->data_len,
1415 transform->ivlen,
1416 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001418 }
1419
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001420 /*
1421 * Authenticate before decrypt if enabled
1422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001425 {
Hanno Becker992b6872017-11-09 18:57:39 +00001426 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001429
Hanno Beckerd96a6522019-07-10 13:55:25 +01001430 /* Update data_len in tandem with add_data.
1431 *
1432 * The subtraction is safe because of the previous check
1433 * data_len >= minlen + maclen + 1.
1434 *
1435 * Afterwards, we know that data + data_len is followed by at
1436 * least maclen Bytes, which justifies the call to
1437 * mbedtls_ssl_safer_memcmp() below.
1438 *
1439 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001441 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001442 transform->minor_ver,
1443 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001444
Hanno Beckerd96a6522019-07-10 13:55:25 +01001445 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001446 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1447 add_data_len );
1448 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1449 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1451 data, rec->data_len );
1452 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1453 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001454
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1456 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001457 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001459
Hanno Beckerd96a6522019-07-10 13:55:25 +01001460 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1462 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001466 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001467 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001468 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001470
1471 /*
1472 * Check length sanity
1473 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001474
1475 /* We know from above that data_len > minlen >= 0,
1476 * so the following check in particular implies that
1477 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001478 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001479 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001480 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1481 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001482 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001484 }
1485
TRodziewicz0f82ec62021-05-12 17:49:18 +02001486#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001487 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001488 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001489 */
TRodziewicz345165c2021-07-06 13:42:11 +02001490 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1491 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001492
TRodziewicz345165c2021-07-06 13:42:11 +02001493 data += transform->ivlen;
1494 rec->data_offset += transform->ivlen;
1495 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001496#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001497
Hanno Beckerd96a6522019-07-10 13:55:25 +01001498 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1499
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1501 transform->iv_dec, transform->ivlen,
1502 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001505 return( ret );
1506 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001507
Hanno Beckerd96a6522019-07-10 13:55:25 +01001508 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001509 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001513 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001514
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001515 /* Safe since data_len >= minlen + maclen + 1, so after having
1516 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001517 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1518 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001520
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 if( auth_done == 1 )
1522 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001523 const size_t mask = mbedtls_ssl_cf_mask_ge(
1524 rec->data_len,
1525 padlen + 1 );
1526 correct &= mask;
1527 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 }
1529 else
Paul Bakker45829992013-01-03 14:52:21 +01001530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( rec->data_len < transform->maclen + padlen + 1 )
1533 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1535 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1536 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 rec->data_len,
1538 transform->maclen,
1539 padlen + 1 ) );
1540 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001541#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001543 const size_t mask = mbedtls_ssl_cf_mask_ge(
1544 rec->data_len,
1545 transform->maclen + padlen + 1 );
1546 correct &= mask;
1547 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001548 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 padlen++;
1551
1552 /* Regardless of the validity of the padding,
1553 * we have data_len >= padlen here. */
1554
TRodziewicz0f82ec62021-05-12 17:49:18 +02001555#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001556 /* The padding check involves a series of up to 256
1557 * consecutive memory reads at the end of the record
1558 * plaintext buffer. In order to hide the length and
1559 * validity of the padding, always perform exactly
1560 * `min(256,plaintext_len)` reads (but take into account
1561 * only the last `padlen` bytes for the padding check). */
1562 size_t pad_count = 0;
1563 volatile unsigned char* const check = data;
1564
1565 /* Index of first padding byte; it has been ensured above
1566 * that the subtraction is safe. */
1567 size_t const padding_idx = rec->data_len - padlen;
1568 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1569 size_t const start_idx = rec->data_len - num_checks;
1570 size_t idx;
1571
1572 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001573 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001574 /* pad_count += (idx >= padding_idx) &&
1575 * (check[idx] == padlen - 1);
1576 */
1577 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1578 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1579 padlen - 1 );
1580 pad_count += mask & equal;
1581 }
1582 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001585 if( padlen > 0 && correct == 0 )
1586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001587#endif
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001588 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
1589
TRodziewicz0f82ec62021-05-12 17:49:18 +02001590#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001591
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001592 /* If the padding was found to be invalid, padlen == 0
1593 * and the subtraction is safe. If the padding was found valid,
1594 * padlen hasn't been changed and the previous assertion
1595 * data_len >= padlen still holds. */
1596 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001598 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001599#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001600 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001603 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001604
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001605#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001607 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001608#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001609
1610 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001611 * Authenticate if not done yet.
1612 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001613 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001614#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001615 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001616 {
Hanno Becker992b6872017-11-09 18:57:39 +00001617 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001618 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001619
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 /* If the initial value of padlen was such that
1621 * data_len < maclen + padlen + 1, then padlen
1622 * got reset to 1, and the initial check
1623 * data_len >= minlen + maclen + 1
1624 * guarantees that at this point we still
1625 * have at least data_len >= maclen.
1626 *
1627 * If the initial value of padlen was such that
1628 * data_len >= maclen + padlen + 1, then we have
1629 * subtracted either padlen + 1 (if the padding was correct)
1630 * or 0 (if the padding was incorrect) since then,
1631 * hence data_len >= maclen in any case.
1632 */
1633 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001634 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001635 transform->minor_ver,
1636 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001637
TRodziewicz0f82ec62021-05-12 17:49:18 +02001638#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001639 /*
1640 * The next two sizes are the minimum and maximum values of
1641 * data_len over all padlen values.
1642 *
1643 * They're independent of padlen, since we previously did
1644 * data_len -= padlen.
1645 *
1646 * Note that max_len + maclen is never more than the buffer
1647 * length, as we previously did in_msglen -= maclen too.
1648 */
1649 const size_t max_len = rec->data_len + padlen;
1650 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1651
1652 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1653 add_data, add_data_len,
1654 data, rec->data_len, min_len, max_len,
1655 mac_expect );
1656 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001657 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1659 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001660 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001661
1662 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1663 rec->data_len,
1664 min_len, max_len,
1665 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001666#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001667
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001668#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001669 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001670 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001671#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001672
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001673 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001675 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#if defined(MBEDTLS_SSL_DEBUG_ALL)
1677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001678#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001679 correct = 0;
1680 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001681 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001682 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001683
1684 /*
1685 * Finally check the correct flag
1686 */
1687 if( correct == 0 )
1688 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001689#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001690
1691 /* Make extra sure authentication was performed, exactly once */
1692 if( auth_done != 1 )
1693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1695 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001696 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001697
Hanno Beckerccc13d02020-05-04 12:30:04 +01001698#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1699 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1700 {
1701 /* Remove inner padding and infer true content type. */
1702 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1703 &rec->type );
1704
1705 if( ret != 0 )
1706 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1707 }
1708#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1709
Hanno Beckera0e20d02019-05-15 14:03:01 +01001710#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001711 if( rec->cid_len != 0 )
1712 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001713 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1714 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001715 if( ret != 0 )
1716 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1717 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001718#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
1722 return( 0 );
1723}
1724
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001725#undef MAC_NONE
1726#undef MAC_PLAINTEXT
1727#undef MAC_CIPHERTEXT
1728
Paul Bakker5121ce52009-01-03 21:22:43 +00001729/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001730 * Fill the input message buffer by appending data to it.
1731 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001732 *
1733 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1734 * available (from this read and/or a previous one). Otherwise, an error code
1735 * is returned (possibly EOF or WANT_READ).
1736 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001737 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1738 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1739 * since we always read a whole datagram at once.
1740 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001741 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001742 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001745{
Janos Follath865b3eb2019-12-16 11:46:15 +00001746 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001747 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1749 size_t in_buf_len = ssl->in_buf_len;
1750#else
1751 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1752#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001756 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001759 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001761 }
1762
Darryl Greenb33cc762019-11-28 14:29:44 +00001763 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001767 }
1768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001770 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001771 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001772 uint32_t timeout;
1773
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001774 /*
1775 * The point is, we need to always read a full datagram at once, so we
1776 * sometimes read more then requested, and handle the additional data.
1777 * It could be the rest of the current record (while fetching the
1778 * header) and/or some other records in the same datagram.
1779 */
1780
1781 /*
1782 * Move to the next record in the already read datagram if applicable
1783 */
1784 if( ssl->next_record_offset != 0 )
1785 {
1786 if( ssl->in_left < ssl->next_record_offset )
1787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1789 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001790 }
1791
1792 ssl->in_left -= ssl->next_record_offset;
1793
1794 if( ssl->in_left != 0 )
1795 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001796 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1797 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001798 ssl->next_record_offset ) );
1799 memmove( ssl->in_hdr,
1800 ssl->in_hdr + ssl->next_record_offset,
1801 ssl->in_left );
1802 }
1803
1804 ssl->next_record_offset = 0;
1805 }
1806
Paul Elliottd48d5c62021-01-07 14:47:05 +00001807 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1808 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001809 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001810
1811 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001812 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001813 */
1814 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001817 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001818 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001819
1820 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001821 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001822 * are not at the beginning of a new record, the caller did something
1823 * wrong.
1824 */
1825 if( ssl->in_left != 0 )
1826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1828 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001829 }
1830
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001831 /*
1832 * Don't even try to read if time's out already.
1833 * This avoids by-passing the timer when repeatedly receiving messages
1834 * that will end up being dropped.
1835 */
Hanno Becker7876d122020-02-05 10:39:31 +00001836 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001837 {
1838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001839 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001840 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001841 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001842 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001843 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001846 timeout = ssl->handshake->retransmit_timeout;
1847 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001848 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001849
Paul Elliott9f352112020-12-09 14:55:45 +00001850 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001851
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001852 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001853 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1854 timeout );
1855 else
1856 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001859
1860 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001862 }
1863
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001864 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001867 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001870 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001871 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001874 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001875 }
1876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001878 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001880 return( ret );
1881 }
1882
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001883 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001884 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001886 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001888 {
Hanno Becker786300f2020-02-05 10:46:40 +00001889 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001890 {
Hanno Becker786300f2020-02-05 10:46:40 +00001891 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1892 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001893 return( ret );
1894 }
1895
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001896 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001897 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001899 }
1900
Paul Bakker5121ce52009-01-03 21:22:43 +00001901 if( ret < 0 )
1902 return( ret );
1903
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001904 ssl->in_left = ret;
1905 }
1906 else
1907#endif
1908 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001909 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1910 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001911 ssl->in_left, nb_want ) );
1912
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001913 while( ssl->in_left < nb_want )
1914 {
1915 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001916
Hanno Becker7876d122020-02-05 10:39:31 +00001917 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001918 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1919 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001920 {
1921 if( ssl->f_recv_timeout != NULL )
1922 {
1923 ret = ssl->f_recv_timeout( ssl->p_bio,
1924 ssl->in_hdr + ssl->in_left, len,
1925 ssl->conf->read_timeout );
1926 }
1927 else
1928 {
1929 ret = ssl->f_recv( ssl->p_bio,
1930 ssl->in_hdr + ssl->in_left, len );
1931 }
1932 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
Paul Elliottd48d5c62021-01-07 14:47:05 +00001934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1935 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001936 ssl->in_left, nb_want ) );
1937 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938
1939 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941
1942 if( ret < 0 )
1943 return( ret );
1944
makise-homuraaf9513b2020-08-24 18:26:27 +03001945 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001946 {
Darryl Green11999bb2018-03-13 15:22:58 +00001947 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001948 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001949 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001950 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1951 }
1952
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001953 ssl->in_left += ret;
1954 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001955 }
1956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001958
1959 return( 0 );
1960}
1961
1962/*
1963 * Flush any data not yet written
1964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001966{
Janos Follath865b3eb2019-12-16 11:46:15 +00001967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001968 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001971
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001972 if( ssl->f_send == NULL )
1973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001975 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001977 }
1978
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001979 /* Avoid incrementing counter if data is flushed */
1980 if( ssl->out_left == 0 )
1981 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001983 return( 0 );
1984 }
1985
Paul Bakker5121ce52009-01-03 21:22:43 +00001986 while( ssl->out_left > 0 )
1987 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1989 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001990 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001991
Hanno Becker2b1e3542018-08-06 11:19:13 +01001992 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001993 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001996
1997 if( ret <= 0 )
1998 return( ret );
1999
makise-homuraaf9513b2020-08-24 18:26:27 +03002000 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002001 {
Darryl Green11999bb2018-03-13 15:22:58 +00002002 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002003 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002004 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002005 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2006 }
2007
Paul Bakker5121ce52009-01-03 21:22:43 +00002008 ssl->out_left -= ret;
2009 }
2010
Hanno Becker2b1e3542018-08-06 11:19:13 +01002011#if defined(MBEDTLS_SSL_PROTO_DTLS)
2012 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002013 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002014 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002015 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002016 else
2017#endif
2018 {
2019 ssl->out_hdr = ssl->out_buf + 8;
2020 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002021 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002024
2025 return( 0 );
2026}
2027
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002028/*
2029 * Functions to handle the DTLS retransmission state machine
2030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002032/*
2033 * Append current handshake message to current outgoing flight
2034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2039 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2040 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002041
2042 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002043 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002044 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002045 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002047 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048 }
2049
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002050 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002051 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002052 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2053 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002055 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056 }
2057
2058 /* Copy current handshake message with headers */
2059 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2060 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002061 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062 msg->next = NULL;
2063
2064 /* Append to the current flight */
2065 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002066 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002067 else
2068 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002070 while( cur->next != NULL )
2071 cur = cur->next;
2072 cur->next = msg;
2073 }
2074
Hanno Becker3b235902018-08-06 09:54:53 +01002075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002076 return( 0 );
2077}
2078
2079/*
2080 * Free the current flight of handshake messages
2081 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002082void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002083{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 mbedtls_ssl_flight_item *cur = flight;
2085 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002086
2087 while( cur != NULL )
2088 {
2089 next = cur->next;
2090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 mbedtls_free( cur->p );
2092 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002093
2094 cur = next;
2095 }
2096}
2097
2098/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002099 * Swap transform_out and out_ctr with the alternative ones
2100 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002101static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002102{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002104 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105
2106 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002109 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110 }
2111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002113
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002114 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115 tmp_transform = ssl->transform_out;
2116 ssl->transform_out = ssl->handshake->alt_transform_out;
2117 ssl->handshake->alt_transform_out = tmp_transform;
2118
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002119 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002120 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2121 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2122 sizeof( ssl->cur_out_ctr ) );
2123 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2124 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002125
2126 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002127 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002128
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002129 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002130}
2131
2132/*
2133 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002134 */
2135int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2136{
2137 int ret = 0;
2138
2139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2140
2141 ret = mbedtls_ssl_flight_transmit( ssl );
2142
2143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2144
2145 return( ret );
2146}
2147
2148/*
2149 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150 *
2151 * Need to remember the current message in case flush_output returns
2152 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002153 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002155int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156{
Janos Follath865b3eb2019-12-16 11:46:15 +00002157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002163
2164 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002165 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002166 ret = ssl_swap_epochs( ssl );
2167 if( ret != 0 )
2168 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002172
2173 while( ssl->handshake->cur_msg != NULL )
2174 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002175 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002176 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002177
Hanno Beckere1dcb032018-08-17 16:47:58 +01002178 int const is_finished =
2179 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2180 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2181
Hanno Becker04da1892018-08-14 13:22:10 +01002182 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2183 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2184
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002185 /* Swap epochs before sending Finished: we can't do it after
2186 * sending ChangeCipherSpec, in case write returns WANT_READ.
2187 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002188 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002189 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002190 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002191 ret = ssl_swap_epochs( ssl );
2192 if( ret != 0 )
2193 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002194 }
2195
Hanno Becker67bc7c32018-08-06 11:33:50 +01002196 ret = ssl_get_remaining_payload_in_datagram( ssl );
2197 if( ret < 0 )
2198 return( ret );
2199 max_frag_len = (size_t) ret;
2200
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002201 /* CCS is copied as is, while HS messages may need fragmentation */
2202 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2203 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002204 if( max_frag_len == 0 )
2205 {
2206 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2207 return( ret );
2208
2209 continue;
2210 }
2211
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002212 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002213 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002214 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002215
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002216 /* Update position inside current message */
2217 ssl->handshake->cur_msg_p += cur->len;
2218 }
2219 else
2220 {
2221 const unsigned char * const p = ssl->handshake->cur_msg_p;
2222 const size_t hs_len = cur->len - 12;
2223 const size_t frag_off = p - ( cur->p + 12 );
2224 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002225 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002226
Hanno Beckere1dcb032018-08-17 16:47:58 +01002227 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002228 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002229 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002230 {
2231 ret = ssl_swap_epochs( ssl );
2232 if( ret != 0 )
2233 return( ret );
2234 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235
Hanno Becker67bc7c32018-08-06 11:33:50 +01002236 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2237 return( ret );
2238
2239 continue;
2240 }
2241 max_hs_frag_len = max_frag_len - 12;
2242
2243 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2244 max_hs_frag_len : rem_len;
2245
2246 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002247 {
2248 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002249 (unsigned) cur_hs_frag_len,
2250 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002251 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002252
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002253 /* Messages are stored with handshake headers as if not fragmented,
2254 * copy beginning of headers then fill fragmentation fields.
2255 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2256 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani6f2bb0c2021-06-24 09:06:23 +01002257
Joe Subbiani5ecac212021-06-24 13:00:03 +01002258 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2259 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2260 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002261
Joe Subbiani5ecac212021-06-24 13:00:03 +01002262 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2263 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2264 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002265
2266 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2267
Hanno Becker3f7b9732018-08-28 09:53:25 +01002268 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002269 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2270 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002271 ssl->out_msgtype = cur->type;
2272
2273 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002274 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002275 }
2276
2277 /* If done with the current message move to the next one if any */
2278 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2279 {
2280 if( cur->next != NULL )
2281 {
2282 ssl->handshake->cur_msg = cur->next;
2283 ssl->handshake->cur_msg_p = cur->next->p + 12;
2284 }
2285 else
2286 {
2287 ssl->handshake->cur_msg = NULL;
2288 ssl->handshake->cur_msg_p = NULL;
2289 }
2290 }
2291
2292 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002293 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002294 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296 return( ret );
2297 }
2298 }
2299
Hanno Becker67bc7c32018-08-06 11:33:50 +01002300 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2301 return( ret );
2302
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002303 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2305 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002306 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002309 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002310 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002311
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
2314 return( 0 );
2315}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002316
2317/*
2318 * To be called when the last message of an incoming flight is received.
2319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002321{
2322 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002323 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324 ssl->handshake->flight = NULL;
2325 ssl->handshake->cur_msg = NULL;
2326
2327 /* The next incoming flight will start with this msg_seq */
2328 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2329
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002330 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002331 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002332
Hanno Becker0271f962018-08-16 13:23:47 +01002333 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002334 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002335
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002336 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002337 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2340 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002343 }
2344 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002346}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002347
2348/*
2349 * To be called when the last message of an outgoing flight is send.
2350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002352{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002353 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002354 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2357 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002358 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002360 }
2361 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002363}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002365
Paul Bakker5121ce52009-01-03 21:22:43 +00002366/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002367 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002368 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369
2370/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002371 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002372 *
2373 * - fill in handshake headers
2374 * - update handshake checksum
2375 * - DTLS: save message for resending
2376 * - then pass to the record layer
2377 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002378 * DTLS: except for HelloRequest, messages are only queued, and will only be
2379 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002380 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002381 * Inputs:
2382 * - ssl->out_msglen: 4 + actual handshake message len
2383 * (4 is the size of handshake headers for TLS)
2384 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2385 * - ssl->out_msg + 4: the handshake message body
2386 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002387 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002388 * - ssl->out_msglen: the length of the record contents
2389 * (including handshake headers but excluding record headers)
2390 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002391 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002392int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2393 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002394{
Janos Follath865b3eb2019-12-16 11:46:15 +00002395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002396 const size_t hs_len = ssl->out_msglen - 4;
2397 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002398
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002399 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2400
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002401 /*
2402 * Sanity checks
2403 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002404 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002405 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2406 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002407 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2408 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002409 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002410
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002411 /* Whenever we send anything different from a
2412 * HelloRequest we should be in a handshake - double check. */
2413 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2414 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002415 ssl->handshake == NULL )
2416 {
2417 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2418 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2419 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002422 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2427 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002428 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002429#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002430
Hanno Beckerb50a2532018-08-06 11:52:54 +01002431 /* Double-check that we did not exceed the bounds
2432 * of the outgoing record buffer.
2433 * This should never fail as the various message
2434 * writing functions must obey the bounds of the
2435 * outgoing record buffer, but better be safe.
2436 *
2437 * Note: We deliberately do not check for the MTU or MFL here.
2438 */
2439 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2440 {
2441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002442 "size %" MBEDTLS_PRINTF_SIZET
2443 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002444 ssl->out_msglen,
2445 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002446 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2447 }
2448
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002449 /*
2450 * Fill handshake headers
2451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002453 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002454 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2455 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2456 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002457
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002458 /*
2459 * DTLS has additional fields in the Handshake layer,
2460 * between the length field and the actual payload:
2461 * uint16 message_seq;
2462 * uint24 fragment_offset;
2463 * uint24 fragment_length;
2464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002466 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002467 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002468 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002469 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002470 {
2471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002472 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002473 hs_len,
2474 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002475 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2476 }
2477
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002478 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002479 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002480
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002481 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002482 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002483 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002484 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002485 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002486 }
2487 else
2488 {
2489 ssl->out_msg[4] = 0;
2490 ssl->out_msg[5] = 0;
2491 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002492
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002493 /* Handshake hashes are computed without fragmentation,
2494 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002495 memset( ssl->out_msg + 6, 0x00, 3 );
2496 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002497 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002499
Hanno Becker0207e532018-08-28 10:28:28 +01002500 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002501 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002502 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002503 }
2504
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002505 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002507 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002508 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2509 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510 {
2511 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002514 return( ret );
2515 }
2516 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002520 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521 {
2522 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2523 return( ret );
2524 }
2525 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002526
2527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2528
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002529 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002530}
2531
2532/*
2533 * Record layer functions
2534 */
2535
2536/*
2537 * Write current record.
2538 *
2539 * Uses:
2540 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2541 * - ssl->out_msglen: length of the record content (excl headers)
2542 * - ssl->out_msg: record content
2543 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002544int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002545{
2546 int ret, done = 0;
2547 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002548 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002549
2550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002551
Paul Bakker05ef8352012-05-08 09:17:57 +00002552 if( !done )
2553 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002554 unsigned i;
2555 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002556#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2557 size_t out_buf_len = ssl->out_buf_len;
2558#else
2559 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2560#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002561 /* Skip writing the record content type to after the encryption,
2562 * as it may change when using the CID extension. */
2563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002565 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002566
Jerry Yuae0b2e22021-10-08 15:21:19 +08002567 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002568 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002569
Paul Bakker48916f92012-09-16 19:57:18 +00002570 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002571 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002572 mbedtls_record rec;
2573
2574 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002575 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002576 rec.data_len = ssl->out_msglen;
2577 rec.data_offset = ssl->out_msg - rec.buf;
2578
Jerry Yud96a5c22021-09-29 17:46:51 +08002579 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002580 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2581 ssl->conf->transport, rec.ver );
2582 rec.type = ssl->out_msgtype;
2583
Hanno Beckera0e20d02019-05-15 14:03:01 +01002584#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002585 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002586 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002587#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002588
Hanno Beckera18d1322018-01-03 14:27:32 +00002589 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002590 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002593 return( ret );
2594 }
2595
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002596 if( rec.data_offset != 0 )
2597 {
2598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2599 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2600 }
2601
Hanno Becker6430faf2019-05-08 11:57:13 +01002602 /* Update the record content type and CID. */
2603 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002604#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002605 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002606#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002607 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002608 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002609 }
2610
Hanno Becker5903de42019-05-03 14:46:38 +01002611 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002612
2613#if defined(MBEDTLS_SSL_PROTO_DTLS)
2614 /* In case of DTLS, double-check that we don't exceed
2615 * the remaining space in the datagram. */
2616 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2617 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002618 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002619 if( ret < 0 )
2620 return( ret );
2621
2622 if( protected_record_size > (size_t) ret )
2623 {
2624 /* Should never happen */
2625 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2626 }
2627 }
2628#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002629
Hanno Becker6430faf2019-05-08 11:57:13 +01002630 /* Now write the potentially updated record content type. */
2631 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2632
Paul Elliott9f352112020-12-09 14:55:45 +00002633 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002634 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002635 ssl->out_hdr[0], ssl->out_hdr[1],
2636 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002639 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002640
2641 ssl->out_left += protected_record_size;
2642 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002643 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002644
Hanno Beckerdd772292020-02-05 10:38:31 +00002645 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002646 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2647 break;
2648
2649 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002650 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002651 {
2652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2653 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2654 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002655 }
2656
Hanno Becker67bc7c32018-08-06 11:33:50 +01002657#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002658 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2659 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002660 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002661 size_t remaining;
2662 ret = ssl_get_remaining_payload_in_datagram( ssl );
2663 if( ret < 0 )
2664 {
2665 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2666 ret );
2667 return( ret );
2668 }
2669
2670 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002671 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002672 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002673 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002674 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002675 else
2676 {
Hanno Becker513815a2018-08-20 11:56:09 +01002677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002678 }
2679 }
2680#endif /* MBEDTLS_SSL_PROTO_DTLS */
2681
2682 if( ( flush == SSL_FORCE_FLUSH ) &&
2683 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002686 return( ret );
2687 }
2688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002690
2691 return( 0 );
2692}
2693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002695
2696static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2697{
2698 if( ssl->in_msglen < ssl->in_hslen ||
2699 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2700 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2701 {
2702 return( 1 );
2703 }
2704 return( 0 );
2705}
Hanno Becker44650b72018-08-16 12:51:11 +01002706
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002707static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002708{
2709 return( ( ssl->in_msg[9] << 16 ) |
2710 ( ssl->in_msg[10] << 8 ) |
2711 ssl->in_msg[11] );
2712}
2713
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002714static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002715{
2716 return( ( ssl->in_msg[6] << 16 ) |
2717 ( ssl->in_msg[7] << 8 ) |
2718 ssl->in_msg[8] );
2719}
2720
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002721static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002722{
2723 uint32_t msg_len, frag_off, frag_len;
2724
2725 msg_len = ssl_get_hs_total_len( ssl );
2726 frag_off = ssl_get_hs_frag_off( ssl );
2727 frag_len = ssl_get_hs_frag_len( ssl );
2728
2729 if( frag_off > msg_len )
2730 return( -1 );
2731
2732 if( frag_len > msg_len - frag_off )
2733 return( -1 );
2734
2735 if( frag_len + 12 > ssl->in_msglen )
2736 return( -1 );
2737
2738 return( 0 );
2739}
2740
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002741/*
2742 * Mark bits in bitmask (used for DTLS HS reassembly)
2743 */
2744static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2745{
2746 unsigned int start_bits, end_bits;
2747
2748 start_bits = 8 - ( offset % 8 );
2749 if( start_bits != 8 )
2750 {
2751 size_t first_byte_idx = offset / 8;
2752
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002753 /* Special case */
2754 if( len <= start_bits )
2755 {
2756 for( ; len != 0; len-- )
2757 mask[first_byte_idx] |= 1 << ( start_bits - len );
2758
2759 /* Avoid potential issues with offset or len becoming invalid */
2760 return;
2761 }
2762
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002763 offset += start_bits; /* Now offset % 8 == 0 */
2764 len -= start_bits;
2765
2766 for( ; start_bits != 0; start_bits-- )
2767 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2768 }
2769
2770 end_bits = len % 8;
2771 if( end_bits != 0 )
2772 {
2773 size_t last_byte_idx = ( offset + len ) / 8;
2774
2775 len -= end_bits; /* Now len % 8 == 0 */
2776
2777 for( ; end_bits != 0; end_bits-- )
2778 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2779 }
2780
2781 memset( mask + offset / 8, 0xFF, len / 8 );
2782}
2783
2784/*
2785 * Check that bitmask is full
2786 */
2787static int ssl_bitmask_check( unsigned char *mask, size_t len )
2788{
2789 size_t i;
2790
2791 for( i = 0; i < len / 8; i++ )
2792 if( mask[i] != 0xFF )
2793 return( -1 );
2794
2795 for( i = 0; i < len % 8; i++ )
2796 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2797 return( -1 );
2798
2799 return( 0 );
2800}
2801
Hanno Becker56e205e2018-08-16 09:06:12 +01002802/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002803static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002804 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002805{
Hanno Becker56e205e2018-08-16 09:06:12 +01002806 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002807
Hanno Becker56e205e2018-08-16 09:06:12 +01002808 alloc_len = 12; /* Handshake header */
2809 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002810
Hanno Beckerd07df862018-08-16 09:14:58 +01002811 if( add_bitmap )
2812 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002813
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002814 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002815}
Hanno Becker56e205e2018-08-16 09:06:12 +01002816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002818
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002819static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002820{
2821 return( ( ssl->in_msg[1] << 16 ) |
2822 ( ssl->in_msg[2] << 8 ) |
2823 ssl->in_msg[3] );
2824}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002825
Simon Butcher99000142016-10-13 17:21:01 +01002826int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002827{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002829 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002830 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002831 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002833 }
2834
Hanno Becker12555c62018-08-16 12:47:53 +01002835 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002838 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002839 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002842 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002843 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002845 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002846
Hanno Becker44650b72018-08-16 12:51:11 +01002847 if( ssl_check_hs_header( ssl ) != 0 )
2848 {
2849 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2850 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2851 }
2852
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002853 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002854 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2855 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2856 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2857 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002858 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002859 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2860 {
2861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2862 recv_msg_seq,
2863 ssl->handshake->in_msg_seq ) );
2864 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2865 }
2866
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002867 /* Retransmit only on last message from previous flight, to avoid
2868 * too many retransmissions.
2869 * Besides, No sane server ever retransmits HelloVerifyRequest */
2870 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002874 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002875 recv_msg_seq,
2876 ssl->handshake->in_flight_start_seq ) );
2877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002881 return( ret );
2882 }
2883 }
2884 else
2885 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002887 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002888 recv_msg_seq,
2889 ssl->handshake->in_msg_seq ) );
2890 }
2891
Hanno Becker90333da2017-10-10 11:27:13 +01002892 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002893 }
2894 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002895
Hanno Becker6d97ef52018-08-16 13:09:04 +01002896 /* Message reassembly is handled alongside buffering of future
2897 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002898 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002899 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002900 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002901 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002903 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002904 }
2905 }
2906 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002908 /* With TLS we don't handle fragmentation (for now) */
2909 if( ssl->in_msglen < ssl->in_hslen )
2910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2912 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002913 }
2914
Simon Butcher99000142016-10-13 17:21:01 +01002915 return( 0 );
2916}
2917
2918void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2919{
Hanno Becker0271f962018-08-16 13:23:47 +01002920 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002921
Hanno Becker0271f962018-08-16 13:23:47 +01002922 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002923 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002924 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002925 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002926
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002927 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002929 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002930 ssl->handshake != NULL )
2931 {
Hanno Becker0271f962018-08-16 13:23:47 +01002932 unsigned offset;
2933 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002934
Hanno Becker0271f962018-08-16 13:23:47 +01002935 /* Increment handshake sequence number */
2936 hs->in_msg_seq++;
2937
2938 /*
2939 * Clear up handshake buffering and reassembly structure.
2940 */
2941
2942 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002943 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002944
2945 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002946 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2947 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002948 offset++, hs_buf++ )
2949 {
2950 *hs_buf = *(hs_buf + 1);
2951 }
2952
2953 /* Create a fresh last entry */
2954 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002955 }
2956#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002957}
2958
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002959/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002960 * DTLS anti-replay: RFC 6347 4.1.2.6
2961 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002962 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2963 * Bit n is set iff record number in_window_top - n has been seen.
2964 *
2965 * Usually, in_window_top is the last record number seen and the lsb of
2966 * in_window is set. The only exception is the initial state (record number 0
2967 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002970void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002971{
2972 ssl->in_window_top = 0;
2973 ssl->in_window = 0;
2974}
2975
2976static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2977{
2978 return( ( (uint64_t) buf[0] << 40 ) |
2979 ( (uint64_t) buf[1] << 32 ) |
2980 ( (uint64_t) buf[2] << 24 ) |
2981 ( (uint64_t) buf[3] << 16 ) |
2982 ( (uint64_t) buf[4] << 8 ) |
2983 ( (uint64_t) buf[5] ) );
2984}
2985
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002986static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2987{
Janos Follath865b3eb2019-12-16 11:46:15 +00002988 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002989 unsigned char *original_in_ctr;
2990
2991 // save original in_ctr
2992 original_in_ctr = ssl->in_ctr;
2993
2994 // use counter from record
2995 ssl->in_ctr = record_in_ctr;
2996
2997 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2998
2999 // restore the counter
3000 ssl->in_ctr = original_in_ctr;
3001
3002 return ret;
3003}
3004
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003005/*
3006 * Return 0 if sequence number is acceptable, -1 otherwise
3007 */
Hanno Becker0183d692019-07-12 08:50:37 +01003008int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003009{
3010 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3011 uint64_t bit;
3012
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003013 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003014 return( 0 );
3015
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003016 if( rec_seqnum > ssl->in_window_top )
3017 return( 0 );
3018
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003019 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003020
3021 if( bit >= 64 )
3022 return( -1 );
3023
3024 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3025 return( -1 );
3026
3027 return( 0 );
3028}
3029
3030/*
3031 * Update replay window on new validated record
3032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003034{
3035 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3036
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003037 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003038 return;
3039
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003040 if( rec_seqnum > ssl->in_window_top )
3041 {
3042 /* Update window_top and the contents of the window */
3043 uint64_t shift = rec_seqnum - ssl->in_window_top;
3044
3045 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003046 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003047 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003048 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003049 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003050 ssl->in_window |= 1;
3051 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003052
3053 ssl->in_window_top = rec_seqnum;
3054 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003055 else
3056 {
3057 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003058 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003059
3060 if( bit < 64 ) /* Always true, but be extra sure */
3061 ssl->in_window |= (uint64_t) 1 << bit;
3062 }
3063}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003065
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003066#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003067/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003068 * Without any SSL context, check if a datagram looks like a ClientHello with
3069 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003070 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003071 *
3072 * - if cookie is valid, return 0
3073 * - if ClientHello looks superficially valid but cookie is not,
3074 * fill obuf and set olen, then
3075 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3076 * - otherwise return a specific error code
3077 */
3078static int ssl_check_dtls_clihlo_cookie(
3079 mbedtls_ssl_cookie_write_t *f_cookie_write,
3080 mbedtls_ssl_cookie_check_t *f_cookie_check,
3081 void *p_cookie,
3082 const unsigned char *cli_id, size_t cli_id_len,
3083 const unsigned char *in, size_t in_len,
3084 unsigned char *obuf, size_t buf_len, size_t *olen )
3085{
3086 size_t sid_len, cookie_len;
3087 unsigned char *p;
3088
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003089 /*
3090 * Structure of ClientHello with record and handshake headers,
3091 * and expected values. We don't need to check a lot, more checks will be
3092 * done when actually parsing the ClientHello - skipping those checks
3093 * avoids code duplication and does not make cookie forging any easier.
3094 *
3095 * 0-0 ContentType type; copied, must be handshake
3096 * 1-2 ProtocolVersion version; copied
3097 * 3-4 uint16 epoch; copied, must be 0
3098 * 5-10 uint48 sequence_number; copied
3099 * 11-12 uint16 length; (ignored)
3100 *
3101 * 13-13 HandshakeType msg_type; (ignored)
3102 * 14-16 uint24 length; (ignored)
3103 * 17-18 uint16 message_seq; copied
3104 * 19-21 uint24 fragment_offset; copied, must be 0
3105 * 22-24 uint24 fragment_length; (ignored)
3106 *
3107 * 25-26 ProtocolVersion client_version; (ignored)
3108 * 27-58 Random random; (ignored)
3109 * 59-xx SessionID session_id; 1 byte len + sid_len content
3110 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3111 * ...
3112 *
3113 * Minimum length is 61 bytes.
3114 */
3115 if( in_len < 61 ||
3116 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3117 in[3] != 0 || in[4] != 0 ||
3118 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3119 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003120 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003121 }
3122
3123 sid_len = in[59];
3124 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003125 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003126
3127 cookie_len = in[60 + sid_len];
3128 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003129 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003130
3131 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3132 cli_id, cli_id_len ) == 0 )
3133 {
3134 /* Valid cookie */
3135 return( 0 );
3136 }
3137
3138 /*
3139 * If we get here, we've got an invalid cookie, let's prepare HVR.
3140 *
3141 * 0-0 ContentType type; copied
3142 * 1-2 ProtocolVersion version; copied
3143 * 3-4 uint16 epoch; copied
3144 * 5-10 uint48 sequence_number; copied
3145 * 11-12 uint16 length; olen - 13
3146 *
3147 * 13-13 HandshakeType msg_type; hello_verify_request
3148 * 14-16 uint24 length; olen - 25
3149 * 17-18 uint16 message_seq; copied
3150 * 19-21 uint24 fragment_offset; copied
3151 * 22-24 uint24 fragment_length; olen - 25
3152 *
3153 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3154 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3155 *
3156 * Minimum length is 28.
3157 */
3158 if( buf_len < 28 )
3159 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3160
3161 /* Copy most fields and adapt others */
3162 memcpy( obuf, in, 25 );
3163 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3164 obuf[25] = 0xfe;
3165 obuf[26] = 0xff;
3166
3167 /* Generate and write actual cookie */
3168 p = obuf + 28;
3169 if( f_cookie_write( p_cookie,
3170 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3171 {
3172 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3173 }
3174
3175 *olen = p - obuf;
3176
3177 /* Go back and fill length fields */
3178 obuf[27] = (unsigned char)( *olen - 28 );
3179
Joe Subbianifbeb6922021-07-16 14:27:50 +01003180 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3181 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3182 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003183
Joe Subbiani6dd73642021-07-19 11:56:54 +01003184 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003185
3186 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3187}
3188
3189/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003190 * Handle possible client reconnect with the same UDP quadruplet
3191 * (RFC 6347 Section 4.2.8).
3192 *
3193 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3194 * that looks like a ClientHello.
3195 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003196 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003197 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003198 * - if the input looks like a ClientHello with a valid cookie,
3199 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003200 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003201 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003202 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003203 * This function is called (through ssl_check_client_reconnect()) when an
3204 * unexpected record is found in ssl_get_next_record(), which will discard the
3205 * record if we return 0, and bubble up the return value otherwise (this
3206 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3207 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003208 */
3209static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3210{
Janos Follath865b3eb2019-12-16 11:46:15 +00003211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003212 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003213
Hanno Becker2fddd372019-07-10 14:37:41 +01003214 if( ssl->conf->f_cookie_write == NULL ||
3215 ssl->conf->f_cookie_check == NULL )
3216 {
3217 /* If we can't use cookies to verify reachability of the peer,
3218 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3220 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003221 return( 0 );
3222 }
3223
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003224 ret = ssl_check_dtls_clihlo_cookie(
3225 ssl->conf->f_cookie_write,
3226 ssl->conf->f_cookie_check,
3227 ssl->conf->p_cookie,
3228 ssl->cli_id, ssl->cli_id_len,
3229 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003230 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003231
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003232 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3233
3234 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003235 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003236 int send_ret;
3237 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3238 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3239 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003240 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003241 * If the error is permanent we'll catch it later,
3242 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003243 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3244 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3245 (void) send_ret;
3246
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003247 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003248 }
3249
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003250 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003251 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003252 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003253 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003254 {
3255 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3256 return( ret );
3257 }
3258
3259 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003260 }
3261
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003262 return( ret );
3263}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003264#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003265
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003266static int ssl_check_record_type( uint8_t record_type )
3267{
3268 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3269 record_type != MBEDTLS_SSL_MSG_ALERT &&
3270 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3271 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3272 {
3273 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3274 }
3275
3276 return( 0 );
3277}
3278
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003279/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003280 * ContentType type;
3281 * ProtocolVersion version;
3282 * uint16 epoch; // DTLS only
3283 * uint48 sequence_number; // DTLS only
3284 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003285 *
3286 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003287 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003288 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3289 *
3290 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003291 * 1. proceed with the record if this function returns 0
3292 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3293 * 3. return CLIENT_RECONNECT if this function return that value
3294 * 4. drop the whole datagram if this function returns anything else.
3295 * Point 2 is needed when the peer is resending, and we have already received
3296 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003297 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003298static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003299 unsigned char *buf,
3300 size_t len,
3301 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003302{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003303 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003304
Hanno Beckere5e7e782019-07-11 12:29:35 +01003305 size_t const rec_hdr_type_offset = 0;
3306 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003307
Hanno Beckere5e7e782019-07-11 12:29:35 +01003308 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3309 rec_hdr_type_len;
3310 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003311
Hanno Beckere5e7e782019-07-11 12:29:35 +01003312 size_t const rec_hdr_ctr_len = 8;
3313#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003314 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003315 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3316 rec_hdr_version_len;
3317
Hanno Beckera0e20d02019-05-15 14:03:01 +01003318#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003319 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3320 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003321 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003322#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3323#endif /* MBEDTLS_SSL_PROTO_DTLS */
3324
3325 size_t rec_hdr_len_offset; /* To be determined */
3326 size_t const rec_hdr_len_len = 2;
3327
3328 /*
3329 * Check minimum lengths for record header.
3330 */
3331
3332#if defined(MBEDTLS_SSL_PROTO_DTLS)
3333 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3334 {
3335 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3336 }
3337 else
3338#endif /* MBEDTLS_SSL_PROTO_DTLS */
3339 {
3340 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3341 }
3342
3343 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3344 {
3345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3346 (unsigned) len,
3347 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3348 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3349 }
3350
3351 /*
3352 * Parse and validate record content type
3353 */
3354
3355 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003356
3357 /* Check record content type */
3358#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3359 rec->cid_len = 0;
3360
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003361 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003362 ssl->conf->cid_len != 0 &&
3363 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003364 {
3365 /* Shift pointers to account for record header including CID
3366 * struct {
3367 * ContentType special_type = tls12_cid;
3368 * ProtocolVersion version;
3369 * uint16 epoch;
3370 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003371 * opaque cid[cid_length]; // Additional field compared to
3372 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003373 * uint16 length;
3374 * opaque enc_content[DTLSCiphertext.length];
3375 * } DTLSCiphertext;
3376 */
3377
3378 /* So far, we only support static CID lengths
3379 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003380 rec_hdr_cid_len = ssl->conf->cid_len;
3381 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003382
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003384 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3386 (unsigned) len,
3387 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003388 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003389 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003390
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003391 /* configured CID len is guaranteed at most 255, see
3392 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3393 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003394 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003395 }
3396 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003397#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003398 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003399 if( ssl_check_record_type( rec->type ) )
3400 {
Hanno Becker54229812019-07-12 14:40:00 +01003401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3402 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003403 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3404 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003405 }
3406
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407 /*
3408 * Parse and validate record version
3409 */
3410
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003411 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3412 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003413 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3414 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003415 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003416
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003417 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003418 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3420 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003421 }
3422
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003423 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3426 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 }
3428
Hanno Beckere5e7e782019-07-11 12:29:35 +01003429 /*
3430 * Parse/Copy record sequence number.
3431 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003432
Hanno Beckere5e7e782019-07-11 12:29:35 +01003433#if defined(MBEDTLS_SSL_PROTO_DTLS)
3434 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003435 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003436 /* Copy explicit record sequence number from input buffer. */
3437 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3438 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003439 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003440 else
3441#endif /* MBEDTLS_SSL_PROTO_DTLS */
3442 {
3443 /* Copy implicit record sequence number from SSL context structure. */
3444 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3445 }
Paul Bakker40e46942009-01-03 21:51:57 +00003446
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 /*
3448 * Parse record length.
3449 */
3450
Hanno Beckere5e7e782019-07-11 12:29:35 +01003451 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003452 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3453 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003454 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003455
Paul Elliott9f352112020-12-09 14:55:45 +00003456 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003457 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003458 rec->type,
3459 major_ver, minor_ver, rec->data_len ) );
3460
3461 rec->buf = buf;
3462 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003463
Hanno Beckerd417cc92019-07-26 08:20:27 +01003464 if( rec->data_len == 0 )
3465 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003467 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003468 * DTLS-related tests.
3469 * Check epoch before checking length constraint because
3470 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3471 * message gets duplicated before the corresponding Finished message,
3472 * the second ChangeCipherSpec should be discarded because it belongs
3473 * to an old epoch, but not because its length is shorter than
3474 * the minimum record length for packets using the new record transform.
3475 * Note that these two kinds of failures are handled differently,
3476 * as an unexpected record is silently skipped but an invalid
3477 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003478 */
3479#if defined(MBEDTLS_SSL_PROTO_DTLS)
3480 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3481 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003482 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003483
Hanno Becker955a5c92019-07-10 17:12:07 +01003484 /* Check that the datagram is large enough to contain a record
3485 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003486 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003487 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3489 (unsigned) len,
3490 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003491 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3492 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003493
Hanno Becker37cfe732019-07-10 17:20:01 +01003494 /* Records from other, non-matching epochs are silently discarded.
3495 * (The case of same-port Client reconnects must be considered in
3496 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003497 if( rec_epoch != ssl->in_epoch )
3498 {
3499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003500 "expected %u, received %lu",
3501 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003502
Hanno Becker552f7472019-07-19 10:59:12 +01003503 /* Records from the next epoch are considered for buffering
3504 * (concretely: early Finished messages). */
3505 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003506 {
Hanno Becker552f7472019-07-19 10:59:12 +01003507 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3508 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003509 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003510
Hanno Becker2fddd372019-07-10 14:37:41 +01003511 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003512 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003513#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003514 /* For records from the correct epoch, check whether their
3515 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003516 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3517 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003518 {
3519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3520 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3521 }
3522#endif
3523 }
3524#endif /* MBEDTLS_SSL_PROTO_DTLS */
3525
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003526 return( 0 );
3527}
Paul Bakker5121ce52009-01-03 21:22:43 +00003528
Paul Bakker5121ce52009-01-03 21:22:43 +00003529
Hanno Becker2fddd372019-07-10 14:37:41 +01003530#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3531static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3532{
3533 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3534
3535 /*
3536 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3537 * access the first byte of record content (handshake type), as we
3538 * have an active transform (possibly iv_len != 0), so use the
3539 * fact that the record header len is 13 instead.
3540 */
3541 if( rec_epoch == 0 &&
3542 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3543 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3544 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3545 ssl->in_left > 13 &&
3546 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3547 {
3548 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3549 "from the same port" ) );
3550 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003551 }
3552
3553 return( 0 );
3554}
Hanno Becker2fddd372019-07-10 14:37:41 +01003555#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003556
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003557/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003558 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003559 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003560static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3561 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003562{
3563 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003566 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003567
Paul Bakker48916f92012-09-16 19:57:18 +00003568 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003569 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003570 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003571
Hanno Beckera18d1322018-01-03 14:27:32 +00003572 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003573 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003574 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003576
Hanno Beckera0e20d02019-05-15 14:03:01 +01003577#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003578 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3579 ssl->conf->ignore_unexpected_cid
3580 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3581 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003582 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003583 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003584 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003585#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003586
Paul Bakker5121ce52009-01-03 21:22:43 +00003587 return( ret );
3588 }
3589
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003590 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003591 {
3592 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003593 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003594 }
3595
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003596 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003597 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003598
Hanno Beckera0e20d02019-05-15 14:03:01 +01003599#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003600 /* We have already checked the record content type
3601 * in ssl_parse_record_header(), failing or silently
3602 * dropping the record in the case of an unknown type.
3603 *
3604 * Since with the use of CIDs, the record content type
3605 * might change during decryption, re-check the record
3606 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003607 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003608 {
3609 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3610 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3611 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003612#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003613
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003614 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003615 {
3616#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3617 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003618 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003619 {
3620 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3622 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3623 }
3624#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3625
3626 ssl->nb_zero++;
3627
3628 /*
3629 * Three or more empty messages may be a DoS attack
3630 * (excessive CPU consumption).
3631 */
3632 if( ssl->nb_zero > 3 )
3633 {
3634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003635 "messages, possible DoS attack" ) );
3636 /* Treat the records as if they were not properly authenticated,
3637 * thereby failing the connection if we see more than allowed
3638 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003639 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3640 }
3641 }
3642 else
3643 ssl->nb_zero = 0;
3644
3645#if defined(MBEDTLS_SSL_PROTO_DTLS)
3646 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3647 {
3648 ; /* in_ctr read from peer, not maintained internally */
3649 }
3650 else
3651#endif
3652 {
3653 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003654 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3655 i > mbedtls_ssl_ep_len( ssl ); i-- )
3656 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003657 if( ++ssl->in_ctr[i - 1] != 0 )
3658 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003659 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003660
3661 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003662 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003663 {
3664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3665 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3666 }
3667 }
3668
Paul Bakker5121ce52009-01-03 21:22:43 +00003669 }
3670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003672 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003673 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003675 }
3676#endif
3677
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003678 /* Check actual (decrypted) record content length against
3679 * configured maximum. */
3680 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3681 {
3682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3683 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3684 }
3685
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003686 return( 0 );
3687}
3688
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003689/*
3690 * Read a record.
3691 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003692 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3693 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3694 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003695 */
Hanno Becker1097b342018-08-15 14:09:41 +01003696
3697/* Helper functions for mbedtls_ssl_read_record(). */
3698static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003699static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3700static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003701
Hanno Becker327c93b2018-08-15 13:56:18 +01003702int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003703 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003704{
Janos Follath865b3eb2019-12-16 11:46:15 +00003705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003708
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003709 if( ssl->keep_current_message == 0 )
3710 {
3711 do {
Simon Butcher99000142016-10-13 17:21:01 +01003712
Hanno Becker26994592018-08-15 14:14:59 +01003713 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003714 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003715 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003716
Hanno Beckere74d5562018-08-15 14:26:08 +01003717 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003718 {
Hanno Becker40f50842018-08-15 14:48:01 +01003719#if defined(MBEDTLS_SSL_PROTO_DTLS)
3720 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003721
Hanno Becker40f50842018-08-15 14:48:01 +01003722 /* We only check for buffered messages if the
3723 * current datagram is fully consumed. */
3724 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003725 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003726 {
Hanno Becker40f50842018-08-15 14:48:01 +01003727 if( ssl_load_buffered_message( ssl ) == 0 )
3728 have_buffered = 1;
3729 }
3730
3731 if( have_buffered == 0 )
3732#endif /* MBEDTLS_SSL_PROTO_DTLS */
3733 {
3734 ret = ssl_get_next_record( ssl );
3735 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3736 continue;
3737
3738 if( ret != 0 )
3739 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003740 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003741 return( ret );
3742 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003743 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003744 }
3745
3746 ret = mbedtls_ssl_handle_message_type( ssl );
3747
Hanno Becker40f50842018-08-15 14:48:01 +01003748#if defined(MBEDTLS_SSL_PROTO_DTLS)
3749 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3750 {
3751 /* Buffer future message */
3752 ret = ssl_buffer_message( ssl );
3753 if( ret != 0 )
3754 return( ret );
3755
3756 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3757 }
3758#endif /* MBEDTLS_SSL_PROTO_DTLS */
3759
Hanno Becker90333da2017-10-10 11:27:13 +01003760 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3761 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003762
3763 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003764 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003765 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003766 return( ret );
3767 }
3768
Hanno Becker327c93b2018-08-15 13:56:18 +01003769 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003770 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003771 {
3772 mbedtls_ssl_update_handshake_status( ssl );
3773 }
Simon Butcher99000142016-10-13 17:21:01 +01003774 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003775 else
Simon Butcher99000142016-10-13 17:21:01 +01003776 {
Hanno Becker02f59072018-08-15 14:00:24 +01003777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003778 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003779 }
3780
3781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3782
3783 return( 0 );
3784}
3785
Hanno Becker40f50842018-08-15 14:48:01 +01003786#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003787static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003788{
Hanno Becker40f50842018-08-15 14:48:01 +01003789 if( ssl->in_left > ssl->next_record_offset )
3790 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003791
Hanno Becker40f50842018-08-15 14:48:01 +01003792 return( 0 );
3793}
3794
3795static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3796{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003797 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003798 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003799 int ret = 0;
3800
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003801 if( hs == NULL )
3802 return( -1 );
3803
Hanno Beckere00ae372018-08-20 09:39:42 +01003804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3805
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003806 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3807 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3808 {
3809 /* Check if we have seen a ChangeCipherSpec before.
3810 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003811 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003812 {
3813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3814 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003815 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003816 }
3817
Hanno Becker39b8bc92018-08-28 17:17:13 +01003818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003819 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3820 ssl->in_msglen = 1;
3821 ssl->in_msg[0] = 1;
3822
3823 /* As long as they are equal, the exact value doesn't matter. */
3824 ssl->in_left = 0;
3825 ssl->next_record_offset = 0;
3826
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003827 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003828 goto exit;
3829 }
Hanno Becker37f95322018-08-16 13:55:32 +01003830
Hanno Beckerb8f50142018-08-28 10:01:34 +01003831#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003832 /* Debug only */
3833 {
3834 unsigned offset;
3835 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3836 {
3837 hs_buf = &hs->buffering.hs[offset];
3838 if( hs_buf->is_valid == 1 )
3839 {
3840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3841 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003842 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003843 }
3844 }
3845 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003846#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003847
3848 /* Check if we have buffered and/or fully reassembled the
3849 * next handshake message. */
3850 hs_buf = &hs->buffering.hs[0];
3851 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3852 {
3853 /* Synthesize a record containing the buffered HS message. */
3854 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3855 ( hs_buf->data[2] << 8 ) |
3856 hs_buf->data[3];
3857
3858 /* Double-check that we haven't accidentally buffered
3859 * a message that doesn't fit into the input buffer. */
3860 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3861 {
3862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3863 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3864 }
3865
3866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3867 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3868 hs_buf->data, msg_len + 12 );
3869
3870 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3871 ssl->in_hslen = msg_len + 12;
3872 ssl->in_msglen = msg_len + 12;
3873 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3874
3875 ret = 0;
3876 goto exit;
3877 }
3878 else
3879 {
3880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3881 hs->in_msg_seq ) );
3882 }
3883
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003884 ret = -1;
3885
3886exit:
3887
3888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3889 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003890}
3891
Hanno Beckera02b0b42018-08-21 17:20:27 +01003892static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3893 size_t desired )
3894{
3895 int offset;
3896 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3898 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003899
Hanno Becker01315ea2018-08-21 17:22:17 +01003900 /* Get rid of future records epoch first, if such exist. */
3901 ssl_free_buffered_record( ssl );
3902
3903 /* Check if we have enough space available now. */
3904 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3905 hs->buffering.total_bytes_buffered ) )
3906 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003908 return( 0 );
3909 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003910
Hanno Becker4f432ad2018-08-28 10:02:32 +01003911 /* We don't have enough space to buffer the next expected handshake
3912 * message. Remove buffers used for future messages to gain space,
3913 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003914 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3915 offset >= 0; offset-- )
3916 {
3917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3918 offset ) );
3919
Hanno Beckerb309b922018-08-23 13:18:05 +01003920 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003921
3922 /* Check if we have enough space available now. */
3923 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3924 hs->buffering.total_bytes_buffered ) )
3925 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003927 return( 0 );
3928 }
3929 }
3930
3931 return( -1 );
3932}
3933
Hanno Becker40f50842018-08-15 14:48:01 +01003934static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3935{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003936 int ret = 0;
3937 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3938
3939 if( hs == NULL )
3940 return( 0 );
3941
3942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3943
3944 switch( ssl->in_msgtype )
3945 {
3946 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003948
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003949 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003950 break;
3951
3952 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003953 {
3954 unsigned recv_msg_seq_offset;
3955 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3956 mbedtls_ssl_hs_buffer *hs_buf;
3957 size_t msg_len = ssl->in_hslen - 12;
3958
3959 /* We should never receive an old handshake
3960 * message - double-check nonetheless. */
3961 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3962 {
3963 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3964 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3965 }
3966
3967 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3968 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3969 {
3970 /* Silently ignore -- message too far in the future */
3971 MBEDTLS_SSL_DEBUG_MSG( 2,
3972 ( "Ignore future HS message with sequence number %u, "
3973 "buffering window %u - %u",
3974 recv_msg_seq, ssl->handshake->in_msg_seq,
3975 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3976
3977 goto exit;
3978 }
3979
3980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3981 recv_msg_seq, recv_msg_seq_offset ) );
3982
3983 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3984
3985 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003986 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003987 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003988 size_t reassembly_buf_sz;
3989
Hanno Becker37f95322018-08-16 13:55:32 +01003990 hs_buf->is_fragmented =
3991 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3992
3993 /* We copy the message back into the input buffer
3994 * after reassembly, so check that it's not too large.
3995 * This is an implementation-specific limitation
3996 * and not one from the standard, hence it is not
3997 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003998 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003999 {
4000 /* Ignore message */
4001 goto exit;
4002 }
4003
Hanno Beckere0b150f2018-08-21 15:51:03 +01004004 /* Check if we have enough space to buffer the message. */
4005 if( hs->buffering.total_bytes_buffered >
4006 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4007 {
4008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4009 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4010 }
4011
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004012 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4013 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004014
4015 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4016 hs->buffering.total_bytes_buffered ) )
4017 {
4018 if( recv_msg_seq_offset > 0 )
4019 {
4020 /* If we can't buffer a future message because
4021 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4023 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4024 " (already %" MBEDTLS_PRINTF_SIZET
4025 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004026 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004027 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004028 goto exit;
4029 }
Hanno Beckere1801392018-08-21 16:51:05 +01004030 else
4031 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4033 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4034 " (already %" MBEDTLS_PRINTF_SIZET
4035 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004036 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004037 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004038 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004039
Hanno Beckera02b0b42018-08-21 17:20:27 +01004040 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004041 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4043 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4044 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4045 " (already %" MBEDTLS_PRINTF_SIZET
4046 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004047 msg_len,
4048 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004049 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004050 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004051 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4052 goto exit;
4053 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004054 }
4055
Paul Elliottd48d5c62021-01-07 14:47:05 +00004056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004057 msg_len ) );
4058
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004059 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4060 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004061 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004062 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004063 goto exit;
4064 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004065 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004066
4067 /* Prepare final header: copy msg_type, length and message_seq,
4068 * then add standardised fragment_offset and fragment_length */
4069 memcpy( hs_buf->data, ssl->in_msg, 6 );
4070 memset( hs_buf->data + 6, 0, 3 );
4071 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4072
4073 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004074
4075 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004076 }
4077 else
4078 {
4079 /* Make sure msg_type and length are consistent */
4080 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4081 {
4082 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4083 /* Ignore */
4084 goto exit;
4085 }
4086 }
4087
Hanno Becker4422bbb2018-08-20 09:40:19 +01004088 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004089 {
4090 size_t frag_len, frag_off;
4091 unsigned char * const msg = hs_buf->data + 12;
4092
4093 /*
4094 * Check and copy current fragment
4095 */
4096
4097 /* Validation of header fields already done in
4098 * mbedtls_ssl_prepare_handshake_record(). */
4099 frag_off = ssl_get_hs_frag_off( ssl );
4100 frag_len = ssl_get_hs_frag_len( ssl );
4101
Paul Elliottd48d5c62021-01-07 14:47:05 +00004102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4103 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004104 frag_off, frag_len ) );
4105 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4106
4107 if( hs_buf->is_fragmented )
4108 {
4109 unsigned char * const bitmask = msg + msg_len;
4110 ssl_bitmask_set( bitmask, frag_off, frag_len );
4111 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4112 msg_len ) == 0 );
4113 }
4114 else
4115 {
4116 hs_buf->is_complete = 1;
4117 }
4118
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4120 hs_buf->is_complete ? "" : "not yet " ) );
4121 }
4122
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004124 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125
4126 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004127 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004128 break;
4129 }
4130
4131exit:
4132
4133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4134 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004135}
4136#endif /* MBEDTLS_SSL_PROTO_DTLS */
4137
Hanno Becker1097b342018-08-15 14:09:41 +01004138static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004139{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004140 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004141 * Consume last content-layer message and potentially
4142 * update in_msglen which keeps track of the contents'
4143 * consumption state.
4144 *
4145 * (1) Handshake messages:
4146 * Remove last handshake message, move content
4147 * and adapt in_msglen.
4148 *
4149 * (2) Alert messages:
4150 * Consume whole record content, in_msglen = 0.
4151 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004152 * (3) Change cipher spec:
4153 * Consume whole record content, in_msglen = 0.
4154 *
4155 * (4) Application data:
4156 * Don't do anything - the record layer provides
4157 * the application data as a stream transport
4158 * and consumes through mbedtls_ssl_read only.
4159 *
4160 */
4161
4162 /* Case (1): Handshake messages */
4163 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004164 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004165 /* Hard assertion to be sure that no application data
4166 * is in flight, as corrupting ssl->in_msglen during
4167 * ssl->in_offt != NULL is fatal. */
4168 if( ssl->in_offt != NULL )
4169 {
4170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4172 }
4173
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004174 /*
4175 * Get next Handshake message in the current record
4176 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004177
Hanno Becker4a810fb2017-05-24 16:27:30 +01004178 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004179 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004180 * current handshake content: If DTLS handshake
4181 * fragmentation is used, that's the fragment
4182 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004183 * size here is faulty and should be changed at
4184 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004185 * (2) While it doesn't seem to cause problems, one
4186 * has to be very careful not to assume that in_hslen
4187 * is always <= in_msglen in a sensible communication.
4188 * Again, it's wrong for DTLS handshake fragmentation.
4189 * The following check is therefore mandatory, and
4190 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004191 * Additionally, ssl->in_hslen might be arbitrarily out of
4192 * bounds after handling a DTLS message with an unexpected
4193 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004194 */
4195 if( ssl->in_hslen < ssl->in_msglen )
4196 {
4197 ssl->in_msglen -= ssl->in_hslen;
4198 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4199 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004200
Hanno Becker4a810fb2017-05-24 16:27:30 +01004201 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4202 ssl->in_msg, ssl->in_msglen );
4203 }
4204 else
4205 {
4206 ssl->in_msglen = 0;
4207 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004208
Hanno Becker4a810fb2017-05-24 16:27:30 +01004209 ssl->in_hslen = 0;
4210 }
4211 /* Case (4): Application data */
4212 else if( ssl->in_offt != NULL )
4213 {
4214 return( 0 );
4215 }
4216 /* Everything else (CCS & Alerts) */
4217 else
4218 {
4219 ssl->in_msglen = 0;
4220 }
4221
Hanno Becker1097b342018-08-15 14:09:41 +01004222 return( 0 );
4223}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004224
Hanno Beckere74d5562018-08-15 14:26:08 +01004225static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4226{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004227 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004228 return( 1 );
4229
4230 return( 0 );
4231}
4232
Hanno Becker5f066e72018-08-16 14:56:31 +01004233#if defined(MBEDTLS_SSL_PROTO_DTLS)
4234
4235static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4236{
4237 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4238 if( hs == NULL )
4239 return;
4240
Hanno Becker01315ea2018-08-21 17:22:17 +01004241 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004242 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004243 hs->buffering.total_bytes_buffered -=
4244 hs->buffering.future_record.len;
4245
4246 mbedtls_free( hs->buffering.future_record.data );
4247 hs->buffering.future_record.data = NULL;
4248 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004249}
4250
4251static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4252{
4253 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4254 unsigned char * rec;
4255 size_t rec_len;
4256 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4258 size_t in_buf_len = ssl->in_buf_len;
4259#else
4260 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4261#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004262 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4263 return( 0 );
4264
4265 if( hs == NULL )
4266 return( 0 );
4267
Hanno Becker5f066e72018-08-16 14:56:31 +01004268 rec = hs->buffering.future_record.data;
4269 rec_len = hs->buffering.future_record.len;
4270 rec_epoch = hs->buffering.future_record.epoch;
4271
4272 if( rec == NULL )
4273 return( 0 );
4274
Hanno Becker4cb782d2018-08-20 11:19:05 +01004275 /* Only consider loading future records if the
4276 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004277 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004278 return( 0 );
4279
Hanno Becker5f066e72018-08-16 14:56:31 +01004280 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4281
4282 if( rec_epoch != ssl->in_epoch )
4283 {
4284 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4285 goto exit;
4286 }
4287
4288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4289
4290 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004291 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004292 {
4293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4294 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4295 }
4296
4297 memcpy( ssl->in_hdr, rec, rec_len );
4298 ssl->in_left = rec_len;
4299 ssl->next_record_offset = 0;
4300
4301 ssl_free_buffered_record( ssl );
4302
4303exit:
4304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4305 return( 0 );
4306}
4307
Hanno Becker519f15d2019-07-11 12:43:20 +01004308static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4309 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004310{
4311 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004312
4313 /* Don't buffer future records outside handshakes. */
4314 if( hs == NULL )
4315 return( 0 );
4316
4317 /* Only buffer handshake records (we are only interested
4318 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004319 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004320 return( 0 );
4321
4322 /* Don't buffer more than one future epoch record. */
4323 if( hs->buffering.future_record.data != NULL )
4324 return( 0 );
4325
Hanno Becker01315ea2018-08-21 17:22:17 +01004326 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004327 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004328 hs->buffering.total_bytes_buffered ) )
4329 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4331 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4332 " (already %" MBEDTLS_PRINTF_SIZET
4333 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004334 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004335 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004336 return( 0 );
4337 }
4338
Hanno Becker5f066e72018-08-16 14:56:31 +01004339 /* Buffer record */
4340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004341 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004342 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004343
4344 /* ssl_parse_record_header() only considers records
4345 * of the next epoch as candidates for buffering. */
4346 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004347 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004348
4349 hs->buffering.future_record.data =
4350 mbedtls_calloc( 1, hs->buffering.future_record.len );
4351 if( hs->buffering.future_record.data == NULL )
4352 {
4353 /* If we run out of RAM trying to buffer a
4354 * record from the next epoch, just ignore. */
4355 return( 0 );
4356 }
4357
Hanno Becker519f15d2019-07-11 12:43:20 +01004358 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004359
Hanno Becker519f15d2019-07-11 12:43:20 +01004360 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004361 return( 0 );
4362}
4363
4364#endif /* MBEDTLS_SSL_PROTO_DTLS */
4365
Hanno Beckere74d5562018-08-15 14:26:08 +01004366static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004367{
Janos Follath865b3eb2019-12-16 11:46:15 +00004368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004369 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004370
Hanno Becker5f066e72018-08-16 14:56:31 +01004371#if defined(MBEDTLS_SSL_PROTO_DTLS)
4372 /* We might have buffered a future record; if so,
4373 * and if the epoch matches now, load it.
4374 * On success, this call will set ssl->in_left to
4375 * the length of the buffered record, so that
4376 * the calls to ssl_fetch_input() below will
4377 * essentially be no-ops. */
4378 ret = ssl_load_buffered_record( ssl );
4379 if( ret != 0 )
4380 return( ret );
4381#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004383 /* Ensure that we have enough space available for the default form
4384 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4385 * with no space for CIDs counted in). */
4386 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4387 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004388 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004389 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004390 return( ret );
4391 }
4392
Hanno Beckere5e7e782019-07-11 12:29:35 +01004393 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4394 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004395 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004397 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004398 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004399 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4400 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004401 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004402 if( ret != 0 )
4403 return( ret );
4404
4405 /* Fall through to handling of unexpected records */
4406 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4407 }
4408
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004409 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4410 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004411#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004412 /* Reset in pointers to default state for TLS/DTLS records,
4413 * assuming no CID and no offset between record content and
4414 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004415 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004416
Hanno Becker7ae20e02019-07-12 08:33:49 +01004417 /* Setup internal message pointers from record structure. */
4418 ssl->in_msgtype = rec.type;
4419#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4420 ssl->in_len = ssl->in_cid + rec.cid_len;
4421#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4422 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4423 ssl->in_msglen = rec.data_len;
4424
Hanno Becker2fddd372019-07-10 14:37:41 +01004425 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004426 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004427 if( ret != 0 )
4428 return( ret );
4429#endif
4430
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004431 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004432 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004433
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4435 "(header)" ) );
4436 }
4437 else
4438 {
4439 /* Skip invalid record and the rest of the datagram */
4440 ssl->next_record_offset = 0;
4441 ssl->in_left = 0;
4442
4443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4444 "(header)" ) );
4445 }
4446
4447 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004448 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004450 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004451#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004452 {
4453 return( ret );
4454 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004455 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004458 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004459 {
Hanno Beckera8814792019-07-10 15:01:45 +01004460 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004461 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004462 if( ssl->next_record_offset < ssl->in_left )
4463 {
4464 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4465 }
4466 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004467 else
4468#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004469 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004470 /*
4471 * Fetch record contents from underlying transport.
4472 */
Hanno Beckera3175662019-07-11 12:50:29 +01004473 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004474 if( ret != 0 )
4475 {
4476 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4477 return( ret );
4478 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004479
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004481 }
4482
4483 /*
4484 * Decrypt record contents.
4485 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004486
Hanno Beckerfdf66042019-07-11 13:07:45 +01004487 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004489#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004490 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004491 {
4492 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004493 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004494 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004495 /* Except when waiting for Finished as a bad mac here
4496 * probably means something went wrong in the handshake
4497 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4498 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4499 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4500 {
4501#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4502 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4503 {
4504 mbedtls_ssl_send_alert_message( ssl,
4505 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4506 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4507 }
4508#endif
4509 return( ret );
4510 }
4511
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004512 if( ssl->conf->badmac_limit != 0 &&
4513 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4516 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004517 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004518
Hanno Becker4a810fb2017-05-24 16:27:30 +01004519 /* As above, invalid records cause
4520 * dismissal of the whole datagram. */
4521
4522 ssl->next_record_offset = 0;
4523 ssl->in_left = 0;
4524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004526 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004527 }
4528
4529 return( ret );
4530 }
4531 else
4532#endif
4533 {
4534 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4536 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538 mbedtls_ssl_send_alert_message( ssl,
4539 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4540 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004541 }
4542#endif
4543 return( ret );
4544 }
4545 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004546
Hanno Becker44d89b22019-07-12 09:40:44 +01004547
4548 /* Reset in pointers to default state for TLS/DTLS records,
4549 * assuming no CID and no offset between record content and
4550 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004551 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004552#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4553 ssl->in_len = ssl->in_cid + rec.cid_len;
4554#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004555 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004556
Hanno Becker8685c822019-07-12 09:37:30 +01004557 /* The record content type may change during decryption,
4558 * so re-read it. */
4559 ssl->in_msgtype = rec.type;
4560 /* Also update the input buffer, because unfortunately
4561 * the server-side ssl_parse_client_hello() reparses the
4562 * record header when receiving a ClientHello initiating
4563 * a renegotiation. */
4564 ssl->in_hdr[0] = rec.type;
4565 ssl->in_msg = rec.buf + rec.data_offset;
4566 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004567 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004568
Simon Butcher99000142016-10-13 17:21:01 +01004569 return( 0 );
4570}
4571
4572int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4573{
Janos Follath865b3eb2019-12-16 11:46:15 +00004574 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004575
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004576 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004577 * Handle particular types of records
4578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004580 {
Simon Butcher99000142016-10-13 17:21:01 +01004581 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4582 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004583 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004584 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004585 }
4586
Hanno Beckere678eaa2018-08-21 14:57:46 +01004587 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004588 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004589 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004590 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004592 ssl->in_msglen ) );
4593 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004594 }
4595
Hanno Beckere678eaa2018-08-21 14:57:46 +01004596 if( ssl->in_msg[0] != 1 )
4597 {
4598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4599 ssl->in_msg[0] ) );
4600 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4601 }
4602
4603#if defined(MBEDTLS_SSL_PROTO_DTLS)
4604 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4605 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4606 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4607 {
4608 if( ssl->handshake == NULL )
4609 {
4610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4611 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4612 }
4613
4614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4615 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4616 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004617#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004618 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004620 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004621 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004622 if( ssl->in_msglen != 2 )
4623 {
4624 /* Note: Standard allows for more than one 2 byte alert
4625 to be packed in a single message, but Mbed TLS doesn't
4626 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004628 ssl->in_msglen ) );
4629 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4630 }
4631
Paul Elliott9f352112020-12-09 14:55:45 +00004632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004633 ssl->in_msg[0], ssl->in_msg[1] ) );
4634
4635 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004636 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004638 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004639 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004641 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004643 }
4644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4646 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004647 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4649 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004650 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004651
4652#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4653 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4654 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4655 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004656 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004657 /* Will be handled when trying to parse ServerHello */
4658 return( 0 );
4659 }
4660#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004661 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004662 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 }
4664
Hanno Beckerc76c6192017-06-06 10:03:17 +01004665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004666 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004667 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004668 /* Drop unexpected ApplicationData records,
4669 * except at the beginning of renegotiations */
4670 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4671 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4672#if defined(MBEDTLS_SSL_RENEGOTIATION)
4673 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4674 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004675#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004676 )
4677 {
4678 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4679 return( MBEDTLS_ERR_SSL_NON_FATAL );
4680 }
4681
4682 if( ssl->handshake != NULL &&
4683 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4684 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004685 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004686 }
4687 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004688#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004689
Paul Bakker5121ce52009-01-03 21:22:43 +00004690 return( 0 );
4691}
4692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004694{
irwir6c0da642019-09-26 21:07:41 +03004695 return( mbedtls_ssl_send_alert_message( ssl,
4696 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4697 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004698}
4699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004701 unsigned char level,
4702 unsigned char message )
4703{
Janos Follath865b3eb2019-12-16 11:46:15 +00004704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004705
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004706 if( ssl == NULL || ssl->conf == NULL )
4707 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004710 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004712 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004713 ssl->out_msglen = 2;
4714 ssl->out_msg[0] = level;
4715 ssl->out_msg[1] = message;
4716
Hanno Becker67bc7c32018-08-06 11:33:50 +01004717 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004718 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004720 return( ret );
4721 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004723
4724 return( 0 );
4725}
4726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004727int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004728{
Janos Follath865b3eb2019-12-16 11:46:15 +00004729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004734 ssl->out_msglen = 1;
4735 ssl->out_msg[0] = 1;
4736
Paul Bakker5121ce52009-01-03 21:22:43 +00004737 ssl->state++;
4738
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004739 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004740 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004741 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004742 return( ret );
4743 }
4744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004746
4747 return( 0 );
4748}
4749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004751{
Janos Follath865b3eb2019-12-16 11:46:15 +00004752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004755
Hanno Becker327c93b2018-08-15 13:56:18 +01004756 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 return( ret );
4760 }
4761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004765 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4766 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004768 }
4769
Hanno Beckere678eaa2018-08-21 14:57:46 +01004770 /* CCS records are only accepted if they have length 1 and content '1',
4771 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004772
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004773 /*
4774 * Switch to our negotiated transform and session parameters for inbound
4775 * data.
4776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004777 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004778 ssl->transform_in = ssl->transform_negotiate;
4779 ssl->session_in = ssl->session_negotiate;
4780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004782 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004785 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004786#endif
4787
4788 /* Increment epoch */
4789 if( ++ssl->in_epoch == 0 )
4790 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004792 /* This is highly unlikely to happen for legitimate reasons, so
4793 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004795 }
4796 }
4797 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004799 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004800
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004801 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004802
Paul Bakker5121ce52009-01-03 21:22:43 +00004803 ssl->state++;
4804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004806
4807 return( 0 );
4808}
4809
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004810/* Once ssl->out_hdr as the address of the beginning of the
4811 * next outgoing record is set, deduce the other pointers.
4812 *
4813 * Note: For TLS, we save the implicit record sequence number
4814 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4815 * and the caller has to make sure there's space for this.
4816 */
4817
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004818static size_t ssl_transform_get_explicit_iv_len(
4819 mbedtls_ssl_transform const *transform )
4820{
TRodziewiczef73f012021-05-13 14:53:36 +02004821 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004822 return( 0 );
4823
4824 return( transform->ivlen - transform->fixed_ivlen );
4825}
4826
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004827void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4828 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004829{
4830#if defined(MBEDTLS_SSL_PROTO_DTLS)
4831 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4832 {
4833 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004834#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004835 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004836 ssl->out_len = ssl->out_cid;
4837 if( transform != NULL )
4838 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004839#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004840 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004841#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004842 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004843 }
4844 else
4845#endif
4846 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004847 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004848#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004849 ssl->out_cid = ssl->out_len;
4850#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004851 ssl->out_iv = ssl->out_hdr + 5;
4852 }
4853
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004854 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004855 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004856 if( transform != NULL )
4857 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004858}
4859
4860/* Once ssl->in_hdr as the address of the beginning of the
4861 * next incoming record is set, deduce the other pointers.
4862 *
4863 * Note: For TLS, we save the implicit record sequence number
4864 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4865 * and the caller has to make sure there's space for this.
4866 */
4867
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004868void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004869{
Hanno Becker79594fd2019-05-08 09:38:41 +01004870 /* This function sets the pointers to match the case
4871 * of unprotected TLS/DTLS records, with both ssl->in_iv
4872 * and ssl->in_msg pointing to the beginning of the record
4873 * content.
4874 *
4875 * When decrypting a protected record, ssl->in_msg
4876 * will be shifted to point to the beginning of the
4877 * record plaintext.
4878 */
4879
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004880#if defined(MBEDTLS_SSL_PROTO_DTLS)
4881 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4882 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004883 /* This sets the header pointers to match records
4884 * without CID. When we receive a record containing
4885 * a CID, the fields are shifted accordingly in
4886 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004887 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004888#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004889 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004890 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004891#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004892 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004893#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004894 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004895 }
4896 else
4897#endif
4898 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004899 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004900 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004901#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004902 ssl->in_cid = ssl->in_len;
4903#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004904 ssl->in_iv = ssl->in_hdr + 5;
4905 }
4906
Hanno Becker79594fd2019-05-08 09:38:41 +01004907 /* This will be adjusted at record decryption time. */
4908 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004909}
4910
Paul Bakker5121ce52009-01-03 21:22:43 +00004911/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004912 * Setup an SSL context
4913 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004914
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004915void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004916{
4917 /* Set the incoming and outgoing record pointers. */
4918#if defined(MBEDTLS_SSL_PROTO_DTLS)
4919 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4920 {
4921 ssl->out_hdr = ssl->out_buf;
4922 ssl->in_hdr = ssl->in_buf;
4923 }
4924 else
4925#endif /* MBEDTLS_SSL_PROTO_DTLS */
4926 {
Hanno Becker12078f42021-03-02 15:28:41 +00004927 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004928 ssl->out_hdr = ssl->out_buf + 8;
4929 ssl->in_hdr = ssl->in_buf + 8;
4930 }
4931
4932 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004933 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4934 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004935}
4936
Paul Bakker5121ce52009-01-03 21:22:43 +00004937/*
4938 * SSL get accessors
4939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004941{
4942 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4943}
4944
Hanno Becker8b170a02017-10-10 11:51:19 +01004945int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4946{
4947 /*
4948 * Case A: We're currently holding back
4949 * a message for further processing.
4950 */
4951
4952 if( ssl->keep_current_message == 1 )
4953 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004954 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004955 return( 1 );
4956 }
4957
4958 /*
4959 * Case B: Further records are pending in the current datagram.
4960 */
4961
4962#if defined(MBEDTLS_SSL_PROTO_DTLS)
4963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4964 ssl->in_left > ssl->next_record_offset )
4965 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004966 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004967 return( 1 );
4968 }
4969#endif /* MBEDTLS_SSL_PROTO_DTLS */
4970
4971 /*
4972 * Case C: A handshake message is being processed.
4973 */
4974
Hanno Becker8b170a02017-10-10 11:51:19 +01004975 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4976 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004977 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004978 return( 1 );
4979 }
4980
4981 /*
4982 * Case D: An application data message is being processed
4983 */
4984 if( ssl->in_offt != NULL )
4985 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004986 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004987 return( 1 );
4988 }
4989
4990 /*
4991 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004992 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004993 * we implement support for multiple alerts in single records.
4994 */
4995
4996 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4997 return( 0 );
4998}
4999
Paul Bakker43ca69c2011-01-15 17:35:19 +00005000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005001int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005002{
Hanno Becker3136ede2018-08-17 15:28:19 +01005003 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005004 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005005 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005006
Hanno Becker5903de42019-05-03 14:46:38 +01005007 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5008
Hanno Becker78640902018-08-13 16:35:15 +01005009 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005010 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005012 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005013 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014 case MBEDTLS_MODE_GCM:
5015 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005016 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005018 transform_expansion = transform->minlen;
5019 break;
5020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005022
5023 block_size = mbedtls_cipher_get_block_size(
5024 &transform->cipher_ctx_enc );
5025
Hanno Becker3136ede2018-08-17 15:28:19 +01005026 /* Expansion due to the addition of the MAC. */
5027 transform_expansion += transform->maclen;
5028
5029 /* Expansion due to the addition of CBC padding;
5030 * Theoretically up to 256 bytes, but we never use
5031 * more than the block size of the underlying cipher. */
5032 transform_expansion += block_size;
5033
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005034 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005035 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005037 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005038#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005039
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005040 break;
5041
5042 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005043 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005045 }
5046
Hanno Beckera0e20d02019-05-15 14:03:01 +01005047#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005048 if( transform->out_cid_len != 0 )
5049 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005050#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005051
Hanno Becker5903de42019-05-03 14:46:38 +01005052 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005053}
5054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005056/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005057 * Check record counters and renegotiate if they're above the limit.
5058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005060{
Hanno Beckerdd772292020-02-05 10:38:31 +00005061 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005062 int in_ctr_cmp;
5063 int out_ctr_cmp;
5064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005065 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5066 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005067 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005068 {
5069 return( 0 );
5070 }
5071
Andres AG2196c7f2016-12-15 17:01:16 +00005072 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005073 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005074 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005075 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5076 &ssl->conf->renego_period[ep_len],
5077 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005078
5079 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005080 {
5081 return( 0 );
5082 }
5083
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005084 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005085 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005086}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005087#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005088
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005089/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005090 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005091 * may only be sent for the purpose of initiating renegotiations.
5092 *
5093 * This function is introduced as a separate helper since the handling
5094 * of post-handshake handshake messages changes significantly in TLS 1.3,
5095 * and having a helper function allows to distinguish between TLS <= 1.2 and
5096 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5097 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005098static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005099{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005101
5102 /*
5103 * - For client-side, expect SERVER_HELLO_REQUEST.
5104 * - For server-side, expect CLIENT_HELLO.
5105 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5106 */
5107
5108#if defined(MBEDTLS_SSL_CLI_C)
5109 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5110 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5111 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5112 {
5113 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5114
5115 /* With DTLS, drop the packet (probably from last handshake) */
5116#if defined(MBEDTLS_SSL_PROTO_DTLS)
5117 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5118 {
5119 return( 0 );
5120 }
5121#endif
5122 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5123 }
5124#endif /* MBEDTLS_SSL_CLI_C */
5125
5126#if defined(MBEDTLS_SSL_SRV_C)
5127 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5128 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5129 {
5130 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5131
5132 /* With DTLS, drop the packet (probably from last handshake) */
5133#if defined(MBEDTLS_SSL_PROTO_DTLS)
5134 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5135 {
5136 return( 0 );
5137 }
5138#endif
5139 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5140 }
5141#endif /* MBEDTLS_SSL_SRV_C */
5142
5143#if defined(MBEDTLS_SSL_RENEGOTIATION)
5144 /* Determine whether renegotiation attempt should be accepted */
5145 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5146 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5147 ssl->conf->allow_legacy_renegotiation ==
5148 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5149 {
5150 /*
5151 * Accept renegotiation request
5152 */
5153
5154 /* DTLS clients need to know renego is server-initiated */
5155#if defined(MBEDTLS_SSL_PROTO_DTLS)
5156 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5157 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5158 {
5159 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5160 }
5161#endif
5162 ret = mbedtls_ssl_start_renegotiation( ssl );
5163 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5164 ret != 0 )
5165 {
5166 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5167 ret );
5168 return( ret );
5169 }
5170 }
5171 else
5172#endif /* MBEDTLS_SSL_RENEGOTIATION */
5173 {
5174 /*
5175 * Refuse renegotiation
5176 */
5177
5178 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5179
TRodziewicz0f82ec62021-05-12 17:49:18 +02005180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005181 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5182 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5183 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005184 {
TRodziewicz345165c2021-07-06 13:42:11 +02005185 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005186 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005187#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005188 }
5189
5190 return( 0 );
5191}
5192
Paul Bakker48916f92012-09-16 19:57:18 +00005193/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005194 * Receive application data decrypted from the SSL layer
5195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005197{
Janos Follath865b3eb2019-12-16 11:46:15 +00005198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005199 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005200
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005201 if( ssl == NULL || ssl->conf == NULL )
5202 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005204 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005207 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005208 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005209 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005210 return( ret );
5211
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005212 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005213 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005214 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005215 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005216 return( ret );
5217 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005218 }
5219#endif
5220
Hanno Becker4a810fb2017-05-24 16:27:30 +01005221 /*
5222 * Check if renegotiation is necessary and/or handshake is
5223 * in process. If yes, perform/continue, and fall through
5224 * if an unexpected packet is received while the client
5225 * is waiting for the ServerHello.
5226 *
5227 * (There is no equivalent to the last condition on
5228 * the server-side as it is not treated as within
5229 * a handshake while waiting for the ClientHello
5230 * after a renegotiation request.)
5231 */
5232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005233#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005234 ret = ssl_check_ctr_renegotiate( ssl );
5235 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5236 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005237 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005238 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005239 return( ret );
5240 }
5241#endif
5242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005244 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005246 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5247 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005248 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005250 return( ret );
5251 }
5252 }
5253
Hanno Beckere41158b2017-10-23 13:30:32 +01005254 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005255 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005257 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005258 if( ssl->f_get_timer != NULL &&
5259 ssl->f_get_timer( ssl->p_timer ) == -1 )
5260 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005261 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005262 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005263
Hanno Becker327c93b2018-08-15 13:56:18 +01005264 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005265 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005266 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5267 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005268
Hanno Becker4a810fb2017-05-24 16:27:30 +01005269 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5270 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005271 }
5272
5273 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005274 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005275 {
5276 /*
5277 * OpenSSL sends empty messages to randomize the IV
5278 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005279 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005281 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005282 return( 0 );
5283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005284 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005285 return( ret );
5286 }
5287 }
5288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005289 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005290 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005291 ret = ssl_handle_hs_message_post_handshake( ssl );
5292 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005293 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005294 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5295 ret );
5296 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005297 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005298
Hanno Beckerf26cc722021-04-21 07:30:13 +01005299 /* At this point, we don't know whether the renegotiation triggered
5300 * by the post-handshake message has been completed or not. The cases
5301 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005302 * 1) The renegotiation is complete. In this case, no new record
5303 * has been read yet.
5304 * 2) The renegotiation is incomplete because the client received
5305 * an application data record while awaiting the ServerHello.
5306 * 3) The renegotiation is incomplete because the client received
5307 * a non-handshake, non-application data message while awaiting
5308 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005309 *
5310 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005311 * - For 1), the next iteration will read a new record and check
5312 * if it's application data.
5313 * - For 2), the loop condition isn't satisfied as application data
5314 * is present, hence continue is the same as break
5315 * - For 3), the loop condition is satisfied and read_record
5316 * will re-deliver the message that was held back by the client
5317 * when expecting the ServerHello.
5318 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005319
Hanno Becker90333da2017-10-10 11:27:13 +01005320 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005321 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005322#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005323 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005324 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005325 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005326 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005327 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005328 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005330 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005332 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005333 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005334 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5338 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005341 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005342 }
5343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5347 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005348 }
5349
5350 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005351
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005352 /* We're going to return something now, cancel timer,
5353 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005355 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005356
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005357#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005358 /* If we requested renego but received AppData, resend HelloRequest.
5359 * Do it now, after setting in_offt, to avoid taking this branch
5360 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005362 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005363 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005364 {
Hanno Becker786300f2020-02-05 10:46:40 +00005365 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005366 {
Hanno Becker786300f2020-02-05 10:46:40 +00005367 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5368 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005369 return( ret );
5370 }
5371 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005373#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005374 }
5375
5376 n = ( len < ssl->in_msglen )
5377 ? len : ssl->in_msglen;
5378
5379 memcpy( buf, ssl->in_offt, n );
5380 ssl->in_msglen -= n;
5381
gabor-mezei-arma3214132020-07-15 10:55:00 +02005382 /* Zeroising the plaintext buffer to erase unused application data
5383 from the memory. */
5384 mbedtls_platform_zeroize( ssl->in_offt, n );
5385
Paul Bakker5121ce52009-01-03 21:22:43 +00005386 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005387 {
5388 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005389 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005390 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005393 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005394 /* more data available */
5395 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005396 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005397
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005399
Paul Bakker23986e52011-04-24 08:57:21 +00005400 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005401}
5402
5403/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005404 * Send application data to be encrypted by the SSL layer, taking care of max
5405 * fragment length and buffer size.
5406 *
5407 * According to RFC 5246 Section 6.2.1:
5408 *
5409 * Zero-length fragments of Application data MAY be sent as they are
5410 * potentially useful as a traffic analysis countermeasure.
5411 *
5412 * Therefore, it is possible that the input message length is 0 and the
5413 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005414 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005415static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005416 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005417{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005418 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5419 const size_t max_len = (size_t) ret;
5420
5421 if( ret < 0 )
5422 {
5423 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5424 return( ret );
5425 }
5426
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005427 if( len > max_len )
5428 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005430 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005433 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5434 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005435 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005437 }
5438 else
5439#endif
5440 len = max_len;
5441 }
Paul Bakker887bd502011-06-08 13:10:54 +00005442
Paul Bakker5121ce52009-01-03 21:22:43 +00005443 if( ssl->out_left != 0 )
5444 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005445 /*
5446 * The user has previously tried to send the data and
5447 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5448 * written. In this case, we expect the high-level write function
5449 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005454 return( ret );
5455 }
5456 }
Paul Bakker887bd502011-06-08 13:10:54 +00005457 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005458 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005459 /*
5460 * The user is trying to send a message the first time, so we need to
5461 * copy the data into the internal buffers and setup the data structure
5462 * to keep track of partial writes
5463 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005464 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005466 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005467
Hanno Becker67bc7c32018-08-06 11:33:50 +01005468 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005471 return( ret );
5472 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005473 }
5474
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005475 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005476}
5477
5478/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005479 * Write application data (public-facing wrapper)
5480 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005481int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005482{
Janos Follath865b3eb2019-12-16 11:46:15 +00005483 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005484
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005485 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005486
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005487 if( ssl == NULL || ssl->conf == NULL )
5488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5489
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005490#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005491 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5492 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005493 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005494 return( ret );
5495 }
5496#endif
5497
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005498 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005499 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005500 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005501 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005502 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005503 return( ret );
5504 }
5505 }
5506
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005507 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005508
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005509 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005510
5511 return( ret );
5512}
5513
5514/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005515 * Notify the peer that the connection is being closed
5516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005518{
Janos Follath865b3eb2019-12-16 11:46:15 +00005519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005520
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005521 if( ssl == NULL || ssl->conf == NULL )
5522 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005525
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005526 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005527 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005531 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5532 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5533 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005536 return( ret );
5537 }
5538 }
5539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005541
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005542 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005543}
5544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005545void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005546{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005547 if( transform == NULL )
5548 return;
5549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5551 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005552
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005553#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 mbedtls_md_free( &transform->md_ctx_enc );
5555 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005556#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005557
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005558 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005559}
5560
Jerry Yuc7875b52021-09-05 21:05:50 +08005561void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5562 mbedtls_ssl_transform *transform )
5563{
Jerry Yuc7875b52021-09-05 21:05:50 +08005564 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005565 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005566}
5567
5568void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5569 mbedtls_ssl_transform *transform )
5570{
5571 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005572 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005573}
5574
Hanno Becker0271f962018-08-16 13:23:47 +01005575#if defined(MBEDTLS_SSL_PROTO_DTLS)
5576
Hanno Becker533ab5f2020-02-05 10:49:13 +00005577void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005578{
5579 unsigned offset;
5580 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5581
5582 if( hs == NULL )
5583 return;
5584
Hanno Becker283f5ef2018-08-24 09:34:47 +01005585 ssl_free_buffered_record( ssl );
5586
Hanno Becker0271f962018-08-16 13:23:47 +01005587 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005588 ssl_buffering_free_slot( ssl, offset );
5589}
5590
5591static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5592 uint8_t slot )
5593{
5594 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5595 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005596
5597 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5598 return;
5599
Hanno Beckere605b192018-08-21 15:59:07 +01005600 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005601 {
Hanno Beckere605b192018-08-21 15:59:07 +01005602 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005603 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005604 mbedtls_free( hs_buf->data );
5605 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005606 }
5607}
5608
5609#endif /* MBEDTLS_SSL_PROTO_DTLS */
5610
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005611/*
5612 * Convert version numbers to/from wire format
5613 * and, for DTLS, to/from TLS equivalent.
5614 *
5615 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005616 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005617 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005619void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005620 unsigned char ver[2] )
5621{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005622#if defined(MBEDTLS_SSL_PROTO_DTLS)
5623 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005624 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005626 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5627
5628 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5629 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5630 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005631 else
5632#else
5633 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005634#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005635 {
5636 ver[0] = (unsigned char) major;
5637 ver[1] = (unsigned char) minor;
5638 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005639}
5640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005641void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005642 const unsigned char ver[2] )
5643{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005644#if defined(MBEDTLS_SSL_PROTO_DTLS)
5645 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005646 {
5647 *major = 255 - ver[0] + 2;
5648 *minor = 255 - ver[1] + 1;
5649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005650 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005651 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5652 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005653 else
5654#else
5655 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005656#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005657 {
5658 *major = ver[0];
5659 *minor = ver[1];
5660 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005661}
5662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005663#endif /* MBEDTLS_SSL_TLS_C */