blob: 39f63373000998e627066b872503a4992dbec6fa [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00007 */
8/*
Paul Bakker5121ce52009-01-03 21:22:43 +00009 * http://www.ietf.org/rfc/rfc2246.txt
10 * http://www.ietf.org/rfc/rfc4346.txt
11 */
12
Gilles Peskinedb09ef62020-06-03 01:43:33 +020013#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020015#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000016
SimonBd5800b72016-04-26 07:43:27 +010017#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010018
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000019#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000020#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000021#include "mbedtls/debug.h"
22#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050023#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010024#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020025#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020031#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050032#include "psa/crypto.h"
33#endif
34
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define a local translating function to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049#endif
50
Dave Rodgman2801f7f2023-05-09 11:00:07 +010051#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
52
53#if defined(MBEDTLS_USE_PSA_CRYPTO)
54
55#if defined(PSA_WANT_ALG_SHA_384)
56#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
57#elif defined(PSA_WANT_ALG_SHA_256)
58#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
59#else /* See check_config.h */
60#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
61#endif
62
63MBEDTLS_STATIC_TESTABLE
64int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
65 psa_algorithm_t mac_alg,
66 const unsigned char *add_data,
67 size_t add_data_len,
68 const unsigned char *data,
69 size_t data_len_secret,
70 size_t min_data_len,
71 size_t max_data_len,
72 unsigned char *output)
73{
74 /*
75 * This function breaks the HMAC abstraction and uses psa_hash_clone()
76 * extension in order to get constant-flow behaviour.
77 *
78 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
79 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
80 * patterns (see RFC 2104, sec. 2).
81 *
82 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
83 * hashing up to minlen, then cloning the context, and for each byte up
84 * to maxlen finishing up the hash computation, keeping only the
85 * correct result.
86 *
87 * Then we only need to compute HASH(okey + inner_hash) and we're done.
88 */
89 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
90 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
91 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
92 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
93 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
94 size_t hash_length;
95
96 unsigned char aux_out[PSA_HASH_MAX_SIZE];
97 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
98 size_t offset;
99 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
100
101 size_t mac_key_length;
102 size_t i;
103
104#define PSA_CHK(func_call) \
105 do { \
106 status = (func_call); \
107 if (status != PSA_SUCCESS) \
108 goto cleanup; \
109 } while (0)
110
111 /* Export MAC key
112 * We assume key length is always exactly the output size
113 * which is never more than the block size, thus we use block_size
114 * as the key buffer size.
115 */
116 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
117
118 /* Calculate ikey */
119 for (i = 0; i < mac_key_length; i++) {
120 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
121 }
122 for (; i < block_size; ++i) {
123 key_buf[i] = 0x36;
124 }
125
126 PSA_CHK(psa_hash_setup(&operation, hash_alg));
127
128 /* Now compute inner_hash = HASH(ikey + msg) */
129 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
130 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
131 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
132
133 /* Fill the hash buffer in advance with something that is
134 * not a valid hash (barring an attack on the hash and
135 * deliberately-crafted input), in case the caller doesn't
136 * check the return status properly. */
137 memset(output, '!', hash_size);
138
139 /* For each possible length, compute the hash up to that point */
140 for (offset = min_data_len; offset <= max_data_len; offset++) {
141 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
142 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
143 PSA_HASH_MAX_SIZE, &hash_length));
144 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100145 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100146 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100147
148 if (offset < max_data_len) {
149 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
150 }
151 }
152
153 /* Abort current operation to prepare for final operation */
154 PSA_CHK(psa_hash_abort(&operation));
155
156 /* Calculate okey */
157 for (i = 0; i < mac_key_length; i++) {
158 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
159 }
160 for (; i < block_size; ++i) {
161 key_buf[i] = 0x5C;
162 }
163
164 /* Now compute HASH(okey + inner_hash) */
165 PSA_CHK(psa_hash_setup(&operation, hash_alg));
166 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
167 PSA_CHK(psa_hash_update(&operation, output, hash_size));
168 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
169
170#undef PSA_CHK
171
172cleanup:
173 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
174 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
175
176 psa_hash_abort(&operation);
177 psa_hash_abort(&aux_operation);
178 return PSA_TO_MBEDTLS_ERR(status);
179}
180
181#undef MAX_HASH_BLOCK_LENGTH
182
183#else
184MBEDTLS_STATIC_TESTABLE
185int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
186 const unsigned char *add_data,
187 size_t add_data_len,
188 const unsigned char *data,
189 size_t data_len_secret,
190 size_t min_data_len,
191 size_t max_data_len,
192 unsigned char *output)
193{
194 /*
195 * This function breaks the HMAC abstraction and uses the md_clone()
196 * extension to the MD API in order to get constant-flow behaviour.
197 *
198 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
199 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
200 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
201 *
202 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
203 * minlen, then cloning the context, and for each byte up to maxlen
204 * finishing up the hash computation, keeping only the correct result.
205 *
206 * Then we only need to compute HASH(okey + inner_hash) and we're done.
207 */
208 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
209 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
210 * all of which have the same block size except SHA-384. */
211 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
212 const unsigned char * const ikey = ctx->hmac_ctx;
213 const unsigned char * const okey = ikey + block_size;
214 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
215
216 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
217 mbedtls_md_context_t aux;
218 size_t offset;
219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
220
221 mbedtls_md_init(&aux);
222
223#define MD_CHK(func_call) \
224 do { \
225 ret = (func_call); \
226 if (ret != 0) \
227 goto cleanup; \
228 } while (0)
229
230 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
231
232 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
233 * so we can start directly with the message */
234 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
235 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
236
237 /* Fill the hash buffer in advance with something that is
238 * not a valid hash (barring an attack on the hash and
239 * deliberately-crafted input), in case the caller doesn't
240 * check the return status properly. */
241 memset(output, '!', hash_size);
242
243 /* For each possible length, compute the hash up to that point */
244 for (offset = min_data_len; offset <= max_data_len; offset++) {
245 MD_CHK(mbedtls_md_clone(&aux, ctx));
246 MD_CHK(mbedtls_md_finish(&aux, aux_out));
247 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100248 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100249 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100250
251 if (offset < max_data_len) {
252 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
253 }
254 }
255
256 /* The context needs to finish() before it starts() again */
257 MD_CHK(mbedtls_md_finish(ctx, aux_out));
258
259 /* Now compute HASH(okey + inner_hash) */
260 MD_CHK(mbedtls_md_starts(ctx));
261 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
262 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
263 MD_CHK(mbedtls_md_finish(ctx, output));
264
265 /* Done, get ready for next time */
266 MD_CHK(mbedtls_md_hmac_reset(ctx));
267
268#undef MD_CHK
269
270cleanup:
271 mbedtls_md_free(&aux);
272 return ret;
273}
274
275#endif /* MBEDTLS_USE_PSA_CRYPTO */
276
277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
278
Gilles Peskine449bd832023-01-11 14:50:10 +0100279static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100280
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200281/*
282 * Start a timer.
283 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200284 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100285void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200286{
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200288 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
292 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293}
294
295/*
296 * Return -1 is timer is expired, 0 if it isn't.
297 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200299{
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (ssl->f_get_timer == NULL) {
301 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200302 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 if (ssl->f_get_timer(ssl->p_timer) == 2) {
305 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
306 return -1;
307 }
308
309 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200310}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100313static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
314 unsigned char *buf,
315 size_t len,
316 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200317
Gilles Peskine449bd832023-01-11 14:50:10 +0100318int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
319 unsigned char *buf,
320 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200321{
322 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
324 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200325
326 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200327 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200328 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200330 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
331 goto exit;
332 }
333#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200335 mbedtls_record rec;
336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
338 if (ret != 0) {
339 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 goto exit;
341 }
342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 if (ssl->transform_in != NULL) {
344 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
345 if (ret != 0) {
346 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 goto exit;
348 }
349 }
350 }
351#endif /* MBEDTLS_SSL_PROTO_DTLS */
352
353exit:
354 /* On success, we have decrypted the buffer in-place, so make
355 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200357
358 /* For the purpose of this API, treat messages with unexpected CID
359 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
361 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200362 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
363 }
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
366 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200367}
368
Hanno Becker67bc7c32018-08-06 11:33:50 +0100369#define SSL_DONT_FORCE_FLUSH 0
370#define SSL_FORCE_FLUSH 1
371
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100373
Hanno Beckerd5847772018-08-28 10:09:23 +0100374/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100375static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
376 uint8_t slot);
377static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200378MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100379static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100381static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200382MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100383static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100385static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
386 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100388static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100391{
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000393#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
394 size_t out_buf_len = ssl->out_buf_len;
395#else
396 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
397#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (mtu != 0 && mtu < out_buf_len) {
400 return mtu;
401 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100402
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100404}
405
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100407static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100408{
Hanno Becker11682cc2018-08-22 14:41:02 +0100409 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100411
412 /* Double-check that the write-index hasn't gone
413 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100415 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100417 }
418
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420}
421
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100423static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100424{
Janos Follath865b3eb2019-12-16 11:46:15 +0000425 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100426 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400427 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100428
429#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100431
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100433 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100435
436 /* By the standard (RFC 6066 Sect. 4), the MFL extension
437 * only limits the maximum record payload size, so in theory
438 * we would be allowed to pack multiple records of payload size
439 * MFL into a single datagram. However, this would mean that there's
440 * no way to explicitly communicate MTU restrictions to the peer.
441 *
442 * The following reduction of max_len makes sure that we never
443 * write datagrams larger than MFL + Record Expansion Overhead.
444 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (max_len <= ssl->out_left) {
446 return 0;
447 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100448
449 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100450#endif
451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 ret = ssl_get_remaining_space_in_datagram(ssl);
453 if (ret < 0) {
454 return ret;
455 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100456 remaining = (size_t) ret;
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 ret = mbedtls_ssl_get_record_expansion(ssl);
459 if (ret < 0) {
460 return ret;
461 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462 expansion = (size_t) ret;
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 if (remaining <= expansion) {
465 return 0;
466 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100467
468 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100470 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474}
475
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200476/*
477 * Double the retransmit timeout value, within the allowed range,
478 * returning -1 if the maximum value has already been reached.
479 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100481static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200482{
483 uint32_t new_timeout;
484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
486 return -1;
487 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200489 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
490 * in the following way: after the initial transmission and a first
491 * retransmission, back off to a temporary estimated MTU of 508 bytes.
492 * This value is guaranteed to be deliverable (if not guaranteed to be
493 * delivered) of any compliant IPv4 (and IPv6) network, and should work
494 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200496 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400498 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200499
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500 new_timeout = 2 * ssl->handshake->retransmit_timeout;
501
502 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (new_timeout < ssl->handshake->retransmit_timeout ||
504 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200505 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200506 }
507
508 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
510 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200513}
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200516{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
519 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200520}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200522
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100523/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000524 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200525 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000526
Ronald Cron6f135e12021-12-08 16:57:54 +0100527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100528
Gilles Peskine449bd832023-01-11 14:50:10 +0100529static size_t ssl_compute_padding_length(size_t len,
530 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100531{
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100533}
534
Hanno Becker581bc1b2020-05-04 12:20:03 +0100535/* This functions transforms a (D)TLS plaintext fragment and a record content
536 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
537 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
538 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100539 *
540 * struct {
541 * opaque content[DTLSPlaintext.length];
542 * ContentType real_type;
543 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100544 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100545 *
546 * Input:
547 * - `content`: The beginning of the buffer holding the
548 * plaintext to be wrapped.
549 * - `*content_size`: The length of the plaintext in Bytes.
550 * - `max_len`: The number of Bytes available starting from
551 * `content`. This must be `>= *content_size`.
552 * - `rec_type`: The desired record content type.
553 *
554 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100555 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
556 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Returns:
559 * - `0` on success.
560 * - A negative error code if `max_len` didn't offer enough space
561 * for the expansion.
562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100564static int ssl_build_inner_plaintext(unsigned char *content,
565 size_t *content_size,
566 size_t remaining,
567 uint8_t rec_type,
568 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569{
570 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100571
572 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (remaining == 0) {
574 return -1;
575 }
576 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100577 len++;
578 remaining--;
579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 if (remaining < pad) {
581 return -1;
582 }
583 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100584 len += pad;
585 remaining -= pad;
586
587 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589}
590
Hanno Becker581bc1b2020-05-04 12:20:03 +0100591/* This function parses a (D)TLSInnerPlaintext structure.
592 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200593MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100594static int ssl_parse_inner_plaintext(unsigned char const *content,
595 size_t *content_size,
596 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100597{
598 size_t remaining = *content_size;
599
600 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 do {
602 if (remaining == 0) {
603 return -1;
604 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100605 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100607
608 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100610
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100612}
Ronald Cron6f135e12021-12-08 16:57:54 +0100613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100614
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200615/* The size of the `add_data` structure depends on various
616 * factors, namely
617 *
618 * 1) CID functionality disabled
619 *
620 * additional_data =
621 * 8: seq_num +
622 * 1: type +
623 * 2: version +
624 * 2: length of inner plaintext +
625 *
626 * size = 13 bytes
627 *
628 * 2) CID functionality based on RFC 9146 enabled
629 *
630 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
631 * = 23 + CID-length
632 *
633 * 3) CID functionality based on legacy CID version
634 according to draft-ietf-tls-dtls-connection-id-05
635 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
636 *
637 * size = 13 + 1 + CID-length
638 *
639 * More information about the CID usage:
640 *
641 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
642 * size of the additional data structure is calculated as:
643 *
644 * additional_data =
645 * 8: seq_num +
646 * 1: tls12_cid +
647 * 2: DTLSCipherText.version +
648 * n: cid +
649 * 1: cid_length +
650 * 2: length_of_DTLSInnerPlaintext
651 *
652 * Per RFC 9146 the size of the add_data structure is calculated as:
653 *
654 * additional_data =
655 * 8: seq_num_placeholder +
656 * 1: tls12_cid +
657 * 1: cid_length +
658 * 1: tls12_cid +
659 * 2: DTLSCiphertext.version +
660 * 2: epoch +
661 * 6: sequence_number +
662 * n: cid +
663 * 2: length_of_DTLSInnerPlaintext
664 *
665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666static void ssl_extract_add_data_from_record(unsigned char *add_data,
667 size_t *add_data_len,
668 mbedtls_record *rec,
669 mbedtls_ssl_protocol_version
670 tls_version,
671 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000672{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200673 /* Several types of ciphers have been defined for use with TLS and DTLS,
674 * and the MAC calculations for those ciphers differ slightly. Further
675 * variants were added when the CID functionality was added with RFC 9146.
676 * This implementations also considers the use of a legacy version of the
677 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
678 * which is used in deployments.
679 *
680 * We will distinguish between the non-CID and the CID cases below.
681 *
682 * --- Non-CID cases ---
683 *
684 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100685 *
686 * additional_data = seq_num + TLSCompressed.type +
687 * TLSCompressed.version + TLSCompressed.length;
688 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100689 * For TLS 1.3, the record sequence number is dropped from the AAD
690 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000691 * Moreover, the additional data involves the length of the TLS
692 * ciphertext, not the TLS plaintext as in earlier versions.
693 * Quoting RFC 8446 (TLS 1.3):
694 *
695 * additional_data = TLSCiphertext.opaque_type ||
696 * TLSCiphertext.legacy_record_version ||
697 * TLSCiphertext.length
698 *
699 * We pass the tag length to this function in order to compute the
700 * ciphertext length from the inner plaintext length rec->data_len via
701 *
702 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
703 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200704 * --- CID cases ---
705 *
706 * RFC 9146 uses a common pattern when constructing the data
707 * passed into a MAC / AEAD cipher.
708 *
709 * Data concatenation for MACs used with block ciphers with
710 * Encrypt-then-MAC Processing (with CID):
711 *
712 * data = seq_num_placeholder +
713 * tls12_cid +
714 * cid_length +
715 * tls12_cid +
716 * DTLSCiphertext.version +
717 * epoch +
718 * sequence_number +
719 * cid +
720 * DTLSCiphertext.length +
721 * IV +
722 * ENC(content + padding + padding_length)
723 *
724 * Data concatenation for MACs used with block ciphers (with CID):
725 *
726 * data = seq_num_placeholder +
727 * tls12_cid +
728 * cid_length +
729 * tls12_cid +
730 * DTLSCiphertext.version +
731 * epoch +
732 * sequence_number +
733 * cid +
734 * length_of_DTLSInnerPlaintext +
735 * DTLSInnerPlaintext.content +
736 * DTLSInnerPlaintext.real_type +
737 * DTLSInnerPlaintext.zeros
738 *
739 * AEAD ciphers use the following additional data calculation (with CIDs):
740 *
741 * additional_data = seq_num_placeholder +
742 * tls12_cid +
743 * cid_length +
744 * tls12_cid +
745 * DTLSCiphertext.version +
746 * epoch +
747 * sequence_number +
748 * cid +
749 * length_of_DTLSInnerPlaintext
750 *
751 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
752 * defines the additional data calculation as follows:
753 *
754 * additional_data = seq_num +
755 * tls12_cid +
756 * DTLSCipherText.version +
757 * cid +
758 * cid_length +
759 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100761
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100762 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000763 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100764
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200765#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
766 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
767 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
768#endif
769
Ronald Cron6f135e12021-12-08 16:57:54 +0100770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000772 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
773 * which differs from the length of the TLSInnerPlaintext
774 * by the length of the authentication tag. */
775 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100778 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400779 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000780 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200781
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100782#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
784 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200785 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
787 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200788
789 // tls12_cid type
790 *cur = rec->type;
791 cur++;
792
793 // cid_length
794 *cur = rec->cid_len;
795 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200798 {
799 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 memcpy(cur, rec->ctr, sizeof(rec->ctr));
801 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200802 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100803 }
804
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200805 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100806 *cur = rec->type;
807 cur++;
808
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200809 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 memcpy(cur, rec->ver, sizeof(rec->ver));
811 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100812
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200813#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
814 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // CID
818 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100819 cur += rec->cid_len;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100822 *cur = rec->cid_len;
823 cur++;
824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825 // length of inner plaintext
826 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
827 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
830 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // epoch + sequence number
834 memcpy(cur, rec->ctr, sizeof(rec->ctr));
835 cur += sizeof(rec->ctr);
836
837 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200839 cur += rec->cid_len;
840
841 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100843 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100845#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100846 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100848 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100849 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100850
851 *add_data_len = 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 */
1215 data, rec->buf_len - (data - rec->buf), /* dst */
1216 &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
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1639 iv, transform->ivlen,
1640 add_data, add_data_len,
1641 data, rec->data_len + transform->taglen, /* src */
1642 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1643 transform->taglen)) != 0) {
1644 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001645
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1647 return MBEDTLS_ERR_SSL_INVALID_MAC;
1648 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001651 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001652#endif /* MBEDTLS_USE_PSA_CRYPTO */
1653
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001654 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001655
Hanno Beckerd96a6522019-07-10 13:55:25 +01001656 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 if (olen != rec->data_len) {
1658 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1659 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001660 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 } else
Valerio Settie5707042023-10-11 11:54:42 +02001662#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001663#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1665 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001666 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001668 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001669 size_t part_len;
1670 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1671#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001672
Paul Bakker5121ce52009-01-03 21:22:43 +00001673 /*
Paul Bakker45829992013-01-03 14:52:21 +01001674 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001675 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001676#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001677 /* The ciphertext is prefixed with the CBC IV. */
1678 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001679#endif
Paul Bakker45829992013-01-03 14:52:21 +01001680
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001681 /* Size considerations:
1682 *
1683 * - The CBC cipher text must not be empty and hence
1684 * at least of size transform->ivlen.
1685 *
1686 * Together with the potential IV-prefix, this explains
1687 * the first of the two checks below.
1688 *
1689 * - The record must contain a MAC, either in plain or
1690 * encrypted, depending on whether Encrypt-then-MAC
1691 * is used or not.
1692 * - If it is, the message contains the IV-prefix,
1693 * the CBC ciphertext, and the MAC.
1694 * - If it is not, the padded plaintext, and hence
1695 * the CBC ciphertext, has at least length maclen + 1
1696 * because there is at least the padding length byte.
1697 *
1698 * As the CBC ciphertext is not empty, both cases give the
1699 * lower bound minlen + maclen + 1 on the record size, which
1700 * we test for in the second check below.
1701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 if (rec->data_len < minlen + transform->ivlen ||
1703 rec->data_len < minlen + transform->maclen + 1) {
1704 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1705 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1706 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1707 "+ 1 ) ( + expl IV )",
1708 rec->data_len,
1709 transform->ivlen,
1710 transform->maclen));
1711 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001712 }
1713
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001714 /*
1715 * Authenticate before decrypt if enabled
1716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001719#if defined(MBEDTLS_USE_PSA_CRYPTO)
1720 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1721#else
Hanno Becker992b6872017-11-09 18:57:39 +00001722 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001723#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001726
Hanno Beckerd96a6522019-07-10 13:55:25 +01001727 /* Update data_len in tandem with add_data.
1728 *
1729 * The subtraction is safe because of the previous check
1730 * data_len >= minlen + maclen + 1.
1731 *
1732 * Afterwards, we know that data + data_len is followed by at
1733 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001734 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001735 *
1736 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001737 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1739 transform->tls_version,
1740 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001741
Hanno Beckerd96a6522019-07-10 13:55:25 +01001742 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1744 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001745#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1747 transform->psa_mac_alg);
1748 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001749 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001751
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 status = psa_mac_update(&operation, add_data, add_data_len);
1753 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001754 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 status = psa_mac_update(&operation, data, rec->data_len);
1758 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001759 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001761
1762 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1764 transform->maclen);
1765 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001766 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001768#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1770 add_data_len);
1771 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001772 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 }
1774 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1775 data, rec->data_len);
1776 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001777 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 }
1779 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1780 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001781 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 }
1783 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1784 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001785 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001787
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1789 transform->maclen);
1790 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1791 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001792
Hanno Beckerd96a6522019-07-10 13:55:25 +01001793 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1795 transform->maclen) != 0) {
1796 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001797 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1798 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001799 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001800#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001801 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001804#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001805 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 status = psa_mac_abort(&operation);
1807 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001808 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001810#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001812#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 if (ret != 0) {
1814 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1815 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1816 }
1817 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001818 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001819 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001821
1822 /*
1823 * Check length sanity
1824 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001825
1826 /* We know from above that data_len > minlen >= 0,
1827 * so the following check in particular implies that
1828 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (rec->data_len % transform->ivlen != 0) {
1830 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1831 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1832 rec->data_len, transform->ivlen));
1833 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001834 }
1835
TRodziewicz0f82ec62021-05-12 17:49:18 +02001836#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001837 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001838 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001839 */
TRodziewicz345165c2021-07-06 13:42:11 +02001840 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001842
TRodziewicz345165c2021-07-06 13:42:11 +02001843 data += transform->ivlen;
1844 rec->data_offset += transform->ivlen;
1845 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001846#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001847
Hanno Beckerd96a6522019-07-10 13:55:25 +01001848 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1849
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001850#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 status = psa_cipher_decrypt_setup(&cipher_op,
1852 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001855 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1857 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001858 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001863 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1865 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001866 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 status = psa_cipher_update(&cipher_op,
1869 data, rec->data_len,
1870 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001873 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1875 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001876 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 status = psa_cipher_finish(&cipher_op,
1879 data + olen, rec->data_len - olen,
1880 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001883 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1885 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001886 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001887
1888 olen += part_len;
1889#else
1890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1892 transform->iv_dec, transform->ivlen,
1893 data, rec->data_len, data, &olen)) != 0) {
1894 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1895 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001896 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001897#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001898
Hanno Beckerd96a6522019-07-10 13:55:25 +01001899 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 if (rec->data_len != olen) {
1901 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001903 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001904
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001905 /* Safe since data_len >= minlen + maclen + 1, so after having
1906 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001907 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1908 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001909 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001912 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 rec->data_len,
1914 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001915 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001916 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 if (rec->data_len < transform->maclen + padlen + 1) {
1920 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1921 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1922 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1923 rec->data_len,
1924 transform->maclen,
1925 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001926 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001927#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001928 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 rec->data_len,
1930 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001931 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001932 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001933 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001934
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001935 padlen++;
1936
1937 /* Regardless of the validity of the padding,
1938 * we have data_len >= padlen here. */
1939
TRodziewicz0f82ec62021-05-12 17:49:18 +02001940#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001941 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 * consecutive memory reads at the end of the record
1943 * plaintext buffer. In order to hide the length and
1944 * validity of the padding, always perform exactly
1945 * `min(256,plaintext_len)` reads (but take into account
1946 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001947 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001949
1950 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001952 size_t const padding_idx = rec->data_len - padlen;
1953 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1954 size_t const start_idx = rec->data_len - num_checks;
1955 size_t idx;
1956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001958 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 * (check[idx] == padlen - 1);
1960 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001961 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001962 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001963 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001964 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001965 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001966 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001967 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001970 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1972 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001973#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001974 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001975
TRodziewicz0f82ec62021-05-12 17:49:18 +02001976#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001977
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001978 /* If the padding was found to be invalid, padlen == 0
1979 * and the subtraction is safe. If the padding was found valid,
1980 * padlen hasn't been changed and the previous assertion
1981 * data_len >= padlen still holds. */
1982 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001984#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001985 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1987 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001988 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001989
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001990#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1992 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001993#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001994
1995 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001996 * Authenticate if not done yet.
1997 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001998 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001999#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002001 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2002 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002003
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002004 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002005 * data_len < maclen + padlen + 1, then padlen
2006 * got reset to 1, and the initial check
2007 * data_len >= minlen + maclen + 1
2008 * guarantees that at this point we still
2009 * have at least data_len >= maclen.
2010 *
2011 * If the initial value of padlen was such that
2012 * data_len >= maclen + padlen + 1, then we have
2013 * subtracted either padlen + 1 (if the padding was correct)
2014 * or 0 (if the padding was incorrect) since then,
2015 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002016 *
2017 * For stream ciphers, we checked above that
2018 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002019 */
2020 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2022 transform->tls_version,
2023 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002024
TRodziewicz0f82ec62021-05-12 17:49:18 +02002025#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002026 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 * The next two sizes are the minimum and maximum values of
2028 * data_len over all padlen values.
2029 *
2030 * They're independent of padlen, since we previously did
2031 * data_len -= padlen.
2032 *
2033 * Note that max_len + maclen is never more than the buffer
2034 * length, as we previously did in_msglen -= maclen too.
2035 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002036 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002038
Neil Armstronge8589962022-02-25 15:14:29 +01002039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2041 transform->psa_mac_alg,
2042 add_data, add_data_len,
2043 data, rec->data_len, min_len, max_len,
2044 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002045#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2047 add_data, add_data_len,
2048 data, rec->data_len, min_len, max_len,
2049 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002050#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (ret != 0) {
2052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002053 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002054 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 mbedtls_ct_memcpy_offset(mac_peer, data,
2057 rec->data_len,
2058 min_len, max_len,
2059 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002060#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002062#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2064 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002065#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2068 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002071#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002072 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002073 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002074 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076hmac_failed_etm_disabled:
2077 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2078 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2079 if (ret != 0) {
2080 return ret;
2081 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002082 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002083
2084 /*
2085 * Finally check the correct flag
2086 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002087 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return MBEDTLS_ERR_SSL_INVALID_MAC;
2089 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002090#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002091
2092 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (auth_done != 1) {
2094 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2095 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002096 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
Ronald Cron6f135e12021-12-08 16:57:54 +01002098#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002100 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2102 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ret != 0) {
2105 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2106 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002107 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002108#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002109
Hanno Beckera0e20d02019-05-15 14:03:01 +01002110#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (rec->cid_len != 0) {
2112 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2113 &rec->type);
2114 if (ret != 0) {
2115 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2116 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002117 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002118#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002123}
2124
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002125#undef MAC_NONE
2126#undef MAC_PLAINTEXT
2127#undef MAC_CIPHERTEXT
2128
Paul Bakker5121ce52009-01-03 21:22:43 +00002129/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002130 * Fill the input message buffer by appending data to it.
2131 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002132 *
2133 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2134 * available (from this read and/or a previous one). Otherwise, an error code
2135 * is returned (possibly EOF or WANT_READ).
2136 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002137 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2138 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2139 * since we always read a whole datagram at once.
2140 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002141 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002142 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002144int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002145{
Janos Follath865b3eb2019-12-16 11:46:15 +00002146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002147 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002148#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2149 size_t in_buf_len = ssl->in_buf_len;
2150#else
2151 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2152#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2157 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2158 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002159 }
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2162 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002164 }
2165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002168 uint32_t timeout;
2169
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002170 /*
2171 * The point is, we need to always read a full datagram at once, so we
2172 * sometimes read more then requested, and handle the additional data.
2173 * It could be the rest of the current record (while fetching the
2174 * header) and/or some other records in the same datagram.
2175 */
2176
2177 /*
2178 * Move to the next record in the already read datagram if applicable
2179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (ssl->next_record_offset != 0) {
2181 if (ssl->in_left < ssl->next_record_offset) {
2182 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2183 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002184 }
2185
2186 ssl->in_left -= ssl->next_record_offset;
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (ssl->in_left != 0) {
2189 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2190 MBEDTLS_PRINTF_SIZET,
2191 ssl->next_record_offset));
2192 memmove(ssl->in_hdr,
2193 ssl->in_hdr + ssl->next_record_offset,
2194 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002195 }
2196
2197 ssl->next_record_offset = 0;
2198 }
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2201 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2202 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002203
2204 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002205 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (nb_want <= ssl->in_left) {
2208 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2209 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002210 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002211
2212 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002213 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002214 * are not at the beginning of a new record, the caller did something
2215 * wrong.
2216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->in_left != 0) {
2218 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2219 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002220 }
2221
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002222 /*
2223 * Don't even try to read if time's out already.
2224 * This avoids by-passing the timer when repeatedly receiving messages
2225 * that will end up being dropped.
2226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (mbedtls_ssl_check_timer(ssl) != 0) {
2228 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002229 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 } else {
2231 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002234 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002236 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (ssl->f_recv_timeout != NULL) {
2242 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2243 timeout);
2244 } else {
2245 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2246 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ret == 0) {
2251 return MBEDTLS_ERR_SSL_CONN_EOF;
2252 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002253 }
2254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2256 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2257 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2260 if (ssl_double_retransmit_timeout(ssl) != 0) {
2261 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2262 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002263 }
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2266 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2267 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002268 }
2269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002271 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2274 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2275 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2277 ret);
2278 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002279 }
2280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002282 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002284 }
2285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 if (ret < 0) {
2287 return ret;
2288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002289
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002290 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002292#endif
2293 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2295 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2296 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002299 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002302 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 } else {
2304 if (ssl->f_recv_timeout != NULL) {
2305 ret = ssl->f_recv_timeout(ssl->p_bio,
2306 ssl->in_hdr + ssl->in_left, len,
2307 ssl->conf->read_timeout);
2308 } else {
2309 ret = ssl->f_recv(ssl->p_bio,
2310 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002311 }
2312 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2315 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2316 ssl->in_left, nb_want));
2317 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if (ret == 0) {
2320 return MBEDTLS_ERR_SSL_CONN_EOF;
2321 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (ret < 0) {
2324 return ret;
2325 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002326
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002327 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 MBEDTLS_SSL_DEBUG_MSG(1,
2329 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2330 " were requested",
2331 ret, len));
2332 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002333 }
2334
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002335 ssl->in_left += ret;
2336 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002337 }
2338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002342}
2343
2344/*
2345 * Flush any data not yet written
2346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002347int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002348{
Janos Follath865b3eb2019-12-16 11:46:15 +00002349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002350 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (ssl->f_send == NULL) {
2355 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002357 }
2358
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002359 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (ssl->out_left == 0) {
2361 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2362 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002363 }
2364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 while (ssl->out_left > 0) {
2366 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2367 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2368 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002369
Hanno Becker2b1e3542018-08-06 11:19:13 +01002370 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (ret <= 0) {
2376 return ret;
2377 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002378
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002379 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_DEBUG_MSG(1,
2381 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2382 " bytes were sent",
2383 ret, ssl->out_left));
2384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002385 }
2386
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 ssl->out_left -= ret;
2388 }
2389
Hanno Becker2b1e3542018-08-06 11:19:13 +01002390#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002392 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002394#endif
2395 {
2396 ssl->out_hdr = ssl->out_buf + 8;
2397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002403}
2404
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002405/*
2406 * Functions to handle the DTLS retransmission state machine
2407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002409/*
2410 * Append current handshake message to current outgoing flight
2411 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002413static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002414{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2417 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2418 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002419
2420 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2422 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2423 sizeof(mbedtls_ssl_flight_item)));
2424 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425 }
2426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2428 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2429 ssl->out_msglen));
2430 mbedtls_free(msg);
2431 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002432 }
2433
2434 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002436 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002437 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002438 msg->next = NULL;
2439
2440 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002442 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002446 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448 cur->next = msg;
2449 }
2450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2452 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002453}
2454
2455/*
2456 * Free the current flight of handshake messages
2457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002458void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002459{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 mbedtls_ssl_flight_item *cur = flight;
2461 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464 next = cur->next;
2465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_free(cur->p);
2467 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002468
2469 cur = next;
2470 }
2471}
2472
2473/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002474 * Swap transform_out and out_ctr with the alternative ones
2475 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002477static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002478{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002480 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2483 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2484 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002485 }
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002488
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002489 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002490 tmp_transform = ssl->transform_out;
2491 ssl->transform_out = ssl->handshake->alt_transform_out;
2492 ssl->handshake->alt_transform_out = tmp_transform;
2493
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002494 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2496 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2497 sizeof(ssl->cur_out_ctr));
2498 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2499 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002500
2501 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002505}
2506
2507/*
2508 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002510int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002511{
2512 int ret = 0;
2513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521}
2522
2523/*
2524 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002525 *
2526 * Need to remember the current message in case flush_output returns
2527 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002528 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002530int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002531{
Janos Follath865b3eb2019-12-16 11:46:15 +00002532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2536 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002537
2538 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002539 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 ret = ssl_swap_epochs(ssl);
2541 if (ret != 0) {
2542 return ret;
2543 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002549 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002550 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002551
Hanno Beckere1dcb032018-08-17 16:47:58 +01002552 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2554 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002555
Ronald Cron00d012f22022-03-08 15:57:12 +01002556 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002558
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002559 /* Swap epochs before sending Finished: we can't do it after
2560 * sending ChangeCipherSpec, in case write returns WANT_READ.
2561 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2563 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2564 ret = ssl_swap_epochs(ssl);
2565 if (ret != 0) {
2566 return ret;
2567 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002568 }
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 ret = ssl_get_remaining_payload_in_datagram(ssl);
2571 if (ret < 0) {
2572 return ret;
2573 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002574 max_frag_len = (size_t) ret;
2575
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002576 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2578 if (max_frag_len == 0) {
2579 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2580 return ret;
2581 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002582
2583 continue;
2584 }
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002587 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002588 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002589
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002590 /* Update position inside current message */
2591 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002593 const unsigned char * const p = ssl->handshake->cur_msg_p;
2594 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002596 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002597 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2600 if (is_finished) {
2601 ret = ssl_swap_epochs(ssl);
2602 if (ret != 0) {
2603 return ret;
2604 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002605 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2608 return ret;
2609 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002610
2611 continue;
2612 }
2613 max_hs_frag_len = max_frag_len - 12;
2614
2615 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2619 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2620 (unsigned) cur_hs_frag_len,
2621 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002622 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002623
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002624 /* Messages are stored with handshake headers as if not fragmented,
2625 * copy beginning of headers then fill fragmentation fields.
2626 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2630 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2631 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2634 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2635 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002638
Hanno Becker3f7b9732018-08-28 09:53:25 +01002639 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002641 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002642 ssl->out_msgtype = cur->type;
2643
2644 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002645 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002646 }
2647
2648 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2650 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002651 ssl->handshake->cur_msg = cur->next;
2652 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002654 ssl->handshake->cur_msg = NULL;
2655 ssl->handshake->cur_msg_p = NULL;
2656 }
2657 }
2658
2659 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2662 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002663 }
2664 }
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2667 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002668 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 /* Update state and set timer */
2671 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2672 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2673 } else {
2674 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2675 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2676 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2679
2680 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002681}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002682
2683/*
2684 * To be called when the last message of an incoming flight is received.
2685 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002686void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002687{
2688 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002690 ssl->handshake->flight = NULL;
2691 ssl->handshake->cur_msg = NULL;
2692
2693 /* The next incoming flight will start with this msg_seq */
2694 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2695
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002696 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002697 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002698
Hanno Becker0271f962018-08-16 13:23:47 +01002699 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002701
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002702 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2706 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002711}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002712
2713/*
2714 * To be called when the last message of an outgoing flight is send.
2715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002717{
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 ssl_reset_retransmit_timeout(ssl);
2719 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2722 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002727}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002729
Paul Bakker5121ce52009-01-03 21:22:43 +00002730/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002731 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2734 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002735{
2736 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002737 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002738 * ...
2739 * HandshakeType msg_type;
2740 * uint24 length;
2741 * ...
2742 */
2743 *buf = ssl->out_msg + 4;
2744 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2745
2746 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2747 ssl->out_msg[0] = hs_type;
2748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002750}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002751
2752/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002753 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002754 *
2755 * - fill in handshake headers
2756 * - update handshake checksum
2757 * - DTLS: save message for resending
2758 * - then pass to the record layer
2759 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002760 * DTLS: except for HelloRequest, messages are only queued, and will only be
2761 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002762 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002763 * Inputs:
2764 * - ssl->out_msglen: 4 + actual handshake message len
2765 * (4 is the size of handshake headers for TLS)
2766 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2767 * - ssl->out_msg + 4: the handshake message body
2768 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002769 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002770 * - ssl->out_msglen: the length of the record contents
2771 * (including handshake headers but excluding record headers)
2772 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002774int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2775 int update_checksum,
2776 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002777{
Janos Follath865b3eb2019-12-16 11:46:15 +00002778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002779 const size_t hs_len = ssl->out_msglen - 4;
2780 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002783
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002784 /*
2785 * Sanity checks
2786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2788 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2789 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2790 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002791 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002792
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002793 /* Whenever we send anything different from a
2794 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2796 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2797 ssl->handshake == NULL) {
2798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2799 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002800 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002804 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2806 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2807 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002808 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002809#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002810
Hanno Beckerb50a2532018-08-06 11:52:54 +01002811 /* Double-check that we did not exceed the bounds
2812 * of the outgoing record buffer.
2813 * This should never fail as the various message
2814 * writing functions must obey the bounds of the
2815 * outgoing record buffer, but better be safe.
2816 *
2817 * Note: We deliberately do not check for the MTU or MFL here.
2818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2820 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2821 "size %" MBEDTLS_PRINTF_SIZET
2822 ", maximum %" MBEDTLS_PRINTF_SIZET,
2823 ssl->out_msglen,
2824 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002826 }
2827
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002828 /*
2829 * Fill handshake headers
2830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2832 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2833 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2834 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002835
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002836 /*
2837 * DTLS has additional fields in the Handshake layer,
2838 * between the length field and the actual payload:
2839 * uint16 message_seq;
2840 * uint24 fragment_offset;
2841 * uint24 fragment_length;
2842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002845 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2847 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2848 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2849 MBEDTLS_PRINTF_SIZET,
2850 hs_len,
2851 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002853 }
2854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002856 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002857
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002858 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2860 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2861 ++(ssl->handshake->out_msg_seq);
2862 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002863 ssl->out_msg[4] = 0;
2864 ssl->out_msg[5] = 0;
2865 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002866
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002867 /* Handshake hashes are computed without fragmentation,
2868 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 memset(ssl->out_msg + 6, 0x00, 3);
2870 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002871 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002873
Hanno Becker0207e532018-08-28 10:28:28 +01002874 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002876 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2877 ssl->out_msglen);
2878 if (ret != 0) {
2879 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2880 return ret;
2881 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002883 }
2884
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002885 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2888 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2889 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2890 if ((ret = ssl_flight_append(ssl)) != 0) {
2891 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2892 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002893 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002895#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002896 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2898 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2899 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002900 }
2901 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002906}
2907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2909 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002910{
2911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2912 size_t msg_with_header_len;
2913 ((void) buf_len);
2914
2915 /* Add reserved 4 bytes for handshake header */
2916 msg_with_header_len = msg_len + 4;
2917 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002919
2920cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002922}
2923
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002924/*
2925 * Record layer functions
2926 */
2927
2928/*
2929 * Write current record.
2930 *
2931 * Uses:
2932 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2933 * - ssl->out_msglen: length of the record content (excl headers)
2934 * - ssl->out_msg: record content
2935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002936int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002937{
2938 int ret, done = 0;
2939 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002940 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002945 unsigned i;
2946 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002947#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2948 size_t out_buf_len = ssl->out_buf_len;
2949#else
2950 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2951#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002952 /* Skip writing the record content type to after the encryption,
2953 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002954 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002955#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002956 /* TLS 1.3 still uses the TLS 1.2 version identifier
2957 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002959 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002961#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2963 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2966 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002969 mbedtls_record rec;
2970
2971 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002973 rec.data_len = ssl->out_msglen;
2974 rec.data_offset = ssl->out_msg - rec.buf;
2975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2977 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002978 rec.type = ssl->out_msgtype;
2979
Hanno Beckera0e20d02019-05-15 14:03:01 +01002980#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002981 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002982 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002983#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2986 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2987 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2988 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002989 }
2990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (rec.data_offset != 0) {
2992 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2993 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002994 }
2995
Hanno Becker6430faf2019-05-08 11:57:13 +01002996 /* Update the record content type and CID. */
2997 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2999 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003000#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003001 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003003 }
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003006
3007#if defined(MBEDTLS_SSL_PROTO_DTLS)
3008 /* In case of DTLS, double-check that we don't exceed
3009 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3011 ret = ssl_get_remaining_space_in_datagram(ssl);
3012 if (ret < 0) {
3013 return ret;
3014 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003017 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003019 }
3020 }
3021#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003022
Hanno Becker6430faf2019-05-08 11:57:13 +01003023 /* Now write the potentially updated record content type. */
3024 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3027 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3028 ssl->out_hdr[0], ssl->out_hdr[1],
3029 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3032 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003033
3034 ssl->out_left += protected_record_size;
3035 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3039 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003040 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 }
3042 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003043
Gabor Mezei96ae9262022-06-28 11:45:18 +02003044 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (i == mbedtls_ssl_ep_len(ssl)) {
3046 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3047 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003048 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003049 }
3050
Hanno Becker67bc7c32018-08-06 11:33:50 +01003051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3053 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003054 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 ret = ssl_get_remaining_payload_in_datagram(ssl);
3056 if (ret < 0) {
3057 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3058 ret);
3059 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003060 }
3061
3062 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003064 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 } else {
3066 MBEDTLS_SSL_DEBUG_MSG(2,
3067 ("Still %u bytes available in current datagram",
3068 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003069 }
3070 }
3071#endif /* MBEDTLS_SSL_PROTO_DTLS */
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if ((flush == SSL_FORCE_FLUSH) &&
3074 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3075 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3076 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003077 }
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003082}
3083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003085
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003087static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003088{
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (ssl->in_msglen < ssl->in_hslen ||
3090 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3091 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3092 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003095}
Hanno Becker44650b72018-08-16 12:51:11 +01003096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003098{
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return (ssl->in_msg[9] << 16) |
3100 (ssl->in_msg[10] << 8) |
3101 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003102}
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003105{
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return (ssl->in_msg[6] << 16) |
3107 (ssl->in_msg[7] << 8) |
3108 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003109}
3110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003112static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003113{
3114 uint32_t msg_len, frag_off, frag_len;
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 msg_len = ssl_get_hs_total_len(ssl);
3117 frag_off = ssl_get_hs_frag_off(ssl);
3118 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 if (frag_off > msg_len) {
3121 return -1;
3122 }
Hanno Becker44650b72018-08-16 12:51:11 +01003123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (frag_len > msg_len - frag_off) {
3125 return -1;
3126 }
Hanno Becker44650b72018-08-16 12:51:11 +01003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (frag_len + 12 > ssl->in_msglen) {
3129 return -1;
3130 }
Hanno Becker44650b72018-08-16 12:51:11 +01003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003133}
3134
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003135/*
3136 * Mark bits in bitmask (used for DTLS HS reassembly)
3137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003138static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003139{
3140 unsigned int start_bits, end_bits;
3141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 start_bits = 8 - (offset % 8);
3143 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003144 size_t first_byte_idx = offset / 8;
3145
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003146 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 if (len <= start_bits) {
3148 for (; len != 0; len--) {
3149 mask[first_byte_idx] |= 1 << (start_bits - len);
3150 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003151
3152 /* Avoid potential issues with offset or len becoming invalid */
3153 return;
3154 }
3155
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003156 offset += start_bits; /* Now offset % 8 == 0 */
3157 len -= start_bits;
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 for (; start_bits != 0; start_bits--) {
3160 mask[first_byte_idx] |= 1 << (start_bits - 1);
3161 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003162 }
3163
3164 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 if (end_bits != 0) {
3166 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003167
3168 len -= end_bits; /* Now len % 8 == 0 */
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 for (; end_bits != 0; end_bits--) {
3171 mask[last_byte_idx] |= 1 << (8 - end_bits);
3172 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173 }
3174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003176}
3177
3178/*
3179 * Check that bitmask is full
3180 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003181MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003182static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003183{
3184 size_t i;
3185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 for (i = 0; i < len / 8; i++) {
3187 if (mask[i] != 0xFF) {
3188 return -1;
3189 }
3190 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 for (i = 0; i < len % 8; i++) {
3193 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3194 return -1;
3195 }
3196 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003199}
3200
Hanno Becker56e205e2018-08-16 09:06:12 +01003201/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003202static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3203 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003204{
Hanno Becker56e205e2018-08-16 09:06:12 +01003205 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003206
Hanno Becker56e205e2018-08-16 09:06:12 +01003207 alloc_len = 12; /* Handshake header */
3208 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (add_bitmap) {
3211 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 }
3214 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003215}
Hanno Becker56e205e2018-08-16 09:06:12 +01003216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003220{
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 return (ssl->in_msg[1] << 16) |
3222 (ssl->in_msg[2] << 8) |
3223 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003224}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003227{
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3229 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3230 ssl->in_msglen));
3231 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003232 }
3233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3237 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3238 MBEDTLS_PRINTF_SIZET,
3239 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl_check_hs_header(ssl) != 0) {
3247 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3248 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003249 }
3250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (ssl->handshake != NULL &&
3252 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3253 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3254 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3255 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3256 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3257 MBEDTLS_SSL_DEBUG_MSG(2,
3258 (
3259 "received future handshake message of sequence number %u (next %u)",
3260 recv_msg_seq,
3261 ssl->handshake->in_msg_seq));
3262 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003263 }
3264
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003265 /* Retransmit only on last message from previous flight, to avoid
3266 * too many retransmissions.
3267 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3269 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3270 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3271 "message_seq = %u, start_of_flight = %u",
3272 recv_msg_seq,
3273 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3277 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003278 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 } else {
3280 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3281 "message_seq = %u, expected = %u",
3282 recv_msg_seq,
3283 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003284 }
3285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003287 }
3288 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003289
Hanno Becker6d97ef52018-08-16 13:09:04 +01003290 /* Message reassembly is handled alongside buffering of future
3291 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003292 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003293 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3295 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3296 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003297 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003300 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (ssl->in_msglen < ssl->in_hslen) {
3302 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3303 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003304 }
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003307}
3308
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003309int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003310{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003312 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003313
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003315 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3316 if (ret != 0) {
3317 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3318 return ret;
3319 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003320 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003321
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003322 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3325 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003326 unsigned offset;
3327 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003328
Hanno Becker0271f962018-08-16 13:23:47 +01003329 /* Increment handshake sequence number */
3330 hs->in_msg_seq++;
3331
3332 /*
3333 * Clear up handshake buffering and reassembly structure.
3334 */
3335
3336 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003338
3339 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003341 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003343 *hs_buf = *(hs_buf + 1);
3344 }
3345
3346 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003348 }
3349#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003350 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003351}
3352
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003353/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003354 * DTLS anti-replay: RFC 6347 4.1.2.6
3355 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003356 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3357 * Bit n is set iff record number in_window_top - n has been seen.
3358 *
3359 * Usually, in_window_top is the last record number seen and the lsb of
3360 * in_window is set. The only exception is the initial state (record number 0
3361 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003364void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003365{
3366 ssl->in_window_top = 0;
3367 ssl->in_window = 0;
3368}
3369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003371{
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return ((uint64_t) buf[0] << 40) |
3373 ((uint64_t) buf[1] << 32) |
3374 ((uint64_t) buf[2] << 24) |
3375 ((uint64_t) buf[3] << 16) |
3376 ((uint64_t) buf[4] << 8) |
3377 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003378}
3379
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003381static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003382{
Janos Follath865b3eb2019-12-16 11:46:15 +00003383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003384 unsigned char *original_in_ctr;
3385
3386 // save original in_ctr
3387 original_in_ctr = ssl->in_ctr;
3388
3389 // use counter from record
3390 ssl->in_ctr = record_in_ctr;
3391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003393
3394 // restore the counter
3395 ssl->in_ctr = original_in_ctr;
3396
3397 return ret;
3398}
3399
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003400/*
3401 * Return 0 if sequence number is acceptable, -1 otherwise
3402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003403int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003404{
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003406 uint64_t bit;
3407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3409 return 0;
3410 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 if (rec_seqnum > ssl->in_window_top) {
3413 return 0;
3414 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003415
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003416 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (bit >= 64) {
3419 return -1;
3420 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3423 return -1;
3424 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003427}
3428
3429/*
3430 * Update replay window on new validated record
3431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003432void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003433{
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003435
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003437 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003441 /* Update window_top and the contents of the window */
3442 uint64_t shift = rec_seqnum - ssl->in_window_top;
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003445 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003448 ssl->in_window |= 1;
3449 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003450
3451 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003454 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003457 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459 }
3460}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003463#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003465 * Check if a datagram looks like a ClientHello with a valid cookie,
3466 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003467 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003468 *
3469 * - if cookie is valid, return 0
3470 * - if ClientHello looks superficially valid but cookie is not,
3471 * fill obuf and set olen, then
3472 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3473 * - otherwise return a specific error code
3474 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003475MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003476MBEDTLS_STATIC_TESTABLE
3477int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 mbedtls_ssl_context *ssl,
3479 const unsigned char *cli_id, size_t cli_id_len,
3480 const unsigned char *in, size_t in_len,
3481 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003482{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003483 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003484 unsigned char *p;
3485
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003486 /*
3487 * Structure of ClientHello with record and handshake headers,
3488 * and expected values. We don't need to check a lot, more checks will be
3489 * done when actually parsing the ClientHello - skipping those checks
3490 * avoids code duplication and does not make cookie forging any easier.
3491 *
3492 * 0-0 ContentType type; copied, must be handshake
3493 * 1-2 ProtocolVersion version; copied
3494 * 3-4 uint16 epoch; copied, must be 0
3495 * 5-10 uint48 sequence_number; copied
3496 * 11-12 uint16 length; (ignored)
3497 *
3498 * 13-13 HandshakeType msg_type; (ignored)
3499 * 14-16 uint24 length; (ignored)
3500 * 17-18 uint16 message_seq; copied
3501 * 19-21 uint24 fragment_offset; copied, must be 0
3502 * 22-24 uint24 fragment_length; (ignored)
3503 *
3504 * 25-26 ProtocolVersion client_version; (ignored)
3505 * 27-58 Random random; (ignored)
3506 * 59-xx SessionID session_id; 1 byte len + sid_len content
3507 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3508 * ...
3509 *
3510 * Minimum length is 61 bytes.
3511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3513 (unsigned) in_len));
3514 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3515 if (in_len < 61) {
3516 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3517 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003518 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003519
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3521 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003522
Gilles Peskine449bd832023-01-11 14:50:10 +01003523 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3524 fragment_offset != 0) {
3525 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3526 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3527 in[0], (unsigned) epoch,
3528 (unsigned) fragment_offset));
3529 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003530 }
3531
3532 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 if (59 + 1 + sid_len + 1 > in_len) {
3534 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3535 (unsigned) sid_len,
3536 (unsigned) in_len - 61));
3537 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003538 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003539 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3540 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003541
3542 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003543 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3544 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3545 (unsigned) cookie_len,
3546 (unsigned) (in_len - sid_len - 61)));
3547 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003548 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003549
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3551 in + sid_len + 61, cookie_len);
3552 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3553 in + sid_len + 61, cookie_len,
3554 cli_id, cli_id_len) == 0) {
3555 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3556 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003557 }
3558
3559 /*
3560 * If we get here, we've got an invalid cookie, let's prepare HVR.
3561 *
3562 * 0-0 ContentType type; copied
3563 * 1-2 ProtocolVersion version; copied
3564 * 3-4 uint16 epoch; copied
3565 * 5-10 uint48 sequence_number; copied
3566 * 11-12 uint16 length; olen - 13
3567 *
3568 * 13-13 HandshakeType msg_type; hello_verify_request
3569 * 14-16 uint24 length; olen - 25
3570 * 17-18 uint16 message_seq; copied
3571 * 19-21 uint24 fragment_offset; copied
3572 * 22-24 uint24 fragment_length; olen - 25
3573 *
3574 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3575 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3576 *
3577 * Minimum length is 28.
3578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 if (buf_len < 28) {
3580 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3581 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003582
3583 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003585 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3586 obuf[25] = 0xfe;
3587 obuf[26] = 0xff;
3588
3589 /* Generate and write actual cookie */
3590 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3592 &p, obuf + buf_len,
3593 cli_id, cli_id_len) != 0) {
3594 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003595 }
3596
3597 *olen = p - obuf;
3598
3599 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003600 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003601
Gilles Peskine449bd832023-01-11 14:50:10 +01003602 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3603 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3604 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003605
Gilles Peskine449bd832023-01-11 14:50:10 +01003606 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003607
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003609}
3610
3611/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003612 * Handle possible client reconnect with the same UDP quadruplet
3613 * (RFC 6347 Section 4.2.8).
3614 *
3615 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3616 * that looks like a ClientHello.
3617 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003618 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003619 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003620 * - if the input looks like a ClientHello with a valid cookie,
3621 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003622 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003623 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003624 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003625 * This function is called (through ssl_check_client_reconnect()) when an
3626 * unexpected record is found in ssl_get_next_record(), which will discard the
3627 * record if we return 0, and bubble up the return value otherwise (this
3628 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3629 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003632static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003633{
Janos Follath865b3eb2019-12-16 11:46:15 +00003634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003635 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003636
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 if (ssl->conf->f_cookie_write == NULL ||
3638 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003639 /* If we can't use cookies to verify reachability of the peer,
3640 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3642 "can't check reconnect validity"));
3643 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003644 }
3645
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003646 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 ssl,
3648 ssl->cli_id, ssl->cli_id_len,
3649 ssl->in_buf, ssl->in_left,
3650 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003651
Gilles Peskine449bd832023-01-11 14:50:10 +01003652 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003653
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003655 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3657 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3658 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003659 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003660 * If the error is permanent we'll catch it later,
3661 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3663 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003664 (void) send_ret;
3665
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003667 }
3668
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 if (ret == 0) {
3670 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3671 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3672 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3673 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003674 }
3675
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003677 }
3678
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003680}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003681#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003682
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003684static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003685{
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003687 record_type != MBEDTLS_SSL_MSG_ALERT &&
3688 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3690 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003691 }
3692
Gilles Peskine449bd832023-01-11 14:50:10 +01003693 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003694}
3695
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003696/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003697 * ContentType type;
3698 * ProtocolVersion version;
3699 * uint16 epoch; // DTLS only
3700 * uint48 sequence_number; // DTLS only
3701 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 *
3703 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003704 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003705 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3706 *
3707 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003708 * 1. proceed with the record if this function returns 0
3709 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3710 * 3. return CLIENT_RECONNECT if this function return that value
3711 * 4. drop the whole datagram if this function returns anything else.
3712 * Point 2 is needed when the peer is resending, and we have already received
3713 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003716static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3717 unsigned char *buf,
3718 size_t len,
3719 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003720{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003721 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003722
Hanno Beckere5e7e782019-07-11 12:29:35 +01003723 size_t const rec_hdr_type_offset = 0;
3724 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003725
Hanno Beckere5e7e782019-07-11 12:29:35 +01003726 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3727 rec_hdr_type_len;
3728 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003729
Hanno Beckere5e7e782019-07-11 12:29:35 +01003730 size_t const rec_hdr_ctr_len = 8;
3731#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003732 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003733 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3734 rec_hdr_version_len;
3735
Hanno Beckera0e20d02019-05-15 14:03:01 +01003736#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003737 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3738 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003739 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003740#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3741#endif /* MBEDTLS_SSL_PROTO_DTLS */
3742
3743 size_t rec_hdr_len_offset; /* To be determined */
3744 size_t const rec_hdr_len_len = 2;
3745
3746 /*
3747 * Check minimum lengths for record header.
3748 */
3749
3750#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003752 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003754#endif /* MBEDTLS_SSL_PROTO_DTLS */
3755 {
3756 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3757 }
3758
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3760 MBEDTLS_SSL_DEBUG_MSG(1,
3761 (
3762 "datagram of length %u too small to hold DTLS record header of length %u",
3763 (unsigned) len,
3764 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3765 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003766 }
3767
3768 /*
3769 * Parse and validate record content type
3770 */
3771
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003773
3774 /* Check record content type */
3775#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3776 rec->cid_len = 0;
3777
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003779 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003781 /* Shift pointers to account for record header including CID
3782 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003783 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003784 * ProtocolVersion version;
3785 * uint16 epoch;
3786 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003787 * opaque cid[cid_length]; // Additional field compared to
3788 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003789 * uint16 length;
3790 * opaque enc_content[DTLSCiphertext.length];
3791 * } DTLSCiphertext;
3792 */
3793
3794 /* So far, we only support static CID lengths
3795 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003796 rec_hdr_cid_len = ssl->conf->cid_len;
3797 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003798
Gilles Peskine449bd832023-01-11 14:50:10 +01003799 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3800 MBEDTLS_SSL_DEBUG_MSG(1,
3801 (
3802 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3803 (unsigned) len,
3804 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3805 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003806 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003807
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003808 /* configured CID len is guaranteed at most 255, see
3809 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3810 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3812 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003813#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003814 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if (ssl_check_record_type(rec->type)) {
3816 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3817 (unsigned) rec->type));
3818 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003819 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003820 }
3821
Hanno Beckere5e7e782019-07-11 12:29:35 +01003822 /*
3823 * Parse and validate record version
3824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003825 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3826 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003827 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3828 buf + rec_hdr_version_offset,
3829 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003830
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 if (tls_version > ssl->conf->max_tls_version) {
3832 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3833 (unsigned) tls_version,
3834 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003835
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003837 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003838 /*
3839 * Parse/Copy record sequence number.
3840 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003841
Hanno Beckere5e7e782019-07-11 12:29:35 +01003842#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003844 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003845 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3846 rec_hdr_ctr_len);
3847 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003848#endif /* MBEDTLS_SSL_PROTO_DTLS */
3849 {
3850 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003852 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003853
Hanno Beckere5e7e782019-07-11 12:29:35 +01003854 /*
3855 * Parse record length.
3856 */
3857
Hanno Beckere5e7e782019-07-11 12:29:35 +01003858 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3860 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3861 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003862
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3864 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3865 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003866
3867 rec->buf = buf;
3868 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003869
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if (rec->data_len == 0) {
3871 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3872 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003873
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003874 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003875 * DTLS-related tests.
3876 * Check epoch before checking length constraint because
3877 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3878 * message gets duplicated before the corresponding Finished message,
3879 * the second ChangeCipherSpec should be discarded because it belongs
3880 * to an old epoch, but not because its length is shorter than
3881 * the minimum record length for packets using the new record transform.
3882 * Note that these two kinds of failures are handled differently,
3883 * as an unexpected record is silently skipped but an invalid
3884 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003885 */
3886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3888 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003889
Hanno Becker955a5c92019-07-10 17:12:07 +01003890 /* Check that the datagram is large enough to contain a record
3891 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 if (len < rec->data_offset + rec->data_len) {
3893 MBEDTLS_SSL_DEBUG_MSG(1,
3894 (
3895 "Datagram of length %u too small to contain record of advertised length %u.",
3896 (unsigned) len,
3897 (unsigned) (rec->data_offset + rec->data_len)));
3898 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003899 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003900
Hanno Becker37cfe732019-07-10 17:20:01 +01003901 /* Records from other, non-matching epochs are silently discarded.
3902 * (The case of same-port Client reconnects must be considered in
3903 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (rec_epoch != ssl->in_epoch) {
3905 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3906 "expected %u, received %lu",
3907 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003908
Hanno Becker552f7472019-07-19 10:59:12 +01003909 /* Records from the next epoch are considered for buffering
3910 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3912 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3913 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003914 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003915
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003917 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003918#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003919 /* For records from the correct epoch, check whether their
3920 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3922 &rec->ctr[0]) != 0) {
3923 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3924 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003925 }
3926#endif
3927 }
3928#endif /* MBEDTLS_SSL_PROTO_DTLS */
3929
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003931}
Paul Bakker5121ce52009-01-03 21:22:43 +00003932
Paul Bakker5121ce52009-01-03 21:22:43 +00003933
Hanno Becker2fddd372019-07-10 14:37:41 +01003934#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003935MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003936static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003937{
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003939
3940 /*
3941 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3942 * access the first byte of record content (handshake type), as we
3943 * have an active transform (possibly iv_len != 0), so use the
3944 * fact that the record header len is 13 instead.
3945 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003947 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003949 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3950 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3952 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3953 "from the same port"));
3954 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003955 }
3956
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003958}
Hanno Becker2fddd372019-07-10 14:37:41 +01003959#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003960
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003961/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003962 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003963 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003964MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003965static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3966 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003967{
3968 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3971 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003972
Ronald Cron7e38cba2021-11-24 12:43:39 +01003973 /*
3974 * In TLS 1.3, always treat ChangeCipherSpec records
3975 * as unencrypted. The only thing we do with them is
3976 * check the length and content and ignore them.
3977 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003978#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 if (ssl->transform_in != NULL &&
3980 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3981 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003982 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003984 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003985#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003986
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003988 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003989
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3991 rec)) != 0) {
3992 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003993
Hanno Beckera0e20d02019-05-15 14:03:01 +01003994#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003996 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3998 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003999 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004000 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004001#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004004 }
4005
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 if (old_msg_type != rec->type) {
4007 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4008 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004009 }
4010
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4012 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004013
Hanno Beckera0e20d02019-05-15 14:03:01 +01004014#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004015 /* We have already checked the record content type
4016 * in ssl_parse_record_header(), failing or silently
4017 * dropping the record in the case of an unknown type.
4018 *
4019 * Since with the use of CIDs, the record content type
4020 * might change during decryption, re-check the record
4021 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if (ssl_check_record_type(rec->type)) {
4023 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4024 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004025 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004026#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4031 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004032 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4034 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004035 }
4036#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4037
4038 ssl->nb_zero++;
4039
4040 /*
4041 * Three or more empty messages may be a DoS attack
4042 * (excessive CPU consumption).
4043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (ssl->nb_zero > 3) {
4045 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4046 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004047 /* Treat the records as if they were not properly authenticated,
4048 * thereby failing the connection if we see more than allowed
4049 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004051 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004053 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004055
4056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004058 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004060#endif
4061 {
4062 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4064 i > mbedtls_ssl_ep_len(ssl); i--) {
4065 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004066 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004068 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004069
4070 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 if (i == mbedtls_ssl_ep_len(ssl)) {
4072 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4073 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004074 }
4075 }
4076
Paul Bakker5121ce52009-01-03 21:22:43 +00004077 }
4078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004079#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4081 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004082 }
4083#endif
4084
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004085 /* Check actual (decrypted) record content length against
4086 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4088 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4089 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004090 }
4091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004093}
4094
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004095/*
4096 * Read a record.
4097 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004098 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4099 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4100 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004101 */
Hanno Becker1097b342018-08-15 14:09:41 +01004102
4103/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004105static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004106MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004107static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004108MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004109static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4112 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004113{
Janos Follath865b3eb2019-12-16 11:46:15 +00004114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004115
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004119 do {
Simon Butcher99000142016-10-13 17:21:01 +01004120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 ret = ssl_consume_current_message(ssl);
4122 if (ret != 0) {
4123 return ret;
4124 }
Hanno Becker26994592018-08-15 14:14:59 +01004125
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004127 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004128#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004129
Hanno Becker40f50842018-08-15 14:48:01 +01004130 /* We only check for buffered messages if the
4131 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4133 ssl_next_record_is_in_datagram(ssl) == 0) {
4134 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004135 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 }
Hanno Becker40f50842018-08-15 14:48:01 +01004137 }
4138
Hanno Becker40f50842018-08-15 14:48:01 +01004139#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 if (dtls_have_buffered == 0) {
4141 ret = ssl_get_next_record(ssl);
4142 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004143 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 }
Hanno Becker40f50842018-08-15 14:48:01 +01004145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (ret != 0) {
4147 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4148 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004149 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004150 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004151 }
4152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004154
Hanno Becker40f50842018-08-15 14:48:01 +01004155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004157 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 ret = ssl_buffer_message(ssl);
4159 if (ret != 0) {
4160 return ret;
4161 }
Hanno Becker40f50842018-08-15 14:48:01 +01004162
4163 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4164 }
4165#endif /* MBEDTLS_SSL_PROTO_DTLS */
4166
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4168 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (0 != ret) {
4171 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4172 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004173 }
4174
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4176 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004177 ret = mbedtls_ssl_update_handshake_status(ssl);
4178 if (0 != ret) {
4179 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4180 return ret;
4181 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004182 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 } else {
4184 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004185 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004186 }
4187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004189
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004191}
4192
Hanno Becker40f50842018-08-15 14:48:01 +01004193#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004194MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004195static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004196{
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 if (ssl->in_left > ssl->next_record_offset) {
4198 return 1;
4199 }
Simon Butcher99000142016-10-13 17:21:01 +01004200
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004202}
4203
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004204MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004205static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004206{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004207 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004209 int ret = 0;
4210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (hs == NULL) {
4212 return -1;
4213 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004214
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4218 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004219 /* Check if we have seen a ChangeCipherSpec before.
4220 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 if (!hs->buffering.seen_ccs) {
4222 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004223 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004224 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004225 }
4226
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004228 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4229 ssl->in_msglen = 1;
4230 ssl->in_msg[0] = 1;
4231
4232 /* As long as they are equal, the exact value doesn't matter. */
4233 ssl->in_left = 0;
4234 ssl->next_record_offset = 0;
4235
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004236 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004237 goto exit;
4238 }
Hanno Becker37f95322018-08-16 13:55:32 +01004239
Hanno Beckerb8f50142018-08-28 10:01:34 +01004240#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004241 /* Debug only */
4242 {
4243 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004245 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 if (hs_buf->is_valid == 1) {
4247 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4248 hs->in_msg_seq + offset,
4249 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004250 }
4251 }
4252 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004253#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004254
4255 /* Check if we have buffered and/or fully reassembled the
4256 * next handshake message. */
4257 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004259 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 size_t msg_len = (hs_buf->data[1] << 16) |
4261 (hs_buf->data[2] << 8) |
4262 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004263
4264 /* Double-check that we haven't accidentally buffered
4265 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4267 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4268 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004269 }
4270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4272 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4273 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004274
4275 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4276 ssl->in_hslen = msg_len + 12;
4277 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004279
4280 ret = 0;
4281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 } else {
4283 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4284 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004285 }
4286
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004287 ret = -1;
4288
4289exit:
4290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4292 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004293}
4294
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004295MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004296static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4297 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004298{
4299 int offset;
4300 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4302 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004303
Hanno Becker01315ea2018-08-21 17:22:17 +01004304 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004306
4307 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4309 hs->buffering.total_bytes_buffered)) {
4310 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4311 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004312 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004313
Hanno Becker4f432ad2018-08-28 10:02:32 +01004314 /* We don't have enough space to buffer the next expected handshake
4315 * message. Remove buffers used for future messages to gain space,
4316 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4318 offset >= 0; offset--) {
4319 MBEDTLS_SSL_DEBUG_MSG(2,
4320 (
4321 "Free buffering slot %d to make space for reassembly of next handshake message",
4322 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004325
4326 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4328 hs->buffering.total_bytes_buffered)) {
4329 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4330 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004331 }
4332 }
4333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004335}
4336
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004337MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004338static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004339{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004340 int ret = 0;
4341 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (hs == NULL) {
4344 return 0;
4345 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004350 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004352
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004353 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004354 break;
4355
4356 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004357 {
4358 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004360 mbedtls_ssl_hs_buffer *hs_buf;
4361 size_t msg_len = ssl->in_hslen - 12;
4362
4363 /* We should never receive an old handshake
4364 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4366 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4367 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004368 }
4369
4370 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004372 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 MBEDTLS_SSL_DEBUG_MSG(2,
4374 ("Ignore future HS message with sequence number %u, "
4375 "buffering window %u - %u",
4376 recv_msg_seq, ssl->handshake->in_msg_seq,
4377 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4378 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004379
4380 goto exit;
4381 }
4382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4384 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004387
4388 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004390 size_t reassembly_buf_sz;
4391
Hanno Becker37f95322018-08-16 13:55:32 +01004392 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004394
4395 /* We copy the message back into the input buffer
4396 * after reassembly, so check that it's not too large.
4397 * This is an implementation-specific limitation
4398 * and not one from the standard, hence it is not
4399 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004401 /* Ignore message */
4402 goto exit;
4403 }
4404
Hanno Beckere0b150f2018-08-21 15:51:03 +01004405 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (hs->buffering.total_bytes_buffered >
4407 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4408 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4409 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004410 }
4411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4413 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4416 hs->buffering.total_bytes_buffered)) {
4417 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004418 /* If we can't buffer a future message because
4419 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 MBEDTLS_SSL_DEBUG_MSG(2,
4421 ("Buffering of future message of size %"
4422 MBEDTLS_PRINTF_SIZET
4423 " would exceed the compile-time limit %"
4424 MBEDTLS_PRINTF_SIZET
4425 " (already %" MBEDTLS_PRINTF_SIZET
4426 " bytes buffered) -- ignore\n",
4427 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4428 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 } else {
4431 MBEDTLS_SSL_DEBUG_MSG(2,
4432 ("Buffering of future message of size %"
4433 MBEDTLS_PRINTF_SIZET
4434 " would exceed the compile-time limit %"
4435 MBEDTLS_PRINTF_SIZET
4436 " (already %" MBEDTLS_PRINTF_SIZET
4437 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4438 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4439 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004440 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4443 MBEDTLS_SSL_DEBUG_MSG(2,
4444 ("Reassembly of next message of size %"
4445 MBEDTLS_PRINTF_SIZET
4446 " (%" MBEDTLS_PRINTF_SIZET
4447 " with bitmap) would exceed"
4448 " the compile-time limit %"
4449 MBEDTLS_PRINTF_SIZET
4450 " (already %" MBEDTLS_PRINTF_SIZET
4451 " bytes buffered) -- fail\n",
4452 msg_len,
4453 reassembly_buf_sz,
4454 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4455 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004456 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4457 goto exit;
4458 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004459 }
4460
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 MBEDTLS_SSL_DEBUG_MSG(2,
4462 ("initialize reassembly, total length = %"
4463 MBEDTLS_PRINTF_SIZET,
4464 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4467 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004468 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004469 goto exit;
4470 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004471 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004472
4473 /* Prepare final header: copy msg_type, length and message_seq,
4474 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 memcpy(hs_buf->data, ssl->in_msg, 6);
4476 memset(hs_buf->data + 6, 0, 3);
4477 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004478
4479 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004480
4481 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004483 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4485 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004486 /* Ignore */
4487 goto exit;
4488 }
4489 }
4490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004492 size_t frag_len, frag_off;
4493 unsigned char * const msg = hs_buf->data + 12;
4494
4495 /*
4496 * Check and copy current fragment
4497 */
4498
4499 /* Validation of header fields already done in
4500 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 frag_off = ssl_get_hs_frag_off(ssl);
4502 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4505 ", length = %" MBEDTLS_PRINTF_SIZET,
4506 frag_off, frag_len));
4507 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004510 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 ssl_bitmask_set(bitmask, frag_off, frag_len);
4512 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4513 msg_len) == 0);
4514 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004515 hs_buf->is_complete = 1;
4516 }
4517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4519 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004520 }
4521
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004522 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004523 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004524
4525 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004526 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004527 break;
4528 }
4529
4530exit:
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4533 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004534}
4535#endif /* MBEDTLS_SSL_PROTO_DTLS */
4536
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004537MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004538static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004539{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004540 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004541 * Consume last content-layer message and potentially
4542 * update in_msglen which keeps track of the contents'
4543 * consumption state.
4544 *
4545 * (1) Handshake messages:
4546 * Remove last handshake message, move content
4547 * and adapt in_msglen.
4548 *
4549 * (2) Alert messages:
4550 * Consume whole record content, in_msglen = 0.
4551 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004552 * (3) Change cipher spec:
4553 * Consume whole record content, in_msglen = 0.
4554 *
4555 * (4) Application data:
4556 * Don't do anything - the record layer provides
4557 * the application data as a stream transport
4558 * and consumes through mbedtls_ssl_read only.
4559 *
4560 */
4561
4562 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004564 /* Hard assertion to be sure that no application data
4565 * is in flight, as corrupting ssl->in_msglen during
4566 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (ssl->in_offt != NULL) {
4568 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4569 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004570 }
4571
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004572 /*
4573 * Get next Handshake message in the current record
4574 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004575
Hanno Becker4a810fb2017-05-24 16:27:30 +01004576 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004577 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004578 * current handshake content: If DTLS handshake
4579 * fragmentation is used, that's the fragment
4580 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004581 * size here is faulty and should be changed at
4582 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004583 * (2) While it doesn't seem to cause problems, one
4584 * has to be very careful not to assume that in_hslen
4585 * is always <= in_msglen in a sensible communication.
4586 * Again, it's wrong for DTLS handshake fragmentation.
4587 * The following check is therefore mandatory, and
4588 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004589 * Additionally, ssl->in_hslen might be arbitrarily out of
4590 * bounds after handling a DTLS message with an unexpected
4591 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004594 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4596 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4599 ssl->in_msg, ssl->in_msglen);
4600 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004601 ssl->in_msglen = 0;
4602 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004603
Hanno Becker4a810fb2017-05-24 16:27:30 +01004604 ssl->in_hslen = 0;
4605 }
4606 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 else if (ssl->in_offt != NULL) {
4608 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004609 }
4610 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004612 ssl->in_msglen = 0;
4613 }
4614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004616}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004617
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004618MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004619static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004620{
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 if (ssl->in_msglen > 0) {
4622 return 1;
4623 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004626}
4627
Hanno Becker5f066e72018-08-16 14:56:31 +01004628#if defined(MBEDTLS_SSL_PROTO_DTLS)
4629
Gilles Peskine449bd832023-01-11 14:50:10 +01004630static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004631{
4632 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004634 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004638 hs->buffering.total_bytes_buffered -=
4639 hs->buffering.future_record.len;
4640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004642 hs->buffering.future_record.data = NULL;
4643 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004644}
4645
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004646MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004647static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004648{
4649 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004651 size_t rec_len;
4652 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004653#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4654 size_t in_buf_len = ssl->in_buf_len;
4655#else
4656 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4657#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4659 return 0;
4660 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if (hs == NULL) {
4663 return 0;
4664 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004665
Hanno Becker5f066e72018-08-16 14:56:31 +01004666 rec = hs->buffering.future_record.data;
4667 rec_len = hs->buffering.future_record.len;
4668 rec_epoch = hs->buffering.future_record.epoch;
4669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (rec == NULL) {
4671 return 0;
4672 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004673
Hanno Becker4cb782d2018-08-20 11:19:05 +01004674 /* Only consider loading future records if the
4675 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4677 return 0;
4678 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (rec_epoch != ssl->in_epoch) {
4683 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004684 goto exit;
4685 }
4686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004688
4689 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004690 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4691 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4692 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004693 }
4694
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004696 ssl->in_left = rec_len;
4697 ssl->next_record_offset = 0;
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004700
4701exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4703 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004704}
4705
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004706MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004707static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4708 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004709{
4710 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004711
4712 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (hs == NULL) {
4714 return 0;
4715 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004716
4717 /* Only buffer handshake records (we are only interested
4718 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4720 return 0;
4721 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004722
4723 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if (hs->buffering.future_record.data != NULL) {
4725 return 0;
4726 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004727
Hanno Becker01315ea2018-08-21 17:22:17 +01004728 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4730 hs->buffering.total_bytes_buffered)) {
4731 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4732 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4733 " (already %" MBEDTLS_PRINTF_SIZET
4734 " bytes buffered) -- ignore\n",
4735 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4736 hs->buffering.total_bytes_buffered));
4737 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004738 }
4739
Hanno Becker5f066e72018-08-16 14:56:31 +01004740 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4742 ssl->in_epoch + 1U));
4743 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004744
4745 /* ssl_parse_record_header() only considers records
4746 * of the next epoch as candidates for buffering. */
4747 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004748 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004749
4750 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 mbedtls_calloc(1, hs->buffering.future_record.len);
4752 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004753 /* If we run out of RAM trying to buffer a
4754 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004756 }
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004759
Hanno Becker519f15d2019-07-11 12:43:20 +01004760 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004762}
4763
4764#endif /* MBEDTLS_SSL_PROTO_DTLS */
4765
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004766MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004767static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004768{
Janos Follath865b3eb2019-12-16 11:46:15 +00004769 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004770 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004771
Hanno Becker5f066e72018-08-16 14:56:31 +01004772#if defined(MBEDTLS_SSL_PROTO_DTLS)
4773 /* We might have buffered a future record; if so,
4774 * and if the epoch matches now, load it.
4775 * On success, this call will set ssl->in_left to
4776 * the length of the buffered record, so that
4777 * the calls to ssl_fetch_input() below will
4778 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 ret = ssl_load_buffered_record(ssl);
4780 if (ret != 0) {
4781 return ret;
4782 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004783#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004784
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004785 /* Ensure that we have enough space available for the default form
4786 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4787 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4789 if (ret != 0) {
4790 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4791 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004792 }
4793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4795 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4798 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4799 ret = ssl_buffer_future_record(ssl, &rec);
4800 if (ret != 0) {
4801 return ret;
4802 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004803
4804 /* Fall through to handling of unexpected records */
4805 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4806 }
4807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004809#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004810 /* Reset in pointers to default state for TLS/DTLS records,
4811 * assuming no CID and no offset between record content and
4812 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004814
Hanno Becker7ae20e02019-07-12 08:33:49 +01004815 /* Setup internal message pointers from record structure. */
4816 ssl->in_msgtype = rec.type;
4817#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4818 ssl->in_len = ssl->in_cid + rec.cid_len;
4819#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4820 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4821 ssl->in_msglen = rec.data_len;
4822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 ret = ssl_check_client_reconnect(ssl);
4824 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4825 if (ret != 0) {
4826 return ret;
4827 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004828#endif
4829
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004830 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004831 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4834 "(header)"));
4835 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004836 /* Skip invalid record and the rest of the datagram */
4837 ssl->next_record_offset = 0;
4838 ssl->in_left = 0;
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4841 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004842 }
4843
4844 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4846 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004847#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004848 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004850 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004851 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004855 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004856 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if (ssl->next_record_offset < ssl->in_left) {
4858 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004861#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004862 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004863 /*
4864 * Fetch record contents from underlying transport.
4865 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4867 if (ret != 0) {
4868 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4869 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004870 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004871
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004872 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004873 }
4874
4875 /*
4876 * Decrypt record contents.
4877 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004882 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004884 /* Except when waiting for Finished as a bad mac here
4885 * probably means something went wrong in the handshake
4886 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4888 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004889#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4891 mbedtls_ssl_send_alert_message(ssl,
4892 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4893 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004894 }
4895#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004897 }
4898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (ssl->conf->badmac_limit != 0 &&
4900 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4901 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4902 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004903 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004904
Hanno Becker4a810fb2017-05-24 16:27:30 +01004905 /* As above, invalid records cause
4906 * dismissal of the whole datagram. */
4907
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 (mac)"));
4912 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004913 }
4914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 return ret;
4916 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004917#endif
4918 {
4919 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004920#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4922 mbedtls_ssl_send_alert_message(ssl,
4923 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4924 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004925 }
4926#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004928 }
4929 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004930
Hanno Becker44d89b22019-07-12 09:40:44 +01004931
4932 /* Reset in pointers to default state for TLS/DTLS records,
4933 * assuming no CID and no offset between record content and
4934 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004936#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4937 ssl->in_len = ssl->in_cid + rec.cid_len;
4938#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004939 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004940
Hanno Becker8685c822019-07-12 09:37:30 +01004941 /* The record content type may change during decryption,
4942 * so re-read it. */
4943 ssl->in_msgtype = rec.type;
4944 /* Also update the input buffer, because unfortunately
4945 * the server-side ssl_parse_client_hello() reparses the
4946 * record header when receiving a ClientHello initiating
4947 * a renegotiation. */
4948 ssl->in_hdr[0] = rec.type;
4949 ssl->in_msg = rec.buf + rec.data_offset;
4950 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004954}
4955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004957{
Janos Follath865b3eb2019-12-16 11:46:15 +00004958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004959
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004960 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004961 * Handle particular types of records
4962 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4964 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4965 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004966 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004967 }
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4970 if (ssl->in_msglen != 1) {
4971 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4972 ssl->in_msglen));
4973 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004974 }
4975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->in_msg[0] != 1) {
4977 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4978 ssl->in_msg[0]));
4979 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004980 }
4981
4982#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004984 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4986 if (ssl->handshake == NULL) {
4987 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4988 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004989 }
4990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4992 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004993 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004994#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004995
Ronald Cron6f135e12021-12-08 16:57:54 +01004996#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004998#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 MBEDTLS_SSL_DEBUG_MSG(1,
5000 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5001 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005002#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 MBEDTLS_SSL_DEBUG_MSG(1,
5004 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5005 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005006#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5007 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005008#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005009 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5012 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005013 /* Note: Standard allows for more than one 2 byte alert
5014 to be packed in a single message, but Mbed TLS doesn't
5015 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5017 ssl->in_msglen));
5018 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005019 }
5020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5022 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005023
5024 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005025 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5028 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5029 ssl->in_msg[1]));
5030 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005031 }
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5034 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5035 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5036 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005037 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005038
5039#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5041 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5042 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005043 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005045 }
5046#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005047 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005048 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005049 }
5050
Hanno Beckerc76c6192017-06-06 10:03:17 +01005051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005053 /* Drop unexpected ApplicationData records,
5054 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5056 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005057#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5059 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005060#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 ) {
5062 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5063 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005064 }
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (ssl->handshake != NULL &&
5067 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5068 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005069 }
5070 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005071#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005074}
5075
Gilles Peskine449bd832023-01-11 14:50:10 +01005076int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005077{
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 return mbedtls_ssl_send_alert_message(ssl,
5079 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5080 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005081}
5082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5084 unsigned char level,
5085 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005086{
Janos Follath865b3eb2019-12-16 11:46:15 +00005087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (ssl == NULL || ssl->conf == NULL) {
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5091 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (ssl->out_left != 0) {
5094 return mbedtls_ssl_flush_output(ssl);
5095 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5098 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005099
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005100 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005101 ssl->out_msglen = 2;
5102 ssl->out_msg[0] = level;
5103 ssl->out_msg[1] = message;
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5106 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5107 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005108 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005110
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005112}
5113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005115{
Janos Follath865b3eb2019-12-16 11:46:15 +00005116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005120 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005121 ssl->out_msglen = 1;
5122 ssl->out_msg[0] = 1;
5123
Paul Bakker5121ce52009-01-03 21:22:43 +00005124 ssl->state++;
5125
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5127 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5128 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005129 }
5130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005132
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005134}
5135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005137{
Janos Follath865b3eb2019-12-16 11:46:15 +00005138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5143 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5144 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005145 }
5146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5148 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5149 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5150 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5151 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005152 }
5153
Hanno Beckere678eaa2018-08-21 14:57:46 +01005154 /* CCS records are only accepted if they have length 1 and content '1',
5155 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005156
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005157 /*
5158 * Switch to our negotiated transform and session parameters for inbound
5159 * data.
5160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005162#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005163 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005164#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005165 ssl->session_in = ssl->session_negotiate;
5166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005167#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005169#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005171#endif
5172
5173 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (++ssl->in_epoch == 0) {
5175 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005176 /* This is highly unlikely to happen for legitimate reasons, so
5177 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005179 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005185
Paul Bakker5121ce52009-01-03 21:22:43 +00005186 ssl->state++;
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005189
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005191}
5192
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005193/* Once ssl->out_hdr as the address of the beginning of the
5194 * next outgoing record is set, deduce the other pointers.
5195 *
5196 * Note: For TLS, we save the implicit record sequence number
5197 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5198 * and the caller has to make sure there's space for this.
5199 */
5200
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005201static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005203{
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005205}
5206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5208 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005209{
5210#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005212 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005213#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005214 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005215 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005217 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005219#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005220 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005221#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005222 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005224#endif
5225 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005226 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005227#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005228 ssl->out_cid = ssl->out_len;
5229#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005230 ssl->out_iv = ssl->out_hdr + 5;
5231 }
5232
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005233 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005234 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (transform != NULL) {
5236 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5237 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005238}
5239
5240/* Once ssl->in_hdr as the address of the beginning of the
5241 * next incoming record is set, deduce the other pointers.
5242 *
5243 * Note: For TLS, we save the implicit record sequence number
5244 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5245 * and the caller has to make sure there's space for this.
5246 */
5247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005249{
Hanno Becker79594fd2019-05-08 09:38:41 +01005250 /* This function sets the pointers to match the case
5251 * of unprotected TLS/DTLS records, with both ssl->in_iv
5252 * and ssl->in_msg pointing to the beginning of the record
5253 * content.
5254 *
5255 * When decrypting a protected record, ssl->in_msg
5256 * will be shifted to point to the beginning of the
5257 * record plaintext.
5258 */
5259
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005260#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005262 /* This sets the header pointers to match records
5263 * without CID. When we receive a record containing
5264 * a CID, the fields are shifted accordingly in
5265 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005266 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005267#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005268 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005269 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005270#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005271 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005272#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005273 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005275#endif
5276 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005277 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005278 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005279#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005280 ssl->in_cid = ssl->in_len;
5281#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005282 ssl->in_iv = ssl->in_hdr + 5;
5283 }
5284
Hanno Becker79594fd2019-05-08 09:38:41 +01005285 /* This will be adjusted at record decryption time. */
5286 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005287}
5288
Paul Bakker5121ce52009-01-03 21:22:43 +00005289/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005290 * Setup an SSL context
5291 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005294{
5295 /* Set the incoming and outgoing record pointers. */
5296#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005298 ssl->out_hdr = ssl->out_buf;
5299 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005301#endif /* MBEDTLS_SSL_PROTO_DTLS */
5302 {
Hanno Becker12078f42021-03-02 15:28:41 +00005303 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005304 ssl->out_hdr = ssl->out_buf + 8;
5305 ssl->in_hdr = ssl->in_buf + 8;
5306 }
5307
5308 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5310 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005311}
5312
Paul Bakker5121ce52009-01-03 21:22:43 +00005313/*
5314 * SSL get accessors
5315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005317{
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005319}
5320
Gilles Peskine449bd832023-01-11 14:50:10 +01005321int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005322{
5323 /*
5324 * Case A: We're currently holding back
5325 * a message for further processing.
5326 */
5327
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 if (ssl->keep_current_message == 1) {
5329 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5330 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005331 }
5332
5333 /*
5334 * Case B: Further records are pending in the current datagram.
5335 */
5336
5337#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5339 ssl->in_left > ssl->next_record_offset) {
5340 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5341 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005342 }
5343#endif /* MBEDTLS_SSL_PROTO_DTLS */
5344
5345 /*
5346 * Case C: A handshake message is being processed.
5347 */
5348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5350 MBEDTLS_SSL_DEBUG_MSG(3,
5351 ("ssl_check_pending: more handshake messages within current record"));
5352 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005353 }
5354
5355 /*
5356 * Case D: An application data message is being processed
5357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (ssl->in_offt != NULL) {
5359 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5360 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005361 }
5362
5363 /*
5364 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005365 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005366 * we implement support for multiple alerts in single records.
5367 */
5368
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5370 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005371}
5372
Paul Bakker43ca69c2011-01-15 17:35:19 +00005373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005375{
Hanno Becker3136ede2018-08-17 15:28:19 +01005376 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005377 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005378 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005379#if defined(MBEDTLS_USE_PSA_CRYPTO)
5380 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5381 psa_key_type_t key_type;
5382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005383
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 if (transform == NULL) {
5387 return (int) out_hdr_len;
5388 }
Hanno Becker78640902018-08-13 16:35:15 +01005389
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005390
5391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if (transform->psa_alg == PSA_ALG_GCM ||
5393 transform->psa_alg == PSA_ALG_CCM ||
5394 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5395 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5396 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005397 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5399 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5400 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005403
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005404 /* Expansion due to the addition of the MAC. */
5405 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005406
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005407 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005408 * Theoretically up to 256 bytes, but we never use
5409 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005410 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005411
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005412 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005413 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005414#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005415 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005416#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 } else {
5418 MBEDTLS_SSL_DEBUG_MSG(1,
5419 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5420 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005421 }
5422#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424 case MBEDTLS_MODE_GCM:
5425 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005426 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005428 transform_expansion = transform->minlen;
5429 break;
5430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005432
5433 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005435
Hanno Becker3136ede2018-08-17 15:28:19 +01005436 /* Expansion due to the addition of the MAC. */
5437 transform_expansion += transform->maclen;
5438
5439 /* Expansion due to the addition of CBC padding;
5440 * Theoretically up to 256 bytes, but we never use
5441 * more than the block size of the underlying cipher. */
5442 transform_expansion += block_size;
5443
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005444 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005445 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005446#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005447 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005448#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005449
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005450 break;
5451
5452 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5454 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005455 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005456#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005457
Hanno Beckera0e20d02019-05-15 14:03:01 +01005458#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005460 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005463
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005465}
5466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005468/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005469 * Check record counters and renegotiate if they're above the limit.
5470 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005472static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005473{
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005475 int in_ctr_cmp;
5476 int out_ctr_cmp;
5477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5481 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005482 }
5483
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5485 &ssl->conf->renego_period[ep_len],
5486 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5487 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005488 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5492 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005493 }
5494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5496 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005497}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005499
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005500#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5501
5502#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005503MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005504static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005505{
5506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5508 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5509 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005510 }
5511
5512 ssl->keep_current_message = 1;
5513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5515 mbedtls_ssl_handshake_set_state(ssl,
5516 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005519}
5520#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5521
Jerry Yua0446a02022-07-13 11:22:55 +08005522MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005523static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005524{
5525
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005527
5528#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5530 int ret = ssl_tls13_check_new_session_ticket(ssl);
5531 if (ret != 0) {
5532 return ret;
5533 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005534 }
5535#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5536
5537 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005539}
5540#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5541
5542#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005543/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005544 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005545 * may only be sent for the purpose of initiating renegotiations.
5546 *
5547 * This function is introduced as a separate helper since the handling
5548 * of post-handshake handshake messages changes significantly in TLS 1.3,
5549 * and having a helper function allows to distinguish between TLS <= 1.2 and
5550 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5551 */
Jerry Yua0446a02022-07-13 11:22:55 +08005552MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005553static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005554{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005556
5557 /*
5558 * - For client-side, expect SERVER_HELLO_REQUEST.
5559 * - For server-side, expect CLIENT_HELLO.
5560 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5561 */
5562
5563#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5565 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5566 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5567 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005568
5569 /* With DTLS, drop the packet (probably from last handshake) */
5570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5572 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005573 }
5574#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005576 }
5577#endif /* MBEDTLS_SSL_CLI_C */
5578
5579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5581 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5582 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005583
5584 /* With DTLS, drop the packet (probably from last handshake) */
5585#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5587 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005588 }
5589#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005591 }
5592#endif /* MBEDTLS_SSL_SRV_C */
5593
5594#if defined(MBEDTLS_SSL_RENEGOTIATION)
5595 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5597 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5598 ssl->conf->allow_legacy_renegotiation ==
5599 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005600 /*
5601 * Accept renegotiation request
5602 */
5603
5604 /* DTLS clients need to know renego is server-initiated */
5605#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5607 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005608 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5609 }
5610#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 ret = mbedtls_ssl_start_renegotiation(ssl);
5612 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5613 ret != 0) {
5614 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5615 ret);
5616 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005617 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005619#endif /* MBEDTLS_SSL_RENEGOTIATION */
5620 {
5621 /*
5622 * Refuse renegotiation
5623 */
5624
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005626
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5628 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5629 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5630 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005631 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005632 }
5633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005635}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005636#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5637
5638MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005639static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005640{
5641 /* Check protocol version and dispatch accordingly. */
5642#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5644 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005645 }
5646#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5647
5648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5650 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005651 }
5652#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5653
5654 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005656}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005657
Paul Bakker48916f92012-09-16 19:57:18 +00005658/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005659 * Receive application data decrypted from the SSL layer
5660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005662{
Janos Follath865b3eb2019-12-16 11:46:15 +00005663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005664 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (ssl == NULL || ssl->conf == NULL) {
5667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5668 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005669
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5674 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5675 return ret;
5676 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (ssl->handshake != NULL &&
5679 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5680 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5681 return ret;
5682 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005683 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005684 }
5685#endif
5686
Hanno Becker4a810fb2017-05-24 16:27:30 +01005687 /*
5688 * Check if renegotiation is necessary and/or handshake is
5689 * in process. If yes, perform/continue, and fall through
5690 * if an unexpected packet is received while the client
5691 * is waiting for the ServerHello.
5692 *
5693 * (There is no equivalent to the last condition on
5694 * the server-side as it is not treated as within
5695 * a handshake while waiting for the ClientHello
5696 * after a renegotiation request.)
5697 */
5698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005699#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 ret = ssl_check_ctr_renegotiate(ssl);
5701 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5702 ret != 0) {
5703 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5704 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005705 }
5706#endif
5707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5709 ret = mbedtls_ssl_handshake(ssl);
5710 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5711 ret != 0) {
5712 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5713 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005714 }
5715 }
5716
Hanno Beckere41158b2017-10-23 13:30:32 +01005717 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005719 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (ssl->f_get_timer != NULL &&
5721 ssl->f_get_timer(ssl->p_timer) == -1) {
5722 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005723 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005724
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5726 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5727 return 0;
5728 }
Paul Bakker831a7552011-05-18 13:32:51 +00005729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5731 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005732 }
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (ssl->in_msglen == 0 &&
5735 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005736 /*
5737 * OpenSSL sends empty messages to randomize the IV
5738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5740 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5741 return 0;
5742 }
Paul Bakker831a7552011-05-18 13:32:51 +00005743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5745 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005746 }
5747 }
5748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5750 ret = ssl_handle_hs_message_post_handshake(ssl);
5751 if (ret != 0) {
5752 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5753 ret);
5754 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005755 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005756
Hanno Beckerf26cc722021-04-21 07:30:13 +01005757 /* At this point, we don't know whether the renegotiation triggered
5758 * by the post-handshake message has been completed or not. The cases
5759 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005760 * 1) The renegotiation is complete. In this case, no new record
5761 * has been read yet.
5762 * 2) The renegotiation is incomplete because the client received
5763 * an application data record while awaiting the ServerHello.
5764 * 3) The renegotiation is incomplete because the client received
5765 * a non-handshake, non-application data message while awaiting
5766 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005767 *
5768 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005769 * - For 1), the next iteration will read a new record and check
5770 * if it's application data.
5771 * - For 2), the loop condition isn't satisfied as application data
5772 * is present, hence continue is the same as break
5773 * - For 3), the loop condition is satisfied and read_record
5774 * will re-deliver the message that was held back by the client
5775 * when expecting the ServerHello.
5776 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005777
Hanno Becker90333da2017-10-10 11:27:13 +01005778 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005779 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005780#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5782 if (ssl->conf->renego_max_records >= 0) {
5783 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5784 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5785 "but not honored by client"));
5786 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005787 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005788 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005789 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005790#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005792 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5794 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5795 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005796 }
5797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5799 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5800 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005801 }
5802
5803 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005804
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005805 /* We're going to return something now, cancel timer,
5806 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5808 mbedtls_ssl_set_timer(ssl, 0);
5809 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005810
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005811#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005812 /* If we requested renego but received AppData, resend HelloRequest.
5813 * Do it now, after setting in_offt, to avoid taking this branch
5814 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005815#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5817 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5818 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5819 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5820 ret);
5821 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005822 }
5823 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005824#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005825#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005826 }
5827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005829 ? len : ssl->in_msglen;
5830
ashesman937d6d52022-02-17 11:08:27 +13005831 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005832 memcpy(buf, ssl->in_offt, n);
5833 ssl->in_msglen -= n;
5834 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005835
gabor-mezei-arma3214132020-07-15 10:55:00 +02005836 /* Zeroising the plaintext buffer to erase unused application data
5837 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005841 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005842 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005843 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005845 /* more data available */
5846 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005847 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005852}
5853
5854/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005855 * Send application data to be encrypted by the SSL layer, taking care of max
5856 * fragment length and buffer size.
5857 *
5858 * According to RFC 5246 Section 6.2.1:
5859 *
5860 * Zero-length fragments of Application data MAY be sent as they are
5861 * potentially useful as a traffic analysis countermeasure.
5862 *
5863 * Therefore, it is possible that the input message length is 0 and the
5864 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005865 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005866MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005867static int ssl_write_real(mbedtls_ssl_context *ssl,
5868 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005869{
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005871 const size_t max_len = (size_t) ret;
5872
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 if (ret < 0) {
5874 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5875 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005876 }
5877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005879#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5881 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5882 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5883 " > %" MBEDTLS_PRINTF_SIZET,
5884 len, max_len));
5885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5886 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005887#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005889 }
Paul Bakker887bd502011-06-08 13:10:54 +00005890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005892 /*
5893 * The user has previously tried to send the data and
5894 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5895 * written. In this case, we expect the high-level write function
5896 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5899 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5900 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005901 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005903 /*
5904 * The user is trying to send a message the first time, so we need to
5905 * copy the data into the internal buffers and setup the data structure
5906 * to keep track of partial writes
5907 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005908 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005910 if (len > 0) {
5911 memcpy(ssl->out_msg, buf, len);
5912 }
Paul Bakker887bd502011-06-08 13:10:54 +00005913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5915 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5916 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005917 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005918 }
5919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005921}
5922
5923/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005924 * Write application data (public-facing wrapper)
5925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005926int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005927{
Janos Follath865b3eb2019-12-16 11:46:15 +00005928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005929
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 if (ssl == NULL || ssl->conf == NULL) {
5933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5934 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005935
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005936#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5938 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5939 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005940 }
5941#endif
5942
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5944 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5945 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5946 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005947 }
5948 }
5949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005953
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005955}
5956
5957/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005958 * Notify the peer that the connection is being closed
5959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005960int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005961{
Janos Follath865b3eb2019-12-16 11:46:15 +00005962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 if (ssl == NULL || ssl->conf == NULL) {
5965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5966 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005967
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5971 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5972 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5973 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5974 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5975 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005976 }
5977 }
5978
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005982}
5983
Gilles Peskine449bd832023-01-11 14:50:10 +01005984void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005985{
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005987 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005989
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005990#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 psa_destroy_key(transform->psa_key_enc);
5992 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005993#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 mbedtls_cipher_free(&transform->cipher_ctx_enc);
5995 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005996#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005997
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005998#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005999#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 psa_destroy_key(transform->psa_mac_enc);
6001 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006002#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 mbedtls_md_free(&transform->md_ctx_enc);
6004 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006005#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006006#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006007
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006009}
6010
Gilles Peskine449bd832023-01-11 14:50:10 +01006011void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6012 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006013{
Jerry Yuc7875b52021-09-05 21:05:50 +08006014 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006016}
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6019 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006020{
6021 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006023}
6024
Hanno Becker0271f962018-08-16 13:23:47 +01006025#if defined(MBEDTLS_SSL_PROTO_DTLS)
6026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006028{
6029 unsigned offset;
6030 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006033 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 }
Hanno Becker0271f962018-08-16 13:23:47 +01006035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006037
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6039 ssl_buffering_free_slot(ssl, offset);
6040 }
Hanno Beckere605b192018-08-21 15:59:07 +01006041}
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6044 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006045{
6046 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6047 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006050 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006054 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006055 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006057 }
6058}
6059
6060#endif /* MBEDTLS_SSL_PROTO_DTLS */
6061
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006062/*
6063 * Convert version numbers to/from wire format
6064 * and, for DTLS, to/from TLS equivalent.
6065 *
6066 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006067 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006068 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006069 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006071void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6072 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006073{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006074 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006075#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006077 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006079 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006080#else
6081 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006082#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006083 {
6084 tls_version_formatted = (uint16_t) tls_version;
6085 }
6086 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006087}
6088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6090 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006091{
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006093#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006095 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6097 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006098#else
6099 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006100#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006101 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006102}
6103
Jerry Yue7047812021-09-13 19:26:39 +08006104/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006105 * Send pending fatal alert.
6106 * 0, No alert message.
6107 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6108 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006109 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006110int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006111{
6112 int ret;
6113
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006114 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (ssl->send_alert == 0) {
6116 return 0;
6117 }
Jerry Yu394ece62021-09-14 22:17:21 +08006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 ret = mbedtls_ssl_send_alert_message(ssl,
6120 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6121 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006122
Jerry Yu3bf1f972021-09-22 21:37:18 +08006123 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6124 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006125 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006127 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006128 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006129
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 if (ret != 0) {
6131 return ret;
6132 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006135}
6136
Jerry Yu394ece62021-09-14 22:17:21 +08006137/*
6138 * Set pending fatal alert flag.
6139 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006140void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6141 unsigned char alert_type,
6142 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006143{
6144 ssl->send_alert = 1;
6145 ssl->alert_type = alert_type;
6146 ssl->alert_reason = alert_reason;
6147}
6148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006149#endif /* MBEDTLS_SSL_TLS_C */