blob: c312d816ea1494b75595f6836b34cae228c0e443 [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#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010030
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000031#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000032#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000033#include "mbedtls/debug.h"
34#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050035#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010036#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020037#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020038#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020043#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050044#include "psa/crypto.h"
45#endif
46
Janos Follath23bdca02016-10-07 14:47:14 +010047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020049#endif
50
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040052/* Define a local translating function to save code size by not using too many
53 * arguments in each translating place. */
54static int local_err_translation(psa_status_t status)
55{
56 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040057 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040058 psa_generic_status_to_mbedtls);
59}
60#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050061#endif
62
Dave Rodgman2801f7f2023-05-09 11:00:07 +010063#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
64
65#if defined(MBEDTLS_USE_PSA_CRYPTO)
66
67#if defined(PSA_WANT_ALG_SHA_384)
68#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
69#elif defined(PSA_WANT_ALG_SHA_256)
70#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
71#else /* See check_config.h */
72#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
73#endif
74
75MBEDTLS_STATIC_TESTABLE
76int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
77 psa_algorithm_t mac_alg,
78 const unsigned char *add_data,
79 size_t add_data_len,
80 const unsigned char *data,
81 size_t data_len_secret,
82 size_t min_data_len,
83 size_t max_data_len,
84 unsigned char *output)
85{
86 /*
87 * This function breaks the HMAC abstraction and uses psa_hash_clone()
88 * extension in order to get constant-flow behaviour.
89 *
90 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
91 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
92 * patterns (see RFC 2104, sec. 2).
93 *
94 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
95 * hashing up to minlen, then cloning the context, and for each byte up
96 * to maxlen finishing up the hash computation, keeping only the
97 * correct result.
98 *
99 * Then we only need to compute HASH(okey + inner_hash) and we're done.
100 */
101 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
102 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
103 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
104 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
105 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
106 size_t hash_length;
107
108 unsigned char aux_out[PSA_HASH_MAX_SIZE];
109 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
110 size_t offset;
111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
112
113 size_t mac_key_length;
114 size_t i;
115
116#define PSA_CHK(func_call) \
117 do { \
118 status = (func_call); \
119 if (status != PSA_SUCCESS) \
120 goto cleanup; \
121 } while (0)
122
123 /* Export MAC key
124 * We assume key length is always exactly the output size
125 * which is never more than the block size, thus we use block_size
126 * as the key buffer size.
127 */
128 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
129
130 /* Calculate ikey */
131 for (i = 0; i < mac_key_length; i++) {
132 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
133 }
134 for (; i < block_size; ++i) {
135 key_buf[i] = 0x36;
136 }
137
138 PSA_CHK(psa_hash_setup(&operation, hash_alg));
139
140 /* Now compute inner_hash = HASH(ikey + msg) */
141 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
142 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
143 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
144
145 /* Fill the hash buffer in advance with something that is
146 * not a valid hash (barring an attack on the hash and
147 * deliberately-crafted input), in case the caller doesn't
148 * check the return status properly. */
149 memset(output, '!', hash_size);
150
151 /* For each possible length, compute the hash up to that point */
152 for (offset = min_data_len; offset <= max_data_len; offset++) {
153 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
154 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
155 PSA_HASH_MAX_SIZE, &hash_length));
156 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100157 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100158 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100159
160 if (offset < max_data_len) {
161 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
162 }
163 }
164
165 /* Abort current operation to prepare for final operation */
166 PSA_CHK(psa_hash_abort(&operation));
167
168 /* Calculate okey */
169 for (i = 0; i < mac_key_length; i++) {
170 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
171 }
172 for (; i < block_size; ++i) {
173 key_buf[i] = 0x5C;
174 }
175
176 /* Now compute HASH(okey + inner_hash) */
177 PSA_CHK(psa_hash_setup(&operation, hash_alg));
178 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
179 PSA_CHK(psa_hash_update(&operation, output, hash_size));
180 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
181
182#undef PSA_CHK
183
184cleanup:
185 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
186 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
187
188 psa_hash_abort(&operation);
189 psa_hash_abort(&aux_operation);
190 return PSA_TO_MBEDTLS_ERR(status);
191}
192
193#undef MAX_HASH_BLOCK_LENGTH
194
195#else
196MBEDTLS_STATIC_TESTABLE
197int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
198 const unsigned char *add_data,
199 size_t add_data_len,
200 const unsigned char *data,
201 size_t data_len_secret,
202 size_t min_data_len,
203 size_t max_data_len,
204 unsigned char *output)
205{
206 /*
207 * This function breaks the HMAC abstraction and uses the md_clone()
208 * extension to the MD API in order to get constant-flow behaviour.
209 *
210 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
211 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
212 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
213 *
214 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
215 * minlen, then cloning the context, and for each byte up to maxlen
216 * finishing up the hash computation, keeping only the correct result.
217 *
218 * Then we only need to compute HASH(okey + inner_hash) and we're done.
219 */
220 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
221 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
222 * all of which have the same block size except SHA-384. */
223 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
224 const unsigned char * const ikey = ctx->hmac_ctx;
225 const unsigned char * const okey = ikey + block_size;
226 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
227
228 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
229 mbedtls_md_context_t aux;
230 size_t offset;
231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
232
233 mbedtls_md_init(&aux);
234
235#define MD_CHK(func_call) \
236 do { \
237 ret = (func_call); \
238 if (ret != 0) \
239 goto cleanup; \
240 } while (0)
241
242 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
243
244 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
245 * so we can start directly with the message */
246 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
247 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
248
249 /* Fill the hash buffer in advance with something that is
250 * not a valid hash (barring an attack on the hash and
251 * deliberately-crafted input), in case the caller doesn't
252 * check the return status properly. */
253 memset(output, '!', hash_size);
254
255 /* For each possible length, compute the hash up to that point */
256 for (offset = min_data_len; offset <= max_data_len; offset++) {
257 MD_CHK(mbedtls_md_clone(&aux, ctx));
258 MD_CHK(mbedtls_md_finish(&aux, aux_out));
259 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100260 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100261 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100262
263 if (offset < max_data_len) {
264 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
265 }
266 }
267
268 /* The context needs to finish() before it starts() again */
269 MD_CHK(mbedtls_md_finish(ctx, aux_out));
270
271 /* Now compute HASH(okey + inner_hash) */
272 MD_CHK(mbedtls_md_starts(ctx));
273 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
274 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
275 MD_CHK(mbedtls_md_finish(ctx, output));
276
277 /* Done, get ready for next time */
278 MD_CHK(mbedtls_md_hmac_reset(ctx));
279
280#undef MD_CHK
281
282cleanup:
283 mbedtls_md_free(&aux);
284 return ret;
285}
286
287#endif /* MBEDTLS_USE_PSA_CRYPTO */
288
289#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100292
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293/*
294 * Start a timer.
295 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200296 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100297void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200298{
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200300 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
304 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200305}
306
307/*
308 * Return -1 is timer is expired, 0 if it isn't.
309 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100310int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311{
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->f_get_timer == NULL) {
313 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200314 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 if (ssl->f_get_timer(ssl->p_timer) == 2) {
317 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
318 return -1;
319 }
320
321 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200322}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200323
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100325static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
326 unsigned char *buf,
327 size_t len,
328 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
331 unsigned char *buf,
332 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200333{
334 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
336 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200337
338 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200339 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200342 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
343 goto exit;
344 }
345#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 mbedtls_record rec;
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
350 if (ret != 0) {
351 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200352 goto exit;
353 }
354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (ssl->transform_in != NULL) {
356 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
357 if (ret != 0) {
358 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200359 goto exit;
360 }
361 }
362 }
363#endif /* MBEDTLS_SSL_PROTO_DTLS */
364
365exit:
366 /* On success, we have decrypted the buffer in-place, so make
367 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200369
370 /* For the purpose of this API, treat messages with unexpected CID
371 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
373 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200374 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
375 }
376
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
378 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200379}
380
Hanno Becker67bc7c32018-08-06 11:33:50 +0100381#define SSL_DONT_FORCE_FLUSH 0
382#define SSL_FORCE_FLUSH 1
383
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200384#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100385
Hanno Beckerd5847772018-08-28 10:09:23 +0100386/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
388 uint8_t slot);
389static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200390MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100393static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100395static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100397static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
398 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100401
Gilles Peskine449bd832023-01-11 14:50:10 +0100402static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100403{
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000405#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
406 size_t out_buf_len = ssl->out_buf_len;
407#else
408 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
409#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 if (mtu != 0 && mtu < out_buf_len) {
412 return mtu;
413 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100414
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100416}
417
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100419static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420{
Hanno Becker11682cc2018-08-22 14:41:02 +0100421 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100423
424 /* Double-check that the write-index hasn't gone
425 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100427 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100429 }
430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100432}
433
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200434MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100435static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100436{
Janos Follath865b3eb2019-12-16 11:46:15 +0000437 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100438 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400439 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100440
441#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100443
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100445 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100447
448 /* By the standard (RFC 6066 Sect. 4), the MFL extension
449 * only limits the maximum record payload size, so in theory
450 * we would be allowed to pack multiple records of payload size
451 * MFL into a single datagram. However, this would mean that there's
452 * no way to explicitly communicate MTU restrictions to the peer.
453 *
454 * The following reduction of max_len makes sure that we never
455 * write datagrams larger than MFL + Record Expansion Overhead.
456 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 if (max_len <= ssl->out_left) {
458 return 0;
459 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100460
461 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462#endif
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 ret = ssl_get_remaining_space_in_datagram(ssl);
465 if (ret < 0) {
466 return ret;
467 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100468 remaining = (size_t) ret;
469
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 ret = mbedtls_ssl_get_record_expansion(ssl);
471 if (ret < 0) {
472 return ret;
473 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474 expansion = (size_t) ret;
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (remaining <= expansion) {
477 return 0;
478 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100479
480 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100482 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100486}
487
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488/*
489 * Double the retransmit timeout value, within the allowed range,
490 * returning -1 if the maximum value has already been reached.
491 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100493static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200494{
495 uint32_t new_timeout;
496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
498 return -1;
499 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200501 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
502 * in the following way: after the initial transmission and a first
503 * retransmission, back off to a temporary estimated MTU of 508 bytes.
504 * This value is guaranteed to be deliverable (if not guaranteed to be
505 * delivered) of any compliant IPv4 (and IPv6) network, and should work
506 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200508 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400510 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200511
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200512 new_timeout = 2 * ssl->handshake->retransmit_timeout;
513
514 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 if (new_timeout < ssl->handshake->retransmit_timeout ||
516 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200518 }
519
520 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
522 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200525}
526
Gilles Peskine449bd832023-01-11 14:50:10 +0100527static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200528{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200529 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
531 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200532}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200534
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100535/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000536 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200537 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000538
Ronald Cron6f135e12021-12-08 16:57:54 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541static size_t ssl_compute_padding_length(size_t len,
542 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100543{
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100545}
546
Hanno Becker581bc1b2020-05-04 12:20:03 +0100547/* This functions transforms a (D)TLS plaintext fragment and a record content
548 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
549 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
550 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100551 *
552 * struct {
553 * opaque content[DTLSPlaintext.length];
554 * ContentType real_type;
555 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100556 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Input:
559 * - `content`: The beginning of the buffer holding the
560 * plaintext to be wrapped.
561 * - `*content_size`: The length of the plaintext in Bytes.
562 * - `max_len`: The number of Bytes available starting from
563 * `content`. This must be `>= *content_size`.
564 * - `rec_type`: The desired record content type.
565 *
566 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100567 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
568 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 *
570 * Returns:
571 * - `0` on success.
572 * - A negative error code if `max_len` didn't offer enough space
573 * for the expansion.
574 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200575MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100576static int ssl_build_inner_plaintext(unsigned char *content,
577 size_t *content_size,
578 size_t remaining,
579 uint8_t rec_type,
580 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100581{
582 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100583
584 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (remaining == 0) {
586 return -1;
587 }
588 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589 len++;
590 remaining--;
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (remaining < pad) {
593 return -1;
594 }
595 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100596 len += pad;
597 remaining -= pad;
598
599 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100601}
602
Hanno Becker581bc1b2020-05-04 12:20:03 +0100603/* This function parses a (D)TLSInnerPlaintext structure.
604 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200605MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100606static int ssl_parse_inner_plaintext(unsigned char const *content,
607 size_t *content_size,
608 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100609{
610 size_t remaining = *content_size;
611
612 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 do {
614 if (remaining == 0) {
615 return -1;
616 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100617 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100619
620 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624}
Ronald Cron6f135e12021-12-08 16:57:54 +0100625#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100626
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200627/* The size of the `add_data` structure depends on various
628 * factors, namely
629 *
630 * 1) CID functionality disabled
631 *
632 * additional_data =
633 * 8: seq_num +
634 * 1: type +
635 * 2: version +
636 * 2: length of inner plaintext +
637 *
638 * size = 13 bytes
639 *
640 * 2) CID functionality based on RFC 9146 enabled
641 *
642 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
643 * = 23 + CID-length
644 *
645 * 3) CID functionality based on legacy CID version
646 according to draft-ietf-tls-dtls-connection-id-05
647 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
648 *
649 * size = 13 + 1 + CID-length
650 *
651 * More information about the CID usage:
652 *
653 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
654 * size of the additional data structure is calculated as:
655 *
656 * additional_data =
657 * 8: seq_num +
658 * 1: tls12_cid +
659 * 2: DTLSCipherText.version +
660 * n: cid +
661 * 1: cid_length +
662 * 2: length_of_DTLSInnerPlaintext
663 *
664 * Per RFC 9146 the size of the add_data structure is calculated as:
665 *
666 * additional_data =
667 * 8: seq_num_placeholder +
668 * 1: tls12_cid +
669 * 1: cid_length +
670 * 1: tls12_cid +
671 * 2: DTLSCiphertext.version +
672 * 2: epoch +
673 * 6: sequence_number +
674 * n: cid +
675 * 2: length_of_DTLSInnerPlaintext
676 *
677 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static void ssl_extract_add_data_from_record(unsigned char *add_data,
679 size_t *add_data_len,
680 mbedtls_record *rec,
681 mbedtls_ssl_protocol_version
682 tls_version,
683 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000684{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200685 /* Several types of ciphers have been defined for use with TLS and DTLS,
686 * and the MAC calculations for those ciphers differ slightly. Further
687 * variants were added when the CID functionality was added with RFC 9146.
688 * This implementations also considers the use of a legacy version of the
689 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
690 * which is used in deployments.
691 *
692 * We will distinguish between the non-CID and the CID cases below.
693 *
694 * --- Non-CID cases ---
695 *
696 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100697 *
698 * additional_data = seq_num + TLSCompressed.type +
699 * TLSCompressed.version + TLSCompressed.length;
700 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100701 * For TLS 1.3, the record sequence number is dropped from the AAD
702 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000703 * Moreover, the additional data involves the length of the TLS
704 * ciphertext, not the TLS plaintext as in earlier versions.
705 * Quoting RFC 8446 (TLS 1.3):
706 *
707 * additional_data = TLSCiphertext.opaque_type ||
708 * TLSCiphertext.legacy_record_version ||
709 * TLSCiphertext.length
710 *
711 * We pass the tag length to this function in order to compute the
712 * ciphertext length from the inner plaintext length rec->data_len via
713 *
714 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
715 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200716 * --- CID cases ---
717 *
718 * RFC 9146 uses a common pattern when constructing the data
719 * passed into a MAC / AEAD cipher.
720 *
721 * Data concatenation for MACs used with block ciphers with
722 * Encrypt-then-MAC Processing (with CID):
723 *
724 * data = seq_num_placeholder +
725 * tls12_cid +
726 * cid_length +
727 * tls12_cid +
728 * DTLSCiphertext.version +
729 * epoch +
730 * sequence_number +
731 * cid +
732 * DTLSCiphertext.length +
733 * IV +
734 * ENC(content + padding + padding_length)
735 *
736 * Data concatenation for MACs used with block ciphers (with CID):
737 *
738 * data = seq_num_placeholder +
739 * tls12_cid +
740 * cid_length +
741 * tls12_cid +
742 * DTLSCiphertext.version +
743 * epoch +
744 * sequence_number +
745 * cid +
746 * length_of_DTLSInnerPlaintext +
747 * DTLSInnerPlaintext.content +
748 * DTLSInnerPlaintext.real_type +
749 * DTLSInnerPlaintext.zeros
750 *
751 * AEAD ciphers use the following additional data calculation (with CIDs):
752 *
753 * additional_data = seq_num_placeholder +
754 * tls12_cid +
755 * cid_length +
756 * tls12_cid +
757 * DTLSCiphertext.version +
758 * epoch +
759 * sequence_number +
760 * cid +
761 * length_of_DTLSInnerPlaintext
762 *
763 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
764 * defines the additional data calculation as follows:
765 *
766 * additional_data = seq_num +
767 * tls12_cid +
768 * DTLSCipherText.version +
769 * cid +
770 * cid_length +
771 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100773
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100774 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000775 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100776
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200777#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
778 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
779 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
780#endif
781
Ronald Cron6f135e12021-12-08 16:57:54 +0100782#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000784 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
785 * which differs from the length of the TLSInnerPlaintext
786 * by the length of the authentication tag. */
787 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100790 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400791 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000792 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200793
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100794#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
796 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200797 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
799 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200800
801 // tls12_cid type
802 *cur = rec->type;
803 cur++;
804
805 // cid_length
806 *cur = rec->cid_len;
807 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100809#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200810 {
811 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 memcpy(cur, rec->ctr, sizeof(rec->ctr));
813 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200814 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100815 }
816
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100818 *cur = rec->type;
819 cur++;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 memcpy(cur, rec->ver, sizeof(rec->ver));
823 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
826 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829 // CID
830 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 cur += rec->cid_len;
832
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100834 *cur = rec->cid_len;
835 cur++;
836
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200837 // length of inner plaintext
838 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
839 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200841#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
842 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200845 // epoch + sequence number
846 memcpy(cur, rec->ctr, sizeof(rec->ctr));
847 cur += sizeof(rec->ctr);
848
849 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200851 cur += rec->cid_len;
852
853 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100855 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100858 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100860 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100861 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100862
863 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864}
865
Hanno Becker67a37db2020-05-28 16:27:07 +0100866#if defined(MBEDTLS_GCM_C) || \
867 defined(MBEDTLS_CCM_C) || \
868 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200869MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100870static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872{
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100874}
875
Hanno Becker17263802020-05-28 07:05:48 +0100876/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
877 *
878 * Concretely, this occurs in two variants:
879 *
880 * a) Fixed and dynamic IV lengths add up to total IV length, giving
881 * IV = fixed_iv || dynamic_iv
882 *
Hanno Becker15952812020-06-04 13:31:46 +0100883 * This variant is used in TLS 1.2 when used with GCM or CCM.
884 *
Hanno Becker17263802020-05-28 07:05:48 +0100885 * b) Fixed IV lengths matches total IV length, giving
886 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100887 *
888 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
889 *
890 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100891 *
892 * This function has the precondition that
893 *
894 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
895 *
896 * which has to be ensured by the caller. If this precondition
897 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100898 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100899static void ssl_build_record_nonce(unsigned char *dst_iv,
900 size_t dst_iv_len,
901 unsigned char const *fixed_iv,
902 size_t fixed_iv_len,
903 unsigned char const *dynamic_iv,
904 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100905{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100906 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(dst_iv, 0, dst_iv_len);
908 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100909
Hanno Becker17263802020-05-28 07:05:48 +0100910 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100912}
Hanno Becker67a37db2020-05-28 16:27:07 +0100913#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100914
Gilles Peskine449bd832023-01-11 14:50:10 +0100915int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
916 mbedtls_ssl_transform *transform,
917 mbedtls_record *rec,
918 int (*f_rng)(void *, unsigned char *, size_t),
919 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000920{
Neil Armstrong136f8402022-03-30 10:58:01 +0200921 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100922 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200924 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 * the description of ssl_extract_add_data_from_record().
926 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200927#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
928 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
929#else
930 unsigned char add_data[13];
931#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100932 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 size_t post_avail;
934
935 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000936#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200937 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 ((void) ssl);
939#endif
940
941 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200942 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100943#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
944 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 ((void) f_rng);
946 ((void) p_rng);
947#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000950
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 if (transform == NULL) {
952 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
953 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000954 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100956 || rec->buf == NULL
957 || rec->buf_len < rec->data_offset
958 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100959#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100960 || rec->cid_len != 0
961#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 ) {
963 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
964 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100965 }
966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200968
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
971 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
972 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
975 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
976 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
977 rec->data_len,
978 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100981
Hanno Becker92313402020-05-20 13:58:58 +0100982 /* The following two code paths implement the (D)TLSInnerPlaintext
983 * structure present in TLS 1.3 and DTLS 1.2 + CID.
984 *
985 * See ssl_build_inner_plaintext() for more information.
986 *
987 * Note that this changes `rec->data_len`, and hence
988 * `post_avail` needs to be recalculated afterwards.
989 *
990 * Note also that the two code paths cannot occur simultaneously
991 * since they apply to different versions of the protocol. There
992 * is hence no risk of double-addition of the inner plaintext.
993 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100994#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100996 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 ssl_compute_padding_length(rec->data_len,
998 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
999 if (ssl_build_inner_plaintext(data,
1000 &rec->data_len,
1001 post_avail,
1002 rec->type,
1003 padding) != 0) {
1004 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +01001005 }
1006
1007 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
1008 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001009#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001010
Hanno Beckera0e20d02019-05-15 14:03:01 +01001011#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001012 /*
1013 * Add CID information
1014 */
1015 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1017 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001020 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 ssl_compute_padding_length(rec->data_len,
1022 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001023 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001024 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001025 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001026 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001027 * Note that this changes `rec->data_len`, and hence
1028 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 if (ssl_build_inner_plaintext(data,
1031 &rec->data_len,
1032 post_avail,
1033 rec->type,
1034 padding) != 0) {
1035 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001036 }
1037
1038 rec->type = MBEDTLS_SSL_MSG_CID;
1039 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001040#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001043
Paul Bakker5121ce52009-01-03 21:22:43 +00001044 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001045 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001046 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1049 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1050 if (post_avail < transform->maclen) {
1051 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1052 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001053 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001055 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001057#if defined(MBEDTLS_USE_PSA_CRYPTO)
1058 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1060 size_t sign_mac_length = 0;
1061#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001062
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1064 transform->tls_version,
1065 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001066
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1069 transform->psa_mac_alg);
1070 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001071 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 status = psa_mac_update(&operation, add_data, add_data_len);
1075 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001076 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 status = psa_mac_update(&operation, data, rec->data_len);
1080 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001081 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1085 &sign_mac_length);
1086 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001089#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1091 add_data_len);
1092 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001093 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
1095 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1096 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001097 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 }
1099 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1100 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001101 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 }
1103 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1104 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001105 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001110#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1113 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001114
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001115 rec->data_len += transform->maclen;
1116 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001117 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119hmac_failed_etm_disabled:
1120 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001122 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 status = psa_mac_abort(&operation);
1124 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001125 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001127#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (ret != 0) {
1129 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1130 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001131 }
Paul Bakker577e0062013-08-28 11:57:20 +02001132 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001135 /*
1136 * Encrypt
1137 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001138#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1140 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1141 "including %d bytes of padding",
1142 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001143
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001144 /* The only supported stream cipher is "NULL",
1145 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001147#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001148
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001149#if defined(MBEDTLS_GCM_C) || \
1150 defined(MBEDTLS_CCM_C) || \
1151 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001153 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001154 unsigned char *dynamic_iv;
1155 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001156 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001158#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001160#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001162
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001163 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (post_avail < transform->taglen) {
1165 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1166 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001167 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001168
Paul Bakker68884e32013-01-07 18:20:04 +01001169 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001170 * Build nonce for AEAD encryption.
1171 *
1172 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1173 * part of the IV is prepended to the ciphertext and
1174 * can be chosen freely - in particular, it need not
1175 * agree with the record sequence number.
1176 * However, since ChaChaPoly as well as all AEAD modes
1177 * in TLS 1.3 use the record sequence number as the
1178 * dynamic part of the nonce, we uniformly use the
1179 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001180 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001181 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 ssl_build_record_nonce(iv, sizeof(iv),
1185 transform->iv_enc,
1186 transform->fixed_ivlen,
1187 dynamic_iv,
1188 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001189
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001190 /*
1191 * Build additional data for AEAD encryption.
1192 * This depends on the TLS version.
1193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1195 transform->tls_version,
1196 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1199 iv, transform->ivlen);
1200 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1201 dynamic_iv,
1202 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1203 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1204 add_data, add_data_len);
1205 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1206 "including 0 bytes of padding",
1207 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001208
Paul Bakker68884e32013-01-07 18:20:04 +01001209 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001210 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001211 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001212#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 status = psa_aead_encrypt(transform->psa_key_enc,
1214 transform->psa_alg,
1215 iv, transform->ivlen,
1216 add_data, add_data_len,
1217 data, rec->data_len,
1218 data, rec->buf_len - (data - rec->buf),
1219 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1224 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001225 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1228 iv, transform->ivlen,
1229 add_data, add_data_len,
1230 data, rec->data_len, /* src */
1231 data, rec->buf_len - (data - rec->buf), /* dst */
1232 &rec->data_len,
1233 transform->taglen)) != 0) {
1234 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1235 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001236 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001237#endif /* MBEDTLS_USE_PSA_CRYPTO */
1238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1240 data + rec->data_len - transform->taglen,
1241 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001242 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001243 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001244
1245 /*
1246 * Prefix record content with dynamic IV in case it is explicit.
1247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (dynamic_iv_is_explicit != 0) {
1249 if (rec->data_offset < dynamic_iv_len) {
1250 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1251 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001252 }
1253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001255 rec->data_offset -= dynamic_iv_len;
1256 rec->data_len += dynamic_iv_len;
1257 }
1258
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001259 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 } else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001261#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001262#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1264 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001265 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001266 size_t padlen, i;
1267 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001268#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001270 size_t part_len;
1271 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001273
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001274 /* Currently we're always using minimal padding
1275 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1277 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001279 }
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 /* Check there's enough space in the buffer for the padding. */
1282 if (post_avail < padlen + 1) {
1283 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1284 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1285 }
1286
1287 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001288 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001291 rec->data_len += padlen + 1;
1292 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001293
TRodziewicz0f82ec62021-05-12 17:49:18 +02001294#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001295 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001296 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001297 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (f_rng == NULL) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1301 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001302 }
TRodziewicz345165c2021-07-06 13:42:11 +02001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (rec->data_offset < transform->ivlen) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1306 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001307 }
1308
1309 /*
1310 * Generate IV
1311 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1313 if (ret != 0) {
1314 return ret;
1315 }
TRodziewicz345165c2021-07-06 13:42:11 +02001316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001318#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1321 "including %"
1322 MBEDTLS_PRINTF_SIZET
1323 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1324 rec->data_len, transform->ivlen,
1325 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001327#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 status = psa_cipher_encrypt_setup(&cipher_op,
1329 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001332 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1334 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001335 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001336
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001340 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1342 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001343
1344 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_cipher_update(&cipher_op,
1347 data, rec->data_len,
1348 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001351 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1353 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001354
1355 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 status = psa_cipher_finish(&cipher_op,
1358 data + olen, rec->data_len - olen,
1359 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001362 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1364 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001365
1366 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001367
1368 olen += part_len;
1369#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1371 transform->iv_enc,
1372 transform->ivlen,
1373 data, rec->data_len,
1374 data, &olen)) != 0) {
1375 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1376 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001377 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001378#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (rec->data_len != olen) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1382 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001383 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001384
TRodziewicz0f82ec62021-05-12 17:49:18 +02001385 data -= transform->ivlen;
1386 rec->data_offset -= transform->ivlen;
1387 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001391 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001392#if defined(MBEDTLS_USE_PSA_CRYPTO)
1393 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1394 size_t sign_mac_length = 0;
1395#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001396
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001397 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 if (post_avail < transform->maclen) {
1401 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1402 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001403 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl_extract_add_data_from_record(add_data, &add_data_len,
1406 rec, transform->tls_version,
1407 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1410 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1411 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1414 transform->psa_mac_alg);
1415 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001416 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 status = psa_mac_update(&operation, add_data, add_data_len);
1420 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001421 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_mac_update(&operation, data, rec->data_len);
1425 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001426 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1430 &sign_mac_length);
1431 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001432 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001434#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1437 add_data_len);
1438 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001439 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 }
1441 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1442 data, rec->data_len);
1443 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001444 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 }
1446 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1447 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001448 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 }
1450 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1451 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001452 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001454#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001457
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001458 rec->data_len += transform->maclen;
1459 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001460 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462hmac_failed_etm_enabled:
1463 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001465 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 status = psa_mac_abort(&operation);
1467 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001468 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001470#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (ret != 0) {
1472 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1473 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001474 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001475 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001478#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001479 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1481 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001482 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001484 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 if (auth_done != 1) {
1486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1487 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001488 }
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001493}
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1496 mbedtls_ssl_transform *transform,
1497 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001498{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001499#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001501#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001502 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001503 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001504
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001505 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001506#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001507 size_t padlen = 0;
1508 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001509#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001511 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 * the description of ssl_extract_add_data_from_record().
1513 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001514#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1515 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1516#else
1517 unsigned char add_data[13];
1518#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001519 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520
Hanno Beckera18d1322018-01-03 14:27:32 +00001521#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001522 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001523 ((void) ssl);
1524#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1527 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 rec->buf == NULL ||
1529 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 rec->buf_len - rec->data_offset < rec->data_len) {
1531 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1532 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001533 }
1534
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001537
Hanno Beckera0e20d02019-05-15 14:03:01 +01001538#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001539 /*
1540 * Match record's CID with incoming CID.
1541 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 if (rec->cid_len != transform->in_cid_len ||
1543 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1544 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001545 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001546#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001547
Hanno Beckerd086bf02021-03-22 13:01:27 +00001548#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001550 if (rec->data_len < transform->maclen) {
1551 MBEDTLS_SSL_DEBUG_MSG(1,
1552 ("Record too short for MAC:"
1553 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1554 rec->data_len, transform->maclen));
1555 return MBEDTLS_ERR_SSL_INVALID_MAC;
1556 }
1557
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001558 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001559 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001561#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001562#if defined(MBEDTLS_GCM_C) || \
1563 defined(MBEDTLS_CCM_C) || \
1564 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001566 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001567 unsigned char *dynamic_iv;
1568 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001569#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001572
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001573 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001574 * Extract dynamic part of nonce for AEAD decryption.
1575 *
1576 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1577 * part of the IV is prepended to the ciphertext and
1578 * can be chosen freely - in particular, it need not
1579 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 dynamic_iv_len = sizeof(rec->ctr);
1582 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1583 if (rec->data_len < dynamic_iv_len) {
1584 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1585 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1586 rec->data_len,
1587 dynamic_iv_len));
1588 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001589 }
1590 dynamic_iv = data;
1591
1592 data += dynamic_iv_len;
1593 rec->data_offset += dynamic_iv_len;
1594 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001596 dynamic_iv = rec->ctr;
1597 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001598
1599 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (rec->data_len < transform->taglen) {
1601 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1602 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1603 rec->data_len,
1604 transform->taglen));
1605 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001606 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001607 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001608
Hanno Beckerdf8be222020-05-21 15:30:57 +01001609 /*
1610 * Prepare nonce from dynamic and static parts.
1611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 ssl_build_record_nonce(iv, sizeof(iv),
1613 transform->iv_dec,
1614 transform->fixed_ivlen,
1615 dynamic_iv,
1616 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001617
Hanno Beckerdf8be222020-05-21 15:30:57 +01001618 /*
1619 * Build additional data for AEAD encryption.
1620 * This depends on the TLS version.
1621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1623 transform->tls_version,
1624 transform->taglen);
1625 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1626 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001627
Hanno Beckerd96a6522019-07-10 13:55:25 +01001628 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001629 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001630 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001631 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001632 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1635 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1636 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001637
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001638 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001639 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001640 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001641#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 status = psa_aead_decrypt(transform->psa_key_dec,
1643 transform->psa_alg,
1644 iv, transform->ivlen,
1645 add_data, add_data_len,
1646 data, rec->data_len + transform->taglen,
1647 data, rec->buf_len - (data - rec->buf),
1648 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001651 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1653 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001654 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001655#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1657 iv, transform->ivlen,
1658 add_data, add_data_len,
1659 data, rec->data_len + transform->taglen, /* src */
1660 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1661 transform->taglen)) != 0) {
1662 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1665 return MBEDTLS_ERR_SSL_INVALID_MAC;
1666 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001669 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001670#endif /* MBEDTLS_USE_PSA_CRYPTO */
1671
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001672 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001673
Hanno Beckerd96a6522019-07-10 13:55:25 +01001674 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 if (olen != rec->data_len) {
1676 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1677 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001678 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001681#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1683 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001684 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001685#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001686 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001687 size_t part_len;
1688 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1689#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001690
Paul Bakker5121ce52009-01-03 21:22:43 +00001691 /*
Paul Bakker45829992013-01-03 14:52:21 +01001692 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001693 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001694#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001695 /* The ciphertext is prefixed with the CBC IV. */
1696 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001697#endif
Paul Bakker45829992013-01-03 14:52:21 +01001698
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001699 /* Size considerations:
1700 *
1701 * - The CBC cipher text must not be empty and hence
1702 * at least of size transform->ivlen.
1703 *
1704 * Together with the potential IV-prefix, this explains
1705 * the first of the two checks below.
1706 *
1707 * - The record must contain a MAC, either in plain or
1708 * encrypted, depending on whether Encrypt-then-MAC
1709 * is used or not.
1710 * - If it is, the message contains the IV-prefix,
1711 * the CBC ciphertext, and the MAC.
1712 * - If it is not, the padded plaintext, and hence
1713 * the CBC ciphertext, has at least length maclen + 1
1714 * because there is at least the padding length byte.
1715 *
1716 * As the CBC ciphertext is not empty, both cases give the
1717 * lower bound minlen + maclen + 1 on the record size, which
1718 * we test for in the second check below.
1719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 if (rec->data_len < minlen + transform->ivlen ||
1721 rec->data_len < minlen + transform->maclen + 1) {
1722 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1723 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1724 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1725 "+ 1 ) ( + expl IV )",
1726 rec->data_len,
1727 transform->ivlen,
1728 transform->maclen));
1729 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001730 }
1731
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001732 /*
1733 * Authenticate before decrypt if enabled
1734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001737#if defined(MBEDTLS_USE_PSA_CRYPTO)
1738 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1739#else
Hanno Becker992b6872017-11-09 18:57:39 +00001740 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001741#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001744
Hanno Beckerd96a6522019-07-10 13:55:25 +01001745 /* Update data_len in tandem with add_data.
1746 *
1747 * The subtraction is safe because of the previous check
1748 * data_len >= minlen + maclen + 1.
1749 *
1750 * Afterwards, we know that data + data_len is followed by at
1751 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001752 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001753 *
1754 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001755 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1757 transform->tls_version,
1758 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001759
Hanno Beckerd96a6522019-07-10 13:55:25 +01001760 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1762 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001763#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1765 transform->psa_mac_alg);
1766 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001767 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 status = psa_mac_update(&operation, add_data, add_data_len);
1771 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001772 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 status = psa_mac_update(&operation, data, rec->data_len);
1776 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001777 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001779
1780 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1782 transform->maclen);
1783 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001784 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001786#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1788 add_data_len);
1789 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001790 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 }
1792 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1793 data, rec->data_len);
1794 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001795 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 }
1797 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1798 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001799 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 }
1801 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1802 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001803 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001805
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1807 transform->maclen);
1808 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1809 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001810
Hanno Beckerd96a6522019-07-10 13:55:25 +01001811 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1813 transform->maclen) != 0) {
1814 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001815 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1816 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001817 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001818#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001819 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001823 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 status = psa_mac_abort(&operation);
1825 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001826 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001828#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001830#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (ret != 0) {
1832 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1833 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1834 }
1835 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001836 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001837 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001838#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001839
1840 /*
1841 * Check length sanity
1842 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001843
1844 /* We know from above that data_len > minlen >= 0,
1845 * so the following check in particular implies that
1846 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (rec->data_len % transform->ivlen != 0) {
1848 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1849 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1850 rec->data_len, transform->ivlen));
1851 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001852 }
1853
TRodziewicz0f82ec62021-05-12 17:49:18 +02001854#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001855 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001856 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001857 */
TRodziewicz345165c2021-07-06 13:42:11 +02001858 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001860
TRodziewicz345165c2021-07-06 13:42:11 +02001861 data += transform->ivlen;
1862 rec->data_offset += transform->ivlen;
1863 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001864#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001865
Hanno Beckerd96a6522019-07-10 13:55:25 +01001866 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1867
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001868#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 status = psa_cipher_decrypt_setup(&cipher_op,
1870 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001873 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1875 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001876 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001881 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1883 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001884 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 status = psa_cipher_update(&cipher_op,
1887 data, rec->data_len,
1888 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001891 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1893 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001894 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001895
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 status = psa_cipher_finish(&cipher_op,
1897 data + olen, rec->data_len - olen,
1898 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001901 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1903 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001904 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001905
1906 olen += part_len;
1907#else
1908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1910 transform->iv_dec, transform->ivlen,
1911 data, rec->data_len, data, &olen)) != 0) {
1912 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1913 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001914 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001915#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001916
Hanno Beckerd96a6522019-07-10 13:55:25 +01001917 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 if (rec->data_len != olen) {
1919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1920 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001921 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001922
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001923 /* Safe since data_len >= minlen + maclen + 1, so after having
1924 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001925 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1926 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001927 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001930 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 rec->data_len,
1932 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001933 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001934 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (rec->data_len < transform->maclen + padlen + 1) {
1938 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1939 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1940 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1941 rec->data_len,
1942 transform->maclen,
1943 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001944 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001945#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001946 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 rec->data_len,
1948 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001949 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001950 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001951 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001952
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001953 padlen++;
1954
1955 /* Regardless of the validity of the padding,
1956 * we have data_len >= padlen here. */
1957
TRodziewicz0f82ec62021-05-12 17:49:18 +02001958#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001959 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 * consecutive memory reads at the end of the record
1961 * plaintext buffer. In order to hide the length and
1962 * validity of the padding, always perform exactly
1963 * `min(256,plaintext_len)` reads (but take into account
1964 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001965 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001967
1968 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001970 size_t const padding_idx = rec->data_len - padlen;
1971 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1972 size_t const start_idx = rec->data_len - num_checks;
1973 size_t idx;
1974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001976 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 * (check[idx] == padlen - 1);
1978 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001979 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001980 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001981 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001982 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001983 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001984 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001985 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001988 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1990 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001991#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001992 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001993
TRodziewicz0f82ec62021-05-12 17:49:18 +02001994#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001995
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001996 /* If the padding was found to be invalid, padlen == 0
1997 * and the subtraction is safe. If the padding was found valid,
1998 * padlen hasn't been changed and the previous assertion
1999 * data_len >= padlen still holds. */
2000 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02002002#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02002003 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2005 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02002006 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002007
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002008#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
2010 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002011#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002012
2013 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01002014 * Authenticate if not done yet.
2015 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002016 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002019 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2020 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002021
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002022 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002023 * data_len < maclen + padlen + 1, then padlen
2024 * got reset to 1, and the initial check
2025 * data_len >= minlen + maclen + 1
2026 * guarantees that at this point we still
2027 * have at least data_len >= maclen.
2028 *
2029 * If the initial value of padlen was such that
2030 * data_len >= maclen + padlen + 1, then we have
2031 * subtracted either padlen + 1 (if the padding was correct)
2032 * or 0 (if the padding was incorrect) since then,
2033 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002034 *
2035 * For stream ciphers, we checked above that
2036 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002037 */
2038 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2040 transform->tls_version,
2041 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002042
TRodziewicz0f82ec62021-05-12 17:49:18 +02002043#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002044 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 * The next two sizes are the minimum and maximum values of
2046 * data_len over all padlen values.
2047 *
2048 * They're independent of padlen, since we previously did
2049 * data_len -= padlen.
2050 *
2051 * Note that max_len + maclen is never more than the buffer
2052 * length, as we previously did in_msglen -= maclen too.
2053 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002054 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002056
Neil Armstronge8589962022-02-25 15:14:29 +01002057#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2059 transform->psa_mac_alg,
2060 add_data, add_data_len,
2061 data, rec->data_len, min_len, max_len,
2062 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002063#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2065 add_data, add_data_len,
2066 data, rec->data_len, min_len, max_len,
2067 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002068#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ret != 0) {
2070 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002071 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002072 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 mbedtls_ct_memcpy_offset(mac_peer, data,
2075 rec->data_len,
2076 min_len, max_len,
2077 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002078#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002079
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002080#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2082 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002083#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2086 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002089#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002090 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002091 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002092 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094hmac_failed_etm_disabled:
2095 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2096 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2097 if (ret != 0) {
2098 return ret;
2099 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002100 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002101
2102 /*
2103 * Finally check the correct flag
2104 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002105 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 return MBEDTLS_ERR_SSL_INVALID_MAC;
2107 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002108#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002109
2110 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (auth_done != 1) {
2112 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2113 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002114 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002115
Ronald Cron6f135e12021-12-08 16:57:54 +01002116#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002118 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2120 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (ret != 0) {
2123 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2124 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002125 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002126#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002127
Hanno Beckera0e20d02019-05-15 14:03:01 +01002128#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 if (rec->cid_len != 0) {
2130 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2131 &rec->type);
2132 if (ret != 0) {
2133 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2134 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002135 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002136#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002141}
2142
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002143#undef MAC_NONE
2144#undef MAC_PLAINTEXT
2145#undef MAC_CIPHERTEXT
2146
Paul Bakker5121ce52009-01-03 21:22:43 +00002147/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002148 * Fill the input message buffer by appending data to it.
2149 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002150 *
2151 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2152 * available (from this read and/or a previous one). Otherwise, an error code
2153 * is returned (possibly EOF or WANT_READ).
2154 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002155 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2156 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2157 * since we always read a whole datagram at once.
2158 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002159 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002160 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002163{
Janos Follath865b3eb2019-12-16 11:46:15 +00002164 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002165 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002166#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2167 size_t in_buf_len = ssl->in_buf_len;
2168#else
2169 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2170#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2175 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2176 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002177 }
2178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2180 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002182 }
2183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002186 uint32_t timeout;
2187
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002188 /*
2189 * The point is, we need to always read a full datagram at once, so we
2190 * sometimes read more then requested, and handle the additional data.
2191 * It could be the rest of the current record (while fetching the
2192 * header) and/or some other records in the same datagram.
2193 */
2194
2195 /*
2196 * Move to the next record in the already read datagram if applicable
2197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->next_record_offset != 0) {
2199 if (ssl->in_left < ssl->next_record_offset) {
2200 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2201 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002202 }
2203
2204 ssl->in_left -= ssl->next_record_offset;
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if (ssl->in_left != 0) {
2207 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2208 MBEDTLS_PRINTF_SIZET,
2209 ssl->next_record_offset));
2210 memmove(ssl->in_hdr,
2211 ssl->in_hdr + ssl->next_record_offset,
2212 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002213 }
2214
2215 ssl->next_record_offset = 0;
2216 }
2217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2219 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2220 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002221
2222 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002223 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002224 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 if (nb_want <= ssl->in_left) {
2226 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2227 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002228 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002229
2230 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002231 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002232 * are not at the beginning of a new record, the caller did something
2233 * wrong.
2234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->in_left != 0) {
2236 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2237 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002238 }
2239
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240 /*
2241 * Don't even try to read if time's out already.
2242 * This avoids by-passing the timer when repeatedly receiving messages
2243 * that will end up being dropped.
2244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (mbedtls_ssl_check_timer(ssl) != 0) {
2246 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002247 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 } else {
2249 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002252 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002254 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (ssl->f_recv_timeout != NULL) {
2260 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2261 timeout);
2262 } else {
2263 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2264 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 if (ret == 0) {
2269 return MBEDTLS_ERR_SSL_CONN_EOF;
2270 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002271 }
2272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2274 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2275 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2278 if (ssl_double_retransmit_timeout(ssl) != 0) {
2279 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2280 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002281 }
2282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2284 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2285 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002286 }
2287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002289 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2292 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2293 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2294 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2295 ret);
2296 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002297 }
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002300 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002302 }
2303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (ret < 0) {
2305 return ret;
2306 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002307
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002308 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002310#endif
2311 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2313 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2314 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002317 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002320 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 } else {
2322 if (ssl->f_recv_timeout != NULL) {
2323 ret = ssl->f_recv_timeout(ssl->p_bio,
2324 ssl->in_hdr + ssl->in_left, len,
2325 ssl->conf->read_timeout);
2326 } else {
2327 ret = ssl->f_recv(ssl->p_bio,
2328 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002329 }
2330 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2333 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2334 ssl->in_left, nb_want));
2335 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (ret == 0) {
2338 return MBEDTLS_ERR_SSL_CONN_EOF;
2339 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (ret < 0) {
2342 return ret;
2343 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002344
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002345 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_DEBUG_MSG(1,
2347 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2348 " were requested",
2349 ret, len));
2350 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002351 }
2352
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002353 ssl->in_left += ret;
2354 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002355 }
2356
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002360}
2361
2362/*
2363 * Flush any data not yet written
2364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002365int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002366{
Janos Follath865b3eb2019-12-16 11:46:15 +00002367 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002368 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (ssl->f_send == NULL) {
2373 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002375 }
2376
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002377 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (ssl->out_left == 0) {
2379 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2380 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002381 }
2382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 while (ssl->out_left > 0) {
2384 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2385 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2386 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002387
Hanno Becker2b1e3542018-08-06 11:19:13 +01002388 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002392
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (ret <= 0) {
2394 return ret;
2395 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002397 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 MBEDTLS_SSL_DEBUG_MSG(1,
2399 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2400 " bytes were sent",
2401 ret, ssl->out_left));
2402 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002403 }
2404
Paul Bakker5121ce52009-01-03 21:22:43 +00002405 ssl->out_left -= ret;
2406 }
2407
Hanno Becker2b1e3542018-08-06 11:19:13 +01002408#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002410 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002412#endif
2413 {
2414 ssl->out_hdr = ssl->out_buf + 8;
2415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002417
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002421}
2422
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002423/*
2424 * Functions to handle the DTLS retransmission state machine
2425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002427/*
2428 * Append current handshake message to current outgoing flight
2429 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002430MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002431static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002432{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2435 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2436 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437
2438 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2440 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2441 sizeof(mbedtls_ssl_flight_item)));
2442 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002443 }
2444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2446 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2447 ssl->out_msglen));
2448 mbedtls_free(msg);
2449 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002450 }
2451
2452 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002455 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002456 msg->next = NULL;
2457
2458 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002460 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466 cur->next = msg;
2467 }
2468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2470 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002471}
2472
2473/*
2474 * Free the current flight of handshake messages
2475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002476void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002477{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 mbedtls_ssl_flight_item *cur = flight;
2479 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002482 next = cur->next;
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 mbedtls_free(cur->p);
2485 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486
2487 cur = next;
2488 }
2489}
2490
2491/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002492 * Swap transform_out and out_ctr with the alternative ones
2493 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002495static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002496{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002498 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2501 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2502 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002503 }
2504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002506
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002507 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002508 tmp_transform = ssl->transform_out;
2509 ssl->transform_out = ssl->handshake->alt_transform_out;
2510 ssl->handshake->alt_transform_out = tmp_transform;
2511
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002512 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2514 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2515 sizeof(ssl->cur_out_ctr));
2516 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2517 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002518
2519 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002523}
2524
2525/*
2526 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002527 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002528int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002529{
2530 int ret = 0;
2531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002539}
2540
2541/*
2542 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002543 *
2544 * Need to remember the current message in case flush_output returns
2545 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002548int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002549{
Janos Follath865b3eb2019-12-16 11:46:15 +00002550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2554 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002555
2556 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002557 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 ret = ssl_swap_epochs(ssl);
2559 if (ret != 0) {
2560 return ret;
2561 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002564 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002567 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002568 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002569
Hanno Beckere1dcb032018-08-17 16:47:58 +01002570 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2572 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002573
Ronald Cron00d012f22022-03-08 15:57:12 +01002574 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002576
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002577 /* Swap epochs before sending Finished: we can't do it after
2578 * sending ChangeCipherSpec, in case write returns WANT_READ.
2579 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2581 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2582 ret = ssl_swap_epochs(ssl);
2583 if (ret != 0) {
2584 return ret;
2585 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002586 }
2587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 ret = ssl_get_remaining_payload_in_datagram(ssl);
2589 if (ret < 0) {
2590 return ret;
2591 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002592 max_frag_len = (size_t) ret;
2593
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002594 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2596 if (max_frag_len == 0) {
2597 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2598 return ret;
2599 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002600
2601 continue;
2602 }
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002605 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002606 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002607
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002608 /* Update position inside current message */
2609 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002611 const unsigned char * const p = ssl->handshake->cur_msg_p;
2612 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002614 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002615 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2618 if (is_finished) {
2619 ret = ssl_swap_epochs(ssl);
2620 if (ret != 0) {
2621 return ret;
2622 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002623 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2626 return ret;
2627 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002628
2629 continue;
2630 }
2631 max_hs_frag_len = max_frag_len - 12;
2632
2633 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2637 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2638 (unsigned) cur_hs_frag_len,
2639 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002640 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002641
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002642 /* Messages are stored with handshake headers as if not fragmented,
2643 * copy beginning of headers then fill fragmentation fields.
2644 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2648 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2649 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2652 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2653 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002656
Hanno Becker3f7b9732018-08-28 09:53:25 +01002657 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002659 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002660 ssl->out_msgtype = cur->type;
2661
2662 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002663 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002664 }
2665
2666 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2668 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002669 ssl->handshake->cur_msg = cur->next;
2670 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002672 ssl->handshake->cur_msg = NULL;
2673 ssl->handshake->cur_msg_p = NULL;
2674 }
2675 }
2676
2677 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2679 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2680 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002681 }
2682 }
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2685 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002686 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 /* Update state and set timer */
2689 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2690 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2691 } else {
2692 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2693 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2694 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2697
2698 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002699}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002700
2701/*
2702 * To be called when the last message of an incoming flight is received.
2703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002704void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002705{
2706 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002708 ssl->handshake->flight = NULL;
2709 ssl->handshake->cur_msg = NULL;
2710
2711 /* The next incoming flight will start with this msg_seq */
2712 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2713
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002714 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002715 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002716
Hanno Becker0271f962018-08-16 13:23:47 +01002717 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002719
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002720 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2724 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002729}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002730
2731/*
2732 * To be called when the last message of an outgoing flight is send.
2733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002734void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002735{
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 ssl_reset_retransmit_timeout(ssl);
2737 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2740 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002745}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002747
Paul Bakker5121ce52009-01-03 21:22:43 +00002748/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002749 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002751int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2752 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002753{
2754 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002755 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002756 * ...
2757 * HandshakeType msg_type;
2758 * uint24 length;
2759 * ...
2760 */
2761 *buf = ssl->out_msg + 4;
2762 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2763
2764 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2765 ssl->out_msg[0] = hs_type;
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002768}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002769
2770/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002771 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002772 *
2773 * - fill in handshake headers
2774 * - update handshake checksum
2775 * - DTLS: save message for resending
2776 * - then pass to the record layer
2777 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002778 * DTLS: except for HelloRequest, messages are only queued, and will only be
2779 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002780 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002781 * Inputs:
2782 * - ssl->out_msglen: 4 + actual handshake message len
2783 * (4 is the size of handshake headers for TLS)
2784 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2785 * - ssl->out_msg + 4: the handshake message body
2786 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002787 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002788 * - ssl->out_msglen: the length of the record contents
2789 * (including handshake headers but excluding record headers)
2790 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002791 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002792int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2793 int update_checksum,
2794 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002795{
Janos Follath865b3eb2019-12-16 11:46:15 +00002796 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002797 const size_t hs_len = ssl->out_msglen - 4;
2798 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002801
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002802 /*
2803 * Sanity checks
2804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2806 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2807 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2808 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002809 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002810
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002811 /* Whenever we send anything different from a
2812 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2814 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2815 ssl->handshake == NULL) {
2816 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2817 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002822 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2824 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002826 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002827#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002828
Hanno Beckerb50a2532018-08-06 11:52:54 +01002829 /* Double-check that we did not exceed the bounds
2830 * of the outgoing record buffer.
2831 * This should never fail as the various message
2832 * writing functions must obey the bounds of the
2833 * outgoing record buffer, but better be safe.
2834 *
2835 * Note: We deliberately do not check for the MTU or MFL here.
2836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2838 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2839 "size %" MBEDTLS_PRINTF_SIZET
2840 ", maximum %" MBEDTLS_PRINTF_SIZET,
2841 ssl->out_msglen,
2842 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2843 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002844 }
2845
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002846 /*
2847 * Fill handshake headers
2848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2850 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2851 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2852 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002853
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002854 /*
2855 * DTLS has additional fields in the Handshake layer,
2856 * between the length field and the actual payload:
2857 * uint16 message_seq;
2858 * uint24 fragment_offset;
2859 * uint24 fragment_length;
2860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002863 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2865 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2866 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2867 MBEDTLS_PRINTF_SIZET,
2868 hs_len,
2869 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002871 }
2872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002874 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002875
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002876 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2878 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2879 ++(ssl->handshake->out_msg_seq);
2880 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002881 ssl->out_msg[4] = 0;
2882 ssl->out_msg[5] = 0;
2883 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002884
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002885 /* Handshake hashes are computed without fragmentation,
2886 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 memset(ssl->out_msg + 6, 0x00, 3);
2888 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002889 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002891
Hanno Becker0207e532018-08-28 10:28:28 +01002892 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002894 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2895 ssl->out_msglen);
2896 if (ret != 0) {
2897 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2898 return ret;
2899 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002901 }
2902
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002903 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2906 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2907 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2908 if ((ret = ssl_flight_append(ssl)) != 0) {
2909 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2910 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002911 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002913#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002914 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2916 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2917 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002918 }
2919 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002924}
2925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2927 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002928{
2929 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2930 size_t msg_with_header_len;
2931 ((void) buf_len);
2932
2933 /* Add reserved 4 bytes for handshake header */
2934 msg_with_header_len = msg_len + 4;
2935 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002937
2938cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002940}
2941
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002942/*
2943 * Record layer functions
2944 */
2945
2946/*
2947 * Write current record.
2948 *
2949 * Uses:
2950 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2951 * - ssl->out_msglen: length of the record content (excl headers)
2952 * - ssl->out_msg: record content
2953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002955{
2956 int ret, done = 0;
2957 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002958 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002963 unsigned i;
2964 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002965#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2966 size_t out_buf_len = ssl->out_buf_len;
2967#else
2968 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2969#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002970 /* Skip writing the record content type to after the encryption,
2971 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002972 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002973#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002974 /* TLS 1.3 still uses the TLS 1.2 version identifier
2975 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002977 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002979#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2981 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2984 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002987 mbedtls_record rec;
2988
2989 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002991 rec.data_len = ssl->out_msglen;
2992 rec.data_offset = ssl->out_msg - rec.buf;
2993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2995 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002996 rec.type = ssl->out_msgtype;
2997
Hanno Beckera0e20d02019-05-15 14:03:01 +01002998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002999 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01003000 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01003001#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01003002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
3004 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
3005 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
3006 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00003007 }
3008
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 if (rec.data_offset != 0) {
3010 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3011 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00003012 }
3013
Hanno Becker6430faf2019-05-08 11:57:13 +01003014 /* Update the record content type and CID. */
3015 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003016#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3017 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003018#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003019 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003021 }
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003024
3025#if defined(MBEDTLS_SSL_PROTO_DTLS)
3026 /* In case of DTLS, double-check that we don't exceed
3027 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3029 ret = ssl_get_remaining_space_in_datagram(ssl);
3030 if (ret < 0) {
3031 return ret;
3032 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003035 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003037 }
3038 }
3039#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003040
Hanno Becker6430faf2019-05-08 11:57:13 +01003041 /* Now write the potentially updated record content type. */
3042 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3045 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3046 ssl->out_hdr[0], ssl->out_hdr[1],
3047 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3050 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003051
3052 ssl->out_left += protected_record_size;
3053 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3057 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003058 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 }
3060 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003061
Gabor Mezei96ae9262022-06-28 11:45:18 +02003062 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if (i == mbedtls_ssl_ep_len(ssl)) {
3064 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3065 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003066 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003067 }
3068
Hanno Becker67bc7c32018-08-06 11:33:50 +01003069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3071 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003072 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 ret = ssl_get_remaining_payload_in_datagram(ssl);
3074 if (ret < 0) {
3075 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3076 ret);
3077 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003078 }
3079
3080 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003082 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 } else {
3084 MBEDTLS_SSL_DEBUG_MSG(2,
3085 ("Still %u bytes available in current datagram",
3086 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003087 }
3088 }
3089#endif /* MBEDTLS_SSL_PROTO_DTLS */
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if ((flush == SSL_FORCE_FLUSH) &&
3092 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3093 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3094 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003095 }
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003100}
3101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003103
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003105static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003106{
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 if (ssl->in_msglen < ssl->in_hslen ||
3108 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3109 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3110 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003111 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003113}
Hanno Becker44650b72018-08-16 12:51:11 +01003114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003116{
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 return (ssl->in_msg[9] << 16) |
3118 (ssl->in_msg[10] << 8) |
3119 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003120}
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003123{
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 return (ssl->in_msg[6] << 16) |
3125 (ssl->in_msg[7] << 8) |
3126 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003127}
3128
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003130static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003131{
3132 uint32_t msg_len, frag_off, frag_len;
3133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 msg_len = ssl_get_hs_total_len(ssl);
3135 frag_off = ssl_get_hs_frag_off(ssl);
3136 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 if (frag_off > msg_len) {
3139 return -1;
3140 }
Hanno Becker44650b72018-08-16 12:51:11 +01003141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 if (frag_len > msg_len - frag_off) {
3143 return -1;
3144 }
Hanno Becker44650b72018-08-16 12:51:11 +01003145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (frag_len + 12 > ssl->in_msglen) {
3147 return -1;
3148 }
Hanno Becker44650b72018-08-16 12:51:11 +01003149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003151}
3152
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003153/*
3154 * Mark bits in bitmask (used for DTLS HS reassembly)
3155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003156static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003157{
3158 unsigned int start_bits, end_bits;
3159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 start_bits = 8 - (offset % 8);
3161 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003162 size_t first_byte_idx = offset / 8;
3163
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003164 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 if (len <= start_bits) {
3166 for (; len != 0; len--) {
3167 mask[first_byte_idx] |= 1 << (start_bits - len);
3168 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003169
3170 /* Avoid potential issues with offset or len becoming invalid */
3171 return;
3172 }
3173
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003174 offset += start_bits; /* Now offset % 8 == 0 */
3175 len -= start_bits;
3176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 for (; start_bits != 0; start_bits--) {
3178 mask[first_byte_idx] |= 1 << (start_bits - 1);
3179 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003180 }
3181
3182 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 if (end_bits != 0) {
3184 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003185
3186 len -= end_bits; /* Now len % 8 == 0 */
3187
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 for (; end_bits != 0; end_bits--) {
3189 mask[last_byte_idx] |= 1 << (8 - end_bits);
3190 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003191 }
3192
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003194}
3195
3196/*
3197 * Check that bitmask is full
3198 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003199MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003200static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003201{
3202 size_t i;
3203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 for (i = 0; i < len / 8; i++) {
3205 if (mask[i] != 0xFF) {
3206 return -1;
3207 }
3208 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 for (i = 0; i < len % 8; i++) {
3211 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3212 return -1;
3213 }
3214 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003217}
3218
Hanno Becker56e205e2018-08-16 09:06:12 +01003219/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003220static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3221 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003222{
Hanno Becker56e205e2018-08-16 09:06:12 +01003223 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003224
Hanno Becker56e205e2018-08-16 09:06:12 +01003225 alloc_len = 12; /* Handshake header */
3226 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003227
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 if (add_bitmap) {
3229 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 }
3232 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003233}
Hanno Becker56e205e2018-08-16 09:06:12 +01003234
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003238{
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 return (ssl->in_msg[1] << 16) |
3240 (ssl->in_msg[2] << 8) |
3241 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003242}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003245{
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3247 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3248 ssl->in_msglen));
3249 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003250 }
3251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3255 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3256 MBEDTLS_PRINTF_SIZET,
3257 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003263
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 if (ssl_check_hs_header(ssl) != 0) {
3265 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3266 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003267 }
3268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (ssl->handshake != NULL &&
3270 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3271 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3272 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3273 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3274 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3275 MBEDTLS_SSL_DEBUG_MSG(2,
3276 (
3277 "received future handshake message of sequence number %u (next %u)",
3278 recv_msg_seq,
3279 ssl->handshake->in_msg_seq));
3280 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003281 }
3282
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003283 /* Retransmit only on last message from previous flight, to avoid
3284 * too many retransmissions.
3285 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3287 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3288 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3289 "message_seq = %u, start_of_flight = %u",
3290 recv_msg_seq,
3291 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3294 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3295 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003296 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 } else {
3298 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3299 "message_seq = %u, expected = %u",
3300 recv_msg_seq,
3301 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003302 }
3303
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003305 }
3306 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003307
Hanno Becker6d97ef52018-08-16 13:09:04 +01003308 /* Message reassembly is handled alongside buffering of future
3309 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003310 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003311 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3313 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3314 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003315 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003318 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl->in_msglen < ssl->in_hslen) {
3320 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003322 }
3323
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003325}
3326
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003327int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003328{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003330 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003331
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003333 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3334 if (ret != 0) {
3335 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3336 return ret;
3337 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003338 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003339
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003340 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3343 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003344 unsigned offset;
3345 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003346
Hanno Becker0271f962018-08-16 13:23:47 +01003347 /* Increment handshake sequence number */
3348 hs->in_msg_seq++;
3349
3350 /*
3351 * Clear up handshake buffering and reassembly structure.
3352 */
3353
3354 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003356
3357 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003359 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003361 *hs_buf = *(hs_buf + 1);
3362 }
3363
3364 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003366 }
3367#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003368 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003369}
3370
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003371/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003372 * DTLS anti-replay: RFC 6347 4.1.2.6
3373 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003374 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3375 * Bit n is set iff record number in_window_top - n has been seen.
3376 *
3377 * Usually, in_window_top is the last record number seen and the lsb of
3378 * in_window is set. The only exception is the initial state (record number 0
3379 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003382void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003383{
3384 ssl->in_window_top = 0;
3385 ssl->in_window = 0;
3386}
3387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003389{
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 return ((uint64_t) buf[0] << 40) |
3391 ((uint64_t) buf[1] << 32) |
3392 ((uint64_t) buf[2] << 24) |
3393 ((uint64_t) buf[3] << 16) |
3394 ((uint64_t) buf[4] << 8) |
3395 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003396}
3397
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003398MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003399static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003400{
Janos Follath865b3eb2019-12-16 11:46:15 +00003401 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003402 unsigned char *original_in_ctr;
3403
3404 // save original in_ctr
3405 original_in_ctr = ssl->in_ctr;
3406
3407 // use counter from record
3408 ssl->in_ctr = record_in_ctr;
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003411
3412 // restore the counter
3413 ssl->in_ctr = original_in_ctr;
3414
3415 return ret;
3416}
3417
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003418/*
3419 * Return 0 if sequence number is acceptable, -1 otherwise
3420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003421int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003422{
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003424 uint64_t bit;
3425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3427 return 0;
3428 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 if (rec_seqnum > ssl->in_window_top) {
3431 return 0;
3432 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003433
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003434 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003435
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 if (bit >= 64) {
3437 return -1;
3438 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3441 return -1;
3442 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003445}
3446
3447/*
3448 * Update replay window on new validated record
3449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003450void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003451{
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003455 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003457
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459 /* Update window_top and the contents of the window */
3460 uint64_t shift = rec_seqnum - ssl->in_window_top;
3461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003463 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003465 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003466 ssl->in_window |= 1;
3467 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003468
3469 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003471 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003472 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003473
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003475 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003477 }
3478}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003480
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003481#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003482/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003483 * Check if a datagram looks like a ClientHello with a valid cookie,
3484 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003485 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003486 *
3487 * - if cookie is valid, return 0
3488 * - if ClientHello looks superficially valid but cookie is not,
3489 * fill obuf and set olen, then
3490 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3491 * - otherwise return a specific error code
3492 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003493MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003494MBEDTLS_STATIC_TESTABLE
3495int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 mbedtls_ssl_context *ssl,
3497 const unsigned char *cli_id, size_t cli_id_len,
3498 const unsigned char *in, size_t in_len,
3499 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003500{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003501 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003502 unsigned char *p;
3503
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003504 /*
3505 * Structure of ClientHello with record and handshake headers,
3506 * and expected values. We don't need to check a lot, more checks will be
3507 * done when actually parsing the ClientHello - skipping those checks
3508 * avoids code duplication and does not make cookie forging any easier.
3509 *
3510 * 0-0 ContentType type; copied, must be handshake
3511 * 1-2 ProtocolVersion version; copied
3512 * 3-4 uint16 epoch; copied, must be 0
3513 * 5-10 uint48 sequence_number; copied
3514 * 11-12 uint16 length; (ignored)
3515 *
3516 * 13-13 HandshakeType msg_type; (ignored)
3517 * 14-16 uint24 length; (ignored)
3518 * 17-18 uint16 message_seq; copied
3519 * 19-21 uint24 fragment_offset; copied, must be 0
3520 * 22-24 uint24 fragment_length; (ignored)
3521 *
3522 * 25-26 ProtocolVersion client_version; (ignored)
3523 * 27-58 Random random; (ignored)
3524 * 59-xx SessionID session_id; 1 byte len + sid_len content
3525 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3526 * ...
3527 *
3528 * Minimum length is 61 bytes.
3529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003530 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3531 (unsigned) in_len));
3532 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3533 if (in_len < 61) {
3534 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3535 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003536 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003537
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3539 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003540
Gilles Peskine449bd832023-01-11 14:50:10 +01003541 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3542 fragment_offset != 0) {
3543 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3544 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3545 in[0], (unsigned) epoch,
3546 (unsigned) fragment_offset));
3547 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003548 }
3549
3550 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003551 if (59 + 1 + sid_len + 1 > in_len) {
3552 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3553 (unsigned) sid_len,
3554 (unsigned) in_len - 61));
3555 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003556 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003557 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3558 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003559
3560 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003561 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3562 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3563 (unsigned) cookie_len,
3564 (unsigned) (in_len - sid_len - 61)));
3565 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003566 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003567
Gilles Peskine449bd832023-01-11 14:50:10 +01003568 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3569 in + sid_len + 61, cookie_len);
3570 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3571 in + sid_len + 61, cookie_len,
3572 cli_id, cli_id_len) == 0) {
3573 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3574 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003575 }
3576
3577 /*
3578 * If we get here, we've got an invalid cookie, let's prepare HVR.
3579 *
3580 * 0-0 ContentType type; copied
3581 * 1-2 ProtocolVersion version; copied
3582 * 3-4 uint16 epoch; copied
3583 * 5-10 uint48 sequence_number; copied
3584 * 11-12 uint16 length; olen - 13
3585 *
3586 * 13-13 HandshakeType msg_type; hello_verify_request
3587 * 14-16 uint24 length; olen - 25
3588 * 17-18 uint16 message_seq; copied
3589 * 19-21 uint24 fragment_offset; copied
3590 * 22-24 uint24 fragment_length; olen - 25
3591 *
3592 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3593 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3594 *
3595 * Minimum length is 28.
3596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 if (buf_len < 28) {
3598 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3599 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003600
3601 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003602 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003603 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3604 obuf[25] = 0xfe;
3605 obuf[26] = 0xff;
3606
3607 /* Generate and write actual cookie */
3608 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003609 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3610 &p, obuf + buf_len,
3611 cli_id, cli_id_len) != 0) {
3612 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003613 }
3614
3615 *olen = p - obuf;
3616
3617 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003618 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003619
Gilles Peskine449bd832023-01-11 14:50:10 +01003620 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3621 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3622 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003623
Gilles Peskine449bd832023-01-11 14:50:10 +01003624 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003625
Gilles Peskine449bd832023-01-11 14:50:10 +01003626 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003627}
3628
3629/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630 * Handle possible client reconnect with the same UDP quadruplet
3631 * (RFC 6347 Section 4.2.8).
3632 *
3633 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3634 * that looks like a ClientHello.
3635 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003636 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003637 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003638 * - if the input looks like a ClientHello with a valid cookie,
3639 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003640 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003641 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003642 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003643 * This function is called (through ssl_check_client_reconnect()) when an
3644 * unexpected record is found in ssl_get_next_record(), which will discard the
3645 * record if we return 0, and bubble up the return value otherwise (this
3646 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3647 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003648 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003649MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003650static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003651{
Janos Follath865b3eb2019-12-16 11:46:15 +00003652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003653 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003654
Gilles Peskine449bd832023-01-11 14:50:10 +01003655 if (ssl->conf->f_cookie_write == NULL ||
3656 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003657 /* If we can't use cookies to verify reachability of the peer,
3658 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3660 "can't check reconnect validity"));
3661 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003662 }
3663
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003664 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003665 ssl,
3666 ssl->cli_id, ssl->cli_id_len,
3667 ssl->in_buf, ssl->in_left,
3668 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003669
Gilles Peskine449bd832023-01-11 14:50:10 +01003670 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003671
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003673 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3675 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3676 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003677 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003678 * If the error is permanent we'll catch it later,
3679 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003680 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3681 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003682 (void) send_ret;
3683
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003685 }
3686
Gilles Peskine449bd832023-01-11 14:50:10 +01003687 if (ret == 0) {
3688 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3689 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3690 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3691 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003692 }
3693
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003695 }
3696
Gilles Peskine449bd832023-01-11 14:50:10 +01003697 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003698}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003699#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003700
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003701MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003702static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003703{
Gilles Peskine449bd832023-01-11 14:50:10 +01003704 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003705 record_type != MBEDTLS_SSL_MSG_ALERT &&
3706 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3708 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003709 }
3710
Gilles Peskine449bd832023-01-11 14:50:10 +01003711 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003712}
3713
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003714/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003715 * ContentType type;
3716 * ProtocolVersion version;
3717 * uint16 epoch; // DTLS only
3718 * uint48 sequence_number; // DTLS only
3719 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003720 *
3721 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003722 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003723 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3724 *
3725 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003726 * 1. proceed with the record if this function returns 0
3727 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3728 * 3. return CLIENT_RECONNECT if this function return that value
3729 * 4. drop the whole datagram if this function returns anything else.
3730 * Point 2 is needed when the peer is resending, and we have already received
3731 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003732 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003734static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3735 unsigned char *buf,
3736 size_t len,
3737 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003738{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003739 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003740
Hanno Beckere5e7e782019-07-11 12:29:35 +01003741 size_t const rec_hdr_type_offset = 0;
3742 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003743
Hanno Beckere5e7e782019-07-11 12:29:35 +01003744 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3745 rec_hdr_type_len;
3746 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003747
Hanno Beckere5e7e782019-07-11 12:29:35 +01003748 size_t const rec_hdr_ctr_len = 8;
3749#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003750 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003751 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3752 rec_hdr_version_len;
3753
Hanno Beckera0e20d02019-05-15 14:03:01 +01003754#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003755 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3756 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003757 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003758#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3759#endif /* MBEDTLS_SSL_PROTO_DTLS */
3760
3761 size_t rec_hdr_len_offset; /* To be determined */
3762 size_t const rec_hdr_len_len = 2;
3763
3764 /*
3765 * Check minimum lengths for record header.
3766 */
3767
3768#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003770 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003772#endif /* MBEDTLS_SSL_PROTO_DTLS */
3773 {
3774 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3775 }
3776
Gilles Peskine449bd832023-01-11 14:50:10 +01003777 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3778 MBEDTLS_SSL_DEBUG_MSG(1,
3779 (
3780 "datagram of length %u too small to hold DTLS record header of length %u",
3781 (unsigned) len,
3782 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3783 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003784 }
3785
3786 /*
3787 * Parse and validate record content type
3788 */
3789
Gilles Peskine449bd832023-01-11 14:50:10 +01003790 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003791
3792 /* Check record content type */
3793#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3794 rec->cid_len = 0;
3795
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003797 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003799 /* Shift pointers to account for record header including CID
3800 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003801 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003802 * ProtocolVersion version;
3803 * uint16 epoch;
3804 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003805 * opaque cid[cid_length]; // Additional field compared to
3806 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003807 * uint16 length;
3808 * opaque enc_content[DTLSCiphertext.length];
3809 * } DTLSCiphertext;
3810 */
3811
3812 /* So far, we only support static CID lengths
3813 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003814 rec_hdr_cid_len = ssl->conf->cid_len;
3815 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003816
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3818 MBEDTLS_SSL_DEBUG_MSG(1,
3819 (
3820 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3821 (unsigned) len,
3822 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3823 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003824 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003825
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003826 /* configured CID len is guaranteed at most 255, see
3827 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3828 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003829 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3830 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003831#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003832 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 if (ssl_check_record_type(rec->type)) {
3834 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3835 (unsigned) rec->type));
3836 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003837 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003838 }
3839
Hanno Beckere5e7e782019-07-11 12:29:35 +01003840 /*
3841 * Parse and validate record version
3842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3844 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003845 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3846 buf + rec_hdr_version_offset,
3847 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003848
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 if (tls_version > ssl->conf->max_tls_version) {
3850 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3851 (unsigned) tls_version,
3852 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003853
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003855 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003856 /*
3857 * Parse/Copy record sequence number.
3858 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003859
Hanno Beckere5e7e782019-07-11 12:29:35 +01003860#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003862 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3864 rec_hdr_ctr_len);
3865 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003866#endif /* MBEDTLS_SSL_PROTO_DTLS */
3867 {
3868 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003870 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003871
Hanno Beckere5e7e782019-07-11 12:29:35 +01003872 /*
3873 * Parse record length.
3874 */
3875
Hanno Beckere5e7e782019-07-11 12:29:35 +01003876 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3878 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3879 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3882 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3883 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003884
3885 rec->buf = buf;
3886 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003887
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (rec->data_len == 0) {
3889 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3890 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003891
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003892 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003893 * DTLS-related tests.
3894 * Check epoch before checking length constraint because
3895 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3896 * message gets duplicated before the corresponding Finished message,
3897 * the second ChangeCipherSpec should be discarded because it belongs
3898 * to an old epoch, but not because its length is shorter than
3899 * the minimum record length for packets using the new record transform.
3900 * Note that these two kinds of failures are handled differently,
3901 * as an unexpected record is silently skipped but an invalid
3902 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003903 */
3904#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3906 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003907
Hanno Becker955a5c92019-07-10 17:12:07 +01003908 /* Check that the datagram is large enough to contain a record
3909 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (len < rec->data_offset + rec->data_len) {
3911 MBEDTLS_SSL_DEBUG_MSG(1,
3912 (
3913 "Datagram of length %u too small to contain record of advertised length %u.",
3914 (unsigned) len,
3915 (unsigned) (rec->data_offset + rec->data_len)));
3916 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003917 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003918
Hanno Becker37cfe732019-07-10 17:20:01 +01003919 /* Records from other, non-matching epochs are silently discarded.
3920 * (The case of same-port Client reconnects must be considered in
3921 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 if (rec_epoch != ssl->in_epoch) {
3923 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3924 "expected %u, received %lu",
3925 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003926
Hanno Becker552f7472019-07-19 10:59:12 +01003927 /* Records from the next epoch are considered for buffering
3928 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3930 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3931 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003932 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003933
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003935 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003936#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003937 /* For records from the correct epoch, check whether their
3938 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003939 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3940 &rec->ctr[0]) != 0) {
3941 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3942 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003943 }
3944#endif
3945 }
3946#endif /* MBEDTLS_SSL_PROTO_DTLS */
3947
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003949}
Paul Bakker5121ce52009-01-03 21:22:43 +00003950
Paul Bakker5121ce52009-01-03 21:22:43 +00003951
Hanno Becker2fddd372019-07-10 14:37:41 +01003952#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003954static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003955{
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003957
3958 /*
3959 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3960 * access the first byte of record content (handshake type), as we
3961 * have an active transform (possibly iv_len != 0), so use the
3962 * fact that the record header len is 13 instead.
3963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003965 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003967 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3968 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3970 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3971 "from the same port"));
3972 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003973 }
3974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003976}
Hanno Becker2fddd372019-07-10 14:37:41 +01003977#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003978
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003979/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003980 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003981 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003983static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3984 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003985{
3986 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003987
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3989 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003990
Ronald Cron7e38cba2021-11-24 12:43:39 +01003991 /*
3992 * In TLS 1.3, always treat ChangeCipherSpec records
3993 * as unencrypted. The only thing we do with them is
3994 * check the length and content and ignore them.
3995 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003996#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 if (ssl->transform_in != NULL &&
3998 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3999 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004000 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01004002 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004003#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01004006 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
4009 rec)) != 0) {
4010 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01004011
Hanno Beckera0e20d02019-05-15 14:03:01 +01004012#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004014 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4016 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004017 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004018 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004019#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004022 }
4023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (old_msg_type != rec->type) {
4025 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4026 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004027 }
4028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4030 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004031
Hanno Beckera0e20d02019-05-15 14:03:01 +01004032#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004033 /* We have already checked the record content type
4034 * in ssl_parse_record_header(), failing or silently
4035 * dropping the record in the case of an unknown type.
4036 *
4037 * Since with the use of CIDs, the record content type
4038 * might change during decryption, re-check the record
4039 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (ssl_check_record_type(rec->type)) {
4041 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4042 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004043 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004044#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004047#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4049 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004050 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4052 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004053 }
4054#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4055
4056 ssl->nb_zero++;
4057
4058 /*
4059 * Three or more empty messages may be a DoS attack
4060 * (excessive CPU consumption).
4061 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (ssl->nb_zero > 3) {
4063 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4064 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004065 /* Treat the records as if they were not properly authenticated,
4066 * thereby failing the connection if we see more than allowed
4067 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004069 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004071 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004073
4074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004076 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004078#endif
4079 {
4080 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4082 i > mbedtls_ssl_ep_len(ssl); i--) {
4083 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004084 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004086 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004087
4088 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (i == mbedtls_ssl_ep_len(ssl)) {
4090 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4091 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004092 }
4093 }
4094
Paul Bakker5121ce52009-01-03 21:22:43 +00004095 }
4096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004097#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4099 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004100 }
4101#endif
4102
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004103 /* Check actual (decrypted) record content length against
4104 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4106 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4107 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004108 }
4109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004111}
4112
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004113/*
4114 * Read a record.
4115 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004116 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4117 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4118 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004119 */
Hanno Becker1097b342018-08-15 14:09:41 +01004120
4121/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004122MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004123static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004124MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004125static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004126MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004127static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4130 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004131{
Janos Follath865b3eb2019-12-16 11:46:15 +00004132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004137 do {
Simon Butcher99000142016-10-13 17:21:01 +01004138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 ret = ssl_consume_current_message(ssl);
4140 if (ret != 0) {
4141 return ret;
4142 }
Hanno Becker26994592018-08-15 14:14:59 +01004143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004145 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004146#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004147
Hanno Becker40f50842018-08-15 14:48:01 +01004148 /* We only check for buffered messages if the
4149 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4151 ssl_next_record_is_in_datagram(ssl) == 0) {
4152 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004153 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 }
Hanno Becker40f50842018-08-15 14:48:01 +01004155 }
4156
Hanno Becker40f50842018-08-15 14:48:01 +01004157#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (dtls_have_buffered == 0) {
4159 ret = ssl_get_next_record(ssl);
4160 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004161 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 }
Hanno Becker40f50842018-08-15 14:48:01 +01004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (ret != 0) {
4165 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4166 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004167 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004168 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004169 }
4170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004172
Hanno Becker40f50842018-08-15 14:48:01 +01004173#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004175 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 ret = ssl_buffer_message(ssl);
4177 if (ret != 0) {
4178 return ret;
4179 }
Hanno Becker40f50842018-08-15 14:48:01 +01004180
4181 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4182 }
4183#endif /* MBEDTLS_SSL_PROTO_DTLS */
4184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4186 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 if (0 != ret) {
4189 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4190 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004191 }
4192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4194 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004195 ret = mbedtls_ssl_update_handshake_status(ssl);
4196 if (0 != ret) {
4197 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4198 return ret;
4199 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004200 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 } else {
4202 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004203 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004204 }
4205
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004209}
4210
Hanno Becker40f50842018-08-15 14:48:01 +01004211#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004212MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004213static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004214{
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (ssl->in_left > ssl->next_record_offset) {
4216 return 1;
4217 }
Simon Butcher99000142016-10-13 17:21:01 +01004218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004220}
4221
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004222MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004223static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004224{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004225 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004227 int ret = 0;
4228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (hs == NULL) {
4230 return -1;
4231 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004234
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4236 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004237 /* Check if we have seen a ChangeCipherSpec before.
4238 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (!hs->buffering.seen_ccs) {
4240 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004241 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004242 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004243 }
4244
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004246 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4247 ssl->in_msglen = 1;
4248 ssl->in_msg[0] = 1;
4249
4250 /* As long as they are equal, the exact value doesn't matter. */
4251 ssl->in_left = 0;
4252 ssl->next_record_offset = 0;
4253
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004254 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004255 goto exit;
4256 }
Hanno Becker37f95322018-08-16 13:55:32 +01004257
Hanno Beckerb8f50142018-08-28 10:01:34 +01004258#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004259 /* Debug only */
4260 {
4261 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004263 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 if (hs_buf->is_valid == 1) {
4265 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4266 hs->in_msg_seq + offset,
4267 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004268 }
4269 }
4270 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004271#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004272
4273 /* Check if we have buffered and/or fully reassembled the
4274 * next handshake message. */
4275 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004277 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 size_t msg_len = (hs_buf->data[1] << 16) |
4279 (hs_buf->data[2] << 8) |
4280 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004281
4282 /* Double-check that we haven't accidentally buffered
4283 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4285 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4286 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004287 }
4288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4290 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4291 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004292
4293 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4294 ssl->in_hslen = msg_len + 12;
4295 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004297
4298 ret = 0;
4299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 } else {
4301 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4302 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004303 }
4304
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004305 ret = -1;
4306
4307exit:
4308
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4310 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004311}
4312
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004313MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004314static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4315 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004316{
4317 int offset;
4318 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4320 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004321
Hanno Becker01315ea2018-08-21 17:22:17 +01004322 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004324
4325 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4327 hs->buffering.total_bytes_buffered)) {
4328 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4329 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004330 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004331
Hanno Becker4f432ad2018-08-28 10:02:32 +01004332 /* We don't have enough space to buffer the next expected handshake
4333 * message. Remove buffers used for future messages to gain space,
4334 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4336 offset >= 0; offset--) {
4337 MBEDTLS_SSL_DEBUG_MSG(2,
4338 (
4339 "Free buffering slot %d to make space for reassembly of next handshake message",
4340 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004343
4344 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4346 hs->buffering.total_bytes_buffered)) {
4347 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4348 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004349 }
4350 }
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004353}
4354
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004355MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004356static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004357{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004358 int ret = 0;
4359 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 if (hs == NULL) {
4362 return 0;
4363 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004368 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004370
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004371 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004372 break;
4373
4374 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004375 {
4376 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004378 mbedtls_ssl_hs_buffer *hs_buf;
4379 size_t msg_len = ssl->in_hslen - 12;
4380
4381 /* We should never receive an old handshake
4382 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4384 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004386 }
4387
4388 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004390 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 MBEDTLS_SSL_DEBUG_MSG(2,
4392 ("Ignore future HS message with sequence number %u, "
4393 "buffering window %u - %u",
4394 recv_msg_seq, ssl->handshake->in_msg_seq,
4395 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4396 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004397
4398 goto exit;
4399 }
4400
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4402 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004405
4406 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004408 size_t reassembly_buf_sz;
4409
Hanno Becker37f95322018-08-16 13:55:32 +01004410 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004412
4413 /* We copy the message back into the input buffer
4414 * after reassembly, so check that it's not too large.
4415 * This is an implementation-specific limitation
4416 * and not one from the standard, hence it is not
4417 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004419 /* Ignore message */
4420 goto exit;
4421 }
4422
Hanno Beckere0b150f2018-08-21 15:51:03 +01004423 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 if (hs->buffering.total_bytes_buffered >
4425 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4426 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4427 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004428 }
4429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4431 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4434 hs->buffering.total_bytes_buffered)) {
4435 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004436 /* If we can't buffer a future message because
4437 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 MBEDTLS_SSL_DEBUG_MSG(2,
4439 ("Buffering of future message of size %"
4440 MBEDTLS_PRINTF_SIZET
4441 " would exceed the compile-time limit %"
4442 MBEDTLS_PRINTF_SIZET
4443 " (already %" MBEDTLS_PRINTF_SIZET
4444 " bytes buffered) -- ignore\n",
4445 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4446 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004447 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 } else {
4449 MBEDTLS_SSL_DEBUG_MSG(2,
4450 ("Buffering of future message of size %"
4451 MBEDTLS_PRINTF_SIZET
4452 " would exceed the compile-time limit %"
4453 MBEDTLS_PRINTF_SIZET
4454 " (already %" MBEDTLS_PRINTF_SIZET
4455 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4456 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4457 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004458 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4461 MBEDTLS_SSL_DEBUG_MSG(2,
4462 ("Reassembly of next message of size %"
4463 MBEDTLS_PRINTF_SIZET
4464 " (%" MBEDTLS_PRINTF_SIZET
4465 " with bitmap) would exceed"
4466 " the compile-time limit %"
4467 MBEDTLS_PRINTF_SIZET
4468 " (already %" MBEDTLS_PRINTF_SIZET
4469 " bytes buffered) -- fail\n",
4470 msg_len,
4471 reassembly_buf_sz,
4472 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4473 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004474 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4475 goto exit;
4476 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004477 }
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 MBEDTLS_SSL_DEBUG_MSG(2,
4480 ("initialize reassembly, total length = %"
4481 MBEDTLS_PRINTF_SIZET,
4482 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4485 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004486 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004487 goto exit;
4488 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004489 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004490
4491 /* Prepare final header: copy msg_type, length and message_seq,
4492 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 memcpy(hs_buf->data, ssl->in_msg, 6);
4494 memset(hs_buf->data + 6, 0, 3);
4495 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004496
4497 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004498
4499 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004501 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4503 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004504 /* Ignore */
4505 goto exit;
4506 }
4507 }
4508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004510 size_t frag_len, frag_off;
4511 unsigned char * const msg = hs_buf->data + 12;
4512
4513 /*
4514 * Check and copy current fragment
4515 */
4516
4517 /* Validation of header fields already done in
4518 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 frag_off = ssl_get_hs_frag_off(ssl);
4520 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004521
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4523 ", length = %" MBEDTLS_PRINTF_SIZET,
4524 frag_off, frag_len));
4525 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004528 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 ssl_bitmask_set(bitmask, frag_off, frag_len);
4530 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4531 msg_len) == 0);
4532 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004533 hs_buf->is_complete = 1;
4534 }
4535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4537 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004538 }
4539
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004540 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004541 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004542
4543 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004544 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004545 break;
4546 }
4547
4548exit:
4549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4551 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004552}
4553#endif /* MBEDTLS_SSL_PROTO_DTLS */
4554
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004555MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004556static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004557{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004558 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004559 * Consume last content-layer message and potentially
4560 * update in_msglen which keeps track of the contents'
4561 * consumption state.
4562 *
4563 * (1) Handshake messages:
4564 * Remove last handshake message, move content
4565 * and adapt in_msglen.
4566 *
4567 * (2) Alert messages:
4568 * Consume whole record content, in_msglen = 0.
4569 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004570 * (3) Change cipher spec:
4571 * Consume whole record content, in_msglen = 0.
4572 *
4573 * (4) Application data:
4574 * Don't do anything - the record layer provides
4575 * the application data as a stream transport
4576 * and consumes through mbedtls_ssl_read only.
4577 *
4578 */
4579
4580 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004582 /* Hard assertion to be sure that no application data
4583 * is in flight, as corrupting ssl->in_msglen during
4584 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (ssl->in_offt != NULL) {
4586 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4587 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004588 }
4589
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004590 /*
4591 * Get next Handshake message in the current record
4592 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004593
Hanno Becker4a810fb2017-05-24 16:27:30 +01004594 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004595 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004596 * current handshake content: If DTLS handshake
4597 * fragmentation is used, that's the fragment
4598 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004599 * size here is faulty and should be changed at
4600 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004601 * (2) While it doesn't seem to cause problems, one
4602 * has to be very careful not to assume that in_hslen
4603 * is always <= in_msglen in a sensible communication.
4604 * Again, it's wrong for DTLS handshake fragmentation.
4605 * The following check is therefore mandatory, and
4606 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004607 * Additionally, ssl->in_hslen might be arbitrarily out of
4608 * bounds after handling a DTLS message with an unexpected
4609 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004612 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4614 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4617 ssl->in_msg, ssl->in_msglen);
4618 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004619 ssl->in_msglen = 0;
4620 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004621
Hanno Becker4a810fb2017-05-24 16:27:30 +01004622 ssl->in_hslen = 0;
4623 }
4624 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 else if (ssl->in_offt != NULL) {
4626 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004627 }
4628 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004630 ssl->in_msglen = 0;
4631 }
4632
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004634}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004635
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004636MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004637static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004638{
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 if (ssl->in_msglen > 0) {
4640 return 1;
4641 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004644}
4645
Hanno Becker5f066e72018-08-16 14:56:31 +01004646#if defined(MBEDTLS_SSL_PROTO_DTLS)
4647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004649{
4650 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004652 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004656 hs->buffering.total_bytes_buffered -=
4657 hs->buffering.future_record.len;
4658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004660 hs->buffering.future_record.data = NULL;
4661 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004662}
4663
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004664MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004665static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004666{
4667 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004669 size_t rec_len;
4670 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004671#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4672 size_t in_buf_len = ssl->in_buf_len;
4673#else
4674 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4675#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4677 return 0;
4678 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (hs == NULL) {
4681 return 0;
4682 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004683
Hanno Becker5f066e72018-08-16 14:56:31 +01004684 rec = hs->buffering.future_record.data;
4685 rec_len = hs->buffering.future_record.len;
4686 rec_epoch = hs->buffering.future_record.epoch;
4687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (rec == NULL) {
4689 return 0;
4690 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004691
Hanno Becker4cb782d2018-08-20 11:19:05 +01004692 /* Only consider loading future records if the
4693 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4695 return 0;
4696 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (rec_epoch != ssl->in_epoch) {
4701 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004702 goto exit;
4703 }
4704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004706
4707 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4709 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4710 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004711 }
4712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004714 ssl->in_left = rec_len;
4715 ssl->next_record_offset = 0;
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004718
4719exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4721 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004722}
4723
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004724MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004725static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4726 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004727{
4728 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004729
4730 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (hs == NULL) {
4732 return 0;
4733 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004734
4735 /* Only buffer handshake records (we are only interested
4736 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4738 return 0;
4739 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004740
4741 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 if (hs->buffering.future_record.data != NULL) {
4743 return 0;
4744 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004745
Hanno Becker01315ea2018-08-21 17:22:17 +01004746 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4748 hs->buffering.total_bytes_buffered)) {
4749 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4750 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4751 " (already %" MBEDTLS_PRINTF_SIZET
4752 " bytes buffered) -- ignore\n",
4753 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4754 hs->buffering.total_bytes_buffered));
4755 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004756 }
4757
Hanno Becker5f066e72018-08-16 14:56:31 +01004758 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4760 ssl->in_epoch + 1U));
4761 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004762
4763 /* ssl_parse_record_header() only considers records
4764 * of the next epoch as candidates for buffering. */
4765 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004766 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004767
4768 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 mbedtls_calloc(1, hs->buffering.future_record.len);
4770 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004771 /* If we run out of RAM trying to buffer a
4772 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004774 }
4775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004777
Hanno Becker519f15d2019-07-11 12:43:20 +01004778 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004780}
4781
4782#endif /* MBEDTLS_SSL_PROTO_DTLS */
4783
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004784MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004785static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004786{
Janos Follath865b3eb2019-12-16 11:46:15 +00004787 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004788 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004789
Hanno Becker5f066e72018-08-16 14:56:31 +01004790#if defined(MBEDTLS_SSL_PROTO_DTLS)
4791 /* We might have buffered a future record; if so,
4792 * and if the epoch matches now, load it.
4793 * On success, this call will set ssl->in_left to
4794 * the length of the buffered record, so that
4795 * the calls to ssl_fetch_input() below will
4796 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 ret = ssl_load_buffered_record(ssl);
4798 if (ret != 0) {
4799 return ret;
4800 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004801#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004802
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004803 /* Ensure that we have enough space available for the default form
4804 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4805 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4807 if (ret != 0) {
4808 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4809 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004810 }
4811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4813 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4816 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4817 ret = ssl_buffer_future_record(ssl, &rec);
4818 if (ret != 0) {
4819 return ret;
4820 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004821
4822 /* Fall through to handling of unexpected records */
4823 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4824 }
4825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004827#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004828 /* Reset in pointers to default state for TLS/DTLS records,
4829 * assuming no CID and no offset between record content and
4830 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004832
Hanno Becker7ae20e02019-07-12 08:33:49 +01004833 /* Setup internal message pointers from record structure. */
4834 ssl->in_msgtype = rec.type;
4835#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4836 ssl->in_len = ssl->in_cid + rec.cid_len;
4837#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4838 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4839 ssl->in_msglen = rec.data_len;
4840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 ret = ssl_check_client_reconnect(ssl);
4842 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4843 if (ret != 0) {
4844 return ret;
4845 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004846#endif
4847
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004848 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004849 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4852 "(header)"));
4853 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004854 /* Skip invalid record and the rest of the datagram */
4855 ssl->next_record_offset = 0;
4856 ssl->in_left = 0;
4857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4859 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004860 }
4861
4862 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4864 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004865#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004866 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004868 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004869 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004871#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004873 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004874 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (ssl->next_record_offset < ssl->in_left) {
4876 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004877 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004879#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004880 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004881 /*
4882 * Fetch record contents from underlying transport.
4883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4885 if (ret != 0) {
4886 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4887 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004888 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004889
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004890 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004891 }
4892
4893 /*
4894 * Decrypt record contents.
4895 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004898#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004900 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004902 /* Except when waiting for Finished as a bad mac here
4903 * probably means something went wrong in the handshake
4904 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4906 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004907#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4909 mbedtls_ssl_send_alert_message(ssl,
4910 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4911 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004912 }
4913#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004915 }
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (ssl->conf->badmac_limit != 0 &&
4918 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4919 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4920 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004921 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004922
Hanno Becker4a810fb2017-05-24 16:27:30 +01004923 /* As above, invalid records cause
4924 * dismissal of the whole datagram. */
4925
4926 ssl->next_record_offset = 0;
4927 ssl->in_left = 0;
4928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4930 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004931 }
4932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 return ret;
4934 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004935#endif
4936 {
4937 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004938#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4940 mbedtls_ssl_send_alert_message(ssl,
4941 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4942 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004943 }
4944#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004946 }
4947 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004948
Hanno Becker44d89b22019-07-12 09:40:44 +01004949
4950 /* Reset in pointers to default state for TLS/DTLS records,
4951 * assuming no CID and no offset between record content and
4952 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004954#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4955 ssl->in_len = ssl->in_cid + rec.cid_len;
4956#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004957 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004958
Hanno Becker8685c822019-07-12 09:37:30 +01004959 /* The record content type may change during decryption,
4960 * so re-read it. */
4961 ssl->in_msgtype = rec.type;
4962 /* Also update the input buffer, because unfortunately
4963 * the server-side ssl_parse_client_hello() reparses the
4964 * record header when receiving a ClientHello initiating
4965 * a renegotiation. */
4966 ssl->in_hdr[0] = rec.type;
4967 ssl->in_msg = rec.buf + rec.data_offset;
4968 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004972}
4973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004975{
Janos Follath865b3eb2019-12-16 11:46:15 +00004976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004977
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004978 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004979 * Handle particular types of records
4980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4982 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4983 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004984 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004985 }
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4988 if (ssl->in_msglen != 1) {
4989 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4990 ssl->in_msglen));
4991 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004992 }
4993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if (ssl->in_msg[0] != 1) {
4995 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4996 ssl->in_msg[0]));
4997 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004998 }
4999
5000#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01005002 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
5004 if (ssl->handshake == NULL) {
5005 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
5006 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005007 }
5008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
5010 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005011 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005012#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005013
Ronald Cron6f135e12021-12-08 16:57:54 +01005014#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005016#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 MBEDTLS_SSL_DEBUG_MSG(1,
5018 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5019 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005020#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 MBEDTLS_SSL_DEBUG_MSG(1,
5022 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5023 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005024#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5025 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005026#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005027 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5030 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005031 /* Note: Standard allows for more than one 2 byte alert
5032 to be packed in a single message, but Mbed TLS doesn't
5033 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5035 ssl->in_msglen));
5036 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005037 }
5038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5040 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005041
5042 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005043 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5046 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5047 ssl->in_msg[1]));
5048 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005049 }
5050
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5052 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5053 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5054 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005055 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005056
5057#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5059 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5060 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005061 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005063 }
5064#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005065 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005066 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005067 }
5068
Hanno Beckerc76c6192017-06-06 10:03:17 +01005069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005071 /* Drop unexpected ApplicationData records,
5072 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5074 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005075#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5077 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005078#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 ) {
5080 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5081 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005082 }
5083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if (ssl->handshake != NULL &&
5085 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5086 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005087 }
5088 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005089#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005092}
5093
Gilles Peskine449bd832023-01-11 14:50:10 +01005094int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005095{
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 return mbedtls_ssl_send_alert_message(ssl,
5097 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5098 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005099}
5100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5102 unsigned char level,
5103 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005104{
Janos Follath865b3eb2019-12-16 11:46:15 +00005105 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005106
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 if (ssl == NULL || ssl->conf == NULL) {
5108 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5109 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (ssl->out_left != 0) {
5112 return mbedtls_ssl_flush_output(ssl);
5113 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5116 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005118 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005119 ssl->out_msglen = 2;
5120 ssl->out_msg[0] = level;
5121 ssl->out_msg[1] = message;
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5124 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5125 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005126 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005128
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005130}
5131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005133{
Janos Follath865b3eb2019-12-16 11:46:15 +00005134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005138 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005139 ssl->out_msglen = 1;
5140 ssl->out_msg[0] = 1;
5141
Paul Bakker5121ce52009-01-03 21:22:43 +00005142 ssl->state++;
5143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5145 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5146 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005147 }
5148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005152}
5153
Gilles Peskine449bd832023-01-11 14:50:10 +01005154int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005155{
Janos Follath865b3eb2019-12-16 11:46:15 +00005156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5161 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5162 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005163 }
5164
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5166 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5167 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5168 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5169 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005170 }
5171
Hanno Beckere678eaa2018-08-21 14:57:46 +01005172 /* CCS records are only accepted if they have length 1 and content '1',
5173 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005174
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005175 /*
5176 * Switch to our negotiated transform and session parameters for inbound
5177 * data.
5178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005181 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005182#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005183 ssl->session_in = ssl->session_negotiate;
5184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005185#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005189#endif
5190
5191 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (++ssl->in_epoch == 0) {
5193 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005194 /* This is highly unlikely to happen for legitimate reasons, so
5195 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005197 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005203
Paul Bakker5121ce52009-01-03 21:22:43 +00005204 ssl->state++;
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005209}
5210
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211/* Once ssl->out_hdr as the address of the beginning of the
5212 * next outgoing record is set, deduce the other pointers.
5213 *
5214 * Note: For TLS, we save the implicit record sequence number
5215 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5216 * and the caller has to make sure there's space for this.
5217 */
5218
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005219static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005221{
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005223}
5224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5226 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005227{
5228#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005230 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005231#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005232 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005233 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005235 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005237#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005238 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005239#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005240 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005242#endif
5243 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005244 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005245#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005246 ssl->out_cid = ssl->out_len;
5247#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005248 ssl->out_iv = ssl->out_hdr + 5;
5249 }
5250
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005251 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005252 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 if (transform != NULL) {
5254 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5255 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005256}
5257
5258/* Once ssl->in_hdr as the address of the beginning of the
5259 * next incoming record is set, deduce the other pointers.
5260 *
5261 * Note: For TLS, we save the implicit record sequence number
5262 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5263 * and the caller has to make sure there's space for this.
5264 */
5265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005267{
Hanno Becker79594fd2019-05-08 09:38:41 +01005268 /* This function sets the pointers to match the case
5269 * of unprotected TLS/DTLS records, with both ssl->in_iv
5270 * and ssl->in_msg pointing to the beginning of the record
5271 * content.
5272 *
5273 * When decrypting a protected record, ssl->in_msg
5274 * will be shifted to point to the beginning of the
5275 * record plaintext.
5276 */
5277
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005278#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005280 /* This sets the header pointers to match records
5281 * without CID. When we receive a record containing
5282 * a CID, the fields are shifted accordingly in
5283 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005284 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005285#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005286 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005287 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005288#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005289 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005290#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005291 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005293#endif
5294 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005295 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005296 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005297#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005298 ssl->in_cid = ssl->in_len;
5299#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005300 ssl->in_iv = ssl->in_hdr + 5;
5301 }
5302
Hanno Becker79594fd2019-05-08 09:38:41 +01005303 /* This will be adjusted at record decryption time. */
5304 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005305}
5306
Paul Bakker5121ce52009-01-03 21:22:43 +00005307/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005308 * Setup an SSL context
5309 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005310
Gilles Peskine449bd832023-01-11 14:50:10 +01005311void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005312{
5313 /* Set the incoming and outgoing record pointers. */
5314#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005316 ssl->out_hdr = ssl->out_buf;
5317 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005319#endif /* MBEDTLS_SSL_PROTO_DTLS */
5320 {
Hanno Becker12078f42021-03-02 15:28:41 +00005321 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005322 ssl->out_hdr = ssl->out_buf + 8;
5323 ssl->in_hdr = ssl->in_buf + 8;
5324 }
5325
5326 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5328 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005329}
5330
Paul Bakker5121ce52009-01-03 21:22:43 +00005331/*
5332 * SSL get accessors
5333 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005334size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005335{
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005337}
5338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005340{
5341 /*
5342 * Case A: We're currently holding back
5343 * a message for further processing.
5344 */
5345
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if (ssl->keep_current_message == 1) {
5347 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5348 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005349 }
5350
5351 /*
5352 * Case B: Further records are pending in the current datagram.
5353 */
5354
5355#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5357 ssl->in_left > ssl->next_record_offset) {
5358 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5359 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005360 }
5361#endif /* MBEDTLS_SSL_PROTO_DTLS */
5362
5363 /*
5364 * Case C: A handshake message is being processed.
5365 */
5366
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5368 MBEDTLS_SSL_DEBUG_MSG(3,
5369 ("ssl_check_pending: more handshake messages within current record"));
5370 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005371 }
5372
5373 /*
5374 * Case D: An application data message is being processed
5375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (ssl->in_offt != NULL) {
5377 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5378 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005379 }
5380
5381 /*
5382 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005383 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005384 * we implement support for multiple alerts in single records.
5385 */
5386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5388 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005389}
5390
Paul Bakker43ca69c2011-01-15 17:35:19 +00005391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005393{
Hanno Becker3136ede2018-08-17 15:28:19 +01005394 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005396 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005397#if defined(MBEDTLS_USE_PSA_CRYPTO)
5398 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5399 psa_key_type_t key_type;
5400#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (transform == NULL) {
5405 return (int) out_hdr_len;
5406 }
Hanno Becker78640902018-08-13 16:35:15 +01005407
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005408
5409#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if (transform->psa_alg == PSA_ALG_GCM ||
5411 transform->psa_alg == PSA_ALG_CCM ||
5412 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5413 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5414 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005415 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5417 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5418 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005421
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005422 /* Expansion due to the addition of the MAC. */
5423 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005424
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005425 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005426 * Theoretically up to 256 bytes, but we never use
5427 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005428 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005429
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005430 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005431 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005432#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005433 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005434#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 } else {
5436 MBEDTLS_SSL_DEBUG_MSG(1,
5437 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5438 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005439 }
5440#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 case MBEDTLS_MODE_GCM:
5443 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005444 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005446 transform_expansion = transform->minlen;
5447 break;
5448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005449 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005450
5451 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005453
Hanno Becker3136ede2018-08-17 15:28:19 +01005454 /* Expansion due to the addition of the MAC. */
5455 transform_expansion += transform->maclen;
5456
5457 /* Expansion due to the addition of CBC padding;
5458 * Theoretically up to 256 bytes, but we never use
5459 * more than the block size of the underlying cipher. */
5460 transform_expansion += block_size;
5461
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005462 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005463 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005465 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005466#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005467
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005468 break;
5469
5470 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005473 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005474#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005475
Hanno Beckera0e20d02019-05-15 14:03:01 +01005476#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005478 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005480#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005481
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005483}
5484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005486/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005487 * Check record counters and renegotiate if they're above the limit.
5488 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005489MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005490static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005491{
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005493 int in_ctr_cmp;
5494 int out_ctr_cmp;
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5499 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005500 }
5501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5503 &ssl->conf->renego_period[ep_len],
5504 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5505 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005506 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5510 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005511 }
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5514 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005515}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005517
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005518#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5519
5520#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005522static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005523{
5524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5526 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5527 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005528 }
5529
5530 ssl->keep_current_message = 1;
5531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5533 mbedtls_ssl_handshake_set_state(ssl,
5534 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005535
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005537}
5538#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5539
Jerry Yua0446a02022-07-13 11:22:55 +08005540MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005541static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005542{
5543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005545
5546#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5548 int ret = ssl_tls13_check_new_session_ticket(ssl);
5549 if (ret != 0) {
5550 return ret;
5551 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005552 }
5553#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5554
5555 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005557}
5558#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5559
5560#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005561/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005562 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005563 * may only be sent for the purpose of initiating renegotiations.
5564 *
5565 * This function is introduced as a separate helper since the handling
5566 * of post-handshake handshake messages changes significantly in TLS 1.3,
5567 * and having a helper function allows to distinguish between TLS <= 1.2 and
5568 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5569 */
Jerry Yua0446a02022-07-13 11:22:55 +08005570MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005571static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005572{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005574
5575 /*
5576 * - For client-side, expect SERVER_HELLO_REQUEST.
5577 * - For server-side, expect CLIENT_HELLO.
5578 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5579 */
5580
5581#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5583 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5584 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5585 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005586
5587 /* With DTLS, drop the packet (probably from last handshake) */
5588#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5590 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005591 }
5592#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005594 }
5595#endif /* MBEDTLS_SSL_CLI_C */
5596
5597#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5599 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5600 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005601
5602 /* With DTLS, drop the packet (probably from last handshake) */
5603#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5605 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005606 }
5607#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005609 }
5610#endif /* MBEDTLS_SSL_SRV_C */
5611
5612#if defined(MBEDTLS_SSL_RENEGOTIATION)
5613 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5615 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5616 ssl->conf->allow_legacy_renegotiation ==
5617 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005618 /*
5619 * Accept renegotiation request
5620 */
5621
5622 /* DTLS clients need to know renego is server-initiated */
5623#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5625 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005626 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5627 }
5628#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 ret = mbedtls_ssl_start_renegotiation(ssl);
5630 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5631 ret != 0) {
5632 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5633 ret);
5634 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005637#endif /* MBEDTLS_SSL_RENEGOTIATION */
5638 {
5639 /*
5640 * Refuse renegotiation
5641 */
5642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005644
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5646 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5647 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5648 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005649 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005650 }
5651
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005653}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005654#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5655
5656MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005657static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005658{
5659 /* Check protocol version and dispatch accordingly. */
5660#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5662 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005663 }
5664#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5665
5666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5668 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005669 }
5670#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5671
5672 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005674}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005675
Paul Bakker48916f92012-09-16 19:57:18 +00005676/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005677 * Receive application data decrypted from the SSL layer
5678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005679int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005680{
Janos Follath865b3eb2019-12-16 11:46:15 +00005681 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005682 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005683
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 if (ssl == NULL || ssl->conf == NULL) {
5685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5686 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005687
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5692 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5693 return ret;
5694 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005695
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 if (ssl->handshake != NULL &&
5697 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5698 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5699 return ret;
5700 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005701 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005702 }
5703#endif
5704
Hanno Becker4a810fb2017-05-24 16:27:30 +01005705 /*
5706 * Check if renegotiation is necessary and/or handshake is
5707 * in process. If yes, perform/continue, and fall through
5708 * if an unexpected packet is received while the client
5709 * is waiting for the ServerHello.
5710 *
5711 * (There is no equivalent to the last condition on
5712 * the server-side as it is not treated as within
5713 * a handshake while waiting for the ClientHello
5714 * after a renegotiation request.)
5715 */
5716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 ret = ssl_check_ctr_renegotiate(ssl);
5719 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5720 ret != 0) {
5721 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5722 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005723 }
5724#endif
5725
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5727 ret = mbedtls_ssl_handshake(ssl);
5728 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5729 ret != 0) {
5730 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5731 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005732 }
5733 }
5734
Hanno Beckere41158b2017-10-23 13:30:32 +01005735 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005737 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if (ssl->f_get_timer != NULL &&
5739 ssl->f_get_timer(ssl->p_timer) == -1) {
5740 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005741 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5744 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5745 return 0;
5746 }
Paul Bakker831a7552011-05-18 13:32:51 +00005747
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5749 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005750 }
5751
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 if (ssl->in_msglen == 0 &&
5753 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005754 /*
5755 * OpenSSL sends empty messages to randomize the IV
5756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5758 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5759 return 0;
5760 }
Paul Bakker831a7552011-05-18 13:32:51 +00005761
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5763 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005764 }
5765 }
5766
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5768 ret = ssl_handle_hs_message_post_handshake(ssl);
5769 if (ret != 0) {
5770 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5771 ret);
5772 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005773 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005774
Hanno Beckerf26cc722021-04-21 07:30:13 +01005775 /* At this point, we don't know whether the renegotiation triggered
5776 * by the post-handshake message has been completed or not. The cases
5777 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005778 * 1) The renegotiation is complete. In this case, no new record
5779 * has been read yet.
5780 * 2) The renegotiation is incomplete because the client received
5781 * an application data record while awaiting the ServerHello.
5782 * 3) The renegotiation is incomplete because the client received
5783 * a non-handshake, non-application data message while awaiting
5784 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005785 *
5786 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005787 * - For 1), the next iteration will read a new record and check
5788 * if it's application data.
5789 * - For 2), the loop condition isn't satisfied as application data
5790 * is present, hence continue is the same as break
5791 * - For 3), the loop condition is satisfied and read_record
5792 * will re-deliver the message that was held back by the client
5793 * when expecting the ServerHello.
5794 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005795
Hanno Becker90333da2017-10-10 11:27:13 +01005796 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005797 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005798#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5800 if (ssl->conf->renego_max_records >= 0) {
5801 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5802 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5803 "but not honored by client"));
5804 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005805 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005806 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005807 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005808#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005810 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5812 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5813 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005814 }
5815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5817 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5818 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005819 }
5820
5821 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005822
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005823 /* We're going to return something now, cancel timer,
5824 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5826 mbedtls_ssl_set_timer(ssl, 0);
5827 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005828
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005829#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005830 /* If we requested renego but received AppData, resend HelloRequest.
5831 * Do it now, after setting in_offt, to avoid taking this branch
5832 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005833#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5835 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5836 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5837 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5838 ret);
5839 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005840 }
5841 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005842#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005843#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005844 }
5845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005847 ? len : ssl->in_msglen;
5848
ashesman937d6d52022-02-17 11:08:27 +13005849 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005850 memcpy(buf, ssl->in_offt, n);
5851 ssl->in_msglen -= n;
5852 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005853
gabor-mezei-arma3214132020-07-15 10:55:00 +02005854 /* Zeroising the plaintext buffer to erase unused application data
5855 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005859 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005860 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005861 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005863 /* more data available */
5864 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005865 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005870}
5871
5872/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005873 * Send application data to be encrypted by the SSL layer, taking care of max
5874 * fragment length and buffer size.
5875 *
5876 * According to RFC 5246 Section 6.2.1:
5877 *
5878 * Zero-length fragments of Application data MAY be sent as they are
5879 * potentially useful as a traffic analysis countermeasure.
5880 *
5881 * Therefore, it is possible that the input message length is 0 and the
5882 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005883 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005884MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005885static int ssl_write_real(mbedtls_ssl_context *ssl,
5886 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005887{
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005889 const size_t max_len = (size_t) ret;
5890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (ret < 0) {
5892 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5893 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005894 }
5895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5899 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5900 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5901 " > %" MBEDTLS_PRINTF_SIZET,
5902 len, max_len));
5903 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5904 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005905#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005907 }
Paul Bakker887bd502011-06-08 13:10:54 +00005908
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005910 /*
5911 * The user has previously tried to send the data and
5912 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5913 * written. In this case, we expect the high-level write function
5914 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5917 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5918 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005919 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005921 /*
5922 * The user is trying to send a message the first time, so we need to
5923 * copy the data into the internal buffers and setup the data structure
5924 * to keep track of partial writes
5925 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005926 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005927 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005928 if (len > 0) {
5929 memcpy(ssl->out_msg, buf, len);
5930 }
Paul Bakker887bd502011-06-08 13:10:54 +00005931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5933 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5934 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005935 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005936 }
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005939}
5940
5941/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005942 * Write application data (public-facing wrapper)
5943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005944int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005945{
Janos Follath865b3eb2019-12-16 11:46:15 +00005946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 if (ssl == NULL || ssl->conf == NULL) {
5951 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5952 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005953
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005954#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5956 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5957 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005958 }
5959#endif
5960
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5962 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5963 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5964 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005965 }
5966 }
5967
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005971
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005973}
5974
5975/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005976 * Notify the peer that the connection is being closed
5977 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005979{
Janos Follath865b3eb2019-12-16 11:46:15 +00005980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (ssl == NULL || ssl->conf == NULL) {
5983 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5984 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5989 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5990 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5991 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5992 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5993 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005994 }
5995 }
5996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006000}
6001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006003{
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006005 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006007
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006008#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 psa_destroy_key(transform->psa_key_enc);
6010 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006011#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6013 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006014#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006015
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006016#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006017#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 psa_destroy_key(transform->psa_mac_enc);
6019 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006020#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 mbedtls_md_free(&transform->md_ctx_enc);
6022 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006023#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006024#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006027}
6028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6030 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006031{
Jerry Yuc7875b52021-09-05 21:05:50 +08006032 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006034}
6035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6037 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006038{
6039 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006041}
6042
Hanno Becker0271f962018-08-16 13:23:47 +01006043#if defined(MBEDTLS_SSL_PROTO_DTLS)
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006046{
6047 unsigned offset;
6048 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006051 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 }
Hanno Becker0271f962018-08-16 13:23:47 +01006053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6057 ssl_buffering_free_slot(ssl, offset);
6058 }
Hanno Beckere605b192018-08-21 15:59:07 +01006059}
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6062 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006063{
6064 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6065 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006068 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006072 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006073 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006075 }
6076}
6077
6078#endif /* MBEDTLS_SSL_PROTO_DTLS */
6079
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006080/*
6081 * Convert version numbers to/from wire format
6082 * and, for DTLS, to/from TLS equivalent.
6083 *
6084 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006085 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006086 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006087 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006088 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006089void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6090 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006091{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006092 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006093#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006095 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006097 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006098#else
6099 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006100#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006101 {
6102 tls_version_formatted = (uint16_t) tls_version;
6103 }
6104 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006105}
6106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6108 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006109{
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006111#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006113 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6115 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006116#else
6117 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006118#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006119 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006120}
6121
Jerry Yue7047812021-09-13 19:26:39 +08006122/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006123 * Send pending fatal alert.
6124 * 0, No alert message.
6125 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6126 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006127 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006128int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006129{
6130 int ret;
6131
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006132 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (ssl->send_alert == 0) {
6134 return 0;
6135 }
Jerry Yu394ece62021-09-14 22:17:21 +08006136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 ret = mbedtls_ssl_send_alert_message(ssl,
6138 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6139 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006140
Jerry Yu3bf1f972021-09-22 21:37:18 +08006141 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6142 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006145 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006146 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 if (ret != 0) {
6149 return ret;
6150 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006153}
6154
Jerry Yu394ece62021-09-14 22:17:21 +08006155/*
6156 * Set pending fatal alert flag.
6157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006158void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6159 unsigned char alert_type,
6160 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006161{
6162 ssl->send_alert = 1;
6163 ssl->alert_type = alert_type;
6164 ssl->alert_reason = alert_reason;
6165}
6166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006167#endif /* MBEDTLS_SSL_TLS_C */