blob: 134a8c52893798571ddbbee7bde49202058490cb [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"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020038#include "mbedtls/ssl_internal.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
Hanno Beckercfe45792019-07-03 16:13:00 +010089#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010090static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t len,
93 mbedtls_record *rec );
94
Hanno Beckercfe45792019-07-03 16:13:00 +010095int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t buflen )
98{
Hanno Becker54229812019-07-12 14:40:00 +010099 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100100 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
101 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
102
103 /* We don't support record checking in TLS because
104 * (a) there doesn't seem to be a usecase for it, and
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100105 * (b) In TLS 1.0, CBC record decryption has state
Hanno Becker54229812019-07-12 14:40:00 +0100106 * and we'd need to backup the transform here.
107 */
108 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
109 {
110 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
111 goto exit;
112 }
113#if defined(MBEDTLS_SSL_PROTO_DTLS)
114 else
115 {
irwir734f0cf2019-09-26 21:03:24 +0300116 mbedtls_record rec;
117
Hanno Becker54229812019-07-12 14:40:00 +0100118 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
119 if( ret != 0 )
120 {
121 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
122 goto exit;
123 }
124
125 if( ssl->transform_in != NULL )
126 {
127 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
128 if( ret != 0 )
129 {
130 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
131 goto exit;
132 }
133 }
134 }
135#endif /* MBEDTLS_SSL_PROTO_DTLS */
136
137exit:
138 /* On success, we have decrypted the buffer in-place, so make
139 * sure we don't leak any plaintext data. */
140 mbedtls_platform_zeroize( buf, buflen );
141
142 /* For the purpose of this API, treat messages with unexpected CID
143 * as well as such from future epochs as unexpected. */
144 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
145 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
146 {
147 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
148 }
149
150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
151 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100152}
153#endif /* MBEDTLS_SSL_RECORD_CHECKING */
154
Hanno Becker67bc7c32018-08-06 11:33:50 +0100155#define SSL_DONT_FORCE_FLUSH 0
156#define SSL_FORCE_FLUSH 1
157
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200158#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100159
Hanno Beckerd5847772018-08-28 10:09:23 +0100160/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100161static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
162 uint8_t slot );
163static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
164static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
165static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
166static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100167static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
168 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100169static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100170
Hanno Becker11682cc2018-08-22 14:41:02 +0100171static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100172{
Hanno Becker89490712020-02-05 10:50:12 +0000173 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000174#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
175 size_t out_buf_len = ssl->out_buf_len;
176#else
177 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
178#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100179
Darryl Greenb33cc762019-11-28 14:29:44 +0000180 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100181 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100182
Darryl Greenb33cc762019-11-28 14:29:44 +0000183 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100184}
185
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
187{
Hanno Becker11682cc2018-08-22 14:41:02 +0100188 size_t const bytes_written = ssl->out_left;
189 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190
191 /* Double-check that the write-index hasn't gone
192 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100193 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194 {
195 /* Should never happen... */
196 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
197 }
198
199 return( (int) ( mtu - bytes_written ) );
200}
201
202static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
203{
Janos Follath865b3eb2019-12-16 11:46:15 +0000204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100205 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400206 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100207
208#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400209 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100210
211 if( max_len > mfl )
212 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100213
214 /* By the standard (RFC 6066 Sect. 4), the MFL extension
215 * only limits the maximum record payload size, so in theory
216 * we would be allowed to pack multiple records of payload size
217 * MFL into a single datagram. However, this would mean that there's
218 * no way to explicitly communicate MTU restrictions to the peer.
219 *
220 * The following reduction of max_len makes sure that we never
221 * write datagrams larger than MFL + Record Expansion Overhead.
222 */
223 if( max_len <= ssl->out_left )
224 return( 0 );
225
226 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100227#endif
228
229 ret = ssl_get_remaining_space_in_datagram( ssl );
230 if( ret < 0 )
231 return( ret );
232 remaining = (size_t) ret;
233
234 ret = mbedtls_ssl_get_record_expansion( ssl );
235 if( ret < 0 )
236 return( ret );
237 expansion = (size_t) ret;
238
239 if( remaining <= expansion )
240 return( 0 );
241
242 remaining -= expansion;
243 if( remaining >= max_len )
244 remaining = max_len;
245
246 return( (int) remaining );
247}
248
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200249/*
250 * Double the retransmit timeout value, within the allowed range,
251 * returning -1 if the maximum value has already been reached.
252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254{
255 uint32_t new_timeout;
256
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200257 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200258 return( -1 );
259
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200260 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
261 * in the following way: after the initial transmission and a first
262 * retransmission, back off to a temporary estimated MTU of 508 bytes.
263 * This value is guaranteed to be deliverable (if not guaranteed to be
264 * delivered) of any compliant IPv4 (and IPv6) network, and should work
265 * on most non-IP stacks too. */
266 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400267 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400269 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
270 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200271
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200272 new_timeout = 2 * ssl->handshake->retransmit_timeout;
273
274 /* Avoid arithmetic overflow and range overflow */
275 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200276 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200277 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200278 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200279 }
280
281 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200282 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283 ssl->handshake->retransmit_timeout ) );
284
285 return( 0 );
286}
287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200290 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292 ssl->handshake->retransmit_timeout ) );
293}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200295
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100296/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000297 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200298 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000299
Hanno Beckerccc13d02020-05-04 12:30:04 +0100300#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
301 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100302
303static size_t ssl_compute_padding_length( size_t len,
304 size_t granularity )
305{
306 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
307}
308
Hanno Becker581bc1b2020-05-04 12:20:03 +0100309/* This functions transforms a (D)TLS plaintext fragment and a record content
310 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
311 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
312 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100313 *
314 * struct {
315 * opaque content[DTLSPlaintext.length];
316 * ContentType real_type;
317 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100318 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100319 *
320 * Input:
321 * - `content`: The beginning of the buffer holding the
322 * plaintext to be wrapped.
323 * - `*content_size`: The length of the plaintext in Bytes.
324 * - `max_len`: The number of Bytes available starting from
325 * `content`. This must be `>= *content_size`.
326 * - `rec_type`: The desired record content type.
327 *
328 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100329 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
330 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100331 *
332 * Returns:
333 * - `0` on success.
334 * - A negative error code if `max_len` didn't offer enough space
335 * for the expansion.
336 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100337static int ssl_build_inner_plaintext( unsigned char *content,
338 size_t *content_size,
339 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100340 uint8_t rec_type,
341 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100342{
343 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100344
345 /* Write real content type */
346 if( remaining == 0 )
347 return( -1 );
348 content[ len ] = rec_type;
349 len++;
350 remaining--;
351
352 if( remaining < pad )
353 return( -1 );
354 memset( content + len, 0, pad );
355 len += pad;
356 remaining -= pad;
357
358 *content_size = len;
359 return( 0 );
360}
361
Hanno Becker581bc1b2020-05-04 12:20:03 +0100362/* This function parses a (D)TLSInnerPlaintext structure.
363 * See ssl_build_inner_plaintext() for details. */
364static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100365 size_t *content_size,
366 uint8_t *rec_type )
367{
368 size_t remaining = *content_size;
369
370 /* Determine length of padding by skipping zeroes from the back. */
371 do
372 {
373 if( remaining == 0 )
374 return( -1 );
375 remaining--;
376 } while( content[ remaining ] == 0 );
377
378 *content_size = remaining;
379 *rec_type = content[ remaining ];
380
381 return( 0 );
382}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100383#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
384 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100385
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100386/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100387 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000388static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100390 mbedtls_record *rec,
391 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000392{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100394 *
395 * additional_data = seq_num + TLSCompressed.type +
396 * TLSCompressed.version + TLSCompressed.length;
397 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100398 * For the CID extension, this is extended as follows
399 * (quoting draft-ietf-tls-dtls-connection-id-05,
400 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 *
402 * additional_data = seq_num + DTLSPlaintext.type +
403 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100404 * cid +
405 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100406 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100407 *
408 * For TLS 1.3, the record sequence number is dropped from the AAD
409 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100410 */
411
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100412 unsigned char *cur = add_data;
413
414#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
415 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
416#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
417 {
418 ((void) minor_ver);
419 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
420 cur += sizeof( rec->ctr );
421 }
422
423 *cur = rec->type;
424 cur++;
425
426 memcpy( cur, rec->ver, sizeof( rec->ver ) );
427 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100428
Hanno Beckera0e20d02019-05-15 14:03:01 +0100429#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100430 if( rec->cid_len != 0 )
431 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 memcpy( cur, rec->cid, rec->cid_len );
433 cur += rec->cid_len;
434
435 *cur = rec->cid_len;
436 cur++;
437
438 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
439 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
440 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100441 }
442 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100443#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100444 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100445 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
446 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
447 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100448 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449
450 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000451}
452
Hanno Becker67a37db2020-05-28 16:27:07 +0100453#if defined(MBEDTLS_GCM_C) || \
454 defined(MBEDTLS_CCM_C) || \
455 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100456static int ssl_transform_aead_dynamic_iv_is_explicit(
457 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100458{
Hanno Becker17263802020-05-28 07:05:48 +0100459 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100460}
461
Hanno Becker17263802020-05-28 07:05:48 +0100462/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
463 *
464 * Concretely, this occurs in two variants:
465 *
466 * a) Fixed and dynamic IV lengths add up to total IV length, giving
467 * IV = fixed_iv || dynamic_iv
468 *
Hanno Becker15952812020-06-04 13:31:46 +0100469 * This variant is used in TLS 1.2 when used with GCM or CCM.
470 *
Hanno Becker17263802020-05-28 07:05:48 +0100471 * b) Fixed IV lengths matches total IV length, giving
472 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100473 *
474 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
475 *
476 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100477 *
478 * This function has the precondition that
479 *
480 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
481 *
482 * which has to be ensured by the caller. If this precondition
483 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100484 */
485static void ssl_build_record_nonce( unsigned char *dst_iv,
486 size_t dst_iv_len,
487 unsigned char const *fixed_iv,
488 size_t fixed_iv_len,
489 unsigned char const *dynamic_iv,
490 size_t dynamic_iv_len )
491{
492 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100493
494 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100495 memset( dst_iv, 0, dst_iv_len );
496 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100497
Hanno Becker17263802020-05-28 07:05:48 +0100498 dst_iv += dst_iv_len - dynamic_iv_len;
499 for( i = 0; i < dynamic_iv_len; i++ )
500 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100501}
Hanno Becker67a37db2020-05-28 16:27:07 +0100502#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100503
Hanno Beckera18d1322018-01-03 14:27:32 +0000504int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
505 mbedtls_ssl_transform *transform,
506 mbedtls_record *rec,
507 int (*f_rng)(void *, unsigned char *, size_t),
508 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000509{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100511 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000512 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100513 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100514 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000515 size_t post_avail;
516
517 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000518#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200519 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000520 ((void) ssl);
521#endif
522
523 /* The PRNG is used for dynamic IV generation that's used
524 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200525#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000526 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
527 ((void) f_rng);
528 ((void) p_rng);
529#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000532
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000533 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100534 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000535 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
536 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
537 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100538 if( rec == NULL
539 || rec->buf == NULL
540 || rec->buf_len < rec->data_offset
541 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100542#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100543 || rec->cid_len != 0
544#endif
545 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000546 {
547 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100549 }
550
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000551 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100552 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000554 data, rec->data_len );
555
556 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
557
558 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
559 {
560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
561 (unsigned) rec->data_len,
562 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
563 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
564 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100565
Hanno Becker92313402020-05-20 13:58:58 +0100566 /* The following two code paths implement the (D)TLSInnerPlaintext
567 * structure present in TLS 1.3 and DTLS 1.2 + CID.
568 *
569 * See ssl_build_inner_plaintext() for more information.
570 *
571 * Note that this changes `rec->data_len`, and hence
572 * `post_avail` needs to be recalculated afterwards.
573 *
574 * Note also that the two code paths cannot occur simultaneously
575 * since they apply to different versions of the protocol. There
576 * is hence no risk of double-addition of the inner plaintext.
577 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100578#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
579 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
580 {
Hanno Becker13996922020-05-28 16:15:19 +0100581 size_t padding =
582 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100583 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100584 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100585 &rec->data_len,
586 post_avail,
587 rec->type,
588 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100589 {
590 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
591 }
592
593 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
594 }
595#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
596
Hanno Beckera0e20d02019-05-15 14:03:01 +0100597#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100598 /*
599 * Add CID information
600 */
601 rec->cid_len = transform->out_cid_len;
602 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
603 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100604
605 if( rec->cid_len != 0 )
606 {
Hanno Becker13996922020-05-28 16:15:19 +0100607 size_t padding =
608 ssl_compute_padding_length( rec->data_len,
609 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100610 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100611 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100612 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100613 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100614 * Note that this changes `rec->data_len`, and hence
615 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100617 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100618 &rec->data_len,
619 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100620 rec->type,
621 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622 {
623 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
624 }
625
626 rec->type = MBEDTLS_SSL_MSG_CID;
627 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100628#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100629
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
631
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100633 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000634 */
Hanno Becker52344c22018-01-03 15:24:20 +0000635#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636 if( mode == MBEDTLS_MODE_STREAM ||
637 ( mode == MBEDTLS_MODE_CBC
638#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000639 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100640#endif
641 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000642 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000643 if( post_avail < transform->maclen )
644 {
645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
646 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
647 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
649 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000650 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200651 {
Hanno Becker992b6872017-11-09 18:57:39 +0000652 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
653
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100654 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
655 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000656
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100658 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000659 mbedtls_md_hmac_update( &transform->md_ctx_enc,
660 data, rec->data_len );
661 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
662 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
663
664 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200665 }
666 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200667#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
670 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200671 }
672
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000673 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
674 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200675
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000676 rec->data_len += transform->maclen;
677 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100678 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200679 }
Hanno Becker52344c22018-01-03 15:24:20 +0000680#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000681
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200682 /*
683 * Encrypt
684 */
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100685#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000687 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000689 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200690 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 "including %d bytes of padding",
692 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000693
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000694 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
695 transform->iv_enc, transform->ivlen,
696 data, rec->data_len,
697 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200698 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200700 return( ret );
701 }
702
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000703 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200707 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000708 }
Paul Bakker68884e32013-01-07 18:20:04 +0100709 else
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100710#endif /* MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000711
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200712#if defined(MBEDTLS_GCM_C) || \
713 defined(MBEDTLS_CCM_C) || \
714 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200716 mode == MBEDTLS_MODE_CCM ||
717 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000718 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200720 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100721 unsigned char *dynamic_iv;
722 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100723 int dynamic_iv_is_explicit =
724 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000725
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100726 /* Check that there's space for the authentication tag. */
727 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000728 {
729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
730 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
731 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000732
Paul Bakker68884e32013-01-07 18:20:04 +0100733 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100734 * Build nonce for AEAD encryption.
735 *
736 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
737 * part of the IV is prepended to the ciphertext and
738 * can be chosen freely - in particular, it need not
739 * agree with the record sequence number.
740 * However, since ChaChaPoly as well as all AEAD modes
741 * in TLS 1.3 use the record sequence number as the
742 * dynamic part of the nonce, we uniformly use the
743 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100744 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100745 dynamic_iv = rec->ctr;
746 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200747
Hanno Becker17263802020-05-28 07:05:48 +0100748 ssl_build_record_nonce( iv, sizeof( iv ),
749 transform->iv_enc,
750 transform->fixed_ivlen,
751 dynamic_iv,
752 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100753
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100754 /*
755 * Build additional data for AEAD encryption.
756 * This depends on the TLS version.
757 */
758 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
759 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100760
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200761 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100762 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200763 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100764 dynamic_iv,
765 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000766 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100767 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200769 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000771
Paul Bakker68884e32013-01-07 18:20:04 +0100772 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200773 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200774 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000775
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100776 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000777 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100778 add_data, add_data_len,
779 data, rec->data_len, /* src */
780 data, rec->buf_len - (data - rec->buf), /* dst */
781 &rec->data_len,
782 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200785 return( ret );
786 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100788 data + rec->data_len - transform->taglen,
789 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100790 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000791 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100792
793 /*
794 * Prefix record content with dynamic IV in case it is explicit.
795 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100796 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797 {
798 if( rec->data_offset < dynamic_iv_len )
799 {
800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
801 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
802 }
803
804 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
805 rec->data_offset -= dynamic_iv_len;
806 rec->data_len += dynamic_iv_len;
807 }
808
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100809 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000810 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000811 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100812#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200813#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000815 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000817 size_t padlen, i;
818 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000819
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000820 /* Currently we're always using minimal padding
821 * (up to 255 bytes would be allowed). */
822 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
823 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000824 padlen = 0;
825
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000826 /* Check there's enough space in the buffer for the padding. */
827 if( post_avail < padlen + 1 )
828 {
829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
830 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
831 }
832
Paul Bakker5121ce52009-01-03 21:22:43 +0000833 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000834 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000835
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000836 rec->data_len += padlen + 1;
837 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000840 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000841 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
842 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000843 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000845 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 if( f_rng == NULL )
847 {
848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
849 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
850 }
851
852 if( rec->data_offset < transform->ivlen )
853 {
854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
855 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
856 }
857
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000858 /*
859 * Generate IV
860 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000861 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000862 if( ret != 0 )
863 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000864
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 memcpy( data - transform->ivlen, transform->iv_enc,
866 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000867
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000868 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000872 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000873 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200874 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000875
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000876 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
877 transform->iv_enc,
878 transform->ivlen,
879 data, rec->data_len,
880 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200883 return( ret );
884 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200885
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000886 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
889 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200890 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200891
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100892#if defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200894 {
895 /*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100896 * Save IV in TLS1
Paul Bakkercca5b812013-08-31 17:40:26 +0200897 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000898 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
899 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000901 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200902#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 {
904 data -= transform->ivlen;
905 rec->data_offset -= transform->ivlen;
906 rec->data_len += transform->ivlen;
907 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100910 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100911 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000912 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
913
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100914 /*
915 * MAC(MAC_write_key, seq_num +
916 * TLSCipherText.type +
917 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100918 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100919 * IV + // except for TLS 1.0
920 * ENC(content + padding + padding_length));
921 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922
923 if( post_avail < transform->maclen)
924 {
925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
926 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
927 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100928
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100929 ssl_extract_add_data_from_record( add_data, &add_data_len,
930 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100934 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100935
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000936 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100937 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 mbedtls_md_hmac_update( &transform->md_ctx_enc,
939 data, rec->data_len );
940 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
941 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100942
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000943 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100944
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 rec->data_len += transform->maclen;
946 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100947 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100948 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000950 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200951 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200952#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200953 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
955 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200956 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000957
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100958 /* Make extra sure authentication was performed, exactly once */
959 if( auth_done != 1 )
960 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
962 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100963 }
964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000966
967 return( 0 );
968}
969
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200970#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200971/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200972 * Turn a bit into a mask:
973 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
974 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200975 *
976 * This function can be used to write constant-time code by replacing branches
977 * with bit operations using masks.
978 *
979 * This function is implemented without using comparison operators, as those
980 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200981 */
982static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
983{
984 /* MSVC has a warning about unary minus on unsigned integer types,
985 * but this is well-defined and precisely what we want to do here. */
986#if defined(_MSC_VER)
987#pragma warning( push )
988#pragma warning( disable : 4146 )
989#endif
990 return -bit;
991#if defined(_MSC_VER)
992#pragma warning( pop )
993#endif
994}
995
996/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200997 * Constant-flow mask generation for "less than" comparison:
998 * - if x < y, return all bits 1, that is (size_t) -1
999 * - otherwise, return all bits 0, that is 0
1000 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001001 * This function can be used to write constant-time code by replacing branches
1002 * with bit operations using masks.
1003 *
1004 * This function is implemented without using comparison operators, as those
1005 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001006 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001007static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001008{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001009 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001010 const size_t sub = x - y;
1011
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001012 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001013 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1014
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001015 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001016 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001017
1018 return( mask );
1019}
1020
1021/*
1022 * Constant-flow mask generation for "greater or equal" comparison:
1023 * - if x >= y, return all bits 1, that is (size_t) -1
1024 * - otherwise, return all bits 0, that is 0
1025 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001026 * This function can be used to write constant-time code by replacing branches
1027 * with bit operations using masks.
1028 *
1029 * This function is implemented without using comparison operators, as those
1030 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001031 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001032static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001033{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001034 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001035}
1036
1037/*
1038 * Constant-flow boolean "equal" comparison:
1039 * return x == y
1040 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001041 * This function can be used to write constant-time code by replacing branches
1042 * with bit operations - it can be used in conjunction with
1043 * mbedtls_ssl_cf_mask_from_bit().
1044 *
1045 * This function is implemented without using comparison operators, as those
1046 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001047 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001048static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001049{
1050 /* diff = 0 if x == y, non-zero otherwise */
1051 const size_t diff = x ^ y;
1052
1053 /* MSVC has a warning about unary minus on unsigned integer types,
1054 * but this is well-defined and precisely what we want to do here. */
1055#if defined(_MSC_VER)
1056#pragma warning( push )
1057#pragma warning( disable : 4146 )
1058#endif
1059
1060 /* diff_msb's most significant bit is equal to x != y */
1061 const size_t diff_msb = ( diff | -diff );
1062
1063#if defined(_MSC_VER)
1064#pragma warning( pop )
1065#endif
1066
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001067 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001068 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1069
1070 return( 1 ^ diff1 );
1071}
1072
1073/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001074 * Constant-flow conditional memcpy:
1075 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1076 * - otherwise, a no-op,
1077 * but with execution flow independent of the values of c1 and c2.
1078 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001079 * This function is implemented without using comparison operators, as those
1080 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001081 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001082static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1083 const unsigned char *src,
1084 size_t len,
1085 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001087 /* mask = c1 == c2 ? 0xff : 0x00 */
1088 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001089 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001090
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001091 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001092 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001093 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001094}
1095
1096/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001097 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001098 *
1099 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1100 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001101 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001102MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001103 mbedtls_md_context_t *ctx,
1104 const unsigned char *add_data, size_t add_data_len,
1105 const unsigned char *data, size_t data_len_secret,
1106 size_t min_data_len, size_t max_data_len,
1107 unsigned char *output )
1108{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001109 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001110 * This function breaks the HMAC abstraction and uses the md_clone()
1111 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001112 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001113 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001114 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001115 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1118 * minlen, then cloning the context, and for each byte up to maxlen
1119 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001120 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001121 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001122 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001123 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001124 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1125 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001126 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001127 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001128 const unsigned char * const okey = ikey + block_size;
1129 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001130
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001131 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1132 mbedtls_md_context_t aux;
1133 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001135
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001136 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001137
1138#define MD_CHK( func_call ) \
1139 do { \
1140 ret = (func_call); \
1141 if( ret != 0 ) \
1142 goto cleanup; \
1143 } while( 0 )
1144
1145 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001146
1147 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1148 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001149 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1150 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151
1152 /* For each possible length, compute the hash up to that point */
1153 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001154 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001155 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1156 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001157 /* Keep only the correct inner_hash in the output buffer */
1158 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1159 offset, data_len_secret );
1160
1161 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001162 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001163 }
1164
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001165 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001166 MD_CHK( mbedtls_md_starts( ctx ) );
1167 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1168 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1169 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001170
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001171 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001172 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001173
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001174#undef MD_CHK
1175
1176cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001177 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001178 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001179}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001180
1181/*
1182 * Constant-flow memcpy from variable position in buffer.
1183 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001184 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001185 */
1186MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1187 unsigned char *dst,
1188 const unsigned char *src_base,
1189 size_t offset_secret,
1190 size_t offset_min, size_t offset_max,
1191 size_t len )
1192{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001193 size_t offset;
1194
1195 for( offset = offset_min; offset <= offset_max; offset++ )
1196 {
1197 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1198 offset, offset_secret );
1199 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001200}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001201#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001202
Hanno Becker605949f2019-07-12 08:23:59 +01001203int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001204 mbedtls_ssl_transform *transform,
1205 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001206{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001207 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001209 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001210#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001211 size_t padlen = 0, correct = 1;
1212#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001213 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001214 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001215 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216
Hanno Beckera18d1322018-01-03 14:27:32 +00001217#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001218 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001219 ((void) ssl);
1220#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001223 if( rec == NULL ||
1224 rec->buf == NULL ||
1225 rec->buf_len < rec->data_offset ||
1226 rec->buf_len - rec->data_offset < rec->data_len )
1227 {
1228 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001230 }
1231
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001232 data = rec->buf + rec->data_offset;
1233 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001234
Hanno Beckera0e20d02019-05-15 14:03:01 +01001235#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001236 /*
1237 * Match record's CID with incoming CID.
1238 */
Hanno Becker938489a2019-05-08 13:02:22 +01001239 if( rec->cid_len != transform->in_cid_len ||
1240 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1241 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001242 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001243 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001244#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001245
Mateusz Starzyk5224e292021-02-22 14:36:29 +01001246#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001248 {
1249 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001250 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1251 transform->iv_dec,
1252 transform->ivlen,
1253 data, rec->data_len,
1254 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001255 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001256 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001257 return( ret );
1258 }
1259
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001260 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001261 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1263 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001264 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001265 }
Paul Bakker68884e32013-01-07 18:20:04 +01001266 else
Mateusz Starzyk5224e292021-02-22 14:36:29 +01001267#endif /* MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001268#if defined(MBEDTLS_GCM_C) || \
1269 defined(MBEDTLS_CCM_C) || \
1270 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001272 mode == MBEDTLS_MODE_CCM ||
1273 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001274 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001275 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001276 unsigned char *dynamic_iv;
1277 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001278
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001279 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001280 * Extract dynamic part of nonce for AEAD decryption.
1281 *
1282 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1283 * part of the IV is prepended to the ciphertext and
1284 * can be chosen freely - in particular, it need not
1285 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001286 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001287 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001288 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001289 {
1290 if( rec->data_len < dynamic_iv_len )
1291 {
1292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1293 rec->data_len,
1294 dynamic_iv_len ) );
1295 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1296 }
1297 dynamic_iv = data;
1298
1299 data += dynamic_iv_len;
1300 rec->data_offset += dynamic_iv_len;
1301 rec->data_len -= dynamic_iv_len;
1302 }
Hanno Becker17263802020-05-28 07:05:48 +01001303 else
1304 {
1305 dynamic_iv = rec->ctr;
1306 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001307
1308 /* Check that there's space for the authentication tag. */
1309 if( rec->data_len < transform->taglen )
1310 {
Christian von Arnim883d3042020-12-01 11:58:29 +01001311 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) ",
1312 rec->data_len,
1313 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001315 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001316 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001317
Hanno Beckerdf8be222020-05-21 15:30:57 +01001318 /*
1319 * Prepare nonce from dynamic and static parts.
1320 */
Hanno Becker17263802020-05-28 07:05:48 +01001321 ssl_build_record_nonce( iv, sizeof( iv ),
1322 transform->iv_dec,
1323 transform->fixed_ivlen,
1324 dynamic_iv,
1325 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001326
Hanno Beckerdf8be222020-05-21 15:30:57 +01001327 /*
1328 * Build additional data for AEAD encryption.
1329 * This depends on the TLS version.
1330 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001331 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1332 transform->minor_ver );
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
Hanno Beckerd96a6522019-07-10 13:55:25 +01001340 * mbedtls_cipher_auth_decrypt() 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 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", 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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001382#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001383 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1384 {
1385 /* The ciphertext is prefixed with the CBC IV. */
1386 minlen += transform->ivlen;
1387 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001388#endif
Paul Bakker45829992013-01-03 14:52:21 +01001389
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001390 /* Size considerations:
1391 *
1392 * - The CBC cipher text must not be empty and hence
1393 * at least of size transform->ivlen.
1394 *
1395 * Together with the potential IV-prefix, this explains
1396 * the first of the two checks below.
1397 *
1398 * - The record must contain a MAC, either in plain or
1399 * encrypted, depending on whether Encrypt-then-MAC
1400 * is used or not.
1401 * - If it is, the message contains the IV-prefix,
1402 * the CBC ciphertext, and the MAC.
1403 * - If it is not, the padded plaintext, and hence
1404 * the CBC ciphertext, has at least length maclen + 1
1405 * because there is at least the padding length byte.
1406 *
1407 * As the CBC ciphertext is not empty, both cases give the
1408 * lower bound minlen + maclen + 1 on the record size, which
1409 * we test for in the second check below.
1410 */
1411 if( rec->data_len < minlen + transform->ivlen ||
1412 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001413 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001415 "+ 1 ) ( + expl IV )", rec->data_len,
1416 transform->ivlen,
1417 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001419 }
1420
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001421 /*
1422 * Authenticate before decrypt if enabled
1423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001425 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001426 {
Hanno Becker992b6872017-11-09 18:57:39 +00001427 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001429 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001430
Hanno Beckerd96a6522019-07-10 13:55:25 +01001431 /* Update data_len in tandem with add_data.
1432 *
1433 * The subtraction is safe because of the previous check
1434 * data_len >= minlen + maclen + 1.
1435 *
1436 * Afterwards, we know that data + data_len is followed by at
1437 * least maclen Bytes, which justifies the call to
1438 * mbedtls_ssl_safer_memcmp() below.
1439 *
1440 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001442 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1443 transform->minor_ver );
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 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001481 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001483 }
1484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001486 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001487 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001488 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001489 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001490 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001491 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001493
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 data += transform->ivlen;
1495 rec->data_offset += transform->ivlen;
1496 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001497 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001499
Hanno Beckerd96a6522019-07-10 13:55:25 +01001500 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1501
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1503 transform->iv_dec, transform->ivlen,
1504 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001507 return( ret );
1508 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001509
Hanno Beckerd96a6522019-07-10 13:55:25 +01001510 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001511 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001515 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001516
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001517#if defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001519 {
1520 /*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001521 * Save IV in TLS1, where CBC decryption of consecutive
Hanno Beckerd96a6522019-07-10 13:55:25 +01001522 * records is equivalent to CBC decryption of the concatenation
1523 * of the records; in other words, IVs are maintained across
1524 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001525 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001526 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1527 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001528 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001529#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001530
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001531 /* Safe since data_len >= minlen + maclen + 1, so after having
1532 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001533 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1534 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001536
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( auth_done == 1 )
1538 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001539 const size_t mask = mbedtls_ssl_cf_mask_ge(
1540 rec->data_len,
1541 padlen + 1 );
1542 correct &= mask;
1543 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001544 }
1545 else
Paul Bakker45829992013-01-03 14:52:21 +01001546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001548 if( rec->data_len < transform->maclen + padlen + 1 )
1549 {
1550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1551 rec->data_len,
1552 transform->maclen,
1553 padlen + 1 ) );
1554 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001555#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001557 const size_t mask = mbedtls_ssl_cf_mask_ge(
1558 rec->data_len,
1559 transform->maclen + padlen + 1 );
1560 correct &= mask;
1561 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001562 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001563
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 padlen++;
1565
1566 /* Regardless of the validity of the padding,
1567 * we have data_len >= padlen here. */
1568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1570 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001571 /* The padding check involves a series of up to 256
1572 * consecutive memory reads at the end of the record
1573 * plaintext buffer. In order to hide the length and
1574 * validity of the padding, always perform exactly
1575 * `min(256,plaintext_len)` reads (but take into account
1576 * only the last `padlen` bytes for the padding check). */
1577 size_t pad_count = 0;
1578 volatile unsigned char* const check = data;
1579
1580 /* Index of first padding byte; it has been ensured above
1581 * that the subtraction is safe. */
1582 size_t const padding_idx = rec->data_len - padlen;
1583 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1584 size_t const start_idx = rec->data_len - num_checks;
1585 size_t idx;
1586
1587 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001588 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001589 /* pad_count += (idx >= padding_idx) &&
1590 * (check[idx] == padlen - 1);
1591 */
1592 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1593 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1594 padlen - 1 );
1595 pad_count += mask & equal;
1596 }
1597 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001600 if( padlen > 0 && correct == 0 )
1601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001602#endif
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001603 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
1604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1606 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001607
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001608 /* If the padding was found to be invalid, padlen == 0
1609 * and the subtraction is safe. If the padding was found valid,
1610 * padlen hasn't been changed and the previous assertion
1611 * data_len >= padlen still holds. */
1612 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001613 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001614 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001615#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001616 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1618 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001619 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001620
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001621#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001623 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001624#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001625
1626 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001627 * Authenticate if not done yet.
1628 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001629 */
Hanno Becker52344c22018-01-03 15:24:20 +00001630#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001631 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001632 {
Hanno Becker992b6872017-11-09 18:57:39 +00001633 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001634 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001635
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001636 /* If the initial value of padlen was such that
1637 * data_len < maclen + padlen + 1, then padlen
1638 * got reset to 1, and the initial check
1639 * data_len >= minlen + maclen + 1
1640 * guarantees that at this point we still
1641 * have at least data_len >= maclen.
1642 *
1643 * If the initial value of padlen was such that
1644 * data_len >= maclen + padlen + 1, then we have
1645 * subtracted either padlen + 1 (if the padding was correct)
1646 * or 0 (if the padding was incorrect) since then,
1647 * hence data_len >= maclen in any case.
1648 */
1649 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001650 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1651 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1654 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001655 /*
1656 * The next two sizes are the minimum and maximum values of
1657 * data_len over all padlen values.
1658 *
1659 * They're independent of padlen, since we previously did
1660 * data_len -= padlen.
1661 *
1662 * Note that max_len + maclen is never more than the buffer
1663 * length, as we previously did in_msglen -= maclen too.
1664 */
1665 const size_t max_len = rec->data_len + padlen;
1666 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1667
1668 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1669 add_data, add_data_len,
1670 data, rec->data_len, min_len, max_len,
1671 mac_expect );
1672 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001673 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001674 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1675 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001676 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001677
1678 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1679 rec->data_len,
1680 min_len, max_len,
1681 transform->maclen );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1683 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001684
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001685#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001686 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001687 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001688#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001689
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001690 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001691 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693#if defined(MBEDTLS_SSL_DEBUG_ALL)
1694 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001695#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001696 correct = 0;
1697 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001698 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001699 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001700
1701 /*
1702 * Finally check the correct flag
1703 */
1704 if( correct == 0 )
1705 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001706#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001707
1708 /* Make extra sure authentication was performed, exactly once */
1709 if( auth_done != 1 )
1710 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001713 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001714
Hanno Beckerccc13d02020-05-04 12:30:04 +01001715#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1716 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1717 {
1718 /* Remove inner padding and infer true content type. */
1719 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1720 &rec->type );
1721
1722 if( ret != 0 )
1723 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1724 }
1725#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1726
Hanno Beckera0e20d02019-05-15 14:03:01 +01001727#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001728 if( rec->cid_len != 0 )
1729 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001730 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1731 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001732 if( ret != 0 )
1733 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1734 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001735#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001738
1739 return( 0 );
1740}
1741
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001742#undef MAC_NONE
1743#undef MAC_PLAINTEXT
1744#undef MAC_CIPHERTEXT
1745
Paul Bakker5121ce52009-01-03 21:22:43 +00001746/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001747 * Fill the input message buffer by appending data to it.
1748 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001749 *
1750 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1751 * available (from this read and/or a previous one). Otherwise, an error code
1752 * is returned (possibly EOF or WANT_READ).
1753 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001754 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1755 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1756 * since we always read a whole datagram at once.
1757 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001758 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001759 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001762{
Janos Follath865b3eb2019-12-16 11:46:15 +00001763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001764 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001765#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1766 size_t in_buf_len = ssl->in_buf_len;
1767#else
1768 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1769#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001772
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001773 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001776 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001778 }
1779
Darryl Greenb33cc762019-11-28 14:29:44 +00001780 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1783 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001784 }
1785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001787 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001788 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001789 uint32_t timeout;
1790
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001791 /*
1792 * The point is, we need to always read a full datagram at once, so we
1793 * sometimes read more then requested, and handle the additional data.
1794 * It could be the rest of the current record (while fetching the
1795 * header) and/or some other records in the same datagram.
1796 */
1797
1798 /*
1799 * Move to the next record in the already read datagram if applicable
1800 */
1801 if( ssl->next_record_offset != 0 )
1802 {
1803 if( ssl->in_left < ssl->next_record_offset )
1804 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1806 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001807 }
1808
1809 ssl->in_left -= ssl->next_record_offset;
1810
1811 if( ssl->in_left != 0 )
1812 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001814 ssl->next_record_offset ) );
1815 memmove( ssl->in_hdr,
1816 ssl->in_hdr + ssl->next_record_offset,
1817 ssl->in_left );
1818 }
1819
1820 ssl->next_record_offset = 0;
1821 }
1822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001824 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001825
1826 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001827 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001828 */
1829 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001832 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001833 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001834
1835 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001836 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001837 * are not at the beginning of a new record, the caller did something
1838 * wrong.
1839 */
1840 if( ssl->in_left != 0 )
1841 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001842 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1843 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001844 }
1845
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001846 /*
1847 * Don't even try to read if time's out already.
1848 * This avoids by-passing the timer when repeatedly receiving messages
1849 * that will end up being dropped.
1850 */
Hanno Becker7876d122020-02-05 10:39:31 +00001851 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001852 {
1853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001854 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001855 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001856 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001857 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001858 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001861 timeout = ssl->handshake->retransmit_timeout;
1862 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001863 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001866
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001867 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001868 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1869 timeout );
1870 else
1871 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001874
1875 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001877 }
1878
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001879 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001882 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001885 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001886 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001889 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001890 }
1891
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001895 return( ret );
1896 }
1897
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001898 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001899 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001901 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001903 {
Hanno Becker786300f2020-02-05 10:46:40 +00001904 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001905 {
Hanno Becker786300f2020-02-05 10:46:40 +00001906 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1907 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001908 return( ret );
1909 }
1910
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001911 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001912 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001914 }
1915
Paul Bakker5121ce52009-01-03 21:22:43 +00001916 if( ret < 0 )
1917 return( ret );
1918
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001919 ssl->in_left = ret;
1920 }
1921 else
1922#endif
1923 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001925 ssl->in_left, nb_want ) );
1926
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001927 while( ssl->in_left < nb_want )
1928 {
1929 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001930
Hanno Becker7876d122020-02-05 10:39:31 +00001931 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001932 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1933 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001934 {
1935 if( ssl->f_recv_timeout != NULL )
1936 {
1937 ret = ssl->f_recv_timeout( ssl->p_bio,
1938 ssl->in_hdr + ssl->in_left, len,
1939 ssl->conf->read_timeout );
1940 }
1941 else
1942 {
1943 ret = ssl->f_recv( ssl->p_bio,
1944 ssl->in_hdr + ssl->in_left, len );
1945 }
1946 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001949 ssl->in_left, nb_want ) );
1950 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001951
1952 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001954
1955 if( ret < 0 )
1956 return( ret );
1957
makise-homuraaf9513b2020-08-24 18:26:27 +03001958 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001959 {
Darryl Green11999bb2018-03-13 15:22:58 +00001960 MBEDTLS_SSL_DEBUG_MSG( 1,
1961 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07001962 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001963 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1964 }
1965
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001966 ssl->in_left += ret;
1967 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001968 }
1969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001971
1972 return( 0 );
1973}
1974
1975/*
1976 * Flush any data not yet written
1977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001979{
Janos Follath865b3eb2019-12-16 11:46:15 +00001980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001981 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001984
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001985 if( ssl->f_send == NULL )
1986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001988 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001990 }
1991
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001992 /* Avoid incrementing counter if data is flushed */
1993 if( ssl->out_left == 0 )
1994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001996 return( 0 );
1997 }
1998
Paul Bakker5121ce52009-01-03 21:22:43 +00001999 while( ssl->out_left > 0 )
2000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002002 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002003
Hanno Becker2b1e3542018-08-06 11:19:13 +01002004 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002005 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002008
2009 if( ret <= 0 )
2010 return( ret );
2011
makise-homuraaf9513b2020-08-24 18:26:27 +03002012 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002013 {
Darryl Green11999bb2018-03-13 15:22:58 +00002014 MBEDTLS_SSL_DEBUG_MSG( 1,
2015 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002016 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002017 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2018 }
2019
Paul Bakker5121ce52009-01-03 21:22:43 +00002020 ssl->out_left -= ret;
2021 }
2022
Hanno Becker2b1e3542018-08-06 11:19:13 +01002023#if defined(MBEDTLS_SSL_PROTO_DTLS)
2024 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002025 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002026 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002027 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002028 else
2029#endif
2030 {
2031 ssl->out_hdr = ssl->out_buf + 8;
2032 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002033 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002036
2037 return( 0 );
2038}
2039
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002040/*
2041 * Functions to handle the DTLS retransmission state machine
2042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002044/*
2045 * Append current handshake message to current outgoing flight
2046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2051 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2052 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002053
2054 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002055 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002056 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002057 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002059 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002060 }
2061
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002062 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002063 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002066 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002067 }
2068
2069 /* Copy current handshake message with headers */
2070 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2071 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002072 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002073 msg->next = NULL;
2074
2075 /* Append to the current flight */
2076 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002077 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078 else
2079 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002081 while( cur->next != NULL )
2082 cur = cur->next;
2083 cur->next = msg;
2084 }
2085
Hanno Becker3b235902018-08-06 09:54:53 +01002086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002087 return( 0 );
2088}
2089
2090/*
2091 * Free the current flight of handshake messages
2092 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002093void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002094{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095 mbedtls_ssl_flight_item *cur = flight;
2096 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002097
2098 while( cur != NULL )
2099 {
2100 next = cur->next;
2101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 mbedtls_free( cur->p );
2103 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002104
2105 cur = next;
2106 }
2107}
2108
2109/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110 * Swap transform_out and out_ctr with the alternative ones
2111 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002112static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002113{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115 unsigned char tmp_out_ctr[8];
2116
2117 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002120 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002121 }
2122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002124
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002125 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002126 tmp_transform = ssl->transform_out;
2127 ssl->transform_out = ssl->handshake->alt_transform_out;
2128 ssl->handshake->alt_transform_out = tmp_transform;
2129
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002130 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002131 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2132 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002133 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002134
2135 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002136 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002137
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002138 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002139}
2140
2141/*
2142 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002143 */
2144int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2145{
2146 int ret = 0;
2147
2148 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2149
2150 ret = mbedtls_ssl_flight_transmit( ssl );
2151
2152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2153
2154 return( ret );
2155}
2156
2157/*
2158 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159 *
2160 * Need to remember the current message in case flush_output returns
2161 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002162 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002164int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165{
Janos Follath865b3eb2019-12-16 11:46:15 +00002166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002167 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002170 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002171 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002172
2173 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002174 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002175 ret = ssl_swap_epochs( ssl );
2176 if( ret != 0 )
2177 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002180 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181
2182 while( ssl->handshake->cur_msg != NULL )
2183 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002184 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002185 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002186
Hanno Beckere1dcb032018-08-17 16:47:58 +01002187 int const is_finished =
2188 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2189 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2190
Hanno Becker04da1892018-08-14 13:22:10 +01002191 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2192 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2193
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002194 /* Swap epochs before sending Finished: we can't do it after
2195 * sending ChangeCipherSpec, in case write returns WANT_READ.
2196 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002197 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002198 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002199 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002200 ret = ssl_swap_epochs( ssl );
2201 if( ret != 0 )
2202 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002203 }
2204
Hanno Becker67bc7c32018-08-06 11:33:50 +01002205 ret = ssl_get_remaining_payload_in_datagram( ssl );
2206 if( ret < 0 )
2207 return( ret );
2208 max_frag_len = (size_t) ret;
2209
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002210 /* CCS is copied as is, while HS messages may need fragmentation */
2211 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2212 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002213 if( max_frag_len == 0 )
2214 {
2215 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2216 return( ret );
2217
2218 continue;
2219 }
2220
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002221 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002222 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002223 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002224
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002225 /* Update position inside current message */
2226 ssl->handshake->cur_msg_p += cur->len;
2227 }
2228 else
2229 {
2230 const unsigned char * const p = ssl->handshake->cur_msg_p;
2231 const size_t hs_len = cur->len - 12;
2232 const size_t frag_off = p - ( cur->p + 12 );
2233 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002234 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235
Hanno Beckere1dcb032018-08-17 16:47:58 +01002236 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002237 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002238 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002239 {
2240 ret = ssl_swap_epochs( ssl );
2241 if( ret != 0 )
2242 return( ret );
2243 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244
Hanno Becker67bc7c32018-08-06 11:33:50 +01002245 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2246 return( ret );
2247
2248 continue;
2249 }
2250 max_hs_frag_len = max_frag_len - 12;
2251
2252 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2253 max_hs_frag_len : rem_len;
2254
2255 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002256 {
2257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002258 (unsigned) cur_hs_frag_len,
2259 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002260 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002261
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002262 /* Messages are stored with handshake headers as if not fragmented,
2263 * copy beginning of headers then fill fragmentation fields.
2264 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2265 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002266
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002267 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2268 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2269 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2270
Hanno Becker67bc7c32018-08-06 11:33:50 +01002271 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2272 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2273 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002274
2275 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2276
Hanno Becker3f7b9732018-08-28 09:53:25 +01002277 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002278 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2279 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002280 ssl->out_msgtype = cur->type;
2281
2282 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002283 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002284 }
2285
2286 /* If done with the current message move to the next one if any */
2287 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2288 {
2289 if( cur->next != NULL )
2290 {
2291 ssl->handshake->cur_msg = cur->next;
2292 ssl->handshake->cur_msg_p = cur->next->p + 12;
2293 }
2294 else
2295 {
2296 ssl->handshake->cur_msg = NULL;
2297 ssl->handshake->cur_msg_p = NULL;
2298 }
2299 }
2300
2301 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002302 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002303 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002305 return( ret );
2306 }
2307 }
2308
Hanno Becker67bc7c32018-08-06 11:33:50 +01002309 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2310 return( ret );
2311
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002312 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002313 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2314 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002315 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002316 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002317 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002318 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002319 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002320
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002322
2323 return( 0 );
2324}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002325
2326/*
2327 * To be called when the last message of an incoming flight is received.
2328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002330{
2331 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002332 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002333 ssl->handshake->flight = NULL;
2334 ssl->handshake->cur_msg = NULL;
2335
2336 /* The next incoming flight will start with this msg_seq */
2337 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2338
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002339 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002340 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002341
Hanno Becker0271f962018-08-16 13:23:47 +01002342 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002343 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002344
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002345 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002346 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2349 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002350 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002352 }
2353 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002355}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002356
2357/*
2358 * To be called when the last message of an outgoing flight is send.
2359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002361{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002362 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002363 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2366 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002367 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002369 }
2370 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002372}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002374
Paul Bakker5121ce52009-01-03 21:22:43 +00002375/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002376 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002378
2379/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002380 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002381 *
2382 * - fill in handshake headers
2383 * - update handshake checksum
2384 * - DTLS: save message for resending
2385 * - then pass to the record layer
2386 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002387 * DTLS: except for HelloRequest, messages are only queued, and will only be
2388 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002389 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002390 * Inputs:
2391 * - ssl->out_msglen: 4 + actual handshake message len
2392 * (4 is the size of handshake headers for TLS)
2393 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2394 * - ssl->out_msg + 4: the handshake message body
2395 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002396 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002397 * - ssl->out_msglen: the length of the record contents
2398 * (including handshake headers but excluding record headers)
2399 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002401int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002402{
Janos Follath865b3eb2019-12-16 11:46:15 +00002403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002404 const size_t hs_len = ssl->out_msglen - 4;
2405 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002406
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002407 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2408
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002409 /*
2410 * Sanity checks
2411 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002412 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002413 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2414 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002415 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2416 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002417 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002418
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002419 /* Whenever we send anything different from a
2420 * HelloRequest we should be in a handshake - double check. */
2421 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2422 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002423 ssl->handshake == NULL )
2424 {
2425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2426 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2427 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002430 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002431 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002433 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2435 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002436 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002438
Hanno Beckerb50a2532018-08-06 11:52:54 +01002439 /* Double-check that we did not exceed the bounds
2440 * of the outgoing record buffer.
2441 * This should never fail as the various message
2442 * writing functions must obey the bounds of the
2443 * outgoing record buffer, but better be safe.
2444 *
2445 * Note: We deliberately do not check for the MTU or MFL here.
2446 */
2447 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2448 {
2449 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2450 "size %u, maximum %u",
2451 (unsigned) ssl->out_msglen,
2452 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2453 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2454 }
2455
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002456 /*
2457 * Fill handshake headers
2458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002460 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002461 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2462 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2463 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002464
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002465 /*
2466 * DTLS has additional fields in the Handshake layer,
2467 * between the length field and the actual payload:
2468 * uint16 message_seq;
2469 * uint24 fragment_offset;
2470 * uint24 fragment_length;
2471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002473 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002474 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002475 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002476 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002477 {
2478 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2479 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002480 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002481 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002482 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2483 }
2484
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002485 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002486 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002487
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002488 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002489 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002490 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002491 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2492 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2493 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002494 }
2495 else
2496 {
2497 ssl->out_msg[4] = 0;
2498 ssl->out_msg[5] = 0;
2499 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002500
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002501 /* Handshake hashes are computed without fragmentation,
2502 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002503 memset( ssl->out_msg + 6, 0x00, 3 );
2504 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002505 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002507
Hanno Becker0207e532018-08-28 10:28:28 +01002508 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002509 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2510 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002511 }
2512
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002513 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002515 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002516 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2517 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518 {
2519 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2520 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002522 return( ret );
2523 }
2524 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002525 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002526#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002527 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002528 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002529 {
2530 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2531 return( ret );
2532 }
2533 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002534
2535 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2536
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002537 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002538}
2539
2540/*
2541 * Record layer functions
2542 */
2543
2544/*
2545 * Write current record.
2546 *
2547 * Uses:
2548 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2549 * - ssl->out_msglen: length of the record content (excl headers)
2550 * - ssl->out_msg: record content
2551 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002552int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002553{
2554 int ret, done = 0;
2555 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002556 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002557
2558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559
Paul Bakker05ef8352012-05-08 09:17:57 +00002560 if( !done )
2561 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002562 unsigned i;
2563 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002564#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2565 size_t out_buf_len = ssl->out_buf_len;
2566#else
2567 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2568#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002569 /* Skip writing the record content type to after the encryption,
2570 * as it may change when using the CID extension. */
2571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002573 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002574
Hanno Becker19859472018-08-06 09:40:20 +01002575 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002576 ssl->out_len[0] = (unsigned char)( len >> 8 );
2577 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002578
Paul Bakker48916f92012-09-16 19:57:18 +00002579 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002580 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002581 mbedtls_record rec;
2582
2583 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002584 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002585 rec.data_len = ssl->out_msglen;
2586 rec.data_offset = ssl->out_msg - rec.buf;
2587
2588 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2589 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2590 ssl->conf->transport, rec.ver );
2591 rec.type = ssl->out_msgtype;
2592
Hanno Beckera0e20d02019-05-15 14:03:01 +01002593#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002594 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002595 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002596#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002597
Hanno Beckera18d1322018-01-03 14:27:32 +00002598 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002599 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002600 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002602 return( ret );
2603 }
2604
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002605 if( rec.data_offset != 0 )
2606 {
2607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2608 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2609 }
2610
Hanno Becker6430faf2019-05-08 11:57:13 +01002611 /* Update the record content type and CID. */
2612 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002613#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002614 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002615#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002616 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002617 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2618 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002619 }
2620
Hanno Becker5903de42019-05-03 14:46:38 +01002621 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002622
2623#if defined(MBEDTLS_SSL_PROTO_DTLS)
2624 /* In case of DTLS, double-check that we don't exceed
2625 * the remaining space in the datagram. */
2626 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2627 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002628 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002629 if( ret < 0 )
2630 return( ret );
2631
2632 if( protected_record_size > (size_t) ret )
2633 {
2634 /* Should never happen */
2635 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2636 }
2637 }
2638#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002639
Hanno Becker6430faf2019-05-08 11:57:13 +01002640 /* Now write the potentially updated record content type. */
2641 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002644 "version = [%d:%d], msglen = %d",
2645 ssl->out_hdr[0], ssl->out_hdr[1],
2646 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002649 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002650
2651 ssl->out_left += protected_record_size;
2652 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002653 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002654
Hanno Beckerdd772292020-02-05 10:38:31 +00002655 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002656 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2657 break;
2658
2659 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002660 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002661 {
2662 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2663 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2664 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002665 }
2666
Hanno Becker67bc7c32018-08-06 11:33:50 +01002667#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002668 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2669 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002670 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002671 size_t remaining;
2672 ret = ssl_get_remaining_payload_in_datagram( ssl );
2673 if( ret < 0 )
2674 {
2675 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2676 ret );
2677 return( ret );
2678 }
2679
2680 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002681 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002682 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002683 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002684 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002685 else
2686 {
Hanno Becker513815a2018-08-20 11:56:09 +01002687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002688 }
2689 }
2690#endif /* MBEDTLS_SSL_PROTO_DTLS */
2691
2692 if( ( flush == SSL_FORCE_FLUSH ) &&
2693 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002694 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002696 return( ret );
2697 }
2698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002700
2701 return( 0 );
2702}
2703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002705
2706static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2707{
2708 if( ssl->in_msglen < ssl->in_hslen ||
2709 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2710 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2711 {
2712 return( 1 );
2713 }
2714 return( 0 );
2715}
Hanno Becker44650b72018-08-16 12:51:11 +01002716
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002717static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002718{
2719 return( ( ssl->in_msg[9] << 16 ) |
2720 ( ssl->in_msg[10] << 8 ) |
2721 ssl->in_msg[11] );
2722}
2723
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002724static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002725{
2726 return( ( ssl->in_msg[6] << 16 ) |
2727 ( ssl->in_msg[7] << 8 ) |
2728 ssl->in_msg[8] );
2729}
2730
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002731static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002732{
2733 uint32_t msg_len, frag_off, frag_len;
2734
2735 msg_len = ssl_get_hs_total_len( ssl );
2736 frag_off = ssl_get_hs_frag_off( ssl );
2737 frag_len = ssl_get_hs_frag_len( ssl );
2738
2739 if( frag_off > msg_len )
2740 return( -1 );
2741
2742 if( frag_len > msg_len - frag_off )
2743 return( -1 );
2744
2745 if( frag_len + 12 > ssl->in_msglen )
2746 return( -1 );
2747
2748 return( 0 );
2749}
2750
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002751/*
2752 * Mark bits in bitmask (used for DTLS HS reassembly)
2753 */
2754static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2755{
2756 unsigned int start_bits, end_bits;
2757
2758 start_bits = 8 - ( offset % 8 );
2759 if( start_bits != 8 )
2760 {
2761 size_t first_byte_idx = offset / 8;
2762
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002763 /* Special case */
2764 if( len <= start_bits )
2765 {
2766 for( ; len != 0; len-- )
2767 mask[first_byte_idx] |= 1 << ( start_bits - len );
2768
2769 /* Avoid potential issues with offset or len becoming invalid */
2770 return;
2771 }
2772
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002773 offset += start_bits; /* Now offset % 8 == 0 */
2774 len -= start_bits;
2775
2776 for( ; start_bits != 0; start_bits-- )
2777 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2778 }
2779
2780 end_bits = len % 8;
2781 if( end_bits != 0 )
2782 {
2783 size_t last_byte_idx = ( offset + len ) / 8;
2784
2785 len -= end_bits; /* Now len % 8 == 0 */
2786
2787 for( ; end_bits != 0; end_bits-- )
2788 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2789 }
2790
2791 memset( mask + offset / 8, 0xFF, len / 8 );
2792}
2793
2794/*
2795 * Check that bitmask is full
2796 */
2797static int ssl_bitmask_check( unsigned char *mask, size_t len )
2798{
2799 size_t i;
2800
2801 for( i = 0; i < len / 8; i++ )
2802 if( mask[i] != 0xFF )
2803 return( -1 );
2804
2805 for( i = 0; i < len % 8; i++ )
2806 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2807 return( -1 );
2808
2809 return( 0 );
2810}
2811
Hanno Becker56e205e2018-08-16 09:06:12 +01002812/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002813static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002814 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002815{
Hanno Becker56e205e2018-08-16 09:06:12 +01002816 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002817
Hanno Becker56e205e2018-08-16 09:06:12 +01002818 alloc_len = 12; /* Handshake header */
2819 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002820
Hanno Beckerd07df862018-08-16 09:14:58 +01002821 if( add_bitmap )
2822 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002823
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002824 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002825}
Hanno Becker56e205e2018-08-16 09:06:12 +01002826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002828
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002829static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002830{
2831 return( ( ssl->in_msg[1] << 16 ) |
2832 ( ssl->in_msg[2] << 8 ) |
2833 ssl->in_msg[3] );
2834}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002835
Simon Butcher99000142016-10-13 17:21:01 +01002836int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002837{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002839 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002841 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002843 }
2844
Hanno Becker12555c62018-08-16 12:47:53 +01002845 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002848 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002849 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002850
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002852 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002853 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002855 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002856
Hanno Becker44650b72018-08-16 12:51:11 +01002857 if( ssl_check_hs_header( ssl ) != 0 )
2858 {
2859 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2860 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2861 }
2862
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002863 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002864 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2865 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2866 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2867 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002868 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002869 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2870 {
2871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2872 recv_msg_seq,
2873 ssl->handshake->in_msg_seq ) );
2874 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2875 }
2876
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002877 /* Retransmit only on last message from previous flight, to avoid
2878 * too many retransmissions.
2879 * Besides, No sane server ever retransmits HelloVerifyRequest */
2880 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002882 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002884 "message_seq = %d, start_of_flight = %d",
2885 recv_msg_seq,
2886 ssl->handshake->in_flight_start_seq ) );
2887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002891 return( ret );
2892 }
2893 }
2894 else
2895 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002897 "message_seq = %d, expected = %d",
2898 recv_msg_seq,
2899 ssl->handshake->in_msg_seq ) );
2900 }
2901
Hanno Becker90333da2017-10-10 11:27:13 +01002902 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002903 }
2904 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002905
Hanno Becker6d97ef52018-08-16 13:09:04 +01002906 /* Message reassembly is handled alongside buffering of future
2907 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002908 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002909 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002910 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002911 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002913 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002914 }
2915 }
2916 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002918 /* With TLS we don't handle fragmentation (for now) */
2919 if( ssl->in_msglen < ssl->in_hslen )
2920 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2922 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002923 }
2924
Simon Butcher99000142016-10-13 17:21:01 +01002925 return( 0 );
2926}
2927
2928void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2929{
Hanno Becker0271f962018-08-16 13:23:47 +01002930 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002931
Hanno Becker0271f962018-08-16 13:23:47 +01002932 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002933 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002934 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002935 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002936
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002937 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002940 ssl->handshake != NULL )
2941 {
Hanno Becker0271f962018-08-16 13:23:47 +01002942 unsigned offset;
2943 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002944
Hanno Becker0271f962018-08-16 13:23:47 +01002945 /* Increment handshake sequence number */
2946 hs->in_msg_seq++;
2947
2948 /*
2949 * Clear up handshake buffering and reassembly structure.
2950 */
2951
2952 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002953 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002954
2955 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002956 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2957 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002958 offset++, hs_buf++ )
2959 {
2960 *hs_buf = *(hs_buf + 1);
2961 }
2962
2963 /* Create a fresh last entry */
2964 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002965 }
2966#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002967}
2968
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002969/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002970 * DTLS anti-replay: RFC 6347 4.1.2.6
2971 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002972 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2973 * Bit n is set iff record number in_window_top - n has been seen.
2974 *
2975 * Usually, in_window_top is the last record number seen and the lsb of
2976 * in_window is set. The only exception is the initial state (record number 0
2977 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002980void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002981{
2982 ssl->in_window_top = 0;
2983 ssl->in_window = 0;
2984}
2985
2986static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2987{
2988 return( ( (uint64_t) buf[0] << 40 ) |
2989 ( (uint64_t) buf[1] << 32 ) |
2990 ( (uint64_t) buf[2] << 24 ) |
2991 ( (uint64_t) buf[3] << 16 ) |
2992 ( (uint64_t) buf[4] << 8 ) |
2993 ( (uint64_t) buf[5] ) );
2994}
2995
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002996static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2997{
Janos Follath865b3eb2019-12-16 11:46:15 +00002998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002999 unsigned char *original_in_ctr;
3000
3001 // save original in_ctr
3002 original_in_ctr = ssl->in_ctr;
3003
3004 // use counter from record
3005 ssl->in_ctr = record_in_ctr;
3006
3007 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3008
3009 // restore the counter
3010 ssl->in_ctr = original_in_ctr;
3011
3012 return ret;
3013}
3014
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003015/*
3016 * Return 0 if sequence number is acceptable, -1 otherwise
3017 */
Hanno Becker0183d692019-07-12 08:50:37 +01003018int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003019{
3020 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3021 uint64_t bit;
3022
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003023 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003024 return( 0 );
3025
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003026 if( rec_seqnum > ssl->in_window_top )
3027 return( 0 );
3028
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003029 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003030
3031 if( bit >= 64 )
3032 return( -1 );
3033
3034 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3035 return( -1 );
3036
3037 return( 0 );
3038}
3039
3040/*
3041 * Update replay window on new validated record
3042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003044{
3045 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3046
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003047 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003048 return;
3049
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003050 if( rec_seqnum > ssl->in_window_top )
3051 {
3052 /* Update window_top and the contents of the window */
3053 uint64_t shift = rec_seqnum - ssl->in_window_top;
3054
3055 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003056 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003057 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003058 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003059 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003060 ssl->in_window |= 1;
3061 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003062
3063 ssl->in_window_top = rec_seqnum;
3064 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003065 else
3066 {
3067 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003068 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003069
3070 if( bit < 64 ) /* Always true, but be extra sure */
3071 ssl->in_window |= (uint64_t) 1 << bit;
3072 }
3073}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003075
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003076#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003077/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003078 * Without any SSL context, check if a datagram looks like a ClientHello with
3079 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003080 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003081 *
3082 * - if cookie is valid, return 0
3083 * - if ClientHello looks superficially valid but cookie is not,
3084 * fill obuf and set olen, then
3085 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3086 * - otherwise return a specific error code
3087 */
3088static int ssl_check_dtls_clihlo_cookie(
3089 mbedtls_ssl_cookie_write_t *f_cookie_write,
3090 mbedtls_ssl_cookie_check_t *f_cookie_check,
3091 void *p_cookie,
3092 const unsigned char *cli_id, size_t cli_id_len,
3093 const unsigned char *in, size_t in_len,
3094 unsigned char *obuf, size_t buf_len, size_t *olen )
3095{
3096 size_t sid_len, cookie_len;
3097 unsigned char *p;
3098
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003099 /*
3100 * Structure of ClientHello with record and handshake headers,
3101 * and expected values. We don't need to check a lot, more checks will be
3102 * done when actually parsing the ClientHello - skipping those checks
3103 * avoids code duplication and does not make cookie forging any easier.
3104 *
3105 * 0-0 ContentType type; copied, must be handshake
3106 * 1-2 ProtocolVersion version; copied
3107 * 3-4 uint16 epoch; copied, must be 0
3108 * 5-10 uint48 sequence_number; copied
3109 * 11-12 uint16 length; (ignored)
3110 *
3111 * 13-13 HandshakeType msg_type; (ignored)
3112 * 14-16 uint24 length; (ignored)
3113 * 17-18 uint16 message_seq; copied
3114 * 19-21 uint24 fragment_offset; copied, must be 0
3115 * 22-24 uint24 fragment_length; (ignored)
3116 *
3117 * 25-26 ProtocolVersion client_version; (ignored)
3118 * 27-58 Random random; (ignored)
3119 * 59-xx SessionID session_id; 1 byte len + sid_len content
3120 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3121 * ...
3122 *
3123 * Minimum length is 61 bytes.
3124 */
3125 if( in_len < 61 ||
3126 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3127 in[3] != 0 || in[4] != 0 ||
3128 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3129 {
3130 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3131 }
3132
3133 sid_len = in[59];
3134 if( sid_len > in_len - 61 )
3135 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3136
3137 cookie_len = in[60 + sid_len];
3138 if( cookie_len > in_len - 60 )
3139 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3140
3141 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3142 cli_id, cli_id_len ) == 0 )
3143 {
3144 /* Valid cookie */
3145 return( 0 );
3146 }
3147
3148 /*
3149 * If we get here, we've got an invalid cookie, let's prepare HVR.
3150 *
3151 * 0-0 ContentType type; copied
3152 * 1-2 ProtocolVersion version; copied
3153 * 3-4 uint16 epoch; copied
3154 * 5-10 uint48 sequence_number; copied
3155 * 11-12 uint16 length; olen - 13
3156 *
3157 * 13-13 HandshakeType msg_type; hello_verify_request
3158 * 14-16 uint24 length; olen - 25
3159 * 17-18 uint16 message_seq; copied
3160 * 19-21 uint24 fragment_offset; copied
3161 * 22-24 uint24 fragment_length; olen - 25
3162 *
3163 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3164 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3165 *
3166 * Minimum length is 28.
3167 */
3168 if( buf_len < 28 )
3169 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3170
3171 /* Copy most fields and adapt others */
3172 memcpy( obuf, in, 25 );
3173 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3174 obuf[25] = 0xfe;
3175 obuf[26] = 0xff;
3176
3177 /* Generate and write actual cookie */
3178 p = obuf + 28;
3179 if( f_cookie_write( p_cookie,
3180 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3181 {
3182 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3183 }
3184
3185 *olen = p - obuf;
3186
3187 /* Go back and fill length fields */
3188 obuf[27] = (unsigned char)( *olen - 28 );
3189
3190 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3191 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3192 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3193
3194 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3195 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3196
3197 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3198}
3199
3200/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003201 * Handle possible client reconnect with the same UDP quadruplet
3202 * (RFC 6347 Section 4.2.8).
3203 *
3204 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3205 * that looks like a ClientHello.
3206 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003207 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003208 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003209 * - if the input looks like a ClientHello with a valid cookie,
3210 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003211 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003212 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003213 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003214 * This function is called (through ssl_check_client_reconnect()) when an
3215 * unexpected record is found in ssl_get_next_record(), which will discard the
3216 * record if we return 0, and bubble up the return value otherwise (this
3217 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3218 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003219 */
3220static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3221{
Janos Follath865b3eb2019-12-16 11:46:15 +00003222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003223 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003224
Hanno Becker2fddd372019-07-10 14:37:41 +01003225 if( ssl->conf->f_cookie_write == NULL ||
3226 ssl->conf->f_cookie_check == NULL )
3227 {
3228 /* If we can't use cookies to verify reachability of the peer,
3229 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003230 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3231 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003232 return( 0 );
3233 }
3234
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003235 ret = ssl_check_dtls_clihlo_cookie(
3236 ssl->conf->f_cookie_write,
3237 ssl->conf->f_cookie_check,
3238 ssl->conf->p_cookie,
3239 ssl->cli_id, ssl->cli_id_len,
3240 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003241 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003242
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003243 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3244
3245 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003246 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003247 int send_ret;
3248 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3249 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3250 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003251 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003252 * If the error is permanent we'll catch it later,
3253 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003254 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3255 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3256 (void) send_ret;
3257
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003258 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003259 }
3260
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003261 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003262 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003263 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003264 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003265 {
3266 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3267 return( ret );
3268 }
3269
3270 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003271 }
3272
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003273 return( ret );
3274}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003275#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003276
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003277static int ssl_check_record_type( uint8_t record_type )
3278{
3279 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3280 record_type != MBEDTLS_SSL_MSG_ALERT &&
3281 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3282 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3283 {
3284 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3285 }
3286
3287 return( 0 );
3288}
3289
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003290/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003291 * ContentType type;
3292 * ProtocolVersion version;
3293 * uint16 epoch; // DTLS only
3294 * uint48 sequence_number; // DTLS only
3295 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003296 *
3297 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003298 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003299 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3300 *
3301 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003302 * 1. proceed with the record if this function returns 0
3303 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3304 * 3. return CLIENT_RECONNECT if this function return that value
3305 * 4. drop the whole datagram if this function returns anything else.
3306 * Point 2 is needed when the peer is resending, and we have already received
3307 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003308 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003309static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 unsigned char *buf,
3311 size_t len,
3312 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003313{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003314 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003315
Hanno Beckere5e7e782019-07-11 12:29:35 +01003316 size_t const rec_hdr_type_offset = 0;
3317 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003318
Hanno Beckere5e7e782019-07-11 12:29:35 +01003319 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3320 rec_hdr_type_len;
3321 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003322
Hanno Beckere5e7e782019-07-11 12:29:35 +01003323 size_t const rec_hdr_ctr_len = 8;
3324#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003325 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003326 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3327 rec_hdr_version_len;
3328
Hanno Beckera0e20d02019-05-15 14:03:01 +01003329#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003330 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3331 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003332 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003333#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3334#endif /* MBEDTLS_SSL_PROTO_DTLS */
3335
3336 size_t rec_hdr_len_offset; /* To be determined */
3337 size_t const rec_hdr_len_len = 2;
3338
3339 /*
3340 * Check minimum lengths for record header.
3341 */
3342
3343#if defined(MBEDTLS_SSL_PROTO_DTLS)
3344 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3345 {
3346 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3347 }
3348 else
3349#endif /* MBEDTLS_SSL_PROTO_DTLS */
3350 {
3351 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3352 }
3353
3354 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3355 {
3356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3357 (unsigned) len,
3358 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3359 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3360 }
3361
3362 /*
3363 * Parse and validate record content type
3364 */
3365
3366 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367
3368 /* Check record content type */
3369#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3370 rec->cid_len = 0;
3371
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003372 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003373 ssl->conf->cid_len != 0 &&
3374 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003375 {
3376 /* Shift pointers to account for record header including CID
3377 * struct {
3378 * ContentType special_type = tls12_cid;
3379 * ProtocolVersion version;
3380 * uint16 epoch;
3381 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003382 * opaque cid[cid_length]; // Additional field compared to
3383 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003384 * uint16 length;
3385 * opaque enc_content[DTLSCiphertext.length];
3386 * } DTLSCiphertext;
3387 */
3388
3389 /* So far, we only support static CID lengths
3390 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003391 rec_hdr_cid_len = ssl->conf->cid_len;
3392 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003393
Hanno Beckere5e7e782019-07-11 12:29:35 +01003394 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003395 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3397 (unsigned) len,
3398 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003399 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003400 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003401
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003402 /* configured CID len is guaranteed at most 255, see
3403 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3404 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003405 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003406 }
3407 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003408#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003409 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003410 if( ssl_check_record_type( rec->type ) )
3411 {
Hanno Becker54229812019-07-12 14:40:00 +01003412 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3413 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003414 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3415 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003416 }
3417
Hanno Beckere5e7e782019-07-11 12:29:35 +01003418 /*
3419 * Parse and validate record version
3420 */
3421
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003422 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3423 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003424 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3425 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003426 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003427
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003428 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3431 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003432 }
3433
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003434 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003435 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3437 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003438 }
3439
Hanno Beckere5e7e782019-07-11 12:29:35 +01003440 /*
3441 * Parse/Copy record sequence number.
3442 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003443
Hanno Beckere5e7e782019-07-11 12:29:35 +01003444#if defined(MBEDTLS_SSL_PROTO_DTLS)
3445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003446 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 /* Copy explicit record sequence number from input buffer. */
3448 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3449 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003450 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003451 else
3452#endif /* MBEDTLS_SSL_PROTO_DTLS */
3453 {
3454 /* Copy implicit record sequence number from SSL context structure. */
3455 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3456 }
Paul Bakker40e46942009-01-03 21:51:57 +00003457
Hanno Beckere5e7e782019-07-11 12:29:35 +01003458 /*
3459 * Parse record length.
3460 */
3461
Hanno Beckere5e7e782019-07-11 12:29:35 +01003462 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003463 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3464 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003465 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003467 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003468 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003469 rec->type,
3470 major_ver, minor_ver, rec->data_len ) );
3471
3472 rec->buf = buf;
3473 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003474
Hanno Beckerd417cc92019-07-26 08:20:27 +01003475 if( rec->data_len == 0 )
3476 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003477
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003478 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003479 * DTLS-related tests.
3480 * Check epoch before checking length constraint because
3481 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3482 * message gets duplicated before the corresponding Finished message,
3483 * the second ChangeCipherSpec should be discarded because it belongs
3484 * to an old epoch, but not because its length is shorter than
3485 * the minimum record length for packets using the new record transform.
3486 * Note that these two kinds of failures are handled differently,
3487 * as an unexpected record is silently skipped but an invalid
3488 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003489 */
3490#if defined(MBEDTLS_SSL_PROTO_DTLS)
3491 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3492 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003493 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003494
Hanno Becker955a5c92019-07-10 17:12:07 +01003495 /* Check that the datagram is large enough to contain a record
3496 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003497 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003498 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3500 (unsigned) len,
3501 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003502 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3503 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003504
Hanno Becker37cfe732019-07-10 17:20:01 +01003505 /* Records from other, non-matching epochs are silently discarded.
3506 * (The case of same-port Client reconnects must be considered in
3507 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003508 if( rec_epoch != ssl->in_epoch )
3509 {
3510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3511 "expected %d, received %d",
3512 ssl->in_epoch, rec_epoch ) );
3513
Hanno Becker552f7472019-07-19 10:59:12 +01003514 /* Records from the next epoch are considered for buffering
3515 * (concretely: early Finished messages). */
3516 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003517 {
Hanno Becker552f7472019-07-19 10:59:12 +01003518 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3519 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003520 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003521
Hanno Becker2fddd372019-07-10 14:37:41 +01003522 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003523 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003524#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003525 /* For records from the correct epoch, check whether their
3526 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003527 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3528 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003529 {
3530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3531 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3532 }
3533#endif
3534 }
3535#endif /* MBEDTLS_SSL_PROTO_DTLS */
3536
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003537 return( 0 );
3538}
Paul Bakker5121ce52009-01-03 21:22:43 +00003539
Paul Bakker5121ce52009-01-03 21:22:43 +00003540
Hanno Becker2fddd372019-07-10 14:37:41 +01003541#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3542static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3543{
3544 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3545
3546 /*
3547 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3548 * access the first byte of record content (handshake type), as we
3549 * have an active transform (possibly iv_len != 0), so use the
3550 * fact that the record header len is 13 instead.
3551 */
3552 if( rec_epoch == 0 &&
3553 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3554 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3555 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3556 ssl->in_left > 13 &&
3557 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3558 {
3559 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3560 "from the same port" ) );
3561 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 }
3563
3564 return( 0 );
3565}
Hanno Becker2fddd372019-07-10 14:37:41 +01003566#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003567
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003568/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003569 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003570 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003571static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3572 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003573{
3574 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003577 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003578
Paul Bakker48916f92012-09-16 19:57:18 +00003579 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003580 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003581 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003582
Hanno Beckera18d1322018-01-03 14:27:32 +00003583 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003584 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003587
Hanno Beckera0e20d02019-05-15 14:03:01 +01003588#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003589 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3590 ssl->conf->ignore_unexpected_cid
3591 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3592 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003593 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003594 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003595 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003596#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003597
Paul Bakker5121ce52009-01-03 21:22:43 +00003598 return( ret );
3599 }
3600
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003601 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003602 {
3603 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003604 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003605 }
3606
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003607 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003608 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003609
Hanno Beckera0e20d02019-05-15 14:03:01 +01003610#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003611 /* We have already checked the record content type
3612 * in ssl_parse_record_header(), failing or silently
3613 * dropping the record in the case of an unknown type.
3614 *
3615 * Since with the use of CIDs, the record content type
3616 * might change during decryption, re-check the record
3617 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003618 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003619 {
3620 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3621 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3622 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003623#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003624
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003625 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003626 {
3627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3628 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003629 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003630 {
3631 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3633 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3634 }
3635#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3636
3637 ssl->nb_zero++;
3638
3639 /*
3640 * Three or more empty messages may be a DoS attack
3641 * (excessive CPU consumption).
3642 */
3643 if( ssl->nb_zero > 3 )
3644 {
3645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003646 "messages, possible DoS attack" ) );
3647 /* Treat the records as if they were not properly authenticated,
3648 * thereby failing the connection if we see more than allowed
3649 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003650 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3651 }
3652 }
3653 else
3654 ssl->nb_zero = 0;
3655
3656#if defined(MBEDTLS_SSL_PROTO_DTLS)
3657 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3658 {
3659 ; /* in_ctr read from peer, not maintained internally */
3660 }
3661 else
3662#endif
3663 {
3664 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003665 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003666 if( ++ssl->in_ctr[i - 1] != 0 )
3667 break;
3668
3669 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003670 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003671 {
3672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3673 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3674 }
3675 }
3676
Paul Bakker5121ce52009-01-03 21:22:43 +00003677 }
3678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003680 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003682 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003683 }
3684#endif
3685
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003686 /* Check actual (decrypted) record content length against
3687 * configured maximum. */
3688 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3689 {
3690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3691 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3692 }
3693
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003694 return( 0 );
3695}
3696
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003697/*
3698 * Read a record.
3699 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003700 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3701 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3702 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003703 */
Hanno Becker1097b342018-08-15 14:09:41 +01003704
3705/* Helper functions for mbedtls_ssl_read_record(). */
3706static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003707static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3708static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003709
Hanno Becker327c93b2018-08-15 13:56:18 +01003710int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003711 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003712{
Janos Follath865b3eb2019-12-16 11:46:15 +00003713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003716
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003717 if( ssl->keep_current_message == 0 )
3718 {
3719 do {
Simon Butcher99000142016-10-13 17:21:01 +01003720
Hanno Becker26994592018-08-15 14:14:59 +01003721 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003722 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003723 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003724
Hanno Beckere74d5562018-08-15 14:26:08 +01003725 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003726 {
Hanno Becker40f50842018-08-15 14:48:01 +01003727#if defined(MBEDTLS_SSL_PROTO_DTLS)
3728 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003729
Hanno Becker40f50842018-08-15 14:48:01 +01003730 /* We only check for buffered messages if the
3731 * current datagram is fully consumed. */
3732 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003733 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003734 {
Hanno Becker40f50842018-08-15 14:48:01 +01003735 if( ssl_load_buffered_message( ssl ) == 0 )
3736 have_buffered = 1;
3737 }
3738
3739 if( have_buffered == 0 )
3740#endif /* MBEDTLS_SSL_PROTO_DTLS */
3741 {
3742 ret = ssl_get_next_record( ssl );
3743 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3744 continue;
3745
3746 if( ret != 0 )
3747 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003748 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003749 return( ret );
3750 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003751 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003752 }
3753
3754 ret = mbedtls_ssl_handle_message_type( ssl );
3755
Hanno Becker40f50842018-08-15 14:48:01 +01003756#if defined(MBEDTLS_SSL_PROTO_DTLS)
3757 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3758 {
3759 /* Buffer future message */
3760 ret = ssl_buffer_message( ssl );
3761 if( ret != 0 )
3762 return( ret );
3763
3764 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3765 }
3766#endif /* MBEDTLS_SSL_PROTO_DTLS */
3767
Hanno Becker90333da2017-10-10 11:27:13 +01003768 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3769 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003770
3771 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003772 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003773 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003774 return( ret );
3775 }
3776
Hanno Becker327c93b2018-08-15 13:56:18 +01003777 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003778 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003779 {
3780 mbedtls_ssl_update_handshake_status( ssl );
3781 }
Simon Butcher99000142016-10-13 17:21:01 +01003782 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003783 else
Simon Butcher99000142016-10-13 17:21:01 +01003784 {
Hanno Becker02f59072018-08-15 14:00:24 +01003785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003786 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003787 }
3788
3789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3790
3791 return( 0 );
3792}
3793
Hanno Becker40f50842018-08-15 14:48:01 +01003794#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003795static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003796{
Hanno Becker40f50842018-08-15 14:48:01 +01003797 if( ssl->in_left > ssl->next_record_offset )
3798 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003799
Hanno Becker40f50842018-08-15 14:48:01 +01003800 return( 0 );
3801}
3802
3803static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3804{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003805 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003806 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003807 int ret = 0;
3808
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003809 if( hs == NULL )
3810 return( -1 );
3811
Hanno Beckere00ae372018-08-20 09:39:42 +01003812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3813
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003814 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3815 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3816 {
3817 /* Check if we have seen a ChangeCipherSpec before.
3818 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003819 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003820 {
3821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3822 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003823 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003824 }
3825
Hanno Becker39b8bc92018-08-28 17:17:13 +01003826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003827 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3828 ssl->in_msglen = 1;
3829 ssl->in_msg[0] = 1;
3830
3831 /* As long as they are equal, the exact value doesn't matter. */
3832 ssl->in_left = 0;
3833 ssl->next_record_offset = 0;
3834
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003835 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003836 goto exit;
3837 }
Hanno Becker37f95322018-08-16 13:55:32 +01003838
Hanno Beckerb8f50142018-08-28 10:01:34 +01003839#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003840 /* Debug only */
3841 {
3842 unsigned offset;
3843 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3844 {
3845 hs_buf = &hs->buffering.hs[offset];
3846 if( hs_buf->is_valid == 1 )
3847 {
3848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3849 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003850 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003851 }
3852 }
3853 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003854#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003855
3856 /* Check if we have buffered and/or fully reassembled the
3857 * next handshake message. */
3858 hs_buf = &hs->buffering.hs[0];
3859 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3860 {
3861 /* Synthesize a record containing the buffered HS message. */
3862 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3863 ( hs_buf->data[2] << 8 ) |
3864 hs_buf->data[3];
3865
3866 /* Double-check that we haven't accidentally buffered
3867 * a message that doesn't fit into the input buffer. */
3868 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3869 {
3870 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3871 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3872 }
3873
3874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3875 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3876 hs_buf->data, msg_len + 12 );
3877
3878 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3879 ssl->in_hslen = msg_len + 12;
3880 ssl->in_msglen = msg_len + 12;
3881 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3882
3883 ret = 0;
3884 goto exit;
3885 }
3886 else
3887 {
3888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3889 hs->in_msg_seq ) );
3890 }
3891
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003892 ret = -1;
3893
3894exit:
3895
3896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3897 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003898}
3899
Hanno Beckera02b0b42018-08-21 17:20:27 +01003900static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3901 size_t desired )
3902{
3903 int offset;
3904 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3906 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003907
Hanno Becker01315ea2018-08-21 17:22:17 +01003908 /* Get rid of future records epoch first, if such exist. */
3909 ssl_free_buffered_record( ssl );
3910
3911 /* Check if we have enough space available now. */
3912 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3913 hs->buffering.total_bytes_buffered ) )
3914 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003916 return( 0 );
3917 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003918
Hanno Becker4f432ad2018-08-28 10:02:32 +01003919 /* We don't have enough space to buffer the next expected handshake
3920 * message. Remove buffers used for future messages to gain space,
3921 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003922 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3923 offset >= 0; offset-- )
3924 {
3925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3926 offset ) );
3927
Hanno Beckerb309b922018-08-23 13:18:05 +01003928 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003929
3930 /* Check if we have enough space available now. */
3931 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3932 hs->buffering.total_bytes_buffered ) )
3933 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003935 return( 0 );
3936 }
3937 }
3938
3939 return( -1 );
3940}
3941
Hanno Becker40f50842018-08-15 14:48:01 +01003942static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3943{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003944 int ret = 0;
3945 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3946
3947 if( hs == NULL )
3948 return( 0 );
3949
3950 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3951
3952 switch( ssl->in_msgtype )
3953 {
3954 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003956
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003957 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003958 break;
3959
3960 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003961 {
3962 unsigned recv_msg_seq_offset;
3963 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3964 mbedtls_ssl_hs_buffer *hs_buf;
3965 size_t msg_len = ssl->in_hslen - 12;
3966
3967 /* We should never receive an old handshake
3968 * message - double-check nonetheless. */
3969 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3970 {
3971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3972 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3973 }
3974
3975 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3976 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3977 {
3978 /* Silently ignore -- message too far in the future */
3979 MBEDTLS_SSL_DEBUG_MSG( 2,
3980 ( "Ignore future HS message with sequence number %u, "
3981 "buffering window %u - %u",
3982 recv_msg_seq, ssl->handshake->in_msg_seq,
3983 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3984
3985 goto exit;
3986 }
3987
3988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3989 recv_msg_seq, recv_msg_seq_offset ) );
3990
3991 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3992
3993 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003994 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003995 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003996 size_t reassembly_buf_sz;
3997
Hanno Becker37f95322018-08-16 13:55:32 +01003998 hs_buf->is_fragmented =
3999 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4000
4001 /* We copy the message back into the input buffer
4002 * after reassembly, so check that it's not too large.
4003 * This is an implementation-specific limitation
4004 * and not one from the standard, hence it is not
4005 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004006 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004007 {
4008 /* Ignore message */
4009 goto exit;
4010 }
4011
Hanno Beckere0b150f2018-08-21 15:51:03 +01004012 /* Check if we have enough space to buffer the message. */
4013 if( hs->buffering.total_bytes_buffered >
4014 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4015 {
4016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4017 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4018 }
4019
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004020 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4021 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004022
4023 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4024 hs->buffering.total_bytes_buffered ) )
4025 {
4026 if( recv_msg_seq_offset > 0 )
4027 {
4028 /* If we can't buffer a future message because
4029 * of space limitations -- ignore. */
4030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- ignore\n",
4031 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4032 (unsigned) hs->buffering.total_bytes_buffered ) );
4033 goto exit;
4034 }
Hanno Beckere1801392018-08-21 16:51:05 +01004035 else
4036 {
4037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4038 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4039 (unsigned) hs->buffering.total_bytes_buffered ) );
4040 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004041
Hanno Beckera02b0b42018-08-21 17:20:27 +01004042 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004043 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %u (%u with bitmap) would exceed the compile-time limit %u (already %u bytes buffered) -- fail\n",
4045 (unsigned) msg_len,
4046 (unsigned) reassembly_buf_sz,
4047 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004048 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004049 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4050 goto exit;
4051 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004052 }
4053
4054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4055 msg_len ) );
4056
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004057 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4058 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004059 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004060 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004061 goto exit;
4062 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004063 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004064
4065 /* Prepare final header: copy msg_type, length and message_seq,
4066 * then add standardised fragment_offset and fragment_length */
4067 memcpy( hs_buf->data, ssl->in_msg, 6 );
4068 memset( hs_buf->data + 6, 0, 3 );
4069 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4070
4071 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004072
4073 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004074 }
4075 else
4076 {
4077 /* Make sure msg_type and length are consistent */
4078 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4079 {
4080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4081 /* Ignore */
4082 goto exit;
4083 }
4084 }
4085
Hanno Becker4422bbb2018-08-20 09:40:19 +01004086 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004087 {
4088 size_t frag_len, frag_off;
4089 unsigned char * const msg = hs_buf->data + 12;
4090
4091 /*
4092 * Check and copy current fragment
4093 */
4094
4095 /* Validation of header fields already done in
4096 * mbedtls_ssl_prepare_handshake_record(). */
4097 frag_off = ssl_get_hs_frag_off( ssl );
4098 frag_len = ssl_get_hs_frag_len( ssl );
4099
4100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4101 frag_off, frag_len ) );
4102 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4103
4104 if( hs_buf->is_fragmented )
4105 {
4106 unsigned char * const bitmask = msg + msg_len;
4107 ssl_bitmask_set( bitmask, frag_off, frag_len );
4108 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4109 msg_len ) == 0 );
4110 }
4111 else
4112 {
4113 hs_buf->is_complete = 1;
4114 }
4115
4116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4117 hs_buf->is_complete ? "" : "not yet " ) );
4118 }
4119
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004120 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004121 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004122
4123 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004124 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125 break;
4126 }
4127
4128exit:
4129
4130 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4131 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004132}
4133#endif /* MBEDTLS_SSL_PROTO_DTLS */
4134
Hanno Becker1097b342018-08-15 14:09:41 +01004135static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004136{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004137 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004138 * Consume last content-layer message and potentially
4139 * update in_msglen which keeps track of the contents'
4140 * consumption state.
4141 *
4142 * (1) Handshake messages:
4143 * Remove last handshake message, move content
4144 * and adapt in_msglen.
4145 *
4146 * (2) Alert messages:
4147 * Consume whole record content, in_msglen = 0.
4148 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004149 * (3) Change cipher spec:
4150 * Consume whole record content, in_msglen = 0.
4151 *
4152 * (4) Application data:
4153 * Don't do anything - the record layer provides
4154 * the application data as a stream transport
4155 * and consumes through mbedtls_ssl_read only.
4156 *
4157 */
4158
4159 /* Case (1): Handshake messages */
4160 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004161 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004162 /* Hard assertion to be sure that no application data
4163 * is in flight, as corrupting ssl->in_msglen during
4164 * ssl->in_offt != NULL is fatal. */
4165 if( ssl->in_offt != NULL )
4166 {
4167 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4168 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4169 }
4170
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004171 /*
4172 * Get next Handshake message in the current record
4173 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004174
Hanno Becker4a810fb2017-05-24 16:27:30 +01004175 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004176 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004177 * current handshake content: If DTLS handshake
4178 * fragmentation is used, that's the fragment
4179 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004180 * size here is faulty and should be changed at
4181 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004182 * (2) While it doesn't seem to cause problems, one
4183 * has to be very careful not to assume that in_hslen
4184 * is always <= in_msglen in a sensible communication.
4185 * Again, it's wrong for DTLS handshake fragmentation.
4186 * The following check is therefore mandatory, and
4187 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004188 * Additionally, ssl->in_hslen might be arbitrarily out of
4189 * bounds after handling a DTLS message with an unexpected
4190 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004191 */
4192 if( ssl->in_hslen < ssl->in_msglen )
4193 {
4194 ssl->in_msglen -= ssl->in_hslen;
4195 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4196 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004197
Hanno Becker4a810fb2017-05-24 16:27:30 +01004198 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4199 ssl->in_msg, ssl->in_msglen );
4200 }
4201 else
4202 {
4203 ssl->in_msglen = 0;
4204 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004205
Hanno Becker4a810fb2017-05-24 16:27:30 +01004206 ssl->in_hslen = 0;
4207 }
4208 /* Case (4): Application data */
4209 else if( ssl->in_offt != NULL )
4210 {
4211 return( 0 );
4212 }
4213 /* Everything else (CCS & Alerts) */
4214 else
4215 {
4216 ssl->in_msglen = 0;
4217 }
4218
Hanno Becker1097b342018-08-15 14:09:41 +01004219 return( 0 );
4220}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004221
Hanno Beckere74d5562018-08-15 14:26:08 +01004222static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4223{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004224 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004225 return( 1 );
4226
4227 return( 0 );
4228}
4229
Hanno Becker5f066e72018-08-16 14:56:31 +01004230#if defined(MBEDTLS_SSL_PROTO_DTLS)
4231
4232static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4233{
4234 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4235 if( hs == NULL )
4236 return;
4237
Hanno Becker01315ea2018-08-21 17:22:17 +01004238 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004239 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004240 hs->buffering.total_bytes_buffered -=
4241 hs->buffering.future_record.len;
4242
4243 mbedtls_free( hs->buffering.future_record.data );
4244 hs->buffering.future_record.data = NULL;
4245 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004246}
4247
4248static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4249{
4250 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4251 unsigned char * rec;
4252 size_t rec_len;
4253 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004254#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4255 size_t in_buf_len = ssl->in_buf_len;
4256#else
4257 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4258#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004259 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4260 return( 0 );
4261
4262 if( hs == NULL )
4263 return( 0 );
4264
Hanno Becker5f066e72018-08-16 14:56:31 +01004265 rec = hs->buffering.future_record.data;
4266 rec_len = hs->buffering.future_record.len;
4267 rec_epoch = hs->buffering.future_record.epoch;
4268
4269 if( rec == NULL )
4270 return( 0 );
4271
Hanno Becker4cb782d2018-08-20 11:19:05 +01004272 /* Only consider loading future records if the
4273 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004274 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004275 return( 0 );
4276
Hanno Becker5f066e72018-08-16 14:56:31 +01004277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4278
4279 if( rec_epoch != ssl->in_epoch )
4280 {
4281 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4282 goto exit;
4283 }
4284
4285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4286
4287 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004288 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004289 {
4290 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4291 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4292 }
4293
4294 memcpy( ssl->in_hdr, rec, rec_len );
4295 ssl->in_left = rec_len;
4296 ssl->next_record_offset = 0;
4297
4298 ssl_free_buffered_record( ssl );
4299
4300exit:
4301 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4302 return( 0 );
4303}
4304
Hanno Becker519f15d2019-07-11 12:43:20 +01004305static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4306 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004307{
4308 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004309
4310 /* Don't buffer future records outside handshakes. */
4311 if( hs == NULL )
4312 return( 0 );
4313
4314 /* Only buffer handshake records (we are only interested
4315 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004316 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004317 return( 0 );
4318
4319 /* Don't buffer more than one future epoch record. */
4320 if( hs->buffering.future_record.data != NULL )
4321 return( 0 );
4322
Hanno Becker01315ea2018-08-21 17:22:17 +01004323 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004324 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004325 hs->buffering.total_bytes_buffered ) )
4326 {
4327 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- ignore\n",
Hanno Becker519f15d2019-07-11 12:43:20 +01004328 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004329 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004330 return( 0 );
4331 }
4332
Hanno Becker5f066e72018-08-16 14:56:31 +01004333 /* Buffer record */
4334 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4335 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004336 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004337
4338 /* ssl_parse_record_header() only considers records
4339 * of the next epoch as candidates for buffering. */
4340 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004341 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004342
4343 hs->buffering.future_record.data =
4344 mbedtls_calloc( 1, hs->buffering.future_record.len );
4345 if( hs->buffering.future_record.data == NULL )
4346 {
4347 /* If we run out of RAM trying to buffer a
4348 * record from the next epoch, just ignore. */
4349 return( 0 );
4350 }
4351
Hanno Becker519f15d2019-07-11 12:43:20 +01004352 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004353
Hanno Becker519f15d2019-07-11 12:43:20 +01004354 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004355 return( 0 );
4356}
4357
4358#endif /* MBEDTLS_SSL_PROTO_DTLS */
4359
Hanno Beckere74d5562018-08-15 14:26:08 +01004360static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004361{
Janos Follath865b3eb2019-12-16 11:46:15 +00004362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004363 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004364
Hanno Becker5f066e72018-08-16 14:56:31 +01004365#if defined(MBEDTLS_SSL_PROTO_DTLS)
4366 /* We might have buffered a future record; if so,
4367 * and if the epoch matches now, load it.
4368 * On success, this call will set ssl->in_left to
4369 * the length of the buffered record, so that
4370 * the calls to ssl_fetch_input() below will
4371 * essentially be no-ops. */
4372 ret = ssl_load_buffered_record( ssl );
4373 if( ret != 0 )
4374 return( ret );
4375#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004376
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004377 /* Ensure that we have enough space available for the default form
4378 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4379 * with no space for CIDs counted in). */
4380 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4381 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004382 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004383 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004384 return( ret );
4385 }
4386
Hanno Beckere5e7e782019-07-11 12:29:35 +01004387 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4388 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004391 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004392 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004393 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4394 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004395 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004396 if( ret != 0 )
4397 return( ret );
4398
4399 /* Fall through to handling of unexpected records */
4400 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4401 }
4402
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004403 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4404 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004405#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004406 /* Reset in pointers to default state for TLS/DTLS records,
4407 * assuming no CID and no offset between record content and
4408 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004409 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004410
Hanno Becker7ae20e02019-07-12 08:33:49 +01004411 /* Setup internal message pointers from record structure. */
4412 ssl->in_msgtype = rec.type;
4413#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4414 ssl->in_len = ssl->in_cid + rec.cid_len;
4415#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4416 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4417 ssl->in_msglen = rec.data_len;
4418
Hanno Becker2fddd372019-07-10 14:37:41 +01004419 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004420 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004421 if( ret != 0 )
4422 return( ret );
4423#endif
4424
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004425 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004426 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004427
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4429 "(header)" ) );
4430 }
4431 else
4432 {
4433 /* Skip invalid record and the rest of the datagram */
4434 ssl->next_record_offset = 0;
4435 ssl->in_left = 0;
4436
4437 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4438 "(header)" ) );
4439 }
4440
4441 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004442 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004443 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004444 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004445#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004446 {
4447 return( ret );
4448 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004451#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004452 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004453 {
Hanno Beckera8814792019-07-10 15:01:45 +01004454 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004455 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004456 if( ssl->next_record_offset < ssl->in_left )
4457 {
4458 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4459 }
4460 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004461 else
4462#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004463 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004464 /*
4465 * Fetch record contents from underlying transport.
4466 */
Hanno Beckera3175662019-07-11 12:50:29 +01004467 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004468 if( ret != 0 )
4469 {
4470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4471 return( ret );
4472 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004473
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004474 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004475 }
4476
4477 /*
4478 * Decrypt record contents.
4479 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480
Hanno Beckerfdf66042019-07-11 13:07:45 +01004481 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004482 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004483#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004484 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004485 {
4486 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004487 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004488 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004489 /* Except when waiting for Finished as a bad mac here
4490 * probably means something went wrong in the handshake
4491 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4492 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4493 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4494 {
4495#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4496 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4497 {
4498 mbedtls_ssl_send_alert_message( ssl,
4499 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4500 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4501 }
4502#endif
4503 return( ret );
4504 }
4505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004507 if( ssl->conf->badmac_limit != 0 &&
4508 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4511 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004512 }
4513#endif
4514
Hanno Becker4a810fb2017-05-24 16:27:30 +01004515 /* As above, invalid records cause
4516 * dismissal of the whole datagram. */
4517
4518 ssl->next_record_offset = 0;
4519 ssl->in_left = 0;
4520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004522 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004523 }
4524
4525 return( ret );
4526 }
4527 else
4528#endif
4529 {
4530 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4532 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004533 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004534 mbedtls_ssl_send_alert_message( ssl,
4535 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4536 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004537 }
4538#endif
4539 return( ret );
4540 }
4541 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004542
Hanno Becker44d89b22019-07-12 09:40:44 +01004543
4544 /* Reset in pointers to default state for TLS/DTLS records,
4545 * assuming no CID and no offset between record content and
4546 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004547 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004548#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4549 ssl->in_len = ssl->in_cid + rec.cid_len;
4550#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004551 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004552
Hanno Becker8685c822019-07-12 09:37:30 +01004553 /* The record content type may change during decryption,
4554 * so re-read it. */
4555 ssl->in_msgtype = rec.type;
4556 /* Also update the input buffer, because unfortunately
4557 * the server-side ssl_parse_client_hello() reparses the
4558 * record header when receiving a ClientHello initiating
4559 * a renegotiation. */
4560 ssl->in_hdr[0] = rec.type;
4561 ssl->in_msg = rec.buf + rec.data_offset;
4562 ssl->in_msglen = rec.data_len;
4563 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4564 ssl->in_len[1] = (unsigned char)( rec.data_len );
4565
Simon Butcher99000142016-10-13 17:21:01 +01004566 return( 0 );
4567}
4568
4569int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4570{
Janos Follath865b3eb2019-12-16 11:46:15 +00004571 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004572
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004573 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004574 * Handle particular types of records
4575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004576 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004577 {
Simon Butcher99000142016-10-13 17:21:01 +01004578 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4579 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004580 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004581 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004582 }
4583
Hanno Beckere678eaa2018-08-21 14:57:46 +01004584 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004585 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004586 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004587 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4589 ssl->in_msglen ) );
4590 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004591 }
4592
Hanno Beckere678eaa2018-08-21 14:57:46 +01004593 if( ssl->in_msg[0] != 1 )
4594 {
4595 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4596 ssl->in_msg[0] ) );
4597 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4598 }
4599
4600#if defined(MBEDTLS_SSL_PROTO_DTLS)
4601 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4602 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4603 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4604 {
4605 if( ssl->handshake == NULL )
4606 {
4607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4608 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4609 }
4610
4611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4612 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4613 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004614#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004615 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004617 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004618 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004619 if( ssl->in_msglen != 2 )
4620 {
4621 /* Note: Standard allows for more than one 2 byte alert
4622 to be packed in a single message, but Mbed TLS doesn't
4623 currently support this. */
4624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4625 ssl->in_msglen ) );
4626 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4627 }
4628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004630 ssl->in_msg[0], ssl->in_msg[1] ) );
4631
4632 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004633 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004638 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004640 }
4641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4643 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004644 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4646 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004647 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004648
4649#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4650 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4651 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4652 {
Hanno Becker90333da2017-10-10 11:27:13 +01004653 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004654 /* Will be handled when trying to parse ServerHello */
4655 return( 0 );
4656 }
4657#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004658 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004659 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004660 }
4661
Hanno Beckerc76c6192017-06-06 10:03:17 +01004662#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004663 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004664 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004665 /* Drop unexpected ApplicationData records,
4666 * except at the beginning of renegotiations */
4667 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4668 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4669#if defined(MBEDTLS_SSL_RENEGOTIATION)
4670 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4671 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004672#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004673 )
4674 {
4675 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4676 return( MBEDTLS_ERR_SSL_NON_FATAL );
4677 }
4678
4679 if( ssl->handshake != NULL &&
4680 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4681 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004682 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004683 }
4684 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004685#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004686
Paul Bakker5121ce52009-01-03 21:22:43 +00004687 return( 0 );
4688}
4689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004691{
irwir6c0da642019-09-26 21:07:41 +03004692 return( mbedtls_ssl_send_alert_message( ssl,
4693 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4694 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004695}
4696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004698 unsigned char level,
4699 unsigned char message )
4700{
Janos Follath865b3eb2019-12-16 11:46:15 +00004701 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004702
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004703 if( ssl == NULL || ssl->conf == NULL )
4704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004707 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004710 ssl->out_msglen = 2;
4711 ssl->out_msg[0] = level;
4712 ssl->out_msg[1] = message;
4713
Hanno Becker67bc7c32018-08-06 11:33:50 +01004714 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004715 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004716 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004717 return( ret );
4718 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004720
4721 return( 0 );
4722}
4723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004724int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004725{
Janos Follath865b3eb2019-12-16 11:46:15 +00004726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004731 ssl->out_msglen = 1;
4732 ssl->out_msg[0] = 1;
4733
Paul Bakker5121ce52009-01-03 21:22:43 +00004734 ssl->state++;
4735
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004736 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004737 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004738 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004739 return( ret );
4740 }
4741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004743
4744 return( 0 );
4745}
4746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004748{
Janos Follath865b3eb2019-12-16 11:46:15 +00004749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004752
Hanno Becker327c93b2018-08-15 13:56:18 +01004753 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004754 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004756 return( ret );
4757 }
4758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004762 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4763 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004765 }
4766
Hanno Beckere678eaa2018-08-21 14:57:46 +01004767 /* CCS records are only accepted if they have length 1 and content '1',
4768 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004769
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004770 /*
4771 * Switch to our negotiated transform and session parameters for inbound
4772 * data.
4773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004775 ssl->transform_in = ssl->transform_negotiate;
4776 ssl->session_in = ssl->session_negotiate;
4777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004779 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004782 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004783#endif
4784
4785 /* Increment epoch */
4786 if( ++ssl->in_epoch == 0 )
4787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004789 /* This is highly unlikely to happen for legitimate reasons, so
4790 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004792 }
4793 }
4794 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004796 memset( ssl->in_ctr, 0, 8 );
4797
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004798 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004799
Paul Bakker5121ce52009-01-03 21:22:43 +00004800 ssl->state++;
4801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004803
4804 return( 0 );
4805}
4806
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004807/* Once ssl->out_hdr as the address of the beginning of the
4808 * next outgoing record is set, deduce the other pointers.
4809 *
4810 * Note: For TLS, we save the implicit record sequence number
4811 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4812 * and the caller has to make sure there's space for this.
4813 */
4814
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004815static size_t ssl_transform_get_explicit_iv_len(
4816 mbedtls_ssl_transform const *transform )
4817{
4818 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
4819 return( 0 );
4820
4821 return( transform->ivlen - transform->fixed_ivlen );
4822}
4823
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004824void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4825 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004826{
4827#if defined(MBEDTLS_SSL_PROTO_DTLS)
4828 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4829 {
4830 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004831#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004832 ssl->out_cid = ssl->out_ctr + 8;
4833 ssl->out_len = ssl->out_cid;
4834 if( transform != NULL )
4835 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004836#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004837 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004838#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004839 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004840 }
4841 else
4842#endif
4843 {
4844 ssl->out_ctr = ssl->out_hdr - 8;
4845 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004846#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004847 ssl->out_cid = ssl->out_len;
4848#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004849 ssl->out_iv = ssl->out_hdr + 5;
4850 }
4851
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004852 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004853 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004854 if( transform != NULL )
4855 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004856}
4857
4858/* Once ssl->in_hdr as the address of the beginning of the
4859 * next incoming record is set, deduce the other pointers.
4860 *
4861 * Note: For TLS, we save the implicit record sequence number
4862 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4863 * and the caller has to make sure there's space for this.
4864 */
4865
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004866void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004867{
Hanno Becker79594fd2019-05-08 09:38:41 +01004868 /* This function sets the pointers to match the case
4869 * of unprotected TLS/DTLS records, with both ssl->in_iv
4870 * and ssl->in_msg pointing to the beginning of the record
4871 * content.
4872 *
4873 * When decrypting a protected record, ssl->in_msg
4874 * will be shifted to point to the beginning of the
4875 * record plaintext.
4876 */
4877
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004878#if defined(MBEDTLS_SSL_PROTO_DTLS)
4879 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4880 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004881 /* This sets the header pointers to match records
4882 * without CID. When we receive a record containing
4883 * a CID, the fields are shifted accordingly in
4884 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004885 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004886#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004887 ssl->in_cid = ssl->in_ctr + 8;
4888 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004889#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004890 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004891#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004892 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004893 }
4894 else
4895#endif
4896 {
4897 ssl->in_ctr = ssl->in_hdr - 8;
4898 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004899#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004900 ssl->in_cid = ssl->in_len;
4901#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004902 ssl->in_iv = ssl->in_hdr + 5;
4903 }
4904
Hanno Becker79594fd2019-05-08 09:38:41 +01004905 /* This will be adjusted at record decryption time. */
4906 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004907}
4908
Paul Bakker5121ce52009-01-03 21:22:43 +00004909/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004910 * Setup an SSL context
4911 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004912
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004913void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004914{
4915 /* Set the incoming and outgoing record pointers. */
4916#if defined(MBEDTLS_SSL_PROTO_DTLS)
4917 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4918 {
4919 ssl->out_hdr = ssl->out_buf;
4920 ssl->in_hdr = ssl->in_buf;
4921 }
4922 else
4923#endif /* MBEDTLS_SSL_PROTO_DTLS */
4924 {
4925 ssl->out_hdr = ssl->out_buf + 8;
4926 ssl->in_hdr = ssl->in_buf + 8;
4927 }
4928
4929 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004930 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4931 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004932}
4933
Paul Bakker5121ce52009-01-03 21:22:43 +00004934/*
4935 * SSL get accessors
4936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004938{
4939 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4940}
4941
Hanno Becker8b170a02017-10-10 11:51:19 +01004942int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4943{
4944 /*
4945 * Case A: We're currently holding back
4946 * a message for further processing.
4947 */
4948
4949 if( ssl->keep_current_message == 1 )
4950 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004951 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004952 return( 1 );
4953 }
4954
4955 /*
4956 * Case B: Further records are pending in the current datagram.
4957 */
4958
4959#if defined(MBEDTLS_SSL_PROTO_DTLS)
4960 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4961 ssl->in_left > ssl->next_record_offset )
4962 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004963 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004964 return( 1 );
4965 }
4966#endif /* MBEDTLS_SSL_PROTO_DTLS */
4967
4968 /*
4969 * Case C: A handshake message is being processed.
4970 */
4971
Hanno Becker8b170a02017-10-10 11:51:19 +01004972 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4973 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004974 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004975 return( 1 );
4976 }
4977
4978 /*
4979 * Case D: An application data message is being processed
4980 */
4981 if( ssl->in_offt != NULL )
4982 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004983 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004984 return( 1 );
4985 }
4986
4987 /*
4988 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004989 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004990 * we implement support for multiple alerts in single records.
4991 */
4992
4993 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4994 return( 0 );
4995}
4996
Paul Bakker43ca69c2011-01-15 17:35:19 +00004997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004999{
Hanno Becker3136ede2018-08-17 15:28:19 +01005000 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005001 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005002 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005003
Hanno Becker5903de42019-05-03 14:46:38 +01005004 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5005
Hanno Becker78640902018-08-13 16:35:15 +01005006 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005007 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005009 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005010 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011 case MBEDTLS_MODE_GCM:
5012 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005013 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005015 transform_expansion = transform->minlen;
5016 break;
5017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005019
5020 block_size = mbedtls_cipher_get_block_size(
5021 &transform->cipher_ctx_enc );
5022
Hanno Becker3136ede2018-08-17 15:28:19 +01005023 /* Expansion due to the addition of the MAC. */
5024 transform_expansion += transform->maclen;
5025
5026 /* Expansion due to the addition of CBC padding;
5027 * Theoretically up to 256 bytes, but we never use
5028 * more than the block size of the underlying cipher. */
5029 transform_expansion += block_size;
5030
5031 /* For TLS 1.1 or higher, an explicit IV is added
5032 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005033#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5034 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005035 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005036#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005037
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005038 break;
5039
5040 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005041 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005042 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005043 }
5044
Hanno Beckera0e20d02019-05-15 14:03:01 +01005045#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005046 if( transform->out_cid_len != 0 )
5047 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005048#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005049
Hanno Becker5903de42019-05-03 14:46:38 +01005050 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005051}
5052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005053#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005054/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005055 * Check record counters and renegotiate if they're above the limit.
5056 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005057static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005058{
Hanno Beckerdd772292020-02-05 10:38:31 +00005059 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005060 int in_ctr_cmp;
5061 int out_ctr_cmp;
5062
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005063 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5064 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005065 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005066 {
5067 return( 0 );
5068 }
5069
Andres AG2196c7f2016-12-15 17:01:16 +00005070 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5071 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005072 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005073 ssl->conf->renego_period + ep_len, 8 - ep_len );
5074
5075 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005076 {
5077 return( 0 );
5078 }
5079
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005081 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005082}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005083#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005084
5085/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005086 * Receive application data decrypted from the SSL layer
5087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005089{
Janos Follath865b3eb2019-12-16 11:46:15 +00005090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005091 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005092
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005093 if( ssl == NULL || ssl->conf == NULL )
5094 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005099 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005100 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005102 return( ret );
5103
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005104 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005106 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005107 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005108 return( ret );
5109 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005110 }
5111#endif
5112
Hanno Becker4a810fb2017-05-24 16:27:30 +01005113 /*
5114 * Check if renegotiation is necessary and/or handshake is
5115 * in process. If yes, perform/continue, and fall through
5116 * if an unexpected packet is received while the client
5117 * is waiting for the ServerHello.
5118 *
5119 * (There is no equivalent to the last condition on
5120 * the server-side as it is not treated as within
5121 * a handshake while waiting for the ClientHello
5122 * after a renegotiation request.)
5123 */
5124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005125#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005126 ret = ssl_check_ctr_renegotiate( ssl );
5127 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5128 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005129 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005130 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005131 return( ret );
5132 }
5133#endif
5134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005135 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005138 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5139 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005140 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005141 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005142 return( ret );
5143 }
5144 }
5145
Hanno Beckere41158b2017-10-23 13:30:32 +01005146 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005147 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005148 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005149 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005150 if( ssl->f_get_timer != NULL &&
5151 ssl->f_get_timer( ssl->p_timer ) == -1 )
5152 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005153 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005154 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005155
Hanno Becker327c93b2018-08-15 13:56:18 +01005156 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005157 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005158 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5159 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005160
Hanno Becker4a810fb2017-05-24 16:27:30 +01005161 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5162 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005163 }
5164
5165 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005167 {
5168 /*
5169 * OpenSSL sends empty messages to randomize the IV
5170 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005171 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005172 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005173 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005174 return( 0 );
5175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005176 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005177 return( ret );
5178 }
5179 }
5180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005183 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005184
Hanno Becker4a810fb2017-05-24 16:27:30 +01005185 /*
5186 * - For client-side, expect SERVER_HELLO_REQUEST.
5187 * - For server-side, expect CLIENT_HELLO.
5188 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5189 */
5190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005192 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005194 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005195 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005197
5198 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005200 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005201 {
5202 continue;
5203 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005204#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005206 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005207#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005208
Hanno Becker4a810fb2017-05-24 16:27:30 +01005209#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005210 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005211 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005212 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005213 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005214
5215 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005216#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005217 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005218 {
5219 continue;
5220 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005221#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005222 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005223 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005224#endif /* MBEDTLS_SSL_SRV_C */
5225
Hanno Becker21df7f92017-10-17 11:03:26 +01005226#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005227 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005228 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5229 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5230 ssl->conf->allow_legacy_renegotiation ==
5231 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5232 {
5233 /*
5234 * Accept renegotiation request
5235 */
Paul Bakker48916f92012-09-16 19:57:18 +00005236
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005237 /* DTLS clients need to know renego is server-initiated */
5238#if defined(MBEDTLS_SSL_PROTO_DTLS)
5239 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5240 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5241 {
5242 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5243 }
5244#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005245 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005246 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5247 ret != 0 )
5248 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5250 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005251 return( ret );
5252 }
5253 }
5254 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005255#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005256 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005257 /*
5258 * Refuse renegotiation
5259 */
5260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5264 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5265 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5268 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5269 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005270 {
5271 return( ret );
5272 }
Paul Bakker48916f92012-09-16 19:57:18 +00005273 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005274 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5276 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005277 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5279 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005280 }
Paul Bakker48916f92012-09-16 19:57:18 +00005281 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005282
Hanno Becker90333da2017-10-10 11:27:13 +01005283 /* At this point, we don't know whether the renegotiation has been
5284 * completed or not. The cases to consider are the following:
5285 * 1) The renegotiation is complete. In this case, no new record
5286 * has been read yet.
5287 * 2) The renegotiation is incomplete because the client received
5288 * an application data record while awaiting the ServerHello.
5289 * 3) The renegotiation is incomplete because the client received
5290 * a non-handshake, non-application data message while awaiting
5291 * the ServerHello.
5292 * In each of these case, looping will be the proper action:
5293 * - For 1), the next iteration will read a new record and check
5294 * if it's application data.
5295 * - For 2), the loop condition isn't satisfied as application data
5296 * is present, hence continue is the same as break
5297 * - For 3), the loop condition is satisfied and read_record
5298 * will re-deliver the message that was held back by the client
5299 * when expecting the ServerHello.
5300 */
5301 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005302 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005303#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005304 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005305 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005306 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005307 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005308 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005309 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005311 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005312 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005313 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005314 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005315 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005316#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5319 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005320 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005322 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005323 }
5324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005325 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005326 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005327 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5328 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005329 }
5330
5331 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005332
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005333 /* We're going to return something now, cancel timer,
5334 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005336 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005337
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005338#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005339 /* If we requested renego but received AppData, resend HelloRequest.
5340 * Do it now, after setting in_offt, to avoid taking this branch
5341 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005343 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005345 {
Hanno Becker786300f2020-02-05 10:46:40 +00005346 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005347 {
Hanno Becker786300f2020-02-05 10:46:40 +00005348 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5349 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005350 return( ret );
5351 }
5352 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005354#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005355 }
5356
5357 n = ( len < ssl->in_msglen )
5358 ? len : ssl->in_msglen;
5359
5360 memcpy( buf, ssl->in_offt, n );
5361 ssl->in_msglen -= n;
5362
gabor-mezei-arma3214132020-07-15 10:55:00 +02005363 /* Zeroising the plaintext buffer to erase unused application data
5364 from the memory. */
5365 mbedtls_platform_zeroize( ssl->in_offt, n );
5366
Paul Bakker5121ce52009-01-03 21:22:43 +00005367 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005368 {
5369 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005370 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005371 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005372 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005373 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005374 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005375 /* more data available */
5376 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005377 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005380
Paul Bakker23986e52011-04-24 08:57:21 +00005381 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005382}
5383
5384/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005385 * Send application data to be encrypted by the SSL layer, taking care of max
5386 * fragment length and buffer size.
5387 *
5388 * According to RFC 5246 Section 6.2.1:
5389 *
5390 * Zero-length fragments of Application data MAY be sent as they are
5391 * potentially useful as a traffic analysis countermeasure.
5392 *
5393 * Therefore, it is possible that the input message length is 0 and the
5394 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005395 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005396static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005397 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005398{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005399 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5400 const size_t max_len = (size_t) ret;
5401
5402 if( ret < 0 )
5403 {
5404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5405 return( ret );
5406 }
5407
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005408 if( len > max_len )
5409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005411 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005414 "maximum fragment length: %d > %d",
5415 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005417 }
5418 else
5419#endif
5420 len = max_len;
5421 }
Paul Bakker887bd502011-06-08 13:10:54 +00005422
Paul Bakker5121ce52009-01-03 21:22:43 +00005423 if( ssl->out_left != 0 )
5424 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005425 /*
5426 * The user has previously tried to send the data and
5427 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5428 * written. In this case, we expect the high-level write function
5429 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005432 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005434 return( ret );
5435 }
5436 }
Paul Bakker887bd502011-06-08 13:10:54 +00005437 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005438 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005439 /*
5440 * The user is trying to send a message the first time, so we need to
5441 * copy the data into the internal buffers and setup the data structure
5442 * to keep track of partial writes
5443 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005444 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005446 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005447
Hanno Becker67bc7c32018-08-06 11:33:50 +01005448 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005449 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005451 return( ret );
5452 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005453 }
5454
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005455 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005456}
5457
5458/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005459 * Write application data, doing 1/n-1 splitting if necessary.
5460 *
5461 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005462 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005463 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005466static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005467 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005468{
Janos Follath865b3eb2019-12-16 11:46:15 +00005469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005470
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005471 if( ssl->conf->cbc_record_splitting ==
5472 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005473 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5475 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5476 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005477 {
5478 return( ssl_write_real( ssl, buf, len ) );
5479 }
5480
5481 if( ssl->split_done == 0 )
5482 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005483 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005484 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005485 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005486 }
5487
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005488 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5489 return( ret );
5490 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005491
5492 return( ret + 1 );
5493}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005495
5496/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005497 * Write application data (public-facing wrapper)
5498 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005499int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005500{
Janos Follath865b3eb2019-12-16 11:46:15 +00005501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005502
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005504
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005505 if( ssl == NULL || ssl->conf == NULL )
5506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5507
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005508#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005509 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5510 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005511 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005512 return( ret );
5513 }
5514#endif
5515
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005516 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005517 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005518 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005519 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005520 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005521 return( ret );
5522 }
5523 }
5524
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005525#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005526 ret = ssl_write_split( ssl, buf, len );
5527#else
5528 ret = ssl_write_real( ssl, buf, len );
5529#endif
5530
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005532
5533 return( ret );
5534}
5535
5536/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005537 * Notify the peer that the connection is being closed
5538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005539int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005540{
Janos Follath865b3eb2019-12-16 11:46:15 +00005541 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005542
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005543 if( ssl == NULL || ssl->conf == NULL )
5544 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005547
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005548 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005551 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005552 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005553 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5554 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5555 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005556 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005558 return( ret );
5559 }
5560 }
5561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005562 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005563
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005564 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005565}
5566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005567void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005568{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005569 if( transform == NULL )
5570 return;
5571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5573 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005574
Hanno Beckerd56ed242018-01-03 15:32:51 +00005575#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 mbedtls_md_free( &transform->md_ctx_enc );
5577 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005578#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005579
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005580 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005581}
5582
Hanno Becker0271f962018-08-16 13:23:47 +01005583#if defined(MBEDTLS_SSL_PROTO_DTLS)
5584
Hanno Becker533ab5f2020-02-05 10:49:13 +00005585void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005586{
5587 unsigned offset;
5588 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5589
5590 if( hs == NULL )
5591 return;
5592
Hanno Becker283f5ef2018-08-24 09:34:47 +01005593 ssl_free_buffered_record( ssl );
5594
Hanno Becker0271f962018-08-16 13:23:47 +01005595 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005596 ssl_buffering_free_slot( ssl, offset );
5597}
5598
5599static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5600 uint8_t slot )
5601{
5602 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5603 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005604
5605 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5606 return;
5607
Hanno Beckere605b192018-08-21 15:59:07 +01005608 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005609 {
Hanno Beckere605b192018-08-21 15:59:07 +01005610 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005611 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005612 mbedtls_free( hs_buf->data );
5613 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005614 }
5615}
5616
5617#endif /* MBEDTLS_SSL_PROTO_DTLS */
5618
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005619/*
5620 * Convert version numbers to/from wire format
5621 * and, for DTLS, to/from TLS equivalent.
5622 *
5623 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005624 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005625 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5626 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005628void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005629 unsigned char ver[2] )
5630{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005631#if defined(MBEDTLS_SSL_PROTO_DTLS)
5632 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005633 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005634 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005635 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5636
5637 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5638 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5639 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005640 else
5641#else
5642 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005643#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005644 {
5645 ver[0] = (unsigned char) major;
5646 ver[1] = (unsigned char) minor;
5647 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005648}
5649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005650void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005651 const unsigned char ver[2] )
5652{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005653#if defined(MBEDTLS_SSL_PROTO_DTLS)
5654 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005655 {
5656 *major = 255 - ver[0] + 2;
5657 *minor = 255 - ver[1] + 1;
5658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005659 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005660 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5661 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005662 else
5663#else
5664 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005665#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005666 {
5667 *major = ver[0];
5668 *minor = ver[1];
5669 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005670}
5671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672#endif /* MBEDTLS_SSL_TLS_C */