blob: a8c79172fcfe8205d14c416c13d828df152278aa [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,
804 mbedtls_record *rec,
805 int (*f_rng)(void *, unsigned char *, size_t),
806 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000807{
Neil Armstrong136f8402022-03-30 10:58:01 +0200808 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100809 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200811 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 * the description of ssl_extract_add_data_from_record().
813 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200814#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
815 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
816#else
817 unsigned char add_data[13];
818#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100819 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000820 size_t post_avail;
821
822 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000823#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200824 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000825 ((void) ssl);
826#endif
827
828 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200829 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100830#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
831 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 ((void) f_rng);
833 ((void) p_rng);
834#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000835
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000837
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 if (transform == NULL) {
839 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
840 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000841 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100843 || rec->buf == NULL
844 || rec->buf_len < rec->data_offset
845 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100846#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100847 || rec->cid_len != 0
848#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100849 ) {
850 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
851 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100852 }
853
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200855
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000856 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
858 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
859 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
862 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
863 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
864 rec->data_len,
865 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100868
Hanno Becker92313402020-05-20 13:58:58 +0100869 /* The following two code paths implement the (D)TLSInnerPlaintext
870 * structure present in TLS 1.3 and DTLS 1.2 + CID.
871 *
872 * See ssl_build_inner_plaintext() for more information.
873 *
874 * Note that this changes `rec->data_len`, and hence
875 * `post_avail` needs to be recalculated afterwards.
876 *
877 * Note also that the two code paths cannot occur simultaneously
878 * since they apply to different versions of the protocol. There
879 * is hence no risk of double-addition of the inner plaintext.
880 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100881#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100883 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 ssl_compute_padding_length(rec->data_len,
885 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
886 if (ssl_build_inner_plaintext(data,
887 &rec->data_len,
888 post_avail,
889 rec->type,
890 padding) != 0) {
891 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100892 }
893
894 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
895 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100896#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100897
Hanno Beckera0e20d02019-05-15 14:03:01 +0100898#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100899 /*
900 * Add CID information
901 */
902 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
904 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100907 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 ssl_compute_padding_length(rec->data_len,
909 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100910 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100911 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100912 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100913 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100914 * Note that this changes `rec->data_len`, and hence
915 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100916 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if (ssl_build_inner_plaintext(data,
918 &rec->data_len,
919 post_avail,
920 rec->type,
921 padding) != 0) {
922 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100923 }
924
925 rec->type = MBEDTLS_SSL_MSG_CID;
926 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100927#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100930
Paul Bakker5121ce52009-01-03 21:22:43 +0000931 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100932 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000933 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000934#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
936 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
937 if (post_avail < transform->maclen) {
938 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
939 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000940 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200941#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200942 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100943 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100944 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
945 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
946 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000947
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
949 transform->tls_version,
950 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000951
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
953 transform->psa_mac_alg);
954 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100955 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 status = psa_mac_update(&operation, add_data, add_data_len);
959 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100960 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 status = psa_mac_update(&operation, data, rec->data_len);
964 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100965 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
969 &sign_mac_length);
970 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100971 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200975#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200976
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
978 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200979
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 rec->data_len += transform->maclen;
981 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100982 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100983
Gilles Peskine449bd832023-01-11 14:50:10 +0100984hmac_failed_etm_disabled:
985 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500986 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 status = psa_mac_abort(&operation);
988 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500989 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 if (ret != 0) {
992 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
993 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100994 }
Paul Bakker577e0062013-08-28 11:57:20 +0200995 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000996#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000997
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200998 /*
999 * Encrypt
1000 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001001#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1003 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1004 "including %d bytes of padding",
1005 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001006
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001007 /* The only supported stream cipher is "NULL",
1008 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001010#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001011
Valerio Settie5707042023-10-11 11:54:42 +02001012#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001014 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001015 unsigned char *dynamic_iv;
1016 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001017 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001019 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001021
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001022 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (post_avail < transform->taglen) {
1024 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1025 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001026 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001027
Paul Bakker68884e32013-01-07 18:20:04 +01001028 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001029 * Build nonce for AEAD encryption.
1030 *
1031 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1032 * part of the IV is prepended to the ciphertext and
1033 * can be chosen freely - in particular, it need not
1034 * agree with the record sequence number.
1035 * However, since ChaChaPoly as well as all AEAD modes
1036 * in TLS 1.3 use the record sequence number as the
1037 * dynamic part of the nonce, we uniformly use the
1038 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001039 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001040 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 ssl_build_record_nonce(iv, sizeof(iv),
1044 transform->iv_enc,
1045 transform->fixed_ivlen,
1046 dynamic_iv,
1047 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001048
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001049 /*
1050 * Build additional data for AEAD encryption.
1051 * This depends on the TLS version.
1052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1054 transform->tls_version,
1055 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001056
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1058 iv, transform->ivlen);
1059 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1060 dynamic_iv,
1061 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1062 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1063 add_data, add_data_len);
1064 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1065 "including 0 bytes of padding",
1066 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001067
Paul Bakker68884e32013-01-07 18:20:04 +01001068 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001069 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 status = psa_aead_encrypt(transform->psa_key_enc,
1072 transform->psa_alg,
1073 iv, transform->ivlen,
1074 add_data, add_data_len,
1075 data, rec->data_len,
1076 data, rec->buf_len - (data - rec->buf),
1077 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001080 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1082 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001083 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1086 data + rec->data_len - transform->taglen,
1087 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001088 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001089 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001090
1091 /*
1092 * Prefix record content with dynamic IV in case it is explicit.
1093 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 if (dynamic_iv_is_explicit != 0) {
1095 if (rec->data_offset < dynamic_iv_len) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1097 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001098 }
1099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001101 rec->data_offset -= dynamic_iv_len;
1102 rec->data_len += dynamic_iv_len;
1103 }
1104
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001105 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 } else
Valerio Settie5707042023-10-11 11:54:42 +02001107#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001108#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1110 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001111 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001112 size_t padlen, i;
1113 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001114 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001115 size_t part_len;
1116 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001117
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001118 /* Currently we're always using minimal padding
1119 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1121 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001122 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001123 }
1124
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 /* Check there's enough space in the buffer for the padding. */
1126 if (post_avail < padlen + 1) {
1127 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1128 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1129 }
1130
1131 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001132 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001135 rec->data_len += padlen + 1;
1136 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001137
TRodziewicz0f82ec62021-05-12 17:49:18 +02001138#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001139 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001140 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001141 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (f_rng == NULL) {
1144 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1145 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001146 }
TRodziewicz345165c2021-07-06 13:42:11 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (rec->data_offset < transform->ivlen) {
1149 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1150 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001151 }
1152
1153 /*
1154 * Generate IV
1155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1157 if (ret != 0) {
1158 return ret;
1159 }
TRodziewicz345165c2021-07-06 13:42:11 +02001160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001162#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1165 "including %"
1166 MBEDTLS_PRINTF_SIZET
1167 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1168 rec->data_len, transform->ivlen,
1169 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 status = psa_cipher_encrypt_setup(&cipher_op,
1172 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001173
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001175 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1177 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001178 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001181
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001183 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1185 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001186
1187 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 status = psa_cipher_update(&cipher_op,
1190 data, rec->data_len,
1191 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001192
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001194 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1196 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001197
1198 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 status = psa_cipher_finish(&cipher_op,
1201 data + olen, rec->data_len - olen,
1202 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001203
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001205 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1207 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001208
1209 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001210
1211 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (rec->data_len != olen) {
1214 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1215 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001216 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001217
TRodziewicz0f82ec62021-05-12 17:49:18 +02001218 data -= transform->ivlen;
1219 rec->data_offset -= transform->ivlen;
1220 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001224 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001225 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1226 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001227
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001228 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001229 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 if (post_avail < transform->maclen) {
1232 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1233 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001234 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ssl_extract_add_data_from_record(add_data, &add_data_len,
1237 rec, transform->tls_version,
1238 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001239
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1241 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1242 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1244 transform->psa_mac_alg);
1245 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001246 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 status = psa_mac_update(&operation, add_data, add_data_len);
1250 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001251 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 status = psa_mac_update(&operation, data, rec->data_len);
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 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001258
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1260 &sign_mac_length);
1261 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001262 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001266
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001267 rec->data_len += transform->maclen;
1268 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001269 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001270
Gilles Peskine449bd832023-01-11 14:50:10 +01001271hmac_failed_etm_enabled:
1272 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001273 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 status = psa_mac_abort(&operation);
1275 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001276 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 if (ret != 0) {
1279 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1280 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001281 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001282 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001285#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001286 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1288 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001291 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (auth_done != 1) {
1293 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1294 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001295 }
1296
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001298
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001300}
1301
Gilles Peskine449bd832023-01-11 14:50:10 +01001302int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1303 mbedtls_ssl_transform *transform,
1304 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001305{
Valerio Settie5707042023-10-11 11:54:42 +02001306#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001307 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001308#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001309 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001310 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001311
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001312 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001313#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001314 size_t padlen = 0;
1315 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001316#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001318 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 * the description of ssl_extract_add_data_from_record().
1320 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001321#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1322 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1323#else
1324 unsigned char add_data[13];
1325#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001326 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327
Hanno Beckera18d1322018-01-03 14:27:32 +00001328#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001329 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001330 ((void) ssl);
1331#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1334 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335 rec->buf == NULL ||
1336 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 rec->buf_len - rec->data_offset < rec->data_len) {
1338 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1339 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001340 }
1341
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001342 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001344
Hanno Beckera0e20d02019-05-15 14:03:01 +01001345#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001346 /*
1347 * Match record's CID with incoming CID.
1348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001349 if (rec->cid_len != transform->in_cid_len ||
1350 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1351 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001352 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001353#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001354
Hanno Beckerd086bf02021-03-22 13:01:27 +00001355#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001357 if (rec->data_len < transform->maclen) {
1358 MBEDTLS_SSL_DEBUG_MSG(1,
1359 ("Record too short for MAC:"
1360 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1361 rec->data_len, transform->maclen));
1362 return MBEDTLS_ERR_SSL_INVALID_MAC;
1363 }
1364
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001365 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001366 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001369#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001371 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001372 unsigned char *dynamic_iv;
1373 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001374 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001375
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001376 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001377 * Extract dynamic part of nonce for AEAD decryption.
1378 *
1379 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1380 * part of the IV is prepended to the ciphertext and
1381 * can be chosen freely - in particular, it need not
1382 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 dynamic_iv_len = sizeof(rec->ctr);
1385 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1386 if (rec->data_len < dynamic_iv_len) {
1387 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1388 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1389 rec->data_len,
1390 dynamic_iv_len));
1391 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001392 }
1393 dynamic_iv = data;
1394
1395 data += dynamic_iv_len;
1396 rec->data_offset += dynamic_iv_len;
1397 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001399 dynamic_iv = rec->ctr;
1400 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001401
1402 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 if (rec->data_len < transform->taglen) {
1404 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1405 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1406 rec->data_len,
1407 transform->taglen));
1408 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001409 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001410 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001411
Hanno Beckerdf8be222020-05-21 15:30:57 +01001412 /*
1413 * Prepare nonce from dynamic and static parts.
1414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 ssl_build_record_nonce(iv, sizeof(iv),
1416 transform->iv_dec,
1417 transform->fixed_ivlen,
1418 dynamic_iv,
1419 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001420
Hanno Beckerdf8be222020-05-21 15:30:57 +01001421 /*
1422 * Build additional data for AEAD encryption.
1423 * This depends on the TLS version.
1424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1426 transform->tls_version,
1427 transform->taglen);
1428 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1429 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430
Hanno Beckerd96a6522019-07-10 13:55:25 +01001431 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001432 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001433 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001434 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001435 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1438 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1439 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001440
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001441 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001442 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 status = psa_aead_decrypt(transform->psa_key_dec,
1445 transform->psa_alg,
1446 iv, transform->ivlen,
1447 add_data, add_data_len,
1448 data, rec->data_len + transform->taglen,
1449 data, rec->buf_len - (data - rec->buf),
1450 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001451
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001453 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1455 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001456 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001457
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001458 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001459
Hanno Beckerd96a6522019-07-10 13:55:25 +01001460 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 if (olen != rec->data_len) {
1462 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1463 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 } else
Valerio Settie5707042023-10-11 11:54:42 +02001466#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001467#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1469 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001470 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001472 size_t part_len;
1473 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001474
Paul Bakker5121ce52009-01-03 21:22:43 +00001475 /*
Paul Bakker45829992013-01-03 14:52:21 +01001476 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001477 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001478#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001479 /* The ciphertext is prefixed with the CBC IV. */
1480 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001481#endif
Paul Bakker45829992013-01-03 14:52:21 +01001482
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001483 /* Size considerations:
1484 *
1485 * - The CBC cipher text must not be empty and hence
1486 * at least of size transform->ivlen.
1487 *
1488 * Together with the potential IV-prefix, this explains
1489 * the first of the two checks below.
1490 *
1491 * - The record must contain a MAC, either in plain or
1492 * encrypted, depending on whether Encrypt-then-MAC
1493 * is used or not.
1494 * - If it is, the message contains the IV-prefix,
1495 * the CBC ciphertext, and the MAC.
1496 * - If it is not, the padded plaintext, and hence
1497 * the CBC ciphertext, has at least length maclen + 1
1498 * because there is at least the padding length byte.
1499 *
1500 * As the CBC ciphertext is not empty, both cases give the
1501 * lower bound minlen + maclen + 1 on the record size, which
1502 * we test for in the second check below.
1503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 if (rec->data_len < minlen + transform->ivlen ||
1505 rec->data_len < minlen + transform->maclen + 1) {
1506 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1507 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1508 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1509 "+ 1 ) ( + expl IV )",
1510 rec->data_len,
1511 transform->ivlen,
1512 transform->maclen));
1513 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001514 }
1515
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001516 /*
1517 * Authenticate before decrypt if enabled
1518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001521 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001522
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001524
Hanno Beckerd96a6522019-07-10 13:55:25 +01001525 /* Update data_len in tandem with add_data.
1526 *
1527 * The subtraction is safe because of the previous check
1528 * data_len >= minlen + maclen + 1.
1529 *
1530 * Afterwards, we know that data + data_len is followed by at
1531 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001532 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001533 *
1534 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1537 transform->tls_version,
1538 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001539
Hanno Beckerd96a6522019-07-10 13:55:25 +01001540 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1542 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1544 transform->psa_mac_alg);
1545 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001546 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 status = psa_mac_update(&operation, add_data, add_data_len);
1550 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001551 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 status = psa_mac_update(&operation, data, rec->data_len);
1555 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001556 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001558
1559 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1561 transform->maclen);
1562 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001563 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001565 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001566
Gilles Peskine449bd832023-01-11 14:50:10 +01001567hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001568 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 status = psa_mac_abort(&operation);
1570 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001571 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (ret != 0) {
1574 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1576 }
1577 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001578 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001579 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001581
1582 /*
1583 * Check length sanity
1584 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001585
1586 /* We know from above that data_len > minlen >= 0,
1587 * so the following check in particular implies that
1588 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 if (rec->data_len % transform->ivlen != 0) {
1590 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1591 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1592 rec->data_len, transform->ivlen));
1593 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001594 }
1595
TRodziewicz0f82ec62021-05-12 17:49:18 +02001596#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001597 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001598 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001599 */
TRodziewicz345165c2021-07-06 13:42:11 +02001600 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001602
TRodziewicz345165c2021-07-06 13:42:11 +02001603 data += transform->ivlen;
1604 rec->data_offset += transform->ivlen;
1605 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001606#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001607
Hanno Beckerd96a6522019-07-10 13:55:25 +01001608 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1609
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 status = psa_cipher_decrypt_setup(&cipher_op,
1611 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001614 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1616 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001617 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001622 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1624 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001625 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 status = psa_cipher_update(&cipher_op,
1628 data, rec->data_len,
1629 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001632 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1634 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001635 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 status = psa_cipher_finish(&cipher_op,
1638 data + olen, rec->data_len - olen,
1639 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001642 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1644 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001645 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001646
1647 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001648
Hanno Beckerd96a6522019-07-10 13:55:25 +01001649 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if (rec->data_len != olen) {
1651 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1652 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001653 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001654
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001655 /* Safe since data_len >= minlen + maclen + 1, so after having
1656 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001657 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1658 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001659 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001662 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 rec->data_len,
1664 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001665 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001666 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 if (rec->data_len < transform->maclen + padlen + 1) {
1670 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1671 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1672 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1673 rec->data_len,
1674 transform->maclen,
1675 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001676 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001677#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001678 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 rec->data_len,
1680 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001681 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001682 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001683 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001684
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001685 padlen++;
1686
1687 /* Regardless of the validity of the padding,
1688 * we have data_len >= padlen here. */
1689
TRodziewicz0f82ec62021-05-12 17:49:18 +02001690#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001691 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 * consecutive memory reads at the end of the record
1693 * plaintext buffer. In order to hide the length and
1694 * validity of the padding, always perform exactly
1695 * `min(256,plaintext_len)` reads (but take into account
1696 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001697 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001699
1700 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001702 size_t const padding_idx = rec->data_len - padlen;
1703 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1704 size_t const start_idx = rec->data_len - num_checks;
1705 size_t idx;
1706
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001708 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 * (check[idx] == padlen - 1);
1710 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001711 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001712 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001713 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001714 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001715 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001716 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001717 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001720 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1722 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001723#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001724 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001725
TRodziewicz0f82ec62021-05-12 17:49:18 +02001726#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001727
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001728 /* If the padding was found to be invalid, padlen == 0
1729 * and the subtraction is safe. If the padding was found valid,
1730 * padlen hasn't been changed and the previous assertion
1731 * data_len >= padlen still holds. */
1732 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001734#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001735 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1737 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001738 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001739
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001740#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1742 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001743#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001744
1745 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001746 * Authenticate if not done yet.
1747 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001748 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001749#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001751 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1752 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001753
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001754 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001755 * data_len < maclen + padlen + 1, then padlen
1756 * got reset to 1, and the initial check
1757 * data_len >= minlen + maclen + 1
1758 * guarantees that at this point we still
1759 * have at least data_len >= maclen.
1760 *
1761 * If the initial value of padlen was such that
1762 * data_len >= maclen + padlen + 1, then we have
1763 * subtracted either padlen + 1 (if the padding was correct)
1764 * or 0 (if the padding was incorrect) since then,
1765 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001766 *
1767 * For stream ciphers, we checked above that
1768 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001769 */
1770 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1772 transform->tls_version,
1773 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001774
TRodziewicz0f82ec62021-05-12 17:49:18 +02001775#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001776 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 * The next two sizes are the minimum and maximum values of
1778 * data_len over all padlen values.
1779 *
1780 * They're independent of padlen, since we previously did
1781 * data_len -= padlen.
1782 *
1783 * Note that max_len + maclen is never more than the buffer
1784 * length, as we previously did in_msglen -= maclen too.
1785 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001786 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1790 transform->psa_mac_alg,
1791 add_data, add_data_len,
1792 data, rec->data_len, min_len, max_len,
1793 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 if (ret != 0) {
1795 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001796 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001797 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 mbedtls_ct_memcpy_offset(mac_peer, data,
1800 rec->data_len,
1801 min_len, max_len,
1802 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001803#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001804
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001805#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1807 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001808#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001809
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1811 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001814#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001815 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001816 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001817 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819hmac_failed_etm_disabled:
1820 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1821 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1822 if (ret != 0) {
1823 return ret;
1824 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001825 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001826
1827 /*
1828 * Finally check the correct flag
1829 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001830 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 return MBEDTLS_ERR_SSL_INVALID_MAC;
1832 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001833#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001834
1835 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (auth_done != 1) {
1837 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1838 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001839 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001840
Ronald Cron6f135e12021-12-08 16:57:54 +01001841#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001843 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1845 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (ret != 0) {
1848 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1849 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001850 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001851#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001852
Hanno Beckera0e20d02019-05-15 14:03:01 +01001853#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 if (rec->cid_len != 0) {
1855 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1856 &rec->type);
1857 if (ret != 0) {
1858 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1859 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001860 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001861#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
1867
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001868#undef MAC_NONE
1869#undef MAC_PLAINTEXT
1870#undef MAC_CIPHERTEXT
1871
Paul Bakker5121ce52009-01-03 21:22:43 +00001872/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001873 * Fill the input message buffer by appending data to it.
1874 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001875 *
1876 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1877 * available (from this read and/or a previous one). Otherwise, an error code
1878 * is returned (possibly EOF or WANT_READ).
1879 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001880 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1881 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1882 * since we always read a whole datagram at once.
1883 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001884 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001885 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001886 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001887int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001888{
Janos Follath865b3eb2019-12-16 11:46:15 +00001889 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001890 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001891#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1892 size_t in_buf_len = ssl->in_buf_len;
1893#else
1894 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1895#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001896
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1900 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1901 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001902 }
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1905 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001907 }
1908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001911 uint32_t timeout;
1912
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001913 /*
1914 * The point is, we need to always read a full datagram at once, so we
1915 * sometimes read more then requested, and handle the additional data.
1916 * It could be the rest of the current record (while fetching the
1917 * header) and/or some other records in the same datagram.
1918 */
1919
1920 /*
1921 * Move to the next record in the already read datagram if applicable
1922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 if (ssl->next_record_offset != 0) {
1924 if (ssl->in_left < ssl->next_record_offset) {
1925 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1926 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001927 }
1928
1929 ssl->in_left -= ssl->next_record_offset;
1930
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (ssl->in_left != 0) {
1932 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1933 MBEDTLS_PRINTF_SIZET,
1934 ssl->next_record_offset));
1935 memmove(ssl->in_hdr,
1936 ssl->in_hdr + ssl->next_record_offset,
1937 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001938 }
1939
1940 ssl->next_record_offset = 0;
1941 }
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1944 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1945 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001946
1947 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001948 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 if (nb_want <= ssl->in_left) {
1951 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1952 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001953 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001954
1955 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001956 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001957 * are not at the beginning of a new record, the caller did something
1958 * wrong.
1959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (ssl->in_left != 0) {
1961 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1962 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001963 }
1964
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001965 /*
1966 * Don't even try to read if time's out already.
1967 * This avoids by-passing the timer when repeatedly receiving messages
1968 * that will end up being dropped.
1969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 if (mbedtls_ssl_check_timer(ssl) != 0) {
1971 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001972 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001974 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001977 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001979 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (ssl->f_recv_timeout != NULL) {
1985 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1986 timeout);
1987 } else {
1988 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1989 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 if (ret == 0) {
1994 return MBEDTLS_ERR_SSL_CONN_EOF;
1995 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001996 }
1997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1999 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2000 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2003 if (ssl_double_retransmit_timeout(ssl) != 0) {
2004 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2005 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002006 }
2007
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2009 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2010 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002011 }
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002014 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2017 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2018 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2019 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2020 ret);
2021 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002022 }
2023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002027 }
2028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 if (ret < 0) {
2030 return ret;
2031 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002032
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002033 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002035#endif
2036 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2038 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2039 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002042 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002045 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 } else {
2047 if (ssl->f_recv_timeout != NULL) {
2048 ret = ssl->f_recv_timeout(ssl->p_bio,
2049 ssl->in_hdr + ssl->in_left, len,
2050 ssl->conf->read_timeout);
2051 } else {
2052 ret = ssl->f_recv(ssl->p_bio,
2053 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002054 }
2055 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2058 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2059 ssl->in_left, nb_want));
2060 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (ret == 0) {
2063 return MBEDTLS_ERR_SSL_CONN_EOF;
2064 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if (ret < 0) {
2067 return ret;
2068 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002069
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002070 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 MBEDTLS_SSL_DEBUG_MSG(1,
2072 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2073 " were requested",
2074 ret, len));
2075 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002076 }
2077
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002078 ssl->in_left += ret;
2079 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002080 }
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002085}
2086
2087/*
2088 * Flush any data not yet written
2089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002090int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002091{
Janos Follath865b3eb2019-12-16 11:46:15 +00002092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002093 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (ssl->f_send == NULL) {
2098 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2099 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002100 }
2101
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002102 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (ssl->out_left == 0) {
2104 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2105 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002106 }
2107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 while (ssl->out_left > 0) {
2109 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2110 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2111 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002112
Hanno Becker2b1e3542018-08-06 11:19:13 +01002113 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (ret <= 0) {
2119 return ret;
2120 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002122 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 MBEDTLS_SSL_DEBUG_MSG(1,
2124 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2125 " bytes were sent",
2126 ret, ssl->out_left));
2127 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002128 }
2129
Paul Bakker5121ce52009-01-03 21:22:43 +00002130 ssl->out_left -= ret;
2131 }
2132
Hanno Becker2b1e3542018-08-06 11:19:13 +01002133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002135 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002137#endif
2138 {
2139 ssl->out_hdr = ssl->out_buf + 8;
2140 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002146}
2147
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002148/*
2149 * Functions to handle the DTLS retransmission state machine
2150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002152/*
2153 * Append current handshake message to current outgoing flight
2154 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002155MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002156static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2160 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2161 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162
2163 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2165 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2166 sizeof(mbedtls_ssl_flight_item)));
2167 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002168 }
2169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2171 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2172 ssl->out_msglen));
2173 mbedtls_free(msg);
2174 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002175 }
2176
2177 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002179 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002180 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181 msg->next = NULL;
2182
2183 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002185 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191 cur->next = msg;
2192 }
2193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2195 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002196}
2197
2198/*
2199 * Free the current flight of handshake messages
2200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 mbedtls_ssl_flight_item *cur = flight;
2204 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002207 next = cur->next;
2208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 mbedtls_free(cur->p);
2210 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002211
2212 cur = next;
2213 }
2214}
2215
2216/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002217 * Swap transform_out and out_ctr with the alternative ones
2218 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002220static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002221{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002223 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2226 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2227 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002228 }
2229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002231
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002232 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002233 tmp_transform = ssl->transform_out;
2234 ssl->transform_out = ssl->handshake->alt_transform_out;
2235 ssl->handshake->alt_transform_out = tmp_transform;
2236
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002237 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2239 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2240 sizeof(ssl->cur_out_ctr));
2241 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2242 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002243
2244 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002248}
2249
2250/*
2251 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002252 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002253int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002254{
2255 int ret = 0;
2256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002264}
2265
2266/*
2267 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002268 *
2269 * Need to remember the current message in case flush_output returns
2270 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002271 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002273int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274{
Janos Follath865b3eb2019-12-16 11:46:15 +00002275 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2279 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002280
2281 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002282 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 ret = ssl_swap_epochs(ssl);
2284 if (ret != 0) {
2285 return ret;
2286 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002289 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002292 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002293 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002294
Hanno Beckere1dcb032018-08-17 16:47:58 +01002295 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2297 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002298
Ronald Cron00d012f22022-03-08 15:57:12 +01002299 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002301
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002302 /* Swap epochs before sending Finished: we can't do it after
2303 * sending ChangeCipherSpec, in case write returns WANT_READ.
2304 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2306 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2307 ret = ssl_swap_epochs(ssl);
2308 if (ret != 0) {
2309 return ret;
2310 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002311 }
2312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ret = ssl_get_remaining_payload_in_datagram(ssl);
2314 if (ret < 0) {
2315 return ret;
2316 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317 max_frag_len = (size_t) ret;
2318
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002319 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2321 if (max_frag_len == 0) {
2322 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2323 return ret;
2324 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002325
2326 continue;
2327 }
2328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002330 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002331 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002332
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002333 /* Update position inside current message */
2334 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002336 const unsigned char * const p = ssl->handshake->cur_msg_p;
2337 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002338 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002339 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002340 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2343 if (is_finished) {
2344 ret = ssl_swap_epochs(ssl);
2345 if (ret != 0) {
2346 return ret;
2347 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002348 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2351 return ret;
2352 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002353
2354 continue;
2355 }
2356 max_hs_frag_len = max_frag_len - 12;
2357
2358 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2362 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2363 (unsigned) cur_hs_frag_len,
2364 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002365 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002366
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002367 /* Messages are stored with handshake headers as if not fragmented,
2368 * copy beginning of headers then fill fragmentation fields.
2369 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2373 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2374 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2377 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2378 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002381
Hanno Becker3f7b9732018-08-28 09:53:25 +01002382 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002384 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002385 ssl->out_msgtype = cur->type;
2386
2387 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002388 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002389 }
2390
2391 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2393 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002394 ssl->handshake->cur_msg = cur->next;
2395 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002397 ssl->handshake->cur_msg = NULL;
2398 ssl->handshake->cur_msg_p = NULL;
2399 }
2400 }
2401
2402 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2404 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2405 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002406 }
2407 }
2408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2410 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002411 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002412
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 /* Update state and set timer */
2414 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2415 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2416 } else {
2417 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2418 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2419 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2422
2423 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002424}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002425
2426/*
2427 * To be called when the last message of an incoming flight is received.
2428 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002429void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002430{
2431 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002433 ssl->handshake->flight = NULL;
2434 ssl->handshake->cur_msg = NULL;
2435
2436 /* The next incoming flight will start with this msg_seq */
2437 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2438
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002439 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002440 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002441
Hanno Becker0271f962018-08-16 13:23:47 +01002442 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002444
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002445 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2449 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002454}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002455
2456/*
2457 * To be called when the last message of an outgoing flight is send.
2458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002459void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002460{
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 ssl_reset_retransmit_timeout(ssl);
2462 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2465 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002470}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002472
Paul Bakker5121ce52009-01-03 21:22:43 +00002473/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002474 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002476int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002478{
2479 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002480 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002481 * ...
2482 * HandshakeType msg_type;
2483 * uint24 length;
2484 * ...
2485 */
2486 *buf = ssl->out_msg + 4;
2487 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2488
2489 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2490 ssl->out_msg[0] = hs_type;
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002493}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002494
2495/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002496 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002497 *
2498 * - fill in handshake headers
2499 * - update handshake checksum
2500 * - DTLS: save message for resending
2501 * - then pass to the record layer
2502 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002503 * DTLS: except for HelloRequest, messages are only queued, and will only be
2504 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002505 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002506 * Inputs:
2507 * - ssl->out_msglen: 4 + actual handshake message len
2508 * (4 is the size of handshake headers for TLS)
2509 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2510 * - ssl->out_msg + 4: the handshake message body
2511 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002512 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002513 * - ssl->out_msglen: the length of the record contents
2514 * (including handshake headers but excluding record headers)
2515 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002516 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002517int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2518 int update_checksum,
2519 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002520{
Janos Follath865b3eb2019-12-16 11:46:15 +00002521 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002522 const size_t hs_len = ssl->out_msglen - 4;
2523 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002526
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002527 /*
2528 * Sanity checks
2529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2531 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2532 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2533 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002534 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002535
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002536 /* Whenever we send anything different from a
2537 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2539 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2540 ssl->handshake == NULL) {
2541 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2542 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002543 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2549 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2550 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002551 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002552#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002553
Hanno Beckerb50a2532018-08-06 11:52:54 +01002554 /* Double-check that we did not exceed the bounds
2555 * of the outgoing record buffer.
2556 * This should never fail as the various message
2557 * writing functions must obey the bounds of the
2558 * outgoing record buffer, but better be safe.
2559 *
2560 * Note: We deliberately do not check for the MTU or MFL here.
2561 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2563 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2564 "size %" MBEDTLS_PRINTF_SIZET
2565 ", maximum %" MBEDTLS_PRINTF_SIZET,
2566 ssl->out_msglen,
2567 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2568 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002569 }
2570
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002571 /*
2572 * Fill handshake headers
2573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2575 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2576 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2577 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002578
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002579 /*
2580 * DTLS has additional fields in the Handshake layer,
2581 * between the length field and the actual payload:
2582 * uint16 message_seq;
2583 * uint24 fragment_offset;
2584 * uint24 fragment_length;
2585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002588 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2590 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2591 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2592 MBEDTLS_PRINTF_SIZET,
2593 hs_len,
2594 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002596 }
2597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002599 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002600
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002601 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2603 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2604 ++(ssl->handshake->out_msg_seq);
2605 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002606 ssl->out_msg[4] = 0;
2607 ssl->out_msg[5] = 0;
2608 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002609
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002610 /* Handshake hashes are computed without fragmentation,
2611 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 memset(ssl->out_msg + 6, 0x00, 3);
2613 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002614 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002616
Hanno Becker0207e532018-08-28 10:28:28 +01002617 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002619 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2620 ssl->out_msglen);
2621 if (ret != 0) {
2622 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2623 return ret;
2624 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002626 }
2627
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002628 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2631 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2632 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2633 if ((ret = ssl_flight_append(ssl)) != 0) {
2634 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2635 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002636 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002638#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002639 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2641 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2642 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002643 }
2644 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002649}
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2652 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002653{
2654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2655 size_t msg_with_header_len;
2656 ((void) buf_len);
2657
2658 /* Add reserved 4 bytes for handshake header */
2659 msg_with_header_len = msg_len + 4;
2660 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002662
2663cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002665}
2666
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002667/*
2668 * Record layer functions
2669 */
2670
2671/*
2672 * Write current record.
2673 *
2674 * Uses:
2675 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2676 * - ssl->out_msglen: length of the record content (excl headers)
2677 * - ssl->out_msg: record content
2678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002679int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002680{
2681 int ret, done = 0;
2682 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002683 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002688 unsigned i;
2689 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002690#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2691 size_t out_buf_len = ssl->out_buf_len;
2692#else
2693 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2694#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002695 /* Skip writing the record content type to after the encryption,
2696 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002697 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002698#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002699 /* TLS 1.3 still uses the TLS 1.2 version identifier
2700 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002702 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002704#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2706 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2709 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002712 mbedtls_record rec;
2713
2714 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002715 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002716 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002717 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002718
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2720 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002721 rec.type = ssl->out_msgtype;
2722
Hanno Beckera0e20d02019-05-15 14:03:01 +01002723#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002724 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002725 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002726#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2729 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2730 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2731 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002732 }
2733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (rec.data_offset != 0) {
2735 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2736 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002737 }
2738
Hanno Becker6430faf2019-05-08 11:57:13 +01002739 /* Update the record content type and CID. */
2740 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002741#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2742 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002743#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002744 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002746 }
2747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002749
2750#if defined(MBEDTLS_SSL_PROTO_DTLS)
2751 /* In case of DTLS, double-check that we don't exceed
2752 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2754 ret = ssl_get_remaining_space_in_datagram(ssl);
2755 if (ret < 0) {
2756 return ret;
2757 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002760 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002762 }
2763 }
2764#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002765
Hanno Becker6430faf2019-05-08 11:57:13 +01002766 /* Now write the potentially updated record content type. */
2767 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2770 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2771 ssl->out_hdr[0], ssl->out_hdr[1],
2772 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2775 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002776
2777 ssl->out_left += protected_record_size;
2778 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2782 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002783 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 }
2785 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002786
Gabor Mezei96ae9262022-06-28 11:45:18 +02002787 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (i == mbedtls_ssl_ep_len(ssl)) {
2789 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2790 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002791 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 }
2793
Hanno Becker67bc7c32018-08-06 11:33:50 +01002794#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2796 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002797 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 ret = ssl_get_remaining_payload_in_datagram(ssl);
2799 if (ret < 0) {
2800 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2801 ret);
2802 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002803 }
2804
2805 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002807 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 } else {
2809 MBEDTLS_SSL_DEBUG_MSG(2,
2810 ("Still %u bytes available in current datagram",
2811 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002812 }
2813 }
2814#endif /* MBEDTLS_SSL_PROTO_DTLS */
2815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 if ((flush == SSL_FORCE_FLUSH) &&
2817 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2819 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002820 }
2821
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002825}
2826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002828
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002830static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002831{
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (ssl->in_msglen < ssl->in_hslen ||
2833 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2834 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2835 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002836 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002838}
Hanno Becker44650b72018-08-16 12:51:11 +01002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002841{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002842 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002843}
2844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002846{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002847 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002848}
2849
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002850MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002851static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002852{
2853 uint32_t msg_len, frag_off, frag_len;
2854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 msg_len = ssl_get_hs_total_len(ssl);
2856 frag_off = ssl_get_hs_frag_off(ssl);
2857 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (frag_off > msg_len) {
2860 return -1;
2861 }
Hanno Becker44650b72018-08-16 12:51:11 +01002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (frag_len > msg_len - frag_off) {
2864 return -1;
2865 }
Hanno Becker44650b72018-08-16 12:51:11 +01002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (frag_len + 12 > ssl->in_msglen) {
2868 return -1;
2869 }
Hanno Becker44650b72018-08-16 12:51:11 +01002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002872}
2873
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002874/*
2875 * Mark bits in bitmask (used for DTLS HS reassembly)
2876 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002878{
2879 unsigned int start_bits, end_bits;
2880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 start_bits = 8 - (offset % 8);
2882 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002883 size_t first_byte_idx = offset / 8;
2884
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002885 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 if (len <= start_bits) {
2887 for (; len != 0; len--) {
2888 mask[first_byte_idx] |= 1 << (start_bits - len);
2889 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002890
2891 /* Avoid potential issues with offset or len becoming invalid */
2892 return;
2893 }
2894
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002895 offset += start_bits; /* Now offset % 8 == 0 */
2896 len -= start_bits;
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 for (; start_bits != 0; start_bits--) {
2899 mask[first_byte_idx] |= 1 << (start_bits - 1);
2900 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002901 }
2902
2903 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (end_bits != 0) {
2905 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002906
2907 len -= end_bits; /* Now len % 8 == 0 */
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 for (; end_bits != 0; end_bits--) {
2910 mask[last_byte_idx] |= 1 << (8 - end_bits);
2911 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002912 }
2913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002915}
2916
2917/*
2918 * Check that bitmask is full
2919 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002920MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002921static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002922{
2923 size_t i;
2924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 for (i = 0; i < len / 8; i++) {
2926 if (mask[i] != 0xFF) {
2927 return -1;
2928 }
2929 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 for (i = 0; i < len % 8; i++) {
2932 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2933 return -1;
2934 }
2935 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002938}
2939
Hanno Becker56e205e2018-08-16 09:06:12 +01002940/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002941static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2942 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002943{
Hanno Becker56e205e2018-08-16 09:06:12 +01002944 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002945
Hanno Becker56e205e2018-08-16 09:06:12 +01002946 alloc_len = 12; /* Handshake header */
2947 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 if (add_bitmap) {
2950 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 }
2953 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002954}
Hanno Becker56e205e2018-08-16 09:06:12 +01002955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002959{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002960 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002961}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002964{
Gilles Peskine7a176962025-02-28 21:59:12 +01002965 if (ssl->in_hsfraglen == 0) {
2966 /* The handshake message must at least include the header.
2967 * We may not have the full message yet in case of fragmentation.
2968 * To simplify the code, we insist on having the header (and in
2969 * particular the handshake message length) in the first
2970 * fragment. */
2971 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2972 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2973 ssl->in_msglen));
2974 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2975 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002976
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002977 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002978 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2981 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2982 MBEDTLS_PRINTF_SIZET,
2983 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002988 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 if (ssl_check_hs_header(ssl) != 0) {
2991 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2992 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002993 }
2994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 if (ssl->handshake != NULL &&
2996 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2997 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2998 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
2999 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3000 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3001 MBEDTLS_SSL_DEBUG_MSG(2,
3002 (
3003 "received future handshake message of sequence number %u (next %u)",
3004 recv_msg_seq,
3005 ssl->handshake->in_msg_seq));
3006 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003007 }
3008
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003009 /* Retransmit only on last message from previous flight, to avoid
3010 * too many retransmissions.
3011 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3013 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3014 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3015 "message_seq = %u, start_of_flight = %u",
3016 recv_msg_seq,
3017 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3020 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3021 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003022 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 } else {
3024 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3025 "message_seq = %u, expected = %u",
3026 recv_msg_seq,
3027 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003028 }
3029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003031 }
3032 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003033
Hanno Becker6d97ef52018-08-16 13:09:04 +01003034 /* Message reassembly is handled alongside buffering of future
3035 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003036 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003037 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3039 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3040 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003041 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003044 if (ssl->in_hsfraglen <= ssl->in_hslen) {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003045 int ret;
3046 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003047 MBEDTLS_SSL_DEBUG_MSG(3,
Gilles Peskine07027722025-03-03 16:46:10 +01003048 ("handshake fragment: %" MBEDTLS_PRINTF_SIZET
3049 ", %" MBEDTLS_PRINTF_SIZET
3050 "..%" MBEDTLS_PRINTF_SIZET
3051 " of %" MBEDTLS_PRINTF_SIZET,
3052 ssl->in_msglen,
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02003053 ssl->in_hsfraglen,
Gilles Peskine07027722025-03-03 16:46:10 +01003054 ssl->in_hsfraglen + ssl->in_msglen,
3055 ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003056 if (ssl->in_msglen < hs_remain) {
3057 ssl->in_hsfraglen += ssl->in_msglen;
3058 ssl->in_hdr = ssl->in_msg + ssl->in_msglen;
3059 ssl->in_msglen = 0;
3060 mbedtls_ssl_update_in_pointers(ssl);
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01003061 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3062 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
3063 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003064 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3065 }
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003066 if (ssl->in_hsfraglen > 0) {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003067 /*
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003068 * At in_first_hdr we have a sequence of records that cover the next handshake
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003069 * record, each with its own record header that we need to remove.
3070 * Note that the reassembled record size may not equal the size of the message,
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003071 * there may be more messages after it, complete or partial.
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003072 */
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003073 unsigned char *in_first_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3074 unsigned char *p = in_first_hdr, *q = NULL;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003075 size_t merged_rec_len = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003076 do {
3077 mbedtls_record rec;
3078 ret = ssl_parse_record_header(ssl, p, mbedtls_ssl_in_hdr_len(ssl), &rec);
3079 if (ret != 0) {
3080 return ret;
3081 }
3082 merged_rec_len += rec.data_len;
3083 p = rec.buf + rec.buf_len;
3084 if (q != NULL) {
3085 memmove(q, rec.buf + rec.data_offset, rec.data_len);
3086 q += rec.data_len;
3087 } else {
3088 q = p;
3089 }
3090 } while (merged_rec_len < ssl->in_hslen);
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003091 ssl->in_hdr = in_first_hdr;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003092 mbedtls_ssl_update_in_pointers(ssl);
3093 ssl->in_msglen = merged_rec_len;
3094 /* Adjust message length. */
3095 MBEDTLS_PUT_UINT16_BE(merged_rec_len, ssl->in_len, 0);
3096 ssl->in_hsfraglen = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003097 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
3098 ssl->in_hdr, mbedtls_ssl_in_hdr_len(ssl) + merged_rec_len);
3099 }
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03003100 } else {
3101 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003102 }
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003105}
3106
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003107int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003108{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003110 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003113 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3114 if (ret != 0) {
3115 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3116 return ret;
3117 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003118 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003119
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003120 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3123 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003124 unsigned offset;
3125 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003126
Hanno Becker0271f962018-08-16 13:23:47 +01003127 /* Increment handshake sequence number */
3128 hs->in_msg_seq++;
3129
3130 /*
3131 * Clear up handshake buffering and reassembly structure.
3132 */
3133
3134 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003136
3137 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003139 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003141 *hs_buf = *(hs_buf + 1);
3142 }
3143
3144 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003146 }
3147#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003148 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003149}
3150
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003151/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003152 * DTLS anti-replay: RFC 6347 4.1.2.6
3153 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003154 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3155 * Bit n is set iff record number in_window_top - n has been seen.
3156 *
3157 * Usually, in_window_top is the last record number seen and the lsb of
3158 * in_window is set. The only exception is the initial state (record number 0
3159 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003162void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003163{
3164 ssl->in_window_top = 0;
3165 ssl->in_window = 0;
3166}
3167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003169{
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 return ((uint64_t) buf[0] << 40) |
3171 ((uint64_t) buf[1] << 32) |
3172 ((uint64_t) buf[2] << 24) |
3173 ((uint64_t) buf[3] << 16) |
3174 ((uint64_t) buf[4] << 8) |
3175 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003176}
3177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003179static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003180{
Janos Follath865b3eb2019-12-16 11:46:15 +00003181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003182 unsigned char *original_in_ctr;
3183
3184 // save original in_ctr
3185 original_in_ctr = ssl->in_ctr;
3186
3187 // use counter from record
3188 ssl->in_ctr = record_in_ctr;
3189
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003191
3192 // restore the counter
3193 ssl->in_ctr = original_in_ctr;
3194
3195 return ret;
3196}
3197
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003198/*
3199 * Return 0 if sequence number is acceptable, -1 otherwise
3200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003201int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003202{
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003204 uint64_t bit;
3205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3207 return 0;
3208 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (rec_seqnum > ssl->in_window_top) {
3211 return 0;
3212 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003213
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003214 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (bit >= 64) {
3217 return -1;
3218 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3221 return -1;
3222 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003225}
3226
3227/*
3228 * Update replay window on new validated record
3229 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003230void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003231{
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003235 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003239 /* Update window_top and the contents of the window */
3240 uint64_t shift = rec_seqnum - ssl->in_window_top;
3241
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003243 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003245 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003246 ssl->in_window |= 1;
3247 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003248
3249 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003251 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003252 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003255 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003257 }
3258}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003261#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003262/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003263 * Check if a datagram looks like a ClientHello with a valid cookie,
3264 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003265 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003266 *
3267 * - if cookie is valid, return 0
3268 * - if ClientHello looks superficially valid but cookie is not,
3269 * fill obuf and set olen, then
3270 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3271 * - otherwise return a specific error code
3272 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003273MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003274MBEDTLS_STATIC_TESTABLE
3275int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 mbedtls_ssl_context *ssl,
3277 const unsigned char *cli_id, size_t cli_id_len,
3278 const unsigned char *in, size_t in_len,
3279 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003280{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003281 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003282 unsigned char *p;
3283
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003284 /*
3285 * Structure of ClientHello with record and handshake headers,
3286 * and expected values. We don't need to check a lot, more checks will be
3287 * done when actually parsing the ClientHello - skipping those checks
3288 * avoids code duplication and does not make cookie forging any easier.
3289 *
3290 * 0-0 ContentType type; copied, must be handshake
3291 * 1-2 ProtocolVersion version; copied
3292 * 3-4 uint16 epoch; copied, must be 0
3293 * 5-10 uint48 sequence_number; copied
3294 * 11-12 uint16 length; (ignored)
3295 *
3296 * 13-13 HandshakeType msg_type; (ignored)
3297 * 14-16 uint24 length; (ignored)
3298 * 17-18 uint16 message_seq; copied
3299 * 19-21 uint24 fragment_offset; copied, must be 0
3300 * 22-24 uint24 fragment_length; (ignored)
3301 *
3302 * 25-26 ProtocolVersion client_version; (ignored)
3303 * 27-58 Random random; (ignored)
3304 * 59-xx SessionID session_id; 1 byte len + sid_len content
3305 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3306 * ...
3307 *
3308 * Minimum length is 61 bytes.
3309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3311 (unsigned) in_len));
3312 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3313 if (in_len < 61) {
3314 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3315 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003316 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3319 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3322 fragment_offset != 0) {
3323 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3324 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3325 in[0], (unsigned) epoch,
3326 (unsigned) fragment_offset));
3327 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003328 }
3329
3330 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (59 + 1 + sid_len + 1 > in_len) {
3332 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3333 (unsigned) sid_len,
3334 (unsigned) in_len - 61));
3335 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003336 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3338 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003339
3340 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3342 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3343 (unsigned) cookie_len,
3344 (unsigned) (in_len - sid_len - 61)));
3345 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003346 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003347
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3349 in + sid_len + 61, cookie_len);
3350 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3351 in + sid_len + 61, cookie_len,
3352 cli_id, cli_id_len) == 0) {
3353 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3354 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003355 }
3356
3357 /*
3358 * If we get here, we've got an invalid cookie, let's prepare HVR.
3359 *
3360 * 0-0 ContentType type; copied
3361 * 1-2 ProtocolVersion version; copied
3362 * 3-4 uint16 epoch; copied
3363 * 5-10 uint48 sequence_number; copied
3364 * 11-12 uint16 length; olen - 13
3365 *
3366 * 13-13 HandshakeType msg_type; hello_verify_request
3367 * 14-16 uint24 length; olen - 25
3368 * 17-18 uint16 message_seq; copied
3369 * 19-21 uint24 fragment_offset; copied
3370 * 22-24 uint24 fragment_length; olen - 25
3371 *
3372 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3373 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3374 *
3375 * Minimum length is 28.
3376 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 if (buf_len < 28) {
3378 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3379 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003380
3381 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003383 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3384 obuf[25] = 0xfe;
3385 obuf[26] = 0xff;
3386
3387 /* Generate and write actual cookie */
3388 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3390 &p, obuf + buf_len,
3391 cli_id, cli_id_len) != 0) {
3392 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003393 }
3394
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003395 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003396
3397 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3401 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3402 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003405
Gilles Peskine449bd832023-01-11 14:50:10 +01003406 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003407}
3408
3409/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003410 * Handle possible client reconnect with the same UDP quadruplet
3411 * (RFC 6347 Section 4.2.8).
3412 *
3413 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3414 * that looks like a ClientHello.
3415 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003416 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003417 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003418 * - if the input looks like a ClientHello with a valid cookie,
3419 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003420 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003421 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003422 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003423 * This function is called (through ssl_check_client_reconnect()) when an
3424 * unexpected record is found in ssl_get_next_record(), which will discard the
3425 * record if we return 0, and bubble up the return value otherwise (this
3426 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3427 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003428 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003430static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003431{
Janos Follath865b3eb2019-12-16 11:46:15 +00003432 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003433 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003434
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 if (ssl->conf->f_cookie_write == NULL ||
3436 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003437 /* If we can't use cookies to verify reachability of the peer,
3438 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3440 "can't check reconnect validity"));
3441 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003442 }
3443
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003444 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 ssl,
3446 ssl->cli_id, ssl->cli_id_len,
3447 ssl->in_buf, ssl->in_left,
3448 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003453 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3455 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3456 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003457 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003458 * If the error is permanent we'll catch it later,
3459 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3461 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003462 (void) send_ret;
3463
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003465 }
3466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (ret == 0) {
3468 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3469 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3470 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3471 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003472 }
3473
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003475 }
3476
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003478}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003479#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003480
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003482static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003483{
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003485 record_type != MBEDTLS_SSL_MSG_ALERT &&
3486 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3488 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003489 }
3490
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003492}
3493
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003494/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003495 * ContentType type;
3496 * ProtocolVersion version;
3497 * uint16 epoch; // DTLS only
3498 * uint48 sequence_number; // DTLS only
3499 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003500 *
3501 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003502 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003503 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3504 *
3505 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003506 * 1. proceed with the record if this function returns 0
3507 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3508 * 3. return CLIENT_RECONNECT if this function return that value
3509 * 4. drop the whole datagram if this function returns anything else.
3510 * Point 2 is needed when the peer is resending, and we have already received
3511 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003512 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003514static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3515 unsigned char *buf,
3516 size_t len,
3517 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003518{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003519 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003520
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 size_t const rec_hdr_type_offset = 0;
3522 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003523
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3525 rec_hdr_type_len;
3526 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003527
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528 size_t const rec_hdr_ctr_len = 8;
3529#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003530 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003531 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3532 rec_hdr_version_len;
3533
Hanno Beckera0e20d02019-05-15 14:03:01 +01003534#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003535 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3536 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003537 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003538#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3539#endif /* MBEDTLS_SSL_PROTO_DTLS */
3540
3541 size_t rec_hdr_len_offset; /* To be determined */
3542 size_t const rec_hdr_len_len = 2;
3543
3544 /*
3545 * Check minimum lengths for record header.
3546 */
3547
3548#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003549 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003550 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003551 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003552#endif /* MBEDTLS_SSL_PROTO_DTLS */
3553 {
3554 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3555 }
3556
Gilles Peskine449bd832023-01-11 14:50:10 +01003557 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3558 MBEDTLS_SSL_DEBUG_MSG(1,
3559 (
3560 "datagram of length %u too small to hold DTLS record header of length %u",
3561 (unsigned) len,
3562 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3563 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 }
3565
3566 /*
3567 * Parse and validate record content type
3568 */
3569
Gilles Peskine449bd832023-01-11 14:50:10 +01003570 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571
3572 /* Check record content type */
3573#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3574 rec->cid_len = 0;
3575
Gilles Peskine449bd832023-01-11 14:50:10 +01003576 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003577 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003578 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003579 /* Shift pointers to account for record header including CID
3580 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003581 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003582 * ProtocolVersion version;
3583 * uint16 epoch;
3584 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003585 * opaque cid[cid_length]; // Additional field compared to
3586 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003587 * uint16 length;
3588 * opaque enc_content[DTLSCiphertext.length];
3589 * } DTLSCiphertext;
3590 */
3591
3592 /* So far, we only support static CID lengths
3593 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594 rec_hdr_cid_len = ssl->conf->cid_len;
3595 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003596
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3598 MBEDTLS_SSL_DEBUG_MSG(1,
3599 (
3600 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3601 (unsigned) len,
3602 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3603 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003604 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003605
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003606 /* configured CID len is guaranteed at most 255, see
3607 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3608 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003609 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3610 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003611#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003612 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003613 if (ssl_check_record_type(rec->type)) {
3614 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3615 (unsigned) rec->type));
3616 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003617 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003618 }
3619
Hanno Beckere5e7e782019-07-11 12:29:35 +01003620 /*
3621 * Parse and validate record version
3622 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003623 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3624 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003625 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3626 buf + rec_hdr_version_offset,
3627 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003628
Gilles Peskine449bd832023-01-11 14:50:10 +01003629 if (tls_version > ssl->conf->max_tls_version) {
3630 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3631 (unsigned) tls_version,
3632 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003633
Gilles Peskine449bd832023-01-11 14:50:10 +01003634 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003635 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003636 /*
3637 * Parse/Copy record sequence number.
3638 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003639
Hanno Beckere5e7e782019-07-11 12:29:35 +01003640#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003642 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3644 rec_hdr_ctr_len);
3645 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003646#endif /* MBEDTLS_SSL_PROTO_DTLS */
3647 {
3648 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003650 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003651
Hanno Beckere5e7e782019-07-11 12:29:35 +01003652 /*
3653 * Parse record length.
3654 */
3655
Hanno Beckere5e7e782019-07-11 12:29:35 +01003656 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003657 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003659
Gilles Peskine449bd832023-01-11 14:50:10 +01003660 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3661 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3662 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003663
3664 rec->buf = buf;
3665 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003666
Gilles Peskine449bd832023-01-11 14:50:10 +01003667 if (rec->data_len == 0) {
3668 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3669 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003670
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003671 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003672 * DTLS-related tests.
3673 * Check epoch before checking length constraint because
3674 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3675 * message gets duplicated before the corresponding Finished message,
3676 * the second ChangeCipherSpec should be discarded because it belongs
3677 * to an old epoch, but not because its length is shorter than
3678 * the minimum record length for packets using the new record transform.
3679 * Note that these two kinds of failures are handled differently,
3680 * as an unexpected record is silently skipped but an invalid
3681 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003682 */
3683#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003685 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003686
Hanno Becker955a5c92019-07-10 17:12:07 +01003687 /* Check that the datagram is large enough to contain a record
3688 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 if (len < rec->data_offset + rec->data_len) {
3690 MBEDTLS_SSL_DEBUG_MSG(1,
3691 (
3692 "Datagram of length %u too small to contain record of advertised length %u.",
3693 (unsigned) len,
3694 (unsigned) (rec->data_offset + rec->data_len)));
3695 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003696 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003697
Hanno Becker37cfe732019-07-10 17:20:01 +01003698 /* Records from other, non-matching epochs are silently discarded.
3699 * (The case of same-port Client reconnects must be considered in
3700 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 if (rec_epoch != ssl->in_epoch) {
3702 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3703 "expected %u, received %lu",
3704 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003705
Hanno Becker552f7472019-07-19 10:59:12 +01003706 /* Records from the next epoch are considered for buffering
3707 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003708 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3709 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3710 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003712
Gilles Peskine449bd832023-01-11 14:50:10 +01003713 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003714 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003715#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003716 /* For records from the correct epoch, check whether their
3717 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003718 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3719 &rec->ctr[0]) != 0) {
3720 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3721 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003722 }
3723#endif
3724 }
3725#endif /* MBEDTLS_SSL_PROTO_DTLS */
3726
Gilles Peskine449bd832023-01-11 14:50:10 +01003727 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003728}
Paul Bakker5121ce52009-01-03 21:22:43 +00003729
Paul Bakker5121ce52009-01-03 21:22:43 +00003730
Hanno Becker2fddd372019-07-10 14:37:41 +01003731#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003733static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003734{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003735 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003736
3737 /*
3738 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3739 * access the first byte of record content (handshake type), as we
3740 * have an active transform (possibly iv_len != 0), so use the
3741 * fact that the record header len is 13 instead.
3742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003744 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003745 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003746 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3747 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3749 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3750 "from the same port"));
3751 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003752 }
3753
Gilles Peskine449bd832023-01-11 14:50:10 +01003754 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003755}
Hanno Becker2fddd372019-07-10 14:37:41 +01003756#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003757
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003758/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003759 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003760 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003761MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003762static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3763 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003764{
3765 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003766
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3768 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003769
Ronald Cron7e38cba2021-11-24 12:43:39 +01003770 /*
3771 * In TLS 1.3, always treat ChangeCipherSpec records
3772 * as unencrypted. The only thing we do with them is
3773 * check the length and content and ignore them.
3774 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003775#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 if (ssl->transform_in != NULL &&
3777 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3778 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003779 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003781 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003782#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003785 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003786
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3788 rec)) != 0) {
3789 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003790
Ronald Cron2995d352024-01-18 16:59:39 +01003791#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3792 /*
3793 * Although the server rejected early data, it might receive early
3794 * data as long as it has not received the client Finished message.
3795 * It is encrypted with early keys and should be ignored as stated
3796 * in section 4.2.10 of RFC 8446:
3797 *
3798 * "Ignore the extension and return a regular 1-RTT response. The
3799 * server then skips past early data by attempting to deprotect
3800 * received records using the handshake traffic key, discarding
3801 * records which fail deprotection (up to the configured
3802 * max_early_data_size). Once a record is deprotected successfully,
3803 * it is treated as the start of the client's second flight and the
3804 * server proceeds as with an ordinary 1-RTT handshake."
3805 */
3806 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3807 (ssl->discard_early_data_record ==
3808 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3809 MBEDTLS_SSL_DEBUG_MSG(
3810 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003811
3812 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3813 if (ret != 0) {
3814 return ret;
3815 }
Ronald Cron2995d352024-01-18 16:59:39 +01003816 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3817 }
3818#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3819
Hanno Beckera0e20d02019-05-15 14:03:01 +01003820#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003821 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003822 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3824 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003825 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003826 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003827#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003828
Ronald Cron71c6e652024-02-05 16:48:10 +01003829 /*
3830 * The decryption of the record failed, no reason to ignore it,
3831 * return in error with the decryption error code.
3832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003834 }
3835
Ronald Cron2995d352024-01-18 16:59:39 +01003836#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3837 /*
3838 * If the server were discarding protected records that it fails to
3839 * deprotect because it has rejected early data, as we have just
3840 * deprotected successfully a record, the server has to resume normal
3841 * operation and fail the connection if the deprotection of a record
3842 * fails.
3843 */
3844 if (ssl->discard_early_data_record ==
3845 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3846 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3847 }
3848#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3849
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 if (old_msg_type != rec->type) {
3851 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3852 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003853 }
3854
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3856 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003857
Hanno Beckera0e20d02019-05-15 14:03:01 +01003858#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003859 /* We have already checked the record content type
3860 * in ssl_parse_record_header(), failing or silently
3861 * dropping the record in the case of an unknown type.
3862 *
3863 * Since with the use of CIDs, the record content type
3864 * might change during decryption, re-check the record
3865 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 if (ssl_check_record_type(rec->type)) {
3867 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3868 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003869 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003870#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003871
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003874 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3875 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003876 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3878 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003879 }
3880#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3881
3882 ssl->nb_zero++;
3883
3884 /*
3885 * Three or more empty messages may be a DoS attack
3886 * (excessive CPU consumption).
3887 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (ssl->nb_zero > 3) {
3889 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3890 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003891 /* Treat the records as if they were not properly authenticated,
3892 * thereby failing the connection if we see more than allowed
3893 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003895 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003896 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003897 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003898 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003899
3900#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003902 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003904#endif
3905 {
3906 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3908 i > mbedtls_ssl_ep_len(ssl); i--) {
3909 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003910 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003912 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003913
3914 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 if (i == mbedtls_ssl_ep_len(ssl)) {
3916 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3917 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003918 }
3919 }
3920
Paul Bakker5121ce52009-01-03 21:22:43 +00003921 }
3922
Jerry Yuf57d14b2023-11-15 16:40:09 +08003923#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3924 /*
3925 * Although the server rejected early data because it needed to send an
3926 * HelloRetryRequest message, it might receive early data as long as it has
3927 * not received the client Finished message.
3928 * The early data is encrypted with early keys and should be ignored as
3929 * stated in section 4.2.10 of RFC 8446 (second case):
3930 *
3931 * "The server then ignores early data by skipping all records with an
3932 * external content type of "application_data" (indicating that they are
3933 * encrypted), up to the configured max_early_data_size. Ignore application
3934 * data message before 2nd ClientHello when early_data was received in 1st
3935 * ClientHello."
3936 */
3937 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3938 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003939
3940 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3941 if (ret != 0) {
3942 return ret;
3943 }
3944
Jerry Yuf57d14b2023-11-15 16:40:09 +08003945 MBEDTLS_SSL_DEBUG_MSG(
3946 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003947
Jerry Yuf57d14b2023-11-15 16:40:09 +08003948 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3949 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3950 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3951 }
3952 }
3953#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003955#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3957 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003958 }
3959#endif
3960
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003961 /* Check actual (decrypted) record content length against
3962 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
3964 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
3965 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003966 }
3967
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003969}
3970
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003971/*
3972 * Read a record.
3973 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003974 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3975 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3976 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003977 */
Hanno Becker1097b342018-08-15 14:09:41 +01003978
3979/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003980MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003981static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003983static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003985static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01003986
Gilles Peskine449bd832023-01-11 14:50:10 +01003987int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
3988 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003989{
Janos Follath865b3eb2019-12-16 11:46:15 +00003990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003995 do {
Simon Butcher99000142016-10-13 17:21:01 +01003996
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 ret = ssl_consume_current_message(ssl);
3998 if (ret != 0) {
3999 return ret;
4000 }
Hanno Becker26994592018-08-15 14:14:59 +01004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004003 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004004#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004005
Hanno Becker40f50842018-08-15 14:48:01 +01004006 /* We only check for buffered messages if the
4007 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4009 ssl_next_record_is_in_datagram(ssl) == 0) {
4010 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004011 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 }
Hanno Becker40f50842018-08-15 14:48:01 +01004013 }
4014
Hanno Becker40f50842018-08-15 14:48:01 +01004015#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if (dtls_have_buffered == 0) {
4017 ret = ssl_get_next_record(ssl);
4018 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004019 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 }
Hanno Becker40f50842018-08-15 14:48:01 +01004021
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if (ret != 0) {
4023 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4024 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004025 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004026 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004027 }
4028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004030
Hanno Becker40f50842018-08-15 14:48:01 +01004031#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004033 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 ret = ssl_buffer_message(ssl);
4035 if (ret != 0) {
4036 return ret;
4037 }
Hanno Becker40f50842018-08-15 14:48:01 +01004038
4039 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4040 }
4041#endif /* MBEDTLS_SSL_PROTO_DTLS */
4042
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4044 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 if (0 != ret) {
4047 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4048 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004049 }
4050
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4052 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004053 ret = mbedtls_ssl_update_handshake_status(ssl);
4054 if (0 != ret) {
4055 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4056 return ret;
4057 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004058 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 } else {
4060 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004061 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004062 }
4063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004067}
4068
Hanno Becker40f50842018-08-15 14:48:01 +01004069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004070MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004071static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004072{
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 if (ssl->in_left > ssl->next_record_offset) {
4074 return 1;
4075 }
Simon Butcher99000142016-10-13 17:21:01 +01004076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004078}
4079
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004080MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004081static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004082{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004083 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004085 int ret = 0;
4086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (hs == NULL) {
4088 return -1;
4089 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4094 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004095 /* Check if we have seen a ChangeCipherSpec before.
4096 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (!hs->buffering.seen_ccs) {
4098 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004099 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004100 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004101 }
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004104 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4105 ssl->in_msglen = 1;
4106 ssl->in_msg[0] = 1;
4107
4108 /* As long as they are equal, the exact value doesn't matter. */
4109 ssl->in_left = 0;
4110 ssl->next_record_offset = 0;
4111
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004112 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004113 goto exit;
4114 }
Hanno Becker37f95322018-08-16 13:55:32 +01004115
Hanno Beckerb8f50142018-08-28 10:01:34 +01004116#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004117 /* Debug only */
4118 {
4119 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004121 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (hs_buf->is_valid == 1) {
4123 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4124 hs->in_msg_seq + offset,
4125 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004126 }
4127 }
4128 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004129#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004130
4131 /* Check if we have buffered and/or fully reassembled the
4132 * next handshake message. */
4133 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004135 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004136 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004137
4138 /* Double-check that we haven't accidentally buffered
4139 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4141 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4142 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004143 }
4144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4146 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4147 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004148
4149 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4150 ssl->in_hslen = msg_len + 12;
4151 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004153
4154 ret = 0;
4155 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 } else {
4157 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4158 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004159 }
4160
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004161 ret = -1;
4162
4163exit:
4164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4166 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004167}
4168
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004169MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004170static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4171 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004172{
4173 int offset;
4174 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4176 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004177
Hanno Becker01315ea2018-08-21 17:22:17 +01004178 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004180
4181 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4183 hs->buffering.total_bytes_buffered)) {
4184 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4185 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004186 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004187
Hanno Becker4f432ad2018-08-28 10:02:32 +01004188 /* We don't have enough space to buffer the next expected handshake
4189 * message. Remove buffers used for future messages to gain space,
4190 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4192 offset >= 0; offset--) {
4193 MBEDTLS_SSL_DEBUG_MSG(2,
4194 (
4195 "Free buffering slot %d to make space for reassembly of next handshake message",
4196 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004199
4200 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4202 hs->buffering.total_bytes_buffered)) {
4203 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4204 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004205 }
4206 }
4207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +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_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004213{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004214 int ret = 0;
4215 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (hs == NULL) {
4218 return 0;
4219 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004226
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004227 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004228 break;
4229
4230 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004231 {
4232 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004233 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004234 mbedtls_ssl_hs_buffer *hs_buf;
4235 size_t msg_len = ssl->in_hslen - 12;
4236
4237 /* We should never receive an old handshake
4238 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4240 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4241 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004242 }
4243
4244 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004246 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 MBEDTLS_SSL_DEBUG_MSG(2,
4248 ("Ignore future HS message with sequence number %u, "
4249 "buffering window %u - %u",
4250 recv_msg_seq, ssl->handshake->in_msg_seq,
4251 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4252 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004253
4254 goto exit;
4255 }
4256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4258 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004261
4262 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004264 size_t reassembly_buf_sz;
4265
Hanno Becker37f95322018-08-16 13:55:32 +01004266 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004268
4269 /* We copy the message back into the input buffer
4270 * after reassembly, so check that it's not too large.
4271 * This is an implementation-specific limitation
4272 * and not one from the standard, hence it is not
4273 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004275 /* Ignore message */
4276 goto exit;
4277 }
4278
Hanno Beckere0b150f2018-08-21 15:51:03 +01004279 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 if (hs->buffering.total_bytes_buffered >
4281 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4282 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4283 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004284 }
4285
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4287 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4290 hs->buffering.total_bytes_buffered)) {
4291 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004292 /* If we can't buffer a future message because
4293 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 MBEDTLS_SSL_DEBUG_MSG(2,
4295 ("Buffering of future message of size %"
4296 MBEDTLS_PRINTF_SIZET
4297 " would exceed the compile-time limit %"
4298 MBEDTLS_PRINTF_SIZET
4299 " (already %" MBEDTLS_PRINTF_SIZET
4300 " bytes buffered) -- ignore\n",
4301 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4302 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004303 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 } else {
4305 MBEDTLS_SSL_DEBUG_MSG(2,
4306 ("Buffering of future message of size %"
4307 MBEDTLS_PRINTF_SIZET
4308 " would exceed the compile-time limit %"
4309 MBEDTLS_PRINTF_SIZET
4310 " (already %" MBEDTLS_PRINTF_SIZET
4311 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4312 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4313 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004314 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4317 MBEDTLS_SSL_DEBUG_MSG(2,
4318 ("Reassembly of next message of size %"
4319 MBEDTLS_PRINTF_SIZET
4320 " (%" MBEDTLS_PRINTF_SIZET
4321 " with bitmap) would exceed"
4322 " the compile-time limit %"
4323 MBEDTLS_PRINTF_SIZET
4324 " (already %" MBEDTLS_PRINTF_SIZET
4325 " bytes buffered) -- fail\n",
4326 msg_len,
4327 reassembly_buf_sz,
4328 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4329 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004330 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4331 goto exit;
4332 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004333 }
4334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 MBEDTLS_SSL_DEBUG_MSG(2,
4336 ("initialize reassembly, total length = %"
4337 MBEDTLS_PRINTF_SIZET,
4338 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4341 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004342 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004343 goto exit;
4344 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004345 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004346
4347 /* Prepare final header: copy msg_type, length and message_seq,
4348 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 memcpy(hs_buf->data, ssl->in_msg, 6);
4350 memset(hs_buf->data + 6, 0, 3);
4351 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004352
4353 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004354
4355 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004357 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4359 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004360 /* Ignore */
4361 goto exit;
4362 }
4363 }
4364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004366 size_t frag_len, frag_off;
4367 unsigned char * const msg = hs_buf->data + 12;
4368
4369 /*
4370 * Check and copy current fragment
4371 */
4372
4373 /* Validation of header fields already done in
4374 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 frag_off = ssl_get_hs_frag_off(ssl);
4376 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4379 ", length = %" MBEDTLS_PRINTF_SIZET,
4380 frag_off, frag_len));
4381 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004384 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 ssl_bitmask_set(bitmask, frag_off, frag_len);
4386 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4387 msg_len) == 0);
4388 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004389 hs_buf->is_complete = 1;
4390 }
4391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4393 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004394 }
4395
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004396 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004397 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004398
4399 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004400 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004401 break;
4402 }
4403
4404exit:
4405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4407 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004408}
4409#endif /* MBEDTLS_SSL_PROTO_DTLS */
4410
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004412static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004413{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004414 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004415 * Consume last content-layer message and potentially
4416 * update in_msglen which keeps track of the contents'
4417 * consumption state.
4418 *
4419 * (1) Handshake messages:
4420 * Remove last handshake message, move content
4421 * and adapt in_msglen.
4422 *
4423 * (2) Alert messages:
4424 * Consume whole record content, in_msglen = 0.
4425 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004426 * (3) Change cipher spec:
4427 * Consume whole record content, in_msglen = 0.
4428 *
4429 * (4) Application data:
4430 * Don't do anything - the record layer provides
4431 * the application data as a stream transport
4432 * and consumes through mbedtls_ssl_read only.
4433 *
4434 */
4435
4436 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004438 /* Hard assertion to be sure that no application data
4439 * is in flight, as corrupting ssl->in_msglen during
4440 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ssl->in_offt != NULL) {
4442 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4443 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004444 }
4445
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004446 if (ssl->in_hsfraglen != 0) {
4447 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004448 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4449 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4450 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004451 return 0;
4452 }
4453
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004454 /*
4455 * Get next Handshake message in the current record
4456 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004457
Hanno Becker4a810fb2017-05-24 16:27:30 +01004458 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004459 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004460 * current handshake content: If DTLS handshake
4461 * fragmentation is used, that's the fragment
4462 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004463 * size here is faulty and should be changed at
4464 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004465 * (2) While it doesn't seem to cause problems, one
4466 * has to be very careful not to assume that in_hslen
4467 * is always <= in_msglen in a sensible communication.
4468 * Again, it's wrong for DTLS handshake fragmentation.
4469 * The following check is therefore mandatory, and
4470 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004471 * Additionally, ssl->in_hslen might be arbitrarily out of
4472 * bounds after handling a DTLS message with an unexpected
4473 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004476 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4478 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004479 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4482 ssl->in_msg, ssl->in_msglen);
4483 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004484 ssl->in_msglen = 0;
4485 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004486
Hanno Becker4a810fb2017-05-24 16:27:30 +01004487 ssl->in_hslen = 0;
4488 }
4489 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 else if (ssl->in_offt != NULL) {
4491 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004492 }
4493 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004495 ssl->in_msglen = 0;
4496 }
4497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004499}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004501MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004502static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004503{
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (ssl->in_msglen > 0) {
4505 return 1;
4506 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004509}
4510
Hanno Becker5f066e72018-08-16 14:56:31 +01004511#if defined(MBEDTLS_SSL_PROTO_DTLS)
4512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004514{
4515 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004517 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004519
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004521 hs->buffering.total_bytes_buffered -=
4522 hs->buffering.future_record.len;
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004525 hs->buffering.future_record.data = NULL;
4526 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004527}
4528
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004529MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004530static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004531{
4532 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004534 size_t rec_len;
4535 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004536#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4537 size_t in_buf_len = ssl->in_buf_len;
4538#else
4539 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4540#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4542 return 0;
4543 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (hs == NULL) {
4546 return 0;
4547 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004548
Hanno Becker5f066e72018-08-16 14:56:31 +01004549 rec = hs->buffering.future_record.data;
4550 rec_len = hs->buffering.future_record.len;
4551 rec_epoch = hs->buffering.future_record.epoch;
4552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 if (rec == NULL) {
4554 return 0;
4555 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004556
Hanno Becker4cb782d2018-08-20 11:19:05 +01004557 /* Only consider loading future records if the
4558 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4560 return 0;
4561 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004562
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (rec_epoch != ssl->in_epoch) {
4566 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004567 goto exit;
4568 }
4569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004571
4572 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4574 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4575 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004576 }
4577
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004579 ssl->in_left = rec_len;
4580 ssl->next_record_offset = 0;
4581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004583
4584exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4586 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004587}
4588
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004589MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004590static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4591 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004592{
4593 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004594
4595 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (hs == NULL) {
4597 return 0;
4598 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004599
4600 /* Only buffer handshake records (we are only interested
4601 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4603 return 0;
4604 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004605
4606 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (hs->buffering.future_record.data != NULL) {
4608 return 0;
4609 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004610
Hanno Becker01315ea2018-08-21 17:22:17 +01004611 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4613 hs->buffering.total_bytes_buffered)) {
4614 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4615 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4616 " (already %" MBEDTLS_PRINTF_SIZET
4617 " bytes buffered) -- ignore\n",
4618 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4619 hs->buffering.total_bytes_buffered));
4620 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004621 }
4622
Hanno Becker5f066e72018-08-16 14:56:31 +01004623 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4625 ssl->in_epoch + 1U));
4626 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004627
4628 /* ssl_parse_record_header() only considers records
4629 * of the next epoch as candidates for buffering. */
4630 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004631 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004632
4633 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 mbedtls_calloc(1, hs->buffering.future_record.len);
4635 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004636 /* If we run out of RAM trying to buffer a
4637 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004639 }
4640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004642
Hanno Becker519f15d2019-07-11 12:43:20 +01004643 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004645}
4646
4647#endif /* MBEDTLS_SSL_PROTO_DTLS */
4648
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004649MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004650static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004651{
Janos Follath865b3eb2019-12-16 11:46:15 +00004652 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004653 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004654
Hanno Becker5f066e72018-08-16 14:56:31 +01004655#if defined(MBEDTLS_SSL_PROTO_DTLS)
4656 /* We might have buffered a future record; if so,
4657 * and if the epoch matches now, load it.
4658 * On success, this call will set ssl->in_left to
4659 * the length of the buffered record, so that
4660 * the calls to ssl_fetch_input() below will
4661 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 ret = ssl_load_buffered_record(ssl);
4663 if (ret != 0) {
4664 return ret;
4665 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004666#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004667
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004668 /* Ensure that we have enough space available for the default form
4669 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4670 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4672 if (ret != 0) {
4673 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4674 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004675 }
4676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4678 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4681 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4682 ret = ssl_buffer_future_record(ssl, &rec);
4683 if (ret != 0) {
4684 return ret;
4685 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004686
4687 /* Fall through to handling of unexpected records */
4688 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4689 }
4690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004692#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004693 /* Reset in pointers to default state for TLS/DTLS records,
4694 * assuming no CID and no offset between record content and
4695 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004697
Hanno Becker7ae20e02019-07-12 08:33:49 +01004698 /* Setup internal message pointers from record structure. */
4699 ssl->in_msgtype = rec.type;
4700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4701 ssl->in_len = ssl->in_cid + rec.cid_len;
4702#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4703 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4704 ssl->in_msglen = rec.data_len;
4705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 ret = ssl_check_client_reconnect(ssl);
4707 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4708 if (ret != 0) {
4709 return ret;
4710 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004711#endif
4712
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004713 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004714 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4717 "(header)"));
4718 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004719 /* Skip invalid record and the rest of the datagram */
4720 ssl->next_record_offset = 0;
4721 ssl->in_left = 0;
4722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4724 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004725 }
4726
4727 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4729 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004730#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004731 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004733 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004734 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004738 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004739 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (ssl->next_record_offset < ssl->in_left) {
4741 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004742 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004744#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004745 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004746 /*
4747 * Fetch record contents from underlying transport.
4748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4750 if (ret != 0) {
4751 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4752 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004753 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004754
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004755 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004756 }
4757
4758 /*
4759 * Decrypt record contents.
4760 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004765 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004767 /* Except when waiting for Finished as a bad mac here
4768 * probably means something went wrong in the handshake
4769 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4771 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004772#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4774 mbedtls_ssl_send_alert_message(ssl,
4775 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4776 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004777 }
4778#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004780 }
4781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (ssl->conf->badmac_limit != 0 &&
4783 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4784 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4785 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004786 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004787
Hanno Becker4a810fb2017-05-24 16:27:30 +01004788 /* As above, invalid records cause
4789 * dismissal of the whole datagram. */
4790
4791 ssl->next_record_offset = 0;
4792 ssl->in_left = 0;
4793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4795 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004796 }
4797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 return ret;
4799 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004800#endif
4801 {
4802 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4805 mbedtls_ssl_send_alert_message(ssl,
4806 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4807 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004808 }
4809#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004811 }
4812 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004813
Hanno Becker44d89b22019-07-12 09:40:44 +01004814
4815 /* Reset in pointers to default state for TLS/DTLS records,
4816 * assuming no CID and no offset between record content and
4817 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004819#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4820 ssl->in_len = ssl->in_cid + rec.cid_len;
4821#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004822 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004823
Hanno Becker8685c822019-07-12 09:37:30 +01004824 /* The record content type may change during decryption,
4825 * so re-read it. */
4826 ssl->in_msgtype = rec.type;
4827 /* Also update the input buffer, because unfortunately
4828 * the server-side ssl_parse_client_hello() reparses the
4829 * record header when receiving a ClientHello initiating
4830 * a renegotiation. */
4831 ssl->in_hdr[0] = rec.type;
4832 ssl->in_msg = rec.buf + rec.data_offset;
4833 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004835
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004837}
4838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004840{
Janos Follath865b3eb2019-12-16 11:46:15 +00004841 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004842
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004843 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004844 * Handle particular types of records
4845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4847 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4848 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004849 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004850 }
4851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4853 if (ssl->in_msglen != 1) {
4854 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4855 ssl->in_msglen));
4856 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004857 }
4858
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (ssl->in_msg[0] != 1) {
4860 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4861 ssl->in_msg[0]));
4862 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004863 }
4864
4865#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004867 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4869 if (ssl->handshake == NULL) {
4870 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4871 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004872 }
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4875 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004876 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004877#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004878
Ronald Cron6f135e12021-12-08 16:57:54 +01004879#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004881 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4883 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004884 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004885#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004886 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4889 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004890 /* Note: Standard allows for more than one 2 byte alert
4891 to be packed in a single message, but Mbed TLS doesn't
4892 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4894 ssl->in_msglen));
4895 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004896 }
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4899 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004900
4901 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004902 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4905 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4906 ssl->in_msg[1]));
4907 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004908 }
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4911 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4912 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4913 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004914 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004915
4916#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4918 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4919 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004920 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004922 }
4923#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004924 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004925 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004926 }
4927
Hanno Beckerc76c6192017-06-06 10:03:17 +01004928#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004930 /* Drop unexpected ApplicationData records,
4931 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4933 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004934#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4936 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004937#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 ) {
4939 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4940 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004941 }
4942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (ssl->handshake != NULL &&
4944 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4945 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004946 }
4947 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004948#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004951}
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004954{
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 return mbedtls_ssl_send_alert_message(ssl,
4956 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4957 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004958}
4959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4961 unsigned char level,
4962 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00004963{
Janos Follath865b3eb2019-12-16 11:46:15 +00004964 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (ssl == NULL || ssl->conf == NULL) {
4967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4968 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (ssl->out_left != 0) {
4971 return mbedtls_ssl_flush_output(ssl);
4972 }
Hanno Becker5e18f742018-08-06 11:35:16 +01004973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
4975 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00004976
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004977 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004978 ssl->out_msglen = 2;
4979 ssl->out_msg[0] = level;
4980 ssl->out_msg[1] = message;
4981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
4983 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
4984 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00004985 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00004989}
4990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004992{
Janos Follath865b3eb2019-12-16 11:46:15 +00004993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004998 ssl->out_msglen = 1;
4999 ssl->out_msg[0] = 1;
5000
Paul Bakker5121ce52009-01-03 21:22:43 +00005001 ssl->state++;
5002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5004 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5005 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005006 }
5007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005011}
5012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005014{
Janos Follath865b3eb2019-12-16 11:46:15 +00005015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5020 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5021 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005022 }
5023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5025 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5026 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5027 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5028 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005029 }
5030
Hanno Beckere678eaa2018-08-21 14:57:46 +01005031 /* CCS records are only accepted if they have length 1 and content '1',
5032 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005033
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005034 /*
5035 * Switch to our negotiated transform and session parameters for inbound
5036 * data.
5037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005040 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005041#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005042 ssl->session_in = ssl->session_negotiate;
5043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005048#endif
5049
5050 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (++ssl->in_epoch == 0) {
5052 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005053 /* This is highly unlikely to happen for legitimate reasons, so
5054 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005058#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005062
Paul Bakker5121ce52009-01-03 21:22:43 +00005063 ssl->state++;
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005068}
5069
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005070/* Once ssl->out_hdr as the address of the beginning of the
5071 * next outgoing record is set, deduce the other pointers.
5072 *
5073 * Note: For TLS, we save the implicit record sequence number
5074 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5075 * and the caller has to make sure there's space for this.
5076 */
5077
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005078static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005080{
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005082}
5083
Gilles Peskine449bd832023-01-11 14:50:10 +01005084void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5085 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005086{
5087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005089 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005090#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005091 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005092 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005094 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005096#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005097 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005098#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005099 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005101#endif
5102 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005103 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005104#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005105 ssl->out_cid = ssl->out_len;
5106#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005107 ssl->out_iv = ssl->out_hdr + 5;
5108 }
5109
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005110 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005111 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if (transform != NULL) {
5113 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5114 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005115}
5116
5117/* Once ssl->in_hdr as the address of the beginning of the
5118 * next incoming record is set, deduce the other pointers.
5119 *
5120 * Note: For TLS, we save the implicit record sequence number
5121 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5122 * and the caller has to make sure there's space for this.
5123 */
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005126{
Hanno Becker79594fd2019-05-08 09:38:41 +01005127 /* This function sets the pointers to match the case
5128 * of unprotected TLS/DTLS records, with both ssl->in_iv
5129 * and ssl->in_msg pointing to the beginning of the record
5130 * content.
5131 *
5132 * When decrypting a protected record, ssl->in_msg
5133 * will be shifted to point to the beginning of the
5134 * record plaintext.
5135 */
5136
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005137#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005139 /* This sets the header pointers to match records
5140 * without CID. When we receive a record containing
5141 * a CID, the fields are shifted accordingly in
5142 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005143 ssl->in_ctr = ssl->in_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->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005146 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005147#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005148 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005149#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005150 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005152#endif
5153 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005154 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005155 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005156#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005157 ssl->in_cid = ssl->in_len;
5158#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005159 ssl->in_iv = ssl->in_hdr + 5;
5160 }
5161
Hanno Becker79594fd2019-05-08 09:38:41 +01005162 /* This will be adjusted at record decryption time. */
5163 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005164}
5165
Paul Bakker5121ce52009-01-03 21:22:43 +00005166/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005167 * Setup an SSL context
5168 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005169
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005170void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5171{
5172#if defined(MBEDTLS_SSL_PROTO_DTLS)
5173 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5174 ssl->in_hdr = ssl->in_buf;
5175 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005176#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005177 {
5178 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5179 }
5180
5181 /* Derive other internal pointers. */
5182 mbedtls_ssl_update_in_pointers(ssl);
5183}
5184
5185void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005186{
5187 /* Set the incoming and outgoing record pointers. */
5188#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005190 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005192#endif /* MBEDTLS_SSL_PROTO_DTLS */
5193 {
Hanno Becker12078f42021-03-02 15:28:41 +00005194 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005195 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005196 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005197 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005199}
5200
Paul Bakker5121ce52009-01-03 21:22:43 +00005201/*
5202 * SSL get accessors
5203 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005204size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005205{
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005207}
5208
Gilles Peskine449bd832023-01-11 14:50:10 +01005209int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005210{
5211 /*
5212 * Case A: We're currently holding back
5213 * a message for further processing.
5214 */
5215
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if (ssl->keep_current_message == 1) {
5217 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5218 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005219 }
5220
5221 /*
5222 * Case B: Further records are pending in the current datagram.
5223 */
5224
5225#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5227 ssl->in_left > ssl->next_record_offset) {
5228 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5229 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005230 }
5231#endif /* MBEDTLS_SSL_PROTO_DTLS */
5232
5233 /*
5234 * Case C: A handshake message is being processed.
5235 */
5236
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5238 MBEDTLS_SSL_DEBUG_MSG(3,
5239 ("ssl_check_pending: more handshake messages within current record"));
5240 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005241 }
5242
5243 /*
5244 * Case D: An application data message is being processed
5245 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (ssl->in_offt != NULL) {
5247 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5248 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005249 }
5250
5251 /*
5252 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005253 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005254 * we implement support for multiple alerts in single records.
5255 */
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5258 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005259}
5260
Paul Bakker43ca69c2011-01-15 17:35:19 +00005261
Gilles Peskine449bd832023-01-11 14:50:10 +01005262int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005263{
Hanno Becker3136ede2018-08-17 15:28:19 +01005264 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005266 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005267 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5268 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 if (transform == NULL) {
5273 return (int) out_hdr_len;
5274 }
Hanno Becker78640902018-08-13 16:35:15 +01005275
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005276
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 if (transform->psa_alg == PSA_ALG_GCM ||
5278 transform->psa_alg == PSA_ALG_CCM ||
5279 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5280 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5281 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005282 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5284 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5285 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005288
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005289 /* Expansion due to the addition of the MAC. */
5290 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005291
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005292 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005293 * Theoretically up to 256 bytes, but we never use
5294 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005295 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005296
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005297 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005298 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005299#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005300 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005301#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 } else {
5303 MBEDTLS_SSL_DEBUG_MSG(1,
5304 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5305 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005306 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005307
Hanno Beckera0e20d02019-05-15 14:03:01 +01005308#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005310 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005312#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005315}
5316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005318/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005319 * Check record counters and renegotiate if they're above the limit.
5320 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005321MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005322static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005323{
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005325 int in_ctr_cmp;
5326 int out_ctr_cmp;
5327
Gilles Peskine449bd832023-01-11 14:50:10 +01005328 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5331 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005332 }
5333
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5335 &ssl->conf->renego_period[ep_len],
5336 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5337 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005338 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5342 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005343 }
5344
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5346 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005347}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005348#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005349
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005350#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5351
Ronald Cron7df18bc2024-03-25 13:42:07 +01005352#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005353MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005354static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005355{
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5358 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005359 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005360 }
5361
Ronald Croncf47a152024-04-02 13:19:57 +02005362 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005363}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005364#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005365
Jerry Yua0446a02022-07-13 11:22:55 +08005366MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005367static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005368{
5369
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005371
Ronald Cron7df18bc2024-03-25 13:42:07 +01005372#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005374 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005375#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5376 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5377 ssl->keep_current_message = 1;
5378
5379 mbedtls_ssl_handshake_set_state(ssl,
5380 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5381 return MBEDTLS_ERR_SSL_WANT_READ;
5382#else
5383 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5384 return 0;
5385#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005387 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005388#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005389
5390 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005392}
5393#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5394
5395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005396/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005397 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005398 * may only be sent for the purpose of initiating renegotiations.
5399 *
5400 * This function is introduced as a separate helper since the handling
5401 * of post-handshake handshake messages changes significantly in TLS 1.3,
5402 * and having a helper function allows to distinguish between TLS <= 1.2 and
5403 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5404 */
Jerry Yua0446a02022-07-13 11:22:55 +08005405MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005406static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005407{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005408 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005409
5410 /*
5411 * - For client-side, expect SERVER_HELLO_REQUEST.
5412 * - For server-side, expect CLIENT_HELLO.
5413 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5414 */
5415
5416#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5418 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5419 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5420 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005421
5422 /* With DTLS, drop the packet (probably from last handshake) */
5423#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5425 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005426 }
5427#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005429 }
5430#endif /* MBEDTLS_SSL_CLI_C */
5431
5432#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5434 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5435 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005436
5437 /* With DTLS, drop the packet (probably from last handshake) */
5438#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5440 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005441 }
5442#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005444 }
5445#endif /* MBEDTLS_SSL_SRV_C */
5446
5447#if defined(MBEDTLS_SSL_RENEGOTIATION)
5448 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5450 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5451 ssl->conf->allow_legacy_renegotiation ==
5452 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005453 /*
5454 * Accept renegotiation request
5455 */
5456
5457 /* DTLS clients need to know renego is server-initiated */
5458#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5460 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005461 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5462 }
5463#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 ret = mbedtls_ssl_start_renegotiation(ssl);
5465 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5466 ret != 0) {
5467 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5468 ret);
5469 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005470 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005472#endif /* MBEDTLS_SSL_RENEGOTIATION */
5473 {
5474 /*
5475 * Refuse renegotiation
5476 */
5477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005479
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5481 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5482 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5483 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005484 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005485 }
5486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005488}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005489#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5490
5491MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005492static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005493{
5494 /* Check protocol version and dispatch accordingly. */
5495#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5497 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005498 }
5499#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5500
5501#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5503 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005504 }
5505#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5506
5507 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005509}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005510
Paul Bakker48916f92012-09-16 19:57:18 +00005511/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005512 * brief Read at most 'len' application data bytes from the input
5513 * buffer.
5514 *
5515 * param ssl SSL context:
5516 * - First byte of application data not read yet in the input
5517 * buffer located at address `in_offt`.
5518 * - The number of bytes of data not read yet is `in_msglen`.
5519 * param buf buffer that will hold the data
5520 * param len maximum number of bytes to read
5521 *
5522 * note The function updates the fields `in_offt` and `in_msglen`
5523 * according to the number of bytes read.
5524 *
5525 * return The number of bytes read.
5526 */
5527static int ssl_read_application_data(
5528 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5529{
5530 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5531
5532 if (len != 0) {
5533 memcpy(buf, ssl->in_offt, n);
5534 ssl->in_msglen -= n;
5535 }
5536
5537 /* Zeroising the plaintext buffer to erase unused application data
5538 from the memory. */
5539 mbedtls_platform_zeroize(ssl->in_offt, n);
5540
5541 if (ssl->in_msglen == 0) {
5542 /* all bytes consumed */
5543 ssl->in_offt = NULL;
5544 ssl->keep_current_message = 0;
5545 } else {
5546 /* more data available */
5547 ssl->in_offt += n;
5548 }
5549
5550 return (int) n;
5551}
5552
5553/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005554 * Receive application data decrypted from the SSL layer
5555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005557{
Janos Follath865b3eb2019-12-16 11:46:15 +00005558 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl == NULL || ssl->conf == NULL) {
5561 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5562 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5568 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5569 return ret;
5570 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005571
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 if (ssl->handshake != NULL &&
5573 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5574 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5575 return ret;
5576 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005577 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005578 }
5579#endif
5580
Hanno Becker4a810fb2017-05-24 16:27:30 +01005581 /*
5582 * Check if renegotiation is necessary and/or handshake is
5583 * in process. If yes, perform/continue, and fall through
5584 * if an unexpected packet is received while the client
5585 * is waiting for the ServerHello.
5586 *
5587 * (There is no equivalent to the last condition on
5588 * the server-side as it is not treated as within
5589 * a handshake while waiting for the ClientHello
5590 * after a renegotiation request.)
5591 */
5592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 ret = ssl_check_ctr_renegotiate(ssl);
5595 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5596 ret != 0) {
5597 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5598 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005599 }
5600#endif
5601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5603 ret = mbedtls_ssl_handshake(ssl);
5604 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5605 ret != 0) {
5606 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5607 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005608 }
5609 }
5610
Hanno Beckere41158b2017-10-23 13:30:32 +01005611 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005613 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 if (ssl->f_get_timer != NULL &&
5615 ssl->f_get_timer(ssl->p_timer) == -1) {
5616 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005617 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5620 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5621 return 0;
5622 }
Paul Bakker831a7552011-05-18 13:32:51 +00005623
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5625 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005626 }
5627
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 if (ssl->in_msglen == 0 &&
5629 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005630 /*
5631 * OpenSSL sends empty messages to randomize the IV
5632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5634 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5635 return 0;
5636 }
Paul Bakker831a7552011-05-18 13:32:51 +00005637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5639 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005640 }
5641 }
5642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5644 ret = ssl_handle_hs_message_post_handshake(ssl);
5645 if (ret != 0) {
5646 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5647 ret);
5648 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005649 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005650
Hanno Beckerf26cc722021-04-21 07:30:13 +01005651 /* At this point, we don't know whether the renegotiation triggered
5652 * by the post-handshake message has been completed or not. The cases
5653 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005654 * 1) The renegotiation is complete. In this case, no new record
5655 * has been read yet.
5656 * 2) The renegotiation is incomplete because the client received
5657 * an application data record while awaiting the ServerHello.
5658 * 3) The renegotiation is incomplete because the client received
5659 * a non-handshake, non-application data message while awaiting
5660 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005661 *
5662 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005663 * - For 1), the next iteration will read a new record and check
5664 * if it's application data.
5665 * - For 2), the loop condition isn't satisfied as application data
5666 * is present, hence continue is the same as break
5667 * - For 3), the loop condition is satisfied and read_record
5668 * will re-deliver the message that was held back by the client
5669 * when expecting the ServerHello.
5670 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005671
Hanno Becker90333da2017-10-10 11:27:13 +01005672 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005673 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005674#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5676 if (ssl->conf->renego_max_records >= 0) {
5677 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5678 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5679 "but not honored by client"));
5680 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005681 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005682 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005683 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005684#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005686 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5688 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5689 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005690 }
5691
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5693 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5694 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005695 }
5696
5697 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005698
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005699 /* We're going to return something now, cancel timer,
5700 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5702 mbedtls_ssl_set_timer(ssl, 0);
5703 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005704
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005705#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005706 /* If we requested renego but received AppData, resend HelloRequest.
5707 * Do it now, after setting in_offt, to avoid taking this branch
5708 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5711 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5712 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5713 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5714 ret);
5715 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005716 }
5717 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005718#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005719#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005720 }
5721
Jerry Yu739a1d42022-12-08 21:10:25 +08005722 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005725
Jerry Yu739a1d42022-12-08 21:10:25 +08005726 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005727}
5728
Jerry Yud9ca3542023-12-06 17:23:52 +08005729#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5730int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5731 unsigned char *buf, size_t len)
5732{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005733 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5735 }
5736
Ronald Cron164537c2024-02-01 18:05:47 +01005737 /*
5738 * The server may receive early data only while waiting for the End of
5739 * Early Data handshake message.
5740 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005741 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5742 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005743 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5744 }
5745
Ronald Croned7d4bf2024-01-31 07:55:19 +01005746 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005747}
5748#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5749
Paul Bakker5121ce52009-01-03 21:22:43 +00005750/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005751 * Send application data to be encrypted by the SSL layer, taking care of max
5752 * fragment length and buffer size.
5753 *
5754 * According to RFC 5246 Section 6.2.1:
5755 *
5756 * Zero-length fragments of Application data MAY be sent as they are
5757 * potentially useful as a traffic analysis countermeasure.
5758 *
5759 * Therefore, it is possible that the input message length is 0 and the
5760 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005761 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005762MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005763static int ssl_write_real(mbedtls_ssl_context *ssl,
5764 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005765{
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005767 const size_t max_len = (size_t) ret;
5768
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 if (ret < 0) {
5770 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5771 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005772 }
5773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005775#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5777 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5778 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5779 " > %" MBEDTLS_PRINTF_SIZET,
5780 len, max_len));
5781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5782 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005783#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005785 }
Paul Bakker887bd502011-06-08 13:10:54 +00005786
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005788 /*
5789 * The user has previously tried to send the data and
5790 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5791 * written. In this case, we expect the high-level write function
5792 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5793 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5795 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5796 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005797 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005799 /*
5800 * The user is trying to send a message the first time, so we need to
5801 * copy the data into the internal buffers and setup the data structure
5802 * to keep track of partial writes
5803 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005804 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005805 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005806 if (len > 0) {
5807 memcpy(ssl->out_msg, buf, len);
5808 }
Paul Bakker887bd502011-06-08 13:10:54 +00005809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5811 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5812 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005813 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005814 }
5815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005817}
5818
5819/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005820 * Write application data (public-facing wrapper)
5821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005822int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005823{
Janos Follath865b3eb2019-12-16 11:46:15 +00005824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (ssl == NULL || ssl->conf == NULL) {
5829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5830 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005831
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005832#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5834 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5835 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005836 }
5837#endif
5838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5840 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5841 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5842 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005843 }
5844 }
5845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005851}
5852
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005853#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5854int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5855 const unsigned char *buf, size_t len)
5856{
5857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5858 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005859 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005860
5861 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5862
5863 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5865 }
5866
Ronald Cron49221902024-02-21 13:39:14 +01005867 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5869 }
5870
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005871 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5872 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5873 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5874 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5875 }
5876
5877 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5878 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5879 }
5880
5881 /*
Ronald Crond2884662024-03-03 15:03:22 +01005882 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005883 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005884 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005885 * enough to be able to send early data if possible. That way, we can
5886 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005887 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005888 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5889 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005890 * as the early data outbound transform has not been set as we may have to
5891 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005892 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005893 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005894 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005895 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005896 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005897 ret = mbedtls_ssl_handshake_step(ssl);
5898 if (ret != 0) {
5899 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5900 return ret;
5901 }
5902
5903 ret = mbedtls_ssl_flush_output(ssl);
5904 if (ret != 0) {
5905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5906 return ret;
5907 }
5908 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005909 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005910 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005911 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005912 * If we are past the point where we can send early data or we have
5913 * already reached the maximum early data size, return immediatly.
5914 * Otherwise, progress the handshake as much as possible to not delay
5915 * it too much. If we reach a point where we can still send early data,
5916 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005917 */
Ronald Crond2884662024-03-03 15:03:22 +01005918 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5919 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005920 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5921 }
5922
Ronald Cron62f971a2024-02-23 08:24:12 +01005923 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005924 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005925
5926 if (remaining == 0) {
5927 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5928 }
5929
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005930 ret = mbedtls_ssl_handshake(ssl);
5931 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5932 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5933 return ret;
5934 }
5935 }
5936
Ronald Crond2884662024-03-03 15:03:22 +01005937 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5938 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005939 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005940 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5941 }
5942
Ronald Cron62f971a2024-02-23 08:24:12 +01005943 if (len > remaining) {
5944 len = remaining;
5945 }
5946
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005947 ret = ssl_write_real(ssl, buf, len);
5948 if (ret >= 0) {
5949 ssl->total_early_data_size += ret;
5950 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005951
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005952 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005953
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005954 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005955}
5956#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
5957
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005958/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005959 * Notify the peer that the connection is being closed
5960 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005961int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005962{
Janos Follath865b3eb2019-12-16 11:46:15 +00005963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 if (ssl == NULL || ssl->conf == NULL) {
5966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5967 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5972 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5973 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5974 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5975 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5976 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005977 }
5978 }
5979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005983}
5984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005986{
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005988 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 psa_destroy_key(transform->psa_key_enc);
5992 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005993
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005994#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 psa_destroy_key(transform->psa_mac_enc);
5996 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00005997#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006000}
6001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6003 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006004{
Jerry Yuc7875b52021-09-05 21:05:50 +08006005 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006007}
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6010 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006011{
6012 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006014}
6015
Hanno Becker0271f962018-08-16 13:23:47 +01006016#if defined(MBEDTLS_SSL_PROTO_DTLS)
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006019{
6020 unsigned offset;
6021 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006024 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 }
Hanno Becker0271f962018-08-16 13:23:47 +01006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6030 ssl_buffering_free_slot(ssl, offset);
6031 }
Hanno Beckere605b192018-08-21 15:59:07 +01006032}
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6035 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006036{
6037 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6038 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006041 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006045 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006046 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006048 }
6049}
6050
6051#endif /* MBEDTLS_SSL_PROTO_DTLS */
6052
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006053/*
6054 * Convert version numbers to/from wire format
6055 * and, for DTLS, to/from TLS equivalent.
6056 *
6057 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006058 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006059 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006060 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006061 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006062void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6063 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006064{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006065 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006066#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006068 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006070 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006071#else
6072 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006073#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006074 {
6075 tls_version_formatted = (uint16_t) tls_version;
6076 }
6077 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006078}
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6081 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006082{
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006084#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006086 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6088 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006089#else
6090 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006091#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006092 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006093}
6094
Jerry Yue7047812021-09-13 19:26:39 +08006095/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006096 * Send pending fatal alert.
6097 * 0, No alert message.
6098 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6099 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006101int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006102{
6103 int ret;
6104
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006105 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (ssl->send_alert == 0) {
6107 return 0;
6108 }
Jerry Yu394ece62021-09-14 22:17:21 +08006109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 ret = mbedtls_ssl_send_alert_message(ssl,
6111 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6112 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006113
Jerry Yu3bf1f972021-09-22 21:37:18 +08006114 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6115 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006118 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006119 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (ret != 0) {
6122 return ret;
6123 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006126}
6127
Jerry Yu394ece62021-09-14 22:17:21 +08006128/*
6129 * Set pending fatal alert flag.
6130 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006131void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6132 unsigned char alert_type,
6133 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006134{
6135 ssl->send_alert = 1;
6136 ssl->alert_type = alert_type;
6137 ssl->alert_reason = alert_reason;
6138}
6139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006140#endif /* MBEDTLS_SSL_TLS_C */