blob: 29518c385a88a39fdd1712d25eefd2196a5d4396 [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"
Janos Follath73c616b2019-12-18 15:07:04 +000021#include "mbedtls/debug.h"
22#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;
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +0000920 int max_out_record_len = mbedtls_ssl_get_max_out_record_payload(ssl);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000921
922 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000923#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200924 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000925 ((void) ssl);
926#endif
927
928 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200929 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100930#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
931 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 ((void) f_rng);
933 ((void) p_rng);
934#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000935
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 if (transform == NULL) {
939 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
940 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100943 || rec->buf == NULL
944 || rec->buf_len < rec->data_offset
945 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100946#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100947 || rec->cid_len != 0
948#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 ) {
950 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
951 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100952 }
953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200955
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000956 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
958 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
959 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000960
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +0000961 if (rec->data_len > (size_t) max_out_record_len) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
963 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
964 rec->data_len,
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +0000965 (size_t) max_out_record_len));
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000967 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100968
Hanno Becker92313402020-05-20 13:58:58 +0100969 /* The following two code paths implement the (D)TLSInnerPlaintext
970 * structure present in TLS 1.3 and DTLS 1.2 + CID.
971 *
972 * See ssl_build_inner_plaintext() for more information.
973 *
974 * Note that this changes `rec->data_len`, and hence
975 * `post_avail` needs to be recalculated afterwards.
976 *
977 * Note also that the two code paths cannot occur simultaneously
978 * since they apply to different versions of the protocol. There
979 * is hence no risk of double-addition of the inner plaintext.
980 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100981#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100983 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 ssl_compute_padding_length(rec->data_len,
985 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
986 if (ssl_build_inner_plaintext(data,
987 &rec->data_len,
988 post_avail,
989 rec->type,
990 padding) != 0) {
991 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100992 }
993
994 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
995 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100996#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100997
Hanno Beckera0e20d02019-05-15 14:03:01 +0100998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100999 /*
1000 * Add CID information
1001 */
1002 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1004 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001005
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001007 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 ssl_compute_padding_length(rec->data_len,
1009 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001010 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001011 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001012 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001013 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001014 * Note that this changes `rec->data_len`, and hence
1015 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 if (ssl_build_inner_plaintext(data,
1018 &rec->data_len,
1019 post_avail,
1020 rec->type,
1021 padding) != 0) {
1022 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001023 }
1024
1025 rec->type = MBEDTLS_SSL_MSG_CID;
1026 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001027#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001028
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001030
Paul Bakker5121ce52009-01-03 21:22:43 +00001031 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001032 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001033 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001034#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1036 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1037 if (post_avail < transform->maclen) {
1038 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1039 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001040 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001041#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001042 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001043 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001044#if defined(MBEDTLS_USE_PSA_CRYPTO)
1045 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1046 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1047 size_t sign_mac_length = 0;
1048#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001049
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1051 transform->tls_version,
1052 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001053
Neil Armstrong26e6d672022-02-23 09:30:33 +01001054#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1056 transform->psa_mac_alg);
1057 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001058 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 status = psa_mac_update(&operation, add_data, add_data_len);
1062 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001063 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 status = psa_mac_update(&operation, data, rec->data_len);
1067 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001068 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1072 &sign_mac_length);
1073 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001074 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001076#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1078 add_data_len);
1079 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001080 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 }
1082 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1083 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001084 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 }
1086 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1087 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001088 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 }
1090 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1091 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001092 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001097#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1100 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001101
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001102 rec->data_len += transform->maclen;
1103 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001104 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106hmac_failed_etm_disabled:
1107 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001108#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001109 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 status = psa_mac_abort(&operation);
1111 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001112 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001114#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (ret != 0) {
1116 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1117 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001118 }
Paul Bakker577e0062013-08-28 11:57:20 +02001119 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001120#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001121
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001122 /*
1123 * Encrypt
1124 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001125#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1127 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1128 "including %d bytes of padding",
1129 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001130
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001131 /* The only supported stream cipher is "NULL",
1132 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001134#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001135
Valerio Settie5707042023-10-11 11:54:42 +02001136#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001138 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001139 unsigned char *dynamic_iv;
1140 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001141 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001144 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001145#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001147
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001148 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 if (post_avail < transform->taglen) {
1150 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1151 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001152 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001153
Paul Bakker68884e32013-01-07 18:20:04 +01001154 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001155 * Build nonce for AEAD encryption.
1156 *
1157 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1158 * part of the IV is prepended to the ciphertext and
1159 * can be chosen freely - in particular, it need not
1160 * agree with the record sequence number.
1161 * However, since ChaChaPoly as well as all AEAD modes
1162 * in TLS 1.3 use the record sequence number as the
1163 * dynamic part of the nonce, we uniformly use the
1164 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001165 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001166 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 ssl_build_record_nonce(iv, sizeof(iv),
1170 transform->iv_enc,
1171 transform->fixed_ivlen,
1172 dynamic_iv,
1173 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001174
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001175 /*
1176 * Build additional data for AEAD encryption.
1177 * This depends on the TLS version.
1178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1180 transform->tls_version,
1181 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1184 iv, transform->ivlen);
1185 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1186 dynamic_iv,
1187 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1188 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1189 add_data, add_data_len);
1190 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1191 "including 0 bytes of padding",
1192 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001193
Paul Bakker68884e32013-01-07 18:20:04 +01001194 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001195 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001196 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001197#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 status = psa_aead_encrypt(transform->psa_key_enc,
1199 transform->psa_alg,
1200 iv, transform->ivlen,
1201 add_data, add_data_len,
1202 data, rec->data_len,
1203 data, rec->buf_len - (data - rec->buf),
1204 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001207 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1209 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001210 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001211#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1213 iv, transform->ivlen,
1214 add_data, add_data_len,
1215 data, rec->data_len, /* src */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001216 data, rec->buf_len - (size_t) (data - rec->buf), /* dst */
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 &rec->data_len,
1218 transform->taglen)) != 0) {
1219 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1220 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001221 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001222#endif /* MBEDTLS_USE_PSA_CRYPTO */
1223
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1225 data + rec->data_len - transform->taglen,
1226 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001227 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001228 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001229
1230 /*
1231 * Prefix record content with dynamic IV in case it is explicit.
1232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 if (dynamic_iv_is_explicit != 0) {
1234 if (rec->data_offset < dynamic_iv_len) {
1235 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1236 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001237 }
1238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001240 rec->data_offset -= dynamic_iv_len;
1241 rec->data_len += dynamic_iv_len;
1242 }
1243
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001244 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 } else
Valerio Settie5707042023-10-11 11:54:42 +02001246#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001247#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1249 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001251 size_t padlen, i;
1252 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001253#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001254 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001255 size_t part_len;
1256 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1257#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001258
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001259 /* Currently we're always using minimal padding
1260 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001261 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1262 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001263 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001264 }
1265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 /* Check there's enough space in the buffer for the padding. */
1267 if (post_avail < padlen + 1) {
1268 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1269 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1270 }
1271
1272 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001273 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001275
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001276 rec->data_len += padlen + 1;
1277 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001278
TRodziewicz0f82ec62021-05-12 17:49:18 +02001279#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001280 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001281 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001282 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 if (f_rng == NULL) {
1285 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1286 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001287 }
TRodziewicz345165c2021-07-06 13:42:11 +02001288
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 if (rec->data_offset < transform->ivlen) {
1290 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1291 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001292 }
1293
1294 /*
1295 * Generate IV
1296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1298 if (ret != 0) {
1299 return ret;
1300 }
TRodziewicz345165c2021-07-06 13:42:11 +02001301
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001303#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1306 "including %"
1307 MBEDTLS_PRINTF_SIZET
1308 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1309 rec->data_len, transform->ivlen,
1310 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 status = psa_cipher_encrypt_setup(&cipher_op,
1314 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001315
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001317 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1319 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001320 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001325 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1327 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001328
1329 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 status = psa_cipher_update(&cipher_op,
1332 data, rec->data_len,
1333 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001336 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1338 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001339
1340 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 status = psa_cipher_finish(&cipher_op,
1343 data + olen, rec->data_len - olen,
1344 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001347 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1349 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001350
1351 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001352
1353 olen += part_len;
1354#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1356 transform->iv_enc,
1357 transform->ivlen,
1358 data, rec->data_len,
1359 data, &olen)) != 0) {
1360 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1361 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001362 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001363#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001364
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (rec->data_len != olen) {
1366 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1367 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001368 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001369
TRodziewicz0f82ec62021-05-12 17:49:18 +02001370 data -= transform->ivlen;
1371 rec->data_offset -= transform->ivlen;
1372 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001376 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001377#if defined(MBEDTLS_USE_PSA_CRYPTO)
1378 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1379 size_t sign_mac_length = 0;
1380#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001381
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001382 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001383 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001384
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 if (post_avail < transform->maclen) {
1386 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1387 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001388 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 ssl_extract_add_data_from_record(add_data, &add_data_len,
1391 rec, transform->tls_version,
1392 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1395 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1396 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001397#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1399 transform->psa_mac_alg);
1400 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001401 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 status = psa_mac_update(&operation, add_data, add_data_len);
1405 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001406 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 status = psa_mac_update(&operation, data, rec->data_len);
1410 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001411 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1415 &sign_mac_length);
1416 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001417 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001419#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1422 add_data_len);
1423 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001424 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 }
1426 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1427 data, rec->data_len);
1428 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001429 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 }
1431 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1432 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001433 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 }
1435 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1436 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001437 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001439#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001442
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001443 rec->data_len += transform->maclen;
1444 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001445 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001446
Gilles Peskine449bd832023-01-11 14:50:10 +01001447hmac_failed_etm_enabled:
1448 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001449#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001450 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 status = psa_mac_abort(&operation);
1452 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001453 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001455#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 if (ret != 0) {
1457 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1458 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001459 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001460 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001463#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001464 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1466 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001467 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001468
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001469 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 if (auth_done != 1) {
1471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001473 }
1474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001478}
1479
Gilles Peskine449bd832023-01-11 14:50:10 +01001480int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1481 mbedtls_ssl_transform *transform,
1482 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001483{
Valerio Settie5707042023-10-11 11:54:42 +02001484#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001485 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001486#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001487 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001488 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001489
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001490 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001491#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001492 size_t padlen = 0;
1493 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001494#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001496 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 * the description of ssl_extract_add_data_from_record().
1498 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001499#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1500 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1501#else
1502 unsigned char add_data[13];
1503#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001504 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001505
Hanno Beckera18d1322018-01-03 14:27:32 +00001506#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001507 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 ((void) ssl);
1509#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1512 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001513 rec->buf == NULL ||
1514 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 rec->buf_len - rec->data_offset < rec->data_len) {
1516 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1517 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001518 }
1519
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001522
Hanno Beckera0e20d02019-05-15 14:03:01 +01001523#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001524 /*
1525 * Match record's CID with incoming CID.
1526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 if (rec->cid_len != transform->in_cid_len ||
1528 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1529 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001530 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001531#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001532
Hanno Beckerd086bf02021-03-22 13:01:27 +00001533#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001535 if (rec->data_len < transform->maclen) {
1536 MBEDTLS_SSL_DEBUG_MSG(1,
1537 ("Record too short for MAC:"
1538 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1539 rec->data_len, transform->maclen));
1540 return MBEDTLS_ERR_SSL_INVALID_MAC;
1541 }
1542
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001543 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001544 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001546#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001547#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001549 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001550 unsigned char *dynamic_iv;
1551 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001552#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001553 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001554#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001555
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001556 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001557 * Extract dynamic part of nonce for AEAD decryption.
1558 *
1559 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1560 * part of the IV is prepended to the ciphertext and
1561 * can be chosen freely - in particular, it need not
1562 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001563 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 dynamic_iv_len = sizeof(rec->ctr);
1565 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1566 if (rec->data_len < dynamic_iv_len) {
1567 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1568 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1569 rec->data_len,
1570 dynamic_iv_len));
1571 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001572 }
1573 dynamic_iv = data;
1574
1575 data += dynamic_iv_len;
1576 rec->data_offset += dynamic_iv_len;
1577 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001579 dynamic_iv = rec->ctr;
1580 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001581
1582 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (rec->data_len < transform->taglen) {
1584 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1585 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1586 rec->data_len,
1587 transform->taglen));
1588 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001589 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001590 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001591
Hanno Beckerdf8be222020-05-21 15:30:57 +01001592 /*
1593 * Prepare nonce from dynamic and static parts.
1594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 ssl_build_record_nonce(iv, sizeof(iv),
1596 transform->iv_dec,
1597 transform->fixed_ivlen,
1598 dynamic_iv,
1599 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001600
Hanno Beckerdf8be222020-05-21 15:30:57 +01001601 /*
1602 * Build additional data for AEAD encryption.
1603 * This depends on the TLS version.
1604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1606 transform->tls_version,
1607 transform->taglen);
1608 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1609 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001610
Hanno Beckerd96a6522019-07-10 13:55:25 +01001611 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001612 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001613 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001614 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001615 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1618 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1619 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001620
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001621 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001622 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001623 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001624#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 status = psa_aead_decrypt(transform->psa_key_dec,
1626 transform->psa_alg,
1627 iv, transform->ivlen,
1628 add_data, add_data_len,
1629 data, rec->data_len + transform->taglen,
1630 data, rec->buf_len - (data - rec->buf),
1631 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001634 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1636 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001637 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001638#else
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001639 if ((ret = mbedtls_cipher_auth_decrypt_ext
1640 (&transform->cipher_ctx_dec,
1641 iv, transform->ivlen,
1642 add_data, add_data_len,
1643 data, rec->data_len + transform->taglen, /* src */
1644 data, rec->buf_len - (size_t) (data - rec->buf), &olen, /* dst */
1645 transform->taglen)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001647
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1649 return MBEDTLS_ERR_SSL_INVALID_MAC;
1650 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001653 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001654#endif /* MBEDTLS_USE_PSA_CRYPTO */
1655
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001656 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001657
Hanno Beckerd96a6522019-07-10 13:55:25 +01001658 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 if (olen != rec->data_len) {
1660 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1661 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001662 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 } else
Valerio Settie5707042023-10-11 11:54:42 +02001664#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001665#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1667 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001668 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001669#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001670 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001671 size_t part_len;
1672 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1673#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001674
Paul Bakker5121ce52009-01-03 21:22:43 +00001675 /*
Paul Bakker45829992013-01-03 14:52:21 +01001676 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001677 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001678#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001679 /* The ciphertext is prefixed with the CBC IV. */
1680 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001681#endif
Paul Bakker45829992013-01-03 14:52:21 +01001682
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001683 /* Size considerations:
1684 *
1685 * - The CBC cipher text must not be empty and hence
1686 * at least of size transform->ivlen.
1687 *
1688 * Together with the potential IV-prefix, this explains
1689 * the first of the two checks below.
1690 *
1691 * - The record must contain a MAC, either in plain or
1692 * encrypted, depending on whether Encrypt-then-MAC
1693 * is used or not.
1694 * - If it is, the message contains the IV-prefix,
1695 * the CBC ciphertext, and the MAC.
1696 * - If it is not, the padded plaintext, and hence
1697 * the CBC ciphertext, has at least length maclen + 1
1698 * because there is at least the padding length byte.
1699 *
1700 * As the CBC ciphertext is not empty, both cases give the
1701 * lower bound minlen + maclen + 1 on the record size, which
1702 * we test for in the second check below.
1703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 if (rec->data_len < minlen + transform->ivlen ||
1705 rec->data_len < minlen + transform->maclen + 1) {
1706 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1707 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1708 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1709 "+ 1 ) ( + expl IV )",
1710 rec->data_len,
1711 transform->ivlen,
1712 transform->maclen));
1713 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001714 }
1715
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001716 /*
1717 * Authenticate before decrypt if enabled
1718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001721#if defined(MBEDTLS_USE_PSA_CRYPTO)
1722 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1723#else
Hanno Becker992b6872017-11-09 18:57:39 +00001724 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001725#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001728
Hanno Beckerd96a6522019-07-10 13:55:25 +01001729 /* Update data_len in tandem with add_data.
1730 *
1731 * The subtraction is safe because of the previous check
1732 * data_len >= minlen + maclen + 1.
1733 *
1734 * Afterwards, we know that data + data_len is followed by at
1735 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001736 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001737 *
1738 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001739 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1741 transform->tls_version,
1742 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001743
Hanno Beckerd96a6522019-07-10 13:55:25 +01001744 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1746 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001747#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1749 transform->psa_mac_alg);
1750 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001751 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 status = psa_mac_update(&operation, add_data, add_data_len);
1755 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001756 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 status = psa_mac_update(&operation, data, rec->data_len);
1760 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001761 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001763
1764 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1766 transform->maclen);
1767 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001768 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001770#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1772 add_data_len);
1773 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001774 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 }
1776 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1777 data, rec->data_len);
1778 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001779 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 }
1781 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1782 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001783 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 }
1785 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1786 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001787 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1791 transform->maclen);
1792 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1793 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001794
Hanno Beckerd96a6522019-07-10 13:55:25 +01001795 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1797 transform->maclen) != 0) {
1798 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001799 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1800 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001801 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001802#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001803 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001807 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 status = psa_mac_abort(&operation);
1809 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001810 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001812#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001814#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 if (ret != 0) {
1816 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1817 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1818 }
1819 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001820 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001821 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001823
1824 /*
1825 * Check length sanity
1826 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001827
1828 /* We know from above that data_len > minlen >= 0,
1829 * so the following check in particular implies that
1830 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (rec->data_len % transform->ivlen != 0) {
1832 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1833 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1834 rec->data_len, transform->ivlen));
1835 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001836 }
1837
TRodziewicz0f82ec62021-05-12 17:49:18 +02001838#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001839 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001840 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001841 */
TRodziewicz345165c2021-07-06 13:42:11 +02001842 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001844
TRodziewicz345165c2021-07-06 13:42:11 +02001845 data += transform->ivlen;
1846 rec->data_offset += transform->ivlen;
1847 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001848#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001849
Hanno Beckerd96a6522019-07-10 13:55:25 +01001850 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1851
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001852#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 status = psa_cipher_decrypt_setup(&cipher_op,
1854 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001857 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1859 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001860 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001865 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1867 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001868 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 status = psa_cipher_update(&cipher_op,
1871 data, rec->data_len,
1872 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001875 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1877 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001878 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 status = psa_cipher_finish(&cipher_op,
1881 data + olen, rec->data_len - olen,
1882 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001883
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001885 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1887 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001888 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001889
1890 olen += part_len;
1891#else
1892
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1894 transform->iv_dec, transform->ivlen,
1895 data, rec->data_len, data, &olen)) != 0) {
1896 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1897 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001898 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001899#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001900
Hanno Beckerd96a6522019-07-10 13:55:25 +01001901 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 if (rec->data_len != olen) {
1903 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1904 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001905 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001906
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001907 /* Safe since data_len >= minlen + maclen + 1, so after having
1908 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001909 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1910 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001911 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001914 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 rec->data_len,
1916 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001917 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001918 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (rec->data_len < transform->maclen + padlen + 1) {
1922 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1923 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1924 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1925 rec->data_len,
1926 transform->maclen,
1927 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001928 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001929#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001930 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 rec->data_len,
1932 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001933 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001934 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001935 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001936
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001937 padlen++;
1938
1939 /* Regardless of the validity of the padding,
1940 * we have data_len >= padlen here. */
1941
TRodziewicz0f82ec62021-05-12 17:49:18 +02001942#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001943 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 * consecutive memory reads at the end of the record
1945 * plaintext buffer. In order to hide the length and
1946 * validity of the padding, always perform exactly
1947 * `min(256,plaintext_len)` reads (but take into account
1948 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001949 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001951
1952 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001954 size_t const padding_idx = rec->data_len - padlen;
1955 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1956 size_t const start_idx = rec->data_len - num_checks;
1957 size_t idx;
1958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001960 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 * (check[idx] == padlen - 1);
1962 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001963 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001964 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001965 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001966 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001967 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001968 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001969 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001972 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1974 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001975#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001976 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001977
TRodziewicz0f82ec62021-05-12 17:49:18 +02001978#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001979
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001980 /* If the padding was found to be invalid, padlen == 0
1981 * and the subtraction is safe. If the padding was found valid,
1982 * padlen hasn't been changed and the previous assertion
1983 * data_len >= padlen still holds. */
1984 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001986#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001987 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1989 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001990 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001991
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001992#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1994 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001995#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001996
1997 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001998 * Authenticate if not done yet.
1999 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002000 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002001#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002003 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2004 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002005
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002006 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002007 * data_len < maclen + padlen + 1, then padlen
2008 * got reset to 1, and the initial check
2009 * data_len >= minlen + maclen + 1
2010 * guarantees that at this point we still
2011 * have at least data_len >= maclen.
2012 *
2013 * If the initial value of padlen was such that
2014 * data_len >= maclen + padlen + 1, then we have
2015 * subtracted either padlen + 1 (if the padding was correct)
2016 * or 0 (if the padding was incorrect) since then,
2017 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002018 *
2019 * For stream ciphers, we checked above that
2020 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002021 */
2022 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2024 transform->tls_version,
2025 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002026
TRodziewicz0f82ec62021-05-12 17:49:18 +02002027#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002028 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 * The next two sizes are the minimum and maximum values of
2030 * data_len over all padlen values.
2031 *
2032 * They're independent of padlen, since we previously did
2033 * data_len -= padlen.
2034 *
2035 * Note that max_len + maclen is never more than the buffer
2036 * length, as we previously did in_msglen -= maclen too.
2037 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002038 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002040
Neil Armstronge8589962022-02-25 15:14:29 +01002041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2043 transform->psa_mac_alg,
2044 add_data, add_data_len,
2045 data, rec->data_len, min_len, max_len,
2046 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002047#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2049 add_data, add_data_len,
2050 data, rec->data_len, min_len, max_len,
2051 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002052#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (ret != 0) {
2054 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002055 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002056 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 mbedtls_ct_memcpy_offset(mac_peer, data,
2059 rec->data_len,
2060 min_len, max_len,
2061 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002063
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002064#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2066 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002067#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2070 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002073#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002074 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002075 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002076 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078hmac_failed_etm_disabled:
2079 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2080 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2081 if (ret != 0) {
2082 return ret;
2083 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002084 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002085
2086 /*
2087 * Finally check the correct flag
2088 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002089 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 return MBEDTLS_ERR_SSL_INVALID_MAC;
2091 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002092#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002093
2094 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (auth_done != 1) {
2096 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2097 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002098 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002099
Ronald Cron6f135e12021-12-08 16:57:54 +01002100#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002102 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2104 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (ret != 0) {
2107 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2108 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002109 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002110#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002111
Hanno Beckera0e20d02019-05-15 14:03:01 +01002112#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (rec->cid_len != 0) {
2114 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2115 &rec->type);
2116 if (ret != 0) {
2117 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2118 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002119 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002120#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002125}
2126
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002127#undef MAC_NONE
2128#undef MAC_PLAINTEXT
2129#undef MAC_CIPHERTEXT
2130
Paul Bakker5121ce52009-01-03 21:22:43 +00002131/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002132 * Fill the input message buffer by appending data to it.
2133 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002134 *
2135 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2136 * available (from this read and/or a previous one). Otherwise, an error code
2137 * is returned (possibly EOF or WANT_READ).
2138 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002139 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2140 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2141 * since we always read a whole datagram at once.
2142 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002143 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002144 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002146int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002147{
Janos Follath865b3eb2019-12-16 11:46:15 +00002148 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002149 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002150#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2151 size_t in_buf_len = ssl->in_buf_len;
2152#else
2153 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2154#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2159 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002161 }
2162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2164 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2165 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002166 }
2167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002170 uint32_t timeout;
2171
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002172 /*
2173 * The point is, we need to always read a full datagram at once, so we
2174 * sometimes read more then requested, and handle the additional data.
2175 * It could be the rest of the current record (while fetching the
2176 * header) and/or some other records in the same datagram.
2177 */
2178
2179 /*
2180 * Move to the next record in the already read datagram if applicable
2181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (ssl->next_record_offset != 0) {
2183 if (ssl->in_left < ssl->next_record_offset) {
2184 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2185 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002186 }
2187
2188 ssl->in_left -= ssl->next_record_offset;
2189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if (ssl->in_left != 0) {
2191 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2192 MBEDTLS_PRINTF_SIZET,
2193 ssl->next_record_offset));
2194 memmove(ssl->in_hdr,
2195 ssl->in_hdr + ssl->next_record_offset,
2196 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002197 }
2198
2199 ssl->next_record_offset = 0;
2200 }
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2203 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2204 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002205
2206 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002207 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (nb_want <= ssl->in_left) {
2210 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2211 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002212 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002213
2214 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002215 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002216 * are not at the beginning of a new record, the caller did something
2217 * wrong.
2218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->in_left != 0) {
2220 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2221 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002222 }
2223
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002224 /*
2225 * Don't even try to read if time's out already.
2226 * This avoids by-passing the timer when repeatedly receiving messages
2227 * that will end up being dropped.
2228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (mbedtls_ssl_check_timer(ssl) != 0) {
2230 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002231 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002233 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002236 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002238 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 if (ssl->f_recv_timeout != NULL) {
2244 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2245 timeout);
2246 } else {
2247 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2248 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 if (ret == 0) {
2253 return MBEDTLS_ERR_SSL_CONN_EOF;
2254 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002255 }
2256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2258 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2259 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2262 if (ssl_double_retransmit_timeout(ssl) != 0) {
2263 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2264 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002265 }
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2268 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2269 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002270 }
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002273 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2276 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2277 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2278 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2279 ret);
2280 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002281 }
2282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002284 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002286 }
2287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 if (ret < 0) {
2289 return ret;
2290 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002291
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002292 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002294#endif
2295 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2297 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2298 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002301 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002304 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 } else {
2306 if (ssl->f_recv_timeout != NULL) {
2307 ret = ssl->f_recv_timeout(ssl->p_bio,
2308 ssl->in_hdr + ssl->in_left, len,
2309 ssl->conf->read_timeout);
2310 } else {
2311 ret = ssl->f_recv(ssl->p_bio,
2312 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002313 }
2314 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2317 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2318 ssl->in_left, nb_want));
2319 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if (ret == 0) {
2322 return MBEDTLS_ERR_SSL_CONN_EOF;
2323 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 if (ret < 0) {
2326 return ret;
2327 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002328
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002329 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 MBEDTLS_SSL_DEBUG_MSG(1,
2331 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2332 " were requested",
2333 ret, len));
2334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002335 }
2336
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002337 ssl->in_left += ret;
2338 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002339 }
2340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002344}
2345
2346/*
2347 * Flush any data not yet written
2348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002349int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002350{
Janos Follath865b3eb2019-12-16 11:46:15 +00002351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002352 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (ssl->f_send == NULL) {
2357 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2358 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002359 }
2360
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002361 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 if (ssl->out_left == 0) {
2363 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2364 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002365 }
2366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 while (ssl->out_left > 0) {
2368 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2369 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2370 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002371
Hanno Becker2b1e3542018-08-06 11:19:13 +01002372 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (ret <= 0) {
2378 return ret;
2379 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002380
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002381 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 MBEDTLS_SSL_DEBUG_MSG(1,
2383 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2384 " bytes were sent",
2385 ret, ssl->out_left));
2386 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002387 }
2388
Paul Bakker5121ce52009-01-03 21:22:43 +00002389 ssl->out_left -= ret;
2390 }
2391
Hanno Becker2b1e3542018-08-06 11:19:13 +01002392#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002394 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002396#endif
2397 {
2398 ssl->out_hdr = ssl->out_buf + 8;
2399 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002405}
2406
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002407/*
2408 * Functions to handle the DTLS retransmission state machine
2409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002411/*
2412 * Append current handshake message to current outgoing flight
2413 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002415static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002416{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2419 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2420 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421
2422 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2424 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2425 sizeof(mbedtls_ssl_flight_item)));
2426 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002427 }
2428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2430 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2431 ssl->out_msglen));
2432 mbedtls_free(msg);
2433 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002434 }
2435
2436 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002438 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002439 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002440 msg->next = NULL;
2441
2442 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002444 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002450 cur->next = msg;
2451 }
2452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2454 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002455}
2456
2457/*
2458 * Free the current flight of handshake messages
2459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002460void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002461{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462 mbedtls_ssl_flight_item *cur = flight;
2463 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466 next = cur->next;
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 mbedtls_free(cur->p);
2469 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002470
2471 cur = next;
2472 }
2473}
2474
2475/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002476 * Swap transform_out and out_ctr with the alternative ones
2477 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002478MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002479static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002480{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002482 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2485 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2486 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002487 }
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002490
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002491 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002492 tmp_transform = ssl->transform_out;
2493 ssl->transform_out = ssl->handshake->alt_transform_out;
2494 ssl->handshake->alt_transform_out = tmp_transform;
2495
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002496 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2498 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2499 sizeof(ssl->cur_out_ctr));
2500 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2501 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002502
2503 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002507}
2508
2509/*
2510 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002513{
2514 int ret = 0;
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002523}
2524
2525/*
2526 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002527 *
2528 * Need to remember the current message in case flush_output returns
2529 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002530 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002532int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002533{
Janos Follath865b3eb2019-12-16 11:46:15 +00002534 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2538 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002539
2540 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002541 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 ret = ssl_swap_epochs(ssl);
2543 if (ret != 0) {
2544 return ret;
2545 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002548 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002551 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002552 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002553
Hanno Beckere1dcb032018-08-17 16:47:58 +01002554 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2556 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002557
Ronald Cron00d012f22022-03-08 15:57:12 +01002558 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002560
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002561 /* Swap epochs before sending Finished: we can't do it after
2562 * sending ChangeCipherSpec, in case write returns WANT_READ.
2563 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2565 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2566 ret = ssl_swap_epochs(ssl);
2567 if (ret != 0) {
2568 return ret;
2569 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002570 }
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 ret = ssl_get_remaining_payload_in_datagram(ssl);
2573 if (ret < 0) {
2574 return ret;
2575 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002576 max_frag_len = (size_t) ret;
2577
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002578 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2580 if (max_frag_len == 0) {
2581 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2582 return ret;
2583 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002584
2585 continue;
2586 }
2587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002589 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002590 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002591
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002592 /* Update position inside current message */
2593 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002595 const unsigned char * const p = ssl->handshake->cur_msg_p;
2596 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002597 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002598 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002599 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2602 if (is_finished) {
2603 ret = ssl_swap_epochs(ssl);
2604 if (ret != 0) {
2605 return ret;
2606 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002607 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2610 return ret;
2611 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002612
2613 continue;
2614 }
2615 max_hs_frag_len = max_frag_len - 12;
2616
2617 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002619
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2621 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2622 (unsigned) cur_hs_frag_len,
2623 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002624 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002625
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002626 /* Messages are stored with handshake headers as if not fragmented,
2627 * copy beginning of headers then fill fragmentation fields.
2628 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002630
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2632 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2633 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2636 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2637 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002640
Hanno Becker3f7b9732018-08-28 09:53:25 +01002641 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002643 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002644 ssl->out_msgtype = cur->type;
2645
2646 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002647 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002648 }
2649
2650 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2652 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002653 ssl->handshake->cur_msg = cur->next;
2654 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002656 ssl->handshake->cur_msg = NULL;
2657 ssl->handshake->cur_msg_p = NULL;
2658 }
2659 }
2660
2661 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2663 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2664 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002665 }
2666 }
2667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2669 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002670 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 /* Update state and set timer */
2673 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2674 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2675 } else {
2676 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2677 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2678 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2681
2682 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002683}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002684
2685/*
2686 * To be called when the last message of an incoming flight is received.
2687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002688void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002689{
2690 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002692 ssl->handshake->flight = NULL;
2693 ssl->handshake->cur_msg = NULL;
2694
2695 /* The next incoming flight will start with this msg_seq */
2696 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2697
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002698 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002699 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002700
Hanno Becker0271f962018-08-16 13:23:47 +01002701 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002703
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002704 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2708 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002713}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002714
2715/*
2716 * To be called when the last message of an outgoing flight is send.
2717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002719{
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 ssl_reset_retransmit_timeout(ssl);
2721 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2724 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002729}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002731
Paul Bakker5121ce52009-01-03 21:22:43 +00002732/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002733 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002734 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002735int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002737{
2738 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002739 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002740 * ...
2741 * HandshakeType msg_type;
2742 * uint24 length;
2743 * ...
2744 */
2745 *buf = ssl->out_msg + 4;
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +00002746 *buf_len = mbedtls_ssl_get_max_out_record_payload(ssl) - 4;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002747
2748 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2749 ssl->out_msg[0] = hs_type;
2750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002752}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002753
2754/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002755 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002756 *
2757 * - fill in handshake headers
2758 * - update handshake checksum
2759 * - DTLS: save message for resending
2760 * - then pass to the record layer
2761 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002762 * DTLS: except for HelloRequest, messages are only queued, and will only be
2763 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002764 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002765 * Inputs:
2766 * - ssl->out_msglen: 4 + actual handshake message len
2767 * (4 is the size of handshake headers for TLS)
2768 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2769 * - ssl->out_msg + 4: the handshake message body
2770 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002771 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002772 * - ssl->out_msglen: the length of the record contents
2773 * (including handshake headers but excluding record headers)
2774 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002776int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2777 int update_checksum,
2778 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002779{
Janos Follath865b3eb2019-12-16 11:46:15 +00002780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002781 const size_t hs_len = ssl->out_msglen - 4;
2782 const unsigned char hs_type = ssl->out_msg[0];
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +00002783 int max_out_record_len = mbedtls_ssl_get_max_out_record_payload(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00002784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002786
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002787 /*
2788 * Sanity checks
2789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2791 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2792 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2793 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002794 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002795
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002796 /* Whenever we send anything different from a
2797 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2799 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2800 ssl->handshake == NULL) {
2801 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2802 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002803 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002807 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2809 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2810 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002811 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002812#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002813
Hanno Beckerb50a2532018-08-06 11:52:54 +01002814 /* Double-check that we did not exceed the bounds
2815 * of the outgoing record buffer.
2816 * This should never fail as the various message
2817 * writing functions must obey the bounds of the
2818 * outgoing record buffer, but better be safe.
2819 *
2820 * Note: We deliberately do not check for the MTU or MFL here.
2821 */
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +00002822 if (ssl->out_msglen > (size_t) max_out_record_len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2824 "size %" MBEDTLS_PRINTF_SIZET
2825 ", maximum %" MBEDTLS_PRINTF_SIZET,
2826 ssl->out_msglen,
Waleed Elmelegy9aec1c72023-12-05 20:08:51 +00002827 (size_t) max_out_record_len));
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002829 }
2830
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002831 /*
2832 * Fill handshake headers
2833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2835 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2836 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2837 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002838
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002839 /*
2840 * DTLS has additional fields in the Handshake layer,
2841 * between the length field and the actual payload:
2842 * uint16 message_seq;
2843 * uint24 fragment_offset;
2844 * uint24 fragment_length;
2845 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002848 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2850 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2851 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2852 MBEDTLS_PRINTF_SIZET,
2853 hs_len,
2854 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002856 }
2857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002859 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002860
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002861 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2863 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2864 ++(ssl->handshake->out_msg_seq);
2865 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002866 ssl->out_msg[4] = 0;
2867 ssl->out_msg[5] = 0;
2868 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002869
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002870 /* Handshake hashes are computed without fragmentation,
2871 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 memset(ssl->out_msg + 6, 0x00, 3);
2873 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002874 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002876
Hanno Becker0207e532018-08-28 10:28:28 +01002877 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002879 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2880 ssl->out_msglen);
2881 if (ret != 0) {
2882 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2883 return ret;
2884 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002886 }
2887
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002888 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2891 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2892 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2893 if ((ret = ssl_flight_append(ssl)) != 0) {
2894 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2895 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002896 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002898#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002899 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2901 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2902 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002903 }
2904 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002909}
2910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2912 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002913{
2914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2915 size_t msg_with_header_len;
2916 ((void) buf_len);
2917
2918 /* Add reserved 4 bytes for handshake header */
2919 msg_with_header_len = msg_len + 4;
2920 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002922
2923cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002925}
2926
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002927/*
2928 * Record layer functions
2929 */
2930
2931/*
2932 * Write current record.
2933 *
2934 * Uses:
2935 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2936 * - ssl->out_msglen: length of the record content (excl headers)
2937 * - ssl->out_msg: record content
2938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002939int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002940{
2941 int ret, done = 0;
2942 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002943 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002948 unsigned i;
2949 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002950#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2951 size_t out_buf_len = ssl->out_buf_len;
2952#else
2953 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2954#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002955 /* Skip writing the record content type to after the encryption,
2956 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002957 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002958#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002959 /* TLS 1.3 still uses the TLS 1.2 version identifier
2960 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002962 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002964#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2966 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2969 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002972 mbedtls_record rec;
2973
2974 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002975 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002976 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002977 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2980 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002981 rec.type = ssl->out_msgtype;
2982
Hanno Beckera0e20d02019-05-15 14:03:01 +01002983#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002984 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002985 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002986#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2989 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2990 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2991 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002992 }
2993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 if (rec.data_offset != 0) {
2995 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2996 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002997 }
2998
Hanno Becker6430faf2019-05-08 11:57:13 +01002999 /* Update the record content type and CID. */
3000 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003001#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3002 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003003#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003004 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003006 }
3007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003009
3010#if defined(MBEDTLS_SSL_PROTO_DTLS)
3011 /* In case of DTLS, double-check that we don't exceed
3012 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3014 ret = ssl_get_remaining_space_in_datagram(ssl);
3015 if (ret < 0) {
3016 return ret;
3017 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003020 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003022 }
3023 }
3024#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003025
Hanno Becker6430faf2019-05-08 11:57:13 +01003026 /* Now write the potentially updated record content type. */
3027 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3030 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3031 ssl->out_hdr[0], ssl->out_hdr[1],
3032 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3035 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003036
3037 ssl->out_left += protected_record_size;
3038 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3042 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003043 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 }
3045 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003046
Gabor Mezei96ae9262022-06-28 11:45:18 +02003047 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 if (i == mbedtls_ssl_ep_len(ssl)) {
3049 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3050 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003051 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003052 }
3053
Hanno Becker67bc7c32018-08-06 11:33:50 +01003054#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3056 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003057 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 ret = ssl_get_remaining_payload_in_datagram(ssl);
3059 if (ret < 0) {
3060 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3061 ret);
3062 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003063 }
3064
3065 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003067 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 } else {
3069 MBEDTLS_SSL_DEBUG_MSG(2,
3070 ("Still %u bytes available in current datagram",
3071 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003072 }
3073 }
3074#endif /* MBEDTLS_SSL_PROTO_DTLS */
3075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 if ((flush == SSL_FORCE_FLUSH) &&
3077 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3078 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3079 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003080 }
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003085}
3086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003088
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003089MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003090static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl->in_msglen < ssl->in_hslen ||
3093 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3094 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3095 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003098}
Hanno Becker44650b72018-08-16 12:51:11 +01003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003101{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003102 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01003103}
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003106{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003107 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01003108}
3109
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003111static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003112{
3113 uint32_t msg_len, frag_off, frag_len;
3114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 msg_len = ssl_get_hs_total_len(ssl);
3116 frag_off = ssl_get_hs_frag_off(ssl);
3117 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 if (frag_off > msg_len) {
3120 return -1;
3121 }
Hanno Becker44650b72018-08-16 12:51:11 +01003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 if (frag_len > msg_len - frag_off) {
3124 return -1;
3125 }
Hanno Becker44650b72018-08-16 12:51:11 +01003126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (frag_len + 12 > ssl->in_msglen) {
3128 return -1;
3129 }
Hanno Becker44650b72018-08-16 12:51:11 +01003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003132}
3133
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003134/*
3135 * Mark bits in bitmask (used for DTLS HS reassembly)
3136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003137static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003138{
3139 unsigned int start_bits, end_bits;
3140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 start_bits = 8 - (offset % 8);
3142 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003143 size_t first_byte_idx = offset / 8;
3144
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003145 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (len <= start_bits) {
3147 for (; len != 0; len--) {
3148 mask[first_byte_idx] |= 1 << (start_bits - len);
3149 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003150
3151 /* Avoid potential issues with offset or len becoming invalid */
3152 return;
3153 }
3154
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003155 offset += start_bits; /* Now offset % 8 == 0 */
3156 len -= start_bits;
3157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 for (; start_bits != 0; start_bits--) {
3159 mask[first_byte_idx] |= 1 << (start_bits - 1);
3160 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003161 }
3162
3163 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 if (end_bits != 0) {
3165 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003166
3167 len -= end_bits; /* Now len % 8 == 0 */
3168
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 for (; end_bits != 0; end_bits--) {
3170 mask[last_byte_idx] |= 1 << (8 - end_bits);
3171 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003172 }
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003175}
3176
3177/*
3178 * Check that bitmask is full
3179 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003181static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003182{
3183 size_t i;
3184
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 for (i = 0; i < len / 8; i++) {
3186 if (mask[i] != 0xFF) {
3187 return -1;
3188 }
3189 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 for (i = 0; i < len % 8; i++) {
3192 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3193 return -1;
3194 }
3195 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003198}
3199
Hanno Becker56e205e2018-08-16 09:06:12 +01003200/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003201static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3202 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003203{
Hanno Becker56e205e2018-08-16 09:06:12 +01003204 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003205
Hanno Becker56e205e2018-08-16 09:06:12 +01003206 alloc_len = 12; /* Handshake header */
3207 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 if (add_bitmap) {
3210 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 }
3213 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003214}
Hanno Becker56e205e2018-08-16 09:06:12 +01003215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003219{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003220 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01003221}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003224{
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3226 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3227 ssl->in_msglen));
3228 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003229 }
3230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003232
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3234 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3235 MBEDTLS_PRINTF_SIZET,
3236 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003241 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 if (ssl_check_hs_header(ssl) != 0) {
3244 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3245 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003246 }
3247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (ssl->handshake != NULL &&
3249 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3250 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3251 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3252 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3253 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3254 MBEDTLS_SSL_DEBUG_MSG(2,
3255 (
3256 "received future handshake message of sequence number %u (next %u)",
3257 recv_msg_seq,
3258 ssl->handshake->in_msg_seq));
3259 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003260 }
3261
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003262 /* Retransmit only on last message from previous flight, to avoid
3263 * too many retransmissions.
3264 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3266 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3267 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3268 "message_seq = %u, start_of_flight = %u",
3269 recv_msg_seq,
3270 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3273 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3274 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003275 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 } else {
3277 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3278 "message_seq = %u, expected = %u",
3279 recv_msg_seq,
3280 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003281 }
3282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003284 }
3285 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003286
Hanno Becker6d97ef52018-08-16 13:09:04 +01003287 /* Message reassembly is handled alongside buffering of future
3288 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003289 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003290 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3292 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3293 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003294 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003297 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 if (ssl->in_msglen < ssl->in_hslen) {
3299 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3300 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003301 }
3302
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003304}
3305
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003306int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003307{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003308 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003309 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003312 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3313 if (ret != 0) {
3314 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3315 return ret;
3316 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003317 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003318
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003319 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3322 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003323 unsigned offset;
3324 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003325
Hanno Becker0271f962018-08-16 13:23:47 +01003326 /* Increment handshake sequence number */
3327 hs->in_msg_seq++;
3328
3329 /*
3330 * Clear up handshake buffering and reassembly structure.
3331 */
3332
3333 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003335
3336 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003338 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003340 *hs_buf = *(hs_buf + 1);
3341 }
3342
3343 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003345 }
3346#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003347 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003348}
3349
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003350/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003351 * DTLS anti-replay: RFC 6347 4.1.2.6
3352 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003353 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3354 * Bit n is set iff record number in_window_top - n has been seen.
3355 *
3356 * Usually, in_window_top is the last record number seen and the lsb of
3357 * in_window is set. The only exception is the initial state (record number 0
3358 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003361void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003362{
3363 ssl->in_window_top = 0;
3364 ssl->in_window = 0;
3365}
3366
Gilles Peskine449bd832023-01-11 14:50:10 +01003367static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003368{
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 return ((uint64_t) buf[0] << 40) |
3370 ((uint64_t) buf[1] << 32) |
3371 ((uint64_t) buf[2] << 24) |
3372 ((uint64_t) buf[3] << 16) |
3373 ((uint64_t) buf[4] << 8) |
3374 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003375}
3376
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003378static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003379{
Janos Follath865b3eb2019-12-16 11:46:15 +00003380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003381 unsigned char *original_in_ctr;
3382
3383 // save original in_ctr
3384 original_in_ctr = ssl->in_ctr;
3385
3386 // use counter from record
3387 ssl->in_ctr = record_in_ctr;
3388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003390
3391 // restore the counter
3392 ssl->in_ctr = original_in_ctr;
3393
3394 return ret;
3395}
3396
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003397/*
3398 * Return 0 if sequence number is acceptable, -1 otherwise
3399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003400int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003401{
Gilles Peskine449bd832023-01-11 14:50:10 +01003402 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003403 uint64_t bit;
3404
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3406 return 0;
3407 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 if (rec_seqnum > ssl->in_window_top) {
3410 return 0;
3411 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003412
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003413 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (bit >= 64) {
3416 return -1;
3417 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003418
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3420 return -1;
3421 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003422
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003424}
3425
3426/*
3427 * Update replay window on new validated record
3428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003429void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003430{
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003434 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003436
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003438 /* Update window_top and the contents of the window */
3439 uint64_t shift = rec_seqnum - ssl->in_window_top;
3440
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003442 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003444 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003445 ssl->in_window |= 1;
3446 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447
3448 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003450 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003451 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003454 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003456 }
3457}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003460#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003461/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003462 * Check if a datagram looks like a ClientHello with a valid cookie,
3463 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003464 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003465 *
3466 * - if cookie is valid, return 0
3467 * - if ClientHello looks superficially valid but cookie is not,
3468 * fill obuf and set olen, then
3469 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3470 * - otherwise return a specific error code
3471 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003472MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003473MBEDTLS_STATIC_TESTABLE
3474int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 mbedtls_ssl_context *ssl,
3476 const unsigned char *cli_id, size_t cli_id_len,
3477 const unsigned char *in, size_t in_len,
3478 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003479{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003480 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003481 unsigned char *p;
3482
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003483 /*
3484 * Structure of ClientHello with record and handshake headers,
3485 * and expected values. We don't need to check a lot, more checks will be
3486 * done when actually parsing the ClientHello - skipping those checks
3487 * avoids code duplication and does not make cookie forging any easier.
3488 *
3489 * 0-0 ContentType type; copied, must be handshake
3490 * 1-2 ProtocolVersion version; copied
3491 * 3-4 uint16 epoch; copied, must be 0
3492 * 5-10 uint48 sequence_number; copied
3493 * 11-12 uint16 length; (ignored)
3494 *
3495 * 13-13 HandshakeType msg_type; (ignored)
3496 * 14-16 uint24 length; (ignored)
3497 * 17-18 uint16 message_seq; copied
3498 * 19-21 uint24 fragment_offset; copied, must be 0
3499 * 22-24 uint24 fragment_length; (ignored)
3500 *
3501 * 25-26 ProtocolVersion client_version; (ignored)
3502 * 27-58 Random random; (ignored)
3503 * 59-xx SessionID session_id; 1 byte len + sid_len content
3504 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3505 * ...
3506 *
3507 * Minimum length is 61 bytes.
3508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3510 (unsigned) in_len));
3511 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3512 if (in_len < 61) {
3513 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3514 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003515 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003516
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3518 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003519
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3521 fragment_offset != 0) {
3522 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3523 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3524 in[0], (unsigned) epoch,
3525 (unsigned) fragment_offset));
3526 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003527 }
3528
3529 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003530 if (59 + 1 + sid_len + 1 > in_len) {
3531 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3532 (unsigned) sid_len,
3533 (unsigned) in_len - 61));
3534 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003535 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003536 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3537 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003538
3539 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003540 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3541 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3542 (unsigned) cookie_len,
3543 (unsigned) (in_len - sid_len - 61)));
3544 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003545 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003546
Gilles Peskine449bd832023-01-11 14:50:10 +01003547 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3548 in + sid_len + 61, cookie_len);
3549 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3550 in + sid_len + 61, cookie_len,
3551 cli_id, cli_id_len) == 0) {
3552 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3553 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003554 }
3555
3556 /*
3557 * If we get here, we've got an invalid cookie, let's prepare HVR.
3558 *
3559 * 0-0 ContentType type; copied
3560 * 1-2 ProtocolVersion version; copied
3561 * 3-4 uint16 epoch; copied
3562 * 5-10 uint48 sequence_number; copied
3563 * 11-12 uint16 length; olen - 13
3564 *
3565 * 13-13 HandshakeType msg_type; hello_verify_request
3566 * 14-16 uint24 length; olen - 25
3567 * 17-18 uint16 message_seq; copied
3568 * 19-21 uint24 fragment_offset; copied
3569 * 22-24 uint24 fragment_length; olen - 25
3570 *
3571 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3572 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3573 *
3574 * Minimum length is 28.
3575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003576 if (buf_len < 28) {
3577 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3578 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003579
3580 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003582 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3583 obuf[25] = 0xfe;
3584 obuf[26] = 0xff;
3585
3586 /* Generate and write actual cookie */
3587 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003588 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3589 &p, obuf + buf_len,
3590 cli_id, cli_id_len) != 0) {
3591 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003592 }
3593
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003594 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003595
3596 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003598
Gilles Peskine449bd832023-01-11 14:50:10 +01003599 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3600 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3601 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003602
Gilles Peskine449bd832023-01-11 14:50:10 +01003603 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003604
Gilles Peskine449bd832023-01-11 14:50:10 +01003605 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003606}
3607
3608/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003609 * Handle possible client reconnect with the same UDP quadruplet
3610 * (RFC 6347 Section 4.2.8).
3611 *
3612 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3613 * that looks like a ClientHello.
3614 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003615 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003616 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003617 * - if the input looks like a ClientHello with a valid cookie,
3618 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003619 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003620 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003621 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003622 * This function is called (through ssl_check_client_reconnect()) when an
3623 * unexpected record is found in ssl_get_next_record(), which will discard the
3624 * record if we return 0, and bubble up the return value otherwise (this
3625 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3626 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003627 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003628MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003629static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630{
Janos Follath865b3eb2019-12-16 11:46:15 +00003631 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003632 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003633
Gilles Peskine449bd832023-01-11 14:50:10 +01003634 if (ssl->conf->f_cookie_write == NULL ||
3635 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003636 /* If we can't use cookies to verify reachability of the peer,
3637 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003638 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3639 "can't check reconnect validity"));
3640 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003641 }
3642
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003643 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003644 ssl,
3645 ssl->cli_id, ssl->cli_id_len,
3646 ssl->in_buf, ssl->in_left,
3647 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003650
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003652 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3654 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3655 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003656 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003657 * If the error is permanent we'll catch it later,
3658 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3660 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003661 (void) send_ret;
3662
Gilles Peskine449bd832023-01-11 14:50:10 +01003663 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003664 }
3665
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 if (ret == 0) {
3667 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3668 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3669 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3670 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003671 }
3672
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003674 }
3675
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003677}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003678#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003679
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003680MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003681static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003682{
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003684 record_type != MBEDTLS_SSL_MSG_ALERT &&
3685 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3687 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003688 }
3689
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003691}
3692
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003693/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003694 * ContentType type;
3695 * ProtocolVersion version;
3696 * uint16 epoch; // DTLS only
3697 * uint48 sequence_number; // DTLS only
3698 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003699 *
3700 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003701 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3703 *
3704 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003705 * 1. proceed with the record if this function returns 0
3706 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3707 * 3. return CLIENT_RECONNECT if this function return that value
3708 * 4. drop the whole datagram if this function returns anything else.
3709 * Point 2 is needed when the peer is resending, and we have already received
3710 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003711 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003713static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3714 unsigned char *buf,
3715 size_t len,
3716 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003717{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003718 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003719
Hanno Beckere5e7e782019-07-11 12:29:35 +01003720 size_t const rec_hdr_type_offset = 0;
3721 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003722
Hanno Beckere5e7e782019-07-11 12:29:35 +01003723 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3724 rec_hdr_type_len;
3725 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003726
Hanno Beckere5e7e782019-07-11 12:29:35 +01003727 size_t const rec_hdr_ctr_len = 8;
3728#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003729 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003730 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3731 rec_hdr_version_len;
3732
Hanno Beckera0e20d02019-05-15 14:03:01 +01003733#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003734 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3735 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003736 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003737#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3738#endif /* MBEDTLS_SSL_PROTO_DTLS */
3739
3740 size_t rec_hdr_len_offset; /* To be determined */
3741 size_t const rec_hdr_len_len = 2;
3742
3743 /*
3744 * Check minimum lengths for record header.
3745 */
3746
3747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003749 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003751#endif /* MBEDTLS_SSL_PROTO_DTLS */
3752 {
3753 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3754 }
3755
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3757 MBEDTLS_SSL_DEBUG_MSG(1,
3758 (
3759 "datagram of length %u too small to hold DTLS record header of length %u",
3760 (unsigned) len,
3761 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3762 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003763 }
3764
3765 /*
3766 * Parse and validate record content type
3767 */
3768
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003770
3771 /* Check record content type */
3772#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3773 rec->cid_len = 0;
3774
Gilles Peskine449bd832023-01-11 14:50:10 +01003775 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003776 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003777 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003778 /* Shift pointers to account for record header including CID
3779 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003780 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003781 * ProtocolVersion version;
3782 * uint16 epoch;
3783 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003784 * opaque cid[cid_length]; // Additional field compared to
3785 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003786 * uint16 length;
3787 * opaque enc_content[DTLSCiphertext.length];
3788 * } DTLSCiphertext;
3789 */
3790
3791 /* So far, we only support static CID lengths
3792 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003793 rec_hdr_cid_len = ssl->conf->cid_len;
3794 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003795
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3797 MBEDTLS_SSL_DEBUG_MSG(1,
3798 (
3799 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3800 (unsigned) len,
3801 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3802 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003803 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003804
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003805 /* configured CID len is guaranteed at most 255, see
3806 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3807 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003808 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3809 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003810#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003811 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 if (ssl_check_record_type(rec->type)) {
3813 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3814 (unsigned) rec->type));
3815 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003816 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003817 }
3818
Hanno Beckere5e7e782019-07-11 12:29:35 +01003819 /*
3820 * Parse and validate record version
3821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3823 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003824 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3825 buf + rec_hdr_version_offset,
3826 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 if (tls_version > ssl->conf->max_tls_version) {
3829 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3830 (unsigned) tls_version,
3831 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003832
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003834 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003835 /*
3836 * Parse/Copy record sequence number.
3837 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003838
Hanno Beckere5e7e782019-07-11 12:29:35 +01003839#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003840 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003841 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3843 rec_hdr_ctr_len);
3844 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003845#endif /* MBEDTLS_SSL_PROTO_DTLS */
3846 {
3847 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003849 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003850
Hanno Beckere5e7e782019-07-11 12:29:35 +01003851 /*
3852 * Parse record length.
3853 */
3854
Hanno Beckere5e7e782019-07-11 12:29:35 +01003855 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003856 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003858
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3860 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3861 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003862
3863 rec->buf = buf;
3864 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003865
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 if (rec->data_len == 0) {
3867 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3868 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003869
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003870 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003871 * DTLS-related tests.
3872 * Check epoch before checking length constraint because
3873 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3874 * message gets duplicated before the corresponding Finished message,
3875 * the second ChangeCipherSpec should be discarded because it belongs
3876 * to an old epoch, but not because its length is shorter than
3877 * the minimum record length for packets using the new record transform.
3878 * Note that these two kinds of failures are handled differently,
3879 * as an unexpected record is silently skipped but an invalid
3880 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003881 */
3882#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003884 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003885
Hanno Becker955a5c92019-07-10 17:12:07 +01003886 /* Check that the datagram is large enough to contain a record
3887 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (len < rec->data_offset + rec->data_len) {
3889 MBEDTLS_SSL_DEBUG_MSG(1,
3890 (
3891 "Datagram of length %u too small to contain record of advertised length %u.",
3892 (unsigned) len,
3893 (unsigned) (rec->data_offset + rec->data_len)));
3894 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003895 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003896
Hanno Becker37cfe732019-07-10 17:20:01 +01003897 /* Records from other, non-matching epochs are silently discarded.
3898 * (The case of same-port Client reconnects must be considered in
3899 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 if (rec_epoch != ssl->in_epoch) {
3901 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3902 "expected %u, received %lu",
3903 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003904
Hanno Becker552f7472019-07-19 10:59:12 +01003905 /* Records from the next epoch are considered for buffering
3906 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3908 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3909 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003910 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003911
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003913 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003914#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003915 /* For records from the correct epoch, check whether their
3916 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3918 &rec->ctr[0]) != 0) {
3919 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3920 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003921 }
3922#endif
3923 }
3924#endif /* MBEDTLS_SSL_PROTO_DTLS */
3925
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003927}
Paul Bakker5121ce52009-01-03 21:22:43 +00003928
Paul Bakker5121ce52009-01-03 21:22:43 +00003929
Hanno Becker2fddd372019-07-10 14:37:41 +01003930#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003931MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003932static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003933{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003934 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003935
3936 /*
3937 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3938 * access the first byte of record content (handshake type), as we
3939 * have an active transform (possibly iv_len != 0), so use the
3940 * fact that the record header len is 13 instead.
3941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003943 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003945 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3946 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3948 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3949 "from the same port"));
3950 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003951 }
3952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003954}
Hanno Becker2fddd372019-07-10 14:37:41 +01003955#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003956
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003957/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003958 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003959 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003961static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3962 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003963{
3964 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3967 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003968
Ronald Cron7e38cba2021-11-24 12:43:39 +01003969 /*
3970 * In TLS 1.3, always treat ChangeCipherSpec records
3971 * as unencrypted. The only thing we do with them is
3972 * check the length and content and ignore them.
3973 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003974#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 if (ssl->transform_in != NULL &&
3976 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3977 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003978 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003980 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003981#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003984 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3987 rec)) != 0) {
3988 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003989
Hanno Beckera0e20d02019-05-15 14:03:01 +01003990#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003992 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3994 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003995 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003996 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003997#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004000 }
4001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (old_msg_type != rec->type) {
4003 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4004 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004005 }
4006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4008 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004009
Hanno Beckera0e20d02019-05-15 14:03:01 +01004010#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004011 /* We have already checked the record content type
4012 * in ssl_parse_record_header(), failing or silently
4013 * dropping the record in the case of an unknown type.
4014 *
4015 * Since with the use of CIDs, the record content type
4016 * might change during decryption, re-check the record
4017 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (ssl_check_record_type(rec->type)) {
4019 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4020 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004021 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004022#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004025#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4027 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004028 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4030 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004031 }
4032#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4033
4034 ssl->nb_zero++;
4035
4036 /*
4037 * Three or more empty messages may be a DoS attack
4038 * (excessive CPU consumption).
4039 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (ssl->nb_zero > 3) {
4041 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4042 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004043 /* Treat the records as if they were not properly authenticated,
4044 * thereby failing the connection if we see more than allowed
4045 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004047 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004049 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004051
4052#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004054 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004056#endif
4057 {
4058 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4060 i > mbedtls_ssl_ep_len(ssl); i--) {
4061 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004062 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004064 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004065
4066 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (i == mbedtls_ssl_ep_len(ssl)) {
4068 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4069 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004070 }
4071 }
4072
Paul Bakker5121ce52009-01-03 21:22:43 +00004073 }
4074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004075#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4077 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004078 }
4079#endif
4080
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004081 /* Check actual (decrypted) record content length against
4082 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4084 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4085 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004086 }
4087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004089}
4090
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004091/*
4092 * Read a record.
4093 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004094 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4095 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4096 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004097 */
Hanno Becker1097b342018-08-15 14:09:41 +01004098
4099/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004100MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004101static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004103static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004105static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4108 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004109{
Janos Follath865b3eb2019-12-16 11:46:15 +00004110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004115 do {
Simon Butcher99000142016-10-13 17:21:01 +01004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 ret = ssl_consume_current_message(ssl);
4118 if (ret != 0) {
4119 return ret;
4120 }
Hanno Becker26994592018-08-15 14:14:59 +01004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004123 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004124#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004125
Hanno Becker40f50842018-08-15 14:48:01 +01004126 /* We only check for buffered messages if the
4127 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4129 ssl_next_record_is_in_datagram(ssl) == 0) {
4130 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004131 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 }
Hanno Becker40f50842018-08-15 14:48:01 +01004133 }
4134
Hanno Becker40f50842018-08-15 14:48:01 +01004135#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (dtls_have_buffered == 0) {
4137 ret = ssl_get_next_record(ssl);
4138 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004139 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 }
Hanno Becker40f50842018-08-15 14:48:01 +01004141
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 if (ret != 0) {
4143 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4144 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004145 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004146 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004147 }
4148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004150
Hanno Becker40f50842018-08-15 14:48:01 +01004151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004153 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 ret = ssl_buffer_message(ssl);
4155 if (ret != 0) {
4156 return ret;
4157 }
Hanno Becker40f50842018-08-15 14:48:01 +01004158
4159 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4160 }
4161#endif /* MBEDTLS_SSL_PROTO_DTLS */
4162
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4164 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (0 != ret) {
4167 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4168 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004169 }
4170
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4172 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004173 ret = mbedtls_ssl_update_handshake_status(ssl);
4174 if (0 != ret) {
4175 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4176 return ret;
4177 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004178 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 } else {
4180 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004181 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004182 }
4183
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004187}
4188
Hanno Becker40f50842018-08-15 14:48:01 +01004189#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004190MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004191static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004192{
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (ssl->in_left > ssl->next_record_offset) {
4194 return 1;
4195 }
Simon Butcher99000142016-10-13 17:21:01 +01004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004198}
4199
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004201static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004202{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004203 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004205 int ret = 0;
4206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (hs == NULL) {
4208 return -1;
4209 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004212
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4214 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004215 /* Check if we have seen a ChangeCipherSpec before.
4216 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (!hs->buffering.seen_ccs) {
4218 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004219 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004220 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004221 }
4222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4225 ssl->in_msglen = 1;
4226 ssl->in_msg[0] = 1;
4227
4228 /* As long as they are equal, the exact value doesn't matter. */
4229 ssl->in_left = 0;
4230 ssl->next_record_offset = 0;
4231
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004232 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004233 goto exit;
4234 }
Hanno Becker37f95322018-08-16 13:55:32 +01004235
Hanno Beckerb8f50142018-08-28 10:01:34 +01004236#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004237 /* Debug only */
4238 {
4239 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004241 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (hs_buf->is_valid == 1) {
4243 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4244 hs->in_msg_seq + offset,
4245 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004246 }
4247 }
4248 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004249#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004250
4251 /* Check if we have buffered and/or fully reassembled the
4252 * next handshake message. */
4253 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004255 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004256 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004257
4258 /* Double-check that we haven't accidentally buffered
4259 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4261 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4262 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004263 }
4264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4266 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4267 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004268
4269 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4270 ssl->in_hslen = msg_len + 12;
4271 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004273
4274 ret = 0;
4275 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 } else {
4277 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4278 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004279 }
4280
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004281 ret = -1;
4282
4283exit:
4284
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4286 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004287}
4288
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004289MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004290static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4291 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004292{
4293 int offset;
4294 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4296 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004297
Hanno Becker01315ea2018-08-21 17:22:17 +01004298 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004300
4301 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4303 hs->buffering.total_bytes_buffered)) {
4304 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4305 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004306 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004307
Hanno Becker4f432ad2018-08-28 10:02:32 +01004308 /* We don't have enough space to buffer the next expected handshake
4309 * message. Remove buffers used for future messages to gain space,
4310 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4312 offset >= 0; offset--) {
4313 MBEDTLS_SSL_DEBUG_MSG(2,
4314 (
4315 "Free buffering slot %d to make space for reassembly of next handshake message",
4316 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004319
4320 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4322 hs->buffering.total_bytes_buffered)) {
4323 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4324 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004325 }
4326 }
4327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004329}
4330
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004331MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004332static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004333{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004334 int ret = 0;
4335 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (hs == NULL) {
4338 return 0;
4339 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004344 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004346
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004347 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004348 break;
4349
4350 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004351 {
4352 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004353 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004354 mbedtls_ssl_hs_buffer *hs_buf;
4355 size_t msg_len = ssl->in_hslen - 12;
4356
4357 /* We should never receive an old handshake
4358 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4360 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4361 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004362 }
4363
4364 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004366 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 MBEDTLS_SSL_DEBUG_MSG(2,
4368 ("Ignore future HS message with sequence number %u, "
4369 "buffering window %u - %u",
4370 recv_msg_seq, ssl->handshake->in_msg_seq,
4371 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4372 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004373
4374 goto exit;
4375 }
4376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4378 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004381
4382 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004384 size_t reassembly_buf_sz;
4385
Hanno Becker37f95322018-08-16 13:55:32 +01004386 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004388
4389 /* We copy the message back into the input buffer
4390 * after reassembly, so check that it's not too large.
4391 * This is an implementation-specific limitation
4392 * and not one from the standard, hence it is not
4393 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004395 /* Ignore message */
4396 goto exit;
4397 }
4398
Hanno Beckere0b150f2018-08-21 15:51:03 +01004399 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (hs->buffering.total_bytes_buffered >
4401 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4402 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4403 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004404 }
4405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4407 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4410 hs->buffering.total_bytes_buffered)) {
4411 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004412 /* If we can't buffer a future message because
4413 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 MBEDTLS_SSL_DEBUG_MSG(2,
4415 ("Buffering of future message of size %"
4416 MBEDTLS_PRINTF_SIZET
4417 " would exceed the compile-time limit %"
4418 MBEDTLS_PRINTF_SIZET
4419 " (already %" MBEDTLS_PRINTF_SIZET
4420 " bytes buffered) -- ignore\n",
4421 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4422 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004423 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 } else {
4425 MBEDTLS_SSL_DEBUG_MSG(2,
4426 ("Buffering of future message of size %"
4427 MBEDTLS_PRINTF_SIZET
4428 " would exceed the compile-time limit %"
4429 MBEDTLS_PRINTF_SIZET
4430 " (already %" MBEDTLS_PRINTF_SIZET
4431 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4432 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4433 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004434 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4437 MBEDTLS_SSL_DEBUG_MSG(2,
4438 ("Reassembly of next message of size %"
4439 MBEDTLS_PRINTF_SIZET
4440 " (%" MBEDTLS_PRINTF_SIZET
4441 " with bitmap) would exceed"
4442 " the compile-time limit %"
4443 MBEDTLS_PRINTF_SIZET
4444 " (already %" MBEDTLS_PRINTF_SIZET
4445 " bytes buffered) -- fail\n",
4446 msg_len,
4447 reassembly_buf_sz,
4448 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4449 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004450 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4451 goto exit;
4452 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004453 }
4454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 MBEDTLS_SSL_DEBUG_MSG(2,
4456 ("initialize reassembly, total length = %"
4457 MBEDTLS_PRINTF_SIZET,
4458 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4461 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004462 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004463 goto exit;
4464 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004465 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004466
4467 /* Prepare final header: copy msg_type, length and message_seq,
4468 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 memcpy(hs_buf->data, ssl->in_msg, 6);
4470 memset(hs_buf->data + 6, 0, 3);
4471 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004472
4473 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004474
4475 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004477 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4479 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004480 /* Ignore */
4481 goto exit;
4482 }
4483 }
4484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004486 size_t frag_len, frag_off;
4487 unsigned char * const msg = hs_buf->data + 12;
4488
4489 /*
4490 * Check and copy current fragment
4491 */
4492
4493 /* Validation of header fields already done in
4494 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 frag_off = ssl_get_hs_frag_off(ssl);
4496 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4499 ", length = %" MBEDTLS_PRINTF_SIZET,
4500 frag_off, frag_len));
4501 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004504 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 ssl_bitmask_set(bitmask, frag_off, frag_len);
4506 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4507 msg_len) == 0);
4508 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004509 hs_buf->is_complete = 1;
4510 }
4511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4513 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004514 }
4515
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004516 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004517 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004518
4519 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004520 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004521 break;
4522 }
4523
4524exit:
4525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4527 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004528}
4529#endif /* MBEDTLS_SSL_PROTO_DTLS */
4530
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004531MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004532static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004533{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004534 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004535 * Consume last content-layer message and potentially
4536 * update in_msglen which keeps track of the contents'
4537 * consumption state.
4538 *
4539 * (1) Handshake messages:
4540 * Remove last handshake message, move content
4541 * and adapt in_msglen.
4542 *
4543 * (2) Alert messages:
4544 * Consume whole record content, in_msglen = 0.
4545 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004546 * (3) Change cipher spec:
4547 * Consume whole record content, in_msglen = 0.
4548 *
4549 * (4) Application data:
4550 * Don't do anything - the record layer provides
4551 * the application data as a stream transport
4552 * and consumes through mbedtls_ssl_read only.
4553 *
4554 */
4555
4556 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004558 /* Hard assertion to be sure that no application data
4559 * is in flight, as corrupting ssl->in_msglen during
4560 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (ssl->in_offt != NULL) {
4562 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4563 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004564 }
4565
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004566 /*
4567 * Get next Handshake message in the current record
4568 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004569
Hanno Becker4a810fb2017-05-24 16:27:30 +01004570 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004571 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004572 * current handshake content: If DTLS handshake
4573 * fragmentation is used, that's the fragment
4574 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004575 * size here is faulty and should be changed at
4576 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004577 * (2) While it doesn't seem to cause problems, one
4578 * has to be very careful not to assume that in_hslen
4579 * is always <= in_msglen in a sensible communication.
4580 * Again, it's wrong for DTLS handshake fragmentation.
4581 * The following check is therefore mandatory, and
4582 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004583 * Additionally, ssl->in_hslen might be arbitrarily out of
4584 * bounds after handling a DTLS message with an unexpected
4585 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004586 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004588 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4590 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4593 ssl->in_msg, ssl->in_msglen);
4594 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004595 ssl->in_msglen = 0;
4596 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004597
Hanno Becker4a810fb2017-05-24 16:27:30 +01004598 ssl->in_hslen = 0;
4599 }
4600 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 else if (ssl->in_offt != NULL) {
4602 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004603 }
4604 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004606 ssl->in_msglen = 0;
4607 }
4608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004610}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004611
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004612MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004613static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004614{
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (ssl->in_msglen > 0) {
4616 return 1;
4617 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004620}
4621
Hanno Becker5f066e72018-08-16 14:56:31 +01004622#if defined(MBEDTLS_SSL_PROTO_DTLS)
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004625{
4626 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004628 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004632 hs->buffering.total_bytes_buffered -=
4633 hs->buffering.future_record.len;
4634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004636 hs->buffering.future_record.data = NULL;
4637 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004638}
4639
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004640MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004641static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004642{
4643 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004645 size_t rec_len;
4646 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004647#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4648 size_t in_buf_len = ssl->in_buf_len;
4649#else
4650 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4651#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4653 return 0;
4654 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004655
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 if (hs == NULL) {
4657 return 0;
4658 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004659
Hanno Becker5f066e72018-08-16 14:56:31 +01004660 rec = hs->buffering.future_record.data;
4661 rec_len = hs->buffering.future_record.len;
4662 rec_epoch = hs->buffering.future_record.epoch;
4663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (rec == NULL) {
4665 return 0;
4666 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004667
Hanno Becker4cb782d2018-08-20 11:19:05 +01004668 /* Only consider loading future records if the
4669 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4671 return 0;
4672 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (rec_epoch != ssl->in_epoch) {
4677 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004678 goto exit;
4679 }
4680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004682
4683 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4685 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4686 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004687 }
4688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004690 ssl->in_left = rec_len;
4691 ssl->next_record_offset = 0;
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004694
4695exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4697 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004698}
4699
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004701static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4702 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004703{
4704 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004705
4706 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (hs == NULL) {
4708 return 0;
4709 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004710
4711 /* Only buffer handshake records (we are only interested
4712 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4714 return 0;
4715 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004716
4717 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (hs->buffering.future_record.data != NULL) {
4719 return 0;
4720 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004721
Hanno Becker01315ea2018-08-21 17:22:17 +01004722 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4724 hs->buffering.total_bytes_buffered)) {
4725 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4726 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4727 " (already %" MBEDTLS_PRINTF_SIZET
4728 " bytes buffered) -- ignore\n",
4729 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4730 hs->buffering.total_bytes_buffered));
4731 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004732 }
4733
Hanno Becker5f066e72018-08-16 14:56:31 +01004734 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4736 ssl->in_epoch + 1U));
4737 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004738
4739 /* ssl_parse_record_header() only considers records
4740 * of the next epoch as candidates for buffering. */
4741 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004742 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004743
4744 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 mbedtls_calloc(1, hs->buffering.future_record.len);
4746 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004747 /* If we run out of RAM trying to buffer a
4748 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004750 }
4751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004753
Hanno Becker519f15d2019-07-11 12:43:20 +01004754 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004756}
4757
4758#endif /* MBEDTLS_SSL_PROTO_DTLS */
4759
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004760MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004761static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004762{
Janos Follath865b3eb2019-12-16 11:46:15 +00004763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004764 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004765
Hanno Becker5f066e72018-08-16 14:56:31 +01004766#if defined(MBEDTLS_SSL_PROTO_DTLS)
4767 /* We might have buffered a future record; if so,
4768 * and if the epoch matches now, load it.
4769 * On success, this call will set ssl->in_left to
4770 * the length of the buffered record, so that
4771 * the calls to ssl_fetch_input() below will
4772 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 ret = ssl_load_buffered_record(ssl);
4774 if (ret != 0) {
4775 return ret;
4776 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004777#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004778
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004779 /* Ensure that we have enough space available for the default form
4780 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4781 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4783 if (ret != 0) {
4784 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4785 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004786 }
4787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4789 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4792 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4793 ret = ssl_buffer_future_record(ssl, &rec);
4794 if (ret != 0) {
4795 return ret;
4796 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004797
4798 /* Fall through to handling of unexpected records */
4799 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4800 }
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004803#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004804 /* Reset in pointers to default state for TLS/DTLS records,
4805 * assuming no CID and no offset between record content and
4806 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004808
Hanno Becker7ae20e02019-07-12 08:33:49 +01004809 /* Setup internal message pointers from record structure. */
4810 ssl->in_msgtype = rec.type;
4811#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4812 ssl->in_len = ssl->in_cid + rec.cid_len;
4813#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4814 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4815 ssl->in_msglen = rec.data_len;
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 ret = ssl_check_client_reconnect(ssl);
4818 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4819 if (ret != 0) {
4820 return ret;
4821 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004822#endif
4823
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004824 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004825 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4828 "(header)"));
4829 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004830 /* Skip invalid record and the rest of the datagram */
4831 ssl->next_record_offset = 0;
4832 ssl->in_left = 0;
4833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4835 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004836 }
4837
4838 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4840 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004841#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004842 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004844 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004845 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004849 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004850 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 if (ssl->next_record_offset < ssl->in_left) {
4852 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004853 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004855#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004856 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004857 /*
4858 * Fetch record contents from underlying transport.
4859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4861 if (ret != 0) {
4862 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4863 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004864 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004865
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004866 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004867 }
4868
4869 /*
4870 * Decrypt record contents.
4871 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004874#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004876 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004878 /* Except when waiting for Finished as a bad mac here
4879 * probably means something went wrong in the handshake
4880 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4882 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004883#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4885 mbedtls_ssl_send_alert_message(ssl,
4886 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4887 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004888 }
4889#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004891 }
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->conf->badmac_limit != 0 &&
4894 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4895 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4896 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004897 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004898
Hanno Becker4a810fb2017-05-24 16:27:30 +01004899 /* As above, invalid records cause
4900 * dismissal of the whole datagram. */
4901
4902 ssl->next_record_offset = 0;
4903 ssl->in_left = 0;
4904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4906 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004907 }
4908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 return ret;
4910 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004911#endif
4912 {
4913 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004914#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4916 mbedtls_ssl_send_alert_message(ssl,
4917 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4918 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004919 }
4920#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004922 }
4923 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004924
Hanno Becker44d89b22019-07-12 09:40:44 +01004925
4926 /* Reset in pointers to default state for TLS/DTLS records,
4927 * assuming no CID and no offset between record content and
4928 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004930#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4931 ssl->in_len = ssl->in_cid + rec.cid_len;
4932#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004933 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004934
Hanno Becker8685c822019-07-12 09:37:30 +01004935 /* The record content type may change during decryption,
4936 * so re-read it. */
4937 ssl->in_msgtype = rec.type;
4938 /* Also update the input buffer, because unfortunately
4939 * the server-side ssl_parse_client_hello() reparses the
4940 * record header when receiving a ClientHello initiating
4941 * a renegotiation. */
4942 ssl->in_hdr[0] = rec.type;
4943 ssl->in_msg = rec.buf + rec.data_offset;
4944 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004948}
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004951{
Janos Follath865b3eb2019-12-16 11:46:15 +00004952 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004953
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004954 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004955 * Handle particular types of records
4956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4958 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4959 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004960 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004961 }
4962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4964 if (ssl->in_msglen != 1) {
4965 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4966 ssl->in_msglen));
4967 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004968 }
4969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (ssl->in_msg[0] != 1) {
4971 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4972 ssl->in_msg[0]));
4973 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004974 }
4975
4976#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004977 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004978 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4980 if (ssl->handshake == NULL) {
4981 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4982 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004983 }
4984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4986 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004987 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004988#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004989
Ronald Cron6f135e12021-12-08 16:57:54 +01004990#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004992#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 MBEDTLS_SSL_DEBUG_MSG(1,
4994 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4995 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004996#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 MBEDTLS_SSL_DEBUG_MSG(1,
4998 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
4999 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005000#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5001 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005002#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005003 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5006 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005007 /* Note: Standard allows for more than one 2 byte alert
5008 to be packed in a single message, but Mbed TLS doesn't
5009 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5011 ssl->in_msglen));
5012 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005013 }
5014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5016 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005017
5018 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005019 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5022 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5023 ssl->in_msg[1]));
5024 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005025 }
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5028 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5029 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5030 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005031 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005032
5033#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5035 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5036 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005037 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005039 }
5040#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005041 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005042 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005043 }
5044
Hanno Beckerc76c6192017-06-06 10:03:17 +01005045#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005047 /* Drop unexpected ApplicationData records,
5048 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5050 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005051#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5053 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005054#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 ) {
5056 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5057 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005058 }
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if (ssl->handshake != NULL &&
5061 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5062 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005063 }
5064 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005065#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005068}
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005071{
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 return mbedtls_ssl_send_alert_message(ssl,
5073 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5074 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005075}
5076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5078 unsigned char level,
5079 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005080{
Janos Follath865b3eb2019-12-16 11:46:15 +00005081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if (ssl == NULL || ssl->conf == NULL) {
5084 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5085 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005086
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 if (ssl->out_left != 0) {
5088 return mbedtls_ssl_flush_output(ssl);
5089 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5092 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005094 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005095 ssl->out_msglen = 2;
5096 ssl->out_msg[0] = level;
5097 ssl->out_msg[1] = message;
5098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5100 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5101 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005102 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005106}
5107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005109{
Janos Follath865b3eb2019-12-16 11:46:15 +00005110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005114 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005115 ssl->out_msglen = 1;
5116 ssl->out_msg[0] = 1;
5117
Paul Bakker5121ce52009-01-03 21:22:43 +00005118 ssl->state++;
5119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5121 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5122 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005123 }
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005128}
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005131{
Janos Follath865b3eb2019-12-16 11:46:15 +00005132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5137 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5138 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005139 }
5140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5142 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5143 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5144 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5145 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005146 }
5147
Hanno Beckere678eaa2018-08-21 14:57:46 +01005148 /* CCS records are only accepted if they have length 1 and content '1',
5149 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005150
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005151 /*
5152 * Switch to our negotiated transform and session parameters for inbound
5153 * data.
5154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005156#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005157 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005158#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005159 ssl->session_in = ssl->session_negotiate;
5160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005161#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005163#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005165#endif
5166
5167 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (++ssl->in_epoch == 0) {
5169 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005170 /* This is highly unlikely to happen for legitimate reasons, so
5171 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005173 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005175#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005179
Paul Bakker5121ce52009-01-03 21:22:43 +00005180 ssl->state++;
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005185}
5186
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005187/* Once ssl->out_hdr as the address of the beginning of the
5188 * next outgoing record is set, deduce the other pointers.
5189 *
5190 * Note: For TLS, we save the implicit record sequence number
5191 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5192 * and the caller has to make sure there's space for this.
5193 */
5194
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005195static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005197{
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005199}
5200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5202 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005203{
5204#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005206 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005207#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005208 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005209 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005211 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005213#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005214 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005215#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005216 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005218#endif
5219 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005220 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005221#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005222 ssl->out_cid = ssl->out_len;
5223#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005224 ssl->out_iv = ssl->out_hdr + 5;
5225 }
5226
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005227 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005228 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 if (transform != NULL) {
5230 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5231 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005232}
5233
5234/* Once ssl->in_hdr as the address of the beginning of the
5235 * next incoming record is set, deduce the other pointers.
5236 *
5237 * Note: For TLS, we save the implicit record sequence number
5238 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5239 * and the caller has to make sure there's space for this.
5240 */
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005243{
Hanno Becker79594fd2019-05-08 09:38:41 +01005244 /* This function sets the pointers to match the case
5245 * of unprotected TLS/DTLS records, with both ssl->in_iv
5246 * and ssl->in_msg pointing to the beginning of the record
5247 * content.
5248 *
5249 * When decrypting a protected record, ssl->in_msg
5250 * will be shifted to point to the beginning of the
5251 * record plaintext.
5252 */
5253
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005254#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005256 /* This sets the header pointers to match records
5257 * without CID. When we receive a record containing
5258 * a CID, the fields are shifted accordingly in
5259 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005260 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005261#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005262 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005263 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005264#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005265 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005266#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005267 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005269#endif
5270 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005271 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005272 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005273#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005274 ssl->in_cid = ssl->in_len;
5275#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005276 ssl->in_iv = ssl->in_hdr + 5;
5277 }
5278
Hanno Becker79594fd2019-05-08 09:38:41 +01005279 /* This will be adjusted at record decryption time. */
5280 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005281}
5282
Paul Bakker5121ce52009-01-03 21:22:43 +00005283/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005284 * Setup an SSL context
5285 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005288{
5289 /* Set the incoming and outgoing record pointers. */
5290#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005292 ssl->out_hdr = ssl->out_buf;
5293 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005295#endif /* MBEDTLS_SSL_PROTO_DTLS */
5296 {
Hanno Becker12078f42021-03-02 15:28:41 +00005297 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005298 ssl->out_hdr = ssl->out_buf + 8;
5299 ssl->in_hdr = ssl->in_buf + 8;
5300 }
5301
5302 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5304 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005305}
5306
Paul Bakker5121ce52009-01-03 21:22:43 +00005307/*
5308 * SSL get accessors
5309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005311{
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005313}
5314
Gilles Peskine449bd832023-01-11 14:50:10 +01005315int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005316{
5317 /*
5318 * Case A: We're currently holding back
5319 * a message for further processing.
5320 */
5321
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if (ssl->keep_current_message == 1) {
5323 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5324 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005325 }
5326
5327 /*
5328 * Case B: Further records are pending in the current datagram.
5329 */
5330
5331#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5333 ssl->in_left > ssl->next_record_offset) {
5334 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5335 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005336 }
5337#endif /* MBEDTLS_SSL_PROTO_DTLS */
5338
5339 /*
5340 * Case C: A handshake message is being processed.
5341 */
5342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5344 MBEDTLS_SSL_DEBUG_MSG(3,
5345 ("ssl_check_pending: more handshake messages within current record"));
5346 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005347 }
5348
5349 /*
5350 * Case D: An application data message is being processed
5351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 if (ssl->in_offt != NULL) {
5353 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5354 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005355 }
5356
5357 /*
5358 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005359 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005360 * we implement support for multiple alerts in single records.
5361 */
5362
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5364 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005365}
5366
Paul Bakker43ca69c2011-01-15 17:35:19 +00005367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005369{
Hanno Becker3136ede2018-08-17 15:28:19 +01005370 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005372 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005373#if defined(MBEDTLS_USE_PSA_CRYPTO)
5374 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5375 psa_key_type_t key_type;
5376#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005377
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005379
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (transform == NULL) {
5381 return (int) out_hdr_len;
5382 }
Hanno Becker78640902018-08-13 16:35:15 +01005383
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005384
5385#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if (transform->psa_alg == PSA_ALG_GCM ||
5387 transform->psa_alg == PSA_ALG_CCM ||
5388 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5389 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5390 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005391 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5393 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5394 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005395
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005397
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005398 /* Expansion due to the addition of the MAC. */
5399 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005400
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005401 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005402 * Theoretically up to 256 bytes, but we never use
5403 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005404 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005405
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005406 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005407 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005408#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005409 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005410#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 } else {
5412 MBEDTLS_SSL_DEBUG_MSG(1,
5413 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5414 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005415 }
5416#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005418 case MBEDTLS_MODE_GCM:
5419 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005420 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005421 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005422 transform_expansion = transform->minlen;
5423 break;
5424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005426
5427 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005429
Hanno Becker3136ede2018-08-17 15:28:19 +01005430 /* Expansion due to the addition of the MAC. */
5431 transform_expansion += transform->maclen;
5432
5433 /* Expansion due to the addition of CBC padding;
5434 * Theoretically up to 256 bytes, but we never use
5435 * more than the block size of the underlying cipher. */
5436 transform_expansion += block_size;
5437
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005438 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005439 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005440#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005441 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005443
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005444 break;
5445
5446 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5448 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005449 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005450#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005451
Hanno Beckera0e20d02019-05-15 14:03:01 +01005452#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005454 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005456#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005457
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005459}
5460
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005461#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005462/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005463 * Check record counters and renegotiate if they're above the limit.
5464 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005465MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005466static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005467{
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005469 int in_ctr_cmp;
5470 int out_ctr_cmp;
5471
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5475 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005476 }
5477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5479 &ssl->conf->renego_period[ep_len],
5480 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5481 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005482 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005484
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5486 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005487 }
5488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5490 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005491}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005493
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005494#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5495
5496#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005497MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005498static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005499{
5500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5502 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5503 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005504 }
5505
5506 ssl->keep_current_message = 1;
5507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5509 mbedtls_ssl_handshake_set_state(ssl,
5510 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005513}
5514#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5515
Jerry Yua0446a02022-07-13 11:22:55 +08005516MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005517static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005518{
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005521
5522#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5524 int ret = ssl_tls13_check_new_session_ticket(ssl);
5525 if (ret != 0) {
5526 return ret;
5527 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005528 }
5529#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5530
5531 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005533}
5534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5535
5536#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005537/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005538 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005539 * may only be sent for the purpose of initiating renegotiations.
5540 *
5541 * This function is introduced as a separate helper since the handling
5542 * of post-handshake handshake messages changes significantly in TLS 1.3,
5543 * and having a helper function allows to distinguish between TLS <= 1.2 and
5544 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5545 */
Jerry Yua0446a02022-07-13 11:22:55 +08005546MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005547static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005548{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005550
5551 /*
5552 * - For client-side, expect SERVER_HELLO_REQUEST.
5553 * - For server-side, expect CLIENT_HELLO.
5554 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5555 */
5556
5557#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5559 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5560 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5561 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005562
5563 /* With DTLS, drop the packet (probably from last handshake) */
5564#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5566 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005567 }
5568#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005570 }
5571#endif /* MBEDTLS_SSL_CLI_C */
5572
5573#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5575 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5576 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005577
5578 /* With DTLS, drop the packet (probably from last handshake) */
5579#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5581 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005582 }
5583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005585 }
5586#endif /* MBEDTLS_SSL_SRV_C */
5587
5588#if defined(MBEDTLS_SSL_RENEGOTIATION)
5589 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5591 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5592 ssl->conf->allow_legacy_renegotiation ==
5593 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005594 /*
5595 * Accept renegotiation request
5596 */
5597
5598 /* DTLS clients need to know renego is server-initiated */
5599#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5601 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005602 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5603 }
5604#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 ret = mbedtls_ssl_start_renegotiation(ssl);
5606 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5607 ret != 0) {
5608 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5609 ret);
5610 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005611 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005613#endif /* MBEDTLS_SSL_RENEGOTIATION */
5614 {
5615 /*
5616 * Refuse renegotiation
5617 */
5618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005620
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5622 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5623 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5624 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005625 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005626 }
5627
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005629}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005630#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5631
5632MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005633static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005634{
5635 /* Check protocol version and dispatch accordingly. */
5636#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5638 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005639 }
5640#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5641
5642#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5644 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005645 }
5646#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5647
5648 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005650}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005651
Paul Bakker48916f92012-09-16 19:57:18 +00005652/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005653 * Receive application data decrypted from the SSL layer
5654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005655int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005656{
Janos Follath865b3eb2019-12-16 11:46:15 +00005657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005658 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005659
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 if (ssl == NULL || ssl->conf == NULL) {
5661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5662 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005663
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5668 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5669 return ret;
5670 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005671
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 if (ssl->handshake != NULL &&
5673 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5674 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5675 return ret;
5676 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005677 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005678 }
5679#endif
5680
Hanno Becker4a810fb2017-05-24 16:27:30 +01005681 /*
5682 * Check if renegotiation is necessary and/or handshake is
5683 * in process. If yes, perform/continue, and fall through
5684 * if an unexpected packet is received while the client
5685 * is waiting for the ServerHello.
5686 *
5687 * (There is no equivalent to the last condition on
5688 * the server-side as it is not treated as within
5689 * a handshake while waiting for the ClientHello
5690 * after a renegotiation request.)
5691 */
5692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005693#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 ret = ssl_check_ctr_renegotiate(ssl);
5695 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5696 ret != 0) {
5697 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5698 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005699 }
5700#endif
5701
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5703 ret = mbedtls_ssl_handshake(ssl);
5704 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5705 ret != 0) {
5706 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5707 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005708 }
5709 }
5710
Hanno Beckere41158b2017-10-23 13:30:32 +01005711 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005713 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (ssl->f_get_timer != NULL &&
5715 ssl->f_get_timer(ssl->p_timer) == -1) {
5716 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005717 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005718
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5720 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5721 return 0;
5722 }
Paul Bakker831a7552011-05-18 13:32:51 +00005723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5725 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005726 }
5727
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (ssl->in_msglen == 0 &&
5729 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005730 /*
5731 * OpenSSL sends empty messages to randomize the IV
5732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5734 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5735 return 0;
5736 }
Paul Bakker831a7552011-05-18 13:32:51 +00005737
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5739 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005740 }
5741 }
5742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5744 ret = ssl_handle_hs_message_post_handshake(ssl);
5745 if (ret != 0) {
5746 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5747 ret);
5748 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005749 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005750
Hanno Beckerf26cc722021-04-21 07:30:13 +01005751 /* At this point, we don't know whether the renegotiation triggered
5752 * by the post-handshake message has been completed or not. The cases
5753 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005754 * 1) The renegotiation is complete. In this case, no new record
5755 * has been read yet.
5756 * 2) The renegotiation is incomplete because the client received
5757 * an application data record while awaiting the ServerHello.
5758 * 3) The renegotiation is incomplete because the client received
5759 * a non-handshake, non-application data message while awaiting
5760 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005761 *
5762 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005763 * - For 1), the next iteration will read a new record and check
5764 * if it's application data.
5765 * - For 2), the loop condition isn't satisfied as application data
5766 * is present, hence continue is the same as break
5767 * - For 3), the loop condition is satisfied and read_record
5768 * will re-deliver the message that was held back by the client
5769 * when expecting the ServerHello.
5770 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005771
Hanno Becker90333da2017-10-10 11:27:13 +01005772 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005773 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005774#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5776 if (ssl->conf->renego_max_records >= 0) {
5777 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5778 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5779 "but not honored by client"));
5780 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005781 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005782 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005783 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5788 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5789 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005790 }
5791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5794 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005795 }
5796
5797 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005798
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005799 /* We're going to return something now, cancel timer,
5800 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5802 mbedtls_ssl_set_timer(ssl, 0);
5803 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005804
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005805#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005806 /* If we requested renego but received AppData, resend HelloRequest.
5807 * Do it now, after setting in_offt, to avoid taking this branch
5808 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5811 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5812 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5814 ret);
5815 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005816 }
5817 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005819#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005820 }
5821
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005823 ? len : ssl->in_msglen;
5824
ashesman937d6d52022-02-17 11:08:27 +13005825 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005826 memcpy(buf, ssl->in_offt, n);
5827 ssl->in_msglen -= n;
5828 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005829
gabor-mezei-arma3214132020-07-15 10:55:00 +02005830 /* Zeroising the plaintext buffer to erase unused application data
5831 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005835 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005836 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005837 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005839 /* more data available */
5840 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005841 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005846}
5847
5848/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005849 * Send application data to be encrypted by the SSL layer, taking care of max
5850 * fragment length and buffer size.
5851 *
5852 * According to RFC 5246 Section 6.2.1:
5853 *
5854 * Zero-length fragments of Application data MAY be sent as they are
5855 * potentially useful as a traffic analysis countermeasure.
5856 *
5857 * Therefore, it is possible that the input message length is 0 and the
5858 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005859 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005860MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005861static int ssl_write_real(mbedtls_ssl_context *ssl,
5862 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005863{
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005865 const size_t max_len = (size_t) ret;
5866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (ret < 0) {
5868 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5869 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005870 }
5871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005873#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5875 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5876 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5877 " > %" MBEDTLS_PRINTF_SIZET,
5878 len, max_len));
5879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5880 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005881#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005883 }
Paul Bakker887bd502011-06-08 13:10:54 +00005884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005886 /*
5887 * The user has previously tried to send the data and
5888 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5889 * written. In this case, we expect the high-level write function
5890 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5891 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5893 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5894 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005895 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005897 /*
5898 * The user is trying to send a message the first time, so we need to
5899 * copy the data into the internal buffers and setup the data structure
5900 * to keep track of partial writes
5901 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005902 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005903 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005904 if (len > 0) {
5905 memcpy(ssl->out_msg, buf, len);
5906 }
Paul Bakker887bd502011-06-08 13:10:54 +00005907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5909 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5910 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005911 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005912 }
5913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005915}
5916
5917/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005918 * Write application data (public-facing wrapper)
5919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005920int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005921{
Janos Follath865b3eb2019-12-16 11:46:15 +00005922 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005923
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (ssl == NULL || ssl->conf == NULL) {
5927 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5928 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005929
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005930#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5932 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5933 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005934 }
5935#endif
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5938 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5939 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5940 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005941 }
5942 }
5943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005945
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005949}
5950
5951/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005952 * Notify the peer that the connection is being closed
5953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005954int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005955{
Janos Follath865b3eb2019-12-16 11:46:15 +00005956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 if (ssl == NULL || ssl->conf == NULL) {
5959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5960 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5965 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5966 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5967 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5969 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005970 }
5971 }
5972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005976}
5977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005979{
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005981 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005983
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005984#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 psa_destroy_key(transform->psa_key_enc);
5986 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005987#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 mbedtls_cipher_free(&transform->cipher_ctx_enc);
5989 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005990#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005991
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005992#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005993#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 psa_destroy_key(transform->psa_mac_enc);
5995 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005996#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 mbedtls_md_free(&transform->md_ctx_enc);
5998 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006000#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006003}
6004
Gilles Peskine449bd832023-01-11 14:50:10 +01006005void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6006 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006007{
Jerry Yuc7875b52021-09-05 21:05:50 +08006008 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006010}
6011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6013 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006014{
6015 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006017}
6018
Hanno Becker0271f962018-08-16 13:23:47 +01006019#if defined(MBEDTLS_SSL_PROTO_DTLS)
6020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006022{
6023 unsigned offset;
6024 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006027 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 }
Hanno Becker0271f962018-08-16 13:23:47 +01006029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6033 ssl_buffering_free_slot(ssl, offset);
6034 }
Hanno Beckere605b192018-08-21 15:59:07 +01006035}
6036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6038 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006039{
6040 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6041 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006044 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006046
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006048 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006049 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006051 }
6052}
6053
6054#endif /* MBEDTLS_SSL_PROTO_DTLS */
6055
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006056/*
6057 * Convert version numbers to/from wire format
6058 * and, for DTLS, to/from TLS equivalent.
6059 *
6060 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006061 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006062 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006063 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006065void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6066 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006067{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006068 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006071 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006073 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006074#else
6075 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006076#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006077 {
6078 tls_version_formatted = (uint16_t) tls_version;
6079 }
6080 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006081}
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6084 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006085{
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006089 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6091 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006092#else
6093 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006094#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006095 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006096}
6097
Jerry Yue7047812021-09-13 19:26:39 +08006098/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006099 * Send pending fatal alert.
6100 * 0, No alert message.
6101 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6102 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006103 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006104int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006105{
6106 int ret;
6107
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006108 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (ssl->send_alert == 0) {
6110 return 0;
6111 }
Jerry Yu394ece62021-09-14 22:17:21 +08006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 ret = mbedtls_ssl_send_alert_message(ssl,
6114 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6115 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006116
Jerry Yu3bf1f972021-09-22 21:37:18 +08006117 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6118 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006121 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006122 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (ret != 0) {
6125 return ret;
6126 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006127
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006129}
6130
Jerry Yu394ece62021-09-14 22:17:21 +08006131/*
6132 * Set pending fatal alert flag.
6133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006134void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6135 unsigned char alert_type,
6136 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006137{
6138 ssl->send_alert = 1;
6139 ssl->alert_type = alert_type;
6140 ssl->alert_reason = alert_reason;
6141}
6142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006143#endif /* MBEDTLS_SSL_TLS_C */