blob: 58063c7f1122f1befda3921ae91d1ff0cc7eb5c7 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00007 */
8/*
Paul Bakker5121ce52009-01-03 21:22:43 +00009 * http://www.ietf.org/rfc/rfc2246.txt
10 * http://www.ietf.org/rfc/rfc4346.txt
11 */
12
Gilles Peskinedb09ef62020-06-03 01:43:33 +020013#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020015#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000016
SimonBd5800b72016-04-26 07:43:27 +010017#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010018
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000019#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000020#include "ssl_misc.h"
Valerio Settib4f50762024-01-17 10:24:52 +010021#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000022#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050023#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010024#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020025#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020031#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050032#include "psa/crypto.h"
33#endif
34
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define a local translating function to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049#endif
50
Dave Rodgman2801f7f2023-05-09 11:00:07 +010051#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
52
53#if defined(MBEDTLS_USE_PSA_CRYPTO)
54
55#if defined(PSA_WANT_ALG_SHA_384)
56#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
57#elif defined(PSA_WANT_ALG_SHA_256)
58#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
59#else /* See check_config.h */
60#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
61#endif
62
63MBEDTLS_STATIC_TESTABLE
64int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
65 psa_algorithm_t mac_alg,
66 const unsigned char *add_data,
67 size_t add_data_len,
68 const unsigned char *data,
69 size_t data_len_secret,
70 size_t min_data_len,
71 size_t max_data_len,
72 unsigned char *output)
73{
74 /*
75 * This function breaks the HMAC abstraction and uses psa_hash_clone()
76 * extension in order to get constant-flow behaviour.
77 *
78 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
79 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
80 * patterns (see RFC 2104, sec. 2).
81 *
82 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
83 * hashing up to minlen, then cloning the context, and for each byte up
84 * to maxlen finishing up the hash computation, keeping only the
85 * correct result.
86 *
87 * Then we only need to compute HASH(okey + inner_hash) and we're done.
88 */
89 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
90 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
91 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
92 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
93 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
94 size_t hash_length;
95
96 unsigned char aux_out[PSA_HASH_MAX_SIZE];
97 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
98 size_t offset;
99 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
100
101 size_t mac_key_length;
102 size_t i;
103
104#define PSA_CHK(func_call) \
105 do { \
106 status = (func_call); \
107 if (status != PSA_SUCCESS) \
108 goto cleanup; \
109 } while (0)
110
111 /* Export MAC key
112 * We assume key length is always exactly the output size
113 * which is never more than the block size, thus we use block_size
114 * as the key buffer size.
115 */
116 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
117
118 /* Calculate ikey */
119 for (i = 0; i < mac_key_length; i++) {
120 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
121 }
122 for (; i < block_size; ++i) {
123 key_buf[i] = 0x36;
124 }
125
126 PSA_CHK(psa_hash_setup(&operation, hash_alg));
127
128 /* Now compute inner_hash = HASH(ikey + msg) */
129 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
130 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
131 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
132
133 /* Fill the hash buffer in advance with something that is
134 * not a valid hash (barring an attack on the hash and
135 * deliberately-crafted input), in case the caller doesn't
136 * check the return status properly. */
137 memset(output, '!', hash_size);
138
139 /* For each possible length, compute the hash up to that point */
140 for (offset = min_data_len; offset <= max_data_len; offset++) {
141 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
142 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
143 PSA_HASH_MAX_SIZE, &hash_length));
144 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100145 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100146 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100147
148 if (offset < max_data_len) {
149 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
150 }
151 }
152
153 /* Abort current operation to prepare for final operation */
154 PSA_CHK(psa_hash_abort(&operation));
155
156 /* Calculate okey */
157 for (i = 0; i < mac_key_length; i++) {
158 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
159 }
160 for (; i < block_size; ++i) {
161 key_buf[i] = 0x5C;
162 }
163
164 /* Now compute HASH(okey + inner_hash) */
165 PSA_CHK(psa_hash_setup(&operation, hash_alg));
166 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
167 PSA_CHK(psa_hash_update(&operation, output, hash_size));
168 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
169
170#undef PSA_CHK
171
172cleanup:
173 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
174 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
175
176 psa_hash_abort(&operation);
177 psa_hash_abort(&aux_operation);
178 return PSA_TO_MBEDTLS_ERR(status);
179}
180
181#undef MAX_HASH_BLOCK_LENGTH
182
183#else
184MBEDTLS_STATIC_TESTABLE
185int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
186 const unsigned char *add_data,
187 size_t add_data_len,
188 const unsigned char *data,
189 size_t data_len_secret,
190 size_t min_data_len,
191 size_t max_data_len,
192 unsigned char *output)
193{
194 /*
195 * This function breaks the HMAC abstraction and uses the md_clone()
196 * extension to the MD API in order to get constant-flow behaviour.
197 *
198 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
199 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
200 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
201 *
202 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
203 * minlen, then cloning the context, and for each byte up to maxlen
204 * finishing up the hash computation, keeping only the correct result.
205 *
206 * Then we only need to compute HASH(okey + inner_hash) and we're done.
207 */
208 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
209 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
210 * all of which have the same block size except SHA-384. */
211 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
212 const unsigned char * const ikey = ctx->hmac_ctx;
213 const unsigned char * const okey = ikey + block_size;
214 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
215
216 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
217 mbedtls_md_context_t aux;
218 size_t offset;
219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
220
221 mbedtls_md_init(&aux);
222
223#define MD_CHK(func_call) \
224 do { \
225 ret = (func_call); \
226 if (ret != 0) \
227 goto cleanup; \
228 } while (0)
229
230 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
231
232 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
233 * so we can start directly with the message */
234 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
235 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
236
237 /* Fill the hash buffer in advance with something that is
238 * not a valid hash (barring an attack on the hash and
239 * deliberately-crafted input), in case the caller doesn't
240 * check the return status properly. */
241 memset(output, '!', hash_size);
242
243 /* For each possible length, compute the hash up to that point */
244 for (offset = min_data_len; offset <= max_data_len; offset++) {
245 MD_CHK(mbedtls_md_clone(&aux, ctx));
246 MD_CHK(mbedtls_md_finish(&aux, aux_out));
247 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100248 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100249 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100250
251 if (offset < max_data_len) {
252 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
253 }
254 }
255
256 /* The context needs to finish() before it starts() again */
257 MD_CHK(mbedtls_md_finish(ctx, aux_out));
258
259 /* Now compute HASH(okey + inner_hash) */
260 MD_CHK(mbedtls_md_starts(ctx));
261 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
262 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
263 MD_CHK(mbedtls_md_finish(ctx, output));
264
265 /* Done, get ready for next time */
266 MD_CHK(mbedtls_md_hmac_reset(ctx));
267
268#undef MD_CHK
269
270cleanup:
271 mbedtls_md_free(&aux);
272 return ret;
273}
274
275#endif /* MBEDTLS_USE_PSA_CRYPTO */
276
277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
278
Gilles Peskine449bd832023-01-11 14:50:10 +0100279static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100280
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200281/*
282 * Start a timer.
283 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200284 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100285void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200286{
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200288 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
292 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293}
294
295/*
296 * Return -1 is timer is expired, 0 if it isn't.
297 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200299{
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (ssl->f_get_timer == NULL) {
301 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200302 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 if (ssl->f_get_timer(ssl->p_timer) == 2) {
305 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
306 return -1;
307 }
308
309 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200310}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100313static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
314 unsigned char *buf,
315 size_t len,
316 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200317
Gilles Peskine449bd832023-01-11 14:50:10 +0100318int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
319 unsigned char *buf,
320 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200321{
322 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
324 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200325
326 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200327 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200328 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200330 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
331 goto exit;
332 }
333#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200335 mbedtls_record rec;
336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
338 if (ret != 0) {
339 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 goto exit;
341 }
342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 if (ssl->transform_in != NULL) {
344 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
345 if (ret != 0) {
346 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 goto exit;
348 }
349 }
350 }
351#endif /* MBEDTLS_SSL_PROTO_DTLS */
352
353exit:
354 /* On success, we have decrypted the buffer in-place, so make
355 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200357
358 /* For the purpose of this API, treat messages with unexpected CID
359 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
361 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200362 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
363 }
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
366 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200367}
368
Hanno Becker67bc7c32018-08-06 11:33:50 +0100369#define SSL_DONT_FORCE_FLUSH 0
370#define SSL_FORCE_FLUSH 1
371
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100373
Hanno Beckerd5847772018-08-28 10:09:23 +0100374/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100375static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
376 uint8_t slot);
377static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200378MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100379static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100381static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200382MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100383static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100385static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
386 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100388static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100391{
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000393#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
394 size_t out_buf_len = ssl->out_buf_len;
395#else
396 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
397#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (mtu != 0 && mtu < out_buf_len) {
400 return mtu;
401 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100402
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100404}
405
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100407static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100408{
Hanno Becker11682cc2018-08-22 14:41:02 +0100409 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100411
412 /* Double-check that the write-index hasn't gone
413 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100415 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100417 }
418
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420}
421
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100423static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100424{
Janos Follath865b3eb2019-12-16 11:46:15 +0000425 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100426 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400427 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100428
429#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100431
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100433 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100435
436 /* By the standard (RFC 6066 Sect. 4), the MFL extension
437 * only limits the maximum record payload size, so in theory
438 * we would be allowed to pack multiple records of payload size
439 * MFL into a single datagram. However, this would mean that there's
440 * no way to explicitly communicate MTU restrictions to the peer.
441 *
442 * The following reduction of max_len makes sure that we never
443 * write datagrams larger than MFL + Record Expansion Overhead.
444 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (max_len <= ssl->out_left) {
446 return 0;
447 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100448
449 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100450#endif
451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 ret = ssl_get_remaining_space_in_datagram(ssl);
453 if (ret < 0) {
454 return ret;
455 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100456 remaining = (size_t) ret;
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 ret = mbedtls_ssl_get_record_expansion(ssl);
459 if (ret < 0) {
460 return ret;
461 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462 expansion = (size_t) ret;
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 if (remaining <= expansion) {
465 return 0;
466 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100467
468 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100470 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474}
475
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200476/*
477 * Double the retransmit timeout value, within the allowed range,
478 * returning -1 if the maximum value has already been reached.
479 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100481static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200482{
483 uint32_t new_timeout;
484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
486 return -1;
487 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200489 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
490 * in the following way: after the initial transmission and a first
491 * retransmission, back off to a temporary estimated MTU of 508 bytes.
492 * This value is guaranteed to be deliverable (if not guaranteed to be
493 * delivered) of any compliant IPv4 (and IPv6) network, and should work
494 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200496 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400498 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200499
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500 new_timeout = 2 * ssl->handshake->retransmit_timeout;
501
502 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (new_timeout < ssl->handshake->retransmit_timeout ||
504 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200505 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200506 }
507
508 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
510 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200513}
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200516{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
519 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200520}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200522
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100523/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000524 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200525 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000526
Ronald Cron6f135e12021-12-08 16:57:54 +0100527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100528
Gilles Peskine449bd832023-01-11 14:50:10 +0100529static size_t ssl_compute_padding_length(size_t len,
530 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100531{
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100533}
534
Hanno Becker581bc1b2020-05-04 12:20:03 +0100535/* This functions transforms a (D)TLS plaintext fragment and a record content
536 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
537 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
538 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100539 *
540 * struct {
541 * opaque content[DTLSPlaintext.length];
542 * ContentType real_type;
543 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100544 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100545 *
546 * Input:
547 * - `content`: The beginning of the buffer holding the
548 * plaintext to be wrapped.
549 * - `*content_size`: The length of the plaintext in Bytes.
550 * - `max_len`: The number of Bytes available starting from
551 * `content`. This must be `>= *content_size`.
552 * - `rec_type`: The desired record content type.
553 *
554 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100555 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
556 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Returns:
559 * - `0` on success.
560 * - A negative error code if `max_len` didn't offer enough space
561 * for the expansion.
562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100564static int ssl_build_inner_plaintext(unsigned char *content,
565 size_t *content_size,
566 size_t remaining,
567 uint8_t rec_type,
568 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569{
570 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100571
572 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (remaining == 0) {
574 return -1;
575 }
576 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100577 len++;
578 remaining--;
579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if (remaining < pad) {
581 return -1;
582 }
583 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100584 len += pad;
585 remaining -= pad;
586
587 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589}
590
Hanno Becker581bc1b2020-05-04 12:20:03 +0100591/* This function parses a (D)TLSInnerPlaintext structure.
592 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200593MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100594static int ssl_parse_inner_plaintext(unsigned char const *content,
595 size_t *content_size,
596 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100597{
598 size_t remaining = *content_size;
599
600 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 do {
602 if (remaining == 0) {
603 return -1;
604 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100605 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100607
608 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100610
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100612}
Ronald Cron6f135e12021-12-08 16:57:54 +0100613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200615/* The size of the `add_data` structure depends on various
616 * factors, namely
617 *
618 * 1) CID functionality disabled
619 *
620 * additional_data =
621 * 8: seq_num +
622 * 1: type +
623 * 2: version +
624 * 2: length of inner plaintext +
625 *
626 * size = 13 bytes
627 *
628 * 2) CID functionality based on RFC 9146 enabled
629 *
630 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
631 * = 23 + CID-length
632 *
633 * 3) CID functionality based on legacy CID version
634 according to draft-ietf-tls-dtls-connection-id-05
635 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
636 *
637 * size = 13 + 1 + CID-length
638 *
639 * More information about the CID usage:
640 *
641 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
642 * size of the additional data structure is calculated as:
643 *
644 * additional_data =
645 * 8: seq_num +
646 * 1: tls12_cid +
647 * 2: DTLSCipherText.version +
648 * n: cid +
649 * 1: cid_length +
650 * 2: length_of_DTLSInnerPlaintext
651 *
652 * Per RFC 9146 the size of the add_data structure is calculated as:
653 *
654 * additional_data =
655 * 8: seq_num_placeholder +
656 * 1: tls12_cid +
657 * 1: cid_length +
658 * 1: tls12_cid +
659 * 2: DTLSCiphertext.version +
660 * 2: epoch +
661 * 6: sequence_number +
662 * n: cid +
663 * 2: length_of_DTLSInnerPlaintext
664 *
665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666static void ssl_extract_add_data_from_record(unsigned char *add_data,
667 size_t *add_data_len,
668 mbedtls_record *rec,
669 mbedtls_ssl_protocol_version
670 tls_version,
671 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000672{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200673 /* Several types of ciphers have been defined for use with TLS and DTLS,
674 * and the MAC calculations for those ciphers differ slightly. Further
675 * variants were added when the CID functionality was added with RFC 9146.
676 * This implementations also considers the use of a legacy version of the
677 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
678 * which is used in deployments.
679 *
680 * We will distinguish between the non-CID and the CID cases below.
681 *
682 * --- Non-CID cases ---
683 *
684 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100685 *
686 * additional_data = seq_num + TLSCompressed.type +
687 * TLSCompressed.version + TLSCompressed.length;
688 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100689 * For TLS 1.3, the record sequence number is dropped from the AAD
690 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000691 * Moreover, the additional data involves the length of the TLS
692 * ciphertext, not the TLS plaintext as in earlier versions.
693 * Quoting RFC 8446 (TLS 1.3):
694 *
695 * additional_data = TLSCiphertext.opaque_type ||
696 * TLSCiphertext.legacy_record_version ||
697 * TLSCiphertext.length
698 *
699 * We pass the tag length to this function in order to compute the
700 * ciphertext length from the inner plaintext length rec->data_len via
701 *
702 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
703 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200704 * --- CID cases ---
705 *
706 * RFC 9146 uses a common pattern when constructing the data
707 * passed into a MAC / AEAD cipher.
708 *
709 * Data concatenation for MACs used with block ciphers with
710 * Encrypt-then-MAC Processing (with CID):
711 *
712 * data = seq_num_placeholder +
713 * tls12_cid +
714 * cid_length +
715 * tls12_cid +
716 * DTLSCiphertext.version +
717 * epoch +
718 * sequence_number +
719 * cid +
720 * DTLSCiphertext.length +
721 * IV +
722 * ENC(content + padding + padding_length)
723 *
724 * Data concatenation for MACs used with block ciphers (with CID):
725 *
726 * data = seq_num_placeholder +
727 * tls12_cid +
728 * cid_length +
729 * tls12_cid +
730 * DTLSCiphertext.version +
731 * epoch +
732 * sequence_number +
733 * cid +
734 * length_of_DTLSInnerPlaintext +
735 * DTLSInnerPlaintext.content +
736 * DTLSInnerPlaintext.real_type +
737 * DTLSInnerPlaintext.zeros
738 *
739 * AEAD ciphers use the following additional data calculation (with CIDs):
740 *
741 * additional_data = seq_num_placeholder +
742 * tls12_cid +
743 * cid_length +
744 * tls12_cid +
745 * DTLSCiphertext.version +
746 * epoch +
747 * sequence_number +
748 * cid +
749 * length_of_DTLSInnerPlaintext
750 *
751 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
752 * defines the additional data calculation as follows:
753 *
754 * additional_data = seq_num +
755 * tls12_cid +
756 * DTLSCipherText.version +
757 * cid +
758 * cid_length +
759 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100761
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100762 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000763 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100764
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200765#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
766 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
767 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
768#endif
769
Ronald Cron6f135e12021-12-08 16:57:54 +0100770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000772 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
773 * which differs from the length of the TLSInnerPlaintext
774 * by the length of the authentication tag. */
775 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100778 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400779 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000780 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200781
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100782#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
784 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200785 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
787 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200788
789 // tls12_cid type
790 *cur = rec->type;
791 cur++;
792
793 // cid_length
794 *cur = rec->cid_len;
795 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200798 {
799 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 memcpy(cur, rec->ctr, sizeof(rec->ctr));
801 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200802 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100803 }
804
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200805 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100806 *cur = rec->type;
807 cur++;
808
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200809 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 memcpy(cur, rec->ver, sizeof(rec->ver));
811 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100812
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200813#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
814 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // CID
818 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100819 cur += rec->cid_len;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100822 *cur = rec->cid_len;
823 cur++;
824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825 // length of inner plaintext
826 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
827 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
830 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // epoch + sequence number
834 memcpy(cur, rec->ctr, sizeof(rec->ctr));
835 cur += sizeof(rec->ctr);
836
837 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200839 cur += rec->cid_len;
840
841 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100843 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100845#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100846 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100848 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100849 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100850
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000851 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852}
853
Valerio Settie5707042023-10-11 11:54:42 +0200854#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200855MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100856static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100858{
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100860}
861
Hanno Becker17263802020-05-28 07:05:48 +0100862/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
863 *
864 * Concretely, this occurs in two variants:
865 *
866 * a) Fixed and dynamic IV lengths add up to total IV length, giving
867 * IV = fixed_iv || dynamic_iv
868 *
Hanno Becker15952812020-06-04 13:31:46 +0100869 * This variant is used in TLS 1.2 when used with GCM or CCM.
870 *
Hanno Becker17263802020-05-28 07:05:48 +0100871 * b) Fixed IV lengths matches total IV length, giving
872 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100873 *
874 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
875 *
876 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100877 *
878 * This function has the precondition that
879 *
880 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
881 *
882 * which has to be ensured by the caller. If this precondition
883 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100884 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100885static void ssl_build_record_nonce(unsigned char *dst_iv,
886 size_t dst_iv_len,
887 unsigned char const *fixed_iv,
888 size_t fixed_iv_len,
889 unsigned char const *dynamic_iv,
890 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100891{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100892 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 memset(dst_iv, 0, dst_iv_len);
894 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100895
Hanno Becker17263802020-05-28 07:05:48 +0100896 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100898}
Valerio Settie5707042023-10-11 11:54:42 +0200899#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
902 mbedtls_ssl_transform *transform,
903 mbedtls_record *rec,
904 int (*f_rng)(void *, unsigned char *, size_t),
905 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000906{
Neil Armstrong136f8402022-03-30 10:58:01 +0200907 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100908 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200910 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 * the description of ssl_extract_add_data_from_record().
912 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200913#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
914 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
915#else
916 unsigned char add_data[13];
917#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100918 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 size_t post_avail;
920
921 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000922#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200923 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000924 ((void) ssl);
925#endif
926
927 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200928 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100929#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
930 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000931 ((void) f_rng);
932 ((void) p_rng);
933#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000936
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (transform == NULL) {
938 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
939 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000940 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100942 || rec->buf == NULL
943 || rec->buf_len < rec->data_offset
944 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100945#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100946 || rec->cid_len != 0
947#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 ) {
949 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
950 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100951 }
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200954
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000955 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
957 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
958 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
961 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
962 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
963 rec->data_len,
964 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000966 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100967
Hanno Becker92313402020-05-20 13:58:58 +0100968 /* The following two code paths implement the (D)TLSInnerPlaintext
969 * structure present in TLS 1.3 and DTLS 1.2 + CID.
970 *
971 * See ssl_build_inner_plaintext() for more information.
972 *
973 * Note that this changes `rec->data_len`, and hence
974 * `post_avail` needs to be recalculated afterwards.
975 *
976 * Note also that the two code paths cannot occur simultaneously
977 * since they apply to different versions of the protocol. There
978 * is hence no risk of double-addition of the inner plaintext.
979 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100980#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100982 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 ssl_compute_padding_length(rec->data_len,
984 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
985 if (ssl_build_inner_plaintext(data,
986 &rec->data_len,
987 post_avail,
988 rec->type,
989 padding) != 0) {
990 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100991 }
992
993 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
994 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100995#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100996
Hanno Beckera0e20d02019-05-15 14:03:01 +0100997#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100998 /*
999 * Add CID information
1000 */
1001 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1003 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001006 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl_compute_padding_length(rec->data_len,
1008 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001009 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001010 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001011 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001012 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001013 * Note that this changes `rec->data_len`, and hence
1014 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 if (ssl_build_inner_plaintext(data,
1017 &rec->data_len,
1018 post_avail,
1019 rec->type,
1020 padding) != 0) {
1021 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001022 }
1023
1024 rec->type = MBEDTLS_SSL_MSG_CID;
1025 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001026#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001029
Paul Bakker5121ce52009-01-03 21:22:43 +00001030 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001031 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001032 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001033#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1035 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1036 if (post_avail < transform->maclen) {
1037 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1038 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001039 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001041 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001042 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001043#if defined(MBEDTLS_USE_PSA_CRYPTO)
1044 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1046 size_t sign_mac_length = 0;
1047#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1050 transform->tls_version,
1051 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001052
Neil Armstrong26e6d672022-02-23 09:30:33 +01001053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1055 transform->psa_mac_alg);
1056 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001057 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 status = psa_mac_update(&operation, add_data, add_data_len);
1061 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001062 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 status = psa_mac_update(&operation, data, rec->data_len);
1066 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1071 &sign_mac_length);
1072 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001073 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001075#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1077 add_data_len);
1078 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001079 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 }
1081 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1082 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001083 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 }
1085 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1086 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
1089 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1090 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001091 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001094
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001096#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1099 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001100
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001101 rec->data_len += transform->maclen;
1102 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001103 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105hmac_failed_etm_disabled:
1106 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001108 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 status = psa_mac_abort(&operation);
1110 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001111 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001113#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 if (ret != 0) {
1115 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1116 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001117 }
Paul Bakker577e0062013-08-28 11:57:20 +02001118 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001119#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001120
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001121 /*
1122 * Encrypt
1123 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001124#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1126 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1127 "including %d bytes of padding",
1128 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001129
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001130 /* The only supported stream cipher is "NULL",
1131 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001134
Valerio Settie5707042023-10-11 11:54:42 +02001135#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001137 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001138 unsigned char *dynamic_iv;
1139 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001140 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001142#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001143 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001144#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001146
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001147 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (post_avail < transform->taglen) {
1149 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1150 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001151 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001152
Paul Bakker68884e32013-01-07 18:20:04 +01001153 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001154 * Build nonce for AEAD encryption.
1155 *
1156 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1157 * part of the IV is prepended to the ciphertext and
1158 * can be chosen freely - in particular, it need not
1159 * agree with the record sequence number.
1160 * However, since ChaChaPoly as well as all AEAD modes
1161 * in TLS 1.3 use the record sequence number as the
1162 * dynamic part of the nonce, we uniformly use the
1163 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001164 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001165 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 ssl_build_record_nonce(iv, sizeof(iv),
1169 transform->iv_enc,
1170 transform->fixed_ivlen,
1171 dynamic_iv,
1172 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001173
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001174 /*
1175 * Build additional data for AEAD encryption.
1176 * This depends on the TLS version.
1177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1179 transform->tls_version,
1180 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001181
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1183 iv, transform->ivlen);
1184 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1185 dynamic_iv,
1186 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1187 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1188 add_data, add_data_len);
1189 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1190 "including 0 bytes of padding",
1191 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001192
Paul Bakker68884e32013-01-07 18:20:04 +01001193 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001194 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001195 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001196#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 status = psa_aead_encrypt(transform->psa_key_enc,
1198 transform->psa_alg,
1199 iv, transform->ivlen,
1200 add_data, add_data_len,
1201 data, rec->data_len,
1202 data, rec->buf_len - (data - rec->buf),
1203 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001206 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1208 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001209 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001210#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001211 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1212 iv, transform->ivlen,
1213 add_data, add_data_len,
1214 data, rec->data_len, /* src */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001215 data, rec->buf_len - (size_t) (data - rec->buf), /* dst */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 &rec->data_len,
1217 transform->taglen)) != 0) {
1218 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1219 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001220 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001221#endif /* MBEDTLS_USE_PSA_CRYPTO */
1222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1224 data + rec->data_len - transform->taglen,
1225 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001226 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001227 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001228
1229 /*
1230 * Prefix record content with dynamic IV in case it is explicit.
1231 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (dynamic_iv_is_explicit != 0) {
1233 if (rec->data_offset < dynamic_iv_len) {
1234 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1235 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001236 }
1237
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001239 rec->data_offset -= dynamic_iv_len;
1240 rec->data_len += dynamic_iv_len;
1241 }
1242
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001243 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Valerio Settie5707042023-10-11 11:54:42 +02001245#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001246#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1248 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001250 size_t padlen, i;
1251 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001252#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001253 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001254 size_t part_len;
1255 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1256#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001257
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001258 /* Currently we're always using minimal padding
1259 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1261 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001263 }
1264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 /* Check there's enough space in the buffer for the padding. */
1266 if (post_avail < padlen + 1) {
1267 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1268 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1269 }
1270
1271 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001272 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001274
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001275 rec->data_len += padlen + 1;
1276 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001277
TRodziewicz0f82ec62021-05-12 17:49:18 +02001278#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001279 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001280 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001281 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if (f_rng == NULL) {
1284 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1285 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001286 }
TRodziewicz345165c2021-07-06 13:42:11 +02001287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 if (rec->data_offset < transform->ivlen) {
1289 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1290 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001291 }
1292
1293 /*
1294 * Generate IV
1295 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1297 if (ret != 0) {
1298 return ret;
1299 }
TRodziewicz345165c2021-07-06 13:42:11 +02001300
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001302#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1305 "including %"
1306 MBEDTLS_PRINTF_SIZET
1307 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1308 rec->data_len, transform->ivlen,
1309 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001310
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001311#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 status = psa_cipher_encrypt_setup(&cipher_op,
1313 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001316 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1318 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001319 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001324 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1326 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001327
1328 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 status = psa_cipher_update(&cipher_op,
1331 data, rec->data_len,
1332 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001335 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1337 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001338
1339 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 status = psa_cipher_finish(&cipher_op,
1342 data + olen, rec->data_len - olen,
1343 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001346 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1348 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001349
1350 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001351
1352 olen += part_len;
1353#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1355 transform->iv_enc,
1356 transform->ivlen,
1357 data, rec->data_len,
1358 data, &olen)) != 0) {
1359 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1360 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001361 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001362#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (rec->data_len != olen) {
1365 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1366 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001367 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001368
TRodziewicz0f82ec62021-05-12 17:49:18 +02001369 data -= transform->ivlen;
1370 rec->data_offset -= transform->ivlen;
1371 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001375 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001376#if defined(MBEDTLS_USE_PSA_CRYPTO)
1377 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1378 size_t sign_mac_length = 0;
1379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001380
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001381 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001382 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001383
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 if (post_avail < transform->maclen) {
1385 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1386 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001387 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 ssl_extract_add_data_from_record(add_data, &add_data_len,
1390 rec, transform->tls_version,
1391 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1394 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1395 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001396#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1398 transform->psa_mac_alg);
1399 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001400 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 status = psa_mac_update(&operation, add_data, add_data_len);
1404 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001405 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 status = psa_mac_update(&operation, data, rec->data_len);
1409 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001410 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1414 &sign_mac_length);
1415 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001416 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001418#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1421 add_data_len);
1422 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001423 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 }
1425 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1426 data, rec->data_len);
1427 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001428 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 }
1430 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1431 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001432 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 }
1434 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1435 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001436 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001438#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001439
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001441
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001442 rec->data_len += transform->maclen;
1443 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001444 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446hmac_failed_etm_enabled:
1447 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001448#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001449 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 status = psa_mac_abort(&operation);
1451 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001452 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001454#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 if (ret != 0) {
1456 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1457 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001458 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001459 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001462#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001463 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1465 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001466 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001467
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001468 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 if (auth_done != 1) {
1470 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001472 }
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001477}
1478
Gilles Peskine449bd832023-01-11 14:50:10 +01001479int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1480 mbedtls_ssl_transform *transform,
1481 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001482{
Valerio Settie5707042023-10-11 11:54:42 +02001483#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001485#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001486 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001487 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001488
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001489 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001490#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001491 size_t padlen = 0;
1492 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001493#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001495 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 * the description of ssl_extract_add_data_from_record().
1497 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001498#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1499 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1500#else
1501 unsigned char add_data[13];
1502#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001503 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001504
Hanno Beckera18d1322018-01-03 14:27:32 +00001505#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001506 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001507 ((void) ssl);
1508#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1511 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 rec->buf == NULL ||
1513 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 rec->buf_len - rec->data_offset < rec->data_len) {
1515 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1516 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001517 }
1518
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Hanno Beckera0e20d02019-05-15 14:03:01 +01001522#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001523 /*
1524 * Match record's CID with incoming CID.
1525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (rec->cid_len != transform->in_cid_len ||
1527 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1528 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001529 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001530#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001531
Hanno Beckerd086bf02021-03-22 13:01:27 +00001532#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001534 if (rec->data_len < transform->maclen) {
1535 MBEDTLS_SSL_DEBUG_MSG(1,
1536 ("Record too short for MAC:"
1537 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1538 rec->data_len, transform->maclen));
1539 return MBEDTLS_ERR_SSL_INVALID_MAC;
1540 }
1541
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001542 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001543 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001545#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001546#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001548 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001549 unsigned char *dynamic_iv;
1550 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001551#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001553#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001554
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001555 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001556 * Extract dynamic part of nonce for AEAD decryption.
1557 *
1558 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1559 * part of the IV is prepended to the ciphertext and
1560 * can be chosen freely - in particular, it need not
1561 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 dynamic_iv_len = sizeof(rec->ctr);
1564 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1565 if (rec->data_len < dynamic_iv_len) {
1566 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1567 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1568 rec->data_len,
1569 dynamic_iv_len));
1570 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001571 }
1572 dynamic_iv = data;
1573
1574 data += dynamic_iv_len;
1575 rec->data_offset += dynamic_iv_len;
1576 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001578 dynamic_iv = rec->ctr;
1579 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001580
1581 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 if (rec->data_len < transform->taglen) {
1583 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1584 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1585 rec->data_len,
1586 transform->taglen));
1587 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001588 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001589 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001590
Hanno Beckerdf8be222020-05-21 15:30:57 +01001591 /*
1592 * Prepare nonce from dynamic and static parts.
1593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 ssl_build_record_nonce(iv, sizeof(iv),
1595 transform->iv_dec,
1596 transform->fixed_ivlen,
1597 dynamic_iv,
1598 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001599
Hanno Beckerdf8be222020-05-21 15:30:57 +01001600 /*
1601 * Build additional data for AEAD encryption.
1602 * This depends on the TLS version.
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1605 transform->tls_version,
1606 transform->taglen);
1607 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1608 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001609
Hanno Beckerd96a6522019-07-10 13:55:25 +01001610 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001611 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001612 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001613 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001614 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1617 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1618 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001619
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001620 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001621 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001622 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001623#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 status = psa_aead_decrypt(transform->psa_key_dec,
1625 transform->psa_alg,
1626 iv, transform->ivlen,
1627 add_data, add_data_len,
1628 data, rec->data_len + transform->taglen,
1629 data, rec->buf_len - (data - rec->buf),
1630 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001633 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1635 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001636 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001637#else
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001638 if ((ret = mbedtls_cipher_auth_decrypt_ext
1639 (&transform->cipher_ctx_dec,
1640 iv, transform->ivlen,
1641 add_data, add_data_len,
1642 data, rec->data_len + transform->taglen, /* src */
1643 data, rec->buf_len - (size_t) (data - rec->buf), &olen, /* dst */
1644 transform->taglen)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1648 return MBEDTLS_ERR_SSL_INVALID_MAC;
1649 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001652 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001653#endif /* MBEDTLS_USE_PSA_CRYPTO */
1654
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001655 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001656
Hanno Beckerd96a6522019-07-10 13:55:25 +01001657 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 if (olen != rec->data_len) {
1659 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1660 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001661 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 } else
Valerio Settie5707042023-10-11 11:54:42 +02001663#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001664#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1666 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001667 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001668#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001669 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001670 size_t part_len;
1671 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1672#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001673
Paul Bakker5121ce52009-01-03 21:22:43 +00001674 /*
Paul Bakker45829992013-01-03 14:52:21 +01001675 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001677#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001678 /* The ciphertext is prefixed with the CBC IV. */
1679 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001680#endif
Paul Bakker45829992013-01-03 14:52:21 +01001681
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001682 /* Size considerations:
1683 *
1684 * - The CBC cipher text must not be empty and hence
1685 * at least of size transform->ivlen.
1686 *
1687 * Together with the potential IV-prefix, this explains
1688 * the first of the two checks below.
1689 *
1690 * - The record must contain a MAC, either in plain or
1691 * encrypted, depending on whether Encrypt-then-MAC
1692 * is used or not.
1693 * - If it is, the message contains the IV-prefix,
1694 * the CBC ciphertext, and the MAC.
1695 * - If it is not, the padded plaintext, and hence
1696 * the CBC ciphertext, has at least length maclen + 1
1697 * because there is at least the padding length byte.
1698 *
1699 * As the CBC ciphertext is not empty, both cases give the
1700 * lower bound minlen + maclen + 1 on the record size, which
1701 * we test for in the second check below.
1702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 if (rec->data_len < minlen + transform->ivlen ||
1704 rec->data_len < minlen + transform->maclen + 1) {
1705 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1706 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1707 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1708 "+ 1 ) ( + expl IV )",
1709 rec->data_len,
1710 transform->ivlen,
1711 transform->maclen));
1712 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001713 }
1714
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001715 /*
1716 * Authenticate before decrypt if enabled
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001720#if defined(MBEDTLS_USE_PSA_CRYPTO)
1721 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1722#else
Hanno Becker992b6872017-11-09 18:57:39 +00001723 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001724#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001727
Hanno Beckerd96a6522019-07-10 13:55:25 +01001728 /* Update data_len in tandem with add_data.
1729 *
1730 * The subtraction is safe because of the previous check
1731 * data_len >= minlen + maclen + 1.
1732 *
1733 * Afterwards, we know that data + data_len is followed by at
1734 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001735 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001736 *
1737 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001738 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1740 transform->tls_version,
1741 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001742
Hanno Beckerd96a6522019-07-10 13:55:25 +01001743 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1745 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001746#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1748 transform->psa_mac_alg);
1749 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001750 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 status = psa_mac_update(&operation, add_data, add_data_len);
1754 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001755 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 status = psa_mac_update(&operation, data, rec->data_len);
1759 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001760 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001762
1763 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1765 transform->maclen);
1766 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001767 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001769#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1771 add_data_len);
1772 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001773 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 }
1775 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1776 data, rec->data_len);
1777 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001778 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 }
1780 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1781 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001782 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 }
1784 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1785 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001786 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1790 transform->maclen);
1791 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1792 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001793
Hanno Beckerd96a6522019-07-10 13:55:25 +01001794 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1796 transform->maclen) != 0) {
1797 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001798 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1799 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001800 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001801#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001802 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001805#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001806 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 status = psa_mac_abort(&operation);
1808 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001809 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001811#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001813#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 if (ret != 0) {
1815 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1816 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1817 }
1818 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001819 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001820 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001822
1823 /*
1824 * Check length sanity
1825 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001826
1827 /* We know from above that data_len > minlen >= 0,
1828 * so the following check in particular implies that
1829 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (rec->data_len % transform->ivlen != 0) {
1831 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1832 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1833 rec->data_len, transform->ivlen));
1834 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001835 }
1836
TRodziewicz0f82ec62021-05-12 17:49:18 +02001837#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001838 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001839 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001840 */
TRodziewicz345165c2021-07-06 13:42:11 +02001841 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001843
TRodziewicz345165c2021-07-06 13:42:11 +02001844 data += transform->ivlen;
1845 rec->data_offset += transform->ivlen;
1846 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001847#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001848
Hanno Beckerd96a6522019-07-10 13:55:25 +01001849 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1850
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001851#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 status = psa_cipher_decrypt_setup(&cipher_op,
1853 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001856 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1858 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001859 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001864 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1866 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001867 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 status = psa_cipher_update(&cipher_op,
1870 data, rec->data_len,
1871 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001874 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1876 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001877 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 status = psa_cipher_finish(&cipher_op,
1880 data + olen, rec->data_len - olen,
1881 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001884 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1886 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001887 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001888
1889 olen += part_len;
1890#else
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1893 transform->iv_dec, transform->ivlen,
1894 data, rec->data_len, data, &olen)) != 0) {
1895 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1896 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001897 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001898#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001899
Hanno Beckerd96a6522019-07-10 13:55:25 +01001900 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 if (rec->data_len != olen) {
1902 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1903 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001904 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001905
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001906 /* Safe since data_len >= minlen + maclen + 1, so after having
1907 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001908 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1909 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001910 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001913 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 rec->data_len,
1915 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001916 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001917 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (rec->data_len < transform->maclen + padlen + 1) {
1921 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1922 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1923 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1924 rec->data_len,
1925 transform->maclen,
1926 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001927 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001928#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001929 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 rec->data_len,
1931 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001932 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001933 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001934 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001935
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001936 padlen++;
1937
1938 /* Regardless of the validity of the padding,
1939 * we have data_len >= padlen here. */
1940
TRodziewicz0f82ec62021-05-12 17:49:18 +02001941#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001942 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 * consecutive memory reads at the end of the record
1944 * plaintext buffer. In order to hide the length and
1945 * validity of the padding, always perform exactly
1946 * `min(256,plaintext_len)` reads (but take into account
1947 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001948 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001950
1951 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001953 size_t const padding_idx = rec->data_len - padlen;
1954 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1955 size_t const start_idx = rec->data_len - num_checks;
1956 size_t idx;
1957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001959 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 * (check[idx] == padlen - 1);
1961 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001962 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001963 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001964 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001965 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001966 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001967 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001968 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001971 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1973 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001974#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001975 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001976
TRodziewicz0f82ec62021-05-12 17:49:18 +02001977#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001978
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001979 /* If the padding was found to be invalid, padlen == 0
1980 * and the subtraction is safe. If the padding was found valid,
1981 * padlen hasn't been changed and the previous assertion
1982 * data_len >= padlen still holds. */
1983 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001985#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001986 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1988 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001989 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001990
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001991#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1993 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001994#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001995
1996 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001997 * Authenticate if not done yet.
1998 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001999 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002000#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002002 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2003 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002004
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002005 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002006 * data_len < maclen + padlen + 1, then padlen
2007 * got reset to 1, and the initial check
2008 * data_len >= minlen + maclen + 1
2009 * guarantees that at this point we still
2010 * have at least data_len >= maclen.
2011 *
2012 * If the initial value of padlen was such that
2013 * data_len >= maclen + padlen + 1, then we have
2014 * subtracted either padlen + 1 (if the padding was correct)
2015 * or 0 (if the padding was incorrect) since then,
2016 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002017 *
2018 * For stream ciphers, we checked above that
2019 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002020 */
2021 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2023 transform->tls_version,
2024 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002025
TRodziewicz0f82ec62021-05-12 17:49:18 +02002026#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002027 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 * The next two sizes are the minimum and maximum values of
2029 * data_len over all padlen values.
2030 *
2031 * They're independent of padlen, since we previously did
2032 * data_len -= padlen.
2033 *
2034 * Note that max_len + maclen is never more than the buffer
2035 * length, as we previously did in_msglen -= maclen too.
2036 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002037 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002039
Neil Armstronge8589962022-02-25 15:14:29 +01002040#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2042 transform->psa_mac_alg,
2043 add_data, add_data_len,
2044 data, rec->data_len, min_len, max_len,
2045 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002046#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2048 add_data, add_data_len,
2049 data, rec->data_len, min_len, max_len,
2050 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002051#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ret != 0) {
2053 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002054 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002055 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 mbedtls_ct_memcpy_offset(mac_peer, data,
2058 rec->data_len,
2059 min_len, max_len,
2060 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002061#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002062
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002063#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2065 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002066#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2069 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002072#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002073 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002074 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002075 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077hmac_failed_etm_disabled:
2078 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2079 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2080 if (ret != 0) {
2081 return ret;
2082 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002083 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002084
2085 /*
2086 * Finally check the correct flag
2087 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002088 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 return MBEDTLS_ERR_SSL_INVALID_MAC;
2090 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002091#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002092
2093 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (auth_done != 1) {
2095 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2096 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002097 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002098
Ronald Cron6f135e12021-12-08 16:57:54 +01002099#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002101 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2103 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (ret != 0) {
2106 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2107 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002108 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002109#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002110
Hanno Beckera0e20d02019-05-15 14:03:01 +01002111#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (rec->cid_len != 0) {
2113 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2114 &rec->type);
2115 if (ret != 0) {
2116 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2117 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002118 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002119#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002124}
2125
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002126#undef MAC_NONE
2127#undef MAC_PLAINTEXT
2128#undef MAC_CIPHERTEXT
2129
Paul Bakker5121ce52009-01-03 21:22:43 +00002130/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002131 * Fill the input message buffer by appending data to it.
2132 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002133 *
2134 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2135 * available (from this read and/or a previous one). Otherwise, an error code
2136 * is returned (possibly EOF or WANT_READ).
2137 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002138 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2139 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2140 * since we always read a whole datagram at once.
2141 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002142 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002143 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002145int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002146{
Janos Follath865b3eb2019-12-16 11:46:15 +00002147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002148 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002149#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2150 size_t in_buf_len = ssl->in_buf_len;
2151#else
2152 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2153#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2158 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002160 }
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2163 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002165 }
2166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002169 uint32_t timeout;
2170
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002171 /*
2172 * The point is, we need to always read a full datagram at once, so we
2173 * sometimes read more then requested, and handle the additional data.
2174 * It could be the rest of the current record (while fetching the
2175 * header) and/or some other records in the same datagram.
2176 */
2177
2178 /*
2179 * Move to the next record in the already read datagram if applicable
2180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (ssl->next_record_offset != 0) {
2182 if (ssl->in_left < ssl->next_record_offset) {
2183 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2184 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002185 }
2186
2187 ssl->in_left -= ssl->next_record_offset;
2188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (ssl->in_left != 0) {
2190 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2191 MBEDTLS_PRINTF_SIZET,
2192 ssl->next_record_offset));
2193 memmove(ssl->in_hdr,
2194 ssl->in_hdr + ssl->next_record_offset,
2195 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002196 }
2197
2198 ssl->next_record_offset = 0;
2199 }
2200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2202 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2203 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002204
2205 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002206 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (nb_want <= ssl->in_left) {
2209 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2210 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002211 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002212
2213 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002214 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002215 * are not at the beginning of a new record, the caller did something
2216 * wrong.
2217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (ssl->in_left != 0) {
2219 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2220 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002221 }
2222
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002223 /*
2224 * Don't even try to read if time's out already.
2225 * This avoids by-passing the timer when repeatedly receiving messages
2226 * that will end up being dropped.
2227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (mbedtls_ssl_check_timer(ssl) != 0) {
2229 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002230 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002232 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002235 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002237 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->f_recv_timeout != NULL) {
2243 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2244 timeout);
2245 } else {
2246 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2247 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (ret == 0) {
2252 return MBEDTLS_ERR_SSL_CONN_EOF;
2253 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002254 }
2255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2257 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2258 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2261 if (ssl_double_retransmit_timeout(ssl) != 0) {
2262 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2263 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002264 }
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2267 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2268 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002269 }
2270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002272 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2275 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2276 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2277 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2278 ret);
2279 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002280 }
2281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002283 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002285 }
2286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (ret < 0) {
2288 return ret;
2289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002290
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002291 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002293#endif
2294 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2296 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2297 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002300 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002303 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 } else {
2305 if (ssl->f_recv_timeout != NULL) {
2306 ret = ssl->f_recv_timeout(ssl->p_bio,
2307 ssl->in_hdr + ssl->in_left, len,
2308 ssl->conf->read_timeout);
2309 } else {
2310 ret = ssl->f_recv(ssl->p_bio,
2311 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002312 }
2313 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2316 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2317 ssl->in_left, nb_want));
2318 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (ret == 0) {
2321 return MBEDTLS_ERR_SSL_CONN_EOF;
2322 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if (ret < 0) {
2325 return ret;
2326 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002327
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002328 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 MBEDTLS_SSL_DEBUG_MSG(1,
2330 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2331 " were requested",
2332 ret, len));
2333 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002334 }
2335
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002336 ssl->in_left += ret;
2337 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002338 }
2339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002343}
2344
2345/*
2346 * Flush any data not yet written
2347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002348int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002349{
Janos Follath865b3eb2019-12-16 11:46:15 +00002350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002351 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (ssl->f_send == NULL) {
2356 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2357 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002358 }
2359
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002360 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (ssl->out_left == 0) {
2362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2363 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002364 }
2365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 while (ssl->out_left > 0) {
2367 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2368 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2369 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002370
Hanno Becker2b1e3542018-08-06 11:19:13 +01002371 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (ret <= 0) {
2377 return ret;
2378 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002379
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002380 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 MBEDTLS_SSL_DEBUG_MSG(1,
2382 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2383 " bytes were sent",
2384 ret, ssl->out_left));
2385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002386 }
2387
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 ssl->out_left -= ret;
2389 }
2390
Hanno Becker2b1e3542018-08-06 11:19:13 +01002391#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002393 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002395#endif
2396 {
2397 ssl->out_hdr = ssl->out_buf + 8;
2398 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002404}
2405
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002406/*
2407 * Functions to handle the DTLS retransmission state machine
2408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410/*
2411 * Append current handshake message to current outgoing flight
2412 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002414static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002415{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2418 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2419 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420
2421 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2423 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2424 sizeof(mbedtls_ssl_flight_item)));
2425 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426 }
2427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2429 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2430 ssl->out_msglen));
2431 mbedtls_free(msg);
2432 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002433 }
2434
2435 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002438 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002439 msg->next = NULL;
2440
2441 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002443 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002449 cur->next = msg;
2450 }
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2453 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454}
2455
2456/*
2457 * Free the current flight of handshake messages
2458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002460{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 mbedtls_ssl_flight_item *cur = flight;
2462 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465 next = cur->next;
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 mbedtls_free(cur->p);
2468 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002469
2470 cur = next;
2471 }
2472}
2473
2474/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002475 * Swap transform_out and out_ctr with the alternative ones
2476 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002478static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002479{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002481 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2484 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2485 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002486 }
2487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002489
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002490 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002491 tmp_transform = ssl->transform_out;
2492 ssl->transform_out = ssl->handshake->alt_transform_out;
2493 ssl->handshake->alt_transform_out = tmp_transform;
2494
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002495 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2497 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2498 sizeof(ssl->cur_out_ctr));
2499 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2500 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002501
2502 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002506}
2507
2508/*
2509 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002512{
2513 int ret = 0;
2514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002522}
2523
2524/*
2525 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002526 *
2527 * Need to remember the current message in case flush_output returns
2528 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002529 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002531int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002532{
Janos Follath865b3eb2019-12-16 11:46:15 +00002533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2537 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002538
2539 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002540 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 ret = ssl_swap_epochs(ssl);
2542 if (ret != 0) {
2543 return ret;
2544 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002547 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002550 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002551 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002552
Hanno Beckere1dcb032018-08-17 16:47:58 +01002553 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2555 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002556
Ronald Cron00d012f22022-03-08 15:57:12 +01002557 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002559
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002560 /* Swap epochs before sending Finished: we can't do it after
2561 * sending ChangeCipherSpec, in case write returns WANT_READ.
2562 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2564 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2565 ret = ssl_swap_epochs(ssl);
2566 if (ret != 0) {
2567 return ret;
2568 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002569 }
2570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 ret = ssl_get_remaining_payload_in_datagram(ssl);
2572 if (ret < 0) {
2573 return ret;
2574 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002575 max_frag_len = (size_t) ret;
2576
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002577 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2579 if (max_frag_len == 0) {
2580 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2581 return ret;
2582 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002583
2584 continue;
2585 }
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002588 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002589 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002590
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002591 /* Update position inside current message */
2592 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002594 const unsigned char * const p = ssl->handshake->cur_msg_p;
2595 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002596 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002597 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002598 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2601 if (is_finished) {
2602 ret = ssl_swap_epochs(ssl);
2603 if (ret != 0) {
2604 return ret;
2605 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002606 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2609 return ret;
2610 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002611
2612 continue;
2613 }
2614 max_hs_frag_len = max_frag_len - 12;
2615
2616 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2620 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2621 (unsigned) cur_hs_frag_len,
2622 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002623 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002624
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002625 /* Messages are stored with handshake headers as if not fragmented,
2626 * copy beginning of headers then fill fragmentation fields.
2627 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2631 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2632 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2635 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2636 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002639
Hanno Becker3f7b9732018-08-28 09:53:25 +01002640 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002642 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002643 ssl->out_msgtype = cur->type;
2644
2645 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002646 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002647 }
2648
2649 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2651 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002652 ssl->handshake->cur_msg = cur->next;
2653 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002655 ssl->handshake->cur_msg = NULL;
2656 ssl->handshake->cur_msg_p = NULL;
2657 }
2658 }
2659
2660 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2662 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2663 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002664 }
2665 }
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2668 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002669 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 /* Update state and set timer */
2672 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2673 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2674 } else {
2675 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2676 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2677 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2680
2681 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002682}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002683
2684/*
2685 * To be called when the last message of an incoming flight is received.
2686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002688{
2689 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002691 ssl->handshake->flight = NULL;
2692 ssl->handshake->cur_msg = NULL;
2693
2694 /* The next incoming flight will start with this msg_seq */
2695 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2696
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002697 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002698 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002699
Hanno Becker0271f962018-08-16 13:23:47 +01002700 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002702
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002703 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2707 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002712}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002713
2714/*
2715 * To be called when the last message of an outgoing flight is send.
2716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002717void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002718{
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 ssl_reset_retransmit_timeout(ssl);
2720 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2723 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002728}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002730
Paul Bakker5121ce52009-01-03 21:22:43 +00002731/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002732 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002733 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002734int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002736{
2737 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002738 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002739 * ...
2740 * HandshakeType msg_type;
2741 * uint24 length;
2742 * ...
2743 */
2744 *buf = ssl->out_msg + 4;
2745 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2746
2747 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2748 ssl->out_msg[0] = hs_type;
2749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002751}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002752
2753/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002754 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002755 *
2756 * - fill in handshake headers
2757 * - update handshake checksum
2758 * - DTLS: save message for resending
2759 * - then pass to the record layer
2760 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002761 * DTLS: except for HelloRequest, messages are only queued, and will only be
2762 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002763 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002764 * Inputs:
2765 * - ssl->out_msglen: 4 + actual handshake message len
2766 * (4 is the size of handshake headers for TLS)
2767 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2768 * - ssl->out_msg + 4: the handshake message body
2769 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002770 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002771 * - ssl->out_msglen: the length of the record contents
2772 * (including handshake headers but excluding record headers)
2773 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002775int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2776 int update_checksum,
2777 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002778{
Janos Follath865b3eb2019-12-16 11:46:15 +00002779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002780 const size_t hs_len = ssl->out_msglen - 4;
2781 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002784
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002785 /*
2786 * Sanity checks
2787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2789 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2790 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2791 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002792 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002794 /* Whenever we send anything different from a
2795 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2797 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2798 ssl->handshake == NULL) {
2799 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2800 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002801 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002805 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2807 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2808 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002809 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002810#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002811
Hanno Beckerb50a2532018-08-06 11:52:54 +01002812 /* Double-check that we did not exceed the bounds
2813 * of the outgoing record buffer.
2814 * This should never fail as the various message
2815 * writing functions must obey the bounds of the
2816 * outgoing record buffer, but better be safe.
2817 *
2818 * Note: We deliberately do not check for the MTU or MFL here.
2819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2821 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2822 "size %" MBEDTLS_PRINTF_SIZET
2823 ", maximum %" MBEDTLS_PRINTF_SIZET,
2824 ssl->out_msglen,
2825 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002827 }
2828
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002829 /*
2830 * Fill handshake headers
2831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2833 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2834 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2835 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002836
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002837 /*
2838 * DTLS has additional fields in the Handshake layer,
2839 * between the length field and the actual payload:
2840 * uint16 message_seq;
2841 * uint24 fragment_offset;
2842 * uint24 fragment_length;
2843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002846 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2848 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2849 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2850 MBEDTLS_PRINTF_SIZET,
2851 hs_len,
2852 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002854 }
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002857 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002858
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002859 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2861 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2862 ++(ssl->handshake->out_msg_seq);
2863 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002864 ssl->out_msg[4] = 0;
2865 ssl->out_msg[5] = 0;
2866 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002867
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002868 /* Handshake hashes are computed without fragmentation,
2869 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 memset(ssl->out_msg + 6, 0x00, 3);
2871 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002872 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002874
Hanno Becker0207e532018-08-28 10:28:28 +01002875 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002877 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2878 ssl->out_msglen);
2879 if (ret != 0) {
2880 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2881 return ret;
2882 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002884 }
2885
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002886 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2889 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2890 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2891 if ((ret = ssl_flight_append(ssl)) != 0) {
2892 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2893 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002894 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002896#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002897 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2899 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2900 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002901 }
2902 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002907}
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2910 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002911{
2912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2913 size_t msg_with_header_len;
2914 ((void) buf_len);
2915
2916 /* Add reserved 4 bytes for handshake header */
2917 msg_with_header_len = msg_len + 4;
2918 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002920
2921cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002923}
2924
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002925/*
2926 * Record layer functions
2927 */
2928
2929/*
2930 * Write current record.
2931 *
2932 * Uses:
2933 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2934 * - ssl->out_msglen: length of the record content (excl headers)
2935 * - ssl->out_msg: record content
2936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002937int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002938{
2939 int ret, done = 0;
2940 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002941 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002946 unsigned i;
2947 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002948#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2949 size_t out_buf_len = ssl->out_buf_len;
2950#else
2951 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2952#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002953 /* Skip writing the record content type to after the encryption,
2954 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002955 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002956#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002957 /* TLS 1.3 still uses the TLS 1.2 version identifier
2958 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002960 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002962#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2964 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2967 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002970 mbedtls_record rec;
2971
2972 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002973 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002974 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002975 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2978 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002979 rec.type = ssl->out_msgtype;
2980
Hanno Beckera0e20d02019-05-15 14:03:01 +01002981#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002982 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002983 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002984#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2987 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2988 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2989 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002990 }
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (rec.data_offset != 0) {
2993 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2994 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002995 }
2996
Hanno Becker6430faf2019-05-08 11:57:13 +01002997 /* Update the record content type and CID. */
2998 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002999#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3000 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003001#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003002 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003004 }
3005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003007
3008#if defined(MBEDTLS_SSL_PROTO_DTLS)
3009 /* In case of DTLS, double-check that we don't exceed
3010 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3012 ret = ssl_get_remaining_space_in_datagram(ssl);
3013 if (ret < 0) {
3014 return ret;
3015 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003018 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003020 }
3021 }
3022#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003023
Hanno Becker6430faf2019-05-08 11:57:13 +01003024 /* Now write the potentially updated record content type. */
3025 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3028 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3029 ssl->out_hdr[0], ssl->out_hdr[1],
3030 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3033 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003034
3035 ssl->out_left += protected_record_size;
3036 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3040 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003041 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 }
3043 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003044
Gabor Mezei96ae9262022-06-28 11:45:18 +02003045 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (i == mbedtls_ssl_ep_len(ssl)) {
3047 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3048 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003049 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 }
3051
Hanno Becker67bc7c32018-08-06 11:33:50 +01003052#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3054 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003055 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 ret = ssl_get_remaining_payload_in_datagram(ssl);
3057 if (ret < 0) {
3058 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3059 ret);
3060 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003061 }
3062
3063 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003065 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 } else {
3067 MBEDTLS_SSL_DEBUG_MSG(2,
3068 ("Still %u bytes available in current datagram",
3069 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003070 }
3071 }
3072#endif /* MBEDTLS_SSL_PROTO_DTLS */
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 if ((flush == SSL_FORCE_FLUSH) &&
3075 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3076 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3077 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 }
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003083}
3084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003086
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003087MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003088static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003089{
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (ssl->in_msglen < ssl->in_hslen ||
3091 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3092 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3093 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003094 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003096}
Hanno Becker44650b72018-08-16 12:51:11 +01003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003099{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003100 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01003101}
3102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003104{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003105 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01003106}
3107
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003108MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003109static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003110{
3111 uint32_t msg_len, frag_off, frag_len;
3112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 msg_len = ssl_get_hs_total_len(ssl);
3114 frag_off = ssl_get_hs_frag_off(ssl);
3115 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 if (frag_off > msg_len) {
3118 return -1;
3119 }
Hanno Becker44650b72018-08-16 12:51:11 +01003120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 if (frag_len > msg_len - frag_off) {
3122 return -1;
3123 }
Hanno Becker44650b72018-08-16 12:51:11 +01003124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 if (frag_len + 12 > ssl->in_msglen) {
3126 return -1;
3127 }
Hanno Becker44650b72018-08-16 12:51:11 +01003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003130}
3131
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003132/*
3133 * Mark bits in bitmask (used for DTLS HS reassembly)
3134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003136{
3137 unsigned int start_bits, end_bits;
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 start_bits = 8 - (offset % 8);
3140 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003141 size_t first_byte_idx = offset / 8;
3142
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003143 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (len <= start_bits) {
3145 for (; len != 0; len--) {
3146 mask[first_byte_idx] |= 1 << (start_bits - len);
3147 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003148
3149 /* Avoid potential issues with offset or len becoming invalid */
3150 return;
3151 }
3152
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003153 offset += start_bits; /* Now offset % 8 == 0 */
3154 len -= start_bits;
3155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 for (; start_bits != 0; start_bits--) {
3157 mask[first_byte_idx] |= 1 << (start_bits - 1);
3158 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003159 }
3160
3161 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 if (end_bits != 0) {
3163 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003164
3165 len -= end_bits; /* Now len % 8 == 0 */
3166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 for (; end_bits != 0; end_bits--) {
3168 mask[last_byte_idx] |= 1 << (8 - end_bits);
3169 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003170 }
3171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173}
3174
3175/*
3176 * Check that bitmask is full
3177 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003179static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003180{
3181 size_t i;
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 for (i = 0; i < len / 8; i++) {
3184 if (mask[i] != 0xFF) {
3185 return -1;
3186 }
3187 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 for (i = 0; i < len % 8; i++) {
3190 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3191 return -1;
3192 }
3193 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003194
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003196}
3197
Hanno Becker56e205e2018-08-16 09:06:12 +01003198/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3200 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003201{
Hanno Becker56e205e2018-08-16 09:06:12 +01003202 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003203
Hanno Becker56e205e2018-08-16 09:06:12 +01003204 alloc_len = 12; /* Handshake header */
3205 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (add_bitmap) {
3208 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 }
3211 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003212}
Hanno Becker56e205e2018-08-16 09:06:12 +01003213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003217{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003218 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01003219}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003222{
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3224 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3225 ssl->in_msglen));
3226 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003227 }
3228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3232 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3233 MBEDTLS_PRINTF_SIZET,
3234 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003239 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (ssl_check_hs_header(ssl) != 0) {
3242 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3243 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003244 }
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl->handshake != NULL &&
3247 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3248 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3249 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3250 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3251 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3252 MBEDTLS_SSL_DEBUG_MSG(2,
3253 (
3254 "received future handshake message of sequence number %u (next %u)",
3255 recv_msg_seq,
3256 ssl->handshake->in_msg_seq));
3257 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003258 }
3259
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003260 /* Retransmit only on last message from previous flight, to avoid
3261 * too many retransmissions.
3262 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3264 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3265 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3266 "message_seq = %u, start_of_flight = %u",
3267 recv_msg_seq,
3268 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003269
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3271 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3272 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003273 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 } else {
3275 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3276 "message_seq = %u, expected = %u",
3277 recv_msg_seq,
3278 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003279 }
3280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003282 }
3283 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003284
Hanno Becker6d97ef52018-08-16 13:09:04 +01003285 /* Message reassembly is handled alongside buffering of future
3286 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003287 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003288 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3290 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3291 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003292 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003295 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 if (ssl->in_msglen < ssl->in_hslen) {
3297 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003299 }
3300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003302}
3303
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003304int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003305{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003307 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003310 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3311 if (ret != 0) {
3312 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3313 return ret;
3314 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003315 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003316
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003317 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3320 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003321 unsigned offset;
3322 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003323
Hanno Becker0271f962018-08-16 13:23:47 +01003324 /* Increment handshake sequence number */
3325 hs->in_msg_seq++;
3326
3327 /*
3328 * Clear up handshake buffering and reassembly structure.
3329 */
3330
3331 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003333
3334 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003336 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003338 *hs_buf = *(hs_buf + 1);
3339 }
3340
3341 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003343 }
3344#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003345 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003346}
3347
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003348/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003349 * DTLS anti-replay: RFC 6347 4.1.2.6
3350 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003351 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3352 * Bit n is set iff record number in_window_top - n has been seen.
3353 *
3354 * Usually, in_window_top is the last record number seen and the lsb of
3355 * in_window is set. The only exception is the initial state (record number 0
3356 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003357 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003359void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003360{
3361 ssl->in_window_top = 0;
3362 ssl->in_window = 0;
3363}
3364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003366{
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 return ((uint64_t) buf[0] << 40) |
3368 ((uint64_t) buf[1] << 32) |
3369 ((uint64_t) buf[2] << 24) |
3370 ((uint64_t) buf[3] << 16) |
3371 ((uint64_t) buf[4] << 8) |
3372 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003373}
3374
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003375MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003376static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003377{
Janos Follath865b3eb2019-12-16 11:46:15 +00003378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003379 unsigned char *original_in_ctr;
3380
3381 // save original in_ctr
3382 original_in_ctr = ssl->in_ctr;
3383
3384 // use counter from record
3385 ssl->in_ctr = record_in_ctr;
3386
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003388
3389 // restore the counter
3390 ssl->in_ctr = original_in_ctr;
3391
3392 return ret;
3393}
3394
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003395/*
3396 * Return 0 if sequence number is acceptable, -1 otherwise
3397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003398int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003399{
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003401 uint64_t bit;
3402
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3404 return 0;
3405 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003406
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 if (rec_seqnum > ssl->in_window_top) {
3408 return 0;
3409 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003410
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003411 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003412
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 if (bit >= 64) {
3414 return -1;
3415 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003416
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3418 return -1;
3419 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003420
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003422}
3423
3424/*
3425 * Update replay window on new validated record
3426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003427void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003428{
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003430
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003432 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003434
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003436 /* Update window_top and the contents of the window */
3437 uint64_t shift = rec_seqnum - ssl->in_window_top;
3438
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003440 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003442 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003443 ssl->in_window |= 1;
3444 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003445
3446 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003448 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003449 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003450
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003452 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003454 }
3455}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003456#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003457
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003458#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003459/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003460 * Check if a datagram looks like a ClientHello with a valid cookie,
3461 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003462 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003463 *
3464 * - if cookie is valid, return 0
3465 * - if ClientHello looks superficially valid but cookie is not,
3466 * fill obuf and set olen, then
3467 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3468 * - otherwise return a specific error code
3469 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003470MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003471MBEDTLS_STATIC_TESTABLE
3472int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 mbedtls_ssl_context *ssl,
3474 const unsigned char *cli_id, size_t cli_id_len,
3475 const unsigned char *in, size_t in_len,
3476 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003477{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003478 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003479 unsigned char *p;
3480
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003481 /*
3482 * Structure of ClientHello with record and handshake headers,
3483 * and expected values. We don't need to check a lot, more checks will be
3484 * done when actually parsing the ClientHello - skipping those checks
3485 * avoids code duplication and does not make cookie forging any easier.
3486 *
3487 * 0-0 ContentType type; copied, must be handshake
3488 * 1-2 ProtocolVersion version; copied
3489 * 3-4 uint16 epoch; copied, must be 0
3490 * 5-10 uint48 sequence_number; copied
3491 * 11-12 uint16 length; (ignored)
3492 *
3493 * 13-13 HandshakeType msg_type; (ignored)
3494 * 14-16 uint24 length; (ignored)
3495 * 17-18 uint16 message_seq; copied
3496 * 19-21 uint24 fragment_offset; copied, must be 0
3497 * 22-24 uint24 fragment_length; (ignored)
3498 *
3499 * 25-26 ProtocolVersion client_version; (ignored)
3500 * 27-58 Random random; (ignored)
3501 * 59-xx SessionID session_id; 1 byte len + sid_len content
3502 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3503 * ...
3504 *
3505 * Minimum length is 61 bytes.
3506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3508 (unsigned) in_len));
3509 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3510 if (in_len < 61) {
3511 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3512 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003513 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003514
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3516 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003517
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3519 fragment_offset != 0) {
3520 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3521 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3522 in[0], (unsigned) epoch,
3523 (unsigned) fragment_offset));
3524 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003525 }
3526
3527 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003528 if (59 + 1 + sid_len + 1 > in_len) {
3529 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3530 (unsigned) sid_len,
3531 (unsigned) in_len - 61));
3532 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003533 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003534 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3535 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003536
3537 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3539 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3540 (unsigned) cookie_len,
3541 (unsigned) (in_len - sid_len - 61)));
3542 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003543 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003544
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3546 in + sid_len + 61, cookie_len);
3547 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3548 in + sid_len + 61, cookie_len,
3549 cli_id, cli_id_len) == 0) {
3550 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3551 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003552 }
3553
3554 /*
3555 * If we get here, we've got an invalid cookie, let's prepare HVR.
3556 *
3557 * 0-0 ContentType type; copied
3558 * 1-2 ProtocolVersion version; copied
3559 * 3-4 uint16 epoch; copied
3560 * 5-10 uint48 sequence_number; copied
3561 * 11-12 uint16 length; olen - 13
3562 *
3563 * 13-13 HandshakeType msg_type; hello_verify_request
3564 * 14-16 uint24 length; olen - 25
3565 * 17-18 uint16 message_seq; copied
3566 * 19-21 uint24 fragment_offset; copied
3567 * 22-24 uint24 fragment_length; olen - 25
3568 *
3569 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3570 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3571 *
3572 * Minimum length is 28.
3573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003574 if (buf_len < 28) {
3575 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3576 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003577
3578 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003580 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3581 obuf[25] = 0xfe;
3582 obuf[26] = 0xff;
3583
3584 /* Generate and write actual cookie */
3585 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003586 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3587 &p, obuf + buf_len,
3588 cli_id, cli_id_len) != 0) {
3589 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003590 }
3591
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003592 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003593
3594 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003595 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003596
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3598 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3599 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003600
Gilles Peskine449bd832023-01-11 14:50:10 +01003601 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003602
Gilles Peskine449bd832023-01-11 14:50:10 +01003603 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003604}
3605
3606/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003607 * Handle possible client reconnect with the same UDP quadruplet
3608 * (RFC 6347 Section 4.2.8).
3609 *
3610 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3611 * that looks like a ClientHello.
3612 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003613 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003614 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003615 * - if the input looks like a ClientHello with a valid cookie,
3616 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003617 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003618 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003619 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003620 * This function is called (through ssl_check_client_reconnect()) when an
3621 * unexpected record is found in ssl_get_next_record(), which will discard the
3622 * record if we return 0, and bubble up the return value otherwise (this
3623 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3624 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003625 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003626MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003627static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003628{
Janos Follath865b3eb2019-12-16 11:46:15 +00003629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003630 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003631
Gilles Peskine449bd832023-01-11 14:50:10 +01003632 if (ssl->conf->f_cookie_write == NULL ||
3633 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003634 /* If we can't use cookies to verify reachability of the peer,
3635 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003636 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3637 "can't check reconnect validity"));
3638 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003639 }
3640
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003641 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003642 ssl,
3643 ssl->cli_id, ssl->cli_id_len,
3644 ssl->in_buf, ssl->in_left,
3645 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003646
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003650 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3652 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3653 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003654 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003655 * If the error is permanent we'll catch it later,
3656 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003657 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3658 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003659 (void) send_ret;
3660
Gilles Peskine449bd832023-01-11 14:50:10 +01003661 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003662 }
3663
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 if (ret == 0) {
3665 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3666 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3667 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3668 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003669 }
3670
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003672 }
3673
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003675}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003676#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003677
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003679static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003680{
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003682 record_type != MBEDTLS_SSL_MSG_ALERT &&
3683 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3685 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003686 }
3687
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003689}
3690
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003691/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003692 * ContentType type;
3693 * ProtocolVersion version;
3694 * uint16 epoch; // DTLS only
3695 * uint48 sequence_number; // DTLS only
3696 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003697 *
3698 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003699 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003700 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3701 *
3702 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003703 * 1. proceed with the record if this function returns 0
3704 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3705 * 3. return CLIENT_RECONNECT if this function return that value
3706 * 4. drop the whole datagram if this function returns anything else.
3707 * Point 2 is needed when the peer is resending, and we have already received
3708 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003709 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003711static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3712 unsigned char *buf,
3713 size_t len,
3714 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003715{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003716 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003717
Hanno Beckere5e7e782019-07-11 12:29:35 +01003718 size_t const rec_hdr_type_offset = 0;
3719 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003720
Hanno Beckere5e7e782019-07-11 12:29:35 +01003721 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3722 rec_hdr_type_len;
3723 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003724
Hanno Beckere5e7e782019-07-11 12:29:35 +01003725 size_t const rec_hdr_ctr_len = 8;
3726#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003727 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003728 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3729 rec_hdr_version_len;
3730
Hanno Beckera0e20d02019-05-15 14:03:01 +01003731#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003732 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3733 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003734 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003735#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3736#endif /* MBEDTLS_SSL_PROTO_DTLS */
3737
3738 size_t rec_hdr_len_offset; /* To be determined */
3739 size_t const rec_hdr_len_len = 2;
3740
3741 /*
3742 * Check minimum lengths for record header.
3743 */
3744
3745#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003746 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003747 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003749#endif /* MBEDTLS_SSL_PROTO_DTLS */
3750 {
3751 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3752 }
3753
Gilles Peskine449bd832023-01-11 14:50:10 +01003754 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3755 MBEDTLS_SSL_DEBUG_MSG(1,
3756 (
3757 "datagram of length %u too small to hold DTLS record header of length %u",
3758 (unsigned) len,
3759 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3760 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003761 }
3762
3763 /*
3764 * Parse and validate record content type
3765 */
3766
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003768
3769 /* Check record content type */
3770#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3771 rec->cid_len = 0;
3772
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003774 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003775 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003776 /* Shift pointers to account for record header including CID
3777 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003778 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003779 * ProtocolVersion version;
3780 * uint16 epoch;
3781 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003782 * opaque cid[cid_length]; // Additional field compared to
3783 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003784 * uint16 length;
3785 * opaque enc_content[DTLSCiphertext.length];
3786 * } DTLSCiphertext;
3787 */
3788
3789 /* So far, we only support static CID lengths
3790 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003791 rec_hdr_cid_len = ssl->conf->cid_len;
3792 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003793
Gilles Peskine449bd832023-01-11 14:50:10 +01003794 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3795 MBEDTLS_SSL_DEBUG_MSG(1,
3796 (
3797 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3798 (unsigned) len,
3799 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3800 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003801 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003802
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003803 /* configured CID len is guaranteed at most 255, see
3804 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3805 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3807 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003808#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003809 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003810 if (ssl_check_record_type(rec->type)) {
3811 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3812 (unsigned) rec->type));
3813 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003814 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003815 }
3816
Hanno Beckere5e7e782019-07-11 12:29:35 +01003817 /*
3818 * Parse and validate record version
3819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3821 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003822 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3823 buf + rec_hdr_version_offset,
3824 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003825
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 if (tls_version > ssl->conf->max_tls_version) {
3827 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3828 (unsigned) tls_version,
3829 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003830
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003832 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003833 /*
3834 * Parse/Copy record sequence number.
3835 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003836
Hanno Beckere5e7e782019-07-11 12:29:35 +01003837#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003839 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003840 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3841 rec_hdr_ctr_len);
3842 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003843#endif /* MBEDTLS_SSL_PROTO_DTLS */
3844 {
3845 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003847 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003848
Hanno Beckere5e7e782019-07-11 12:29:35 +01003849 /*
3850 * Parse record length.
3851 */
3852
Hanno Beckere5e7e782019-07-11 12:29:35 +01003853 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003854 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003856
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3858 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3859 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003860
3861 rec->buf = buf;
3862 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003863
Gilles Peskine449bd832023-01-11 14:50:10 +01003864 if (rec->data_len == 0) {
3865 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3866 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003867
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003868 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003869 * DTLS-related tests.
3870 * Check epoch before checking length constraint because
3871 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3872 * message gets duplicated before the corresponding Finished message,
3873 * the second ChangeCipherSpec should be discarded because it belongs
3874 * to an old epoch, but not because its length is shorter than
3875 * the minimum record length for packets using the new record transform.
3876 * Note that these two kinds of failures are handled differently,
3877 * as an unexpected record is silently skipped but an invalid
3878 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003879 */
3880#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003882 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003883
Hanno Becker955a5c92019-07-10 17:12:07 +01003884 /* Check that the datagram is large enough to contain a record
3885 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 if (len < rec->data_offset + rec->data_len) {
3887 MBEDTLS_SSL_DEBUG_MSG(1,
3888 (
3889 "Datagram of length %u too small to contain record of advertised length %u.",
3890 (unsigned) len,
3891 (unsigned) (rec->data_offset + rec->data_len)));
3892 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003893 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003894
Hanno Becker37cfe732019-07-10 17:20:01 +01003895 /* Records from other, non-matching epochs are silently discarded.
3896 * (The case of same-port Client reconnects must be considered in
3897 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 if (rec_epoch != ssl->in_epoch) {
3899 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3900 "expected %u, received %lu",
3901 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003902
Hanno Becker552f7472019-07-19 10:59:12 +01003903 /* Records from the next epoch are considered for buffering
3904 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3906 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3907 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003908 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003909
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003911 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003912#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003913 /* For records from the correct epoch, check whether their
3914 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3916 &rec->ctr[0]) != 0) {
3917 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3918 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003919 }
3920#endif
3921 }
3922#endif /* MBEDTLS_SSL_PROTO_DTLS */
3923
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003925}
Paul Bakker5121ce52009-01-03 21:22:43 +00003926
Paul Bakker5121ce52009-01-03 21:22:43 +00003927
Hanno Becker2fddd372019-07-10 14:37:41 +01003928#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003929MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003930static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003931{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003932 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003933
3934 /*
3935 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3936 * access the first byte of record content (handshake type), as we
3937 * have an active transform (possibly iv_len != 0), so use the
3938 * fact that the record header len is 13 instead.
3939 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003941 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003943 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3944 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3946 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3947 "from the same port"));
3948 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003949 }
3950
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003952}
Hanno Becker2fddd372019-07-10 14:37:41 +01003953#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003954
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003955/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003956 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003957 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003959static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3960 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003961{
3962 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3965 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003966
Ronald Cron7e38cba2021-11-24 12:43:39 +01003967 /*
3968 * In TLS 1.3, always treat ChangeCipherSpec records
3969 * as unencrypted. The only thing we do with them is
3970 * check the length and content and ignore them.
3971 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003972#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 if (ssl->transform_in != NULL &&
3974 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3975 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003976 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003978 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003979#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003980
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003982 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3985 rec)) != 0) {
3986 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003987
Ronald Cron2995d352024-01-18 16:59:39 +01003988#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3989 /*
3990 * Although the server rejected early data, it might receive early
3991 * data as long as it has not received the client Finished message.
3992 * It is encrypted with early keys and should be ignored as stated
3993 * in section 4.2.10 of RFC 8446:
3994 *
3995 * "Ignore the extension and return a regular 1-RTT response. The
3996 * server then skips past early data by attempting to deprotect
3997 * received records using the handshake traffic key, discarding
3998 * records which fail deprotection (up to the configured
3999 * max_early_data_size). Once a record is deprotected successfully,
4000 * it is treated as the start of the client's second flight and the
4001 * server proceeds as with an ordinary 1-RTT handshake."
4002 */
4003 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
4004 (ssl->discard_early_data_record ==
4005 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
4006 MBEDTLS_SSL_DEBUG_MSG(
4007 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01004008
4009 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
4010 if (ret != 0) {
4011 return ret;
4012 }
Ronald Cron2995d352024-01-18 16:59:39 +01004013 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4014 }
4015#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4016
Hanno Beckera0e20d02019-05-15 14:03:01 +01004017#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004019 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4021 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004022 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004023 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004024#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004025
Ronald Cron71c6e652024-02-05 16:48:10 +01004026 /*
4027 * The decryption of the record failed, no reason to ignore it,
4028 * return in error with the decryption error code.
4029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004031 }
4032
Ronald Cron2995d352024-01-18 16:59:39 +01004033#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
4034 /*
4035 * If the server were discarding protected records that it fails to
4036 * deprotect because it has rejected early data, as we have just
4037 * deprotected successfully a record, the server has to resume normal
4038 * operation and fail the connection if the deprotection of a record
4039 * fails.
4040 */
4041 if (ssl->discard_early_data_record ==
4042 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
4043 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
4044 }
4045#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (old_msg_type != rec->type) {
4048 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4049 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004050 }
4051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4053 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004054
Hanno Beckera0e20d02019-05-15 14:03:01 +01004055#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004056 /* We have already checked the record content type
4057 * in ssl_parse_record_header(), failing or silently
4058 * dropping the record in the case of an unknown type.
4059 *
4060 * Since with the use of CIDs, the record content type
4061 * might change during decryption, re-check the record
4062 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 if (ssl_check_record_type(rec->type)) {
4064 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4065 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004066 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004067#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4072 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004073 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4075 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004076 }
4077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4078
4079 ssl->nb_zero++;
4080
4081 /*
4082 * Three or more empty messages may be a DoS attack
4083 * (excessive CPU consumption).
4084 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (ssl->nb_zero > 3) {
4086 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4087 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004088 /* Treat the records as if they were not properly authenticated,
4089 * thereby failing the connection if we see more than allowed
4090 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004092 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004094 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004096
4097#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004099 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004101#endif
4102 {
4103 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4105 i > mbedtls_ssl_ep_len(ssl); i--) {
4106 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004107 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004109 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004110
4111 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (i == mbedtls_ssl_ep_len(ssl)) {
4113 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4114 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004115 }
4116 }
4117
Paul Bakker5121ce52009-01-03 21:22:43 +00004118 }
4119
Jerry Yuf57d14b2023-11-15 16:40:09 +08004120#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
4121 /*
4122 * Although the server rejected early data because it needed to send an
4123 * HelloRetryRequest message, it might receive early data as long as it has
4124 * not received the client Finished message.
4125 * The early data is encrypted with early keys and should be ignored as
4126 * stated in section 4.2.10 of RFC 8446 (second case):
4127 *
4128 * "The server then ignores early data by skipping all records with an
4129 * external content type of "application_data" (indicating that they are
4130 * encrypted), up to the configured max_early_data_size. Ignore application
4131 * data message before 2nd ClientHello when early_data was received in 1st
4132 * ClientHello."
4133 */
4134 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
4135 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01004136
4137 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
4138 if (ret != 0) {
4139 return ret;
4140 }
4141
Jerry Yuf57d14b2023-11-15 16:40:09 +08004142 MBEDTLS_SSL_DEBUG_MSG(
4143 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01004144
Jerry Yuf57d14b2023-11-15 16:40:09 +08004145 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4146 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
4147 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
4148 }
4149 }
4150#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
4151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004152#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4154 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004155 }
4156#endif
4157
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004158 /* Check actual (decrypted) record content length against
4159 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4161 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4162 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004163 }
4164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004166}
4167
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004168/*
4169 * Read a record.
4170 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004171 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4172 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4173 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004174 */
Hanno Becker1097b342018-08-15 14:09:41 +01004175
4176/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004177MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004178static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004179MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004180static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004181MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004182static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004183
Gilles Peskine449bd832023-01-11 14:50:10 +01004184int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4185 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004186{
Janos Follath865b3eb2019-12-16 11:46:15 +00004187 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004188
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004190
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004192 do {
Simon Butcher99000142016-10-13 17:21:01 +01004193
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 ret = ssl_consume_current_message(ssl);
4195 if (ret != 0) {
4196 return ret;
4197 }
Hanno Becker26994592018-08-15 14:14:59 +01004198
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004200 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004201#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004202
Hanno Becker40f50842018-08-15 14:48:01 +01004203 /* We only check for buffered messages if the
4204 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4206 ssl_next_record_is_in_datagram(ssl) == 0) {
4207 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004208 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 }
Hanno Becker40f50842018-08-15 14:48:01 +01004210 }
4211
Hanno Becker40f50842018-08-15 14:48:01 +01004212#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 if (dtls_have_buffered == 0) {
4214 ret = ssl_get_next_record(ssl);
4215 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004216 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 }
Hanno Becker40f50842018-08-15 14:48:01 +01004218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 if (ret != 0) {
4220 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4221 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004222 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004223 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004224 }
4225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004227
Hanno Becker40f50842018-08-15 14:48:01 +01004228#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004230 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 ret = ssl_buffer_message(ssl);
4232 if (ret != 0) {
4233 return ret;
4234 }
Hanno Becker40f50842018-08-15 14:48:01 +01004235
4236 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4237 }
4238#endif /* MBEDTLS_SSL_PROTO_DTLS */
4239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4241 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004242
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (0 != ret) {
4244 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4245 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004246 }
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4249 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004250 ret = mbedtls_ssl_update_handshake_status(ssl);
4251 if (0 != ret) {
4252 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4253 return ret;
4254 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004255 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 } else {
4257 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004258 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004259 }
4260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004264}
4265
Hanno Becker40f50842018-08-15 14:48:01 +01004266#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004267MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004268static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004269{
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (ssl->in_left > ssl->next_record_offset) {
4271 return 1;
4272 }
Simon Butcher99000142016-10-13 17:21:01 +01004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004275}
4276
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004278static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004279{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004280 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004282 int ret = 0;
4283
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 if (hs == NULL) {
4285 return -1;
4286 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4291 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004292 /* Check if we have seen a ChangeCipherSpec before.
4293 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (!hs->buffering.seen_ccs) {
4295 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004296 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004297 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004298 }
4299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004301 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4302 ssl->in_msglen = 1;
4303 ssl->in_msg[0] = 1;
4304
4305 /* As long as they are equal, the exact value doesn't matter. */
4306 ssl->in_left = 0;
4307 ssl->next_record_offset = 0;
4308
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004309 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004310 goto exit;
4311 }
Hanno Becker37f95322018-08-16 13:55:32 +01004312
Hanno Beckerb8f50142018-08-28 10:01:34 +01004313#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004314 /* Debug only */
4315 {
4316 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004318 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 if (hs_buf->is_valid == 1) {
4320 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4321 hs->in_msg_seq + offset,
4322 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004323 }
4324 }
4325 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004326#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004327
4328 /* Check if we have buffered and/or fully reassembled the
4329 * next handshake message. */
4330 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004332 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004333 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004334
4335 /* Double-check that we haven't accidentally buffered
4336 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4338 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4339 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004340 }
4341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4343 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4344 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004345
4346 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4347 ssl->in_hslen = msg_len + 12;
4348 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004350
4351 ret = 0;
4352 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 } else {
4354 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4355 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004356 }
4357
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004358 ret = -1;
4359
4360exit:
4361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4363 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004364}
4365
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004366MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004367static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4368 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004369{
4370 int offset;
4371 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4373 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004374
Hanno Becker01315ea2018-08-21 17:22:17 +01004375 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004377
4378 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4380 hs->buffering.total_bytes_buffered)) {
4381 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4382 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004383 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004384
Hanno Becker4f432ad2018-08-28 10:02:32 +01004385 /* We don't have enough space to buffer the next expected handshake
4386 * message. Remove buffers used for future messages to gain space,
4387 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4389 offset >= 0; offset--) {
4390 MBEDTLS_SSL_DEBUG_MSG(2,
4391 (
4392 "Free buffering slot %d to make space for reassembly of next handshake message",
4393 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004396
4397 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4399 hs->buffering.total_bytes_buffered)) {
4400 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4401 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004402 }
4403 }
4404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004406}
4407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004408MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004409static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004410{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004411 int ret = 0;
4412 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (hs == NULL) {
4415 return 0;
4416 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004421 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004423
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004424 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004425 break;
4426
4427 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004428 {
4429 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004430 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004431 mbedtls_ssl_hs_buffer *hs_buf;
4432 size_t msg_len = ssl->in_hslen - 12;
4433
4434 /* We should never receive an old handshake
4435 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4437 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4438 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004439 }
4440
4441 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004443 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 MBEDTLS_SSL_DEBUG_MSG(2,
4445 ("Ignore future HS message with sequence number %u, "
4446 "buffering window %u - %u",
4447 recv_msg_seq, ssl->handshake->in_msg_seq,
4448 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4449 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004450
4451 goto exit;
4452 }
4453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4455 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004458
4459 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004461 size_t reassembly_buf_sz;
4462
Hanno Becker37f95322018-08-16 13:55:32 +01004463 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004465
4466 /* We copy the message back into the input buffer
4467 * after reassembly, so check that it's not too large.
4468 * This is an implementation-specific limitation
4469 * and not one from the standard, hence it is not
4470 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004472 /* Ignore message */
4473 goto exit;
4474 }
4475
Hanno Beckere0b150f2018-08-21 15:51:03 +01004476 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (hs->buffering.total_bytes_buffered >
4478 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4479 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4480 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004481 }
4482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4484 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004485
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4487 hs->buffering.total_bytes_buffered)) {
4488 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004489 /* If we can't buffer a future message because
4490 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 MBEDTLS_SSL_DEBUG_MSG(2,
4492 ("Buffering of future message of size %"
4493 MBEDTLS_PRINTF_SIZET
4494 " would exceed the compile-time limit %"
4495 MBEDTLS_PRINTF_SIZET
4496 " (already %" MBEDTLS_PRINTF_SIZET
4497 " bytes buffered) -- ignore\n",
4498 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4499 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004500 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 } else {
4502 MBEDTLS_SSL_DEBUG_MSG(2,
4503 ("Buffering of future message of size %"
4504 MBEDTLS_PRINTF_SIZET
4505 " would exceed the compile-time limit %"
4506 MBEDTLS_PRINTF_SIZET
4507 " (already %" MBEDTLS_PRINTF_SIZET
4508 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4509 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4510 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004511 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4514 MBEDTLS_SSL_DEBUG_MSG(2,
4515 ("Reassembly of next message of size %"
4516 MBEDTLS_PRINTF_SIZET
4517 " (%" MBEDTLS_PRINTF_SIZET
4518 " with bitmap) would exceed"
4519 " the compile-time limit %"
4520 MBEDTLS_PRINTF_SIZET
4521 " (already %" MBEDTLS_PRINTF_SIZET
4522 " bytes buffered) -- fail\n",
4523 msg_len,
4524 reassembly_buf_sz,
4525 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4526 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004527 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4528 goto exit;
4529 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004530 }
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 MBEDTLS_SSL_DEBUG_MSG(2,
4533 ("initialize reassembly, total length = %"
4534 MBEDTLS_PRINTF_SIZET,
4535 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4538 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004539 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004540 goto exit;
4541 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004542 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004543
4544 /* Prepare final header: copy msg_type, length and message_seq,
4545 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 memcpy(hs_buf->data, ssl->in_msg, 6);
4547 memset(hs_buf->data + 6, 0, 3);
4548 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004549
4550 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004551
4552 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004554 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4556 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004557 /* Ignore */
4558 goto exit;
4559 }
4560 }
4561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004563 size_t frag_len, frag_off;
4564 unsigned char * const msg = hs_buf->data + 12;
4565
4566 /*
4567 * Check and copy current fragment
4568 */
4569
4570 /* Validation of header fields already done in
4571 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 frag_off = ssl_get_hs_frag_off(ssl);
4573 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004574
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4576 ", length = %" MBEDTLS_PRINTF_SIZET,
4577 frag_off, frag_len));
4578 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004581 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 ssl_bitmask_set(bitmask, frag_off, frag_len);
4583 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4584 msg_len) == 0);
4585 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004586 hs_buf->is_complete = 1;
4587 }
4588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4590 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004591 }
4592
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004593 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004594 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004595
4596 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004597 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004598 break;
4599 }
4600
4601exit:
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4604 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004605}
4606#endif /* MBEDTLS_SSL_PROTO_DTLS */
4607
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004608MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004609static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004610{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004611 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004612 * Consume last content-layer message and potentially
4613 * update in_msglen which keeps track of the contents'
4614 * consumption state.
4615 *
4616 * (1) Handshake messages:
4617 * Remove last handshake message, move content
4618 * and adapt in_msglen.
4619 *
4620 * (2) Alert messages:
4621 * Consume whole record content, in_msglen = 0.
4622 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004623 * (3) Change cipher spec:
4624 * Consume whole record content, in_msglen = 0.
4625 *
4626 * (4) Application data:
4627 * Don't do anything - the record layer provides
4628 * the application data as a stream transport
4629 * and consumes through mbedtls_ssl_read only.
4630 *
4631 */
4632
4633 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004635 /* Hard assertion to be sure that no application data
4636 * is in flight, as corrupting ssl->in_msglen during
4637 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (ssl->in_offt != NULL) {
4639 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4640 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004641 }
4642
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004643 /*
4644 * Get next Handshake message in the current record
4645 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004646
Hanno Becker4a810fb2017-05-24 16:27:30 +01004647 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004648 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004649 * current handshake content: If DTLS handshake
4650 * fragmentation is used, that's the fragment
4651 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004652 * size here is faulty and should be changed at
4653 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004654 * (2) While it doesn't seem to cause problems, one
4655 * has to be very careful not to assume that in_hslen
4656 * is always <= in_msglen in a sensible communication.
4657 * Again, it's wrong for DTLS handshake fragmentation.
4658 * The following check is therefore mandatory, and
4659 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004660 * Additionally, ssl->in_hslen might be arbitrarily out of
4661 * bounds after handling a DTLS message with an unexpected
4662 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004665 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4667 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4670 ssl->in_msg, ssl->in_msglen);
4671 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004672 ssl->in_msglen = 0;
4673 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004674
Hanno Becker4a810fb2017-05-24 16:27:30 +01004675 ssl->in_hslen = 0;
4676 }
4677 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 else if (ssl->in_offt != NULL) {
4679 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004680 }
4681 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004683 ssl->in_msglen = 0;
4684 }
4685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004687}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004688
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004689MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004690static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004691{
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (ssl->in_msglen > 0) {
4693 return 1;
4694 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004697}
4698
Hanno Becker5f066e72018-08-16 14:56:31 +01004699#if defined(MBEDTLS_SSL_PROTO_DTLS)
4700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004702{
4703 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004705 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004709 hs->buffering.total_bytes_buffered -=
4710 hs->buffering.future_record.len;
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004713 hs->buffering.future_record.data = NULL;
4714 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004715}
4716
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004717MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004718static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004719{
4720 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004722 size_t rec_len;
4723 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004724#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4725 size_t in_buf_len = ssl->in_buf_len;
4726#else
4727 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4728#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4730 return 0;
4731 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (hs == NULL) {
4734 return 0;
4735 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004736
Hanno Becker5f066e72018-08-16 14:56:31 +01004737 rec = hs->buffering.future_record.data;
4738 rec_len = hs->buffering.future_record.len;
4739 rec_epoch = hs->buffering.future_record.epoch;
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (rec == NULL) {
4742 return 0;
4743 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004744
Hanno Becker4cb782d2018-08-20 11:19:05 +01004745 /* Only consider loading future records if the
4746 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4748 return 0;
4749 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004752
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (rec_epoch != ssl->in_epoch) {
4754 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004755 goto exit;
4756 }
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004759
4760 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4762 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4763 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004764 }
4765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004767 ssl->in_left = rec_len;
4768 ssl->next_record_offset = 0;
4769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004771
4772exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4774 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004775}
4776
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004777MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004778static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4779 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004780{
4781 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004782
4783 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 if (hs == NULL) {
4785 return 0;
4786 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004787
4788 /* Only buffer handshake records (we are only interested
4789 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4791 return 0;
4792 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004793
4794 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if (hs->buffering.future_record.data != NULL) {
4796 return 0;
4797 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004798
Hanno Becker01315ea2018-08-21 17:22:17 +01004799 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4801 hs->buffering.total_bytes_buffered)) {
4802 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4803 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4804 " (already %" MBEDTLS_PRINTF_SIZET
4805 " bytes buffered) -- ignore\n",
4806 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4807 hs->buffering.total_bytes_buffered));
4808 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004809 }
4810
Hanno Becker5f066e72018-08-16 14:56:31 +01004811 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4813 ssl->in_epoch + 1U));
4814 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004815
4816 /* ssl_parse_record_header() only considers records
4817 * of the next epoch as candidates for buffering. */
4818 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004819 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004820
4821 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 mbedtls_calloc(1, hs->buffering.future_record.len);
4823 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004824 /* If we run out of RAM trying to buffer a
4825 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004827 }
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004830
Hanno Becker519f15d2019-07-11 12:43:20 +01004831 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004833}
4834
4835#endif /* MBEDTLS_SSL_PROTO_DTLS */
4836
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004837MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004838static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004839{
Janos Follath865b3eb2019-12-16 11:46:15 +00004840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004841 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004842
Hanno Becker5f066e72018-08-16 14:56:31 +01004843#if defined(MBEDTLS_SSL_PROTO_DTLS)
4844 /* We might have buffered a future record; if so,
4845 * and if the epoch matches now, load it.
4846 * On success, this call will set ssl->in_left to
4847 * the length of the buffered record, so that
4848 * the calls to ssl_fetch_input() below will
4849 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 ret = ssl_load_buffered_record(ssl);
4851 if (ret != 0) {
4852 return ret;
4853 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004854#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004855
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004856 /* Ensure that we have enough space available for the default form
4857 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4858 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4860 if (ret != 0) {
4861 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4862 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004863 }
4864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4866 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004867#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4869 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4870 ret = ssl_buffer_future_record(ssl, &rec);
4871 if (ret != 0) {
4872 return ret;
4873 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004874
4875 /* Fall through to handling of unexpected records */
4876 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4877 }
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004880#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004881 /* Reset in pointers to default state for TLS/DTLS records,
4882 * assuming no CID and no offset between record content and
4883 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004885
Hanno Becker7ae20e02019-07-12 08:33:49 +01004886 /* Setup internal message pointers from record structure. */
4887 ssl->in_msgtype = rec.type;
4888#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4889 ssl->in_len = ssl->in_cid + rec.cid_len;
4890#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4891 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4892 ssl->in_msglen = rec.data_len;
4893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 ret = ssl_check_client_reconnect(ssl);
4895 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4896 if (ret != 0) {
4897 return ret;
4898 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004899#endif
4900
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004901 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004902 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4905 "(header)"));
4906 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004907 /* Skip invalid record and the rest of the datagram */
4908 ssl->next_record_offset = 0;
4909 ssl->in_left = 0;
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4912 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004913 }
4914
4915 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4917 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004918#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004919 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004921 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004922 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004926 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004927 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (ssl->next_record_offset < ssl->in_left) {
4929 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004930 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004932#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004933 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004934 /*
4935 * Fetch record contents from underlying transport.
4936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4938 if (ret != 0) {
4939 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4940 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004941 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004942
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004943 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004944 }
4945
4946 /*
4947 * Decrypt record contents.
4948 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004953 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004955 /* Except when waiting for Finished as a bad mac here
4956 * probably means something went wrong in the handshake
4957 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4959 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004960#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4962 mbedtls_ssl_send_alert_message(ssl,
4963 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4964 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004965 }
4966#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004968 }
4969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (ssl->conf->badmac_limit != 0 &&
4971 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4972 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4973 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004974 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004975
Hanno Becker4a810fb2017-05-24 16:27:30 +01004976 /* As above, invalid records cause
4977 * dismissal of the whole datagram. */
4978
4979 ssl->next_record_offset = 0;
4980 ssl->in_left = 0;
4981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4983 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004984 }
4985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 return ret;
4987 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004988#endif
4989 {
4990 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004991#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4993 mbedtls_ssl_send_alert_message(ssl,
4994 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4995 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004996 }
4997#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004999 }
5000 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005001
Hanno Becker44d89b22019-07-12 09:40:44 +01005002
5003 /* Reset in pointers to default state for TLS/DTLS records,
5004 * assuming no CID and no offset between record content and
5005 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01005007#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5008 ssl->in_len = ssl->in_cid + rec.cid_len;
5009#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03005010 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01005011
Hanno Becker8685c822019-07-12 09:37:30 +01005012 /* The record content type may change during decryption,
5013 * so re-read it. */
5014 ssl->in_msgtype = rec.type;
5015 /* Also update the input buffer, because unfortunately
5016 * the server-side ssl_parse_client_hello() reparses the
5017 * record header when receiving a ClientHello initiating
5018 * a renegotiation. */
5019 ssl->in_hdr[0] = rec.type;
5020 ssl->in_msg = rec.buf + rec.data_offset;
5021 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01005023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01005025}
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01005028{
Janos Follath865b3eb2019-12-16 11:46:15 +00005029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01005030
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005031 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02005032 * Handle particular types of records
5033 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5035 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
5036 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01005037 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005038 }
5039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5041 if (ssl->in_msglen != 1) {
5042 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
5043 ssl->in_msglen));
5044 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005045 }
5046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if (ssl->in_msg[0] != 1) {
5048 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
5049 ssl->in_msg[0]));
5050 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005051 }
5052
5053#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01005055 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
5057 if (ssl->handshake == NULL) {
5058 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
5059 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005060 }
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
5063 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005064 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005065#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005066
Ronald Cron6f135e12021-12-08 16:57:54 +01005067#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005069#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 MBEDTLS_SSL_DEBUG_MSG(1,
5071 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5072 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005073#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 MBEDTLS_SSL_DEBUG_MSG(1,
5075 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5076 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005077#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5078 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005079#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005080 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5083 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005084 /* Note: Standard allows for more than one 2 byte alert
5085 to be packed in a single message, but Mbed TLS doesn't
5086 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5088 ssl->in_msglen));
5089 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005090 }
5091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5093 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005094
5095 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005096 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5099 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5100 ssl->in_msg[1]));
5101 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005102 }
5103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5105 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5106 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5107 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005108 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005109
5110#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5112 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5113 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005114 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005116 }
5117#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005118 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005119 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005120 }
5121
Hanno Beckerc76c6192017-06-06 10:03:17 +01005122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005124 /* Drop unexpected ApplicationData records,
5125 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5127 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005128#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5130 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005131#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 ) {
5133 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5134 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005135 }
5136
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (ssl->handshake != NULL &&
5138 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5139 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005140 }
5141 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005142#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005145}
5146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005148{
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 return mbedtls_ssl_send_alert_message(ssl,
5150 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5151 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005152}
5153
Gilles Peskine449bd832023-01-11 14:50:10 +01005154int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5155 unsigned char level,
5156 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005157{
Janos Follath865b3eb2019-12-16 11:46:15 +00005158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 if (ssl == NULL || ssl->conf == NULL) {
5161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5162 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (ssl->out_left != 0) {
5165 return mbedtls_ssl_flush_output(ssl);
5166 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5169 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005171 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005172 ssl->out_msglen = 2;
5173 ssl->out_msg[0] = level;
5174 ssl->out_msg[1] = message;
5175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5177 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5178 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005179 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005183}
5184
Gilles Peskine449bd832023-01-11 14:50:10 +01005185int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005186{
Janos Follath865b3eb2019-12-16 11:46:15 +00005187 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005192 ssl->out_msglen = 1;
5193 ssl->out_msg[0] = 1;
5194
Paul Bakker5121ce52009-01-03 21:22:43 +00005195 ssl->state++;
5196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5198 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5199 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005200 }
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005205}
5206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005208{
Janos Follath865b3eb2019-12-16 11:46:15 +00005209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005210
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5214 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5215 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005216 }
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5219 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5220 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5221 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5222 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005223 }
5224
Hanno Beckere678eaa2018-08-21 14:57:46 +01005225 /* CCS records are only accepted if they have length 1 and content '1',
5226 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005227
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005228 /*
5229 * Switch to our negotiated transform and session parameters for inbound
5230 * data.
5231 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005233#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005234 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005235#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005236 ssl->session_in = ssl->session_negotiate;
5237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005238#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005240#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005242#endif
5243
5244 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 if (++ssl->in_epoch == 0) {
5246 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005247 /* This is highly unlikely to happen for legitimate reasons, so
5248 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005256
Paul Bakker5121ce52009-01-03 21:22:43 +00005257 ssl->state++;
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005262}
5263
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005264/* Once ssl->out_hdr as the address of the beginning of the
5265 * next outgoing record is set, deduce the other pointers.
5266 *
5267 * Note: For TLS, we save the implicit record sequence number
5268 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5269 * and the caller has to make sure there's space for this.
5270 */
5271
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005272static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005274{
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005276}
5277
Gilles Peskine449bd832023-01-11 14:50:10 +01005278void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5279 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005280{
5281#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005283 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005284#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005285 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005286 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005288 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005290#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005291 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005292#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005293 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005295#endif
5296 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005297 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005298#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005299 ssl->out_cid = ssl->out_len;
5300#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005301 ssl->out_iv = ssl->out_hdr + 5;
5302 }
5303
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005304 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005305 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 if (transform != NULL) {
5307 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5308 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005309}
5310
5311/* Once ssl->in_hdr as the address of the beginning of the
5312 * next incoming record is set, deduce the other pointers.
5313 *
5314 * Note: For TLS, we save the implicit record sequence number
5315 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5316 * and the caller has to make sure there's space for this.
5317 */
5318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005320{
Hanno Becker79594fd2019-05-08 09:38:41 +01005321 /* This function sets the pointers to match the case
5322 * of unprotected TLS/DTLS records, with both ssl->in_iv
5323 * and ssl->in_msg pointing to the beginning of the record
5324 * content.
5325 *
5326 * When decrypting a protected record, ssl->in_msg
5327 * will be shifted to point to the beginning of the
5328 * record plaintext.
5329 */
5330
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005331#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005333 /* This sets the header pointers to match records
5334 * without CID. When we receive a record containing
5335 * a CID, the fields are shifted accordingly in
5336 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005337 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005338#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005339 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005340 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005341#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005342 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005343#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005344 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005346#endif
5347 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005348 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005349 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005350#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005351 ssl->in_cid = ssl->in_len;
5352#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005353 ssl->in_iv = ssl->in_hdr + 5;
5354 }
5355
Hanno Becker79594fd2019-05-08 09:38:41 +01005356 /* This will be adjusted at record decryption time. */
5357 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005358}
5359
Paul Bakker5121ce52009-01-03 21:22:43 +00005360/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005361 * Setup an SSL context
5362 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005363
Gilles Peskine449bd832023-01-11 14:50:10 +01005364void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005365{
5366 /* Set the incoming and outgoing record pointers. */
5367#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005369 ssl->out_hdr = ssl->out_buf;
5370 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005372#endif /* MBEDTLS_SSL_PROTO_DTLS */
5373 {
Hanno Becker12078f42021-03-02 15:28:41 +00005374 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005375 ssl->out_hdr = ssl->out_buf + 8;
5376 ssl->in_hdr = ssl->in_buf + 8;
5377 }
5378
5379 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5381 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005382}
5383
Paul Bakker5121ce52009-01-03 21:22:43 +00005384/*
5385 * SSL get accessors
5386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005387size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005388{
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005390}
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005393{
5394 /*
5395 * Case A: We're currently holding back
5396 * a message for further processing.
5397 */
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if (ssl->keep_current_message == 1) {
5400 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5401 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005402 }
5403
5404 /*
5405 * Case B: Further records are pending in the current datagram.
5406 */
5407
5408#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5410 ssl->in_left > ssl->next_record_offset) {
5411 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5412 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005413 }
5414#endif /* MBEDTLS_SSL_PROTO_DTLS */
5415
5416 /*
5417 * Case C: A handshake message is being processed.
5418 */
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5421 MBEDTLS_SSL_DEBUG_MSG(3,
5422 ("ssl_check_pending: more handshake messages within current record"));
5423 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005424 }
5425
5426 /*
5427 * Case D: An application data message is being processed
5428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (ssl->in_offt != NULL) {
5430 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5431 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005432 }
5433
5434 /*
5435 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005436 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005437 * we implement support for multiple alerts in single records.
5438 */
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5441 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005442}
5443
Paul Bakker43ca69c2011-01-15 17:35:19 +00005444
Gilles Peskine449bd832023-01-11 14:50:10 +01005445int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005446{
Hanno Becker3136ede2018-08-17 15:28:19 +01005447 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005449 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005450#if defined(MBEDTLS_USE_PSA_CRYPTO)
5451 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5452 psa_key_type_t key_type;
5453#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 if (transform == NULL) {
5458 return (int) out_hdr_len;
5459 }
Hanno Becker78640902018-08-13 16:35:15 +01005460
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005461
5462#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 if (transform->psa_alg == PSA_ALG_GCM ||
5464 transform->psa_alg == PSA_ALG_CCM ||
5465 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5466 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5467 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005468 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5470 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5471 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005474
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005475 /* Expansion due to the addition of the MAC. */
5476 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005477
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005478 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005479 * Theoretically up to 256 bytes, but we never use
5480 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005481 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005482
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005483 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005484 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005485#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005486 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005487#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 } else {
5489 MBEDTLS_SSL_DEBUG_MSG(1,
5490 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5491 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005492 }
5493#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495 case MBEDTLS_MODE_GCM:
5496 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005497 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005499 transform_expansion = transform->minlen;
5500 break;
5501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005503
5504 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005506
Hanno Becker3136ede2018-08-17 15:28:19 +01005507 /* Expansion due to the addition of the MAC. */
5508 transform_expansion += transform->maclen;
5509
5510 /* Expansion due to the addition of CBC padding;
5511 * Theoretically up to 256 bytes, but we never use
5512 * more than the block size of the underlying cipher. */
5513 transform_expansion += block_size;
5514
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005515 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005516 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005517#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005518 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005519#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005520
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005521 break;
5522
5523 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5525 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005526 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005528
Hanno Beckera0e20d02019-05-15 14:03:01 +01005529#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005531 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005533#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005536}
5537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005539/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005540 * Check record counters and renegotiate if they're above the limit.
5541 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005542MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005543static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005544{
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005546 int in_ctr_cmp;
5547 int out_ctr_cmp;
5548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5552 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005553 }
5554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5556 &ssl->conf->renego_period[ep_len],
5557 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5558 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005559 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005561
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5563 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005564 }
5565
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5567 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005568}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005569#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005570
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005571#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5572
Ronald Cron6071f612024-03-25 13:42:07 +01005573#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005574MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron698c8e92024-04-02 13:19:57 +02005575static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005576{
5577
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5579 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Cron698c8e92024-04-02 13:19:57 +02005580 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005581 }
5582
Ronald Cron698c8e92024-04-02 13:19:57 +02005583 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005584}
Ronald Cron6071f612024-03-25 13:42:07 +01005585#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005586
Jerry Yua0446a02022-07-13 11:22:55 +08005587MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005588static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005589{
5590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005592
Ronald Cron6071f612024-03-25 13:42:07 +01005593#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Cron698c8e92024-04-02 13:19:57 +02005595 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron6071f612024-03-25 13:42:07 +01005596#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5597 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
Ronald Crond67f8012024-08-28 07:45:57 +02005598 if (mbedtls_ssl_conf_is_new_session_tickets_enabled(ssl->conf) ==
5599 MBEDTLS_SSL_NEW_SESSION_TICKETS_ENABLED) {
Ronald Cronb675b2b2024-08-27 09:19:40 +02005600 ssl->keep_current_message = 1;
Ronald Cron6071f612024-03-25 13:42:07 +01005601
Ronald Cronb675b2b2024-08-27 09:19:40 +02005602 mbedtls_ssl_handshake_set_state(ssl,
5603 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5604 return MBEDTLS_ERR_SSL_WANT_READ;
5605 } else {
5606 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, disabled."));
5607 return 0;
5608 }
Ronald Cron6071f612024-03-25 13:42:07 +01005609#else
5610 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5611 return 0;
5612#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005614 }
Ronald Cron6071f612024-03-25 13:42:07 +01005615#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005616
5617 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005619}
5620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5621
5622#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005623/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005624 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005625 * may only be sent for the purpose of initiating renegotiations.
5626 *
5627 * This function is introduced as a separate helper since the handling
5628 * of post-handshake handshake messages changes significantly in TLS 1.3,
5629 * and having a helper function allows to distinguish between TLS <= 1.2 and
5630 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5631 */
Jerry Yua0446a02022-07-13 11:22:55 +08005632MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005633static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005634{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005635 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005636
5637 /*
5638 * - For client-side, expect SERVER_HELLO_REQUEST.
5639 * - For server-side, expect CLIENT_HELLO.
5640 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5641 */
5642
5643#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5645 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5646 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5647 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005648
5649 /* With DTLS, drop the packet (probably from last handshake) */
5650#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5652 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005653 }
5654#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005656 }
5657#endif /* MBEDTLS_SSL_CLI_C */
5658
5659#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5661 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5662 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005663
5664 /* With DTLS, drop the packet (probably from last handshake) */
5665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5667 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005668 }
5669#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005671 }
5672#endif /* MBEDTLS_SSL_SRV_C */
5673
5674#if defined(MBEDTLS_SSL_RENEGOTIATION)
5675 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5677 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5678 ssl->conf->allow_legacy_renegotiation ==
5679 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005680 /*
5681 * Accept renegotiation request
5682 */
5683
5684 /* DTLS clients need to know renego is server-initiated */
5685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5687 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005688 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5689 }
5690#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 ret = mbedtls_ssl_start_renegotiation(ssl);
5692 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5693 ret != 0) {
5694 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5695 ret);
5696 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005697 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005699#endif /* MBEDTLS_SSL_RENEGOTIATION */
5700 {
5701 /*
5702 * Refuse renegotiation
5703 */
5704
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005706
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5708 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5709 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5710 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005711 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005712 }
5713
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005715}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005716#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5717
5718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005719static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005720{
5721 /* Check protocol version and dispatch accordingly. */
5722#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5724 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005725 }
5726#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5727
5728#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5730 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005731 }
5732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5733
5734 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005736}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005737
Paul Bakker48916f92012-09-16 19:57:18 +00005738/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005739 * brief Read at most 'len' application data bytes from the input
5740 * buffer.
5741 *
5742 * param ssl SSL context:
5743 * - First byte of application data not read yet in the input
5744 * buffer located at address `in_offt`.
5745 * - The number of bytes of data not read yet is `in_msglen`.
5746 * param buf buffer that will hold the data
5747 * param len maximum number of bytes to read
5748 *
5749 * note The function updates the fields `in_offt` and `in_msglen`
5750 * according to the number of bytes read.
5751 *
5752 * return The number of bytes read.
5753 */
5754static int ssl_read_application_data(
5755 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5756{
5757 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5758
5759 if (len != 0) {
5760 memcpy(buf, ssl->in_offt, n);
5761 ssl->in_msglen -= n;
5762 }
5763
5764 /* Zeroising the plaintext buffer to erase unused application data
5765 from the memory. */
5766 mbedtls_platform_zeroize(ssl->in_offt, n);
5767
5768 if (ssl->in_msglen == 0) {
5769 /* all bytes consumed */
5770 ssl->in_offt = NULL;
5771 ssl->keep_current_message = 0;
5772 } else {
5773 /* more data available */
5774 ssl->in_offt += n;
5775 }
5776
5777 return (int) n;
5778}
5779
5780/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005781 * Receive application data decrypted from the SSL layer
5782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005783int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005784{
Janos Follath865b3eb2019-12-16 11:46:15 +00005785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005786
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 if (ssl == NULL || ssl->conf == NULL) {
5788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5789 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005790
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5795 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5796 return ret;
5797 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005798
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 if (ssl->handshake != NULL &&
5800 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5801 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5802 return ret;
5803 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005804 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005805 }
5806#endif
5807
Hanno Becker4a810fb2017-05-24 16:27:30 +01005808 /*
5809 * Check if renegotiation is necessary and/or handshake is
5810 * in process. If yes, perform/continue, and fall through
5811 * if an unexpected packet is received while the client
5812 * is waiting for the ServerHello.
5813 *
5814 * (There is no equivalent to the last condition on
5815 * the server-side as it is not treated as within
5816 * a handshake while waiting for the ClientHello
5817 * after a renegotiation request.)
5818 */
5819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005820#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 ret = ssl_check_ctr_renegotiate(ssl);
5822 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5823 ret != 0) {
5824 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5825 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005826 }
5827#endif
5828
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5830 ret = mbedtls_ssl_handshake(ssl);
5831 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5832 ret != 0) {
5833 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5834 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005835 }
5836 }
5837
Hanno Beckere41158b2017-10-23 13:30:32 +01005838 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005840 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (ssl->f_get_timer != NULL &&
5842 ssl->f_get_timer(ssl->p_timer) == -1) {
5843 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005844 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5847 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5848 return 0;
5849 }
Paul Bakker831a7552011-05-18 13:32:51 +00005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5852 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005853 }
5854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (ssl->in_msglen == 0 &&
5856 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005857 /*
5858 * OpenSSL sends empty messages to randomize the IV
5859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5861 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5862 return 0;
5863 }
Paul Bakker831a7552011-05-18 13:32:51 +00005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5866 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005867 }
5868 }
5869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5871 ret = ssl_handle_hs_message_post_handshake(ssl);
5872 if (ret != 0) {
5873 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5874 ret);
5875 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005876 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005877
Hanno Beckerf26cc722021-04-21 07:30:13 +01005878 /* At this point, we don't know whether the renegotiation triggered
5879 * by the post-handshake message has been completed or not. The cases
5880 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005881 * 1) The renegotiation is complete. In this case, no new record
5882 * has been read yet.
5883 * 2) The renegotiation is incomplete because the client received
5884 * an application data record while awaiting the ServerHello.
5885 * 3) The renegotiation is incomplete because the client received
5886 * a non-handshake, non-application data message while awaiting
5887 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005888 *
5889 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005890 * - For 1), the next iteration will read a new record and check
5891 * if it's application data.
5892 * - For 2), the loop condition isn't satisfied as application data
5893 * is present, hence continue is the same as break
5894 * - For 3), the loop condition is satisfied and read_record
5895 * will re-deliver the message that was held back by the client
5896 * when expecting the ServerHello.
5897 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005898
Hanno Becker90333da2017-10-10 11:27:13 +01005899 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005900 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005901#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5903 if (ssl->conf->renego_max_records >= 0) {
5904 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5905 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5906 "but not honored by client"));
5907 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005908 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005909 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005910 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005911#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005913 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5915 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5916 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005917 }
5918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5920 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5921 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005922 }
5923
5924 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005925
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005926 /* We're going to return something now, cancel timer,
5927 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5929 mbedtls_ssl_set_timer(ssl, 0);
5930 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005931
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005933 /* If we requested renego but received AppData, resend HelloRequest.
5934 * Do it now, after setting in_offt, to avoid taking this branch
5935 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005936#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5938 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5939 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5940 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5941 ret);
5942 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005943 }
5944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005945#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005946#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005947 }
5948
Jerry Yu739a1d42022-12-08 21:10:25 +08005949 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005952
Jerry Yu739a1d42022-12-08 21:10:25 +08005953 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005954}
5955
Jerry Yud9ca3542023-12-06 17:23:52 +08005956#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5957int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5958 unsigned char *buf, size_t len)
5959{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005960 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5962 }
5963
Ronald Cron164537c2024-02-01 18:05:47 +01005964 /*
5965 * The server may receive early data only while waiting for the End of
5966 * Early Data handshake message.
5967 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005968 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5969 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005970 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5971 }
5972
Ronald Croned7d4bf2024-01-31 07:55:19 +01005973 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005974}
5975#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5976
Paul Bakker5121ce52009-01-03 21:22:43 +00005977/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005978 * Send application data to be encrypted by the SSL layer, taking care of max
5979 * fragment length and buffer size.
5980 *
5981 * According to RFC 5246 Section 6.2.1:
5982 *
5983 * Zero-length fragments of Application data MAY be sent as they are
5984 * potentially useful as a traffic analysis countermeasure.
5985 *
5986 * Therefore, it is possible that the input message length is 0 and the
5987 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005988 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005989MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005990static int ssl_write_real(mbedtls_ssl_context *ssl,
5991 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005992{
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005994 const size_t max_len = (size_t) ret;
5995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 if (ret < 0) {
5997 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5998 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005999 }
6000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
6004 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
6005 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
6006 " > %" MBEDTLS_PRINTF_SIZET,
6007 len, max_len));
6008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6009 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006010#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006012 }
Paul Bakker887bd502011-06-08 13:10:54 +00006013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01006015 /*
6016 * The user has previously tried to send the data and
6017 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
6018 * written. In this case, we expect the high-level write function
6019 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
6020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
6022 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
6023 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006024 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01006026 /*
6027 * The user is trying to send a message the first time, so we need to
6028 * copy the data into the internal buffers and setup the data structure
6029 * to keep track of partial writes
6030 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02006031 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006032 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00006033 if (len > 0) {
6034 memcpy(ssl->out_msg, buf, len);
6035 }
Paul Bakker887bd502011-06-08 13:10:54 +00006036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
6038 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
6039 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00006040 }
Paul Bakker5121ce52009-01-03 21:22:43 +00006041 }
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00006044}
6045
6046/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006047 * Write application data (public-facing wrapper)
6048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006049int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006050{
Janos Follath865b3eb2019-12-16 11:46:15 +00006051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 if (ssl == NULL || ssl->conf == NULL) {
6056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6057 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006058
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02006059#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
6061 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
6062 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006063 }
6064#endif
6065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
6067 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
6068 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
6069 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006070 }
6071 }
6072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006078}
6079
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006080#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
6081int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
6082 const unsigned char *buf, size_t len)
6083{
6084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6085 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01006086 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006087
6088 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
6089
6090 if (ssl == NULL || (conf = ssl->conf) == NULL) {
6091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6092 }
6093
Ronald Cron49221902024-02-21 13:39:14 +01006094 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
6095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6096 }
6097
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006098 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
6099 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
6100 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
6101 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6102 }
6103
6104 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
6105 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6106 }
6107
6108 /*
Ronald Crond2884662024-03-03 15:03:22 +01006109 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006110 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01006111 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006112 * enough to be able to send early data if possible. That way, we can
6113 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01006114 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01006115 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
6116 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01006117 * as the early data outbound transform has not been set as we may have to
6118 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006119 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006120 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01006121 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01006122 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01006123 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006124 ret = mbedtls_ssl_handshake_step(ssl);
6125 if (ret != 0) {
6126 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
6127 return ret;
6128 }
6129
6130 ret = mbedtls_ssl_flush_output(ssl);
6131 if (ret != 0) {
6132 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
6133 return ret;
6134 }
6135 }
Ronald Cron62f971a2024-02-23 08:24:12 +01006136 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006137 } else {
Ronald Crond4069242024-02-21 13:45:52 +01006138 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01006139 * If we are past the point where we can send early data or we have
6140 * already reached the maximum early data size, return immediatly.
6141 * Otherwise, progress the handshake as much as possible to not delay
6142 * it too much. If we reach a point where we can still send early data,
6143 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01006144 */
Ronald Crond2884662024-03-03 15:03:22 +01006145 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
6146 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006147 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6148 }
6149
Ronald Cron62f971a2024-02-23 08:24:12 +01006150 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01006151 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01006152
6153 if (remaining == 0) {
6154 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6155 }
6156
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006157 ret = mbedtls_ssl_handshake(ssl);
6158 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
6159 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
6160 return ret;
6161 }
6162 }
6163
Ronald Crond2884662024-03-03 15:03:22 +01006164 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
6165 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01006166 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006167 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
6168 }
6169
Ronald Cron62f971a2024-02-23 08:24:12 +01006170 if (len > remaining) {
6171 len = remaining;
6172 }
6173
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006174 ret = ssl_write_real(ssl, buf, len);
6175 if (ret >= 0) {
6176 ssl->total_early_data_size += ret;
6177 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006178
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006179 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006180
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006181 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006182}
6183#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6184
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006185/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006186 * Notify the peer that the connection is being closed
6187 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006188int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006189{
Janos Follath865b3eb2019-12-16 11:46:15 +00006190 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (ssl == NULL || ssl->conf == NULL) {
6193 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6194 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6199 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6200 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6201 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6202 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6203 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006204 }
6205 }
6206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006210}
6211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006213{
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006215 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006217
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006218#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 psa_destroy_key(transform->psa_key_enc);
6220 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006221#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6223 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006224#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006225
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006226#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006227#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 psa_destroy_key(transform->psa_mac_enc);
6229 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006230#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 mbedtls_md_free(&transform->md_ctx_enc);
6232 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006233#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006234#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006237}
6238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6240 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006241{
Jerry Yuc7875b52021-09-05 21:05:50 +08006242 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006244}
6245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6247 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006248{
6249 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006251}
6252
Hanno Becker0271f962018-08-16 13:23:47 +01006253#if defined(MBEDTLS_SSL_PROTO_DTLS)
6254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006256{
6257 unsigned offset;
6258 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006261 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 }
Hanno Becker0271f962018-08-16 13:23:47 +01006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6267 ssl_buffering_free_slot(ssl, offset);
6268 }
Hanno Beckere605b192018-08-21 15:59:07 +01006269}
6270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6272 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006273{
6274 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6275 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006276
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006278 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006282 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006283 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006285 }
6286}
6287
6288#endif /* MBEDTLS_SSL_PROTO_DTLS */
6289
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006290/*
6291 * Convert version numbers to/from wire format
6292 * and, for DTLS, to/from TLS equivalent.
6293 *
6294 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006295 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006296 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006297 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006299void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6300 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006301{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006302 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006303#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006305 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006307 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006308#else
6309 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006310#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006311 {
6312 tls_version_formatted = (uint16_t) tls_version;
6313 }
6314 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006315}
6316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6318 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006319{
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006321#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006323 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6325 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006326#else
6327 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006328#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006329 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006330}
6331
Jerry Yue7047812021-09-13 19:26:39 +08006332/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006333 * Send pending fatal alert.
6334 * 0, No alert message.
6335 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6336 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006338int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006339{
6340 int ret;
6341
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006342 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 if (ssl->send_alert == 0) {
6344 return 0;
6345 }
Jerry Yu394ece62021-09-14 22:17:21 +08006346
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 ret = mbedtls_ssl_send_alert_message(ssl,
6348 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6349 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006350
Jerry Yu3bf1f972021-09-22 21:37:18 +08006351 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6352 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006355 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006356 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006357
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 if (ret != 0) {
6359 return ret;
6360 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006361
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006363}
6364
Jerry Yu394ece62021-09-14 22:17:21 +08006365/*
6366 * Set pending fatal alert flag.
6367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006368void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6369 unsigned char alert_type,
6370 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006371{
6372 ssl->send_alert = 1;
6373 ssl->alert_type = alert_type;
6374 ssl->alert_reason = alert_reason;
6375}
6376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006377#endif /* MBEDTLS_SSL_TLS_C */