blob: 96c1a7c96ea1958b4658c98ea3c58a192ad0a510 [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
Harry Ramsey0f6bc412024-10-04 10:36:54 +010013#include "ssl_misc.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"
Valerio Settib4f50762024-01-17 10:24:52 +010020#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000021#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050022#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010023#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020024#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020025#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020026
Rich Evans00ab4702015-02-06 13:43:58 +000027#include <string.h>
28
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020029#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031
Janos Follath23bdca02016-10-07 14:47:14 +010032#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020034#endif
35
Andrzej Kurek00644842023-05-30 05:45:00 -040036/* Define a local translating function to save code size by not using too many
37 * arguments in each translating place. */
38static int local_err_translation(psa_status_t status)
39{
40 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040041 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040042 psa_generic_status_to_mbedtls);
43}
44#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050045
Dave Rodgman2801f7f2023-05-09 11:00:07 +010046#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
47
Dave Rodgman2801f7f2023-05-09 11:00:07 +010048
49#if defined(PSA_WANT_ALG_SHA_384)
50#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
51#elif defined(PSA_WANT_ALG_SHA_256)
52#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
53#else /* See check_config.h */
54#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
55#endif
56
57MBEDTLS_STATIC_TESTABLE
58int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
59 psa_algorithm_t mac_alg,
60 const unsigned char *add_data,
61 size_t add_data_len,
62 const unsigned char *data,
63 size_t data_len_secret,
64 size_t min_data_len,
65 size_t max_data_len,
66 unsigned char *output)
67{
68 /*
69 * This function breaks the HMAC abstraction and uses psa_hash_clone()
70 * extension in order to get constant-flow behaviour.
71 *
72 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
73 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
74 * patterns (see RFC 2104, sec. 2).
75 *
76 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
77 * hashing up to minlen, then cloning the context, and for each byte up
78 * to maxlen finishing up the hash computation, keeping only the
79 * correct result.
80 *
81 * Then we only need to compute HASH(okey + inner_hash) and we're done.
82 */
83 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
84 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
85 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
86 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
87 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
88 size_t hash_length;
89
90 unsigned char aux_out[PSA_HASH_MAX_SIZE];
91 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
92 size_t offset;
93 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
94
95 size_t mac_key_length;
96 size_t i;
97
98#define PSA_CHK(func_call) \
99 do { \
100 status = (func_call); \
101 if (status != PSA_SUCCESS) \
102 goto cleanup; \
103 } while (0)
104
105 /* Export MAC key
106 * We assume key length is always exactly the output size
107 * which is never more than the block size, thus we use block_size
108 * as the key buffer size.
109 */
110 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
111
112 /* Calculate ikey */
113 for (i = 0; i < mac_key_length; i++) {
114 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
115 }
116 for (; i < block_size; ++i) {
117 key_buf[i] = 0x36;
118 }
119
120 PSA_CHK(psa_hash_setup(&operation, hash_alg));
121
122 /* Now compute inner_hash = HASH(ikey + msg) */
123 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
124 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
125 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
126
127 /* Fill the hash buffer in advance with something that is
128 * not a valid hash (barring an attack on the hash and
129 * deliberately-crafted input), in case the caller doesn't
130 * check the return status properly. */
131 memset(output, '!', hash_size);
132
133 /* For each possible length, compute the hash up to that point */
134 for (offset = min_data_len; offset <= max_data_len; offset++) {
135 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
136 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
137 PSA_HASH_MAX_SIZE, &hash_length));
138 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100139 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100140 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100141
142 if (offset < max_data_len) {
143 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
144 }
145 }
146
147 /* Abort current operation to prepare for final operation */
148 PSA_CHK(psa_hash_abort(&operation));
149
150 /* Calculate okey */
151 for (i = 0; i < mac_key_length; i++) {
152 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
153 }
154 for (; i < block_size; ++i) {
155 key_buf[i] = 0x5C;
156 }
157
158 /* Now compute HASH(okey + inner_hash) */
159 PSA_CHK(psa_hash_setup(&operation, hash_alg));
160 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
161 PSA_CHK(psa_hash_update(&operation, output, hash_size));
162 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
163
164#undef PSA_CHK
165
166cleanup:
167 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
168 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
169
170 psa_hash_abort(&operation);
171 psa_hash_abort(&aux_operation);
172 return PSA_TO_MBEDTLS_ERR(status);
173}
174
175#undef MAX_HASH_BLOCK_LENGTH
176
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100177
178#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100181
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200182/*
183 * Start a timer.
184 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200185 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100186void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200187{
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200189 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200191
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
193 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200194}
195
196/*
197 * Return -1 is timer is expired, 0 if it isn't.
198 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100199int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200200{
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 if (ssl->f_get_timer == NULL) {
202 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200203 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 if (ssl->f_get_timer(ssl->p_timer) == 2) {
206 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
207 return -1;
208 }
209
210 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200211}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200212
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100214static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
215 unsigned char *buf,
216 size_t len,
217 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200218
Gilles Peskine449bd832023-01-11 14:50:10 +0100219int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
220 unsigned char *buf,
221 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200222{
223 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100224 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
225 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200226
227 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200228 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200229 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200231 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
232 goto exit;
233 }
234#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200236 mbedtls_record rec;
237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
239 if (ret != 0) {
240 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200241 goto exit;
242 }
243
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (ssl->transform_in != NULL) {
245 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
246 if (ret != 0) {
247 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200248 goto exit;
249 }
250 }
251 }
252#endif /* MBEDTLS_SSL_PROTO_DTLS */
253
254exit:
255 /* On success, we have decrypted the buffer in-place, so make
256 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200258
259 /* For the purpose of this API, treat messages with unexpected CID
260 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
262 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200263 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
264 }
265
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
267 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200268}
269
Hanno Becker67bc7c32018-08-06 11:33:50 +0100270#define SSL_DONT_FORCE_FLUSH 0
271#define SSL_FORCE_FLUSH 1
272
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200273#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100274
Hanno Beckerd5847772018-08-28 10:09:23 +0100275/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100276static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
277 uint8_t slot);
278static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200279MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100280static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100282static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200283MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100284static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100286static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
287 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100289static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100292{
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000294#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
295 size_t out_buf_len = ssl->out_buf_len;
296#else
297 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
298#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (mtu != 0 && mtu < out_buf_len) {
301 return mtu;
302 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100305}
306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100308static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100309{
Hanno Becker11682cc2018-08-22 14:41:02 +0100310 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100312
313 /* Double-check that the write-index hasn't gone
314 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100316 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100318 }
319
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100321}
322
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100324static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100325{
Janos Follath865b3eb2019-12-16 11:46:15 +0000326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100327 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400328 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100329
330#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100332
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100334 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100336
337 /* By the standard (RFC 6066 Sect. 4), the MFL extension
338 * only limits the maximum record payload size, so in theory
339 * we would be allowed to pack multiple records of payload size
340 * MFL into a single datagram. However, this would mean that there's
341 * no way to explicitly communicate MTU restrictions to the peer.
342 *
343 * The following reduction of max_len makes sure that we never
344 * write datagrams larger than MFL + Record Expansion Overhead.
345 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 if (max_len <= ssl->out_left) {
347 return 0;
348 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100349
350 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100351#endif
352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 ret = ssl_get_remaining_space_in_datagram(ssl);
354 if (ret < 0) {
355 return ret;
356 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100357 remaining = (size_t) ret;
358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 ret = mbedtls_ssl_get_record_expansion(ssl);
360 if (ret < 0) {
361 return ret;
362 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100363 expansion = (size_t) ret;
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (remaining <= expansion) {
366 return 0;
367 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100368
369 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100371 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100373
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100375}
376
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200377/*
378 * Double the retransmit timeout value, within the allowed range,
379 * returning -1 if the maximum value has already been reached.
380 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200381MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100382static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200383{
384 uint32_t new_timeout;
385
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
387 return -1;
388 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200389
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200390 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
391 * in the following way: after the initial transmission and a first
392 * retransmission, back off to a temporary estimated MTU of 508 bytes.
393 * This value is guaranteed to be deliverable (if not guaranteed to be
394 * delivered) of any compliant IPv4 (and IPv6) network, and should work
395 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200397 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400399 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200400
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200401 new_timeout = 2 * ssl->handshake->retransmit_timeout;
402
403 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 if (new_timeout < ssl->handshake->retransmit_timeout ||
405 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200406 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200407 }
408
409 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
411 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200412
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200414}
415
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200417{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200418 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
420 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200421}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200423
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100424/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000425 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200426 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000427
Ronald Cron6f135e12021-12-08 16:57:54 +0100428#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static size_t ssl_compute_padding_length(size_t len,
431 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100432{
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100434}
435
Hanno Becker581bc1b2020-05-04 12:20:03 +0100436/* This functions transforms a (D)TLS plaintext fragment and a record content
437 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
438 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
439 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100440 *
441 * struct {
442 * opaque content[DTLSPlaintext.length];
443 * ContentType real_type;
444 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100445 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100446 *
447 * Input:
448 * - `content`: The beginning of the buffer holding the
449 * plaintext to be wrapped.
450 * - `*content_size`: The length of the plaintext in Bytes.
451 * - `max_len`: The number of Bytes available starting from
452 * `content`. This must be `>= *content_size`.
453 * - `rec_type`: The desired record content type.
454 *
455 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100456 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
457 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100458 *
459 * Returns:
460 * - `0` on success.
461 * - A negative error code if `max_len` didn't offer enough space
462 * for the expansion.
463 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100465static int ssl_build_inner_plaintext(unsigned char *content,
466 size_t *content_size,
467 size_t remaining,
468 uint8_t rec_type,
469 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100470{
471 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100472
473 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 if (remaining == 0) {
475 return -1;
476 }
477 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100478 len++;
479 remaining--;
480
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (remaining < pad) {
482 return -1;
483 }
484 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100485 len += pad;
486 remaining -= pad;
487
488 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100490}
491
Hanno Becker581bc1b2020-05-04 12:20:03 +0100492/* This function parses a (D)TLSInnerPlaintext structure.
493 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static int ssl_parse_inner_plaintext(unsigned char const *content,
496 size_t *content_size,
497 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100498{
499 size_t remaining = *content_size;
500
501 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 do {
503 if (remaining == 0) {
504 return -1;
505 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100506 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100508
509 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100513}
Ronald Cron6f135e12021-12-08 16:57:54 +0100514#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100515
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200516/* The size of the `add_data` structure depends on various
517 * factors, namely
518 *
519 * 1) CID functionality disabled
520 *
521 * additional_data =
522 * 8: seq_num +
523 * 1: type +
524 * 2: version +
525 * 2: length of inner plaintext +
526 *
527 * size = 13 bytes
528 *
529 * 2) CID functionality based on RFC 9146 enabled
530 *
531 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
532 * = 23 + CID-length
533 *
534 * 3) CID functionality based on legacy CID version
535 according to draft-ietf-tls-dtls-connection-id-05
536 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
537 *
538 * size = 13 + 1 + CID-length
539 *
540 * More information about the CID usage:
541 *
542 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
543 * size of the additional data structure is calculated as:
544 *
545 * additional_data =
546 * 8: seq_num +
547 * 1: tls12_cid +
548 * 2: DTLSCipherText.version +
549 * n: cid +
550 * 1: cid_length +
551 * 2: length_of_DTLSInnerPlaintext
552 *
553 * Per RFC 9146 the size of the add_data structure is calculated as:
554 *
555 * additional_data =
556 * 8: seq_num_placeholder +
557 * 1: tls12_cid +
558 * 1: cid_length +
559 * 1: tls12_cid +
560 * 2: DTLSCiphertext.version +
561 * 2: epoch +
562 * 6: sequence_number +
563 * n: cid +
564 * 2: length_of_DTLSInnerPlaintext
565 *
566 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100567static void ssl_extract_add_data_from_record(unsigned char *add_data,
568 size_t *add_data_len,
569 mbedtls_record *rec,
570 mbedtls_ssl_protocol_version
571 tls_version,
572 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000573{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200574 /* Several types of ciphers have been defined for use with TLS and DTLS,
575 * and the MAC calculations for those ciphers differ slightly. Further
576 * variants were added when the CID functionality was added with RFC 9146.
577 * This implementations also considers the use of a legacy version of the
578 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
579 * which is used in deployments.
580 *
581 * We will distinguish between the non-CID and the CID cases below.
582 *
583 * --- Non-CID cases ---
584 *
585 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100586 *
587 * additional_data = seq_num + TLSCompressed.type +
588 * TLSCompressed.version + TLSCompressed.length;
589 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100590 * For TLS 1.3, the record sequence number is dropped from the AAD
591 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000592 * Moreover, the additional data involves the length of the TLS
593 * ciphertext, not the TLS plaintext as in earlier versions.
594 * Quoting RFC 8446 (TLS 1.3):
595 *
596 * additional_data = TLSCiphertext.opaque_type ||
597 * TLSCiphertext.legacy_record_version ||
598 * TLSCiphertext.length
599 *
600 * We pass the tag length to this function in order to compute the
601 * ciphertext length from the inner plaintext length rec->data_len via
602 *
603 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
604 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200605 * --- CID cases ---
606 *
607 * RFC 9146 uses a common pattern when constructing the data
608 * passed into a MAC / AEAD cipher.
609 *
610 * Data concatenation for MACs used with block ciphers with
611 * Encrypt-then-MAC Processing (with CID):
612 *
613 * data = seq_num_placeholder +
614 * tls12_cid +
615 * cid_length +
616 * tls12_cid +
617 * DTLSCiphertext.version +
618 * epoch +
619 * sequence_number +
620 * cid +
621 * DTLSCiphertext.length +
622 * IV +
623 * ENC(content + padding + padding_length)
624 *
625 * Data concatenation for MACs used with block ciphers (with CID):
626 *
627 * data = seq_num_placeholder +
628 * tls12_cid +
629 * cid_length +
630 * tls12_cid +
631 * DTLSCiphertext.version +
632 * epoch +
633 * sequence_number +
634 * cid +
635 * length_of_DTLSInnerPlaintext +
636 * DTLSInnerPlaintext.content +
637 * DTLSInnerPlaintext.real_type +
638 * DTLSInnerPlaintext.zeros
639 *
640 * AEAD ciphers use the following additional data calculation (with CIDs):
641 *
642 * additional_data = seq_num_placeholder +
643 * tls12_cid +
644 * cid_length +
645 * tls12_cid +
646 * DTLSCiphertext.version +
647 * epoch +
648 * sequence_number +
649 * cid +
650 * length_of_DTLSInnerPlaintext
651 *
652 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
653 * defines the additional data calculation as follows:
654 *
655 * additional_data = seq_num +
656 * tls12_cid +
657 * DTLSCipherText.version +
658 * cid +
659 * cid_length +
660 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100662
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100663 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000664 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100665
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
667 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
668 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
669#endif
670
Ronald Cron6f135e12021-12-08 16:57:54 +0100671#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000673 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
674 * which differs from the length of the TLSInnerPlaintext
675 * by the length of the authentication tag. */
676 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100678#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100679 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400680 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000681 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200682
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100683#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
685 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200686 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
688 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200689
690 // tls12_cid type
691 *cur = rec->type;
692 cur++;
693
694 // cid_length
695 *cur = rec->cid_len;
696 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100698#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200699 {
700 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 memcpy(cur, rec->ctr, sizeof(rec->ctr));
702 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200703 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100704 }
705
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200706 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100707 *cur = rec->type;
708 cur++;
709
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200710 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 memcpy(cur, rec->ver, sizeof(rec->ver));
712 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100713
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200714#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
715 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200718 // CID
719 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100720 cur += rec->cid_len;
721
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200722 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100723 *cur = rec->cid_len;
724 cur++;
725
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200726 // length of inner plaintext
727 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
728 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200730#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
731 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200734 // epoch + sequence number
735 memcpy(cur, rec->ctr, sizeof(rec->ctr));
736 cur += sizeof(rec->ctr);
737
738 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200740 cur += rec->cid_len;
741
742 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100744 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100746#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100747 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100749 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100750 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100751
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000752 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753}
754
Valerio Settie5707042023-10-11 11:54:42 +0200755#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200756MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100757static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100759{
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100761}
762
Hanno Becker17263802020-05-28 07:05:48 +0100763/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
764 *
765 * Concretely, this occurs in two variants:
766 *
767 * a) Fixed and dynamic IV lengths add up to total IV length, giving
768 * IV = fixed_iv || dynamic_iv
769 *
Hanno Becker15952812020-06-04 13:31:46 +0100770 * This variant is used in TLS 1.2 when used with GCM or CCM.
771 *
Hanno Becker17263802020-05-28 07:05:48 +0100772 * b) Fixed IV lengths matches total IV length, giving
773 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100774 *
775 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
776 *
777 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100778 *
779 * This function has the precondition that
780 *
781 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
782 *
783 * which has to be ensured by the caller. If this precondition
784 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100785 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100786static void ssl_build_record_nonce(unsigned char *dst_iv,
787 size_t dst_iv_len,
788 unsigned char const *fixed_iv,
789 size_t fixed_iv_len,
790 unsigned char const *dynamic_iv,
791 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100792{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100793 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 memset(dst_iv, 0, dst_iv_len);
795 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100796
Hanno Becker17263802020-05-28 07:05:48 +0100797 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100799}
Valerio Settie5707042023-10-11 11:54:42 +0200800#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
803 mbedtls_ssl_transform *transform,
Ben Taylor602b2962025-03-07 15:52:50 +0000804 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +0000805{
Neil Armstrong136f8402022-03-30 10:58:01 +0200806 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100807 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200809 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 * the description of ssl_extract_add_data_from_record().
811 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200812#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
813 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
814#else
815 unsigned char add_data[13];
816#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100817 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 size_t post_avail;
819
820 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000821#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200822 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000823 ((void) ssl);
824#endif
825
826 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200827 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100828#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
829 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000830 ((void) f_rng);
831 ((void) p_rng);
832#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000835
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 if (transform == NULL) {
837 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
838 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000839 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100841 || rec->buf == NULL
842 || rec->buf_len < rec->data_offset
843 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100844#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100845 || rec->cid_len != 0
846#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 ) {
848 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
849 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100850 }
851
Gilles Peskine449bd832023-01-11 14:50:10 +0100852 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200853
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000854 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
856 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
857 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000858
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
860 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
861 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
862 rec->data_len,
863 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100866
Hanno Becker92313402020-05-20 13:58:58 +0100867 /* The following two code paths implement the (D)TLSInnerPlaintext
868 * structure present in TLS 1.3 and DTLS 1.2 + CID.
869 *
870 * See ssl_build_inner_plaintext() for more information.
871 *
872 * Note that this changes `rec->data_len`, and hence
873 * `post_avail` needs to be recalculated afterwards.
874 *
875 * Note also that the two code paths cannot occur simultaneously
876 * since they apply to different versions of the protocol. There
877 * is hence no risk of double-addition of the inner plaintext.
878 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100879#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100881 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 ssl_compute_padding_length(rec->data_len,
883 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
884 if (ssl_build_inner_plaintext(data,
885 &rec->data_len,
886 post_avail,
887 rec->type,
888 padding) != 0) {
889 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100890 }
891
892 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
893 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100894#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100895
Hanno Beckera0e20d02019-05-15 14:03:01 +0100896#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100897 /*
898 * Add CID information
899 */
900 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
902 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100903
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100905 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 ssl_compute_padding_length(rec->data_len,
907 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100908 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100909 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100910 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100911 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100912 * Note that this changes `rec->data_len`, and hence
913 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100914 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 if (ssl_build_inner_plaintext(data,
916 &rec->data_len,
917 post_avail,
918 rec->type,
919 padding) != 0) {
920 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100921 }
922
923 rec->type = MBEDTLS_SSL_MSG_CID;
924 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100925#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100926
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100928
Paul Bakker5121ce52009-01-03 21:22:43 +0000929 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100930 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000931 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000932#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
934 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
935 if (post_avail < transform->maclen) {
936 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
937 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200939#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200940 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100942 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
943 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
944 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000945
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
947 transform->tls_version,
948 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
951 transform->psa_mac_alg);
952 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100953 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100955
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 status = psa_mac_update(&operation, add_data, add_data_len);
957 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100958 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 status = psa_mac_update(&operation, data, rec->data_len);
962 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100963 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100965
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
967 &sign_mac_length);
968 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100969 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000971
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200973#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200974
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
976 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200977
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 rec->data_len += transform->maclen;
979 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100980 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100981
Gilles Peskine449bd832023-01-11 14:50:10 +0100982hmac_failed_etm_disabled:
983 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500984 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 status = psa_mac_abort(&operation);
986 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500987 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 if (ret != 0) {
990 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
991 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100992 }
Paul Bakker577e0062013-08-28 11:57:20 +0200993 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000994#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000995
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200996 /*
997 * Encrypt
998 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000999#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1001 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1002 "including %d bytes of padding",
1003 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001004
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001005 /* The only supported stream cipher is "NULL",
1006 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001008#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001009
Valerio Settie5707042023-10-11 11:54:42 +02001010#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001012 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001013 unsigned char *dynamic_iv;
1014 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001015 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001018 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001019
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001020 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 if (post_avail < transform->taglen) {
1022 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1023 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001024 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001025
Paul Bakker68884e32013-01-07 18:20:04 +01001026 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001027 * Build nonce for AEAD encryption.
1028 *
1029 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1030 * part of the IV is prepended to the ciphertext and
1031 * can be chosen freely - in particular, it need not
1032 * agree with the record sequence number.
1033 * However, since ChaChaPoly as well as all AEAD modes
1034 * in TLS 1.3 use the record sequence number as the
1035 * dynamic part of the nonce, we uniformly use the
1036 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001037 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001038 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001040
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 ssl_build_record_nonce(iv, sizeof(iv),
1042 transform->iv_enc,
1043 transform->fixed_ivlen,
1044 dynamic_iv,
1045 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001046
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001047 /*
1048 * Build additional data for AEAD encryption.
1049 * This depends on the TLS version.
1050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1052 transform->tls_version,
1053 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1056 iv, transform->ivlen);
1057 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1058 dynamic_iv,
1059 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1060 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1061 add_data, add_data_len);
1062 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1063 "including 0 bytes of padding",
1064 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001065
Paul Bakker68884e32013-01-07 18:20:04 +01001066 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001067 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 status = psa_aead_encrypt(transform->psa_key_enc,
1070 transform->psa_alg,
1071 iv, transform->ivlen,
1072 add_data, add_data_len,
1073 data, rec->data_len,
1074 data, rec->buf_len - (data - rec->buf),
1075 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001078 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1080 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001081 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1084 data + rec->data_len - transform->taglen,
1085 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001086 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001087 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001088
1089 /*
1090 * Prefix record content with dynamic IV in case it is explicit.
1091 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (dynamic_iv_is_explicit != 0) {
1093 if (rec->data_offset < dynamic_iv_len) {
1094 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1095 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001096 }
1097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001099 rec->data_offset -= dynamic_iv_len;
1100 rec->data_len += dynamic_iv_len;
1101 }
1102
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001103 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 } else
Valerio Settie5707042023-10-11 11:54:42 +02001105#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001106#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1108 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001110 size_t padlen, i;
1111 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001112 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001113 size_t part_len;
1114 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001115
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001116 /* Currently we're always using minimal padding
1117 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1119 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001120 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001121 }
1122
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 /* Check there's enough space in the buffer for the padding. */
1124 if (post_avail < padlen + 1) {
1125 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1126 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1127 }
1128
1129 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001130 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001132
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001133 rec->data_len += padlen + 1;
1134 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001135
TRodziewicz0f82ec62021-05-12 17:49:18 +02001136#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001137 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001138 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001139 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001140 */
TRodziewicz345165c2021-07-06 13:42:11 +02001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 if (rec->data_offset < transform->ivlen) {
1143 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1144 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001145 }
1146
1147 /*
1148 * Generate IV
1149 */
Ben Taylor602b2962025-03-07 15:52:50 +00001150 ret = psa_generate_random(transform->iv_enc, transform->ivlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 if (ret != 0) {
1152 return ret;
1153 }
TRodziewicz345165c2021-07-06 13:42:11 +02001154
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001156#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1159 "including %"
1160 MBEDTLS_PRINTF_SIZET
1161 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1162 rec->data_len, transform->ivlen,
1163 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 status = psa_cipher_encrypt_setup(&cipher_op,
1166 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001169 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1171 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001172 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001173
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001175
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001177 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1179 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001180
1181 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 status = psa_cipher_update(&cipher_op,
1184 data, rec->data_len,
1185 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001188 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1190 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001191
1192 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 status = psa_cipher_finish(&cipher_op,
1195 data + olen, rec->data_len - olen,
1196 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001199 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1201 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001202
1203 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001204
1205 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 if (rec->data_len != olen) {
1208 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1209 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001210 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001211
TRodziewicz0f82ec62021-05-12 17:49:18 +02001212 data -= transform->ivlen;
1213 rec->data_offset -= transform->ivlen;
1214 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001218 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001219 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1220 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001221
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001222 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001223 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001224
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 if (post_avail < transform->maclen) {
1226 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1227 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001228 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001229
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 ssl_extract_add_data_from_record(add_data, &add_data_len,
1231 rec, transform->tls_version,
1232 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001233
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1235 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1236 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1238 transform->psa_mac_alg);
1239 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001240 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001242
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 status = psa_mac_update(&operation, add_data, add_data_len);
1244 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001245 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 status = psa_mac_update(&operation, data, rec->data_len);
1249 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001250 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001252
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1254 &sign_mac_length);
1255 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001256 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001258
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001260
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001261 rec->data_len += transform->maclen;
1262 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001263 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265hmac_failed_etm_enabled:
1266 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001267 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 status = psa_mac_abort(&operation);
1269 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001270 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 if (ret != 0) {
1273 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1274 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001275 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001276 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001279#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001280 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1282 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001283 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001284
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001285 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if (auth_done != 1) {
1287 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1288 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001289 }
1290
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001292
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001294}
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1297 mbedtls_ssl_transform *transform,
1298 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001299{
Valerio Settie5707042023-10-11 11:54:42 +02001300#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001301 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001302#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001303 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001304 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001305
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001306 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001307#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001308 size_t padlen = 0;
1309 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001310#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001312 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 * the description of ssl_extract_add_data_from_record().
1314 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001315#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1316 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1317#else
1318 unsigned char add_data[13];
1319#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001320 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001321
Hanno Beckera18d1322018-01-03 14:27:32 +00001322#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001323 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 ((void) ssl);
1325#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1328 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001329 rec->buf == NULL ||
1330 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 rec->buf_len - rec->data_offset < rec->data_len) {
1332 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1333 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001334 }
1335
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001336 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001338
Hanno Beckera0e20d02019-05-15 14:03:01 +01001339#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001340 /*
1341 * Match record's CID with incoming CID.
1342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 if (rec->cid_len != transform->in_cid_len ||
1344 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1345 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001346 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001347#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001348
Hanno Beckerd086bf02021-03-22 13:01:27 +00001349#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001351 if (rec->data_len < transform->maclen) {
1352 MBEDTLS_SSL_DEBUG_MSG(1,
1353 ("Record too short for MAC:"
1354 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1355 rec->data_len, transform->maclen));
1356 return MBEDTLS_ERR_SSL_INVALID_MAC;
1357 }
1358
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001359 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001360 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001362#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001363#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001365 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001366 unsigned char *dynamic_iv;
1367 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001368 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001369
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001370 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001371 * Extract dynamic part of nonce for AEAD decryption.
1372 *
1373 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1374 * part of the IV is prepended to the ciphertext and
1375 * can be chosen freely - in particular, it need not
1376 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 dynamic_iv_len = sizeof(rec->ctr);
1379 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1380 if (rec->data_len < dynamic_iv_len) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1382 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1383 rec->data_len,
1384 dynamic_iv_len));
1385 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001386 }
1387 dynamic_iv = data;
1388
1389 data += dynamic_iv_len;
1390 rec->data_offset += dynamic_iv_len;
1391 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001393 dynamic_iv = rec->ctr;
1394 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001395
1396 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 if (rec->data_len < transform->taglen) {
1398 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1399 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1400 rec->data_len,
1401 transform->taglen));
1402 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001403 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001404 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001405
Hanno Beckerdf8be222020-05-21 15:30:57 +01001406 /*
1407 * Prepare nonce from dynamic and static parts.
1408 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 ssl_build_record_nonce(iv, sizeof(iv),
1410 transform->iv_dec,
1411 transform->fixed_ivlen,
1412 dynamic_iv,
1413 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001414
Hanno Beckerdf8be222020-05-21 15:30:57 +01001415 /*
1416 * Build additional data for AEAD encryption.
1417 * This depends on the TLS version.
1418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1420 transform->tls_version,
1421 transform->taglen);
1422 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1423 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424
Hanno Beckerd96a6522019-07-10 13:55:25 +01001425 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001426 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001427 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001428 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001429 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1432 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1433 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001434
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001435 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001436 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 status = psa_aead_decrypt(transform->psa_key_dec,
1439 transform->psa_alg,
1440 iv, transform->ivlen,
1441 add_data, add_data_len,
1442 data, rec->data_len + transform->taglen,
1443 data, rec->buf_len - (data - rec->buf),
1444 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001445
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001447 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1449 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001450 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001451
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001452 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001453
Hanno Beckerd96a6522019-07-10 13:55:25 +01001454 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 if (olen != rec->data_len) {
1456 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1457 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001458 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 } else
Valerio Settie5707042023-10-11 11:54:42 +02001460#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001461#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1463 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001464 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001465 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001466 size_t part_len;
1467 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001468
Paul Bakker5121ce52009-01-03 21:22:43 +00001469 /*
Paul Bakker45829992013-01-03 14:52:21 +01001470 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001472#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001473 /* The ciphertext is prefixed with the CBC IV. */
1474 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001475#endif
Paul Bakker45829992013-01-03 14:52:21 +01001476
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001477 /* Size considerations:
1478 *
1479 * - The CBC cipher text must not be empty and hence
1480 * at least of size transform->ivlen.
1481 *
1482 * Together with the potential IV-prefix, this explains
1483 * the first of the two checks below.
1484 *
1485 * - The record must contain a MAC, either in plain or
1486 * encrypted, depending on whether Encrypt-then-MAC
1487 * is used or not.
1488 * - If it is, the message contains the IV-prefix,
1489 * the CBC ciphertext, and the MAC.
1490 * - If it is not, the padded plaintext, and hence
1491 * the CBC ciphertext, has at least length maclen + 1
1492 * because there is at least the padding length byte.
1493 *
1494 * As the CBC ciphertext is not empty, both cases give the
1495 * lower bound minlen + maclen + 1 on the record size, which
1496 * we test for in the second check below.
1497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 if (rec->data_len < minlen + transform->ivlen ||
1499 rec->data_len < minlen + transform->maclen + 1) {
1500 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1501 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1502 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1503 "+ 1 ) ( + expl IV )",
1504 rec->data_len,
1505 transform->ivlen,
1506 transform->maclen));
1507 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001508 }
1509
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001510 /*
1511 * Authenticate before decrypt if enabled
1512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001515 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001516
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001518
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 /* Update data_len in tandem with add_data.
1520 *
1521 * The subtraction is safe because of the previous check
1522 * data_len >= minlen + maclen + 1.
1523 *
1524 * Afterwards, we know that data + data_len is followed by at
1525 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001526 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001527 *
1528 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1531 transform->tls_version,
1532 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001533
Hanno Beckerd96a6522019-07-10 13:55:25 +01001534 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1536 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1538 transform->psa_mac_alg);
1539 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001540 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 status = psa_mac_update(&operation, add_data, add_data_len);
1544 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001545 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 status = psa_mac_update(&operation, data, rec->data_len);
1549 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001550 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001552
1553 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1555 transform->maclen);
1556 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001557 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001559 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001562 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 status = psa_mac_abort(&operation);
1564 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001565 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 if (ret != 0) {
1568 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1569 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1570 }
1571 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001572 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001573 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001575
1576 /*
1577 * Check length sanity
1578 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001579
1580 /* We know from above that data_len > minlen >= 0,
1581 * so the following check in particular implies that
1582 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if (rec->data_len % transform->ivlen != 0) {
1584 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1585 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1586 rec->data_len, transform->ivlen));
1587 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001588 }
1589
TRodziewicz0f82ec62021-05-12 17:49:18 +02001590#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001591 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001592 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001593 */
TRodziewicz345165c2021-07-06 13:42:11 +02001594 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001596
TRodziewicz345165c2021-07-06 13:42:11 +02001597 data += transform->ivlen;
1598 rec->data_offset += transform->ivlen;
1599 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001600#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001601
Hanno Beckerd96a6522019-07-10 13:55:25 +01001602 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 status = psa_cipher_decrypt_setup(&cipher_op,
1605 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001608 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1610 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001611 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001616 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1618 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001619 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 status = psa_cipher_update(&cipher_op,
1622 data, rec->data_len,
1623 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001626 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1628 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001629 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 status = psa_cipher_finish(&cipher_op,
1632 data + olen, rec->data_len - olen,
1633 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001636 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1638 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001639 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640
1641 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001642
Hanno Beckerd96a6522019-07-10 13:55:25 +01001643 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if (rec->data_len != olen) {
1645 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1646 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001647 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001648
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001649 /* Safe since data_len >= minlen + maclen + 1, so after having
1650 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001651 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1652 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001653 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001656 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 rec->data_len,
1658 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001659 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001660 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 if (rec->data_len < transform->maclen + padlen + 1) {
1664 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1665 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1666 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1667 rec->data_len,
1668 transform->maclen,
1669 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001670 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001671#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001672 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 rec->data_len,
1674 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001675 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001676 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001677 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001678
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001679 padlen++;
1680
1681 /* Regardless of the validity of the padding,
1682 * we have data_len >= padlen here. */
1683
TRodziewicz0f82ec62021-05-12 17:49:18 +02001684#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001685 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 * consecutive memory reads at the end of the record
1687 * plaintext buffer. In order to hide the length and
1688 * validity of the padding, always perform exactly
1689 * `min(256,plaintext_len)` reads (but take into account
1690 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001691 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001693
1694 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001696 size_t const padding_idx = rec->data_len - padlen;
1697 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1698 size_t const start_idx = rec->data_len - num_checks;
1699 size_t idx;
1700
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001702 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 * (check[idx] == padlen - 1);
1704 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001705 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001706 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001707 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001708 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001709 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001710 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001711 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001714 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1716 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001717#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001718 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001719
TRodziewicz0f82ec62021-05-12 17:49:18 +02001720#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001721
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001722 /* If the padding was found to be invalid, padlen == 0
1723 * and the subtraction is safe. If the padding was found valid,
1724 * padlen hasn't been changed and the previous assertion
1725 * data_len >= padlen still holds. */
1726 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001728#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001729 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1731 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001732 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001734#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1736 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001737#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001738
1739 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001740 * Authenticate if not done yet.
1741 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001742 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001743#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001745 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1746 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001747
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001748 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001749 * data_len < maclen + padlen + 1, then padlen
1750 * got reset to 1, and the initial check
1751 * data_len >= minlen + maclen + 1
1752 * guarantees that at this point we still
1753 * have at least data_len >= maclen.
1754 *
1755 * If the initial value of padlen was such that
1756 * data_len >= maclen + padlen + 1, then we have
1757 * subtracted either padlen + 1 (if the padding was correct)
1758 * or 0 (if the padding was incorrect) since then,
1759 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001760 *
1761 * For stream ciphers, we checked above that
1762 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001763 */
1764 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1766 transform->tls_version,
1767 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001768
TRodziewicz0f82ec62021-05-12 17:49:18 +02001769#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001770 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 * The next two sizes are the minimum and maximum values of
1772 * data_len over all padlen values.
1773 *
1774 * They're independent of padlen, since we previously did
1775 * data_len -= padlen.
1776 *
1777 * Note that max_len + maclen is never more than the buffer
1778 * length, as we previously did in_msglen -= maclen too.
1779 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001780 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1784 transform->psa_mac_alg,
1785 add_data, add_data_len,
1786 data, rec->data_len, min_len, max_len,
1787 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 if (ret != 0) {
1789 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001790 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001791 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ct_memcpy_offset(mac_peer, data,
1794 rec->data_len,
1795 min_len, max_len,
1796 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001797#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001798
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001799#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1801 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001802#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1805 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001808#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001809 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001810 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001811 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813hmac_failed_etm_disabled:
1814 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1815 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1816 if (ret != 0) {
1817 return ret;
1818 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001819 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001820
1821 /*
1822 * Finally check the correct flag
1823 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001824 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 return MBEDTLS_ERR_SSL_INVALID_MAC;
1826 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001827#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001828
1829 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (auth_done != 1) {
1831 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1832 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001833 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001834
Ronald Cron6f135e12021-12-08 16:57:54 +01001835#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001837 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1839 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (ret != 0) {
1842 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1843 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001844 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001845#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001846
Hanno Beckera0e20d02019-05-15 14:03:01 +01001847#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 if (rec->cid_len != 0) {
1849 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1850 &rec->type);
1851 if (ret != 0) {
1852 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1853 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001854 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001855#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001860}
1861
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001862#undef MAC_NONE
1863#undef MAC_PLAINTEXT
1864#undef MAC_CIPHERTEXT
1865
Paul Bakker5121ce52009-01-03 21:22:43 +00001866/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001867 * Fill the input message buffer by appending data to it.
1868 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001869 *
1870 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1871 * available (from this read and/or a previous one). Otherwise, an error code
1872 * is returned (possibly EOF or WANT_READ).
1873 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001874 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1875 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1876 * since we always read a whole datagram at once.
1877 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001878 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001879 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001881int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001882{
Janos Follath865b3eb2019-12-16 11:46:15 +00001883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001884 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001885#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1886 size_t in_buf_len = ssl->in_buf_len;
1887#else
1888 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1889#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001892
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1894 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001896 }
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1899 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1900 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001901 }
1902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001905 uint32_t timeout;
1906
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001907 /*
1908 * The point is, we need to always read a full datagram at once, so we
1909 * sometimes read more then requested, and handle the additional data.
1910 * It could be the rest of the current record (while fetching the
1911 * header) and/or some other records in the same datagram.
1912 */
1913
1914 /*
1915 * Move to the next record in the already read datagram if applicable
1916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (ssl->next_record_offset != 0) {
1918 if (ssl->in_left < ssl->next_record_offset) {
1919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1920 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001921 }
1922
1923 ssl->in_left -= ssl->next_record_offset;
1924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (ssl->in_left != 0) {
1926 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1927 MBEDTLS_PRINTF_SIZET,
1928 ssl->next_record_offset));
1929 memmove(ssl->in_hdr,
1930 ssl->in_hdr + ssl->next_record_offset,
1931 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001932 }
1933
1934 ssl->next_record_offset = 0;
1935 }
1936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1938 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1939 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001940
1941 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001942 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (nb_want <= ssl->in_left) {
1945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1946 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001947 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001948
1949 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001950 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001951 * are not at the beginning of a new record, the caller did something
1952 * wrong.
1953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (ssl->in_left != 0) {
1955 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1956 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001957 }
1958
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001959 /*
1960 * Don't even try to read if time's out already.
1961 * This avoids by-passing the timer when repeatedly receiving messages
1962 * that will end up being dropped.
1963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 if (mbedtls_ssl_check_timer(ssl) != 0) {
1965 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001966 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001968 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001971 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001973 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (ssl->f_recv_timeout != NULL) {
1979 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1980 timeout);
1981 } else {
1982 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1983 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 if (ret == 0) {
1988 return MBEDTLS_ERR_SSL_CONN_EOF;
1989 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001990 }
1991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1993 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
1994 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
1997 if (ssl_double_retransmit_timeout(ssl) != 0) {
1998 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
1999 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002000 }
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2003 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2004 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002005 }
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002008 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2011 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2012 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2013 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2014 ret);
2015 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002016 }
2017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002019 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002021 }
2022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 if (ret < 0) {
2024 return ret;
2025 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002026
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002027 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002029#endif
2030 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2032 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2033 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002036 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002039 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 } else {
2041 if (ssl->f_recv_timeout != NULL) {
2042 ret = ssl->f_recv_timeout(ssl->p_bio,
2043 ssl->in_hdr + ssl->in_left, len,
2044 ssl->conf->read_timeout);
2045 } else {
2046 ret = ssl->f_recv(ssl->p_bio,
2047 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002048 }
2049 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2052 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2053 ssl->in_left, nb_want));
2054 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 if (ret == 0) {
2057 return MBEDTLS_ERR_SSL_CONN_EOF;
2058 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (ret < 0) {
2061 return ret;
2062 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002063
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002064 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 MBEDTLS_SSL_DEBUG_MSG(1,
2066 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2067 " were requested",
2068 ret, len));
2069 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002070 }
2071
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002072 ssl->in_left += ret;
2073 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002079}
2080
2081/*
2082 * Flush any data not yet written
2083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002084int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002085{
Janos Follath865b3eb2019-12-16 11:46:15 +00002086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002087 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (ssl->f_send == NULL) {
2092 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002094 }
2095
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002096 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (ssl->out_left == 0) {
2098 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2099 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002100 }
2101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 while (ssl->out_left > 0) {
2103 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2104 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2105 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002106
Hanno Becker2b1e3542018-08-06 11:19:13 +01002107 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (ret <= 0) {
2113 return ret;
2114 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002115
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002116 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_DEBUG_MSG(1,
2118 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2119 " bytes were sent",
2120 ret, ssl->out_left));
2121 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002122 }
2123
Paul Bakker5121ce52009-01-03 21:22:43 +00002124 ssl->out_left -= ret;
2125 }
2126
Hanno Becker2b1e3542018-08-06 11:19:13 +01002127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002129 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002131#endif
2132 {
2133 ssl->out_hdr = ssl->out_buf + 8;
2134 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002140}
2141
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002142/*
2143 * Functions to handle the DTLS retransmission state machine
2144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146/*
2147 * Append current handshake message to current outgoing flight
2148 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002149MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002150static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002151{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2154 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2155 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156
2157 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2159 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2160 sizeof(mbedtls_ssl_flight_item)));
2161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162 }
2163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2165 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2166 ssl->out_msglen));
2167 mbedtls_free(msg);
2168 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002169 }
2170
2171 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002173 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002174 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002175 msg->next = NULL;
2176
2177 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002179 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002183 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002185 cur->next = msg;
2186 }
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2189 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190}
2191
2192/*
2193 * Free the current flight of handshake messages
2194 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002195void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002196{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 mbedtls_ssl_flight_item *cur = flight;
2198 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002201 next = cur->next;
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 mbedtls_free(cur->p);
2204 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002205
2206 cur = next;
2207 }
2208}
2209
2210/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002211 * Swap transform_out and out_ctr with the alternative ones
2212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002213MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002214static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002215{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002217 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2220 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2221 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002222 }
2223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002225
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002226 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227 tmp_transform = ssl->transform_out;
2228 ssl->transform_out = ssl->handshake->alt_transform_out;
2229 ssl->handshake->alt_transform_out = tmp_transform;
2230
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002231 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2233 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2234 sizeof(ssl->cur_out_ctr));
2235 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2236 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002237
2238 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002242}
2243
2244/*
2245 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002247int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002248{
2249 int ret = 0;
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002258}
2259
2260/*
2261 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002262 *
2263 * Need to remember the current message in case flush_output returns
2264 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002267int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002268{
Janos Follath865b3eb2019-12-16 11:46:15 +00002269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2273 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002274
2275 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002276 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 ret = ssl_swap_epochs(ssl);
2278 if (ret != 0) {
2279 return ret;
2280 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002281
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002282 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002283 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002286 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002287 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002288
Hanno Beckere1dcb032018-08-17 16:47:58 +01002289 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2291 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002292
Ronald Cron00d012f22022-03-08 15:57:12 +01002293 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002295
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002296 /* Swap epochs before sending Finished: we can't do it after
2297 * sending ChangeCipherSpec, in case write returns WANT_READ.
2298 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2300 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2301 ret = ssl_swap_epochs(ssl);
2302 if (ret != 0) {
2303 return ret;
2304 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002305 }
2306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 ret = ssl_get_remaining_payload_in_datagram(ssl);
2308 if (ret < 0) {
2309 return ret;
2310 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002311 max_frag_len = (size_t) ret;
2312
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002313 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2315 if (max_frag_len == 0) {
2316 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2317 return ret;
2318 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002319
2320 continue;
2321 }
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002324 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002325 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002326
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002327 /* Update position inside current message */
2328 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002330 const unsigned char * const p = ssl->handshake->cur_msg_p;
2331 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002332 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002333 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002334 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2337 if (is_finished) {
2338 ret = ssl_swap_epochs(ssl);
2339 if (ret != 0) {
2340 return ret;
2341 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002342 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002343
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2345 return ret;
2346 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002347
2348 continue;
2349 }
2350 max_hs_frag_len = max_frag_len - 12;
2351
2352 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2356 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2357 (unsigned) cur_hs_frag_len,
2358 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002359 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002360
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002361 /* Messages are stored with handshake headers as if not fragmented,
2362 * copy beginning of headers then fill fragmentation fields.
2363 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2367 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2368 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002369
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2371 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2372 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002375
Hanno Becker3f7b9732018-08-28 09:53:25 +01002376 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002378 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379 ssl->out_msgtype = cur->type;
2380
2381 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002382 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002383 }
2384
2385 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2387 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002388 ssl->handshake->cur_msg = cur->next;
2389 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002391 ssl->handshake->cur_msg = NULL;
2392 ssl->handshake->cur_msg_p = NULL;
2393 }
2394 }
2395
2396 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2398 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2399 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400 }
2401 }
2402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2404 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002405 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 /* Update state and set timer */
2408 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2409 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2410 } else {
2411 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2412 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2413 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2416
2417 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002418}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002419
2420/*
2421 * To be called when the last message of an incoming flight is received.
2422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002424{
2425 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002427 ssl->handshake->flight = NULL;
2428 ssl->handshake->cur_msg = NULL;
2429
2430 /* The next incoming flight will start with this msg_seq */
2431 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2432
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002433 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002434 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002435
Hanno Becker0271f962018-08-16 13:23:47 +01002436 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002438
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002439 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2443 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002448}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002449
2450/*
2451 * To be called when the last message of an outgoing flight is send.
2452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002454{
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 ssl_reset_retransmit_timeout(ssl);
2456 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2459 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002464}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466
Paul Bakker5121ce52009-01-03 21:22:43 +00002467/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002468 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002469 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002470int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002472{
2473 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002474 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002475 * ...
2476 * HandshakeType msg_type;
2477 * uint24 length;
2478 * ...
2479 */
2480 *buf = ssl->out_msg + 4;
2481 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2482
2483 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2484 ssl->out_msg[0] = hs_type;
2485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002487}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002488
2489/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002490 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002491 *
2492 * - fill in handshake headers
2493 * - update handshake checksum
2494 * - DTLS: save message for resending
2495 * - then pass to the record layer
2496 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002497 * DTLS: except for HelloRequest, messages are only queued, and will only be
2498 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002499 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002500 * Inputs:
2501 * - ssl->out_msglen: 4 + actual handshake message len
2502 * (4 is the size of handshake headers for TLS)
2503 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2504 * - ssl->out_msg + 4: the handshake message body
2505 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002506 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002507 * - ssl->out_msglen: the length of the record contents
2508 * (including handshake headers but excluding record headers)
2509 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002511int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2512 int update_checksum,
2513 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002514{
Janos Follath865b3eb2019-12-16 11:46:15 +00002515 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002516 const size_t hs_len = ssl->out_msglen - 4;
2517 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002518
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002521 /*
2522 * Sanity checks
2523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2525 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2526 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2527 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002528 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002529
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002530 /* Whenever we send anything different from a
2531 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2533 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2534 ssl->handshake == NULL) {
2535 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2536 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002537 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002541 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2543 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2544 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002545 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002546#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002547
Hanno Beckerb50a2532018-08-06 11:52:54 +01002548 /* Double-check that we did not exceed the bounds
2549 * of the outgoing record buffer.
2550 * This should never fail as the various message
2551 * writing functions must obey the bounds of the
2552 * outgoing record buffer, but better be safe.
2553 *
2554 * Note: We deliberately do not check for the MTU or MFL here.
2555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2557 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2558 "size %" MBEDTLS_PRINTF_SIZET
2559 ", maximum %" MBEDTLS_PRINTF_SIZET,
2560 ssl->out_msglen,
2561 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2562 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002563 }
2564
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002565 /*
2566 * Fill handshake headers
2567 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2569 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2570 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2571 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002572
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002573 /*
2574 * DTLS has additional fields in the Handshake layer,
2575 * between the length field and the actual payload:
2576 * uint16 message_seq;
2577 * uint24 fragment_offset;
2578 * uint24 fragment_length;
2579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002582 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2584 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2585 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2586 MBEDTLS_PRINTF_SIZET,
2587 hs_len,
2588 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002590 }
2591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002593 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002594
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002595 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2597 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2598 ++(ssl->handshake->out_msg_seq);
2599 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002600 ssl->out_msg[4] = 0;
2601 ssl->out_msg[5] = 0;
2602 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002603
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002604 /* Handshake hashes are computed without fragmentation,
2605 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 memset(ssl->out_msg + 6, 0x00, 3);
2607 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002608 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002610
Hanno Becker0207e532018-08-28 10:28:28 +01002611 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002613 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2614 ssl->out_msglen);
2615 if (ret != 0) {
2616 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2617 return ret;
2618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002620 }
2621
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002622 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2625 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2626 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2627 if ((ret = ssl_flight_append(ssl)) != 0) {
2628 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2629 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002630 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002632#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002633 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2635 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2636 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002637 }
2638 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002643}
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2646 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002647{
2648 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2649 size_t msg_with_header_len;
2650 ((void) buf_len);
2651
2652 /* Add reserved 4 bytes for handshake header */
2653 msg_with_header_len = msg_len + 4;
2654 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002656
2657cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002659}
2660
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002661/*
2662 * Record layer functions
2663 */
2664
2665/*
2666 * Write current record.
2667 *
2668 * Uses:
2669 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2670 * - ssl->out_msglen: length of the record content (excl headers)
2671 * - ssl->out_msg: record content
2672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002673int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002674{
2675 int ret, done = 0;
2676 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002677 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002682 unsigned i;
2683 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002684#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2685 size_t out_buf_len = ssl->out_buf_len;
2686#else
2687 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2688#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002689 /* Skip writing the record content type to after the encryption,
2690 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002691 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002692#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002693 /* TLS 1.3 still uses the TLS 1.2 version identifier
2694 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002696 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002698#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2700 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2703 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002706 mbedtls_record rec;
2707
2708 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002709 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002710 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002711 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2714 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002715 rec.type = ssl->out_msgtype;
2716
Hanno Beckera0e20d02019-05-15 14:03:01 +01002717#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002718 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002719 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002720#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002721
Ben Taylor602b2962025-03-07 15:52:50 +00002722 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2724 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002725 }
2726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 if (rec.data_offset != 0) {
2728 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2729 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002730 }
2731
Hanno Becker6430faf2019-05-08 11:57:13 +01002732 /* Update the record content type and CID. */
2733 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002734#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2735 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002736#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002737 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002739 }
2740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002742
2743#if defined(MBEDTLS_SSL_PROTO_DTLS)
2744 /* In case of DTLS, double-check that we don't exceed
2745 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2747 ret = ssl_get_remaining_space_in_datagram(ssl);
2748 if (ret < 0) {
2749 return ret;
2750 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002753 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002755 }
2756 }
2757#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002758
Hanno Becker6430faf2019-05-08 11:57:13 +01002759 /* Now write the potentially updated record content type. */
2760 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2763 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2764 ssl->out_hdr[0], ssl->out_hdr[1],
2765 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2768 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002769
2770 ssl->out_left += protected_record_size;
2771 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2775 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002776 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 }
2778 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002779
Gabor Mezei96ae9262022-06-28 11:45:18 +02002780 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (i == mbedtls_ssl_ep_len(ssl)) {
2782 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2783 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002784 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002785 }
2786
Hanno Becker67bc7c32018-08-06 11:33:50 +01002787#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2789 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002790 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 ret = ssl_get_remaining_payload_in_datagram(ssl);
2792 if (ret < 0) {
2793 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2794 ret);
2795 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002796 }
2797
2798 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002800 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 } else {
2802 MBEDTLS_SSL_DEBUG_MSG(2,
2803 ("Still %u bytes available in current datagram",
2804 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002805 }
2806 }
2807#endif /* MBEDTLS_SSL_PROTO_DTLS */
2808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if ((flush == SSL_FORCE_FLUSH) &&
2810 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2811 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2812 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002813 }
2814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002818}
2819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002821
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002823static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002824{
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if (ssl->in_msglen < ssl->in_hslen ||
2826 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2827 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2828 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002831}
Hanno Becker44650b72018-08-16 12:51:11 +01002832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002834{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002835 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002836}
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002839{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002840 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002841}
2842
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002843MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002844static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002845{
2846 uint32_t msg_len, frag_off, frag_len;
2847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 msg_len = ssl_get_hs_total_len(ssl);
2849 frag_off = ssl_get_hs_frag_off(ssl);
2850 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (frag_off > msg_len) {
2853 return -1;
2854 }
Hanno Becker44650b72018-08-16 12:51:11 +01002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (frag_len > msg_len - frag_off) {
2857 return -1;
2858 }
Hanno Becker44650b72018-08-16 12:51:11 +01002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (frag_len + 12 > ssl->in_msglen) {
2861 return -1;
2862 }
Hanno Becker44650b72018-08-16 12:51:11 +01002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002865}
2866
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002867/*
2868 * Mark bits in bitmask (used for DTLS HS reassembly)
2869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002871{
2872 unsigned int start_bits, end_bits;
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 start_bits = 8 - (offset % 8);
2875 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002876 size_t first_byte_idx = offset / 8;
2877
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002878 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (len <= start_bits) {
2880 for (; len != 0; len--) {
2881 mask[first_byte_idx] |= 1 << (start_bits - len);
2882 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002883
2884 /* Avoid potential issues with offset or len becoming invalid */
2885 return;
2886 }
2887
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002888 offset += start_bits; /* Now offset % 8 == 0 */
2889 len -= start_bits;
2890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 for (; start_bits != 0; start_bits--) {
2892 mask[first_byte_idx] |= 1 << (start_bits - 1);
2893 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002894 }
2895
2896 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if (end_bits != 0) {
2898 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002899
2900 len -= end_bits; /* Now len % 8 == 0 */
2901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 for (; end_bits != 0; end_bits--) {
2903 mask[last_byte_idx] |= 1 << (8 - end_bits);
2904 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002905 }
2906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002908}
2909
2910/*
2911 * Check that bitmask is full
2912 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002914static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002915{
2916 size_t i;
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 for (i = 0; i < len / 8; i++) {
2919 if (mask[i] != 0xFF) {
2920 return -1;
2921 }
2922 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 for (i = 0; i < len % 8; i++) {
2925 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2926 return -1;
2927 }
2928 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002931}
2932
Hanno Becker56e205e2018-08-16 09:06:12 +01002933/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2935 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002936{
Hanno Becker56e205e2018-08-16 09:06:12 +01002937 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002938
Hanno Becker56e205e2018-08-16 09:06:12 +01002939 alloc_len = 12; /* Handshake header */
2940 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 if (add_bitmap) {
2943 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 }
2946 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002947}
Hanno Becker56e205e2018-08-16 09:06:12 +01002948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002952{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002953 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002954}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002957{
Gilles Peskine7a176962025-02-28 21:59:12 +01002958 if (ssl->in_hsfraglen == 0) {
2959 /* The handshake message must at least include the header.
2960 * We may not have the full message yet in case of fragmentation.
2961 * To simplify the code, we insist on having the header (and in
2962 * particular the handshake message length) in the first
2963 * fragment. */
2964 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2965 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2966 ssl->in_msglen));
2967 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2968 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002969
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002970 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002971 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2974 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2975 MBEDTLS_PRINTF_SIZET,
2976 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002977
Gilles Peskine235eae92025-02-28 22:02:52 +01002978 if (ssl->transform_in != NULL) {
2979 MBEDTLS_SSL_DEBUG_MSG(4, ("decrypted handshake message:"
2980 " iv-buf=%d hdr-buf=%d hdr-buf=%d",
2981 (int) (ssl->in_iv - ssl->in_buf),
2982 (int) (ssl->in_hdr - ssl->in_buf),
2983 (int) (ssl->in_msg - ssl->in_buf)));
2984 }
2985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002988 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002989 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (ssl_check_hs_header(ssl) != 0) {
2992 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2993 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002994 }
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 if (ssl->handshake != NULL &&
2997 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2998 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2999 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3000 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3001 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3002 MBEDTLS_SSL_DEBUG_MSG(2,
3003 (
3004 "received future handshake message of sequence number %u (next %u)",
3005 recv_msg_seq,
3006 ssl->handshake->in_msg_seq));
3007 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003008 }
3009
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003010 /* Retransmit only on last message from previous flight, to avoid
3011 * too many retransmissions.
3012 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3014 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3015 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3016 "message_seq = %u, start_of_flight = %u",
3017 recv_msg_seq,
3018 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3021 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3022 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003023 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 } else {
3025 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3026 "message_seq = %u, expected = %u",
3027 recv_msg_seq,
3028 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003029 }
3030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003032 }
3033 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003034
Hanno Becker6d97ef52018-08-16 13:09:04 +01003035 /* Message reassembly is handled alongside buffering of future
3036 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003037 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003038 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3040 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3041 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003042 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskinee85ece62025-02-28 22:24:56 +01003045 {
3046 unsigned char *const reassembled_record_start =
3047 ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3048 unsigned char *const payload_start =
3049 reassembled_record_start + mbedtls_ssl_in_hdr_len(ssl);
3050 unsigned char *payload_end = payload_start + ssl->in_hsfraglen;
Gilles Peskine15c072f2025-03-06 19:03:00 +01003051 /* How many more bytes we want to have a complete handshake message. */
3052 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
3053 /* How many bytes of the current record are part of the first
3054 * handshake message. There may be more handshake messages (possibly
3055 * incomplete) in the same record; if so, we leave them after the
3056 * current record, and ssl_consume_current_message() will take
3057 * care of consuming the next handshake message. */
3058 const size_t hs_this_fragment_len =
3059 ssl->in_msglen > hs_remain ? hs_remain : ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003060 (void) hs_this_fragment_len;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003061
Gilles Peskineafb254c2025-03-06 19:23:22 +01003062 MBEDTLS_SSL_DEBUG_MSG(3,
3063 ("%s handshake fragment: %" MBEDTLS_PRINTF_SIZET
3064 ", %" MBEDTLS_PRINTF_SIZET
3065 "..%" MBEDTLS_PRINTF_SIZET
3066 " of %" MBEDTLS_PRINTF_SIZET,
3067 (ssl->in_hsfraglen != 0 ?
3068 "subsequent" :
3069 hs_this_fragment_len == ssl->in_hslen ?
3070 "sole" :
3071 "initial"),
3072 ssl->in_msglen,
3073 ssl->in_hsfraglen,
3074 ssl->in_hsfraglen + hs_this_fragment_len,
3075 ssl->in_hslen));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003076
3077 /* Move the received handshake fragment to have the whole message
3078 * (at least the part received so far) in a single segment at a
3079 * known offset in the input buffer.
3080 * - When receiving a non-initial handshake fragment, append it to
3081 * the initial segment.
3082 * - Even the initial handshake fragment is moved, if it was
3083 * encrypted with an explicit IV: decryption leaves the payload
3084 * after the explicit IV, but here we move it to start where the
3085 * IV was.
3086 */
3087#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3088 size_t const in_buf_len = ssl->in_buf_len;
3089#else
3090 size_t const in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3091#endif
Gilles Peskine0851ec92025-03-06 15:15:20 +01003092 if (payload_end + ssl->in_msglen > ssl->in_buf + in_buf_len) {
Gilles Peskinee85ece62025-02-28 22:24:56 +01003093 MBEDTLS_SSL_DEBUG_MSG(1,
3094 ("Shouldn't happen: no room to move handshake fragment %"
3095 MBEDTLS_PRINTF_SIZET " from %p to %p (buf=%p len=%"
3096 MBEDTLS_PRINTF_SIZET ")",
3097 ssl->in_msglen,
Gilles Peskine90a95932025-02-25 23:57:20 +01003098 (void *) ssl->in_msg, (void *) payload_end,
3099 (void *) ssl->in_buf, in_buf_len));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003100 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3101 }
3102 memmove(payload_end, ssl->in_msg, ssl->in_msglen);
3103
3104 ssl->in_hsfraglen += ssl->in_msglen;
3105 payload_end += ssl->in_msglen;
3106
3107 if (ssl->in_hsfraglen < ssl->in_hslen) {
3108 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3109 MBEDTLS_PRINTF_SIZET "/%"
3110 MBEDTLS_PRINTF_SIZET,
3111 ssl->in_hsfraglen, ssl->in_hslen));
3112 ssl->in_hdr = payload_end;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003113 ssl->in_msglen = 0;
3114 mbedtls_ssl_update_in_pointers(ssl);
3115 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003116 } else {
3117 ssl->in_msglen = ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003118 ssl->in_hsfraglen = 0;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003119 ssl->in_hdr = reassembled_record_start;
3120 mbedtls_ssl_update_in_pointers(ssl);
3121
3122 /* Update the record length in the fully reassembled record */
3123 if (ssl->in_msglen > 0xffff) {
3124 MBEDTLS_SSL_DEBUG_MSG(1,
Gilles Peskinee34ec862025-03-07 10:43:39 +01003125 ("Shouldn't happen: in_msglen=%"
Gilles Peskinee85ece62025-02-28 22:24:56 +01003126 MBEDTLS_PRINTF_SIZET " > 0xffff",
3127 ssl->in_msglen));
3128 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3129 }
3130 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
3131
Gilles Peskine15c072f2025-03-06 19:03:00 +01003132 size_t record_len = mbedtls_ssl_in_hdr_len(ssl) + ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003133 (void) record_len;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003134 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
Gilles Peskine15c072f2025-03-06 19:03:00 +01003135 ssl->in_hdr, record_len);
3136 if (ssl->in_hslen < ssl->in_msglen) {
3137 MBEDTLS_SSL_DEBUG_MSG(3,
3138 ("More handshake messages in the record: "
Gilles Peskineb8f1e4b2025-03-06 21:32:08 +01003139 "%" MBEDTLS_PRINTF_SIZET " + %" MBEDTLS_PRINTF_SIZET,
Gilles Peskine15c072f2025-03-06 19:03:00 +01003140 ssl->in_hslen,
3141 ssl->in_msglen - ssl->in_hslen));
3142 }
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003143 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003144 }
3145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003147}
3148
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003149int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003150{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003151 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003152 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003155 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3156 if (ret != 0) {
3157 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3158 return ret;
3159 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003160 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003161
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003162 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3165 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003166 unsigned offset;
3167 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003168
Hanno Becker0271f962018-08-16 13:23:47 +01003169 /* Increment handshake sequence number */
3170 hs->in_msg_seq++;
3171
3172 /*
3173 * Clear up handshake buffering and reassembly structure.
3174 */
3175
3176 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003178
3179 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003181 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003183 *hs_buf = *(hs_buf + 1);
3184 }
3185
3186 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003188 }
3189#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003190 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003191}
3192
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003193/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003194 * DTLS anti-replay: RFC 6347 4.1.2.6
3195 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003196 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3197 * Bit n is set iff record number in_window_top - n has been seen.
3198 *
3199 * Usually, in_window_top is the last record number seen and the lsb of
3200 * in_window is set. The only exception is the initial state (record number 0
3201 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003204void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003205{
3206 ssl->in_window_top = 0;
3207 ssl->in_window = 0;
3208}
3209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003211{
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 return ((uint64_t) buf[0] << 40) |
3213 ((uint64_t) buf[1] << 32) |
3214 ((uint64_t) buf[2] << 24) |
3215 ((uint64_t) buf[3] << 16) |
3216 ((uint64_t) buf[4] << 8) |
3217 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003218}
3219
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003220MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003221static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003222{
Janos Follath865b3eb2019-12-16 11:46:15 +00003223 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003224 unsigned char *original_in_ctr;
3225
3226 // save original in_ctr
3227 original_in_ctr = ssl->in_ctr;
3228
3229 // use counter from record
3230 ssl->in_ctr = record_in_ctr;
3231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003233
3234 // restore the counter
3235 ssl->in_ctr = original_in_ctr;
3236
3237 return ret;
3238}
3239
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003240/*
3241 * Return 0 if sequence number is acceptable, -1 otherwise
3242 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003243int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003244{
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003246 uint64_t bit;
3247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3249 return 0;
3250 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 if (rec_seqnum > ssl->in_window_top) {
3253 return 0;
3254 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003255
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003256 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (bit >= 64) {
3259 return -1;
3260 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003261
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3263 return -1;
3264 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003265
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003267}
3268
3269/*
3270 * Update replay window on new validated record
3271 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003272void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003273{
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003277 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003281 /* Update window_top and the contents of the window */
3282 uint64_t shift = rec_seqnum - ssl->in_window_top;
3283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003285 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003287 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003288 ssl->in_window |= 1;
3289 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003290
3291 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003293 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003294 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003297 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003299 }
3300}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003302
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003303#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003304/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003305 * Check if a datagram looks like a ClientHello with a valid cookie,
3306 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003307 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003308 *
3309 * - if cookie is valid, return 0
3310 * - if ClientHello looks superficially valid but cookie is not,
3311 * fill obuf and set olen, then
3312 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3313 * - otherwise return a specific error code
3314 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003315MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003316MBEDTLS_STATIC_TESTABLE
3317int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 mbedtls_ssl_context *ssl,
3319 const unsigned char *cli_id, size_t cli_id_len,
3320 const unsigned char *in, size_t in_len,
3321 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003322{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003323 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003324 unsigned char *p;
3325
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003326 /*
3327 * Structure of ClientHello with record and handshake headers,
3328 * and expected values. We don't need to check a lot, more checks will be
3329 * done when actually parsing the ClientHello - skipping those checks
3330 * avoids code duplication and does not make cookie forging any easier.
3331 *
3332 * 0-0 ContentType type; copied, must be handshake
3333 * 1-2 ProtocolVersion version; copied
3334 * 3-4 uint16 epoch; copied, must be 0
3335 * 5-10 uint48 sequence_number; copied
3336 * 11-12 uint16 length; (ignored)
3337 *
3338 * 13-13 HandshakeType msg_type; (ignored)
3339 * 14-16 uint24 length; (ignored)
3340 * 17-18 uint16 message_seq; copied
3341 * 19-21 uint24 fragment_offset; copied, must be 0
3342 * 22-24 uint24 fragment_length; (ignored)
3343 *
3344 * 25-26 ProtocolVersion client_version; (ignored)
3345 * 27-58 Random random; (ignored)
3346 * 59-xx SessionID session_id; 1 byte len + sid_len content
3347 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3348 * ...
3349 *
3350 * Minimum length is 61 bytes.
3351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3353 (unsigned) in_len));
3354 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3355 if (in_len < 61) {
3356 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3357 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003358 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3361 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003362
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3364 fragment_offset != 0) {
3365 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3366 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3367 in[0], (unsigned) epoch,
3368 (unsigned) fragment_offset));
3369 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003370 }
3371
3372 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 if (59 + 1 + sid_len + 1 > in_len) {
3374 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3375 (unsigned) sid_len,
3376 (unsigned) in_len - 61));
3377 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003378 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3380 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003381
3382 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3384 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3385 (unsigned) cookie_len,
3386 (unsigned) (in_len - sid_len - 61)));
3387 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003388 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003389
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3391 in + sid_len + 61, cookie_len);
3392 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3393 in + sid_len + 61, cookie_len,
3394 cli_id, cli_id_len) == 0) {
3395 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3396 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003397 }
3398
3399 /*
3400 * If we get here, we've got an invalid cookie, let's prepare HVR.
3401 *
3402 * 0-0 ContentType type; copied
3403 * 1-2 ProtocolVersion version; copied
3404 * 3-4 uint16 epoch; copied
3405 * 5-10 uint48 sequence_number; copied
3406 * 11-12 uint16 length; olen - 13
3407 *
3408 * 13-13 HandshakeType msg_type; hello_verify_request
3409 * 14-16 uint24 length; olen - 25
3410 * 17-18 uint16 message_seq; copied
3411 * 19-21 uint24 fragment_offset; copied
3412 * 22-24 uint24 fragment_length; olen - 25
3413 *
3414 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3415 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3416 *
3417 * Minimum length is 28.
3418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if (buf_len < 28) {
3420 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3421 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003422
3423 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003425 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3426 obuf[25] = 0xfe;
3427 obuf[26] = 0xff;
3428
3429 /* Generate and write actual cookie */
3430 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3432 &p, obuf + buf_len,
3433 cli_id, cli_id_len) != 0) {
3434 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003435 }
3436
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003437 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003438
3439 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003441
Gilles Peskine449bd832023-01-11 14:50:10 +01003442 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3443 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3444 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003449}
3450
3451/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003452 * Handle possible client reconnect with the same UDP quadruplet
3453 * (RFC 6347 Section 4.2.8).
3454 *
3455 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3456 * that looks like a ClientHello.
3457 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003459 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003460 * - if the input looks like a ClientHello with a valid cookie,
3461 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003462 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003463 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003465 * This function is called (through ssl_check_client_reconnect()) when an
3466 * unexpected record is found in ssl_get_next_record(), which will discard the
3467 * record if we return 0, and bubble up the return value otherwise (this
3468 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3469 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003470 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003472static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003473{
Janos Follath865b3eb2019-12-16 11:46:15 +00003474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003475 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003476
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 if (ssl->conf->f_cookie_write == NULL ||
3478 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003479 /* If we can't use cookies to verify reachability of the peer,
3480 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3482 "can't check reconnect validity"));
3483 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003484 }
3485
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003486 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 ssl,
3488 ssl->cli_id, ssl->cli_id_len,
3489 ssl->in_buf, ssl->in_left,
3490 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003491
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003493
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003495 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3497 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3498 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003499 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003500 * If the error is permanent we'll catch it later,
3501 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3503 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003504 (void) send_ret;
3505
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003507 }
3508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 if (ret == 0) {
3510 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3511 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3512 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3513 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003514 }
3515
Gilles Peskine449bd832023-01-11 14:50:10 +01003516 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003517 }
3518
Gilles Peskine449bd832023-01-11 14:50:10 +01003519 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003520}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003521#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003522
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003523MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003524static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003525{
Gilles Peskine449bd832023-01-11 14:50:10 +01003526 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003527 record_type != MBEDTLS_SSL_MSG_ALERT &&
3528 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3530 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003531 }
3532
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003534}
3535
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003536/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003537 * ContentType type;
3538 * ProtocolVersion version;
3539 * uint16 epoch; // DTLS only
3540 * uint48 sequence_number; // DTLS only
3541 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003542 *
3543 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003544 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003545 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3546 *
3547 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003548 * 1. proceed with the record if this function returns 0
3549 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3550 * 3. return CLIENT_RECONNECT if this function return that value
3551 * 4. drop the whole datagram if this function returns anything else.
3552 * Point 2 is needed when the peer is resending, and we have already received
3553 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003554 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003555MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003556static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3557 unsigned char *buf,
3558 size_t len,
3559 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003560{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003561 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003562
Hanno Beckere5e7e782019-07-11 12:29:35 +01003563 size_t const rec_hdr_type_offset = 0;
3564 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003565
Hanno Beckere5e7e782019-07-11 12:29:35 +01003566 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3567 rec_hdr_type_len;
3568 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003569
Hanno Beckere5e7e782019-07-11 12:29:35 +01003570 size_t const rec_hdr_ctr_len = 8;
3571#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003572 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3574 rec_hdr_version_len;
3575
Hanno Beckera0e20d02019-05-15 14:03:01 +01003576#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003577 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3578 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003579 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3581#endif /* MBEDTLS_SSL_PROTO_DTLS */
3582
3583 size_t rec_hdr_len_offset; /* To be determined */
3584 size_t const rec_hdr_len_len = 2;
3585
3586 /*
3587 * Check minimum lengths for record header.
3588 */
3589
3590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003593 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594#endif /* MBEDTLS_SSL_PROTO_DTLS */
3595 {
3596 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3597 }
3598
Gilles Peskine449bd832023-01-11 14:50:10 +01003599 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3600 MBEDTLS_SSL_DEBUG_MSG(1,
3601 (
3602 "datagram of length %u too small to hold DTLS record header of length %u",
3603 (unsigned) len,
3604 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3605 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003606 }
3607
3608 /*
3609 * Parse and validate record content type
3610 */
3611
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003613
3614 /* Check record content type */
3615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3616 rec->cid_len = 0;
3617
Gilles Peskine449bd832023-01-11 14:50:10 +01003618 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003619 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003620 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003621 /* Shift pointers to account for record header including CID
3622 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003623 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003624 * ProtocolVersion version;
3625 * uint16 epoch;
3626 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003627 * opaque cid[cid_length]; // Additional field compared to
3628 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003629 * uint16 length;
3630 * opaque enc_content[DTLSCiphertext.length];
3631 * } DTLSCiphertext;
3632 */
3633
3634 /* So far, we only support static CID lengths
3635 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003636 rec_hdr_cid_len = ssl->conf->cid_len;
3637 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003638
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3640 MBEDTLS_SSL_DEBUG_MSG(1,
3641 (
3642 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3643 (unsigned) len,
3644 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3645 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003646 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003648 /* configured CID len is guaranteed at most 255, see
3649 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3650 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003651 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3652 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003653#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003654 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003655 if (ssl_check_record_type(rec->type)) {
3656 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3657 (unsigned) rec->type));
3658 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003659 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003660 }
3661
Hanno Beckere5e7e782019-07-11 12:29:35 +01003662 /*
3663 * Parse and validate record version
3664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003665 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3666 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003667 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3668 buf + rec_hdr_version_offset,
3669 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003670
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 if (tls_version > ssl->conf->max_tls_version) {
3672 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3673 (unsigned) tls_version,
3674 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003675
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003677 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003678 /*
3679 * Parse/Copy record sequence number.
3680 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003681
Hanno Beckere5e7e782019-07-11 12:29:35 +01003682#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003684 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003685 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3686 rec_hdr_ctr_len);
3687 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003688#endif /* MBEDTLS_SSL_PROTO_DTLS */
3689 {
3690 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003691 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003692 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003693
Hanno Beckere5e7e782019-07-11 12:29:35 +01003694 /*
3695 * Parse record length.
3696 */
3697
Hanno Beckere5e7e782019-07-11 12:29:35 +01003698 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003699 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003700 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003701
Gilles Peskine449bd832023-01-11 14:50:10 +01003702 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3703 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3704 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003705
3706 rec->buf = buf;
3707 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003708
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 if (rec->data_len == 0) {
3710 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3711 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003712
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003713 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003714 * DTLS-related tests.
3715 * Check epoch before checking length constraint because
3716 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3717 * message gets duplicated before the corresponding Finished message,
3718 * the second ChangeCipherSpec should be discarded because it belongs
3719 * to an old epoch, but not because its length is shorter than
3720 * the minimum record length for packets using the new record transform.
3721 * Note that these two kinds of failures are handled differently,
3722 * as an unexpected record is silently skipped but an invalid
3723 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003724 */
3725#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003727 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003728
Hanno Becker955a5c92019-07-10 17:12:07 +01003729 /* Check that the datagram is large enough to contain a record
3730 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003731 if (len < rec->data_offset + rec->data_len) {
3732 MBEDTLS_SSL_DEBUG_MSG(1,
3733 (
3734 "Datagram of length %u too small to contain record of advertised length %u.",
3735 (unsigned) len,
3736 (unsigned) (rec->data_offset + rec->data_len)));
3737 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003738 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003739
Hanno Becker37cfe732019-07-10 17:20:01 +01003740 /* Records from other, non-matching epochs are silently discarded.
3741 * (The case of same-port Client reconnects must be considered in
3742 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 if (rec_epoch != ssl->in_epoch) {
3744 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3745 "expected %u, received %lu",
3746 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003747
Hanno Becker552f7472019-07-19 10:59:12 +01003748 /* Records from the next epoch are considered for buffering
3749 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003750 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3751 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3752 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003753 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003754
Gilles Peskine449bd832023-01-11 14:50:10 +01003755 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003756 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003757#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003758 /* For records from the correct epoch, check whether their
3759 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3761 &rec->ctr[0]) != 0) {
3762 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3763 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003764 }
3765#endif
3766 }
3767#endif /* MBEDTLS_SSL_PROTO_DTLS */
3768
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003770}
Paul Bakker5121ce52009-01-03 21:22:43 +00003771
Paul Bakker5121ce52009-01-03 21:22:43 +00003772
Hanno Becker2fddd372019-07-10 14:37:41 +01003773#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003774MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003775static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003776{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003777 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003778
3779 /*
3780 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3781 * access the first byte of record content (handshake type), as we
3782 * have an active transform (possibly iv_len != 0), so use the
3783 * fact that the record header len is 13 instead.
3784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003786 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003788 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3789 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003790 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3791 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3792 "from the same port"));
3793 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003794 }
3795
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003797}
Hanno Becker2fddd372019-07-10 14:37:41 +01003798#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003799
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003800/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003801 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003802 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003804static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3805 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003806{
3807 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003808
Gilles Peskine449bd832023-01-11 14:50:10 +01003809 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3810 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003811
Ronald Cron7e38cba2021-11-24 12:43:39 +01003812 /*
3813 * In TLS 1.3, always treat ChangeCipherSpec records
3814 * as unencrypted. The only thing we do with them is
3815 * check the length and content and ignore them.
3816 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003817#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003818 if (ssl->transform_in != NULL &&
3819 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3820 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003821 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003823 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003824#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003825
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003827 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003828
Gilles Peskine449bd832023-01-11 14:50:10 +01003829 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3830 rec)) != 0) {
3831 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003832
Ronald Cron2995d352024-01-18 16:59:39 +01003833#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3834 /*
3835 * Although the server rejected early data, it might receive early
3836 * data as long as it has not received the client Finished message.
3837 * It is encrypted with early keys and should be ignored as stated
3838 * in section 4.2.10 of RFC 8446:
3839 *
3840 * "Ignore the extension and return a regular 1-RTT response. The
3841 * server then skips past early data by attempting to deprotect
3842 * received records using the handshake traffic key, discarding
3843 * records which fail deprotection (up to the configured
3844 * max_early_data_size). Once a record is deprotected successfully,
3845 * it is treated as the start of the client's second flight and the
3846 * server proceeds as with an ordinary 1-RTT handshake."
3847 */
3848 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3849 (ssl->discard_early_data_record ==
3850 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3851 MBEDTLS_SSL_DEBUG_MSG(
3852 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003853
3854 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3855 if (ret != 0) {
3856 return ret;
3857 }
Ronald Cron2995d352024-01-18 16:59:39 +01003858 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3859 }
3860#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3861
Hanno Beckera0e20d02019-05-15 14:03:01 +01003862#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003864 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3866 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003867 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003868 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003869#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003870
Ronald Cron71c6e652024-02-05 16:48:10 +01003871 /*
3872 * The decryption of the record failed, no reason to ignore it,
3873 * return in error with the decryption error code.
3874 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003875 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003876 }
3877
Ronald Cron2995d352024-01-18 16:59:39 +01003878#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3879 /*
3880 * If the server were discarding protected records that it fails to
3881 * deprotect because it has rejected early data, as we have just
3882 * deprotected successfully a record, the server has to resume normal
3883 * operation and fail the connection if the deprotection of a record
3884 * fails.
3885 */
3886 if (ssl->discard_early_data_record ==
3887 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3888 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3889 }
3890#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3891
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 if (old_msg_type != rec->type) {
3893 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3894 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003895 }
3896
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3898 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003899
Hanno Beckera0e20d02019-05-15 14:03:01 +01003900#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003901 /* We have already checked the record content type
3902 * in ssl_parse_record_header(), failing or silently
3903 * dropping the record in the case of an unknown type.
3904 *
3905 * Since with the use of CIDs, the record content type
3906 * might change during decryption, re-check the record
3907 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003908 if (ssl_check_record_type(rec->type)) {
3909 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3910 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003911 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003912#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003913
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003915#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3917 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003918 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3920 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003921 }
3922#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3923
3924 ssl->nb_zero++;
3925
3926 /*
3927 * Three or more empty messages may be a DoS attack
3928 * (excessive CPU consumption).
3929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 if (ssl->nb_zero > 3) {
3931 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3932 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003933 /* Treat the records as if they were not properly authenticated,
3934 * thereby failing the connection if we see more than allowed
3935 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003939 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003941
3942#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003944 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003946#endif
3947 {
3948 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3950 i > mbedtls_ssl_ep_len(ssl); i--) {
3951 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003952 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003954 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003955
3956 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 if (i == mbedtls_ssl_ep_len(ssl)) {
3958 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3959 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003960 }
3961 }
3962
Paul Bakker5121ce52009-01-03 21:22:43 +00003963 }
3964
Jerry Yuf57d14b2023-11-15 16:40:09 +08003965#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3966 /*
3967 * Although the server rejected early data because it needed to send an
3968 * HelloRetryRequest message, it might receive early data as long as it has
3969 * not received the client Finished message.
3970 * The early data is encrypted with early keys and should be ignored as
3971 * stated in section 4.2.10 of RFC 8446 (second case):
3972 *
3973 * "The server then ignores early data by skipping all records with an
3974 * external content type of "application_data" (indicating that they are
3975 * encrypted), up to the configured max_early_data_size. Ignore application
3976 * data message before 2nd ClientHello when early_data was received in 1st
3977 * ClientHello."
3978 */
3979 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3980 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003981
3982 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3983 if (ret != 0) {
3984 return ret;
3985 }
3986
Jerry Yuf57d14b2023-11-15 16:40:09 +08003987 MBEDTLS_SSL_DEBUG_MSG(
3988 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003989
Jerry Yuf57d14b2023-11-15 16:40:09 +08003990 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3991 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3992 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3993 }
3994 }
3995#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003997#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3999 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004000 }
4001#endif
4002
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004003 /* Check actual (decrypted) record content length against
4004 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4006 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4007 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004008 }
4009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004011}
4012
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004013/*
4014 * Read a record.
4015 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004016 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4017 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4018 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004019 */
Hanno Becker1097b342018-08-15 14:09:41 +01004020
4021/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004022MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004023static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004024MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004025static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004026MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004027static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4030 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004031{
Janos Follath865b3eb2019-12-16 11:46:15 +00004032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004035
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004037 do {
Simon Butcher99000142016-10-13 17:21:01 +01004038
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 ret = ssl_consume_current_message(ssl);
4040 if (ret != 0) {
4041 return ret;
4042 }
Hanno Becker26994592018-08-15 14:14:59 +01004043
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004045 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004046#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004047
Hanno Becker40f50842018-08-15 14:48:01 +01004048 /* We only check for buffered messages if the
4049 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4051 ssl_next_record_is_in_datagram(ssl) == 0) {
4052 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004053 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 }
Hanno Becker40f50842018-08-15 14:48:01 +01004055 }
4056
Hanno Becker40f50842018-08-15 14:48:01 +01004057#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 if (dtls_have_buffered == 0) {
4059 ret = ssl_get_next_record(ssl);
4060 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004061 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 }
Hanno Becker40f50842018-08-15 14:48:01 +01004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (ret != 0) {
4065 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4066 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004067 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004068 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004069 }
4070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004072
Hanno Becker40f50842018-08-15 14:48:01 +01004073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004075 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 ret = ssl_buffer_message(ssl);
4077 if (ret != 0) {
4078 return ret;
4079 }
Hanno Becker40f50842018-08-15 14:48:01 +01004080
4081 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4082 }
4083#endif /* MBEDTLS_SSL_PROTO_DTLS */
4084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4086 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if (0 != ret) {
4089 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4090 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004091 }
4092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4094 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004095 ret = mbedtls_ssl_update_handshake_status(ssl);
4096 if (0 != ret) {
4097 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4098 return ret;
4099 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004100 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 } else {
4102 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004103 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004104 }
4105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004109}
4110
Hanno Becker40f50842018-08-15 14:48:01 +01004111#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004112MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004113static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004114{
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if (ssl->in_left > ssl->next_record_offset) {
4116 return 1;
4117 }
Simon Butcher99000142016-10-13 17:21:01 +01004118
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004120}
4121
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004122MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004123static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004124{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004127 int ret = 0;
4128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 if (hs == NULL) {
4130 return -1;
4131 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4136 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004137 /* Check if we have seen a ChangeCipherSpec before.
4138 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (!hs->buffering.seen_ccs) {
4140 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004141 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004142 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004143 }
4144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004146 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4147 ssl->in_msglen = 1;
4148 ssl->in_msg[0] = 1;
4149
4150 /* As long as they are equal, the exact value doesn't matter. */
4151 ssl->in_left = 0;
4152 ssl->next_record_offset = 0;
4153
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004154 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004155 goto exit;
4156 }
Hanno Becker37f95322018-08-16 13:55:32 +01004157
Hanno Beckerb8f50142018-08-28 10:01:34 +01004158#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004159 /* Debug only */
4160 {
4161 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004163 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 if (hs_buf->is_valid == 1) {
4165 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4166 hs->in_msg_seq + offset,
4167 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004168 }
4169 }
4170 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004171#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004172
4173 /* Check if we have buffered and/or fully reassembled the
4174 * next handshake message. */
4175 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004177 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004178 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004179
4180 /* Double-check that we haven't accidentally buffered
4181 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4183 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4184 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004185 }
4186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4188 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4189 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004190
4191 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4192 ssl->in_hslen = msg_len + 12;
4193 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004195
4196 ret = 0;
4197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 } else {
4199 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4200 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004201 }
4202
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004203 ret = -1;
4204
4205exit:
4206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4208 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004209}
4210
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004212static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4213 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004214{
4215 int offset;
4216 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4218 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004219
Hanno Becker01315ea2018-08-21 17:22:17 +01004220 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004222
4223 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4225 hs->buffering.total_bytes_buffered)) {
4226 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4227 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004228 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004229
Hanno Becker4f432ad2018-08-28 10:02:32 +01004230 /* We don't have enough space to buffer the next expected handshake
4231 * message. Remove buffers used for future messages to gain space,
4232 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4234 offset >= 0; offset--) {
4235 MBEDTLS_SSL_DEBUG_MSG(2,
4236 (
4237 "Free buffering slot %d to make space for reassembly of next handshake message",
4238 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004239
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004241
4242 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4244 hs->buffering.total_bytes_buffered)) {
4245 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4246 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004247 }
4248 }
4249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004251}
4252
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004253MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004254static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004255{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004256 int ret = 0;
4257 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4258
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 if (hs == NULL) {
4260 return 0;
4261 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004264
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004266 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004268
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004269 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004270 break;
4271
4272 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004273 {
4274 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004275 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004276 mbedtls_ssl_hs_buffer *hs_buf;
4277 size_t msg_len = ssl->in_hslen - 12;
4278
4279 /* We should never receive an old handshake
4280 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4282 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4283 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004284 }
4285
4286 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004288 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 MBEDTLS_SSL_DEBUG_MSG(2,
4290 ("Ignore future HS message with sequence number %u, "
4291 "buffering window %u - %u",
4292 recv_msg_seq, ssl->handshake->in_msg_seq,
4293 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4294 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004295
4296 goto exit;
4297 }
4298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4300 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004303
4304 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004306 size_t reassembly_buf_sz;
4307
Hanno Becker37f95322018-08-16 13:55:32 +01004308 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004310
4311 /* We copy the message back into the input buffer
4312 * after reassembly, so check that it's not too large.
4313 * This is an implementation-specific limitation
4314 * and not one from the standard, hence it is not
4315 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004317 /* Ignore message */
4318 goto exit;
4319 }
4320
Hanno Beckere0b150f2018-08-21 15:51:03 +01004321 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (hs->buffering.total_bytes_buffered >
4323 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4324 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4325 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004326 }
4327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4329 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4332 hs->buffering.total_bytes_buffered)) {
4333 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004334 /* If we can't buffer a future message because
4335 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 MBEDTLS_SSL_DEBUG_MSG(2,
4337 ("Buffering of future message of size %"
4338 MBEDTLS_PRINTF_SIZET
4339 " would exceed the compile-time limit %"
4340 MBEDTLS_PRINTF_SIZET
4341 " (already %" MBEDTLS_PRINTF_SIZET
4342 " bytes buffered) -- ignore\n",
4343 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4344 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004345 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 } else {
4347 MBEDTLS_SSL_DEBUG_MSG(2,
4348 ("Buffering of future message of size %"
4349 MBEDTLS_PRINTF_SIZET
4350 " would exceed the compile-time limit %"
4351 MBEDTLS_PRINTF_SIZET
4352 " (already %" MBEDTLS_PRINTF_SIZET
4353 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4354 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4355 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004356 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4359 MBEDTLS_SSL_DEBUG_MSG(2,
4360 ("Reassembly of next message of size %"
4361 MBEDTLS_PRINTF_SIZET
4362 " (%" MBEDTLS_PRINTF_SIZET
4363 " with bitmap) would exceed"
4364 " the compile-time limit %"
4365 MBEDTLS_PRINTF_SIZET
4366 " (already %" MBEDTLS_PRINTF_SIZET
4367 " bytes buffered) -- fail\n",
4368 msg_len,
4369 reassembly_buf_sz,
4370 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4371 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004372 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4373 goto exit;
4374 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004375 }
4376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 MBEDTLS_SSL_DEBUG_MSG(2,
4378 ("initialize reassembly, total length = %"
4379 MBEDTLS_PRINTF_SIZET,
4380 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4383 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004384 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004385 goto exit;
4386 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004387 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004388
4389 /* Prepare final header: copy msg_type, length and message_seq,
4390 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 memcpy(hs_buf->data, ssl->in_msg, 6);
4392 memset(hs_buf->data + 6, 0, 3);
4393 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004394
4395 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004396
4397 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004399 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4401 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004402 /* Ignore */
4403 goto exit;
4404 }
4405 }
4406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004408 size_t frag_len, frag_off;
4409 unsigned char * const msg = hs_buf->data + 12;
4410
4411 /*
4412 * Check and copy current fragment
4413 */
4414
4415 /* Validation of header fields already done in
4416 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 frag_off = ssl_get_hs_frag_off(ssl);
4418 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004419
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4421 ", length = %" MBEDTLS_PRINTF_SIZET,
4422 frag_off, frag_len));
4423 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004426 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 ssl_bitmask_set(bitmask, frag_off, frag_len);
4428 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4429 msg_len) == 0);
4430 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004431 hs_buf->is_complete = 1;
4432 }
4433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4435 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004436 }
4437
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004438 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004439 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004440
4441 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004442 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004443 break;
4444 }
4445
4446exit:
4447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4449 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004450}
4451#endif /* MBEDTLS_SSL_PROTO_DTLS */
4452
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004453MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004454static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004455{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004456 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004457 * Consume last content-layer message and potentially
4458 * update in_msglen which keeps track of the contents'
4459 * consumption state.
4460 *
4461 * (1) Handshake messages:
4462 * Remove last handshake message, move content
4463 * and adapt in_msglen.
4464 *
4465 * (2) Alert messages:
4466 * Consume whole record content, in_msglen = 0.
4467 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004468 * (3) Change cipher spec:
4469 * Consume whole record content, in_msglen = 0.
4470 *
4471 * (4) Application data:
4472 * Don't do anything - the record layer provides
4473 * the application data as a stream transport
4474 * and consumes through mbedtls_ssl_read only.
4475 *
4476 */
4477
4478 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004480 /* Hard assertion to be sure that no application data
4481 * is in flight, as corrupting ssl->in_msglen during
4482 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl->in_offt != NULL) {
4484 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4485 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004486 }
4487
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004488 if (ssl->in_hsfraglen != 0) {
4489 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004490 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4491 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4492 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004493 return 0;
4494 }
4495
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004496 /*
4497 * Get next Handshake message in the current record
4498 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004499
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004501 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004502 * current handshake content: If DTLS handshake
4503 * fragmentation is used, that's the fragment
4504 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004505 * size here is faulty and should be changed at
4506 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004507 * (2) While it doesn't seem to cause problems, one
4508 * has to be very careful not to assume that in_hslen
4509 * is always <= in_msglen in a sensible communication.
4510 * Again, it's wrong for DTLS handshake fragmentation.
4511 * The following check is therefore mandatory, and
4512 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004513 * Additionally, ssl->in_hslen might be arbitrarily out of
4514 * bounds after handling a DTLS message with an unexpected
4515 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004516 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004518 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4520 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004521 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4524 ssl->in_msg, ssl->in_msglen);
4525 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004526 ssl->in_msglen = 0;
4527 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004528
Hanno Becker4a810fb2017-05-24 16:27:30 +01004529 ssl->in_hslen = 0;
4530 }
4531 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 else if (ssl->in_offt != NULL) {
4533 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004534 }
4535 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004537 ssl->in_msglen = 0;
4538 }
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004541}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004542
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004544static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004545{
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 if (ssl->in_msglen > 0) {
4547 return 1;
4548 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004551}
4552
Hanno Becker5f066e72018-08-16 14:56:31 +01004553#if defined(MBEDTLS_SSL_PROTO_DTLS)
4554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004556{
4557 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004559 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004563 hs->buffering.total_bytes_buffered -=
4564 hs->buffering.future_record.len;
4565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004567 hs->buffering.future_record.data = NULL;
4568 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004569}
4570
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004571MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004572static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004573{
4574 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004576 size_t rec_len;
4577 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004578#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4579 size_t in_buf_len = ssl->in_buf_len;
4580#else
4581 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4582#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4584 return 0;
4585 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (hs == NULL) {
4588 return 0;
4589 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004590
Hanno Becker5f066e72018-08-16 14:56:31 +01004591 rec = hs->buffering.future_record.data;
4592 rec_len = hs->buffering.future_record.len;
4593 rec_epoch = hs->buffering.future_record.epoch;
4594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if (rec == NULL) {
4596 return 0;
4597 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004598
Hanno Becker4cb782d2018-08-20 11:19:05 +01004599 /* Only consider loading future records if the
4600 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4602 return 0;
4603 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (rec_epoch != ssl->in_epoch) {
4608 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004609 goto exit;
4610 }
4611
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004613
4614 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4616 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4617 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004618 }
4619
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004621 ssl->in_left = rec_len;
4622 ssl->next_record_offset = 0;
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004625
4626exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4628 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004629}
4630
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004632static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4633 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004634{
4635 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004636
4637 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (hs == NULL) {
4639 return 0;
4640 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004641
4642 /* Only buffer handshake records (we are only interested
4643 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4645 return 0;
4646 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004647
4648 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (hs->buffering.future_record.data != NULL) {
4650 return 0;
4651 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004652
Hanno Becker01315ea2018-08-21 17:22:17 +01004653 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4655 hs->buffering.total_bytes_buffered)) {
4656 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4657 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4658 " (already %" MBEDTLS_PRINTF_SIZET
4659 " bytes buffered) -- ignore\n",
4660 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4661 hs->buffering.total_bytes_buffered));
4662 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004663 }
4664
Hanno Becker5f066e72018-08-16 14:56:31 +01004665 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4667 ssl->in_epoch + 1U));
4668 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004669
4670 /* ssl_parse_record_header() only considers records
4671 * of the next epoch as candidates for buffering. */
4672 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004673 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004674
4675 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 mbedtls_calloc(1, hs->buffering.future_record.len);
4677 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004678 /* If we run out of RAM trying to buffer a
4679 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004681 }
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004684
Hanno Becker519f15d2019-07-11 12:43:20 +01004685 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004687}
4688
4689#endif /* MBEDTLS_SSL_PROTO_DTLS */
4690
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004692static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004693{
Janos Follath865b3eb2019-12-16 11:46:15 +00004694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004695 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004696
Hanno Becker5f066e72018-08-16 14:56:31 +01004697#if defined(MBEDTLS_SSL_PROTO_DTLS)
4698 /* We might have buffered a future record; if so,
4699 * and if the epoch matches now, load it.
4700 * On success, this call will set ssl->in_left to
4701 * the length of the buffered record, so that
4702 * the calls to ssl_fetch_input() below will
4703 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 ret = ssl_load_buffered_record(ssl);
4705 if (ret != 0) {
4706 return ret;
4707 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004708#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004709
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004710 /* Ensure that we have enough space available for the default form
4711 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4712 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4714 if (ret != 0) {
4715 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4716 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004717 }
4718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4720 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4723 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4724 ret = ssl_buffer_future_record(ssl, &rec);
4725 if (ret != 0) {
4726 return ret;
4727 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004728
4729 /* Fall through to handling of unexpected records */
4730 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4731 }
4732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004734#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004735 /* Reset in pointers to default state for TLS/DTLS records,
4736 * assuming no CID and no offset between record content and
4737 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004739
Hanno Becker7ae20e02019-07-12 08:33:49 +01004740 /* Setup internal message pointers from record structure. */
4741 ssl->in_msgtype = rec.type;
4742#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4743 ssl->in_len = ssl->in_cid + rec.cid_len;
4744#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4745 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4746 ssl->in_msglen = rec.data_len;
4747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 ret = ssl_check_client_reconnect(ssl);
4749 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4750 if (ret != 0) {
4751 return ret;
4752 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004753#endif
4754
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004755 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004756 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4759 "(header)"));
4760 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004761 /* Skip invalid record and the rest of the datagram */
4762 ssl->next_record_offset = 0;
4763 ssl->in_left = 0;
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4766 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004767 }
4768
4769 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4771 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004772#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004773 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004775 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004776 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004780 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004781 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (ssl->next_record_offset < ssl->in_left) {
4783 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004784 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004786#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004787 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004788 /*
4789 * Fetch record contents from underlying transport.
4790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4792 if (ret != 0) {
4793 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4794 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004795 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004796
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004797 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004798 }
4799
4800 /*
4801 * Decrypt record contents.
4802 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004803
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004805#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004807 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004809 /* Except when waiting for Finished as a bad mac here
4810 * probably means something went wrong in the handshake
4811 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4813 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004814#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4816 mbedtls_ssl_send_alert_message(ssl,
4817 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4818 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004819 }
4820#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004822 }
4823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (ssl->conf->badmac_limit != 0 &&
4825 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4826 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4827 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004828 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004829
Hanno Becker4a810fb2017-05-24 16:27:30 +01004830 /* As above, invalid records cause
4831 * dismissal of the whole datagram. */
4832
4833 ssl->next_record_offset = 0;
4834 ssl->in_left = 0;
4835
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4837 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004838 }
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 return ret;
4841 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004842#endif
4843 {
4844 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4847 mbedtls_ssl_send_alert_message(ssl,
4848 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4849 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004850 }
4851#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004853 }
4854 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004855
Hanno Becker44d89b22019-07-12 09:40:44 +01004856
4857 /* Reset in pointers to default state for TLS/DTLS records,
4858 * assuming no CID and no offset between record content and
4859 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004861#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4862 ssl->in_len = ssl->in_cid + rec.cid_len;
4863#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004864 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004865
Hanno Becker8685c822019-07-12 09:37:30 +01004866 /* The record content type may change during decryption,
4867 * so re-read it. */
4868 ssl->in_msgtype = rec.type;
4869 /* Also update the input buffer, because unfortunately
4870 * the server-side ssl_parse_client_hello() reparses the
4871 * record header when receiving a ClientHello initiating
4872 * a renegotiation. */
4873 ssl->in_hdr[0] = rec.type;
4874 ssl->in_msg = rec.buf + rec.data_offset;
4875 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004879}
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004882{
Janos Follath865b3eb2019-12-16 11:46:15 +00004883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004884
Manuel Pégourié-Gonnarde26a0602025-03-05 12:52:18 +01004885 /* If we're in the middle of a fragmented TLS handshake message,
4886 * we don't accept any other message type. For TLS 1.3, the spec forbids
4887 * interleaving other message types between handshake fragments. For TLS
4888 * 1.2, the spec does not forbid it but we do. */
4889 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM &&
4890 ssl->in_hsfraglen != 0 &&
4891 ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
4892 MBEDTLS_SSL_DEBUG_MSG(1, ("non-handshake message in the middle"
4893 " of a fragmented handshake message"));
4894 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
4895 }
4896
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004897 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004898 * Handle particular types of records
4899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4901 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4902 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004903 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004904 }
4905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4907 if (ssl->in_msglen != 1) {
4908 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4909 ssl->in_msglen));
4910 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004911 }
4912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (ssl->in_msg[0] != 1) {
4914 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4915 ssl->in_msg[0]));
4916 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004917 }
4918
4919#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004921 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4923 if (ssl->handshake == NULL) {
4924 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4925 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004926 }
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4929 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004930 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004931#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004932
Ronald Cron6f135e12021-12-08 16:57:54 +01004933#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004935 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4937 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004938 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004939#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004940 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4943 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004944 /* Note: Standard allows for more than one 2 byte alert
4945 to be packed in a single message, but Mbed TLS doesn't
4946 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4948 ssl->in_msglen));
4949 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004950 }
4951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4953 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004954
4955 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004956 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004957 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4959 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4960 ssl->in_msg[1]));
4961 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004962 }
4963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4965 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4966 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4967 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004968 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004969
4970#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4972 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4973 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004974 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004976 }
4977#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004978 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004979 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004980 }
4981
Hanno Beckerc76c6192017-06-06 10:03:17 +01004982#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004984 /* Drop unexpected ApplicationData records,
4985 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4987 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004988#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4990 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004991#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 ) {
4993 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4994 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004995 }
4996
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 if (ssl->handshake != NULL &&
4998 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4999 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005000 }
5001 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005002#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005005}
5006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005008{
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 return mbedtls_ssl_send_alert_message(ssl,
5010 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5011 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005012}
5013
Gilles Peskine449bd832023-01-11 14:50:10 +01005014int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5015 unsigned char level,
5016 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005017{
Janos Follath865b3eb2019-12-16 11:46:15 +00005018 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 if (ssl == NULL || ssl->conf == NULL) {
5021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5022 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if (ssl->out_left != 0) {
5025 return mbedtls_ssl_flush_output(ssl);
5026 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5029 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005032 ssl->out_msglen = 2;
5033 ssl->out_msg[0] = level;
5034 ssl->out_msg[1] = message;
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5037 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5038 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005039 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005043}
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005046{
Janos Follath865b3eb2019-12-16 11:46:15 +00005047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005052 ssl->out_msglen = 1;
5053 ssl->out_msg[0] = 1;
5054
Paul Bakker5121ce52009-01-03 21:22:43 +00005055 ssl->state++;
5056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5058 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5059 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005060 }
5061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005065}
5066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005068{
Janos Follath865b3eb2019-12-16 11:46:15 +00005069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5074 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5075 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005076 }
5077
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5079 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5080 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5081 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5082 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005083 }
5084
Hanno Beckere678eaa2018-08-21 14:57:46 +01005085 /* CCS records are only accepted if they have length 1 and content '1',
5086 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005087
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005088 /*
5089 * Switch to our negotiated transform and session parameters for inbound
5090 * data.
5091 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005093#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005094 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005095#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005096 ssl->session_in = ssl->session_negotiate;
5097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005100#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005102#endif
5103
5104 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (++ssl->in_epoch == 0) {
5106 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005107 /* This is highly unlikely to happen for legitimate reasons, so
5108 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005110 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005116
Paul Bakker5121ce52009-01-03 21:22:43 +00005117 ssl->state++;
5118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005122}
5123
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005124/* Once ssl->out_hdr as the address of the beginning of the
5125 * next outgoing record is set, deduce the other pointers.
5126 *
5127 * Note: For TLS, we save the implicit record sequence number
5128 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5129 * and the caller has to make sure there's space for this.
5130 */
5131
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005132static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005134{
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005136}
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5139 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005140{
5141#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005143 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005144#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005145 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005146 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005148 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005150#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005151 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005152#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005153 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005155#endif
5156 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005157 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005158#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005159 ssl->out_cid = ssl->out_len;
5160#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005161 ssl->out_iv = ssl->out_hdr + 5;
5162 }
5163
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005164 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005165 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (transform != NULL) {
5167 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5168 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005169}
5170
5171/* Once ssl->in_hdr as the address of the beginning of the
5172 * next incoming record is set, deduce the other pointers.
5173 *
5174 * Note: For TLS, we save the implicit record sequence number
5175 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5176 * and the caller has to make sure there's space for this.
5177 */
5178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005180{
Hanno Becker79594fd2019-05-08 09:38:41 +01005181 /* This function sets the pointers to match the case
5182 * of unprotected TLS/DTLS records, with both ssl->in_iv
5183 * and ssl->in_msg pointing to the beginning of the record
5184 * content.
5185 *
5186 * When decrypting a protected record, ssl->in_msg
5187 * will be shifted to point to the beginning of the
5188 * record plaintext.
5189 */
5190
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005191#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005193 /* This sets the header pointers to match records
5194 * without CID. When we receive a record containing
5195 * a CID, the fields are shifted accordingly in
5196 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005197 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005198#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005199 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005200 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005201#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005202 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005203#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005204 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005206#endif
5207 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005208 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005209 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005210#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005211 ssl->in_cid = ssl->in_len;
5212#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005213 ssl->in_iv = ssl->in_hdr + 5;
5214 }
5215
Hanno Becker79594fd2019-05-08 09:38:41 +01005216 /* This will be adjusted at record decryption time. */
5217 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005218}
5219
Paul Bakker5121ce52009-01-03 21:22:43 +00005220/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005221 * Setup an SSL context
5222 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005223
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005224void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5225{
5226#if defined(MBEDTLS_SSL_PROTO_DTLS)
5227 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5228 ssl->in_hdr = ssl->in_buf;
5229 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005230#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005231 {
5232 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5233 }
5234
5235 /* Derive other internal pointers. */
5236 mbedtls_ssl_update_in_pointers(ssl);
5237}
5238
5239void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005240{
5241 /* Set the incoming and outgoing record pointers. */
5242#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005244 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005246#endif /* MBEDTLS_SSL_PROTO_DTLS */
5247 {
Hanno Becker12078f42021-03-02 15:28:41 +00005248 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005249 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005250 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005251 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005253}
5254
Paul Bakker5121ce52009-01-03 21:22:43 +00005255/*
5256 * SSL get accessors
5257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005258size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005259{
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005261}
5262
Gilles Peskine449bd832023-01-11 14:50:10 +01005263int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005264{
5265 /*
5266 * Case A: We're currently holding back
5267 * a message for further processing.
5268 */
5269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 if (ssl->keep_current_message == 1) {
5271 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5272 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005273 }
5274
5275 /*
5276 * Case B: Further records are pending in the current datagram.
5277 */
5278
5279#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5281 ssl->in_left > ssl->next_record_offset) {
5282 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5283 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005284 }
5285#endif /* MBEDTLS_SSL_PROTO_DTLS */
5286
5287 /*
5288 * Case C: A handshake message is being processed.
5289 */
5290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5292 MBEDTLS_SSL_DEBUG_MSG(3,
5293 ("ssl_check_pending: more handshake messages within current record"));
5294 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005295 }
5296
5297 /*
5298 * Case D: An application data message is being processed
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if (ssl->in_offt != NULL) {
5301 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5302 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005303 }
5304
5305 /*
5306 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005307 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005308 * we implement support for multiple alerts in single records.
5309 */
5310
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5312 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005313}
5314
Paul Bakker43ca69c2011-01-15 17:35:19 +00005315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005317{
Hanno Becker3136ede2018-08-17 15:28:19 +01005318 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005319 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005320 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005321 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5322 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005325
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 if (transform == NULL) {
5327 return (int) out_hdr_len;
5328 }
Hanno Becker78640902018-08-13 16:35:15 +01005329
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 if (transform->psa_alg == PSA_ALG_GCM ||
5332 transform->psa_alg == PSA_ALG_CCM ||
5333 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5334 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5335 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005336 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5338 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5339 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005342
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005343 /* Expansion due to the addition of the MAC. */
5344 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005345
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005346 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005347 * Theoretically up to 256 bytes, but we never use
5348 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005349 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005350
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005351 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005352 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005353#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005354 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005355#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 } else {
5357 MBEDTLS_SSL_DEBUG_MSG(1,
5358 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5359 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005360 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005361
Hanno Beckera0e20d02019-05-15 14:03:01 +01005362#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005364 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005366#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005369}
5370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005372/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005373 * Check record counters and renegotiate if they're above the limit.
5374 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005375MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005376static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005377{
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005379 int in_ctr_cmp;
5380 int out_ctr_cmp;
5381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5385 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005386 }
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5389 &ssl->conf->renego_period[ep_len],
5390 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5391 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005392 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5396 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005397 }
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5400 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005401}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005403
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005404#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5405
Ronald Cron7df18bc2024-03-25 13:42:07 +01005406#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005407MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005408static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005409{
5410
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5412 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005413 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005414 }
5415
Ronald Croncf47a152024-04-02 13:19:57 +02005416 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005417}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005418#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005419
Jerry Yua0446a02022-07-13 11:22:55 +08005420MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005421static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005422{
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005425
Ronald Cron7df18bc2024-03-25 13:42:07 +01005426#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005428 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005429#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5430 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5431 ssl->keep_current_message = 1;
5432
5433 mbedtls_ssl_handshake_set_state(ssl,
5434 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5435 return MBEDTLS_ERR_SSL_WANT_READ;
5436#else
5437 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5438 return 0;
5439#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005441 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005442#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005443
5444 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005446}
5447#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5448
5449#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005450/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005451 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005452 * may only be sent for the purpose of initiating renegotiations.
5453 *
5454 * This function is introduced as a separate helper since the handling
5455 * of post-handshake handshake messages changes significantly in TLS 1.3,
5456 * and having a helper function allows to distinguish between TLS <= 1.2 and
5457 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5458 */
Jerry Yua0446a02022-07-13 11:22:55 +08005459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005460static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005461{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005463
5464 /*
5465 * - For client-side, expect SERVER_HELLO_REQUEST.
5466 * - For server-side, expect CLIENT_HELLO.
5467 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5468 */
5469
5470#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5472 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5473 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5474 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005475
5476 /* With DTLS, drop the packet (probably from last handshake) */
5477#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5479 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005480 }
5481#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005483 }
5484#endif /* MBEDTLS_SSL_CLI_C */
5485
5486#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5488 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5489 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005490
5491 /* With DTLS, drop the packet (probably from last handshake) */
5492#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5494 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005495 }
5496#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005498 }
5499#endif /* MBEDTLS_SSL_SRV_C */
5500
5501#if defined(MBEDTLS_SSL_RENEGOTIATION)
5502 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5504 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5505 ssl->conf->allow_legacy_renegotiation ==
5506 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005507 /*
5508 * Accept renegotiation request
5509 */
5510
5511 /* DTLS clients need to know renego is server-initiated */
5512#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5514 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005515 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5516 }
5517#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 ret = mbedtls_ssl_start_renegotiation(ssl);
5519 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5520 ret != 0) {
5521 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5522 ret);
5523 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005524 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005526#endif /* MBEDTLS_SSL_RENEGOTIATION */
5527 {
5528 /*
5529 * Refuse renegotiation
5530 */
5531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5535 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5536 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5537 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005538 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005539 }
5540
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005542}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005543#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5544
5545MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005546static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005547{
5548 /* Check protocol version and dispatch accordingly. */
5549#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5551 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005552 }
5553#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5554
5555#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5557 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005558 }
5559#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5560
5561 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005563}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005564
Paul Bakker48916f92012-09-16 19:57:18 +00005565/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005566 * brief Read at most 'len' application data bytes from the input
5567 * buffer.
5568 *
5569 * param ssl SSL context:
5570 * - First byte of application data not read yet in the input
5571 * buffer located at address `in_offt`.
5572 * - The number of bytes of data not read yet is `in_msglen`.
5573 * param buf buffer that will hold the data
5574 * param len maximum number of bytes to read
5575 *
5576 * note The function updates the fields `in_offt` and `in_msglen`
5577 * according to the number of bytes read.
5578 *
5579 * return The number of bytes read.
5580 */
5581static int ssl_read_application_data(
5582 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5583{
5584 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5585
5586 if (len != 0) {
5587 memcpy(buf, ssl->in_offt, n);
5588 ssl->in_msglen -= n;
5589 }
5590
5591 /* Zeroising the plaintext buffer to erase unused application data
5592 from the memory. */
5593 mbedtls_platform_zeroize(ssl->in_offt, n);
5594
5595 if (ssl->in_msglen == 0) {
5596 /* all bytes consumed */
5597 ssl->in_offt = NULL;
5598 ssl->keep_current_message = 0;
5599 } else {
5600 /* more data available */
5601 ssl->in_offt += n;
5602 }
5603
5604 return (int) n;
5605}
5606
5607/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005608 * Receive application data decrypted from the SSL layer
5609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005610int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005611{
Janos Follath865b3eb2019-12-16 11:46:15 +00005612 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005613
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 if (ssl == NULL || ssl->conf == NULL) {
5615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5616 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005617
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5622 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5623 return ret;
5624 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005625
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 if (ssl->handshake != NULL &&
5627 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5628 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5629 return ret;
5630 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005631 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005632 }
5633#endif
5634
Hanno Becker4a810fb2017-05-24 16:27:30 +01005635 /*
5636 * Check if renegotiation is necessary and/or handshake is
5637 * in process. If yes, perform/continue, and fall through
5638 * if an unexpected packet is received while the client
5639 * is waiting for the ServerHello.
5640 *
5641 * (There is no equivalent to the last condition on
5642 * the server-side as it is not treated as within
5643 * a handshake while waiting for the ClientHello
5644 * after a renegotiation request.)
5645 */
5646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005647#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 ret = ssl_check_ctr_renegotiate(ssl);
5649 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5650 ret != 0) {
5651 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5652 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005653 }
5654#endif
5655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5657 ret = mbedtls_ssl_handshake(ssl);
5658 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5659 ret != 0) {
5660 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5661 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005662 }
5663 }
5664
Hanno Beckere41158b2017-10-23 13:30:32 +01005665 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005667 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 if (ssl->f_get_timer != NULL &&
5669 ssl->f_get_timer(ssl->p_timer) == -1) {
5670 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005671 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5674 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5675 return 0;
5676 }
Paul Bakker831a7552011-05-18 13:32:51 +00005677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5679 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005680 }
5681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (ssl->in_msglen == 0 &&
5683 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005684 /*
5685 * OpenSSL sends empty messages to randomize the IV
5686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5688 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5689 return 0;
5690 }
Paul Bakker831a7552011-05-18 13:32:51 +00005691
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5693 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005694 }
5695 }
5696
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5698 ret = ssl_handle_hs_message_post_handshake(ssl);
5699 if (ret != 0) {
5700 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5701 ret);
5702 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005703 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005704
Hanno Beckerf26cc722021-04-21 07:30:13 +01005705 /* At this point, we don't know whether the renegotiation triggered
5706 * by the post-handshake message has been completed or not. The cases
5707 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005708 * 1) The renegotiation is complete. In this case, no new record
5709 * has been read yet.
5710 * 2) The renegotiation is incomplete because the client received
5711 * an application data record while awaiting the ServerHello.
5712 * 3) The renegotiation is incomplete because the client received
5713 * a non-handshake, non-application data message while awaiting
5714 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005715 *
5716 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005717 * - For 1), the next iteration will read a new record and check
5718 * if it's application data.
5719 * - For 2), the loop condition isn't satisfied as application data
5720 * is present, hence continue is the same as break
5721 * - For 3), the loop condition is satisfied and read_record
5722 * will re-deliver the message that was held back by the client
5723 * when expecting the ServerHello.
5724 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005725
Hanno Becker90333da2017-10-10 11:27:13 +01005726 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005727 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005728#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5730 if (ssl->conf->renego_max_records >= 0) {
5731 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5732 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5733 "but not honored by client"));
5734 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005735 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005736 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005737 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5742 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5743 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005744 }
5745
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5747 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5748 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005749 }
5750
5751 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005752
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005753 /* We're going to return something now, cancel timer,
5754 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5756 mbedtls_ssl_set_timer(ssl, 0);
5757 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005758
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005759#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005760 /* If we requested renego but received AppData, resend HelloRequest.
5761 * Do it now, after setting in_offt, to avoid taking this branch
5762 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5765 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5766 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5767 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5768 ret);
5769 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005770 }
5771 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005773#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005774 }
5775
Jerry Yu739a1d42022-12-08 21:10:25 +08005776 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005777
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005779
Jerry Yu739a1d42022-12-08 21:10:25 +08005780 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005781}
5782
Jerry Yud9ca3542023-12-06 17:23:52 +08005783#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5784int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5785 unsigned char *buf, size_t len)
5786{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005787 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5789 }
5790
Ronald Cron164537c2024-02-01 18:05:47 +01005791 /*
5792 * The server may receive early data only while waiting for the End of
5793 * Early Data handshake message.
5794 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005795 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5796 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005797 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5798 }
5799
Ronald Croned7d4bf2024-01-31 07:55:19 +01005800 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005801}
5802#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5803
Paul Bakker5121ce52009-01-03 21:22:43 +00005804/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005805 * Send application data to be encrypted by the SSL layer, taking care of max
5806 * fragment length and buffer size.
5807 *
5808 * According to RFC 5246 Section 6.2.1:
5809 *
5810 * Zero-length fragments of Application data MAY be sent as they are
5811 * potentially useful as a traffic analysis countermeasure.
5812 *
5813 * Therefore, it is possible that the input message length is 0 and the
5814 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005815 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005816MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005817static int ssl_write_real(mbedtls_ssl_context *ssl,
5818 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005819{
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005821 const size_t max_len = (size_t) ret;
5822
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (ret < 0) {
5824 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5825 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005826 }
5827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005829#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5831 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5832 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5833 " > %" MBEDTLS_PRINTF_SIZET,
5834 len, max_len));
5835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5836 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005837#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005839 }
Paul Bakker887bd502011-06-08 13:10:54 +00005840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005842 /*
5843 * The user has previously tried to send the data and
5844 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5845 * written. In this case, we expect the high-level write function
5846 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5849 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5850 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005851 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005853 /*
5854 * The user is trying to send a message the first time, so we need to
5855 * copy the data into the internal buffers and setup the data structure
5856 * to keep track of partial writes
5857 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005858 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005859 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005860 if (len > 0) {
5861 memcpy(ssl->out_msg, buf, len);
5862 }
Paul Bakker887bd502011-06-08 13:10:54 +00005863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5866 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005867 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005868 }
5869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005871}
5872
5873/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005874 * Write application data (public-facing wrapper)
5875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005876int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005877{
Janos Follath865b3eb2019-12-16 11:46:15 +00005878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (ssl == NULL || ssl->conf == NULL) {
5883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5884 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005885
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005886#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5888 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5889 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005890 }
5891#endif
5892
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5894 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5895 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5896 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005897 }
5898 }
5899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005903
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005905}
5906
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005907#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5908int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5909 const unsigned char *buf, size_t len)
5910{
5911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5912 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005913 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005914
5915 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5916
5917 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5919 }
5920
Ronald Cron49221902024-02-21 13:39:14 +01005921 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5923 }
5924
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005925 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5926 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5927 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5928 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5929 }
5930
5931 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5932 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5933 }
5934
5935 /*
Ronald Crond2884662024-03-03 15:03:22 +01005936 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005937 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005938 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005939 * enough to be able to send early data if possible. That way, we can
5940 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005941 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005942 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5943 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005944 * as the early data outbound transform has not been set as we may have to
5945 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005946 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005947 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005948 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005949 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005950 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005951 ret = mbedtls_ssl_handshake_step(ssl);
5952 if (ret != 0) {
5953 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5954 return ret;
5955 }
5956
5957 ret = mbedtls_ssl_flush_output(ssl);
5958 if (ret != 0) {
5959 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5960 return ret;
5961 }
5962 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005963 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005964 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005965 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005966 * If we are past the point where we can send early data or we have
5967 * already reached the maximum early data size, return immediatly.
5968 * Otherwise, progress the handshake as much as possible to not delay
5969 * it too much. If we reach a point where we can still send early data,
5970 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005971 */
Ronald Crond2884662024-03-03 15:03:22 +01005972 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5973 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005974 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5975 }
5976
Ronald Cron62f971a2024-02-23 08:24:12 +01005977 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005978 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005979
5980 if (remaining == 0) {
5981 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5982 }
5983
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005984 ret = mbedtls_ssl_handshake(ssl);
5985 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5986 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5987 return ret;
5988 }
5989 }
5990
Ronald Crond2884662024-03-03 15:03:22 +01005991 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5992 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005993 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005994 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5995 }
5996
Ronald Cron62f971a2024-02-23 08:24:12 +01005997 if (len > remaining) {
5998 len = remaining;
5999 }
6000
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006001 ret = ssl_write_real(ssl, buf, len);
6002 if (ret >= 0) {
6003 ssl->total_early_data_size += ret;
6004 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006005
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006006 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006007
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006008 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006009}
6010#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6011
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006012/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006013 * Notify the peer that the connection is being closed
6014 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006015int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006016{
Janos Follath865b3eb2019-12-16 11:46:15 +00006017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 if (ssl == NULL || ssl->conf == NULL) {
6020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6021 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006024
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6026 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6027 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6028 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6029 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6030 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006031 }
6032 }
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006037}
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006040{
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006042 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 psa_destroy_key(transform->psa_key_enc);
6046 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006047
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006048#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 psa_destroy_key(transform->psa_mac_enc);
6050 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00006051#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006054}
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6057 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006058{
Jerry Yuc7875b52021-09-05 21:05:50 +08006059 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006061}
6062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6064 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006065{
6066 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006068}
6069
Hanno Becker0271f962018-08-16 13:23:47 +01006070#if defined(MBEDTLS_SSL_PROTO_DTLS)
6071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006073{
6074 unsigned offset;
6075 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006078 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 }
Hanno Becker0271f962018-08-16 13:23:47 +01006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6084 ssl_buffering_free_slot(ssl, offset);
6085 }
Hanno Beckere605b192018-08-21 15:59:07 +01006086}
6087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6089 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006090{
6091 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6092 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006093
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006095 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006099 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006100 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006102 }
6103}
6104
6105#endif /* MBEDTLS_SSL_PROTO_DTLS */
6106
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006107/*
6108 * Convert version numbers to/from wire format
6109 * and, for DTLS, to/from TLS equivalent.
6110 *
6111 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006112 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006113 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006114 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006115 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006116void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6117 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006118{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006119 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006120#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006122 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006124 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006125#else
6126 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006127#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006128 {
6129 tls_version_formatted = (uint16_t) tls_version;
6130 }
6131 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006132}
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6135 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006136{
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006138#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006140 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6142 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006143#else
6144 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006145#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006146 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006147}
6148
Jerry Yue7047812021-09-13 19:26:39 +08006149/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006150 * Send pending fatal alert.
6151 * 0, No alert message.
6152 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6153 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006155int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006156{
6157 int ret;
6158
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006159 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 if (ssl->send_alert == 0) {
6161 return 0;
6162 }
Jerry Yu394ece62021-09-14 22:17:21 +08006163
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 ret = mbedtls_ssl_send_alert_message(ssl,
6165 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6166 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006167
Jerry Yu3bf1f972021-09-22 21:37:18 +08006168 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6169 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006172 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006173 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 if (ret != 0) {
6176 return ret;
6177 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006180}
6181
Jerry Yu394ece62021-09-14 22:17:21 +08006182/*
6183 * Set pending fatal alert flag.
6184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006185void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6186 unsigned char alert_type,
6187 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006188{
6189 ssl->send_alert = 1;
6190 ssl->alert_type = alert_type;
6191 ssl->alert_reason = alert_reason;
6192}
6193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006194#endif /* MBEDTLS_SSL_TLS_C */