blob: 85632a1c31bfcbbe96604854ca7c285d71a13f75 [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)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001507 size_t padlen = 0, correct = 1;
1508#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001510 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 * the description of ssl_extract_add_data_from_record().
1512 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001513#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1514 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1515#else
1516 unsigned char add_data[13];
1517#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001518 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519
Hanno Beckera18d1322018-01-03 14:27:32 +00001520#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001521 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 ((void) ssl);
1523#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1526 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 rec->buf == NULL ||
1528 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 rec->buf_len - rec->data_offset < rec->data_len) {
1530 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1531 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001532 }
1533
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001536
Hanno Beckera0e20d02019-05-15 14:03:01 +01001537#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001538 /*
1539 * Match record's CID with incoming CID.
1540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 if (rec->cid_len != transform->in_cid_len ||
1542 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1543 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001544 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001545#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001546
Hanno Beckerd086bf02021-03-22 13:01:27 +00001547#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001549 /* The only supported stream cipher is "NULL",
1550 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001552#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001553#if defined(MBEDTLS_GCM_C) || \
1554 defined(MBEDTLS_CCM_C) || \
1555 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001557 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001558 unsigned char *dynamic_iv;
1559 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001560#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001561 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001562#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001563
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001564 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001565 * Extract dynamic part of nonce for AEAD decryption.
1566 *
1567 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1568 * part of the IV is prepended to the ciphertext and
1569 * can be chosen freely - in particular, it need not
1570 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 dynamic_iv_len = sizeof(rec->ctr);
1573 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1574 if (rec->data_len < dynamic_iv_len) {
1575 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1576 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1577 rec->data_len,
1578 dynamic_iv_len));
1579 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001580 }
1581 dynamic_iv = data;
1582
1583 data += dynamic_iv_len;
1584 rec->data_offset += dynamic_iv_len;
1585 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001587 dynamic_iv = rec->ctr;
1588 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001589
1590 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if (rec->data_len < transform->taglen) {
1592 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1593 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1594 rec->data_len,
1595 transform->taglen));
1596 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001597 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001598 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001599
Hanno Beckerdf8be222020-05-21 15:30:57 +01001600 /*
1601 * Prepare nonce from dynamic and static parts.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 ssl_build_record_nonce(iv, sizeof(iv),
1604 transform->iv_dec,
1605 transform->fixed_ivlen,
1606 dynamic_iv,
1607 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001608
Hanno Beckerdf8be222020-05-21 15:30:57 +01001609 /*
1610 * Build additional data for AEAD encryption.
1611 * This depends on the TLS version.
1612 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1614 transform->tls_version,
1615 transform->taglen);
1616 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1617 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618
Hanno Beckerd96a6522019-07-10 13:55:25 +01001619 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001620 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001621 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001622 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001623 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1626 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1627 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001628
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001629 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001630 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001631 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001632#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 status = psa_aead_decrypt(transform->psa_key_dec,
1634 transform->psa_alg,
1635 iv, transform->ivlen,
1636 add_data, add_data_len,
1637 data, rec->data_len + transform->taglen,
1638 data, rec->buf_len - (data - rec->buf),
1639 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001642 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1644 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001645 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001646#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1648 iv, transform->ivlen,
1649 add_data, add_data_len,
1650 data, rec->data_len + transform->taglen, /* src */
1651 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1652 transform->taglen)) != 0) {
1653 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1656 return MBEDTLS_ERR_SSL_INVALID_MAC;
1657 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001658
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001660 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001661#endif /* MBEDTLS_USE_PSA_CRYPTO */
1662
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001663 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001664
Hanno Beckerd96a6522019-07-10 13:55:25 +01001665 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 if (olen != rec->data_len) {
1667 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1668 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001669 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001670 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001672#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1674 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001675 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001676#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001677 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001678 size_t part_len;
1679 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001681
Paul Bakker5121ce52009-01-03 21:22:43 +00001682 /*
Paul Bakker45829992013-01-03 14:52:21 +01001683 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001684 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001685#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001686 /* The ciphertext is prefixed with the CBC IV. */
1687 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001688#endif
Paul Bakker45829992013-01-03 14:52:21 +01001689
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001690 /* Size considerations:
1691 *
1692 * - The CBC cipher text must not be empty and hence
1693 * at least of size transform->ivlen.
1694 *
1695 * Together with the potential IV-prefix, this explains
1696 * the first of the two checks below.
1697 *
1698 * - The record must contain a MAC, either in plain or
1699 * encrypted, depending on whether Encrypt-then-MAC
1700 * is used or not.
1701 * - If it is, the message contains the IV-prefix,
1702 * the CBC ciphertext, and the MAC.
1703 * - If it is not, the padded plaintext, and hence
1704 * the CBC ciphertext, has at least length maclen + 1
1705 * because there is at least the padding length byte.
1706 *
1707 * As the CBC ciphertext is not empty, both cases give the
1708 * lower bound minlen + maclen + 1 on the record size, which
1709 * we test for in the second check below.
1710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 if (rec->data_len < minlen + transform->ivlen ||
1712 rec->data_len < minlen + transform->maclen + 1) {
1713 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1714 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1715 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1716 "+ 1 ) ( + expl IV )",
1717 rec->data_len,
1718 transform->ivlen,
1719 transform->maclen));
1720 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001721 }
1722
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001723 /*
1724 * Authenticate before decrypt if enabled
1725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001728#if defined(MBEDTLS_USE_PSA_CRYPTO)
1729 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1730#else
Hanno Becker992b6872017-11-09 18:57:39 +00001731 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001732#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001735
Hanno Beckerd96a6522019-07-10 13:55:25 +01001736 /* Update data_len in tandem with add_data.
1737 *
1738 * The subtraction is safe because of the previous check
1739 * data_len >= minlen + maclen + 1.
1740 *
1741 * Afterwards, we know that data + data_len is followed by at
1742 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001743 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001744 *
1745 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001746 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1748 transform->tls_version,
1749 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001750
Hanno Beckerd96a6522019-07-10 13:55:25 +01001751 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1753 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001754#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1756 transform->psa_mac_alg);
1757 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001758 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 status = psa_mac_update(&operation, add_data, add_data_len);
1762 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001763 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 status = psa_mac_update(&operation, data, rec->data_len);
1767 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001768 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001770
1771 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1773 transform->maclen);
1774 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001775 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001777#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1779 add_data_len);
1780 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001781 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 }
1783 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1784 data, rec->data_len);
1785 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001786 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 }
1788 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
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_reset(&transform->md_ctx_dec);
1793 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001794 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1798 transform->maclen);
1799 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1800 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001801
Hanno Beckerd96a6522019-07-10 13:55:25 +01001802 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1804 transform->maclen) != 0) {
1805 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001806 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1807 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001808 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001809#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001810 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001813#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001814 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 status = psa_mac_abort(&operation);
1816 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001817 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001819#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001821#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (ret != 0) {
1823 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1824 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1825 }
1826 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001827 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001828 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001830
1831 /*
1832 * Check length sanity
1833 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001834
1835 /* We know from above that data_len > minlen >= 0,
1836 * so the following check in particular implies that
1837 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 if (rec->data_len % transform->ivlen != 0) {
1839 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1840 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1841 rec->data_len, transform->ivlen));
1842 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001843 }
1844
TRodziewicz0f82ec62021-05-12 17:49:18 +02001845#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001846 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001847 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001848 */
TRodziewicz345165c2021-07-06 13:42:11 +02001849 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001851
TRodziewicz345165c2021-07-06 13:42:11 +02001852 data += transform->ivlen;
1853 rec->data_offset += transform->ivlen;
1854 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001855#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001856
Hanno Beckerd96a6522019-07-10 13:55:25 +01001857 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1858
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001859#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 status = psa_cipher_decrypt_setup(&cipher_op,
1861 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001864 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1866 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001867 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001872 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1874 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001875 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 status = psa_cipher_update(&cipher_op,
1878 data, rec->data_len,
1879 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001882 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1884 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001885 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001886
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 status = psa_cipher_finish(&cipher_op,
1888 data + olen, rec->data_len - olen,
1889 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001892 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1894 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001895 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001896
1897 olen += part_len;
1898#else
1899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1901 transform->iv_dec, transform->ivlen,
1902 data, rec->data_len, data, &olen)) != 0) {
1903 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1904 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001905 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001906#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001907
Hanno Beckerd96a6522019-07-10 13:55:25 +01001908 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (rec->data_len != olen) {
1910 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1911 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001912 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001913
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001914 /* Safe since data_len >= minlen + maclen + 1, so after having
1915 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001916 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1917 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001918 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001921 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 rec->data_len,
1923 padlen + 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001924 correct = mbedtls_ct_size_if_else_0(ge, correct);
1925 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 if (rec->data_len < transform->maclen + padlen + 1) {
1929 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1930 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1931 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1932 rec->data_len,
1933 transform->maclen,
1934 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001935 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001936#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001937 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 rec->data_len,
1939 transform->maclen + padlen + 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001940 correct = mbedtls_ct_size_if_else_0(ge, correct);
1941 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001942 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001943
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001944 padlen++;
1945
1946 /* Regardless of the validity of the padding,
1947 * we have data_len >= padlen here. */
1948
TRodziewicz0f82ec62021-05-12 17:49:18 +02001949#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001950 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 * consecutive memory reads at the end of the record
1952 * plaintext buffer. In order to hide the length and
1953 * validity of the padding, always perform exactly
1954 * `min(256,plaintext_len)` reads (but take into account
1955 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001956 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001958
1959 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001961 size_t const padding_idx = rec->data_len - padlen;
1962 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1963 size_t const start_idx = rec->data_len - num_checks;
1964 size_t idx;
1965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001967 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 * (check[idx] == padlen - 1);
1969 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001970 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001971 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001972 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001973 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001974 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001975 }
Tom Cosgrove9d8a7d62023-09-12 16:01:52 +01001976 correct = mbedtls_ct_size_if_else_0(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (padlen > 0 && correct == 0) {
1980 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1981 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001982#endif
Dave Rodgman98ddc012023-08-10 12:11:31 +01001983 padlen = mbedtls_ct_size_if_else_0(mbedtls_ct_bool(correct), padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001984
TRodziewicz0f82ec62021-05-12 17:49:18 +02001985#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001986
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001987 /* If the padding was found to be invalid, padlen == 0
1988 * and the subtraction is safe. If the padding was found valid,
1989 * padlen hasn't been changed and the previous assertion
1990 * data_len >= padlen still holds. */
1991 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001993#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001994 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1996 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001997 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001998
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001999#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
2001 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002002#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002003
2004 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01002005 * Authenticate if not done yet.
2006 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002007 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002008#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002010 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2011 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002012
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002013 /* If the initial value of padlen was such that
2014 * data_len < maclen + padlen + 1, then padlen
2015 * got reset to 1, and the initial check
2016 * data_len >= minlen + maclen + 1
2017 * guarantees that at this point we still
2018 * have at least data_len >= maclen.
2019 *
2020 * If the initial value of padlen was such that
2021 * data_len >= maclen + padlen + 1, then we have
2022 * subtracted either padlen + 1 (if the padding was correct)
2023 * or 0 (if the padding was incorrect) since then,
2024 * hence data_len >= maclen in any case.
2025 */
2026 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2028 transform->tls_version,
2029 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002030
TRodziewicz0f82ec62021-05-12 17:49:18 +02002031#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002032 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 * The next two sizes are the minimum and maximum values of
2034 * data_len over all padlen values.
2035 *
2036 * They're independent of padlen, since we previously did
2037 * data_len -= padlen.
2038 *
2039 * Note that max_len + maclen is never more than the buffer
2040 * length, as we previously did in_msglen -= maclen too.
2041 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002042 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002044
Neil Armstronge8589962022-02-25 15:14:29 +01002045#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2047 transform->psa_mac_alg,
2048 add_data, add_data_len,
2049 data, rec->data_len, min_len, max_len,
2050 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002051#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2053 add_data, add_data_len,
2054 data, rec->data_len, min_len, max_len,
2055 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002056#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 if (ret != 0) {
2058 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002059 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002060 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 mbedtls_ct_memcpy_offset(mac_peer, data,
2063 rec->data_len,
2064 min_len, max_len,
2065 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002068#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2070 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002071#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2074 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002077#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002078 correct = 0;
2079 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002080 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082hmac_failed_etm_disabled:
2083 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2084 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2085 if (ret != 0) {
2086 return ret;
2087 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002088 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002089
2090 /*
2091 * Finally check the correct flag
2092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (correct == 0) {
2094 return MBEDTLS_ERR_SSL_INVALID_MAC;
2095 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002096#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002097
2098 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (auth_done != 1) {
2100 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2101 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002102 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
Ronald Cron6f135e12021-12-08 16:57:54 +01002104#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002106 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2108 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (ret != 0) {
2111 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2112 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002113 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002114#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002115
Hanno Beckera0e20d02019-05-15 14:03:01 +01002116#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (rec->cid_len != 0) {
2118 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2119 &rec->type);
2120 if (ret != 0) {
2121 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2122 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002123 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002124#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002129}
2130
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002131#undef MAC_NONE
2132#undef MAC_PLAINTEXT
2133#undef MAC_CIPHERTEXT
2134
Paul Bakker5121ce52009-01-03 21:22:43 +00002135/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002136 * Fill the input message buffer by appending data to it.
2137 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002138 *
2139 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2140 * available (from this read and/or a previous one). Otherwise, an error code
2141 * is returned (possibly EOF or WANT_READ).
2142 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002143 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2144 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2145 * since we always read a whole datagram at once.
2146 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002147 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002148 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002149 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002151{
Janos Follath865b3eb2019-12-16 11:46:15 +00002152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002153 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002154#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2155 size_t in_buf_len = ssl->in_buf_len;
2156#else
2157 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2158#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2163 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002165 }
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2168 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002170 }
2171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002174 uint32_t timeout;
2175
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002176 /*
2177 * The point is, we need to always read a full datagram at once, so we
2178 * sometimes read more then requested, and handle the additional data.
2179 * It could be the rest of the current record (while fetching the
2180 * header) and/or some other records in the same datagram.
2181 */
2182
2183 /*
2184 * Move to the next record in the already read datagram if applicable
2185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 if (ssl->next_record_offset != 0) {
2187 if (ssl->in_left < ssl->next_record_offset) {
2188 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2189 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002190 }
2191
2192 ssl->in_left -= ssl->next_record_offset;
2193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 if (ssl->in_left != 0) {
2195 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2196 MBEDTLS_PRINTF_SIZET,
2197 ssl->next_record_offset));
2198 memmove(ssl->in_hdr,
2199 ssl->in_hdr + ssl->next_record_offset,
2200 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002201 }
2202
2203 ssl->next_record_offset = 0;
2204 }
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2207 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2208 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002209
2210 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002211 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002212 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 if (nb_want <= ssl->in_left) {
2214 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2215 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002216 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002217
2218 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002219 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002220 * are not at the beginning of a new record, the caller did something
2221 * wrong.
2222 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (ssl->in_left != 0) {
2224 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2225 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002226 }
2227
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002228 /*
2229 * Don't even try to read if time's out already.
2230 * This avoids by-passing the timer when repeatedly receiving messages
2231 * that will end up being dropped.
2232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (mbedtls_ssl_check_timer(ssl) != 0) {
2234 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002235 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 } else {
2237 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002242 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->f_recv_timeout != NULL) {
2248 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2249 timeout);
2250 } else {
2251 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2252 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (ret == 0) {
2257 return MBEDTLS_ERR_SSL_CONN_EOF;
2258 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002259 }
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2262 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2263 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2266 if (ssl_double_retransmit_timeout(ssl) != 0) {
2267 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2268 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002269 }
2270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2272 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2273 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002274 }
2275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002277 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2280 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2281 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2282 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2283 ret);
2284 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002285 }
2286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002288 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002290 }
2291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if (ret < 0) {
2293 return ret;
2294 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002295
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002296 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002298#endif
2299 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2301 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2302 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002305 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002308 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 } else {
2310 if (ssl->f_recv_timeout != NULL) {
2311 ret = ssl->f_recv_timeout(ssl->p_bio,
2312 ssl->in_hdr + ssl->in_left, len,
2313 ssl->conf->read_timeout);
2314 } else {
2315 ret = ssl->f_recv(ssl->p_bio,
2316 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002317 }
2318 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2321 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2322 ssl->in_left, nb_want));
2323 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 if (ret == 0) {
2326 return MBEDTLS_ERR_SSL_CONN_EOF;
2327 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 if (ret < 0) {
2330 return ret;
2331 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002332
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002333 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 MBEDTLS_SSL_DEBUG_MSG(1,
2335 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2336 " were requested",
2337 ret, len));
2338 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002339 }
2340
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002341 ssl->in_left += ret;
2342 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002343 }
2344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002348}
2349
2350/*
2351 * Flush any data not yet written
2352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002354{
Janos Follath865b3eb2019-12-16 11:46:15 +00002355 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002356 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (ssl->f_send == NULL) {
2361 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002363 }
2364
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002365 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (ssl->out_left == 0) {
2367 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2368 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002369 }
2370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 while (ssl->out_left > 0) {
2372 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2373 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2374 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002375
Hanno Becker2b1e3542018-08-06 11:19:13 +01002376 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 if (ret <= 0) {
2382 return ret;
2383 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002384
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002385 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 MBEDTLS_SSL_DEBUG_MSG(1,
2387 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2388 " bytes were sent",
2389 ret, ssl->out_left));
2390 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002391 }
2392
Paul Bakker5121ce52009-01-03 21:22:43 +00002393 ssl->out_left -= ret;
2394 }
2395
Hanno Becker2b1e3542018-08-06 11:19:13 +01002396#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002398 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002400#endif
2401 {
2402 ssl->out_hdr = ssl->out_buf + 8;
2403 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002409}
2410
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002411/*
2412 * Functions to handle the DTLS retransmission state machine
2413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002415/*
2416 * Append current handshake message to current outgoing flight
2417 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002419static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2423 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2424 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425
2426 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2428 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2429 sizeof(mbedtls_ssl_flight_item)));
2430 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002431 }
2432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2434 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2435 ssl->out_msglen));
2436 mbedtls_free(msg);
2437 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002438 }
2439
2440 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002442 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002443 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002444 msg->next = NULL;
2445
2446 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002448 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002452 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454 cur->next = msg;
2455 }
2456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2458 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002459}
2460
2461/*
2462 * Free the current flight of handshake messages
2463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 mbedtls_ssl_flight_item *cur = flight;
2467 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002470 next = cur->next;
2471
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 mbedtls_free(cur->p);
2473 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002474
2475 cur = next;
2476 }
2477}
2478
2479/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002480 * Swap transform_out and out_ctr with the alternative ones
2481 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002483static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002484{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002486 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2489 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2490 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002491 }
2492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002494
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002495 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002496 tmp_transform = ssl->transform_out;
2497 ssl->transform_out = ssl->handshake->alt_transform_out;
2498 ssl->handshake->alt_transform_out = tmp_transform;
2499
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002500 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2502 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2503 sizeof(ssl->cur_out_ctr));
2504 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2505 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002506
2507 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002511}
2512
2513/*
2514 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002516int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517{
2518 int ret = 0;
2519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002527}
2528
2529/*
2530 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002531 *
2532 * Need to remember the current message in case flush_output returns
2533 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002534 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002536int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002537{
Janos Follath865b3eb2019-12-16 11:46:15 +00002538 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2542 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002543
2544 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002545 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 ret = ssl_swap_epochs(ssl);
2547 if (ret != 0) {
2548 return ret;
2549 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002552 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002555 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002556 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002557
Hanno Beckere1dcb032018-08-17 16:47:58 +01002558 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2560 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002561
Ronald Cron00d012f22022-03-08 15:57:12 +01002562 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002564
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002565 /* Swap epochs before sending Finished: we can't do it after
2566 * sending ChangeCipherSpec, in case write returns WANT_READ.
2567 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2569 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2570 ret = ssl_swap_epochs(ssl);
2571 if (ret != 0) {
2572 return ret;
2573 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002574 }
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 ret = ssl_get_remaining_payload_in_datagram(ssl);
2577 if (ret < 0) {
2578 return ret;
2579 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002580 max_frag_len = (size_t) ret;
2581
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002582 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2584 if (max_frag_len == 0) {
2585 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2586 return ret;
2587 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002588
2589 continue;
2590 }
2591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002593 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002594 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002595
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002596 /* Update position inside current message */
2597 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002599 const unsigned char * const p = ssl->handshake->cur_msg_p;
2600 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002602 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002603 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2606 if (is_finished) {
2607 ret = ssl_swap_epochs(ssl);
2608 if (ret != 0) {
2609 return ret;
2610 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002611 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2614 return ret;
2615 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002616
2617 continue;
2618 }
2619 max_hs_frag_len = max_frag_len - 12;
2620
2621 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2625 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2626 (unsigned) cur_hs_frag_len,
2627 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002628 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002629
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002630 /* Messages are stored with handshake headers as if not fragmented,
2631 * copy beginning of headers then fill fragmentation fields.
2632 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2636 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2637 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2640 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2641 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002644
Hanno Becker3f7b9732018-08-28 09:53:25 +01002645 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002647 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002648 ssl->out_msgtype = cur->type;
2649
2650 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002651 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002652 }
2653
2654 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2656 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002657 ssl->handshake->cur_msg = cur->next;
2658 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002660 ssl->handshake->cur_msg = NULL;
2661 ssl->handshake->cur_msg_p = NULL;
2662 }
2663 }
2664
2665 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2667 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2668 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002669 }
2670 }
2671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2673 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002674 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 /* Update state and set timer */
2677 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2678 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2679 } else {
2680 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2681 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2682 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2685
2686 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002687}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002688
2689/*
2690 * To be called when the last message of an incoming flight is received.
2691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002692void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002693{
2694 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002696 ssl->handshake->flight = NULL;
2697 ssl->handshake->cur_msg = NULL;
2698
2699 /* The next incoming flight will start with this msg_seq */
2700 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2701
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002702 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002703 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002704
Hanno Becker0271f962018-08-16 13:23:47 +01002705 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002707
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002708 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2712 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002717}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002718
2719/*
2720 * To be called when the last message of an outgoing flight is send.
2721 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002722void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002723{
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 ssl_reset_retransmit_timeout(ssl);
2725 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2728 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002733}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002735
Paul Bakker5121ce52009-01-03 21:22:43 +00002736/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002737 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002739int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2740 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002741{
2742 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002743 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002744 * ...
2745 * HandshakeType msg_type;
2746 * uint24 length;
2747 * ...
2748 */
2749 *buf = ssl->out_msg + 4;
2750 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2751
2752 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2753 ssl->out_msg[0] = hs_type;
2754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002756}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002757
2758/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002759 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002760 *
2761 * - fill in handshake headers
2762 * - update handshake checksum
2763 * - DTLS: save message for resending
2764 * - then pass to the record layer
2765 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002766 * DTLS: except for HelloRequest, messages are only queued, and will only be
2767 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002768 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002769 * Inputs:
2770 * - ssl->out_msglen: 4 + actual handshake message len
2771 * (4 is the size of handshake headers for TLS)
2772 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2773 * - ssl->out_msg + 4: the handshake message body
2774 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002775 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002776 * - ssl->out_msglen: the length of the record contents
2777 * (including handshake headers but excluding record headers)
2778 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2781 int update_checksum,
2782 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002783{
Janos Follath865b3eb2019-12-16 11:46:15 +00002784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002785 const size_t hs_len = ssl->out_msglen - 4;
2786 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002789
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002790 /*
2791 * Sanity checks
2792 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2794 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2795 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2796 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002797 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002798
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002799 /* Whenever we send anything different from a
2800 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2802 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2803 ssl->handshake == NULL) {
2804 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2805 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002806 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002810 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2812 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2813 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002814 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002815#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002816
Hanno Beckerb50a2532018-08-06 11:52:54 +01002817 /* Double-check that we did not exceed the bounds
2818 * of the outgoing record buffer.
2819 * This should never fail as the various message
2820 * writing functions must obey the bounds of the
2821 * outgoing record buffer, but better be safe.
2822 *
2823 * Note: We deliberately do not check for the MTU or MFL here.
2824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2826 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2827 "size %" MBEDTLS_PRINTF_SIZET
2828 ", maximum %" MBEDTLS_PRINTF_SIZET,
2829 ssl->out_msglen,
2830 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2831 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002832 }
2833
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002834 /*
2835 * Fill handshake headers
2836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2838 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2839 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2840 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002841
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002842 /*
2843 * DTLS has additional fields in the Handshake layer,
2844 * between the length field and the actual payload:
2845 * uint16 message_seq;
2846 * uint24 fragment_offset;
2847 * uint24 fragment_length;
2848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002851 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2853 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2854 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2855 MBEDTLS_PRINTF_SIZET,
2856 hs_len,
2857 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2858 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002859 }
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002862 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002863
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002864 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2866 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2867 ++(ssl->handshake->out_msg_seq);
2868 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002869 ssl->out_msg[4] = 0;
2870 ssl->out_msg[5] = 0;
2871 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002872
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002873 /* Handshake hashes are computed without fragmentation,
2874 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 memset(ssl->out_msg + 6, 0x00, 3);
2876 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002877 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002879
Hanno Becker0207e532018-08-28 10:28:28 +01002880 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002882 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2883 ssl->out_msglen);
2884 if (ret != 0) {
2885 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2886 return ret;
2887 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002889 }
2890
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002891 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2894 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2895 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2896 if ((ret = ssl_flight_append(ssl)) != 0) {
2897 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2898 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002899 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002901#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002902 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2904 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2905 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002906 }
2907 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002912}
2913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2915 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002916{
2917 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2918 size_t msg_with_header_len;
2919 ((void) buf_len);
2920
2921 /* Add reserved 4 bytes for handshake header */
2922 msg_with_header_len = msg_len + 4;
2923 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002925
2926cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002928}
2929
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002930/*
2931 * Record layer functions
2932 */
2933
2934/*
2935 * Write current record.
2936 *
2937 * Uses:
2938 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2939 * - ssl->out_msglen: length of the record content (excl headers)
2940 * - ssl->out_msg: record content
2941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002942int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002943{
2944 int ret, done = 0;
2945 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002946 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002951 unsigned i;
2952 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002953#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2954 size_t out_buf_len = ssl->out_buf_len;
2955#else
2956 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2957#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002958 /* Skip writing the record content type to after the encryption,
2959 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002960 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002961#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002962 /* TLS 1.3 still uses the TLS 1.2 version identifier
2963 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002965 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002967#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2969 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2972 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002975 mbedtls_record rec;
2976
2977 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002979 rec.data_len = ssl->out_msglen;
2980 rec.data_offset = ssl->out_msg - rec.buf;
2981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2983 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002984 rec.type = ssl->out_msgtype;
2985
Hanno Beckera0e20d02019-05-15 14:03:01 +01002986#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002987 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002988 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002989#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2992 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2993 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2994 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002995 }
2996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (rec.data_offset != 0) {
2998 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2999 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00003000 }
3001
Hanno Becker6430faf2019-05-08 11:57:13 +01003002 /* Update the record content type and CID. */
3003 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003004#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3005 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003006#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003007 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003009 }
3010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003012
3013#if defined(MBEDTLS_SSL_PROTO_DTLS)
3014 /* In case of DTLS, double-check that we don't exceed
3015 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3017 ret = ssl_get_remaining_space_in_datagram(ssl);
3018 if (ret < 0) {
3019 return ret;
3020 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003023 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003025 }
3026 }
3027#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003028
Hanno Becker6430faf2019-05-08 11:57:13 +01003029 /* Now write the potentially updated record content type. */
3030 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3033 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3034 ssl->out_hdr[0], ssl->out_hdr[1],
3035 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3038 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003039
3040 ssl->out_left += protected_record_size;
3041 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3045 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003046 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 }
3048 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003049
Gabor Mezei96ae9262022-06-28 11:45:18 +02003050 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 if (i == mbedtls_ssl_ep_len(ssl)) {
3052 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3053 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003054 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003055 }
3056
Hanno Becker67bc7c32018-08-06 11:33:50 +01003057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3059 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003060 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 ret = ssl_get_remaining_payload_in_datagram(ssl);
3062 if (ret < 0) {
3063 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3064 ret);
3065 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003066 }
3067
3068 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003070 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 } else {
3072 MBEDTLS_SSL_DEBUG_MSG(2,
3073 ("Still %u bytes available in current datagram",
3074 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003075 }
3076 }
3077#endif /* MBEDTLS_SSL_PROTO_DTLS */
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if ((flush == SSL_FORCE_FLUSH) &&
3080 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3081 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3082 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 }
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003088}
3089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003091
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003092MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003093static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003094{
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (ssl->in_msglen < ssl->in_hslen ||
3096 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3097 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3098 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003099 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003101}
Hanno Becker44650b72018-08-16 12:51:11 +01003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003104{
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return (ssl->in_msg[9] << 16) |
3106 (ssl->in_msg[10] << 8) |
3107 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003111{
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return (ssl->in_msg[6] << 16) |
3113 (ssl->in_msg[7] << 8) |
3114 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003115}
3116
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003118static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003119{
3120 uint32_t msg_len, frag_off, frag_len;
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 msg_len = ssl_get_hs_total_len(ssl);
3123 frag_off = ssl_get_hs_frag_off(ssl);
3124 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 if (frag_off > msg_len) {
3127 return -1;
3128 }
Hanno Becker44650b72018-08-16 12:51:11 +01003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 if (frag_len > msg_len - frag_off) {
3131 return -1;
3132 }
Hanno Becker44650b72018-08-16 12:51:11 +01003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 if (frag_len + 12 > ssl->in_msglen) {
3135 return -1;
3136 }
Hanno Becker44650b72018-08-16 12:51:11 +01003137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003139}
3140
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003141/*
3142 * Mark bits in bitmask (used for DTLS HS reassembly)
3143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003144static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003145{
3146 unsigned int start_bits, end_bits;
3147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 start_bits = 8 - (offset % 8);
3149 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003150 size_t first_byte_idx = offset / 8;
3151
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003152 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 if (len <= start_bits) {
3154 for (; len != 0; len--) {
3155 mask[first_byte_idx] |= 1 << (start_bits - len);
3156 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003157
3158 /* Avoid potential issues with offset or len becoming invalid */
3159 return;
3160 }
3161
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003162 offset += start_bits; /* Now offset % 8 == 0 */
3163 len -= start_bits;
3164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 for (; start_bits != 0; start_bits--) {
3166 mask[first_byte_idx] |= 1 << (start_bits - 1);
3167 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003168 }
3169
3170 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 if (end_bits != 0) {
3172 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173
3174 len -= end_bits; /* Now len % 8 == 0 */
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 for (; end_bits != 0; end_bits--) {
3177 mask[last_byte_idx] |= 1 << (8 - end_bits);
3178 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003179 }
3180
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003182}
3183
3184/*
3185 * Check that bitmask is full
3186 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003187MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003188static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003189{
3190 size_t i;
3191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 for (i = 0; i < len / 8; i++) {
3193 if (mask[i] != 0xFF) {
3194 return -1;
3195 }
3196 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 for (i = 0; i < len % 8; i++) {
3199 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3200 return -1;
3201 }
3202 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003205}
3206
Hanno Becker56e205e2018-08-16 09:06:12 +01003207/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003208static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3209 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003210{
Hanno Becker56e205e2018-08-16 09:06:12 +01003211 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003212
Hanno Becker56e205e2018-08-16 09:06:12 +01003213 alloc_len = 12; /* Handshake header */
3214 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (add_bitmap) {
3217 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 }
3220 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003221}
Hanno Becker56e205e2018-08-16 09:06:12 +01003222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003226{
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 return (ssl->in_msg[1] << 16) |
3228 (ssl->in_msg[2] << 8) |
3229 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003230}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003233{
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3235 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3236 ssl->in_msglen));
3237 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003238 }
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003241
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3243 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3244 MBEDTLS_PRINTF_SIZET,
3245 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 if (ssl_check_hs_header(ssl) != 0) {
3253 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3254 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003255 }
3256
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 if (ssl->handshake != NULL &&
3258 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3259 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3260 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3261 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3262 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3263 MBEDTLS_SSL_DEBUG_MSG(2,
3264 (
3265 "received future handshake message of sequence number %u (next %u)",
3266 recv_msg_seq,
3267 ssl->handshake->in_msg_seq));
3268 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003269 }
3270
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003271 /* Retransmit only on last message from previous flight, to avoid
3272 * too many retransmissions.
3273 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3275 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3276 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3277 "message_seq = %u, start_of_flight = %u",
3278 recv_msg_seq,
3279 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3282 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3283 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003284 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 } else {
3286 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3287 "message_seq = %u, expected = %u",
3288 recv_msg_seq,
3289 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003290 }
3291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003293 }
3294 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003295
Hanno Becker6d97ef52018-08-16 13:09:04 +01003296 /* Message reassembly is handled alongside buffering of future
3297 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003298 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003299 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3301 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3302 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003303 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003306 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 if (ssl->in_msglen < ssl->in_hslen) {
3308 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3309 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003310 }
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003313}
3314
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003315int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003316{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003317 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003318 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003319
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003321 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3322 if (ret != 0) {
3323 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3324 return ret;
3325 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003326 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003327
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003328 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3331 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003332 unsigned offset;
3333 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003334
Hanno Becker0271f962018-08-16 13:23:47 +01003335 /* Increment handshake sequence number */
3336 hs->in_msg_seq++;
3337
3338 /*
3339 * Clear up handshake buffering and reassembly structure.
3340 */
3341
3342 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003344
3345 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003347 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003349 *hs_buf = *(hs_buf + 1);
3350 }
3351
3352 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003354 }
3355#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003356 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003357}
3358
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003359/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003360 * DTLS anti-replay: RFC 6347 4.1.2.6
3361 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003362 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3363 * Bit n is set iff record number in_window_top - n has been seen.
3364 *
3365 * Usually, in_window_top is the last record number seen and the lsb of
3366 * in_window is set. The only exception is the initial state (record number 0
3367 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003370void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003371{
3372 ssl->in_window_top = 0;
3373 ssl->in_window = 0;
3374}
3375
Gilles Peskine449bd832023-01-11 14:50:10 +01003376static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003377{
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return ((uint64_t) buf[0] << 40) |
3379 ((uint64_t) buf[1] << 32) |
3380 ((uint64_t) buf[2] << 24) |
3381 ((uint64_t) buf[3] << 16) |
3382 ((uint64_t) buf[4] << 8) |
3383 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003384}
3385
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003386MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003387static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003388{
Janos Follath865b3eb2019-12-16 11:46:15 +00003389 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003390 unsigned char *original_in_ctr;
3391
3392 // save original in_ctr
3393 original_in_ctr = ssl->in_ctr;
3394
3395 // use counter from record
3396 ssl->in_ctr = record_in_ctr;
3397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003399
3400 // restore the counter
3401 ssl->in_ctr = original_in_ctr;
3402
3403 return ret;
3404}
3405
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003406/*
3407 * Return 0 if sequence number is acceptable, -1 otherwise
3408 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003409int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003410{
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003412 uint64_t bit;
3413
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3415 return 0;
3416 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (rec_seqnum > ssl->in_window_top) {
3419 return 0;
3420 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003421
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003422 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (bit >= 64) {
3425 return -1;
3426 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3429 return -1;
3430 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003433}
3434
3435/*
3436 * Update replay window on new validated record
3437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003438void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003439{
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003441
Gilles Peskine449bd832023-01-11 14:50:10 +01003442 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003443 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447 /* Update window_top and the contents of the window */
3448 uint64_t shift = rec_seqnum - ssl->in_window_top;
3449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003451 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003454 ssl->in_window |= 1;
3455 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003456
3457 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003460 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003463 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003465 }
3466}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003468
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003469#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003470/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003471 * Check if a datagram looks like a ClientHello with a valid cookie,
3472 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003473 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003474 *
3475 * - if cookie is valid, return 0
3476 * - if ClientHello looks superficially valid but cookie is not,
3477 * fill obuf and set olen, then
3478 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3479 * - otherwise return a specific error code
3480 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003481MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003482MBEDTLS_STATIC_TESTABLE
3483int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 mbedtls_ssl_context *ssl,
3485 const unsigned char *cli_id, size_t cli_id_len,
3486 const unsigned char *in, size_t in_len,
3487 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003488{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003489 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003490 unsigned char *p;
3491
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003492 /*
3493 * Structure of ClientHello with record and handshake headers,
3494 * and expected values. We don't need to check a lot, more checks will be
3495 * done when actually parsing the ClientHello - skipping those checks
3496 * avoids code duplication and does not make cookie forging any easier.
3497 *
3498 * 0-0 ContentType type; copied, must be handshake
3499 * 1-2 ProtocolVersion version; copied
3500 * 3-4 uint16 epoch; copied, must be 0
3501 * 5-10 uint48 sequence_number; copied
3502 * 11-12 uint16 length; (ignored)
3503 *
3504 * 13-13 HandshakeType msg_type; (ignored)
3505 * 14-16 uint24 length; (ignored)
3506 * 17-18 uint16 message_seq; copied
3507 * 19-21 uint24 fragment_offset; copied, must be 0
3508 * 22-24 uint24 fragment_length; (ignored)
3509 *
3510 * 25-26 ProtocolVersion client_version; (ignored)
3511 * 27-58 Random random; (ignored)
3512 * 59-xx SessionID session_id; 1 byte len + sid_len content
3513 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3514 * ...
3515 *
3516 * Minimum length is 61 bytes.
3517 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3519 (unsigned) in_len));
3520 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3521 if (in_len < 61) {
3522 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3523 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003524 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003525
Gilles Peskine449bd832023-01-11 14:50:10 +01003526 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3527 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003528
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3530 fragment_offset != 0) {
3531 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3532 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3533 in[0], (unsigned) epoch,
3534 (unsigned) fragment_offset));
3535 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003536 }
3537
3538 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003539 if (59 + 1 + sid_len + 1 > in_len) {
3540 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3541 (unsigned) sid_len,
3542 (unsigned) in_len - 61));
3543 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003544 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3546 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003547
3548 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003549 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3550 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3551 (unsigned) cookie_len,
3552 (unsigned) (in_len - sid_len - 61)));
3553 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003554 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003555
Gilles Peskine449bd832023-01-11 14:50:10 +01003556 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3557 in + sid_len + 61, cookie_len);
3558 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3559 in + sid_len + 61, cookie_len,
3560 cli_id, cli_id_len) == 0) {
3561 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3562 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003563 }
3564
3565 /*
3566 * If we get here, we've got an invalid cookie, let's prepare HVR.
3567 *
3568 * 0-0 ContentType type; copied
3569 * 1-2 ProtocolVersion version; copied
3570 * 3-4 uint16 epoch; copied
3571 * 5-10 uint48 sequence_number; copied
3572 * 11-12 uint16 length; olen - 13
3573 *
3574 * 13-13 HandshakeType msg_type; hello_verify_request
3575 * 14-16 uint24 length; olen - 25
3576 * 17-18 uint16 message_seq; copied
3577 * 19-21 uint24 fragment_offset; copied
3578 * 22-24 uint24 fragment_length; olen - 25
3579 *
3580 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3581 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3582 *
3583 * Minimum length is 28.
3584 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003585 if (buf_len < 28) {
3586 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3587 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003588
3589 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003590 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003591 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3592 obuf[25] = 0xfe;
3593 obuf[26] = 0xff;
3594
3595 /* Generate and write actual cookie */
3596 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3598 &p, obuf + buf_len,
3599 cli_id, cli_id_len) != 0) {
3600 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003601 }
3602
3603 *olen = p - obuf;
3604
3605 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003606 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003607
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3609 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3610 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003611
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003613
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003615}
3616
3617/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003618 * Handle possible client reconnect with the same UDP quadruplet
3619 * (RFC 6347 Section 4.2.8).
3620 *
3621 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3622 * that looks like a ClientHello.
3623 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003624 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003625 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003626 * - if the input looks like a ClientHello with a valid cookie,
3627 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003628 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003629 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003631 * This function is called (through ssl_check_client_reconnect()) when an
3632 * unexpected record is found in ssl_get_next_record(), which will discard the
3633 * record if we return 0, and bubble up the return value otherwise (this
3634 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3635 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003636 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003637MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003638static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003639{
Janos Follath865b3eb2019-12-16 11:46:15 +00003640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003641 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003642
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 if (ssl->conf->f_cookie_write == NULL ||
3644 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003645 /* If we can't use cookies to verify reachability of the peer,
3646 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3648 "can't check reconnect validity"));
3649 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003650 }
3651
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003652 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 ssl,
3654 ssl->cli_id, ssl->cli_id_len,
3655 ssl->in_buf, ssl->in_left,
3656 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003657
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003659
Gilles Peskine449bd832023-01-11 14:50:10 +01003660 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003661 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3663 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3664 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003665 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003666 * If the error is permanent we'll catch it later,
3667 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3669 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003670 (void) send_ret;
3671
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003673 }
3674
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 if (ret == 0) {
3676 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3677 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3678 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3679 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003680 }
3681
Gilles Peskine449bd832023-01-11 14:50:10 +01003682 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003683 }
3684
Gilles Peskine449bd832023-01-11 14:50:10 +01003685 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003686}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003687#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003688
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003689MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003690static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003691{
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003693 record_type != MBEDTLS_SSL_MSG_ALERT &&
3694 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003695 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3696 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003697 }
3698
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003700}
3701
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003702/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003703 * ContentType type;
3704 * ProtocolVersion version;
3705 * uint16 epoch; // DTLS only
3706 * uint48 sequence_number; // DTLS only
3707 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003708 *
3709 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003710 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3712 *
3713 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003714 * 1. proceed with the record if this function returns 0
3715 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3716 * 3. return CLIENT_RECONNECT if this function return that value
3717 * 4. drop the whole datagram if this function returns anything else.
3718 * Point 2 is needed when the peer is resending, and we have already received
3719 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003720 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003721MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003722static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3723 unsigned char *buf,
3724 size_t len,
3725 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003726{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003727 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003728
Hanno Beckere5e7e782019-07-11 12:29:35 +01003729 size_t const rec_hdr_type_offset = 0;
3730 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003731
Hanno Beckere5e7e782019-07-11 12:29:35 +01003732 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3733 rec_hdr_type_len;
3734 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003735
Hanno Beckere5e7e782019-07-11 12:29:35 +01003736 size_t const rec_hdr_ctr_len = 8;
3737#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003738 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003739 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3740 rec_hdr_version_len;
3741
Hanno Beckera0e20d02019-05-15 14:03:01 +01003742#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003743 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3744 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003745 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003746#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3747#endif /* MBEDTLS_SSL_PROTO_DTLS */
3748
3749 size_t rec_hdr_len_offset; /* To be determined */
3750 size_t const rec_hdr_len_len = 2;
3751
3752 /*
3753 * Check minimum lengths for record header.
3754 */
3755
3756#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003757 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003758 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003760#endif /* MBEDTLS_SSL_PROTO_DTLS */
3761 {
3762 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3763 }
3764
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3766 MBEDTLS_SSL_DEBUG_MSG(1,
3767 (
3768 "datagram of length %u too small to hold DTLS record header of length %u",
3769 (unsigned) len,
3770 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3771 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003772 }
3773
3774 /*
3775 * Parse and validate record content type
3776 */
3777
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003779
3780 /* Check record content type */
3781#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3782 rec->cid_len = 0;
3783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003785 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003786 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003787 /* Shift pointers to account for record header including CID
3788 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003789 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003790 * ProtocolVersion version;
3791 * uint16 epoch;
3792 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003793 * opaque cid[cid_length]; // Additional field compared to
3794 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003795 * uint16 length;
3796 * opaque enc_content[DTLSCiphertext.length];
3797 * } DTLSCiphertext;
3798 */
3799
3800 /* So far, we only support static CID lengths
3801 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003802 rec_hdr_cid_len = ssl->conf->cid_len;
3803 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003804
Gilles Peskine449bd832023-01-11 14:50:10 +01003805 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3806 MBEDTLS_SSL_DEBUG_MSG(1,
3807 (
3808 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3809 (unsigned) len,
3810 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3811 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003812 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003813
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003814 /* configured CID len is guaranteed at most 255, see
3815 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3816 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3818 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003819#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003820 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003821 if (ssl_check_record_type(rec->type)) {
3822 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3823 (unsigned) rec->type));
3824 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003825 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003826 }
3827
Hanno Beckere5e7e782019-07-11 12:29:35 +01003828 /*
3829 * Parse and validate record version
3830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3832 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003833 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3834 buf + rec_hdr_version_offset,
3835 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003836
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 if (tls_version > ssl->conf->max_tls_version) {
3838 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3839 (unsigned) tls_version,
3840 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003843 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003844 /*
3845 * Parse/Copy record sequence number.
3846 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003847
Hanno Beckere5e7e782019-07-11 12:29:35 +01003848#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003850 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3852 rec_hdr_ctr_len);
3853 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003854#endif /* MBEDTLS_SSL_PROTO_DTLS */
3855 {
3856 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003858 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003859
Hanno Beckere5e7e782019-07-11 12:29:35 +01003860 /*
3861 * Parse record length.
3862 */
3863
Hanno Beckere5e7e782019-07-11 12:29:35 +01003864 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3866 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3867 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003868
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3870 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3871 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003872
3873 rec->buf = buf;
3874 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003875
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 if (rec->data_len == 0) {
3877 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3878 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003879
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003880 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003881 * DTLS-related tests.
3882 * Check epoch before checking length constraint because
3883 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3884 * message gets duplicated before the corresponding Finished message,
3885 * the second ChangeCipherSpec should be discarded because it belongs
3886 * to an old epoch, but not because its length is shorter than
3887 * the minimum record length for packets using the new record transform.
3888 * Note that these two kinds of failures are handled differently,
3889 * as an unexpected record is silently skipped but an invalid
3890 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003891 */
3892#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003893 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3894 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003895
Hanno Becker955a5c92019-07-10 17:12:07 +01003896 /* Check that the datagram is large enough to contain a record
3897 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 if (len < rec->data_offset + rec->data_len) {
3899 MBEDTLS_SSL_DEBUG_MSG(1,
3900 (
3901 "Datagram of length %u too small to contain record of advertised length %u.",
3902 (unsigned) len,
3903 (unsigned) (rec->data_offset + rec->data_len)));
3904 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003905 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003906
Hanno Becker37cfe732019-07-10 17:20:01 +01003907 /* Records from other, non-matching epochs are silently discarded.
3908 * (The case of same-port Client reconnects must be considered in
3909 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (rec_epoch != ssl->in_epoch) {
3911 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3912 "expected %u, received %lu",
3913 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003914
Hanno Becker552f7472019-07-19 10:59:12 +01003915 /* Records from the next epoch are considered for buffering
3916 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3918 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3919 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003920 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003921
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003923 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003924#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003925 /* For records from the correct epoch, check whether their
3926 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3928 &rec->ctr[0]) != 0) {
3929 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3930 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003931 }
3932#endif
3933 }
3934#endif /* MBEDTLS_SSL_PROTO_DTLS */
3935
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003937}
Paul Bakker5121ce52009-01-03 21:22:43 +00003938
Paul Bakker5121ce52009-01-03 21:22:43 +00003939
Hanno Becker2fddd372019-07-10 14:37:41 +01003940#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003941MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003942static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003943{
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003945
3946 /*
3947 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3948 * access the first byte of record content (handshake type), as we
3949 * have an active transform (possibly iv_len != 0), so use the
3950 * fact that the record header len is 13 instead.
3951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003952 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003953 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003955 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3956 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3958 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3959 "from the same port"));
3960 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003961 }
3962
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003964}
Hanno Becker2fddd372019-07-10 14:37:41 +01003965#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003966
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003967/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003968 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003969 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003970MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003971static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3972 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003973{
3974 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3977 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003978
Ronald Cron7e38cba2021-11-24 12:43:39 +01003979 /*
3980 * In TLS 1.3, always treat ChangeCipherSpec records
3981 * as unencrypted. The only thing we do with them is
3982 * check the length and content and ignore them.
3983 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003984#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 if (ssl->transform_in != NULL &&
3986 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3987 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003988 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003990 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003991#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003992
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003994 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3997 rec)) != 0) {
3998 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003999
Hanno Beckera0e20d02019-05-15 14:03:01 +01004000#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004002 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4004 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004005 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004006 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004007#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004008
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004010 }
4011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if (old_msg_type != rec->type) {
4013 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4014 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004015 }
4016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4018 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004019
Hanno Beckera0e20d02019-05-15 14:03:01 +01004020#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004021 /* We have already checked the record content type
4022 * in ssl_parse_record_header(), failing or silently
4023 * dropping the record in the case of an unknown type.
4024 *
4025 * Since with the use of CIDs, the record content type
4026 * might change during decryption, re-check the record
4027 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (ssl_check_record_type(rec->type)) {
4029 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4030 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004031 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004032#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004035#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4037 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004038 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4040 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004041 }
4042#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4043
4044 ssl->nb_zero++;
4045
4046 /*
4047 * Three or more empty messages may be a DoS attack
4048 * (excessive CPU consumption).
4049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (ssl->nb_zero > 3) {
4051 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4052 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004053 /* Treat the records as if they were not properly authenticated,
4054 * thereby failing the connection if we see more than allowed
4055 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004059 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004061
4062#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004064 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004066#endif
4067 {
4068 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4070 i > mbedtls_ssl_ep_len(ssl); i--) {
4071 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004072 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004074 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004075
4076 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 if (i == mbedtls_ssl_ep_len(ssl)) {
4078 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4079 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004080 }
4081 }
4082
Paul Bakker5121ce52009-01-03 21:22:43 +00004083 }
4084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004085#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4087 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004088 }
4089#endif
4090
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004091 /* Check actual (decrypted) record content length against
4092 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4094 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4095 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004096 }
4097
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004099}
4100
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004101/*
4102 * Read a record.
4103 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004104 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4105 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4106 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004107 */
Hanno Becker1097b342018-08-15 14:09:41 +01004108
4109/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004111static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004112MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004113static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004114MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004115static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4118 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004119{
Janos Follath865b3eb2019-12-16 11:46:15 +00004120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004125 do {
Simon Butcher99000142016-10-13 17:21:01 +01004126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 ret = ssl_consume_current_message(ssl);
4128 if (ret != 0) {
4129 return ret;
4130 }
Hanno Becker26994592018-08-15 14:14:59 +01004131
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004133 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004135
Hanno Becker40f50842018-08-15 14:48:01 +01004136 /* We only check for buffered messages if the
4137 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4139 ssl_next_record_is_in_datagram(ssl) == 0) {
4140 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004141 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 }
Hanno Becker40f50842018-08-15 14:48:01 +01004143 }
4144
Hanno Becker40f50842018-08-15 14:48:01 +01004145#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (dtls_have_buffered == 0) {
4147 ret = ssl_get_next_record(ssl);
4148 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004149 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 }
Hanno Becker40f50842018-08-15 14:48:01 +01004151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (ret != 0) {
4153 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4154 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004155 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004156 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004157 }
4158
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004160
Hanno Becker40f50842018-08-15 14:48:01 +01004161#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004163 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 ret = ssl_buffer_message(ssl);
4165 if (ret != 0) {
4166 return ret;
4167 }
Hanno Becker40f50842018-08-15 14:48:01 +01004168
4169 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4170 }
4171#endif /* MBEDTLS_SSL_PROTO_DTLS */
4172
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4174 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004175
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (0 != ret) {
4177 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4178 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004179 }
4180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4182 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004183 ret = mbedtls_ssl_update_handshake_status(ssl);
4184 if (0 != ret) {
4185 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4186 return ret;
4187 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004188 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 } else {
4190 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004191 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004192 }
4193
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004197}
4198
Hanno Becker40f50842018-08-15 14:48:01 +01004199#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004201static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004202{
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 if (ssl->in_left > ssl->next_record_offset) {
4204 return 1;
4205 }
Simon Butcher99000142016-10-13 17:21:01 +01004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004208}
4209
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004210MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004211static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004212{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004213 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004215 int ret = 0;
4216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (hs == NULL) {
4218 return -1;
4219 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4224 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004225 /* Check if we have seen a ChangeCipherSpec before.
4226 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if (!hs->buffering.seen_ccs) {
4228 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004229 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004230 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004231 }
4232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004234 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4235 ssl->in_msglen = 1;
4236 ssl->in_msg[0] = 1;
4237
4238 /* As long as they are equal, the exact value doesn't matter. */
4239 ssl->in_left = 0;
4240 ssl->next_record_offset = 0;
4241
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004242 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004243 goto exit;
4244 }
Hanno Becker37f95322018-08-16 13:55:32 +01004245
Hanno Beckerb8f50142018-08-28 10:01:34 +01004246#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004247 /* Debug only */
4248 {
4249 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004251 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (hs_buf->is_valid == 1) {
4253 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4254 hs->in_msg_seq + offset,
4255 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004256 }
4257 }
4258 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004259#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004260
4261 /* Check if we have buffered and/or fully reassembled the
4262 * next handshake message. */
4263 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004265 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 size_t msg_len = (hs_buf->data[1] << 16) |
4267 (hs_buf->data[2] << 8) |
4268 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004269
4270 /* Double-check that we haven't accidentally buffered
4271 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4273 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4274 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004275 }
4276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4278 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4279 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004280
4281 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4282 ssl->in_hslen = msg_len + 12;
4283 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004285
4286 ret = 0;
4287 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 } else {
4289 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4290 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004291 }
4292
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004293 ret = -1;
4294
4295exit:
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4298 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004299}
4300
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004302static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4303 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004304{
4305 int offset;
4306 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4308 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004309
Hanno Becker01315ea2018-08-21 17:22:17 +01004310 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004312
4313 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4315 hs->buffering.total_bytes_buffered)) {
4316 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4317 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004318 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004319
Hanno Becker4f432ad2018-08-28 10:02:32 +01004320 /* We don't have enough space to buffer the next expected handshake
4321 * message. Remove buffers used for future messages to gain space,
4322 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4324 offset >= 0; offset--) {
4325 MBEDTLS_SSL_DEBUG_MSG(2,
4326 (
4327 "Free buffering slot %d to make space for reassembly of next handshake message",
4328 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004329
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004331
4332 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4334 hs->buffering.total_bytes_buffered)) {
4335 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4336 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004337 }
4338 }
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004341}
4342
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004343MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004344static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004345{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004346 int ret = 0;
4347 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (hs == NULL) {
4350 return 0;
4351 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004356 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004358
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004359 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004360 break;
4361
4362 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004363 {
4364 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004366 mbedtls_ssl_hs_buffer *hs_buf;
4367 size_t msg_len = ssl->in_hslen - 12;
4368
4369 /* We should never receive an old handshake
4370 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4372 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4373 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004374 }
4375
4376 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004378 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 MBEDTLS_SSL_DEBUG_MSG(2,
4380 ("Ignore future HS message with sequence number %u, "
4381 "buffering window %u - %u",
4382 recv_msg_seq, ssl->handshake->in_msg_seq,
4383 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4384 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004385
4386 goto exit;
4387 }
4388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4390 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004393
4394 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004396 size_t reassembly_buf_sz;
4397
Hanno Becker37f95322018-08-16 13:55:32 +01004398 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004400
4401 /* We copy the message back into the input buffer
4402 * after reassembly, so check that it's not too large.
4403 * This is an implementation-specific limitation
4404 * and not one from the standard, hence it is not
4405 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004407 /* Ignore message */
4408 goto exit;
4409 }
4410
Hanno Beckere0b150f2018-08-21 15:51:03 +01004411 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (hs->buffering.total_bytes_buffered >
4413 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4414 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4415 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004416 }
4417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4419 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4422 hs->buffering.total_bytes_buffered)) {
4423 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004424 /* If we can't buffer a future message because
4425 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 MBEDTLS_SSL_DEBUG_MSG(2,
4427 ("Buffering of future message of size %"
4428 MBEDTLS_PRINTF_SIZET
4429 " would exceed the compile-time limit %"
4430 MBEDTLS_PRINTF_SIZET
4431 " (already %" MBEDTLS_PRINTF_SIZET
4432 " bytes buffered) -- ignore\n",
4433 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4434 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 } else {
4437 MBEDTLS_SSL_DEBUG_MSG(2,
4438 ("Buffering of future message of size %"
4439 MBEDTLS_PRINTF_SIZET
4440 " would exceed the compile-time limit %"
4441 MBEDTLS_PRINTF_SIZET
4442 " (already %" MBEDTLS_PRINTF_SIZET
4443 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4444 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4445 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004446 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4449 MBEDTLS_SSL_DEBUG_MSG(2,
4450 ("Reassembly of next message of size %"
4451 MBEDTLS_PRINTF_SIZET
4452 " (%" MBEDTLS_PRINTF_SIZET
4453 " with bitmap) would exceed"
4454 " the compile-time limit %"
4455 MBEDTLS_PRINTF_SIZET
4456 " (already %" MBEDTLS_PRINTF_SIZET
4457 " bytes buffered) -- fail\n",
4458 msg_len,
4459 reassembly_buf_sz,
4460 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4461 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004462 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4463 goto exit;
4464 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004465 }
4466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 MBEDTLS_SSL_DEBUG_MSG(2,
4468 ("initialize reassembly, total length = %"
4469 MBEDTLS_PRINTF_SIZET,
4470 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4473 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004474 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004475 goto exit;
4476 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004477 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004478
4479 /* Prepare final header: copy msg_type, length and message_seq,
4480 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 memcpy(hs_buf->data, ssl->in_msg, 6);
4482 memset(hs_buf->data + 6, 0, 3);
4483 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004484
4485 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004486
4487 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004489 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4491 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004492 /* Ignore */
4493 goto exit;
4494 }
4495 }
4496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004498 size_t frag_len, frag_off;
4499 unsigned char * const msg = hs_buf->data + 12;
4500
4501 /*
4502 * Check and copy current fragment
4503 */
4504
4505 /* Validation of header fields already done in
4506 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 frag_off = ssl_get_hs_frag_off(ssl);
4508 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4511 ", length = %" MBEDTLS_PRINTF_SIZET,
4512 frag_off, frag_len));
4513 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004516 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 ssl_bitmask_set(bitmask, frag_off, frag_len);
4518 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4519 msg_len) == 0);
4520 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004521 hs_buf->is_complete = 1;
4522 }
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4525 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004526 }
4527
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004528 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004529 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004530
4531 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004532 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004533 break;
4534 }
4535
4536exit:
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4539 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004540}
4541#endif /* MBEDTLS_SSL_PROTO_DTLS */
4542
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004544static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004545{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004546 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004547 * Consume last content-layer message and potentially
4548 * update in_msglen which keeps track of the contents'
4549 * consumption state.
4550 *
4551 * (1) Handshake messages:
4552 * Remove last handshake message, move content
4553 * and adapt in_msglen.
4554 *
4555 * (2) Alert messages:
4556 * Consume whole record content, in_msglen = 0.
4557 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004558 * (3) Change cipher spec:
4559 * Consume whole record content, in_msglen = 0.
4560 *
4561 * (4) Application data:
4562 * Don't do anything - the record layer provides
4563 * the application data as a stream transport
4564 * and consumes through mbedtls_ssl_read only.
4565 *
4566 */
4567
4568 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004570 /* Hard assertion to be sure that no application data
4571 * is in flight, as corrupting ssl->in_msglen during
4572 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ssl->in_offt != NULL) {
4574 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4575 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004576 }
4577
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004578 /*
4579 * Get next Handshake message in the current record
4580 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004581
Hanno Becker4a810fb2017-05-24 16:27:30 +01004582 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004583 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004584 * current handshake content: If DTLS handshake
4585 * fragmentation is used, that's the fragment
4586 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004587 * size here is faulty and should be changed at
4588 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004589 * (2) While it doesn't seem to cause problems, one
4590 * has to be very careful not to assume that in_hslen
4591 * is always <= in_msglen in a sensible communication.
4592 * Again, it's wrong for DTLS handshake fragmentation.
4593 * The following check is therefore mandatory, and
4594 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004595 * Additionally, ssl->in_hslen might be arbitrarily out of
4596 * bounds after handling a DTLS message with an unexpected
4597 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004600 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4602 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4605 ssl->in_msg, ssl->in_msglen);
4606 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004607 ssl->in_msglen = 0;
4608 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004609
Hanno Becker4a810fb2017-05-24 16:27:30 +01004610 ssl->in_hslen = 0;
4611 }
4612 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 else if (ssl->in_offt != NULL) {
4614 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004615 }
4616 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004618 ssl->in_msglen = 0;
4619 }
4620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004622}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004623
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004625static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004626{
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (ssl->in_msglen > 0) {
4628 return 1;
4629 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004632}
4633
Hanno Becker5f066e72018-08-16 14:56:31 +01004634#if defined(MBEDTLS_SSL_PROTO_DTLS)
4635
Gilles Peskine449bd832023-01-11 14:50:10 +01004636static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004637{
4638 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004640 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004642
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004644 hs->buffering.total_bytes_buffered -=
4645 hs->buffering.future_record.len;
4646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004648 hs->buffering.future_record.data = NULL;
4649 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004650}
4651
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004652MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004653static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004654{
4655 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004657 size_t rec_len;
4658 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004659#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4660 size_t in_buf_len = ssl->in_buf_len;
4661#else
4662 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4663#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4665 return 0;
4666 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if (hs == NULL) {
4669 return 0;
4670 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004671
Hanno Becker5f066e72018-08-16 14:56:31 +01004672 rec = hs->buffering.future_record.data;
4673 rec_len = hs->buffering.future_record.len;
4674 rec_epoch = hs->buffering.future_record.epoch;
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (rec == NULL) {
4677 return 0;
4678 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004679
Hanno Becker4cb782d2018-08-20 11:19:05 +01004680 /* Only consider loading future records if the
4681 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4683 return 0;
4684 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (rec_epoch != ssl->in_epoch) {
4689 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004690 goto exit;
4691 }
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004694
4695 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4697 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4698 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004699 }
4700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004702 ssl->in_left = rec_len;
4703 ssl->next_record_offset = 0;
4704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004706
4707exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4709 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004710}
4711
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004713static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4714 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004715{
4716 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004717
4718 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (hs == NULL) {
4720 return 0;
4721 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004722
4723 /* Only buffer handshake records (we are only interested
4724 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4726 return 0;
4727 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004728
4729 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if (hs->buffering.future_record.data != NULL) {
4731 return 0;
4732 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004733
Hanno Becker01315ea2018-08-21 17:22:17 +01004734 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4736 hs->buffering.total_bytes_buffered)) {
4737 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4738 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4739 " (already %" MBEDTLS_PRINTF_SIZET
4740 " bytes buffered) -- ignore\n",
4741 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4742 hs->buffering.total_bytes_buffered));
4743 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004744 }
4745
Hanno Becker5f066e72018-08-16 14:56:31 +01004746 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4748 ssl->in_epoch + 1U));
4749 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004750
4751 /* ssl_parse_record_header() only considers records
4752 * of the next epoch as candidates for buffering. */
4753 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004754 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004755
4756 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 mbedtls_calloc(1, hs->buffering.future_record.len);
4758 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004759 /* If we run out of RAM trying to buffer a
4760 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004762 }
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004765
Hanno Becker519f15d2019-07-11 12:43:20 +01004766 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004768}
4769
4770#endif /* MBEDTLS_SSL_PROTO_DTLS */
4771
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004772MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004773static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004774{
Janos Follath865b3eb2019-12-16 11:46:15 +00004775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004776 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004777
Hanno Becker5f066e72018-08-16 14:56:31 +01004778#if defined(MBEDTLS_SSL_PROTO_DTLS)
4779 /* We might have buffered a future record; if so,
4780 * and if the epoch matches now, load it.
4781 * On success, this call will set ssl->in_left to
4782 * the length of the buffered record, so that
4783 * the calls to ssl_fetch_input() below will
4784 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 ret = ssl_load_buffered_record(ssl);
4786 if (ret != 0) {
4787 return ret;
4788 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004789#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004790
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004791 /* Ensure that we have enough space available for the default form
4792 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4793 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4795 if (ret != 0) {
4796 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4797 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004798 }
4799
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4801 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4804 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4805 ret = ssl_buffer_future_record(ssl, &rec);
4806 if (ret != 0) {
4807 return ret;
4808 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004809
4810 /* Fall through to handling of unexpected records */
4811 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4812 }
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004815#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004816 /* Reset in pointers to default state for TLS/DTLS records,
4817 * assuming no CID and no offset between record content and
4818 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004820
Hanno Becker7ae20e02019-07-12 08:33:49 +01004821 /* Setup internal message pointers from record structure. */
4822 ssl->in_msgtype = rec.type;
4823#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4824 ssl->in_len = ssl->in_cid + rec.cid_len;
4825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4826 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4827 ssl->in_msglen = rec.data_len;
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 ret = ssl_check_client_reconnect(ssl);
4830 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4831 if (ret != 0) {
4832 return ret;
4833 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004834#endif
4835
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004836 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004837 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4840 "(header)"));
4841 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004842 /* Skip invalid record and the rest of the datagram */
4843 ssl->next_record_offset = 0;
4844 ssl->in_left = 0;
4845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4847 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004848 }
4849
4850 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4852 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004853#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004854 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004856 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004857 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004859#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004861 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004862 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (ssl->next_record_offset < ssl->in_left) {
4864 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004865 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004867#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004868 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004869 /*
4870 * Fetch record contents from underlying transport.
4871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4873 if (ret != 0) {
4874 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4875 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004876 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004877
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004878 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004879 }
4880
4881 /*
4882 * Decrypt record contents.
4883 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004888 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004890 /* Except when waiting for Finished as a bad mac here
4891 * probably means something went wrong in the handshake
4892 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4894 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004895#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4897 mbedtls_ssl_send_alert_message(ssl,
4898 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4899 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004900 }
4901#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004903 }
4904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 if (ssl->conf->badmac_limit != 0 &&
4906 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4907 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4908 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004909 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004910
Hanno Becker4a810fb2017-05-24 16:27:30 +01004911 /* As above, invalid records cause
4912 * dismissal of the whole datagram. */
4913
4914 ssl->next_record_offset = 0;
4915 ssl->in_left = 0;
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4918 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004919 }
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 return ret;
4922 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004923#endif
4924 {
4925 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004926#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4928 mbedtls_ssl_send_alert_message(ssl,
4929 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4930 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004931 }
4932#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004934 }
4935 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004936
Hanno Becker44d89b22019-07-12 09:40:44 +01004937
4938 /* Reset in pointers to default state for TLS/DTLS records,
4939 * assuming no CID and no offset between record content and
4940 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004942#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4943 ssl->in_len = ssl->in_cid + rec.cid_len;
4944#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004945 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004946
Hanno Becker8685c822019-07-12 09:37:30 +01004947 /* The record content type may change during decryption,
4948 * so re-read it. */
4949 ssl->in_msgtype = rec.type;
4950 /* Also update the input buffer, because unfortunately
4951 * the server-side ssl_parse_client_hello() reparses the
4952 * record header when receiving a ClientHello initiating
4953 * a renegotiation. */
4954 ssl->in_hdr[0] = rec.type;
4955 ssl->in_msg = rec.buf + rec.data_offset;
4956 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004960}
4961
Gilles Peskine449bd832023-01-11 14:50:10 +01004962int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004963{
Janos Follath865b3eb2019-12-16 11:46:15 +00004964 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004965
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004966 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004967 * Handle particular types of records
4968 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4970 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4971 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004972 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004973 }
4974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4976 if (ssl->in_msglen != 1) {
4977 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4978 ssl->in_msglen));
4979 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004980 }
4981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if (ssl->in_msg[0] != 1) {
4983 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4984 ssl->in_msg[0]));
4985 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004986 }
4987
4988#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004990 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4992 if (ssl->handshake == NULL) {
4993 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4994 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004995 }
4996
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4998 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004999 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005000#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005001
Ronald Cron6f135e12021-12-08 16:57:54 +01005002#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005004#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 MBEDTLS_SSL_DEBUG_MSG(1,
5006 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5007 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005008#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 MBEDTLS_SSL_DEBUG_MSG(1,
5010 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5011 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005012#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5013 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005014#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005015 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5018 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005019 /* Note: Standard allows for more than one 2 byte alert
5020 to be packed in a single message, but Mbed TLS doesn't
5021 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5023 ssl->in_msglen));
5024 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005025 }
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5028 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005029
5030 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005031 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5034 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5035 ssl->in_msg[1]));
5036 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005037 }
5038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5040 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5041 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5042 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005043 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005044
5045#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5047 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5048 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005049 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005051 }
5052#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005053 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005054 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005055 }
5056
Hanno Beckerc76c6192017-06-06 10:03:17 +01005057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005059 /* Drop unexpected ApplicationData records,
5060 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5062 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005063#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5065 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005066#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 ) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5069 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005070 }
5071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (ssl->handshake != NULL &&
5073 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5074 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005075 }
5076 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005077#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005080}
5081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005083{
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 return mbedtls_ssl_send_alert_message(ssl,
5085 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5086 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005087}
5088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5090 unsigned char level,
5091 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005092{
Janos Follath865b3eb2019-12-16 11:46:15 +00005093 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if (ssl == NULL || ssl->conf == NULL) {
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5097 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (ssl->out_left != 0) {
5100 return mbedtls_ssl_flush_output(ssl);
5101 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5104 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005106 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005107 ssl->out_msglen = 2;
5108 ssl->out_msg[0] = level;
5109 ssl->out_msg[1] = message;
5110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5112 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5113 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005118}
5119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005121{
Janos Follath865b3eb2019-12-16 11:46:15 +00005122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005123
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005125
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005127 ssl->out_msglen = 1;
5128 ssl->out_msg[0] = 1;
5129
Paul Bakker5121ce52009-01-03 21:22:43 +00005130 ssl->state++;
5131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5134 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005135 }
5136
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005140}
5141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005143{
Janos Follath865b3eb2019-12-16 11:46:15 +00005144 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005145
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5149 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5150 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005151 }
5152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5154 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5155 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5156 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5157 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005158 }
5159
Hanno Beckere678eaa2018-08-21 14:57:46 +01005160 /* CCS records are only accepted if they have length 1 and content '1',
5161 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005162
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005163 /*
5164 * Switch to our negotiated transform and session parameters for inbound
5165 * data.
5166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005168#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005169 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005170#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005171 ssl->session_in = ssl->session_negotiate;
5172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005173#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005175#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005177#endif
5178
5179 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (++ssl->in_epoch == 0) {
5181 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005182 /* This is highly unlikely to happen for legitimate reasons, so
5183 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005185 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005189
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005191
Paul Bakker5121ce52009-01-03 21:22:43 +00005192 ssl->state++;
5193
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005195
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005197}
5198
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005199/* Once ssl->out_hdr as the address of the beginning of the
5200 * next outgoing record is set, deduce the other pointers.
5201 *
5202 * Note: For TLS, we save the implicit record sequence number
5203 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5204 * and the caller has to make sure there's space for this.
5205 */
5206
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005207static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005209{
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005211}
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5214 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005215{
5216#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005218 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005219#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005220 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005221 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005223 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005225#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005226 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005227#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005228 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005230#endif
5231 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005232 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005233#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005234 ssl->out_cid = ssl->out_len;
5235#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005236 ssl->out_iv = ssl->out_hdr + 5;
5237 }
5238
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005239 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005240 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (transform != NULL) {
5242 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5243 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005244}
5245
5246/* Once ssl->in_hdr as the address of the beginning of the
5247 * next incoming record is set, deduce the other pointers.
5248 *
5249 * Note: For TLS, we save the implicit record sequence number
5250 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5251 * and the caller has to make sure there's space for this.
5252 */
5253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005255{
Hanno Becker79594fd2019-05-08 09:38:41 +01005256 /* This function sets the pointers to match the case
5257 * of unprotected TLS/DTLS records, with both ssl->in_iv
5258 * and ssl->in_msg pointing to the beginning of the record
5259 * content.
5260 *
5261 * When decrypting a protected record, ssl->in_msg
5262 * will be shifted to point to the beginning of the
5263 * record plaintext.
5264 */
5265
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005266#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005268 /* This sets the header pointers to match records
5269 * without CID. When we receive a record containing
5270 * a CID, the fields are shifted accordingly in
5271 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005272 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005273#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005274 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005275 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005276#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005277 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005278#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005279 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005281#endif
5282 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005283 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005284 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005285#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005286 ssl->in_cid = ssl->in_len;
5287#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005288 ssl->in_iv = ssl->in_hdr + 5;
5289 }
5290
Hanno Becker79594fd2019-05-08 09:38:41 +01005291 /* This will be adjusted at record decryption time. */
5292 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005293}
5294
Paul Bakker5121ce52009-01-03 21:22:43 +00005295/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005296 * Setup an SSL context
5297 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005298
Gilles Peskine449bd832023-01-11 14:50:10 +01005299void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005300{
5301 /* Set the incoming and outgoing record pointers. */
5302#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005304 ssl->out_hdr = ssl->out_buf;
5305 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005307#endif /* MBEDTLS_SSL_PROTO_DTLS */
5308 {
Hanno Becker12078f42021-03-02 15:28:41 +00005309 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005310 ssl->out_hdr = ssl->out_buf + 8;
5311 ssl->in_hdr = ssl->in_buf + 8;
5312 }
5313
5314 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5316 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005317}
5318
Paul Bakker5121ce52009-01-03 21:22:43 +00005319/*
5320 * SSL get accessors
5321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005323{
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005325}
5326
Gilles Peskine449bd832023-01-11 14:50:10 +01005327int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005328{
5329 /*
5330 * Case A: We're currently holding back
5331 * a message for further processing.
5332 */
5333
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 if (ssl->keep_current_message == 1) {
5335 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5336 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005337 }
5338
5339 /*
5340 * Case B: Further records are pending in the current datagram.
5341 */
5342
5343#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5345 ssl->in_left > ssl->next_record_offset) {
5346 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5347 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005348 }
5349#endif /* MBEDTLS_SSL_PROTO_DTLS */
5350
5351 /*
5352 * Case C: A handshake message is being processed.
5353 */
5354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5356 MBEDTLS_SSL_DEBUG_MSG(3,
5357 ("ssl_check_pending: more handshake messages within current record"));
5358 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005359 }
5360
5361 /*
5362 * Case D: An application data message is being processed
5363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 if (ssl->in_offt != NULL) {
5365 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5366 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005367 }
5368
5369 /*
5370 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005371 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005372 * we implement support for multiple alerts in single records.
5373 */
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5376 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005377}
5378
Paul Bakker43ca69c2011-01-15 17:35:19 +00005379
Gilles Peskine449bd832023-01-11 14:50:10 +01005380int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005381{
Hanno Becker3136ede2018-08-17 15:28:19 +01005382 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005384 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005385#if defined(MBEDTLS_USE_PSA_CRYPTO)
5386 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5387 psa_key_type_t key_type;
5388#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005389
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (transform == NULL) {
5393 return (int) out_hdr_len;
5394 }
Hanno Becker78640902018-08-13 16:35:15 +01005395
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005396
5397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (transform->psa_alg == PSA_ALG_GCM ||
5399 transform->psa_alg == PSA_ALG_CCM ||
5400 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5401 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5402 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005403 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5405 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5406 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005407
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005409
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005410 /* Expansion due to the addition of the MAC. */
5411 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005412
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005413 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005414 * Theoretically up to 256 bytes, but we never use
5415 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005416 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005417
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005418 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005419 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005420#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005421 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005422#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 } else {
5424 MBEDTLS_SSL_DEBUG_MSG(1,
5425 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5426 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005427 }
5428#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 case MBEDTLS_MODE_GCM:
5431 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005432 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005434 transform_expansion = transform->minlen;
5435 break;
5436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005438
5439 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005441
Hanno Becker3136ede2018-08-17 15:28:19 +01005442 /* Expansion due to the addition of the MAC. */
5443 transform_expansion += transform->maclen;
5444
5445 /* Expansion due to the addition of CBC padding;
5446 * Theoretically up to 256 bytes, but we never use
5447 * more than the block size of the underlying cipher. */
5448 transform_expansion += block_size;
5449
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005450 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005451 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005452#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005453 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005455
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005456 break;
5457
5458 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5460 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005461 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005462#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005463
Hanno Beckera0e20d02019-05-15 14:03:01 +01005464#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005466 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005468#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005471}
5472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005474/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005475 * Check record counters and renegotiate if they're above the limit.
5476 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005478static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005479{
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005481 int in_ctr_cmp;
5482 int out_ctr_cmp;
5483
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5487 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005488 }
5489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5491 &ssl->conf->renego_period[ep_len],
5492 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5493 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005494 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005496
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5498 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005499 }
5500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5502 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005503}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005505
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005506#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5507
5508#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005509MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005510static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005511{
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5514 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5515 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005516 }
5517
5518 ssl->keep_current_message = 1;
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5521 mbedtls_ssl_handshake_set_state(ssl,
5522 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005523
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005525}
5526#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5527
Jerry Yua0446a02022-07-13 11:22:55 +08005528MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005529static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005530{
5531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005533
5534#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5536 int ret = ssl_tls13_check_new_session_ticket(ssl);
5537 if (ret != 0) {
5538 return ret;
5539 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005540 }
5541#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5542
5543 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005545}
5546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5547
5548#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005549/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005550 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005551 * may only be sent for the purpose of initiating renegotiations.
5552 *
5553 * This function is introduced as a separate helper since the handling
5554 * of post-handshake handshake messages changes significantly in TLS 1.3,
5555 * and having a helper function allows to distinguish between TLS <= 1.2 and
5556 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5557 */
Jerry Yua0446a02022-07-13 11:22:55 +08005558MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005559static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005560{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005561 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005562
5563 /*
5564 * - For client-side, expect SERVER_HELLO_REQUEST.
5565 * - For server-side, expect CLIENT_HELLO.
5566 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5567 */
5568
5569#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5571 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5572 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5573 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005574
5575 /* With DTLS, drop the packet (probably from last handshake) */
5576#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5578 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005579 }
5580#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005582 }
5583#endif /* MBEDTLS_SSL_CLI_C */
5584
5585#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5587 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5588 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005589
5590 /* With DTLS, drop the packet (probably from last handshake) */
5591#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5593 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005594 }
5595#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005597 }
5598#endif /* MBEDTLS_SSL_SRV_C */
5599
5600#if defined(MBEDTLS_SSL_RENEGOTIATION)
5601 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5603 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5604 ssl->conf->allow_legacy_renegotiation ==
5605 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005606 /*
5607 * Accept renegotiation request
5608 */
5609
5610 /* DTLS clients need to know renego is server-initiated */
5611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5613 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005614 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5615 }
5616#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 ret = mbedtls_ssl_start_renegotiation(ssl);
5618 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5619 ret != 0) {
5620 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5621 ret);
5622 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005623 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005625#endif /* MBEDTLS_SSL_RENEGOTIATION */
5626 {
5627 /*
5628 * Refuse renegotiation
5629 */
5630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005632
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5634 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5635 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5636 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005637 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005638 }
5639
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005641}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005642#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5643
5644MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005645static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005646{
5647 /* Check protocol version and dispatch accordingly. */
5648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5650 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005651 }
5652#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5653
5654#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5656 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005657 }
5658#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5659
5660 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005662}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005663
Paul Bakker48916f92012-09-16 19:57:18 +00005664/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005665 * Receive application data decrypted from the SSL layer
5666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005667int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005668{
Janos Follath865b3eb2019-12-16 11:46:15 +00005669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005670 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005671
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 if (ssl == NULL || ssl->conf == NULL) {
5673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5674 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005678#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5680 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5681 return ret;
5682 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005683
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 if (ssl->handshake != NULL &&
5685 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5686 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5687 return ret;
5688 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005689 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005690 }
5691#endif
5692
Hanno Becker4a810fb2017-05-24 16:27:30 +01005693 /*
5694 * Check if renegotiation is necessary and/or handshake is
5695 * in process. If yes, perform/continue, and fall through
5696 * if an unexpected packet is received while the client
5697 * is waiting for the ServerHello.
5698 *
5699 * (There is no equivalent to the last condition on
5700 * the server-side as it is not treated as within
5701 * a handshake while waiting for the ClientHello
5702 * after a renegotiation request.)
5703 */
5704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 ret = ssl_check_ctr_renegotiate(ssl);
5707 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5708 ret != 0) {
5709 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5710 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005711 }
5712#endif
5713
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5715 ret = mbedtls_ssl_handshake(ssl);
5716 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5717 ret != 0) {
5718 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5719 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005720 }
5721 }
5722
Hanno Beckere41158b2017-10-23 13:30:32 +01005723 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005725 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (ssl->f_get_timer != NULL &&
5727 ssl->f_get_timer(ssl->p_timer) == -1) {
5728 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005729 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5732 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5733 return 0;
5734 }
Paul Bakker831a7552011-05-18 13:32:51 +00005735
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5737 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005738 }
5739
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 if (ssl->in_msglen == 0 &&
5741 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005742 /*
5743 * OpenSSL sends empty messages to randomize the IV
5744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5746 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5747 return 0;
5748 }
Paul Bakker831a7552011-05-18 13:32:51 +00005749
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5751 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005752 }
5753 }
5754
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5756 ret = ssl_handle_hs_message_post_handshake(ssl);
5757 if (ret != 0) {
5758 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5759 ret);
5760 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005761 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005762
Hanno Beckerf26cc722021-04-21 07:30:13 +01005763 /* At this point, we don't know whether the renegotiation triggered
5764 * by the post-handshake message has been completed or not. The cases
5765 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005766 * 1) The renegotiation is complete. In this case, no new record
5767 * has been read yet.
5768 * 2) The renegotiation is incomplete because the client received
5769 * an application data record while awaiting the ServerHello.
5770 * 3) The renegotiation is incomplete because the client received
5771 * a non-handshake, non-application data message while awaiting
5772 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005773 *
5774 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005775 * - For 1), the next iteration will read a new record and check
5776 * if it's application data.
5777 * - For 2), the loop condition isn't satisfied as application data
5778 * is present, hence continue is the same as break
5779 * - For 3), the loop condition is satisfied and read_record
5780 * will re-deliver the message that was held back by the client
5781 * when expecting the ServerHello.
5782 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005783
Hanno Becker90333da2017-10-10 11:27:13 +01005784 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005785 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005786#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5788 if (ssl->conf->renego_max_records >= 0) {
5789 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5790 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5791 "but not honored by client"));
5792 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005793 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005794 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005795 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005796#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005798 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5800 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5801 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005802 }
5803
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5805 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5806 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005807 }
5808
5809 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005810
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005811 /* We're going to return something now, cancel timer,
5812 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5814 mbedtls_ssl_set_timer(ssl, 0);
5815 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005816
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005817#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005818 /* If we requested renego but received AppData, resend HelloRequest.
5819 * Do it now, after setting in_offt, to avoid taking this branch
5820 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005821#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5823 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5824 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5825 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5826 ret);
5827 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005828 }
5829 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005830#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005831#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005832 }
5833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005835 ? len : ssl->in_msglen;
5836
ashesman937d6d52022-02-17 11:08:27 +13005837 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005838 memcpy(buf, ssl->in_offt, n);
5839 ssl->in_msglen -= n;
5840 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005841
gabor-mezei-arma3214132020-07-15 10:55:00 +02005842 /* Zeroising the plaintext buffer to erase unused application data
5843 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005847 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005848 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005849 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005851 /* more data available */
5852 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005853 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005858}
5859
5860/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005861 * Send application data to be encrypted by the SSL layer, taking care of max
5862 * fragment length and buffer size.
5863 *
5864 * According to RFC 5246 Section 6.2.1:
5865 *
5866 * Zero-length fragments of Application data MAY be sent as they are
5867 * potentially useful as a traffic analysis countermeasure.
5868 *
5869 * Therefore, it is possible that the input message length is 0 and the
5870 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005871 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005872MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005873static int ssl_write_real(mbedtls_ssl_context *ssl,
5874 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005875{
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005877 const size_t max_len = (size_t) ret;
5878
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 if (ret < 0) {
5880 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5881 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005882 }
5883
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005885#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5887 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5888 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5889 " > %" MBEDTLS_PRINTF_SIZET,
5890 len, max_len));
5891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5892 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005893#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005895 }
Paul Bakker887bd502011-06-08 13:10:54 +00005896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005898 /*
5899 * The user has previously tried to send the data and
5900 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5901 * written. In this case, we expect the high-level write function
5902 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5906 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005907 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005909 /*
5910 * The user is trying to send a message the first time, so we need to
5911 * copy the data into the internal buffers and setup the data structure
5912 * to keep track of partial writes
5913 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005914 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005915 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005916 if (len > 0) {
5917 memcpy(ssl->out_msg, buf, len);
5918 }
Paul Bakker887bd502011-06-08 13:10:54 +00005919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5921 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5922 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005923 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005924 }
5925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005927}
5928
5929/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005930 * Write application data (public-facing wrapper)
5931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005932int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005933{
Janos Follath865b3eb2019-12-16 11:46:15 +00005934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (ssl == NULL || ssl->conf == NULL) {
5939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5940 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005941
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005942#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5944 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5945 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005946 }
5947#endif
5948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5950 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5951 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5952 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005953 }
5954 }
5955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005959
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005961}
5962
5963/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005964 * Notify the peer that the connection is being closed
5965 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005966int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005967{
Janos Follath865b3eb2019-12-16 11:46:15 +00005968 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 if (ssl == NULL || ssl->conf == NULL) {
5971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5972 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005973
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5977 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5978 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5979 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5980 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5981 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005982 }
5983 }
5984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005988}
5989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005991{
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005993 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005995
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005996#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 psa_destroy_key(transform->psa_key_enc);
5998 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005999#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6001 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006002#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006003
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006004#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006005#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 psa_destroy_key(transform->psa_mac_enc);
6007 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006008#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 mbedtls_md_free(&transform->md_ctx_enc);
6010 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006011#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006012#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006015}
6016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6018 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006019{
Jerry Yuc7875b52021-09-05 21:05:50 +08006020 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006022}
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6025 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006026{
6027 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006029}
6030
Hanno Becker0271f962018-08-16 13:23:47 +01006031#if defined(MBEDTLS_SSL_PROTO_DTLS)
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006034{
6035 unsigned offset;
6036 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6037
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006039 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 }
Hanno Becker0271f962018-08-16 13:23:47 +01006041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6045 ssl_buffering_free_slot(ssl, offset);
6046 }
Hanno Beckere605b192018-08-21 15:59:07 +01006047}
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6050 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006051{
6052 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6053 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006056 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006060 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006061 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006063 }
6064}
6065
6066#endif /* MBEDTLS_SSL_PROTO_DTLS */
6067
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006068/*
6069 * Convert version numbers to/from wire format
6070 * and, for DTLS, to/from TLS equivalent.
6071 *
6072 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006073 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006074 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006075 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006077void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6078 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006079{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006080 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006081#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006083 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006085 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006086#else
6087 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006088#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006089 {
6090 tls_version_formatted = (uint16_t) tls_version;
6091 }
6092 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006093}
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6096 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006097{
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006099#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006101 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6103 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006104#else
6105 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006106#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006107 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006108}
6109
Jerry Yue7047812021-09-13 19:26:39 +08006110/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006111 * Send pending fatal alert.
6112 * 0, No alert message.
6113 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6114 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006115 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006116int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006117{
6118 int ret;
6119
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006120 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (ssl->send_alert == 0) {
6122 return 0;
6123 }
Jerry Yu394ece62021-09-14 22:17:21 +08006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 ret = mbedtls_ssl_send_alert_message(ssl,
6126 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6127 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006128
Jerry Yu3bf1f972021-09-22 21:37:18 +08006129 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6130 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006133 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006134 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 if (ret != 0) {
6137 return ret;
6138 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006139
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006141}
6142
Jerry Yu394ece62021-09-14 22:17:21 +08006143/*
6144 * Set pending fatal alert flag.
6145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006146void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6147 unsigned char alert_type,
6148 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006149{
6150 ssl->send_alert = 1;
6151 ssl->alert_type = alert_type;
6152 ssl->alert_reason = alert_reason;
6153}
6154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006155#endif /* MBEDTLS_SSL_TLS_C */