blob: 50dda51cadc6481214a01de38b5fa4ef38d2f1d2 [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
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00007 */
8/*
Paul Bakker5121ce52009-01-03 21:22:43 +00009 * http://www.ietf.org/rfc/rfc2246.txt
10 * http://www.ietf.org/rfc/rfc4346.txt
11 */
12
Gilles Peskinedb09ef62020-06-03 01:43:33 +020013#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020015#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000016
SimonBd5800b72016-04-26 07:43:27 +010017#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010018
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000019#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000020#include "ssl_misc.h"
Valerio Settib4f50762024-01-17 10:24:52 +010021#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000022#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050023#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010024#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020025#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020031#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050032#include "psa/crypto.h"
33#endif
34
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define a local translating function to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049#endif
50
Dave Rodgman2801f7f2023-05-09 11:00:07 +010051#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
52
53#if defined(MBEDTLS_USE_PSA_CRYPTO)
54
55#if defined(PSA_WANT_ALG_SHA_384)
56#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
57#elif defined(PSA_WANT_ALG_SHA_256)
58#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
59#else /* See check_config.h */
60#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
61#endif
62
63MBEDTLS_STATIC_TESTABLE
64int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
65 psa_algorithm_t mac_alg,
66 const unsigned char *add_data,
67 size_t add_data_len,
68 const unsigned char *data,
69 size_t data_len_secret,
70 size_t min_data_len,
71 size_t max_data_len,
72 unsigned char *output)
73{
74 /*
75 * This function breaks the HMAC abstraction and uses psa_hash_clone()
76 * extension in order to get constant-flow behaviour.
77 *
78 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
79 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
80 * patterns (see RFC 2104, sec. 2).
81 *
82 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
83 * hashing up to minlen, then cloning the context, and for each byte up
84 * to maxlen finishing up the hash computation, keeping only the
85 * correct result.
86 *
87 * Then we only need to compute HASH(okey + inner_hash) and we're done.
88 */
89 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
90 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
91 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
92 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
93 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
94 size_t hash_length;
95
96 unsigned char aux_out[PSA_HASH_MAX_SIZE];
97 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
98 size_t offset;
99 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
100
101 size_t mac_key_length;
102 size_t i;
103
104#define PSA_CHK(func_call) \
105 do { \
106 status = (func_call); \
107 if (status != PSA_SUCCESS) \
108 goto cleanup; \
109 } while (0)
110
111 /* Export MAC key
112 * We assume key length is always exactly the output size
113 * which is never more than the block size, thus we use block_size
114 * as the key buffer size.
115 */
116 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
117
118 /* Calculate ikey */
119 for (i = 0; i < mac_key_length; i++) {
120 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
121 }
122 for (; i < block_size; ++i) {
123 key_buf[i] = 0x36;
124 }
125
126 PSA_CHK(psa_hash_setup(&operation, hash_alg));
127
128 /* Now compute inner_hash = HASH(ikey + msg) */
129 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
130 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
131 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
132
133 /* Fill the hash buffer in advance with something that is
134 * not a valid hash (barring an attack on the hash and
135 * deliberately-crafted input), in case the caller doesn't
136 * check the return status properly. */
137 memset(output, '!', hash_size);
138
139 /* For each possible length, compute the hash up to that point */
140 for (offset = min_data_len; offset <= max_data_len; offset++) {
141 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
142 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
143 PSA_HASH_MAX_SIZE, &hash_length));
144 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100145 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100146 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100147
148 if (offset < max_data_len) {
149 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
150 }
151 }
152
153 /* Abort current operation to prepare for final operation */
154 PSA_CHK(psa_hash_abort(&operation));
155
156 /* Calculate okey */
157 for (i = 0; i < mac_key_length; i++) {
158 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
159 }
160 for (; i < block_size; ++i) {
161 key_buf[i] = 0x5C;
162 }
163
164 /* Now compute HASH(okey + inner_hash) */
165 PSA_CHK(psa_hash_setup(&operation, hash_alg));
166 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
167 PSA_CHK(psa_hash_update(&operation, output, hash_size));
168 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
169
170#undef PSA_CHK
171
172cleanup:
173 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
174 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
175
176 psa_hash_abort(&operation);
177 psa_hash_abort(&aux_operation);
178 return PSA_TO_MBEDTLS_ERR(status);
179}
180
181#undef MAX_HASH_BLOCK_LENGTH
182
183#else
184MBEDTLS_STATIC_TESTABLE
185int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
186 const unsigned char *add_data,
187 size_t add_data_len,
188 const unsigned char *data,
189 size_t data_len_secret,
190 size_t min_data_len,
191 size_t max_data_len,
192 unsigned char *output)
193{
194 /*
195 * This function breaks the HMAC abstraction and uses the md_clone()
196 * extension to the MD API in order to get constant-flow behaviour.
197 *
198 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
199 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
200 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
201 *
202 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
203 * minlen, then cloning the context, and for each byte up to maxlen
204 * finishing up the hash computation, keeping only the correct result.
205 *
206 * Then we only need to compute HASH(okey + inner_hash) and we're done.
207 */
208 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
209 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
210 * all of which have the same block size except SHA-384. */
211 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
212 const unsigned char * const ikey = ctx->hmac_ctx;
213 const unsigned char * const okey = ikey + block_size;
214 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
215
216 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
217 mbedtls_md_context_t aux;
218 size_t offset;
219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
220
221 mbedtls_md_init(&aux);
222
223#define MD_CHK(func_call) \
224 do { \
225 ret = (func_call); \
226 if (ret != 0) \
227 goto cleanup; \
228 } while (0)
229
230 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
231
232 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
233 * so we can start directly with the message */
234 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
235 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
236
237 /* Fill the hash buffer in advance with something that is
238 * not a valid hash (barring an attack on the hash and
239 * deliberately-crafted input), in case the caller doesn't
240 * check the return status properly. */
241 memset(output, '!', hash_size);
242
243 /* For each possible length, compute the hash up to that point */
244 for (offset = min_data_len; offset <= max_data_len; offset++) {
245 MD_CHK(mbedtls_md_clone(&aux, ctx));
246 MD_CHK(mbedtls_md_finish(&aux, aux_out));
247 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100248 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100249 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100250
251 if (offset < max_data_len) {
252 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
253 }
254 }
255
256 /* The context needs to finish() before it starts() again */
257 MD_CHK(mbedtls_md_finish(ctx, aux_out));
258
259 /* Now compute HASH(okey + inner_hash) */
260 MD_CHK(mbedtls_md_starts(ctx));
261 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
262 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
263 MD_CHK(mbedtls_md_finish(ctx, output));
264
265 /* Done, get ready for next time */
266 MD_CHK(mbedtls_md_hmac_reset(ctx));
267
268#undef MD_CHK
269
270cleanup:
271 mbedtls_md_free(&aux);
272 return ret;
273}
274
275#endif /* MBEDTLS_USE_PSA_CRYPTO */
276
277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
278
Gilles Peskine449bd832023-01-11 14:50:10 +0100279static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100280
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200281/*
282 * Start a timer.
283 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200284 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100285void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200286{
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200288 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
292 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293}
294
295/*
296 * Return -1 is timer is expired, 0 if it isn't.
297 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200299{
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (ssl->f_get_timer == NULL) {
301 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200302 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 if (ssl->f_get_timer(ssl->p_timer) == 2) {
305 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
306 return -1;
307 }
308
309 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200310}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100313static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
314 unsigned char *buf,
315 size_t len,
316 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200317
Gilles Peskine449bd832023-01-11 14:50:10 +0100318int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
319 unsigned char *buf,
320 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200321{
322 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
324 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200325
326 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200327 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200328 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200330 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
331 goto exit;
332 }
333#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200335 mbedtls_record rec;
336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
338 if (ret != 0) {
339 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 goto exit;
341 }
342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 if (ssl->transform_in != NULL) {
344 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
345 if (ret != 0) {
346 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 goto exit;
348 }
349 }
350 }
351#endif /* MBEDTLS_SSL_PROTO_DTLS */
352
353exit:
354 /* On success, we have decrypted the buffer in-place, so make
355 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200357
358 /* For the purpose of this API, treat messages with unexpected CID
359 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
361 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200362 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
363 }
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
366 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200367}
368
Hanno Becker67bc7c32018-08-06 11:33:50 +0100369#define SSL_DONT_FORCE_FLUSH 0
370#define SSL_FORCE_FLUSH 1
371
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100373
Hanno Beckerd5847772018-08-28 10:09:23 +0100374/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100375static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
376 uint8_t slot);
377static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200378MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100379static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100381static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200382MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100383static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100385static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
386 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100388static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100391{
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000393#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
394 size_t out_buf_len = ssl->out_buf_len;
395#else
396 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
397#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (mtu != 0 && mtu < out_buf_len) {
400 return mtu;
401 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100402
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100404}
405
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100407static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100408{
Hanno Becker11682cc2018-08-22 14:41:02 +0100409 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100411
412 /* Double-check that the write-index hasn't gone
413 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100415 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100417 }
418
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420}
421
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100423static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100424{
Janos Follath865b3eb2019-12-16 11:46:15 +0000425 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100426 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400427 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100428
429#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100431
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100433 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100435
436 /* By the standard (RFC 6066 Sect. 4), the MFL extension
437 * only limits the maximum record payload size, so in theory
438 * we would be allowed to pack multiple records of payload size
439 * MFL into a single datagram. However, this would mean that there's
440 * no way to explicitly communicate MTU restrictions to the peer.
441 *
442 * The following reduction of max_len makes sure that we never
443 * write datagrams larger than MFL + Record Expansion Overhead.
444 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (max_len <= ssl->out_left) {
446 return 0;
447 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100448
449 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100450#endif
451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 ret = ssl_get_remaining_space_in_datagram(ssl);
453 if (ret < 0) {
454 return ret;
455 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100456 remaining = (size_t) ret;
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 ret = mbedtls_ssl_get_record_expansion(ssl);
459 if (ret < 0) {
460 return ret;
461 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462 expansion = (size_t) ret;
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 if (remaining <= expansion) {
465 return 0;
466 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100467
468 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100470 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474}
475
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200476/*
477 * Double the retransmit timeout value, within the allowed range,
478 * returning -1 if the maximum value has already been reached.
479 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100481static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200482{
483 uint32_t new_timeout;
484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
486 return -1;
487 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200489 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
490 * in the following way: after the initial transmission and a first
491 * retransmission, back off to a temporary estimated MTU of 508 bytes.
492 * This value is guaranteed to be deliverable (if not guaranteed to be
493 * delivered) of any compliant IPv4 (and IPv6) network, and should work
494 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200496 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400498 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200499
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500 new_timeout = 2 * ssl->handshake->retransmit_timeout;
501
502 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (new_timeout < ssl->handshake->retransmit_timeout ||
504 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200505 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200506 }
507
508 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
510 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200513}
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200516{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
519 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200520}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200522
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100523/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000524 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200525 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000526
Ronald Cron6f135e12021-12-08 16:57:54 +0100527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100528
Gilles Peskine449bd832023-01-11 14:50:10 +0100529static size_t ssl_compute_padding_length(size_t len,
530 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100531{
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100533}
534
Hanno Becker581bc1b2020-05-04 12:20:03 +0100535/* This functions transforms a (D)TLS plaintext fragment and a record content
536 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
537 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
538 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100539 *
540 * struct {
541 * opaque content[DTLSPlaintext.length];
542 * ContentType real_type;
543 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100544 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100545 *
546 * Input:
547 * - `content`: The beginning of the buffer holding the
548 * plaintext to be wrapped.
549 * - `*content_size`: The length of the plaintext in Bytes.
550 * - `max_len`: The number of Bytes available starting from
551 * `content`. This must be `>= *content_size`.
552 * - `rec_type`: The desired record content type.
553 *
554 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100555 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
556 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Returns:
559 * - `0` on success.
560 * - A negative error code if `max_len` didn't offer enough space
561 * for the expansion.
562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100564static int ssl_build_inner_plaintext(unsigned char *content,
565 size_t *content_size,
566 size_t remaining,
567 uint8_t rec_type,
568 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569{
570 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100571
572 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (remaining == 0) {
574 return -1;
575 }
576 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100577 len++;
578 remaining--;
579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if (remaining < pad) {
581 return -1;
582 }
583 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100584 len += pad;
585 remaining -= pad;
586
587 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589}
590
Hanno Becker581bc1b2020-05-04 12:20:03 +0100591/* This function parses a (D)TLSInnerPlaintext structure.
592 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200593MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100594static int ssl_parse_inner_plaintext(unsigned char const *content,
595 size_t *content_size,
596 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100597{
598 size_t remaining = *content_size;
599
600 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 do {
602 if (remaining == 0) {
603 return -1;
604 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100605 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100607
608 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100610
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100612}
Ronald Cron6f135e12021-12-08 16:57:54 +0100613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200615/* The size of the `add_data` structure depends on various
616 * factors, namely
617 *
618 * 1) CID functionality disabled
619 *
620 * additional_data =
621 * 8: seq_num +
622 * 1: type +
623 * 2: version +
624 * 2: length of inner plaintext +
625 *
626 * size = 13 bytes
627 *
628 * 2) CID functionality based on RFC 9146 enabled
629 *
630 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
631 * = 23 + CID-length
632 *
633 * 3) CID functionality based on legacy CID version
634 according to draft-ietf-tls-dtls-connection-id-05
635 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
636 *
637 * size = 13 + 1 + CID-length
638 *
639 * More information about the CID usage:
640 *
641 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
642 * size of the additional data structure is calculated as:
643 *
644 * additional_data =
645 * 8: seq_num +
646 * 1: tls12_cid +
647 * 2: DTLSCipherText.version +
648 * n: cid +
649 * 1: cid_length +
650 * 2: length_of_DTLSInnerPlaintext
651 *
652 * Per RFC 9146 the size of the add_data structure is calculated as:
653 *
654 * additional_data =
655 * 8: seq_num_placeholder +
656 * 1: tls12_cid +
657 * 1: cid_length +
658 * 1: tls12_cid +
659 * 2: DTLSCiphertext.version +
660 * 2: epoch +
661 * 6: sequence_number +
662 * n: cid +
663 * 2: length_of_DTLSInnerPlaintext
664 *
665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666static void ssl_extract_add_data_from_record(unsigned char *add_data,
667 size_t *add_data_len,
668 mbedtls_record *rec,
669 mbedtls_ssl_protocol_version
670 tls_version,
671 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000672{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200673 /* Several types of ciphers have been defined for use with TLS and DTLS,
674 * and the MAC calculations for those ciphers differ slightly. Further
675 * variants were added when the CID functionality was added with RFC 9146.
676 * This implementations also considers the use of a legacy version of the
677 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
678 * which is used in deployments.
679 *
680 * We will distinguish between the non-CID and the CID cases below.
681 *
682 * --- Non-CID cases ---
683 *
684 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100685 *
686 * additional_data = seq_num + TLSCompressed.type +
687 * TLSCompressed.version + TLSCompressed.length;
688 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100689 * For TLS 1.3, the record sequence number is dropped from the AAD
690 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000691 * Moreover, the additional data involves the length of the TLS
692 * ciphertext, not the TLS plaintext as in earlier versions.
693 * Quoting RFC 8446 (TLS 1.3):
694 *
695 * additional_data = TLSCiphertext.opaque_type ||
696 * TLSCiphertext.legacy_record_version ||
697 * TLSCiphertext.length
698 *
699 * We pass the tag length to this function in order to compute the
700 * ciphertext length from the inner plaintext length rec->data_len via
701 *
702 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
703 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200704 * --- CID cases ---
705 *
706 * RFC 9146 uses a common pattern when constructing the data
707 * passed into a MAC / AEAD cipher.
708 *
709 * Data concatenation for MACs used with block ciphers with
710 * Encrypt-then-MAC Processing (with CID):
711 *
712 * data = seq_num_placeholder +
713 * tls12_cid +
714 * cid_length +
715 * tls12_cid +
716 * DTLSCiphertext.version +
717 * epoch +
718 * sequence_number +
719 * cid +
720 * DTLSCiphertext.length +
721 * IV +
722 * ENC(content + padding + padding_length)
723 *
724 * Data concatenation for MACs used with block ciphers (with CID):
725 *
726 * data = seq_num_placeholder +
727 * tls12_cid +
728 * cid_length +
729 * tls12_cid +
730 * DTLSCiphertext.version +
731 * epoch +
732 * sequence_number +
733 * cid +
734 * length_of_DTLSInnerPlaintext +
735 * DTLSInnerPlaintext.content +
736 * DTLSInnerPlaintext.real_type +
737 * DTLSInnerPlaintext.zeros
738 *
739 * AEAD ciphers use the following additional data calculation (with CIDs):
740 *
741 * additional_data = seq_num_placeholder +
742 * tls12_cid +
743 * cid_length +
744 * tls12_cid +
745 * DTLSCiphertext.version +
746 * epoch +
747 * sequence_number +
748 * cid +
749 * length_of_DTLSInnerPlaintext
750 *
751 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
752 * defines the additional data calculation as follows:
753 *
754 * additional_data = seq_num +
755 * tls12_cid +
756 * DTLSCipherText.version +
757 * cid +
758 * cid_length +
759 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100761
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100762 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000763 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100764
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200765#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
766 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
767 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
768#endif
769
Ronald Cron6f135e12021-12-08 16:57:54 +0100770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000772 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
773 * which differs from the length of the TLSInnerPlaintext
774 * by the length of the authentication tag. */
775 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100778 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400779 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000780 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200781
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100782#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
784 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200785 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
787 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200788
789 // tls12_cid type
790 *cur = rec->type;
791 cur++;
792
793 // cid_length
794 *cur = rec->cid_len;
795 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200798 {
799 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 memcpy(cur, rec->ctr, sizeof(rec->ctr));
801 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200802 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100803 }
804
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200805 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100806 *cur = rec->type;
807 cur++;
808
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200809 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 memcpy(cur, rec->ver, sizeof(rec->ver));
811 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100812
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200813#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
814 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // CID
818 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100819 cur += rec->cid_len;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100822 *cur = rec->cid_len;
823 cur++;
824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825 // length of inner plaintext
826 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
827 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
830 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // epoch + sequence number
834 memcpy(cur, rec->ctr, sizeof(rec->ctr));
835 cur += sizeof(rec->ctr);
836
837 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200839 cur += rec->cid_len;
840
841 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100843 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100845#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100846 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100848 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100849 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100850
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000851 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852}
853
Valerio Settie5707042023-10-11 11:54:42 +0200854#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200855MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100856static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100858{
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100860}
861
Hanno Becker17263802020-05-28 07:05:48 +0100862/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
863 *
864 * Concretely, this occurs in two variants:
865 *
866 * a) Fixed and dynamic IV lengths add up to total IV length, giving
867 * IV = fixed_iv || dynamic_iv
868 *
Hanno Becker15952812020-06-04 13:31:46 +0100869 * This variant is used in TLS 1.2 when used with GCM or CCM.
870 *
Hanno Becker17263802020-05-28 07:05:48 +0100871 * b) Fixed IV lengths matches total IV length, giving
872 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100873 *
874 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
875 *
876 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100877 *
878 * This function has the precondition that
879 *
880 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
881 *
882 * which has to be ensured by the caller. If this precondition
883 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100884 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100885static void ssl_build_record_nonce(unsigned char *dst_iv,
886 size_t dst_iv_len,
887 unsigned char const *fixed_iv,
888 size_t fixed_iv_len,
889 unsigned char const *dynamic_iv,
890 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100891{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100892 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 memset(dst_iv, 0, dst_iv_len);
894 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100895
Hanno Becker17263802020-05-28 07:05:48 +0100896 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100898}
Valerio Settie5707042023-10-11 11:54:42 +0200899#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
902 mbedtls_ssl_transform *transform,
903 mbedtls_record *rec,
904 int (*f_rng)(void *, unsigned char *, size_t),
905 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000906{
Neil Armstrong136f8402022-03-30 10:58:01 +0200907 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100908 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200910 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 * the description of ssl_extract_add_data_from_record().
912 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200913#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
914 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
915#else
916 unsigned char add_data[13];
917#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100918 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 size_t post_avail;
920
921 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000922#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200923 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000924 ((void) ssl);
925#endif
926
927 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200928 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100929#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
930 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000931 ((void) f_rng);
932 ((void) p_rng);
933#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000936
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (transform == NULL) {
938 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
939 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000940 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100942 || rec->buf == NULL
943 || rec->buf_len < rec->data_offset
944 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100945#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100946 || rec->cid_len != 0
947#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 ) {
949 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
950 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100951 }
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200954
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000955 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
957 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
958 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
961 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
962 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
963 rec->data_len,
964 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000966 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100967
Hanno Becker92313402020-05-20 13:58:58 +0100968 /* The following two code paths implement the (D)TLSInnerPlaintext
969 * structure present in TLS 1.3 and DTLS 1.2 + CID.
970 *
971 * See ssl_build_inner_plaintext() for more information.
972 *
973 * Note that this changes `rec->data_len`, and hence
974 * `post_avail` needs to be recalculated afterwards.
975 *
976 * Note also that the two code paths cannot occur simultaneously
977 * since they apply to different versions of the protocol. There
978 * is hence no risk of double-addition of the inner plaintext.
979 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100980#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100982 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 ssl_compute_padding_length(rec->data_len,
984 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
985 if (ssl_build_inner_plaintext(data,
986 &rec->data_len,
987 post_avail,
988 rec->type,
989 padding) != 0) {
990 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100991 }
992
993 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
994 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100995#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100996
Hanno Beckera0e20d02019-05-15 14:03:01 +0100997#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100998 /*
999 * Add CID information
1000 */
1001 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1003 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001006 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl_compute_padding_length(rec->data_len,
1008 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001009 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001010 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001011 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001012 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001013 * Note that this changes `rec->data_len`, and hence
1014 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 if (ssl_build_inner_plaintext(data,
1017 &rec->data_len,
1018 post_avail,
1019 rec->type,
1020 padding) != 0) {
1021 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001022 }
1023
1024 rec->type = MBEDTLS_SSL_MSG_CID;
1025 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001026#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001029
Paul Bakker5121ce52009-01-03 21:22:43 +00001030 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001031 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001032 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001033#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1035 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1036 if (post_avail < transform->maclen) {
1037 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1038 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001039 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001041 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001042 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001043#if defined(MBEDTLS_USE_PSA_CRYPTO)
1044 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1046 size_t sign_mac_length = 0;
1047#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1050 transform->tls_version,
1051 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001052
Neil Armstrong26e6d672022-02-23 09:30:33 +01001053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1055 transform->psa_mac_alg);
1056 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001057 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 status = psa_mac_update(&operation, add_data, add_data_len);
1061 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001062 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 status = psa_mac_update(&operation, data, rec->data_len);
1066 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1071 &sign_mac_length);
1072 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001073 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001075#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1077 add_data_len);
1078 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001079 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 }
1081 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1082 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001083 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 }
1085 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1086 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
1089 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1090 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001091 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001094
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001096#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1099 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001100
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001101 rec->data_len += transform->maclen;
1102 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001103 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105hmac_failed_etm_disabled:
1106 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001108 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 status = psa_mac_abort(&operation);
1110 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001111 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001113#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 if (ret != 0) {
1115 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1116 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001117 }
Paul Bakker577e0062013-08-28 11:57:20 +02001118 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001119#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001120
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001121 /*
1122 * Encrypt
1123 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001124#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1126 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1127 "including %d bytes of padding",
1128 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001129
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001130 /* The only supported stream cipher is "NULL",
1131 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001134
Valerio Settie5707042023-10-11 11:54:42 +02001135#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001137 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001138 unsigned char *dynamic_iv;
1139 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001140 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001142#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001143 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001144#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001146
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001147 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (post_avail < transform->taglen) {
1149 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1150 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001151 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001152
Paul Bakker68884e32013-01-07 18:20:04 +01001153 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001154 * Build nonce for AEAD encryption.
1155 *
1156 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1157 * part of the IV is prepended to the ciphertext and
1158 * can be chosen freely - in particular, it need not
1159 * agree with the record sequence number.
1160 * However, since ChaChaPoly as well as all AEAD modes
1161 * in TLS 1.3 use the record sequence number as the
1162 * dynamic part of the nonce, we uniformly use the
1163 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001164 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001165 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 ssl_build_record_nonce(iv, sizeof(iv),
1169 transform->iv_enc,
1170 transform->fixed_ivlen,
1171 dynamic_iv,
1172 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001173
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001174 /*
1175 * Build additional data for AEAD encryption.
1176 * This depends on the TLS version.
1177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1179 transform->tls_version,
1180 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001181
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1183 iv, transform->ivlen);
1184 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1185 dynamic_iv,
1186 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1187 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1188 add_data, add_data_len);
1189 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1190 "including 0 bytes of padding",
1191 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001192
Paul Bakker68884e32013-01-07 18:20:04 +01001193 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001194 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001195 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001196#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 status = psa_aead_encrypt(transform->psa_key_enc,
1198 transform->psa_alg,
1199 iv, transform->ivlen,
1200 add_data, add_data_len,
1201 data, rec->data_len,
1202 data, rec->buf_len - (data - rec->buf),
1203 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001206 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1208 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001209 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001210#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1212 iv, transform->ivlen,
1213 add_data, add_data_len,
1214 data, rec->data_len, /* src */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001215 data, rec->buf_len - (size_t) (data - rec->buf), /* dst */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 &rec->data_len,
1217 transform->taglen)) != 0) {
1218 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1219 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001220 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001221#endif /* MBEDTLS_USE_PSA_CRYPTO */
1222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1224 data + rec->data_len - transform->taglen,
1225 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001226 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001227 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001228
1229 /*
1230 * Prefix record content with dynamic IV in case it is explicit.
1231 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (dynamic_iv_is_explicit != 0) {
1233 if (rec->data_offset < dynamic_iv_len) {
1234 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1235 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001236 }
1237
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001239 rec->data_offset -= dynamic_iv_len;
1240 rec->data_len += dynamic_iv_len;
1241 }
1242
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001243 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Valerio Settie5707042023-10-11 11:54:42 +02001245#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001246#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1248 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001250 size_t padlen, i;
1251 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001252#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001254 size_t part_len;
1255 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1256#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001257
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001258 /* Currently we're always using minimal padding
1259 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1261 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001263 }
1264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 /* Check there's enough space in the buffer for the padding. */
1266 if (post_avail < padlen + 1) {
1267 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1268 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1269 }
1270
1271 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001272 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001274
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001275 rec->data_len += padlen + 1;
1276 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001277
TRodziewicz0f82ec62021-05-12 17:49:18 +02001278#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001279 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001280 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001281 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if (f_rng == NULL) {
1284 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1285 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001286 }
TRodziewicz345165c2021-07-06 13:42:11 +02001287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 if (rec->data_offset < transform->ivlen) {
1289 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1290 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001291 }
1292
1293 /*
1294 * Generate IV
1295 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1297 if (ret != 0) {
1298 return ret;
1299 }
TRodziewicz345165c2021-07-06 13:42:11 +02001300
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001302#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1305 "including %"
1306 MBEDTLS_PRINTF_SIZET
1307 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1308 rec->data_len, transform->ivlen,
1309 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001310
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001311#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 status = psa_cipher_encrypt_setup(&cipher_op,
1313 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001316 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1318 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001319 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001324 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1326 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001327
1328 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 status = psa_cipher_update(&cipher_op,
1331 data, rec->data_len,
1332 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001335 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1337 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001338
1339 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 status = psa_cipher_finish(&cipher_op,
1342 data + olen, rec->data_len - olen,
1343 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001346 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1348 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001349
1350 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001351
1352 olen += part_len;
1353#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1355 transform->iv_enc,
1356 transform->ivlen,
1357 data, rec->data_len,
1358 data, &olen)) != 0) {
1359 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1360 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001361 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001362#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (rec->data_len != olen) {
1365 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1366 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001367 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001368
TRodziewicz0f82ec62021-05-12 17:49:18 +02001369 data -= transform->ivlen;
1370 rec->data_offset -= transform->ivlen;
1371 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001375 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001376#if defined(MBEDTLS_USE_PSA_CRYPTO)
1377 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1378 size_t sign_mac_length = 0;
1379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001380
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001381 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001382 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 if (post_avail < transform->maclen) {
1385 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1386 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001387 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 ssl_extract_add_data_from_record(add_data, &add_data_len,
1390 rec, transform->tls_version,
1391 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1394 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1395 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001396#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1398 transform->psa_mac_alg);
1399 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001400 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 status = psa_mac_update(&operation, add_data, add_data_len);
1404 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001405 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 status = psa_mac_update(&operation, data, rec->data_len);
1409 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001410 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1414 &sign_mac_length);
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#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1421 add_data_len);
1422 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001423 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 }
1425 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1426 data, rec->data_len);
1427 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001428 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 }
1430 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1431 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001432 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 }
1434 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1435 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001436 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001438#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001439
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001441
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001442 rec->data_len += transform->maclen;
1443 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001444 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446hmac_failed_etm_enabled:
1447 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001448#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001449 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 status = psa_mac_abort(&operation);
1451 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001452 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001454#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 if (ret != 0) {
1456 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1457 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001458 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001459 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001462#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001463 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1465 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001466 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001467
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001468 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 if (auth_done != 1) {
1470 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001472 }
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001477}
1478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1480 mbedtls_ssl_transform *transform,
1481 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001482{
Valerio Settie5707042023-10-11 11:54:42 +02001483#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001485#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001486 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001487 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001488
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001489 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001490#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001491 size_t padlen = 0;
1492 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001493#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001495 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 * the description of ssl_extract_add_data_from_record().
1497 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001498#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1499 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1500#else
1501 unsigned char add_data[13];
1502#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001503 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001504
Hanno Beckera18d1322018-01-03 14:27:32 +00001505#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001506 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001507 ((void) ssl);
1508#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1511 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 rec->buf == NULL ||
1513 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 rec->buf_len - rec->data_offset < rec->data_len) {
1515 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1516 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001517 }
1518
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Hanno Beckera0e20d02019-05-15 14:03:01 +01001522#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001523 /*
1524 * Match record's CID with incoming CID.
1525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (rec->cid_len != transform->in_cid_len ||
1527 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1528 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001529 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001530#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001531
Hanno Beckerd086bf02021-03-22 13:01:27 +00001532#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001534 if (rec->data_len < transform->maclen) {
1535 MBEDTLS_SSL_DEBUG_MSG(1,
1536 ("Record too short for MAC:"
1537 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1538 rec->data_len, transform->maclen));
1539 return MBEDTLS_ERR_SSL_INVALID_MAC;
1540 }
1541
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001542 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001543 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001545#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001546#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001548 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001549 unsigned char *dynamic_iv;
1550 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001551#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001553#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001554
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001555 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001556 * Extract dynamic part of nonce for AEAD decryption.
1557 *
1558 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1559 * part of the IV is prepended to the ciphertext and
1560 * can be chosen freely - in particular, it need not
1561 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 dynamic_iv_len = sizeof(rec->ctr);
1564 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1565 if (rec->data_len < dynamic_iv_len) {
1566 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1567 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1568 rec->data_len,
1569 dynamic_iv_len));
1570 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001571 }
1572 dynamic_iv = data;
1573
1574 data += dynamic_iv_len;
1575 rec->data_offset += dynamic_iv_len;
1576 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001578 dynamic_iv = rec->ctr;
1579 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001580
1581 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 if (rec->data_len < transform->taglen) {
1583 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1584 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1585 rec->data_len,
1586 transform->taglen));
1587 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001588 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001589 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001590
Hanno Beckerdf8be222020-05-21 15:30:57 +01001591 /*
1592 * Prepare nonce from dynamic and static parts.
1593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 ssl_build_record_nonce(iv, sizeof(iv),
1595 transform->iv_dec,
1596 transform->fixed_ivlen,
1597 dynamic_iv,
1598 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001599
Hanno Beckerdf8be222020-05-21 15:30:57 +01001600 /*
1601 * Build additional data for AEAD encryption.
1602 * This depends on the TLS version.
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1605 transform->tls_version,
1606 transform->taglen);
1607 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1608 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001609
Hanno Beckerd96a6522019-07-10 13:55:25 +01001610 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001611 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001612 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001613 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001614 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1617 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1618 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001619
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001620 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001621 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001622 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001623#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 status = psa_aead_decrypt(transform->psa_key_dec,
1625 transform->psa_alg,
1626 iv, transform->ivlen,
1627 add_data, add_data_len,
1628 data, rec->data_len + transform->taglen,
1629 data, rec->buf_len - (data - rec->buf),
1630 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001633 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1635 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001636 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001637#else
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001638 if ((ret = mbedtls_cipher_auth_decrypt_ext
1639 (&transform->cipher_ctx_dec,
1640 iv, transform->ivlen,
1641 add_data, add_data_len,
1642 data, rec->data_len + transform->taglen, /* src */
1643 data, rec->buf_len - (size_t) (data - rec->buf), &olen, /* dst */
1644 transform->taglen)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1648 return MBEDTLS_ERR_SSL_INVALID_MAC;
1649 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001652 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001653#endif /* MBEDTLS_USE_PSA_CRYPTO */
1654
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001655 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001656
Hanno Beckerd96a6522019-07-10 13:55:25 +01001657 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 if (olen != rec->data_len) {
1659 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1660 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001661 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 } else
Valerio Settie5707042023-10-11 11:54:42 +02001663#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1666 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001667 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001668#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001670 size_t part_len;
1671 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1672#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001673
Paul Bakker5121ce52009-01-03 21:22:43 +00001674 /*
Paul Bakker45829992013-01-03 14:52:21 +01001675 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001677#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001678 /* The ciphertext is prefixed with the CBC IV. */
1679 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001680#endif
Paul Bakker45829992013-01-03 14:52:21 +01001681
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001682 /* Size considerations:
1683 *
1684 * - The CBC cipher text must not be empty and hence
1685 * at least of size transform->ivlen.
1686 *
1687 * Together with the potential IV-prefix, this explains
1688 * the first of the two checks below.
1689 *
1690 * - The record must contain a MAC, either in plain or
1691 * encrypted, depending on whether Encrypt-then-MAC
1692 * is used or not.
1693 * - If it is, the message contains the IV-prefix,
1694 * the CBC ciphertext, and the MAC.
1695 * - If it is not, the padded plaintext, and hence
1696 * the CBC ciphertext, has at least length maclen + 1
1697 * because there is at least the padding length byte.
1698 *
1699 * As the CBC ciphertext is not empty, both cases give the
1700 * lower bound minlen + maclen + 1 on the record size, which
1701 * we test for in the second check below.
1702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 if (rec->data_len < minlen + transform->ivlen ||
1704 rec->data_len < minlen + transform->maclen + 1) {
1705 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1706 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1707 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1708 "+ 1 ) ( + expl IV )",
1709 rec->data_len,
1710 transform->ivlen,
1711 transform->maclen));
1712 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001713 }
1714
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001715 /*
1716 * Authenticate before decrypt if enabled
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001720#if defined(MBEDTLS_USE_PSA_CRYPTO)
1721 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1722#else
Hanno Becker992b6872017-11-09 18:57:39 +00001723 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001724#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001727
Hanno Beckerd96a6522019-07-10 13:55:25 +01001728 /* Update data_len in tandem with add_data.
1729 *
1730 * The subtraction is safe because of the previous check
1731 * data_len >= minlen + maclen + 1.
1732 *
1733 * Afterwards, we know that data + data_len is followed by at
1734 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001735 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001736 *
1737 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001738 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1740 transform->tls_version,
1741 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001742
Hanno Beckerd96a6522019-07-10 13:55:25 +01001743 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1745 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001746#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1748 transform->psa_mac_alg);
1749 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001750 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 status = psa_mac_update(&operation, add_data, add_data_len);
1754 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001755 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 status = psa_mac_update(&operation, data, rec->data_len);
1759 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001760 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001762
1763 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1765 transform->maclen);
1766 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001767 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001769#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1771 add_data_len);
1772 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001773 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 }
1775 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1776 data, rec->data_len);
1777 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001778 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 }
1780 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1781 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001782 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 }
1784 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
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 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1790 transform->maclen);
1791 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1792 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001793
Hanno Beckerd96a6522019-07-10 13:55:25 +01001794 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1796 transform->maclen) != 0) {
1797 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001798 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1799 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001800 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001801#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001802 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001805#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001806 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 status = psa_mac_abort(&operation);
1808 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001809 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001811#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001813#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 if (ret != 0) {
1815 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1816 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1817 }
1818 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001819 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001820 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001822
1823 /*
1824 * Check length sanity
1825 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001826
1827 /* We know from above that data_len > minlen >= 0,
1828 * so the following check in particular implies that
1829 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (rec->data_len % transform->ivlen != 0) {
1831 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1832 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1833 rec->data_len, transform->ivlen));
1834 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001835 }
1836
TRodziewicz0f82ec62021-05-12 17:49:18 +02001837#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001838 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001839 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001840 */
TRodziewicz345165c2021-07-06 13:42:11 +02001841 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001843
TRodziewicz345165c2021-07-06 13:42:11 +02001844 data += transform->ivlen;
1845 rec->data_offset += transform->ivlen;
1846 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001847#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001848
Hanno Beckerd96a6522019-07-10 13:55:25 +01001849 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1850
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001851#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 status = psa_cipher_decrypt_setup(&cipher_op,
1853 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001856 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1858 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001859 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
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_set_iv", 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_update(&cipher_op,
1870 data, rec->data_len,
1871 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001874 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1876 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001877 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 status = psa_cipher_finish(&cipher_op,
1880 data + olen, rec->data_len - olen,
1881 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001884 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1886 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001887 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001888
1889 olen += part_len;
1890#else
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1893 transform->iv_dec, transform->ivlen,
1894 data, rec->data_len, data, &olen)) != 0) {
1895 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1896 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001897 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001898#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001899
Hanno Beckerd96a6522019-07-10 13:55:25 +01001900 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 if (rec->data_len != olen) {
1902 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1903 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001904 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001905
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001906 /* Safe since data_len >= minlen + maclen + 1, so after having
1907 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001908 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1909 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001910 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001913 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 rec->data_len,
1915 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001916 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001917 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (rec->data_len < transform->maclen + padlen + 1) {
1921 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1922 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1923 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1924 rec->data_len,
1925 transform->maclen,
1926 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001927 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001928#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001929 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 rec->data_len,
1931 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001932 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001933 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001934 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001935
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001936 padlen++;
1937
1938 /* Regardless of the validity of the padding,
1939 * we have data_len >= padlen here. */
1940
TRodziewicz0f82ec62021-05-12 17:49:18 +02001941#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001942 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 * consecutive memory reads at the end of the record
1944 * plaintext buffer. In order to hide the length and
1945 * validity of the padding, always perform exactly
1946 * `min(256,plaintext_len)` reads (but take into account
1947 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001948 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001950
1951 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001953 size_t const padding_idx = rec->data_len - padlen;
1954 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1955 size_t const start_idx = rec->data_len - num_checks;
1956 size_t idx;
1957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001959 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 * (check[idx] == padlen - 1);
1961 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001962 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001963 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001964 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001965 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001966 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001967 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001968 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001971 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1973 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001974#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001975 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001976
TRodziewicz0f82ec62021-05-12 17:49:18 +02001977#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001978
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001979 /* If the padding was found to be invalid, padlen == 0
1980 * and the subtraction is safe. If the padding was found valid,
1981 * padlen hasn't been changed and the previous assertion
1982 * data_len >= padlen still holds. */
1983 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001985#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001986 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1988 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001989 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001990
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001991#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1993 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001994#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001995
1996 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001997 * Authenticate if not done yet.
1998 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001999 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002000#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002002 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2003 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002004
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002005 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002006 * data_len < maclen + padlen + 1, then padlen
2007 * got reset to 1, and the initial check
2008 * data_len >= minlen + maclen + 1
2009 * guarantees that at this point we still
2010 * have at least data_len >= maclen.
2011 *
2012 * If the initial value of padlen was such that
2013 * data_len >= maclen + padlen + 1, then we have
2014 * subtracted either padlen + 1 (if the padding was correct)
2015 * or 0 (if the padding was incorrect) since then,
2016 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002017 *
2018 * For stream ciphers, we checked above that
2019 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002020 */
2021 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2023 transform->tls_version,
2024 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002025
TRodziewicz0f82ec62021-05-12 17:49:18 +02002026#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002027 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 * The next two sizes are the minimum and maximum values of
2029 * data_len over all padlen values.
2030 *
2031 * They're independent of padlen, since we previously did
2032 * data_len -= padlen.
2033 *
2034 * Note that max_len + maclen is never more than the buffer
2035 * length, as we previously did in_msglen -= maclen too.
2036 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002037 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002039
Neil Armstronge8589962022-02-25 15:14:29 +01002040#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2042 transform->psa_mac_alg,
2043 add_data, add_data_len,
2044 data, rec->data_len, min_len, max_len,
2045 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002046#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
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#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ret != 0) {
2053 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002054 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002055 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 mbedtls_ct_memcpy_offset(mac_peer, data,
2058 rec->data_len,
2059 min_len, max_len,
2060 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002061#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002062
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002063#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2065 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002066#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2069 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002072#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002073 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002074 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002075 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077hmac_failed_etm_disabled:
2078 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2079 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2080 if (ret != 0) {
2081 return ret;
2082 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002083 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002084
2085 /*
2086 * Finally check the correct flag
2087 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002088 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 return MBEDTLS_ERR_SSL_INVALID_MAC;
2090 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002091#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002092
2093 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (auth_done != 1) {
2095 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2096 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002097 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002098
Ronald Cron6f135e12021-12-08 16:57:54 +01002099#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002101 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2103 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (ret != 0) {
2106 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2107 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002108 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002109#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002110
Hanno Beckera0e20d02019-05-15 14:03:01 +01002111#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (rec->cid_len != 0) {
2113 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2114 &rec->type);
2115 if (ret != 0) {
2116 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2117 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002118 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002119#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002124}
2125
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002126#undef MAC_NONE
2127#undef MAC_PLAINTEXT
2128#undef MAC_CIPHERTEXT
2129
Paul Bakker5121ce52009-01-03 21:22:43 +00002130/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002131 * Fill the input message buffer by appending data to it.
2132 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002133 *
2134 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2135 * available (from this read and/or a previous one). Otherwise, an error code
2136 * is returned (possibly EOF or WANT_READ).
2137 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002138 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2139 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2140 * since we always read a whole datagram at once.
2141 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002142 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002143 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002145int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002146{
Janos Follath865b3eb2019-12-16 11:46:15 +00002147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002148 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002149#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2150 size_t in_buf_len = ssl->in_buf_len;
2151#else
2152 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2153#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2158 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002160 }
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2163 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002165 }
2166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002169 uint32_t timeout;
2170
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002171 /*
2172 * The point is, we need to always read a full datagram at once, so we
2173 * sometimes read more then requested, and handle the additional data.
2174 * It could be the rest of the current record (while fetching the
2175 * header) and/or some other records in the same datagram.
2176 */
2177
2178 /*
2179 * Move to the next record in the already read datagram if applicable
2180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (ssl->next_record_offset != 0) {
2182 if (ssl->in_left < ssl->next_record_offset) {
2183 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2184 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002185 }
2186
2187 ssl->in_left -= ssl->next_record_offset;
2188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (ssl->in_left != 0) {
2190 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2191 MBEDTLS_PRINTF_SIZET,
2192 ssl->next_record_offset));
2193 memmove(ssl->in_hdr,
2194 ssl->in_hdr + ssl->next_record_offset,
2195 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002196 }
2197
2198 ssl->next_record_offset = 0;
2199 }
2200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2202 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2203 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002204
2205 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002206 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (nb_want <= ssl->in_left) {
2209 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2210 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002211 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002212
2213 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002214 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002215 * are not at the beginning of a new record, the caller did something
2216 * wrong.
2217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (ssl->in_left != 0) {
2219 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2220 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002221 }
2222
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002223 /*
2224 * Don't even try to read if time's out already.
2225 * This avoids by-passing the timer when repeatedly receiving messages
2226 * that will end up being dropped.
2227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (mbedtls_ssl_check_timer(ssl) != 0) {
2229 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002230 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002232 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002235 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002237 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->f_recv_timeout != NULL) {
2243 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2244 timeout);
2245 } else {
2246 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2247 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (ret == 0) {
2252 return MBEDTLS_ERR_SSL_CONN_EOF;
2253 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002254 }
2255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2257 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2258 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2261 if (ssl_double_retransmit_timeout(ssl) != 0) {
2262 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2263 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002264 }
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2267 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2268 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002269 }
2270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002272 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2275 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2276 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2277 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2278 ret);
2279 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002280 }
2281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002283 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002285 }
2286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (ret < 0) {
2288 return ret;
2289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002290
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002291 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002293#endif
2294 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2296 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2297 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002300 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002303 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 } else {
2305 if (ssl->f_recv_timeout != NULL) {
2306 ret = ssl->f_recv_timeout(ssl->p_bio,
2307 ssl->in_hdr + ssl->in_left, len,
2308 ssl->conf->read_timeout);
2309 } else {
2310 ret = ssl->f_recv(ssl->p_bio,
2311 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002312 }
2313 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2316 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2317 ssl->in_left, nb_want));
2318 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (ret == 0) {
2321 return MBEDTLS_ERR_SSL_CONN_EOF;
2322 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (ret < 0) {
2325 return ret;
2326 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002327
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002328 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 MBEDTLS_SSL_DEBUG_MSG(1,
2330 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2331 " were requested",
2332 ret, len));
2333 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002334 }
2335
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002336 ssl->in_left += ret;
2337 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002338 }
2339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002343}
2344
2345/*
2346 * Flush any data not yet written
2347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002348int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002349{
Janos Follath865b3eb2019-12-16 11:46:15 +00002350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002351 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (ssl->f_send == NULL) {
2356 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2357 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002358 }
2359
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002360 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (ssl->out_left == 0) {
2362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2363 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002364 }
2365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 while (ssl->out_left > 0) {
2367 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2368 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2369 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002370
Hanno Becker2b1e3542018-08-06 11:19:13 +01002371 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (ret <= 0) {
2377 return ret;
2378 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002379
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002380 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 MBEDTLS_SSL_DEBUG_MSG(1,
2382 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2383 " bytes were sent",
2384 ret, ssl->out_left));
2385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002386 }
2387
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 ssl->out_left -= ret;
2389 }
2390
Hanno Becker2b1e3542018-08-06 11:19:13 +01002391#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002393 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002395#endif
2396 {
2397 ssl->out_hdr = ssl->out_buf + 8;
2398 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002404}
2405
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002406/*
2407 * Functions to handle the DTLS retransmission state machine
2408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410/*
2411 * Append current handshake message to current outgoing flight
2412 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002414static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002415{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2418 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2419 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420
2421 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2423 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2424 sizeof(mbedtls_ssl_flight_item)));
2425 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426 }
2427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2429 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2430 ssl->out_msglen));
2431 mbedtls_free(msg);
2432 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002433 }
2434
2435 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002438 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002439 msg->next = NULL;
2440
2441 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002443 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002449 cur->next = msg;
2450 }
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2453 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454}
2455
2456/*
2457 * Free the current flight of handshake messages
2458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002460{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 mbedtls_ssl_flight_item *cur = flight;
2462 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465 next = cur->next;
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 mbedtls_free(cur->p);
2468 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002469
2470 cur = next;
2471 }
2472}
2473
2474/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002475 * Swap transform_out and out_ctr with the alternative ones
2476 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002478static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002479{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002481 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2484 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2485 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002486 }
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002489
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002490 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002491 tmp_transform = ssl->transform_out;
2492 ssl->transform_out = ssl->handshake->alt_transform_out;
2493 ssl->handshake->alt_transform_out = tmp_transform;
2494
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002495 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2497 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2498 sizeof(ssl->cur_out_ctr));
2499 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2500 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002501
2502 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002506}
2507
2508/*
2509 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002512{
2513 int ret = 0;
2514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002522}
2523
2524/*
2525 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002526 *
2527 * Need to remember the current message in case flush_output returns
2528 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002529 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002531int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002532{
Janos Follath865b3eb2019-12-16 11:46:15 +00002533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2537 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002538
2539 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002540 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 ret = ssl_swap_epochs(ssl);
2542 if (ret != 0) {
2543 return ret;
2544 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002547 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002550 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002551 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002552
Hanno Beckere1dcb032018-08-17 16:47:58 +01002553 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2555 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002556
Ronald Cron00d012f22022-03-08 15:57:12 +01002557 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002559
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002560 /* Swap epochs before sending Finished: we can't do it after
2561 * sending ChangeCipherSpec, in case write returns WANT_READ.
2562 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2564 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2565 ret = ssl_swap_epochs(ssl);
2566 if (ret != 0) {
2567 return ret;
2568 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002569 }
2570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 ret = ssl_get_remaining_payload_in_datagram(ssl);
2572 if (ret < 0) {
2573 return ret;
2574 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002575 max_frag_len = (size_t) ret;
2576
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002577 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2579 if (max_frag_len == 0) {
2580 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2581 return ret;
2582 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002583
2584 continue;
2585 }
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002588 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002589 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002590
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002591 /* Update position inside current message */
2592 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002594 const unsigned char * const p = ssl->handshake->cur_msg_p;
2595 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002596 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002597 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002598 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2601 if (is_finished) {
2602 ret = ssl_swap_epochs(ssl);
2603 if (ret != 0) {
2604 return ret;
2605 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002606 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2609 return ret;
2610 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002611
2612 continue;
2613 }
2614 max_hs_frag_len = max_frag_len - 12;
2615
2616 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2620 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2621 (unsigned) cur_hs_frag_len,
2622 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002623 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002624
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002625 /* Messages are stored with handshake headers as if not fragmented,
2626 * copy beginning of headers then fill fragmentation fields.
2627 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2631 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2632 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2635 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2636 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002639
Hanno Becker3f7b9732018-08-28 09:53:25 +01002640 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002642 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002643 ssl->out_msgtype = cur->type;
2644
2645 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002646 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002647 }
2648
2649 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2651 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002652 ssl->handshake->cur_msg = cur->next;
2653 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002655 ssl->handshake->cur_msg = NULL;
2656 ssl->handshake->cur_msg_p = NULL;
2657 }
2658 }
2659
2660 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2662 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2663 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002664 }
2665 }
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2668 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002669 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 /* Update state and set timer */
2672 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2673 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2674 } else {
2675 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2676 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2677 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2680
2681 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002682}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002683
2684/*
2685 * To be called when the last message of an incoming flight is received.
2686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002688{
2689 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002691 ssl->handshake->flight = NULL;
2692 ssl->handshake->cur_msg = NULL;
2693
2694 /* The next incoming flight will start with this msg_seq */
2695 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2696
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002697 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002698 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002699
Hanno Becker0271f962018-08-16 13:23:47 +01002700 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002702
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002703 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2707 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002712}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002713
2714/*
2715 * To be called when the last message of an outgoing flight is send.
2716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002717void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002718{
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 ssl_reset_retransmit_timeout(ssl);
2720 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2723 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002728}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002730
Paul Bakker5121ce52009-01-03 21:22:43 +00002731/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002732 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002733 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002734int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002736{
2737 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002738 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002739 * ...
2740 * HandshakeType msg_type;
2741 * uint24 length;
2742 * ...
2743 */
2744 *buf = ssl->out_msg + 4;
2745 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2746
2747 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2748 ssl->out_msg[0] = hs_type;
2749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002751}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002752
2753/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002754 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002755 *
2756 * - fill in handshake headers
2757 * - update handshake checksum
2758 * - DTLS: save message for resending
2759 * - then pass to the record layer
2760 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002761 * DTLS: except for HelloRequest, messages are only queued, and will only be
2762 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002763 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002764 * Inputs:
2765 * - ssl->out_msglen: 4 + actual handshake message len
2766 * (4 is the size of handshake headers for TLS)
2767 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2768 * - ssl->out_msg + 4: the handshake message body
2769 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002770 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002771 * - ssl->out_msglen: the length of the record contents
2772 * (including handshake headers but excluding record headers)
2773 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002775int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2776 int update_checksum,
2777 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002778{
Janos Follath865b3eb2019-12-16 11:46:15 +00002779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002780 const size_t hs_len = ssl->out_msglen - 4;
2781 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002784
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002785 /*
2786 * Sanity checks
2787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2789 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2790 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2791 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002792 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002794 /* Whenever we send anything different from a
2795 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2797 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2798 ssl->handshake == NULL) {
2799 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2800 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002801 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002805 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2807 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2808 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002809 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002810#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002811
Hanno Beckerb50a2532018-08-06 11:52:54 +01002812 /* Double-check that we did not exceed the bounds
2813 * of the outgoing record buffer.
2814 * This should never fail as the various message
2815 * writing functions must obey the bounds of the
2816 * outgoing record buffer, but better be safe.
2817 *
2818 * Note: We deliberately do not check for the MTU or MFL here.
2819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2821 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2822 "size %" MBEDTLS_PRINTF_SIZET
2823 ", maximum %" MBEDTLS_PRINTF_SIZET,
2824 ssl->out_msglen,
2825 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002827 }
2828
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002829 /*
2830 * Fill handshake headers
2831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2833 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2834 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2835 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002836
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002837 /*
2838 * DTLS has additional fields in the Handshake layer,
2839 * between the length field and the actual payload:
2840 * uint16 message_seq;
2841 * uint24 fragment_offset;
2842 * uint24 fragment_length;
2843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002846 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2848 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2849 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2850 MBEDTLS_PRINTF_SIZET,
2851 hs_len,
2852 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002854 }
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002857 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002858
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002859 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2861 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2862 ++(ssl->handshake->out_msg_seq);
2863 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002864 ssl->out_msg[4] = 0;
2865 ssl->out_msg[5] = 0;
2866 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002867
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002868 /* Handshake hashes are computed without fragmentation,
2869 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 memset(ssl->out_msg + 6, 0x00, 3);
2871 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002872 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002874
Hanno Becker0207e532018-08-28 10:28:28 +01002875 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002877 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2878 ssl->out_msglen);
2879 if (ret != 0) {
2880 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2881 return ret;
2882 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002884 }
2885
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002886 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2889 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2890 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2891 if ((ret = ssl_flight_append(ssl)) != 0) {
2892 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2893 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002894 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002896#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002897 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2899 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2900 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002901 }
2902 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002907}
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2910 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002911{
2912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2913 size_t msg_with_header_len;
2914 ((void) buf_len);
2915
2916 /* Add reserved 4 bytes for handshake header */
2917 msg_with_header_len = msg_len + 4;
2918 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002920
2921cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002923}
2924
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002925/*
2926 * Record layer functions
2927 */
2928
2929/*
2930 * Write current record.
2931 *
2932 * Uses:
2933 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2934 * - ssl->out_msglen: length of the record content (excl headers)
2935 * - ssl->out_msg: record content
2936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002937int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002938{
2939 int ret, done = 0;
2940 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002941 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002946 unsigned i;
2947 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002948#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2949 size_t out_buf_len = ssl->out_buf_len;
2950#else
2951 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2952#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002953 /* Skip writing the record content type to after the encryption,
2954 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002955 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002956#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002957 /* TLS 1.3 still uses the TLS 1.2 version identifier
2958 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002960 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002962#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2964 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2967 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002970 mbedtls_record rec;
2971
2972 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002973 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002974 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002975 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2978 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002979 rec.type = ssl->out_msgtype;
2980
Hanno Beckera0e20d02019-05-15 14:03:01 +01002981#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002982 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002983 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002984#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2987 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2988 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2989 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002990 }
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (rec.data_offset != 0) {
2993 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2994 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002995 }
2996
Hanno Becker6430faf2019-05-08 11:57:13 +01002997 /* Update the record content type and CID. */
2998 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002999#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3000 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003001#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003002 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003004 }
3005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003007
3008#if defined(MBEDTLS_SSL_PROTO_DTLS)
3009 /* In case of DTLS, double-check that we don't exceed
3010 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3012 ret = ssl_get_remaining_space_in_datagram(ssl);
3013 if (ret < 0) {
3014 return ret;
3015 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003018 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003020 }
3021 }
3022#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003023
Hanno Becker6430faf2019-05-08 11:57:13 +01003024 /* Now write the potentially updated record content type. */
3025 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3028 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3029 ssl->out_hdr[0], ssl->out_hdr[1],
3030 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3033 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003034
3035 ssl->out_left += protected_record_size;
3036 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3040 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003041 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 }
3043 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003044
Gabor Mezei96ae9262022-06-28 11:45:18 +02003045 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (i == mbedtls_ssl_ep_len(ssl)) {
3047 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3048 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003049 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 }
3051
Hanno Becker67bc7c32018-08-06 11:33:50 +01003052#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3054 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003055 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 ret = ssl_get_remaining_payload_in_datagram(ssl);
3057 if (ret < 0) {
3058 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3059 ret);
3060 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003061 }
3062
3063 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003065 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 } else {
3067 MBEDTLS_SSL_DEBUG_MSG(2,
3068 ("Still %u bytes available in current datagram",
3069 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003070 }
3071 }
3072#endif /* MBEDTLS_SSL_PROTO_DTLS */
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 if ((flush == SSL_FORCE_FLUSH) &&
3075 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3076 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3077 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 }
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003083}
3084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003086
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003087MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003088static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003089{
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (ssl->in_msglen < ssl->in_hslen ||
3091 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3092 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3093 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003094 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003096}
Hanno Becker44650b72018-08-16 12:51:11 +01003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003099{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003100 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01003101}
3102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003104{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003105 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01003106}
3107
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003108MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003109static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003110{
3111 uint32_t msg_len, frag_off, frag_len;
3112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 msg_len = ssl_get_hs_total_len(ssl);
3114 frag_off = ssl_get_hs_frag_off(ssl);
3115 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 if (frag_off > msg_len) {
3118 return -1;
3119 }
Hanno Becker44650b72018-08-16 12:51:11 +01003120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 if (frag_len > msg_len - frag_off) {
3122 return -1;
3123 }
Hanno Becker44650b72018-08-16 12:51:11 +01003124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 if (frag_len + 12 > ssl->in_msglen) {
3126 return -1;
3127 }
Hanno Becker44650b72018-08-16 12:51:11 +01003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003130}
3131
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003132/*
3133 * Mark bits in bitmask (used for DTLS HS reassembly)
3134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003136{
3137 unsigned int start_bits, end_bits;
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 start_bits = 8 - (offset % 8);
3140 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003141 size_t first_byte_idx = offset / 8;
3142
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003143 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (len <= start_bits) {
3145 for (; len != 0; len--) {
3146 mask[first_byte_idx] |= 1 << (start_bits - len);
3147 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003148
3149 /* Avoid potential issues with offset or len becoming invalid */
3150 return;
3151 }
3152
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003153 offset += start_bits; /* Now offset % 8 == 0 */
3154 len -= start_bits;
3155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 for (; start_bits != 0; start_bits--) {
3157 mask[first_byte_idx] |= 1 << (start_bits - 1);
3158 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003159 }
3160
3161 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 if (end_bits != 0) {
3163 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003164
3165 len -= end_bits; /* Now len % 8 == 0 */
3166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 for (; end_bits != 0; end_bits--) {
3168 mask[last_byte_idx] |= 1 << (8 - end_bits);
3169 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003170 }
3171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173}
3174
3175/*
3176 * Check that bitmask is full
3177 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003179static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003180{
3181 size_t i;
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 for (i = 0; i < len / 8; i++) {
3184 if (mask[i] != 0xFF) {
3185 return -1;
3186 }
3187 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 for (i = 0; i < len % 8; i++) {
3190 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3191 return -1;
3192 }
3193 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003194
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003196}
3197
Hanno Becker56e205e2018-08-16 09:06:12 +01003198/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3200 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003201{
Hanno Becker56e205e2018-08-16 09:06:12 +01003202 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003203
Hanno Becker56e205e2018-08-16 09:06:12 +01003204 alloc_len = 12; /* Handshake header */
3205 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (add_bitmap) {
3208 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 }
3211 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003212}
Hanno Becker56e205e2018-08-16 09:06:12 +01003213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003217{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003218 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01003219}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003222{
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3224 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3225 ssl->in_msglen));
3226 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003227 }
3228
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00003229 if (ssl->in_hslen == 0) {
3230 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
3231 ssl->in_hsfraglen = 0;
3232 ssl->in_hshdr = ssl->in_hdr;
3233 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003234
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3236 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3237 MBEDTLS_PRINTF_SIZET,
3238 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003243 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 if (ssl_check_hs_header(ssl) != 0) {
3246 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3247 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003248 }
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (ssl->handshake != NULL &&
3251 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3252 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3253 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3254 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3255 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3256 MBEDTLS_SSL_DEBUG_MSG(2,
3257 (
3258 "received future handshake message of sequence number %u (next %u)",
3259 recv_msg_seq,
3260 ssl->handshake->in_msg_seq));
3261 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003262 }
3263
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003264 /* Retransmit only on last message from previous flight, to avoid
3265 * too many retransmissions.
3266 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3268 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3269 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3270 "message_seq = %u, start_of_flight = %u",
3271 recv_msg_seq,
3272 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3275 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3276 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003277 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 } else {
3279 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3280 "message_seq = %u, expected = %u",
3281 recv_msg_seq,
3282 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003283 }
3284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003286 }
3287 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003288
Hanno Becker6d97ef52018-08-16 13:09:04 +01003289 /* Message reassembly is handled alongside buffering of future
3290 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003291 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003292 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3294 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3295 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003296 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00003299 {
3300 int ret;
3301 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00003302 MBEDTLS_SSL_DEBUG_MSG(3,
3303 ("handshake fragment: %" MBEDTLS_PRINTF_SIZET " .. %"
3304 MBEDTLS_PRINTF_SIZET " of %"
3305 MBEDTLS_PRINTF_SIZET " msglen %" MBEDTLS_PRINTF_SIZET,
Deomid rojer Ryabkov1f4088c2025-01-18 15:58:57 +02003306 ssl->in_hsfraglen,
3307 ssl->in_hsfraglen +
3308 (hs_remain <= ssl->in_msglen ? hs_remain : ssl->in_msglen),
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00003309 ssl->in_hslen, ssl->in_msglen));
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00003310 if (ssl->in_msglen < hs_remain) {
3311 ssl->in_hsfraglen += ssl->in_msglen;
3312 ssl->in_hdr = ssl->in_msg + ssl->in_msglen;
3313 ssl->in_msglen = 0;
3314 mbedtls_ssl_update_in_pointers(ssl);
3315 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3316 }
3317 if (ssl->in_hshdr != ssl->in_hdr) {
3318 /*
3319 * At ssl->in_hshdr we have a sequence of records that cover the next handshake
3320 * record, each with its own record header that we need to remove.
3321 * Note that the reassembled record size may not equal the size of the message,
3322 * there maybe bytes from the next message following it.
3323 */
3324 size_t merged_rec_len = 0;
3325 unsigned char *p = ssl->in_hshdr, *q = NULL;
3326 do {
3327 mbedtls_record rec;
3328 ret = ssl_parse_record_header(ssl, p, mbedtls_ssl_in_hdr_len(ssl), &rec);
3329 if (ret != 0) {
3330 return ret;
3331 }
3332 merged_rec_len += rec.data_len;
3333 p = rec.buf + rec.buf_len;
3334 if (q != NULL) {
3335 memmove(q, rec.buf + rec.data_offset, rec.data_len);
3336 q += rec.data_len;
3337 } else {
3338 q = p;
3339 }
3340 } while (merged_rec_len < ssl->in_hslen);
3341 ssl->in_hdr = ssl->in_hshdr;
3342 mbedtls_ssl_update_in_pointers(ssl);
3343 ssl->in_msglen = merged_rec_len;
3344 /* Adjust message length. */
3345 MBEDTLS_PUT_UINT16_BE(merged_rec_len, ssl->in_len, 0);
3346 ssl->in_hsfraglen = 0;
3347 ssl->in_hshdr = NULL;
3348 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
3349 ssl->in_hdr, mbedtls_ssl_in_hdr_len(ssl) + merged_rec_len);
3350 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003351 }
3352
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003354}
3355
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003356int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003357{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003358 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003359 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003362 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3363 if (ret != 0) {
3364 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3365 return ret;
3366 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003367 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003368
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003369 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3372 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003373 unsigned offset;
3374 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003375
Hanno Becker0271f962018-08-16 13:23:47 +01003376 /* Increment handshake sequence number */
3377 hs->in_msg_seq++;
3378
3379 /*
3380 * Clear up handshake buffering and reassembly structure.
3381 */
3382
3383 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003385
3386 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003388 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003390 *hs_buf = *(hs_buf + 1);
3391 }
3392
3393 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003395 }
3396#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003397 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003398}
3399
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003400/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003401 * DTLS anti-replay: RFC 6347 4.1.2.6
3402 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003403 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3404 * Bit n is set iff record number in_window_top - n has been seen.
3405 *
3406 * Usually, in_window_top is the last record number seen and the lsb of
3407 * in_window is set. The only exception is the initial state (record number 0
3408 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003411void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003412{
3413 ssl->in_window_top = 0;
3414 ssl->in_window = 0;
3415}
3416
Gilles Peskine449bd832023-01-11 14:50:10 +01003417static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003418{
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 return ((uint64_t) buf[0] << 40) |
3420 ((uint64_t) buf[1] << 32) |
3421 ((uint64_t) buf[2] << 24) |
3422 ((uint64_t) buf[3] << 16) |
3423 ((uint64_t) buf[4] << 8) |
3424 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003425}
3426
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003427MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003428static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003429{
Janos Follath865b3eb2019-12-16 11:46:15 +00003430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003431 unsigned char *original_in_ctr;
3432
3433 // save original in_ctr
3434 original_in_ctr = ssl->in_ctr;
3435
3436 // use counter from record
3437 ssl->in_ctr = record_in_ctr;
3438
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003440
3441 // restore the counter
3442 ssl->in_ctr = original_in_ctr;
3443
3444 return ret;
3445}
3446
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447/*
3448 * Return 0 if sequence number is acceptable, -1 otherwise
3449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003450int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003451{
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453 uint64_t bit;
3454
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3456 return 0;
3457 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 if (rec_seqnum > ssl->in_window_top) {
3460 return 0;
3461 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003463 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 if (bit >= 64) {
3466 return -1;
3467 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003468
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3470 return -1;
3471 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003472
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003474}
3475
3476/*
3477 * Update replay window on new validated record
3478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003479void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003480{
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003484 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003486
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003488 /* Update window_top and the contents of the window */
3489 uint64_t shift = rec_seqnum - ssl->in_window_top;
3490
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003492 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003493 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003494 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003495 ssl->in_window |= 1;
3496 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003497
3498 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003500 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003501 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003502
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003504 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003506 }
3507}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003509
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003510#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003511/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003512 * Check if a datagram looks like a ClientHello with a valid cookie,
3513 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003514 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003515 *
3516 * - if cookie is valid, return 0
3517 * - if ClientHello looks superficially valid but cookie is not,
3518 * fill obuf and set olen, then
3519 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3520 * - otherwise return a specific error code
3521 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003522MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003523MBEDTLS_STATIC_TESTABLE
3524int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 mbedtls_ssl_context *ssl,
3526 const unsigned char *cli_id, size_t cli_id_len,
3527 const unsigned char *in, size_t in_len,
3528 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003529{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003530 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003531 unsigned char *p;
3532
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003533 /*
3534 * Structure of ClientHello with record and handshake headers,
3535 * and expected values. We don't need to check a lot, more checks will be
3536 * done when actually parsing the ClientHello - skipping those checks
3537 * avoids code duplication and does not make cookie forging any easier.
3538 *
3539 * 0-0 ContentType type; copied, must be handshake
3540 * 1-2 ProtocolVersion version; copied
3541 * 3-4 uint16 epoch; copied, must be 0
3542 * 5-10 uint48 sequence_number; copied
3543 * 11-12 uint16 length; (ignored)
3544 *
3545 * 13-13 HandshakeType msg_type; (ignored)
3546 * 14-16 uint24 length; (ignored)
3547 * 17-18 uint16 message_seq; copied
3548 * 19-21 uint24 fragment_offset; copied, must be 0
3549 * 22-24 uint24 fragment_length; (ignored)
3550 *
3551 * 25-26 ProtocolVersion client_version; (ignored)
3552 * 27-58 Random random; (ignored)
3553 * 59-xx SessionID session_id; 1 byte len + sid_len content
3554 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3555 * ...
3556 *
3557 * Minimum length is 61 bytes.
3558 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003559 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3560 (unsigned) in_len));
3561 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3562 if (in_len < 61) {
3563 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3564 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003565 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003566
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3568 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003569
Gilles Peskine449bd832023-01-11 14:50:10 +01003570 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3571 fragment_offset != 0) {
3572 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3573 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3574 in[0], (unsigned) epoch,
3575 (unsigned) fragment_offset));
3576 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003577 }
3578
3579 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003580 if (59 + 1 + sid_len + 1 > in_len) {
3581 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3582 (unsigned) sid_len,
3583 (unsigned) in_len - 61));
3584 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003585 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003586 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3587 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003588
3589 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003590 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3591 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3592 (unsigned) cookie_len,
3593 (unsigned) (in_len - sid_len - 61)));
3594 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003595 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003596
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3598 in + sid_len + 61, cookie_len);
3599 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3600 in + sid_len + 61, cookie_len,
3601 cli_id, cli_id_len) == 0) {
3602 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3603 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003604 }
3605
3606 /*
3607 * If we get here, we've got an invalid cookie, let's prepare HVR.
3608 *
3609 * 0-0 ContentType type; copied
3610 * 1-2 ProtocolVersion version; copied
3611 * 3-4 uint16 epoch; copied
3612 * 5-10 uint48 sequence_number; copied
3613 * 11-12 uint16 length; olen - 13
3614 *
3615 * 13-13 HandshakeType msg_type; hello_verify_request
3616 * 14-16 uint24 length; olen - 25
3617 * 17-18 uint16 message_seq; copied
3618 * 19-21 uint24 fragment_offset; copied
3619 * 22-24 uint24 fragment_length; olen - 25
3620 *
3621 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3622 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3623 *
3624 * Minimum length is 28.
3625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003626 if (buf_len < 28) {
3627 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3628 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003629
3630 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003632 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3633 obuf[25] = 0xfe;
3634 obuf[26] = 0xff;
3635
3636 /* Generate and write actual cookie */
3637 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003638 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3639 &p, obuf + buf_len,
3640 cli_id, cli_id_len) != 0) {
3641 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003642 }
3643
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003644 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003645
3646 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3650 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3651 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003652
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003654
Gilles Peskine449bd832023-01-11 14:50:10 +01003655 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003656}
3657
3658/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003659 * Handle possible client reconnect with the same UDP quadruplet
3660 * (RFC 6347 Section 4.2.8).
3661 *
3662 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3663 * that looks like a ClientHello.
3664 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003665 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003666 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003667 * - if the input looks like a ClientHello with a valid cookie,
3668 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003669 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003670 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003671 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003672 * This function is called (through ssl_check_client_reconnect()) when an
3673 * unexpected record is found in ssl_get_next_record(), which will discard the
3674 * record if we return 0, and bubble up the return value otherwise (this
3675 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3676 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003677 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003679static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003680{
Janos Follath865b3eb2019-12-16 11:46:15 +00003681 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003682 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003683
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 if (ssl->conf->f_cookie_write == NULL ||
3685 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003686 /* If we can't use cookies to verify reachability of the peer,
3687 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3689 "can't check reconnect validity"));
3690 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003691 }
3692
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003693 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 ssl,
3695 ssl->cli_id, ssl->cli_id_len,
3696 ssl->in_buf, ssl->in_left,
3697 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003698
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003700
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003702 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3704 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3705 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003706 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003707 * If the error is permanent we'll catch it later,
3708 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3710 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003711 (void) send_ret;
3712
Gilles Peskine449bd832023-01-11 14:50:10 +01003713 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003714 }
3715
Gilles Peskine449bd832023-01-11 14:50:10 +01003716 if (ret == 0) {
3717 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3718 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3719 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3720 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003721 }
3722
Gilles Peskine449bd832023-01-11 14:50:10 +01003723 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003724 }
3725
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003727}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003728#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003729
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003730MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003731static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003732{
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003734 record_type != MBEDTLS_SSL_MSG_ALERT &&
3735 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003736 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3737 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003738 }
3739
Gilles Peskine449bd832023-01-11 14:50:10 +01003740 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003741}
3742
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003743/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003744 * ContentType type;
3745 * ProtocolVersion version;
3746 * uint16 epoch; // DTLS only
3747 * uint48 sequence_number; // DTLS only
3748 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003749 *
3750 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003751 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003752 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3753 *
3754 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003755 * 1. proceed with the record if this function returns 0
3756 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3757 * 3. return CLIENT_RECONNECT if this function return that value
3758 * 4. drop the whole datagram if this function returns anything else.
3759 * Point 2 is needed when the peer is resending, and we have already received
3760 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003761 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003762MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003763static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3764 unsigned char *buf,
3765 size_t len,
3766 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003767{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003768 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003769
Hanno Beckere5e7e782019-07-11 12:29:35 +01003770 size_t const rec_hdr_type_offset = 0;
3771 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003772
Hanno Beckere5e7e782019-07-11 12:29:35 +01003773 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3774 rec_hdr_type_len;
3775 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003776
Hanno Beckere5e7e782019-07-11 12:29:35 +01003777 size_t const rec_hdr_ctr_len = 8;
3778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003779 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003780 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3781 rec_hdr_version_len;
3782
Hanno Beckera0e20d02019-05-15 14:03:01 +01003783#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003784 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3785 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003786 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003787#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3788#endif /* MBEDTLS_SSL_PROTO_DTLS */
3789
3790 size_t rec_hdr_len_offset; /* To be determined */
3791 size_t const rec_hdr_len_len = 2;
3792
3793 /*
3794 * Check minimum lengths for record header.
3795 */
3796
3797#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003799 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003800 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003801#endif /* MBEDTLS_SSL_PROTO_DTLS */
3802 {
3803 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3804 }
3805
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3807 MBEDTLS_SSL_DEBUG_MSG(1,
3808 (
3809 "datagram of length %u too small to hold DTLS record header of length %u",
3810 (unsigned) len,
3811 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3812 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003813 }
3814
3815 /*
3816 * Parse and validate record content type
3817 */
3818
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003820
3821 /* Check record content type */
3822#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3823 rec->cid_len = 0;
3824
Gilles Peskine449bd832023-01-11 14:50:10 +01003825 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003826 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003828 /* Shift pointers to account for record header including CID
3829 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003830 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003831 * ProtocolVersion version;
3832 * uint16 epoch;
3833 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003834 * opaque cid[cid_length]; // Additional field compared to
3835 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003836 * uint16 length;
3837 * opaque enc_content[DTLSCiphertext.length];
3838 * } DTLSCiphertext;
3839 */
3840
3841 /* So far, we only support static CID lengths
3842 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003843 rec_hdr_cid_len = ssl->conf->cid_len;
3844 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3847 MBEDTLS_SSL_DEBUG_MSG(1,
3848 (
3849 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3850 (unsigned) len,
3851 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3852 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003853 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003854
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003855 /* configured CID len is guaranteed at most 255, see
3856 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3857 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3859 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003860#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003861 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 if (ssl_check_record_type(rec->type)) {
3863 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3864 (unsigned) rec->type));
3865 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003866 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003867 }
3868
Hanno Beckere5e7e782019-07-11 12:29:35 +01003869 /*
3870 * Parse and validate record version
3871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3873 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003874 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3875 buf + rec_hdr_version_offset,
3876 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003877
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 if (tls_version > ssl->conf->max_tls_version) {
3879 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3880 (unsigned) tls_version,
3881 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003882
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003884 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003885 /*
3886 * Parse/Copy record sequence number.
3887 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003888
Hanno Beckere5e7e782019-07-11 12:29:35 +01003889#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003891 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3893 rec_hdr_ctr_len);
3894 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003895#endif /* MBEDTLS_SSL_PROTO_DTLS */
3896 {
3897 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003899 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003900
Hanno Beckere5e7e782019-07-11 12:29:35 +01003901 /*
3902 * Parse record length.
3903 */
3904
Hanno Beckere5e7e782019-07-11 12:29:35 +01003905 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003906 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003908
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3910 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3911 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003912
3913 rec->buf = buf;
3914 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003915
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 if (rec->data_len == 0) {
3917 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3918 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003919
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003920 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003921 * DTLS-related tests.
3922 * Check epoch before checking length constraint because
3923 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3924 * message gets duplicated before the corresponding Finished message,
3925 * the second ChangeCipherSpec should be discarded because it belongs
3926 * to an old epoch, but not because its length is shorter than
3927 * the minimum record length for packets using the new record transform.
3928 * Note that these two kinds of failures are handled differently,
3929 * as an unexpected record is silently skipped but an invalid
3930 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003931 */
3932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003934 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003935
Hanno Becker955a5c92019-07-10 17:12:07 +01003936 /* Check that the datagram is large enough to contain a record
3937 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (len < rec->data_offset + rec->data_len) {
3939 MBEDTLS_SSL_DEBUG_MSG(1,
3940 (
3941 "Datagram of length %u too small to contain record of advertised length %u.",
3942 (unsigned) len,
3943 (unsigned) (rec->data_offset + rec->data_len)));
3944 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003945 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003946
Hanno Becker37cfe732019-07-10 17:20:01 +01003947 /* Records from other, non-matching epochs are silently discarded.
3948 * (The case of same-port Client reconnects must be considered in
3949 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 if (rec_epoch != ssl->in_epoch) {
3951 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3952 "expected %u, received %lu",
3953 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003954
Hanno Becker552f7472019-07-19 10:59:12 +01003955 /* Records from the next epoch are considered for buffering
3956 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3958 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3959 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003960 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003961
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003963 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003964#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003965 /* For records from the correct epoch, check whether their
3966 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3968 &rec->ctr[0]) != 0) {
3969 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3970 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003971 }
3972#endif
3973 }
3974#endif /* MBEDTLS_SSL_PROTO_DTLS */
3975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003977}
Paul Bakker5121ce52009-01-03 21:22:43 +00003978
Paul Bakker5121ce52009-01-03 21:22:43 +00003979
Hanno Becker2fddd372019-07-10 14:37:41 +01003980#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003981MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003982static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003983{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003984 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003985
3986 /*
3987 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3988 * access the first byte of record content (handshake type), as we
3989 * have an active transform (possibly iv_len != 0), so use the
3990 * fact that the record header len is 13 instead.
3991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003993 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003995 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3996 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3998 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3999 "from the same port"));
4000 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004001 }
4002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004004}
Hanno Becker2fddd372019-07-10 14:37:41 +01004005#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004006
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004007/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004008 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004009 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004010MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004011static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
4012 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004013{
4014 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
4017 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004018
Ronald Cron7e38cba2021-11-24 12:43:39 +01004019 /*
4020 * In TLS 1.3, always treat ChangeCipherSpec records
4021 * as unencrypted. The only thing we do with them is
4022 * check the length and content and ignore them.
4023 */
Ronald Cron6f135e12021-12-08 16:57:54 +01004024#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 if (ssl->transform_in != NULL &&
4026 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4027 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004028 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01004030 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004031#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01004032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01004034 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004035
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
4037 rec)) != 0) {
4038 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01004039
Ronald Cron2995d352024-01-18 16:59:39 +01004040#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
4041 /*
4042 * Although the server rejected early data, it might receive early
4043 * data as long as it has not received the client Finished message.
4044 * It is encrypted with early keys and should be ignored as stated
4045 * in section 4.2.10 of RFC 8446:
4046 *
4047 * "Ignore the extension and return a regular 1-RTT response. The
4048 * server then skips past early data by attempting to deprotect
4049 * received records using the handshake traffic key, discarding
4050 * records which fail deprotection (up to the configured
4051 * max_early_data_size). Once a record is deprotected successfully,
4052 * it is treated as the start of the client's second flight and the
4053 * server proceeds as with an ordinary 1-RTT handshake."
4054 */
4055 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
4056 (ssl->discard_early_data_record ==
4057 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
4058 MBEDTLS_SSL_DEBUG_MSG(
4059 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01004060
4061 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
4062 if (ret != 0) {
4063 return ret;
4064 }
Ronald Cron2995d352024-01-18 16:59:39 +01004065 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4066 }
4067#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4068
Hanno Beckera0e20d02019-05-15 14:03:01 +01004069#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004071 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4073 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004074 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004075 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004076#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004077
Ronald Cron71c6e652024-02-05 16:48:10 +01004078 /*
4079 * The decryption of the record failed, no reason to ignore it,
4080 * return in error with the decryption error code.
4081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004083 }
4084
Ronald Cron2995d352024-01-18 16:59:39 +01004085#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
4086 /*
4087 * If the server were discarding protected records that it fails to
4088 * deprotect because it has rejected early data, as we have just
4089 * deprotected successfully a record, the server has to resume normal
4090 * operation and fail the connection if the deprotection of a record
4091 * fails.
4092 */
4093 if (ssl->discard_early_data_record ==
4094 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
4095 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
4096 }
4097#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (old_msg_type != rec->type) {
4100 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4101 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004102 }
4103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4105 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004106
Hanno Beckera0e20d02019-05-15 14:03:01 +01004107#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004108 /* We have already checked the record content type
4109 * in ssl_parse_record_header(), failing or silently
4110 * dropping the record in the case of an unknown type.
4111 *
4112 * Since with the use of CIDs, the record content type
4113 * might change during decryption, re-check the record
4114 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if (ssl_check_record_type(rec->type)) {
4116 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4117 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004118 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004119#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004122#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4124 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004125 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4127 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004128 }
4129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4130
4131 ssl->nb_zero++;
4132
4133 /*
4134 * Three or more empty messages may be a DoS attack
4135 * (excessive CPU consumption).
4136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 if (ssl->nb_zero > 3) {
4138 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4139 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004140 /* Treat the records as if they were not properly authenticated,
4141 * thereby failing the connection if we see more than allowed
4142 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004144 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004146 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004148
4149#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004151 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004153#endif
4154 {
4155 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4157 i > mbedtls_ssl_ep_len(ssl); i--) {
4158 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004159 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004161 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004162
4163 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (i == mbedtls_ssl_ep_len(ssl)) {
4165 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4166 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004167 }
4168 }
4169
Paul Bakker5121ce52009-01-03 21:22:43 +00004170 }
4171
Jerry Yuf57d14b2023-11-15 16:40:09 +08004172#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
4173 /*
4174 * Although the server rejected early data because it needed to send an
4175 * HelloRetryRequest message, it might receive early data as long as it has
4176 * not received the client Finished message.
4177 * The early data is encrypted with early keys and should be ignored as
4178 * stated in section 4.2.10 of RFC 8446 (second case):
4179 *
4180 * "The server then ignores early data by skipping all records with an
4181 * external content type of "application_data" (indicating that they are
4182 * encrypted), up to the configured max_early_data_size. Ignore application
4183 * data message before 2nd ClientHello when early_data was received in 1st
4184 * ClientHello."
4185 */
4186 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
4187 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01004188
4189 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
4190 if (ret != 0) {
4191 return ret;
4192 }
4193
Jerry Yuf57d14b2023-11-15 16:40:09 +08004194 MBEDTLS_SSL_DEBUG_MSG(
4195 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01004196
Jerry Yuf57d14b2023-11-15 16:40:09 +08004197 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4198 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
4199 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
4200 }
4201 }
4202#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004204#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4206 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004207 }
4208#endif
4209
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004210 /* Check actual (decrypted) record content length against
4211 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4213 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4214 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004215 }
4216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004218}
4219
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004220/*
4221 * Read a record.
4222 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004223 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4224 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4225 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004226 */
Hanno Becker1097b342018-08-15 14:09:41 +01004227
4228/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004229MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004230static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004231MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004232static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004233MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004234static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4237 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004238{
Janos Follath865b3eb2019-12-16 11:46:15 +00004239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004242
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004244 do {
Simon Butcher99000142016-10-13 17:21:01 +01004245
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 ret = ssl_consume_current_message(ssl);
4247 if (ret != 0) {
4248 return ret;
4249 }
Hanno Becker26994592018-08-15 14:14:59 +01004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004252 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004253#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004254
Hanno Becker40f50842018-08-15 14:48:01 +01004255 /* We only check for buffered messages if the
4256 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4258 ssl_next_record_is_in_datagram(ssl) == 0) {
4259 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004260 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 }
Hanno Becker40f50842018-08-15 14:48:01 +01004262 }
4263
Hanno Becker40f50842018-08-15 14:48:01 +01004264#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (dtls_have_buffered == 0) {
4266 ret = ssl_get_next_record(ssl);
4267 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004268 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 }
Hanno Becker40f50842018-08-15 14:48:01 +01004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 if (ret != 0) {
4272 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4273 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004274 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004275 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004276 }
4277
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004279
Hanno Becker40f50842018-08-15 14:48:01 +01004280#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004282 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 ret = ssl_buffer_message(ssl);
4284 if (ret != 0) {
4285 return ret;
4286 }
Hanno Becker40f50842018-08-15 14:48:01 +01004287
4288 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4289 }
4290#endif /* MBEDTLS_SSL_PROTO_DTLS */
4291
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4293 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (0 != ret) {
4296 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4297 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004298 }
4299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4301 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004302 ret = mbedtls_ssl_update_handshake_status(ssl);
4303 if (0 != ret) {
4304 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4305 return ret;
4306 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004307 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 } else {
4309 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004310 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004311 }
4312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004316}
4317
Hanno Becker40f50842018-08-15 14:48:01 +01004318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004319MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004320static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004321{
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (ssl->in_left > ssl->next_record_offset) {
4323 return 1;
4324 }
Simon Butcher99000142016-10-13 17:21:01 +01004325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004327}
4328
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004329MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004330static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004331{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004332 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004334 int ret = 0;
4335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 if (hs == NULL) {
4337 return -1;
4338 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4343 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004344 /* Check if we have seen a ChangeCipherSpec before.
4345 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if (!hs->buffering.seen_ccs) {
4347 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004348 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004349 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004350 }
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004353 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4354 ssl->in_msglen = 1;
4355 ssl->in_msg[0] = 1;
4356
4357 /* As long as they are equal, the exact value doesn't matter. */
4358 ssl->in_left = 0;
4359 ssl->next_record_offset = 0;
4360
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004361 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004362 goto exit;
4363 }
Hanno Becker37f95322018-08-16 13:55:32 +01004364
Hanno Beckerb8f50142018-08-28 10:01:34 +01004365#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004366 /* Debug only */
4367 {
4368 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004370 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (hs_buf->is_valid == 1) {
4372 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4373 hs->in_msg_seq + offset,
4374 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004375 }
4376 }
4377 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004378#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004379
4380 /* Check if we have buffered and/or fully reassembled the
4381 * next handshake message. */
4382 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004384 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004385 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004386
4387 /* Double-check that we haven't accidentally buffered
4388 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4391 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004392 }
4393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4395 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4396 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004397
4398 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4399 ssl->in_hslen = msg_len + 12;
4400 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004402
4403 ret = 0;
4404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 } else {
4406 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4407 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004408 }
4409
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004410 ret = -1;
4411
4412exit:
4413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4415 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004416}
4417
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004419static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4420 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004421{
4422 int offset;
4423 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4425 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004426
Hanno Becker01315ea2018-08-21 17:22:17 +01004427 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004429
4430 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4432 hs->buffering.total_bytes_buffered)) {
4433 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4434 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004435 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004436
Hanno Becker4f432ad2018-08-28 10:02:32 +01004437 /* We don't have enough space to buffer the next expected handshake
4438 * message. Remove buffers used for future messages to gain space,
4439 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4441 offset >= 0; offset--) {
4442 MBEDTLS_SSL_DEBUG_MSG(2,
4443 (
4444 "Free buffering slot %d to make space for reassembly of next handshake message",
4445 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004448
4449 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4451 hs->buffering.total_bytes_buffered)) {
4452 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4453 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004454 }
4455 }
4456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004458}
4459
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004460MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004461static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004462{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004463 int ret = 0;
4464 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (hs == NULL) {
4467 return 0;
4468 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004473 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004475
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004476 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004477 break;
4478
4479 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004480 {
4481 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004482 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004483 mbedtls_ssl_hs_buffer *hs_buf;
4484 size_t msg_len = ssl->in_hslen - 12;
4485
4486 /* We should never receive an old handshake
4487 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4489 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4490 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004491 }
4492
4493 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004495 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 MBEDTLS_SSL_DEBUG_MSG(2,
4497 ("Ignore future HS message with sequence number %u, "
4498 "buffering window %u - %u",
4499 recv_msg_seq, ssl->handshake->in_msg_seq,
4500 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4501 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004502
4503 goto exit;
4504 }
4505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4507 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004510
4511 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004513 size_t reassembly_buf_sz;
4514
Hanno Becker37f95322018-08-16 13:55:32 +01004515 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004517
4518 /* We copy the message back into the input buffer
4519 * after reassembly, so check that it's not too large.
4520 * This is an implementation-specific limitation
4521 * and not one from the standard, hence it is not
4522 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004524 /* Ignore message */
4525 goto exit;
4526 }
4527
Hanno Beckere0b150f2018-08-21 15:51:03 +01004528 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (hs->buffering.total_bytes_buffered >
4530 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4531 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4532 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004533 }
4534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4536 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4539 hs->buffering.total_bytes_buffered)) {
4540 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004541 /* If we can't buffer a future message because
4542 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 MBEDTLS_SSL_DEBUG_MSG(2,
4544 ("Buffering of future message of size %"
4545 MBEDTLS_PRINTF_SIZET
4546 " would exceed the compile-time limit %"
4547 MBEDTLS_PRINTF_SIZET
4548 " (already %" MBEDTLS_PRINTF_SIZET
4549 " bytes buffered) -- ignore\n",
4550 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4551 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004552 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 } else {
4554 MBEDTLS_SSL_DEBUG_MSG(2,
4555 ("Buffering of future message of size %"
4556 MBEDTLS_PRINTF_SIZET
4557 " would exceed the compile-time limit %"
4558 MBEDTLS_PRINTF_SIZET
4559 " (already %" MBEDTLS_PRINTF_SIZET
4560 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4561 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4562 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004563 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4566 MBEDTLS_SSL_DEBUG_MSG(2,
4567 ("Reassembly of next message of size %"
4568 MBEDTLS_PRINTF_SIZET
4569 " (%" MBEDTLS_PRINTF_SIZET
4570 " with bitmap) would exceed"
4571 " the compile-time limit %"
4572 MBEDTLS_PRINTF_SIZET
4573 " (already %" MBEDTLS_PRINTF_SIZET
4574 " bytes buffered) -- fail\n",
4575 msg_len,
4576 reassembly_buf_sz,
4577 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4578 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004579 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4580 goto exit;
4581 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004582 }
4583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 MBEDTLS_SSL_DEBUG_MSG(2,
4585 ("initialize reassembly, total length = %"
4586 MBEDTLS_PRINTF_SIZET,
4587 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4590 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004591 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004592 goto exit;
4593 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004594 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004595
4596 /* Prepare final header: copy msg_type, length and message_seq,
4597 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 memcpy(hs_buf->data, ssl->in_msg, 6);
4599 memset(hs_buf->data + 6, 0, 3);
4600 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004601
4602 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004603
4604 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004606 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4608 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004609 /* Ignore */
4610 goto exit;
4611 }
4612 }
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004615 size_t frag_len, frag_off;
4616 unsigned char * const msg = hs_buf->data + 12;
4617
4618 /*
4619 * Check and copy current fragment
4620 */
4621
4622 /* Validation of header fields already done in
4623 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 frag_off = ssl_get_hs_frag_off(ssl);
4625 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4628 ", length = %" MBEDTLS_PRINTF_SIZET,
4629 frag_off, frag_len));
4630 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004633 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 ssl_bitmask_set(bitmask, frag_off, frag_len);
4635 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4636 msg_len) == 0);
4637 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004638 hs_buf->is_complete = 1;
4639 }
4640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4642 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004643 }
4644
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004645 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004646 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004647
4648 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004649 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004650 break;
4651 }
4652
4653exit:
4654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4656 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004657}
4658#endif /* MBEDTLS_SSL_PROTO_DTLS */
4659
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004660MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004661static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004662{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004663 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004664 * Consume last content-layer message and potentially
4665 * update in_msglen which keeps track of the contents'
4666 * consumption state.
4667 *
4668 * (1) Handshake messages:
4669 * Remove last handshake message, move content
4670 * and adapt in_msglen.
4671 *
4672 * (2) Alert messages:
4673 * Consume whole record content, in_msglen = 0.
4674 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004675 * (3) Change cipher spec:
4676 * Consume whole record content, in_msglen = 0.
4677 *
4678 * (4) Application data:
4679 * Don't do anything - the record layer provides
4680 * the application data as a stream transport
4681 * and consumes through mbedtls_ssl_read only.
4682 *
4683 */
4684
4685 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004687 /* Hard assertion to be sure that no application data
4688 * is in flight, as corrupting ssl->in_msglen during
4689 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if (ssl->in_offt != NULL) {
4691 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4692 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004693 }
4694
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00004695 if (ssl->in_hsfraglen != 0) {
4696 /* Not all handshake fragments have arrived, do not consume. */
4697 MBEDTLS_SSL_DEBUG_MSG(3,
4698 ("waiting for more fragments (%" MBEDTLS_PRINTF_SIZET " of %"
4699 MBEDTLS_PRINTF_SIZET ", %" MBEDTLS_PRINTF_SIZET " left)",
4700 ssl->in_hsfraglen, ssl->in_hslen,
4701 ssl->in_hslen - ssl->in_hsfraglen));
4702 return 0;
4703 }
4704
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004705 /*
4706 * Get next Handshake message in the current record
4707 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004708
Hanno Becker4a810fb2017-05-24 16:27:30 +01004709 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004710 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004711 * current handshake content: If DTLS handshake
4712 * fragmentation is used, that's the fragment
4713 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004714 * size here is faulty and should be changed at
4715 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004716 * (2) While it doesn't seem to cause problems, one
4717 * has to be very careful not to assume that in_hslen
4718 * is always <= in_msglen in a sensible communication.
4719 * Again, it's wrong for DTLS handshake fragmentation.
4720 * The following check is therefore mandatory, and
4721 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004722 * Additionally, ssl->in_hslen might be arbitrarily out of
4723 * bounds after handling a DTLS message with an unexpected
4724 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004727 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4729 ssl->in_msglen);
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00004730 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4733 ssl->in_msg, ssl->in_msglen);
4734 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004735 ssl->in_msglen = 0;
4736 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004737
Hanno Becker4a810fb2017-05-24 16:27:30 +01004738 ssl->in_hslen = 0;
4739 }
4740 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 else if (ssl->in_offt != NULL) {
4742 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004743 }
4744 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004746 ssl->in_msglen = 0;
4747 }
4748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004750}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004751
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004752MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004753static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004754{
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (ssl->in_msglen > 0) {
4756 return 1;
4757 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004760}
4761
Hanno Becker5f066e72018-08-16 14:56:31 +01004762#if defined(MBEDTLS_SSL_PROTO_DTLS)
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004765{
4766 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004768 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004772 hs->buffering.total_bytes_buffered -=
4773 hs->buffering.future_record.len;
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004776 hs->buffering.future_record.data = NULL;
4777 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004778}
4779
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004780MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004781static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004782{
4783 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004785 size_t rec_len;
4786 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004787#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4788 size_t in_buf_len = ssl->in_buf_len;
4789#else
4790 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4791#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4793 return 0;
4794 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004795
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 if (hs == NULL) {
4797 return 0;
4798 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004799
Hanno Becker5f066e72018-08-16 14:56:31 +01004800 rec = hs->buffering.future_record.data;
4801 rec_len = hs->buffering.future_record.len;
4802 rec_epoch = hs->buffering.future_record.epoch;
4803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (rec == NULL) {
4805 return 0;
4806 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004807
Hanno Becker4cb782d2018-08-20 11:19:05 +01004808 /* Only consider loading future records if the
4809 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4811 return 0;
4812 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (rec_epoch != ssl->in_epoch) {
4817 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004818 goto exit;
4819 }
4820
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004822
4823 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4825 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004827 }
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004830 ssl->in_left = rec_len;
4831 ssl->next_record_offset = 0;
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004834
4835exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4837 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004838}
4839
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004840MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004841static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4842 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004843{
4844 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004845
4846 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (hs == NULL) {
4848 return 0;
4849 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004850
4851 /* Only buffer handshake records (we are only interested
4852 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4854 return 0;
4855 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004856
4857 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if (hs->buffering.future_record.data != NULL) {
4859 return 0;
4860 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004861
Hanno Becker01315ea2018-08-21 17:22:17 +01004862 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4864 hs->buffering.total_bytes_buffered)) {
4865 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4866 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4867 " (already %" MBEDTLS_PRINTF_SIZET
4868 " bytes buffered) -- ignore\n",
4869 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4870 hs->buffering.total_bytes_buffered));
4871 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004872 }
4873
Hanno Becker5f066e72018-08-16 14:56:31 +01004874 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4876 ssl->in_epoch + 1U));
4877 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004878
4879 /* ssl_parse_record_header() only considers records
4880 * of the next epoch as candidates for buffering. */
4881 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004882 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004883
4884 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_calloc(1, hs->buffering.future_record.len);
4886 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004887 /* If we run out of RAM trying to buffer a
4888 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004890 }
4891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004893
Hanno Becker519f15d2019-07-11 12:43:20 +01004894 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004896}
4897
4898#endif /* MBEDTLS_SSL_PROTO_DTLS */
4899
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004900MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004901static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004902{
Janos Follath865b3eb2019-12-16 11:46:15 +00004903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004904 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004905
Hanno Becker5f066e72018-08-16 14:56:31 +01004906#if defined(MBEDTLS_SSL_PROTO_DTLS)
4907 /* We might have buffered a future record; if so,
4908 * and if the epoch matches now, load it.
4909 * On success, this call will set ssl->in_left to
4910 * the length of the buffered record, so that
4911 * the calls to ssl_fetch_input() below will
4912 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 ret = ssl_load_buffered_record(ssl);
4914 if (ret != 0) {
4915 return ret;
4916 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004917#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004918
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004919 /* Ensure that we have enough space available for the default form
4920 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4921 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4923 if (ret != 0) {
4924 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4925 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004926 }
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4929 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4932 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4933 ret = ssl_buffer_future_record(ssl, &rec);
4934 if (ret != 0) {
4935 return ret;
4936 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004937
4938 /* Fall through to handling of unexpected records */
4939 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4940 }
4941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004943#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004944 /* Reset in pointers to default state for TLS/DTLS records,
4945 * assuming no CID and no offset between record content and
4946 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004948
Hanno Becker7ae20e02019-07-12 08:33:49 +01004949 /* Setup internal message pointers from record structure. */
4950 ssl->in_msgtype = rec.type;
4951#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4952 ssl->in_len = ssl->in_cid + rec.cid_len;
4953#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4954 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4955 ssl->in_msglen = rec.data_len;
4956
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 ret = ssl_check_client_reconnect(ssl);
4958 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4959 if (ret != 0) {
4960 return ret;
4961 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004962#endif
4963
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004964 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004965 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4968 "(header)"));
4969 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004970 /* Skip invalid record and the rest of the datagram */
4971 ssl->next_record_offset = 0;
4972 ssl->in_left = 0;
4973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4975 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004976 }
4977
4978 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4980 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004981#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004982 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004984 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004985 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004987#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004989 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004990 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 if (ssl->next_record_offset < ssl->in_left) {
4992 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004993 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004995#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004996 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004997 /*
4998 * Fetch record contents from underlying transport.
4999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
5001 if (ret != 0) {
5002 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
5003 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01005004 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005005
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005006 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01005007 }
5008
5009 /*
5010 * Decrypt record contents.
5011 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02005016 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02005018 /* Except when waiting for Finished as a bad mac here
5019 * probably means something went wrong in the handshake
5020 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
5022 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02005023#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
5025 mbedtls_ssl_send_alert_message(ssl,
5026 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5027 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02005028 }
5029#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02005031 }
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if (ssl->conf->badmac_limit != 0 &&
5034 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
5035 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
5036 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02005037 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02005038
Hanno Becker4a810fb2017-05-24 16:27:30 +01005039 /* As above, invalid records cause
5040 * dismissal of the whole datagram. */
5041
5042 ssl->next_record_offset = 0;
5043 ssl->in_left = 0;
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
5046 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02005047 }
5048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 return ret;
5050 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02005051#endif
5052 {
5053 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005054#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
5056 mbedtls_ssl_send_alert_message(ssl,
5057 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5058 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02005059 }
5060#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02005062 }
5063 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005064
Hanno Becker44d89b22019-07-12 09:40:44 +01005065
5066 /* Reset in pointers to default state for TLS/DTLS records,
5067 * assuming no CID and no offset between record content and
5068 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01005070#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5071 ssl->in_len = ssl->in_cid + rec.cid_len;
5072#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03005073 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01005074
Hanno Becker8685c822019-07-12 09:37:30 +01005075 /* The record content type may change during decryption,
5076 * so re-read it. */
5077 ssl->in_msgtype = rec.type;
5078 /* Also update the input buffer, because unfortunately
5079 * the server-side ssl_parse_client_hello() reparses the
5080 * record header when receiving a ClientHello initiating
5081 * a renegotiation. */
5082 ssl->in_hdr[0] = rec.type;
5083 ssl->in_msg = rec.buf + rec.data_offset;
5084 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01005086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01005088}
5089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01005091{
Janos Follath865b3eb2019-12-16 11:46:15 +00005092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01005093
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005094 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005095 * Handle particular types of records
5096 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5098 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
5099 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01005100 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005101 }
5102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5104 if (ssl->in_msglen != 1) {
5105 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
5106 ssl->in_msglen));
5107 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005108 }
5109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (ssl->in_msg[0] != 1) {
5111 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
5112 ssl->in_msg[0]));
5113 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005114 }
5115
5116#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01005118 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
5120 if (ssl->handshake == NULL) {
5121 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
5122 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005123 }
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
5126 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005127 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005128#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005129
Ronald Cron6f135e12021-12-08 16:57:54 +01005130#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine5a668dd2024-09-13 16:03:41 +02005132 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5134 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005135 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005136#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005137 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5140 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005141 /* Note: Standard allows for more than one 2 byte alert
5142 to be packed in a single message, but Mbed TLS doesn't
5143 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5145 ssl->in_msglen));
5146 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005147 }
5148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5150 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005151
5152 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005153 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5156 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5157 ssl->in_msg[1]));
5158 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005159 }
5160
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5162 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5163 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5164 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005165 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005166
5167#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5169 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5170 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005171 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005173 }
5174#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005175 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005176 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005177 }
5178
Hanno Beckerc76c6192017-06-06 10:03:17 +01005179#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005181 /* Drop unexpected ApplicationData records,
5182 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5184 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005185#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5187 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005188#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 ) {
5190 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5191 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005192 }
5193
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 if (ssl->handshake != NULL &&
5195 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5196 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005197 }
5198 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005199#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005202}
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005205{
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 return mbedtls_ssl_send_alert_message(ssl,
5207 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5208 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005209}
5210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5212 unsigned char level,
5213 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005214{
Janos Follath865b3eb2019-12-16 11:46:15 +00005215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl == NULL || ssl->conf == NULL) {
5218 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5219 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (ssl->out_left != 0) {
5222 return mbedtls_ssl_flush_output(ssl);
5223 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5226 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005227
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005228 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005229 ssl->out_msglen = 2;
5230 ssl->out_msg[0] = level;
5231 ssl->out_msg[1] = message;
5232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5234 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5235 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005236 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005240}
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005243{
Janos Follath865b3eb2019-12-16 11:46:15 +00005244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005248 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 ssl->out_msglen = 1;
5250 ssl->out_msg[0] = 1;
5251
Paul Bakker5121ce52009-01-03 21:22:43 +00005252 ssl->state++;
5253
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5255 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5256 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005257 }
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005262}
5263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005265{
Janos Follath865b3eb2019-12-16 11:46:15 +00005266 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5271 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5272 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005273 }
5274
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5276 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5277 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5278 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5279 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 }
5281
Hanno Beckere678eaa2018-08-21 14:57:46 +01005282 /* CCS records are only accepted if they have length 1 and content '1',
5283 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005284
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005285 /*
5286 * Switch to our negotiated transform and session parameters for inbound
5287 * data.
5288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005290#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005291 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005292#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005293 ssl->session_in = ssl->session_negotiate;
5294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005295#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005297#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005299#endif
5300
5301 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 if (++ssl->in_epoch == 0) {
5303 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005304 /* This is highly unlikely to happen for legitimate reasons, so
5305 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005307 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005309#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005311
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005313
Paul Bakker5121ce52009-01-03 21:22:43 +00005314 ssl->state++;
5315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005319}
5320
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005321/* Once ssl->out_hdr as the address of the beginning of the
5322 * next outgoing record is set, deduce the other pointers.
5323 *
5324 * Note: For TLS, we save the implicit record sequence number
5325 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5326 * and the caller has to make sure there's space for this.
5327 */
5328
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005329static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005331{
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005333}
5334
Gilles Peskine449bd832023-01-11 14:50:10 +01005335void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5336 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005337{
5338#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005340 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005341#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005342 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005343 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005345 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005347#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005348 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005349#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005350 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005352#endif
5353 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005354 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005355#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005356 ssl->out_cid = ssl->out_len;
5357#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005358 ssl->out_iv = ssl->out_hdr + 5;
5359 }
5360
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005361 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005362 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 if (transform != NULL) {
5364 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5365 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005366}
5367
5368/* Once ssl->in_hdr as the address of the beginning of the
5369 * next incoming record is set, deduce the other pointers.
5370 *
5371 * Note: For TLS, we save the implicit record sequence number
5372 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5373 * and the caller has to make sure there's space for this.
5374 */
5375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005377{
Hanno Becker79594fd2019-05-08 09:38:41 +01005378 /* This function sets the pointers to match the case
5379 * of unprotected TLS/DTLS records, with both ssl->in_iv
5380 * and ssl->in_msg pointing to the beginning of the record
5381 * content.
5382 *
5383 * When decrypting a protected record, ssl->in_msg
5384 * will be shifted to point to the beginning of the
5385 * record plaintext.
5386 */
5387
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005388#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005390 /* This sets the header pointers to match records
5391 * without CID. When we receive a record containing
5392 * a CID, the fields are shifted accordingly in
5393 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005394 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005395#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005396 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005397 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005398#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005399 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005400#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005401 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005403#endif
5404 {
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00005405 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005406 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005407#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005408 ssl->in_cid = ssl->in_len;
5409#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005410 ssl->in_iv = ssl->in_hdr + 5;
5411 }
5412
Hanno Becker79594fd2019-05-08 09:38:41 +01005413 /* This will be adjusted at record decryption time. */
5414 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005415}
5416
Paul Bakker5121ce52009-01-03 21:22:43 +00005417/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005418 * Setup an SSL context
5419 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005420
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00005421void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5422{
5423#if defined(MBEDTLS_SSL_PROTO_DTLS)
5424 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5425 ssl->in_hdr = ssl->in_buf;
5426 } else
Deomid rojer Ryabkov1f4088c2025-01-18 15:58:57 +02005427#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00005428 {
5429 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5430 }
5431
5432 /* Derive other internal pointers. */
5433 mbedtls_ssl_update_in_pointers(ssl);
5434}
5435
5436void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005437{
5438 /* Set the incoming and outgoing record pointers. */
5439#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005441 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005443#endif /* MBEDTLS_SSL_PROTO_DTLS */
5444 {
Hanno Becker12078f42021-03-02 15:28:41 +00005445 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkov3fc5a4d2024-03-10 02:11:03 +00005446 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005447 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005448 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005450}
5451
Paul Bakker5121ce52009-01-03 21:22:43 +00005452/*
5453 * SSL get accessors
5454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005455size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005456{
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005458}
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005461{
5462 /*
5463 * Case A: We're currently holding back
5464 * a message for further processing.
5465 */
5466
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if (ssl->keep_current_message == 1) {
5468 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5469 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005470 }
5471
5472 /*
5473 * Case B: Further records are pending in the current datagram.
5474 */
5475
5476#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5478 ssl->in_left > ssl->next_record_offset) {
5479 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5480 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005481 }
5482#endif /* MBEDTLS_SSL_PROTO_DTLS */
5483
5484 /*
5485 * Case C: A handshake message is being processed.
5486 */
5487
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5489 MBEDTLS_SSL_DEBUG_MSG(3,
5490 ("ssl_check_pending: more handshake messages within current record"));
5491 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005492 }
5493
5494 /*
5495 * Case D: An application data message is being processed
5496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (ssl->in_offt != NULL) {
5498 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5499 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005500 }
5501
5502 /*
5503 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005504 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005505 * we implement support for multiple alerts in single records.
5506 */
5507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5509 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005510}
5511
Paul Bakker43ca69c2011-01-15 17:35:19 +00005512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005514{
Hanno Becker3136ede2018-08-17 15:28:19 +01005515 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005517 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005518#if defined(MBEDTLS_USE_PSA_CRYPTO)
5519 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5520 psa_key_type_t key_type;
5521#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (transform == NULL) {
5526 return (int) out_hdr_len;
5527 }
Hanno Becker78640902018-08-13 16:35:15 +01005528
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005529
5530#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (transform->psa_alg == PSA_ALG_GCM ||
5532 transform->psa_alg == PSA_ALG_CCM ||
5533 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5534 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5535 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005536 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5538 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5539 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005540
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005542
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005543 /* Expansion due to the addition of the MAC. */
5544 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005545
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005546 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005547 * Theoretically up to 256 bytes, but we never use
5548 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005549 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005550
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005551 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005552 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005553#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005554 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005555#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 } else {
5557 MBEDTLS_SSL_DEBUG_MSG(1,
5558 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5559 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005560 }
5561#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563 case MBEDTLS_MODE_GCM:
5564 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005565 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005567 transform_expansion = transform->minlen;
5568 break;
5569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005571
5572 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005574
Hanno Becker3136ede2018-08-17 15:28:19 +01005575 /* Expansion due to the addition of the MAC. */
5576 transform_expansion += transform->maclen;
5577
5578 /* Expansion due to the addition of CBC padding;
5579 * Theoretically up to 256 bytes, but we never use
5580 * more than the block size of the underlying cipher. */
5581 transform_expansion += block_size;
5582
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005583 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005584 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005585#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005586 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005587#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005588
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005589 break;
5590
5591 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5593 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005594 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005595#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005596
Hanno Beckera0e20d02019-05-15 14:03:01 +01005597#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005599 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005601#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005602
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005604}
5605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005606#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005607/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005608 * Check record counters and renegotiate if they're above the limit.
5609 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005610MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005611static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005612{
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005614 int in_ctr_cmp;
5615 int out_ctr_cmp;
5616
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005618 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5620 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005621 }
5622
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5624 &ssl->conf->renego_period[ep_len],
5625 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5626 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005627 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005629
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5631 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005632 }
5633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5635 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005636}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005637#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005638
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5640
Ronald Cron6071f612024-03-25 13:42:07 +01005641#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005642MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron698c8e92024-04-02 13:19:57 +02005643static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005644{
5645
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5647 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Cron698c8e92024-04-02 13:19:57 +02005648 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005649 }
5650
Ronald Cron698c8e92024-04-02 13:19:57 +02005651 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005652}
Ronald Cron6071f612024-03-25 13:42:07 +01005653#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005654
Jerry Yua0446a02022-07-13 11:22:55 +08005655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005656static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005657{
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005660
Ronald Cron6071f612024-03-25 13:42:07 +01005661#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron698c8e92024-04-02 13:19:57 +02005663 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron6071f612024-03-25 13:42:07 +01005664#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5665 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
Ronald Cron9f44c882024-08-28 16:44:10 +02005666 if (mbedtls_ssl_conf_is_signal_new_session_tickets_enabled(ssl->conf) ==
5667 MBEDTLS_SSL_TLS1_3_SIGNAL_NEW_SESSION_TICKETS_ENABLED) {
Ronald Cronb675b2b2024-08-27 09:19:40 +02005668 ssl->keep_current_message = 1;
Ronald Cron6071f612024-03-25 13:42:07 +01005669
Ronald Cronb675b2b2024-08-27 09:19:40 +02005670 mbedtls_ssl_handshake_set_state(ssl,
5671 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5672 return MBEDTLS_ERR_SSL_WANT_READ;
5673 } else {
Ronald Cron97dc5832024-08-28 09:34:34 +02005674 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignoring NewSessionTicket, handling disabled."));
Ronald Cronb675b2b2024-08-27 09:19:40 +02005675 return 0;
5676 }
Ronald Cron6071f612024-03-25 13:42:07 +01005677#else
Ronald Cron97dc5832024-08-28 09:34:34 +02005678 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignoring NewSessionTicket, not supported."));
Ronald Cron6071f612024-03-25 13:42:07 +01005679 return 0;
5680#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005682 }
Ronald Cron6071f612024-03-25 13:42:07 +01005683#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005684
5685 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005687}
5688#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5689
5690#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005691/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005692 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005693 * may only be sent for the purpose of initiating renegotiations.
5694 *
5695 * This function is introduced as a separate helper since the handling
5696 * of post-handshake handshake messages changes significantly in TLS 1.3,
5697 * and having a helper function allows to distinguish between TLS <= 1.2 and
5698 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5699 */
Jerry Yua0446a02022-07-13 11:22:55 +08005700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005701static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005702{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005703 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005704
5705 /*
5706 * - For client-side, expect SERVER_HELLO_REQUEST.
5707 * - For server-side, expect CLIENT_HELLO.
5708 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5709 */
5710
5711#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5713 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5714 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5715 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005716
5717 /* With DTLS, drop the packet (probably from last handshake) */
5718#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5720 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005721 }
5722#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005724 }
5725#endif /* MBEDTLS_SSL_CLI_C */
5726
5727#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5729 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5730 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005731
5732 /* With DTLS, drop the packet (probably from last handshake) */
5733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5735 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005736 }
5737#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005739 }
5740#endif /* MBEDTLS_SSL_SRV_C */
5741
5742#if defined(MBEDTLS_SSL_RENEGOTIATION)
5743 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5745 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5746 ssl->conf->allow_legacy_renegotiation ==
5747 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005748 /*
5749 * Accept renegotiation request
5750 */
5751
5752 /* DTLS clients need to know renego is server-initiated */
5753#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5755 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005756 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5757 }
5758#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 ret = mbedtls_ssl_start_renegotiation(ssl);
5760 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5761 ret != 0) {
5762 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5763 ret);
5764 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005765 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005767#endif /* MBEDTLS_SSL_RENEGOTIATION */
5768 {
5769 /*
5770 * Refuse renegotiation
5771 */
5772
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005774
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5776 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5777 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5778 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005779 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005780 }
5781
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005783}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005784#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5785
5786MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005787static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005788{
5789 /* Check protocol version and dispatch accordingly. */
5790#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5792 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005793 }
5794#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5795
5796#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5798 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005799 }
5800#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5801
5802 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005804}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005805
Paul Bakker48916f92012-09-16 19:57:18 +00005806/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005807 * brief Read at most 'len' application data bytes from the input
5808 * buffer.
5809 *
5810 * param ssl SSL context:
5811 * - First byte of application data not read yet in the input
5812 * buffer located at address `in_offt`.
5813 * - The number of bytes of data not read yet is `in_msglen`.
5814 * param buf buffer that will hold the data
5815 * param len maximum number of bytes to read
5816 *
5817 * note The function updates the fields `in_offt` and `in_msglen`
5818 * according to the number of bytes read.
5819 *
5820 * return The number of bytes read.
5821 */
5822static int ssl_read_application_data(
5823 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5824{
5825 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5826
5827 if (len != 0) {
5828 memcpy(buf, ssl->in_offt, n);
5829 ssl->in_msglen -= n;
5830 }
5831
5832 /* Zeroising the plaintext buffer to erase unused application data
5833 from the memory. */
5834 mbedtls_platform_zeroize(ssl->in_offt, n);
5835
5836 if (ssl->in_msglen == 0) {
5837 /* all bytes consumed */
5838 ssl->in_offt = NULL;
5839 ssl->keep_current_message = 0;
5840 } else {
5841 /* more data available */
5842 ssl->in_offt += n;
5843 }
5844
5845 return (int) n;
5846}
5847
5848/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005849 * Receive application data decrypted from the SSL layer
5850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005851int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005852{
Janos Follath865b3eb2019-12-16 11:46:15 +00005853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (ssl == NULL || ssl->conf == NULL) {
5856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5857 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005858
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005861#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5863 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5864 return ret;
5865 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (ssl->handshake != NULL &&
5868 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5869 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5870 return ret;
5871 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005872 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005873 }
5874#endif
5875
Hanno Becker4a810fb2017-05-24 16:27:30 +01005876 /*
5877 * Check if renegotiation is necessary and/or handshake is
5878 * in process. If yes, perform/continue, and fall through
5879 * if an unexpected packet is received while the client
5880 * is waiting for the ServerHello.
5881 *
5882 * (There is no equivalent to the last condition on
5883 * the server-side as it is not treated as within
5884 * a handshake while waiting for the ClientHello
5885 * after a renegotiation request.)
5886 */
5887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005888#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 ret = ssl_check_ctr_renegotiate(ssl);
5890 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5891 ret != 0) {
5892 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5893 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005894 }
5895#endif
5896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5898 ret = mbedtls_ssl_handshake(ssl);
5899 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5900 ret != 0) {
5901 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5902 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005903 }
5904 }
5905
Hanno Beckere41158b2017-10-23 13:30:32 +01005906 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005908 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 if (ssl->f_get_timer != NULL &&
5910 ssl->f_get_timer(ssl->p_timer) == -1) {
5911 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005912 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5915 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5916 return 0;
5917 }
Paul Bakker831a7552011-05-18 13:32:51 +00005918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5920 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005921 }
5922
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 if (ssl->in_msglen == 0 &&
5924 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005925 /*
5926 * OpenSSL sends empty messages to randomize the IV
5927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5929 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5930 return 0;
5931 }
Paul Bakker831a7552011-05-18 13:32:51 +00005932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5934 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005935 }
5936 }
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5939 ret = ssl_handle_hs_message_post_handshake(ssl);
5940 if (ret != 0) {
5941 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5942 ret);
5943 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005944 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005945
Hanno Beckerf26cc722021-04-21 07:30:13 +01005946 /* At this point, we don't know whether the renegotiation triggered
5947 * by the post-handshake message has been completed or not. The cases
5948 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005949 * 1) The renegotiation is complete. In this case, no new record
5950 * has been read yet.
5951 * 2) The renegotiation is incomplete because the client received
5952 * an application data record while awaiting the ServerHello.
5953 * 3) The renegotiation is incomplete because the client received
5954 * a non-handshake, non-application data message while awaiting
5955 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005956 *
5957 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005958 * - For 1), the next iteration will read a new record and check
5959 * if it's application data.
5960 * - For 2), the loop condition isn't satisfied as application data
5961 * is present, hence continue is the same as break
5962 * - For 3), the loop condition is satisfied and read_record
5963 * will re-deliver the message that was held back by the client
5964 * when expecting the ServerHello.
5965 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005966
Hanno Becker90333da2017-10-10 11:27:13 +01005967 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005968 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005969#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5971 if (ssl->conf->renego_max_records >= 0) {
5972 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5973 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5974 "but not honored by client"));
5975 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005976 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005977 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005978 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005979#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005981 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5983 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5984 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005985 }
5986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5988 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5989 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005990 }
5991
5992 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005993
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005994 /* We're going to return something now, cancel timer,
5995 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5997 mbedtls_ssl_set_timer(ssl, 0);
5998 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005999
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02006000#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02006001 /* If we requested renego but received AppData, resend HelloRequest.
6002 * Do it now, after setting in_offt, to avoid taking this branch
6003 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006004#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
6006 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
6007 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
6008 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
6009 ret);
6010 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02006011 }
6012 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006013#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01006014#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00006015 }
6016
Jerry Yu739a1d42022-12-08 21:10:25 +08006017 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00006018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006020
Jerry Yu739a1d42022-12-08 21:10:25 +08006021 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006022}
6023
Jerry Yud9ca3542023-12-06 17:23:52 +08006024#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
6025int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
6026 unsigned char *buf, size_t len)
6027{
Ronald Croned7d4bf2024-01-31 07:55:19 +01006028 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08006029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6030 }
6031
Ronald Cron164537c2024-02-01 18:05:47 +01006032 /*
6033 * The server may receive early data only while waiting for the End of
6034 * Early Data handshake message.
6035 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01006036 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
6037 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08006038 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
6039 }
6040
Ronald Croned7d4bf2024-01-31 07:55:19 +01006041 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08006042}
6043#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
6044
Paul Bakker5121ce52009-01-03 21:22:43 +00006045/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01006046 * Send application data to be encrypted by the SSL layer, taking care of max
6047 * fragment length and buffer size.
6048 *
6049 * According to RFC 5246 Section 6.2.1:
6050 *
6051 * Zero-length fragments of Application data MAY be sent as they are
6052 * potentially useful as a traffic analysis countermeasure.
6053 *
6054 * Therefore, it is possible that the input message length is 0 and the
6055 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00006056 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006057MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006058static int ssl_write_real(mbedtls_ssl_context *ssl,
6059 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00006060{
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02006062 const size_t max_len = (size_t) ret;
6063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (ret < 0) {
6065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
6066 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02006067 }
6068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006070#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
6072 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
6073 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
6074 " > %" MBEDTLS_PRINTF_SIZET,
6075 len, max_len));
6076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6077 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006078#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006080 }
Paul Bakker887bd502011-06-08 13:10:54 +00006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01006083 /*
6084 * The user has previously tried to send the data and
6085 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
6086 * written. In this case, we expect the high-level write function
6087 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
6088 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
6090 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
6091 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006092 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01006094 /*
6095 * The user is trying to send a message the first time, so we need to
6096 * copy the data into the internal buffers and setup the data structure
6097 * to keep track of partial writes
6098 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006099 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006100 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00006101 if (len > 0) {
6102 memcpy(ssl->out_msg, buf, len);
6103 }
Paul Bakker887bd502011-06-08 13:10:54 +00006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
6106 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
6107 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00006108 }
Paul Bakker5121ce52009-01-03 21:22:43 +00006109 }
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00006112}
6113
6114/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006115 * Write application data (public-facing wrapper)
6116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006117int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006118{
Janos Follath865b3eb2019-12-16 11:46:15 +00006119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 if (ssl == NULL || ssl->conf == NULL) {
6124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6125 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006126
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02006127#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
6129 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
6130 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006131 }
6132#endif
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
6135 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
6136 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
6137 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006138 }
6139 }
6140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006142
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006146}
6147
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006148#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
6149int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
6150 const unsigned char *buf, size_t len)
6151{
6152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6153 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01006154 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006155
6156 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
6157
6158 if (ssl == NULL || (conf = ssl->conf) == NULL) {
6159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6160 }
6161
Ronald Cron49221902024-02-21 13:39:14 +01006162 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
6163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6164 }
6165
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006166 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
6167 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
6168 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
6169 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6170 }
6171
6172 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
6173 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6174 }
6175
6176 /*
Ronald Crond2884662024-03-03 15:03:22 +01006177 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006178 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01006179 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006180 * enough to be able to send early data if possible. That way, we can
6181 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01006182 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01006183 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
6184 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01006185 * as the early data outbound transform has not been set as we may have to
6186 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006187 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006188 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01006189 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006190 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01006191 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006192 ret = mbedtls_ssl_handshake_step(ssl);
6193 if (ret != 0) {
6194 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
6195 return ret;
6196 }
6197
6198 ret = mbedtls_ssl_flush_output(ssl);
6199 if (ret != 0) {
6200 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
6201 return ret;
6202 }
6203 }
Ronald Cron62f971a2024-02-23 08:24:12 +01006204 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006205 } else {
Ronald Crond4069242024-02-21 13:45:52 +01006206 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01006207 * If we are past the point where we can send early data or we have
6208 * already reached the maximum early data size, return immediatly.
6209 * Otherwise, progress the handshake as much as possible to not delay
6210 * it too much. If we reach a point where we can still send early data,
6211 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01006212 */
Ronald Crond2884662024-03-03 15:03:22 +01006213 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
6214 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006215 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6216 }
6217
Ronald Cron62f971a2024-02-23 08:24:12 +01006218 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01006219 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01006220
6221 if (remaining == 0) {
6222 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6223 }
6224
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006225 ret = mbedtls_ssl_handshake(ssl);
6226 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
6227 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
6228 return ret;
6229 }
6230 }
6231
Ronald Crond2884662024-03-03 15:03:22 +01006232 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
6233 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01006234 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006235 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6236 }
6237
Ronald Cron62f971a2024-02-23 08:24:12 +01006238 if (len > remaining) {
6239 len = remaining;
6240 }
6241
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006242 ret = ssl_write_real(ssl, buf, len);
6243 if (ret >= 0) {
6244 ssl->total_early_data_size += ret;
6245 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006246
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006248
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006249 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006250}
6251#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6252
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006253/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006254 * Notify the peer that the connection is being closed
6255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006256int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006257{
Janos Follath865b3eb2019-12-16 11:46:15 +00006258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (ssl == NULL || ssl->conf == NULL) {
6261 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6262 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6267 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6268 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6269 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6270 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6271 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006272 }
6273 }
6274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006276
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006278}
6279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006281{
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006283 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006285
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006286#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 psa_destroy_key(transform->psa_key_enc);
6288 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006289#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6291 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006292#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006293
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006294#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006295#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 psa_destroy_key(transform->psa_mac_enc);
6297 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006298#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 mbedtls_md_free(&transform->md_ctx_enc);
6300 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006301#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006302#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006305}
6306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6308 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006309{
Jerry Yuc7875b52021-09-05 21:05:50 +08006310 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006312}
6313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6315 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006316{
6317 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006319}
6320
Hanno Becker0271f962018-08-16 13:23:47 +01006321#if defined(MBEDTLS_SSL_PROTO_DTLS)
6322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006324{
6325 unsigned offset;
6326 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6327
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006329 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 }
Hanno Becker0271f962018-08-16 13:23:47 +01006331
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6335 ssl_buffering_free_slot(ssl, offset);
6336 }
Hanno Beckere605b192018-08-21 15:59:07 +01006337}
6338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6340 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006341{
6342 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6343 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006344
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006346 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006350 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006351 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006353 }
6354}
6355
6356#endif /* MBEDTLS_SSL_PROTO_DTLS */
6357
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006358/*
6359 * Convert version numbers to/from wire format
6360 * and, for DTLS, to/from TLS equivalent.
6361 *
6362 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006363 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006364 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006365 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006367void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6368 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006369{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006370 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006371#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006373 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006375 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006376#else
6377 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006378#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006379 {
6380 tls_version_formatted = (uint16_t) tls_version;
6381 }
6382 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006383}
6384
Gilles Peskine449bd832023-01-11 14:50:10 +01006385uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6386 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006387{
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006389#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006391 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6393 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006394#else
6395 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006396#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006397 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006398}
6399
Jerry Yue7047812021-09-13 19:26:39 +08006400/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006401 * Send pending fatal alert.
6402 * 0, No alert message.
6403 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6404 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006406int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006407{
6408 int ret;
6409
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006410 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (ssl->send_alert == 0) {
6412 return 0;
6413 }
Jerry Yu394ece62021-09-14 22:17:21 +08006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 ret = mbedtls_ssl_send_alert_message(ssl,
6416 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6417 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006418
Jerry Yu3bf1f972021-09-22 21:37:18 +08006419 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6420 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006423 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006424 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (ret != 0) {
6427 return ret;
6428 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006431}
6432
Jerry Yu394ece62021-09-14 22:17:21 +08006433/*
6434 * Set pending fatal alert flag.
6435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006436void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6437 unsigned char alert_type,
6438 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006439{
6440 ssl->send_alert = 1;
6441 ssl->alert_type = alert_type;
6442 ssl->alert_reason = alert_reason;
6443}
6444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006445#endif /* MBEDTLS_SSL_TLS_C */