blob: 12b8f9bf019ca179f368d7654272d7ab603ff20b [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010030
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000031#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000032#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000033#include "mbedtls/debug.h"
34#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050035#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010036#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020037#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020038#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020043#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050044#include "psa/crypto.h"
45#endif
46
Janos Follath23bdca02016-10-07 14:47:14 +010047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020049#endif
50
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040052/* Define a local translating function to save code size by not using too many
53 * arguments in each translating place. */
54static int local_err_translation(psa_status_t status)
55{
56 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040057 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040058 psa_generic_status_to_mbedtls);
59}
60#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050061#endif
62
Dave Rodgman2801f7f2023-05-09 11:00:07 +010063#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
64
65#if defined(MBEDTLS_USE_PSA_CRYPTO)
66
67#if defined(PSA_WANT_ALG_SHA_384)
68#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
69#elif defined(PSA_WANT_ALG_SHA_256)
70#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
71#else /* See check_config.h */
72#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
73#endif
74
75MBEDTLS_STATIC_TESTABLE
76int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
77 psa_algorithm_t mac_alg,
78 const unsigned char *add_data,
79 size_t add_data_len,
80 const unsigned char *data,
81 size_t data_len_secret,
82 size_t min_data_len,
83 size_t max_data_len,
84 unsigned char *output)
85{
86 /*
87 * This function breaks the HMAC abstraction and uses psa_hash_clone()
88 * extension in order to get constant-flow behaviour.
89 *
90 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
91 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
92 * patterns (see RFC 2104, sec. 2).
93 *
94 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
95 * hashing up to minlen, then cloning the context, and for each byte up
96 * to maxlen finishing up the hash computation, keeping only the
97 * correct result.
98 *
99 * Then we only need to compute HASH(okey + inner_hash) and we're done.
100 */
101 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
102 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
103 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
104 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
105 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
106 size_t hash_length;
107
108 unsigned char aux_out[PSA_HASH_MAX_SIZE];
109 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
110 size_t offset;
111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
112
113 size_t mac_key_length;
114 size_t i;
115
116#define PSA_CHK(func_call) \
117 do { \
118 status = (func_call); \
119 if (status != PSA_SUCCESS) \
120 goto cleanup; \
121 } while (0)
122
123 /* Export MAC key
124 * We assume key length is always exactly the output size
125 * which is never more than the block size, thus we use block_size
126 * as the key buffer size.
127 */
128 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
129
130 /* Calculate ikey */
131 for (i = 0; i < mac_key_length; i++) {
132 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
133 }
134 for (; i < block_size; ++i) {
135 key_buf[i] = 0x36;
136 }
137
138 PSA_CHK(psa_hash_setup(&operation, hash_alg));
139
140 /* Now compute inner_hash = HASH(ikey + msg) */
141 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
142 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
143 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
144
145 /* Fill the hash buffer in advance with something that is
146 * not a valid hash (barring an attack on the hash and
147 * deliberately-crafted input), in case the caller doesn't
148 * check the return status properly. */
149 memset(output, '!', hash_size);
150
151 /* For each possible length, compute the hash up to that point */
152 for (offset = min_data_len; offset <= max_data_len; offset++) {
153 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
154 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
155 PSA_HASH_MAX_SIZE, &hash_length));
156 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100157 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100158 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100159
160 if (offset < max_data_len) {
161 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
162 }
163 }
164
165 /* Abort current operation to prepare for final operation */
166 PSA_CHK(psa_hash_abort(&operation));
167
168 /* Calculate okey */
169 for (i = 0; i < mac_key_length; i++) {
170 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
171 }
172 for (; i < block_size; ++i) {
173 key_buf[i] = 0x5C;
174 }
175
176 /* Now compute HASH(okey + inner_hash) */
177 PSA_CHK(psa_hash_setup(&operation, hash_alg));
178 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
179 PSA_CHK(psa_hash_update(&operation, output, hash_size));
180 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
181
182#undef PSA_CHK
183
184cleanup:
185 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
186 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
187
188 psa_hash_abort(&operation);
189 psa_hash_abort(&aux_operation);
190 return PSA_TO_MBEDTLS_ERR(status);
191}
192
193#undef MAX_HASH_BLOCK_LENGTH
194
195#else
196MBEDTLS_STATIC_TESTABLE
197int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
198 const unsigned char *add_data,
199 size_t add_data_len,
200 const unsigned char *data,
201 size_t data_len_secret,
202 size_t min_data_len,
203 size_t max_data_len,
204 unsigned char *output)
205{
206 /*
207 * This function breaks the HMAC abstraction and uses the md_clone()
208 * extension to the MD API in order to get constant-flow behaviour.
209 *
210 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
211 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
212 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
213 *
214 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
215 * minlen, then cloning the context, and for each byte up to maxlen
216 * finishing up the hash computation, keeping only the correct result.
217 *
218 * Then we only need to compute HASH(okey + inner_hash) and we're done.
219 */
220 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
221 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
222 * all of which have the same block size except SHA-384. */
223 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
224 const unsigned char * const ikey = ctx->hmac_ctx;
225 const unsigned char * const okey = ikey + block_size;
226 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
227
228 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
229 mbedtls_md_context_t aux;
230 size_t offset;
231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
232
233 mbedtls_md_init(&aux);
234
235#define MD_CHK(func_call) \
236 do { \
237 ret = (func_call); \
238 if (ret != 0) \
239 goto cleanup; \
240 } while (0)
241
242 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
243
244 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
245 * so we can start directly with the message */
246 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
247 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
248
249 /* Fill the hash buffer in advance with something that is
250 * not a valid hash (barring an attack on the hash and
251 * deliberately-crafted input), in case the caller doesn't
252 * check the return status properly. */
253 memset(output, '!', hash_size);
254
255 /* For each possible length, compute the hash up to that point */
256 for (offset = min_data_len; offset <= max_data_len; offset++) {
257 MD_CHK(mbedtls_md_clone(&aux, ctx));
258 MD_CHK(mbedtls_md_finish(&aux, aux_out));
259 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100260 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100261 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100262
263 if (offset < max_data_len) {
264 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
265 }
266 }
267
268 /* The context needs to finish() before it starts() again */
269 MD_CHK(mbedtls_md_finish(ctx, aux_out));
270
271 /* Now compute HASH(okey + inner_hash) */
272 MD_CHK(mbedtls_md_starts(ctx));
273 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
274 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
275 MD_CHK(mbedtls_md_finish(ctx, output));
276
277 /* Done, get ready for next time */
278 MD_CHK(mbedtls_md_hmac_reset(ctx));
279
280#undef MD_CHK
281
282cleanup:
283 mbedtls_md_free(&aux);
284 return ret;
285}
286
287#endif /* MBEDTLS_USE_PSA_CRYPTO */
288
289#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100292
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293/*
294 * Start a timer.
295 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200296 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100297void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200298{
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200300 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
304 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200305}
306
307/*
308 * Return -1 is timer is expired, 0 if it isn't.
309 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100310int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311{
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->f_get_timer == NULL) {
313 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200314 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 if (ssl->f_get_timer(ssl->p_timer) == 2) {
317 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
318 return -1;
319 }
320
321 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200322}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200323
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100325static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
326 unsigned char *buf,
327 size_t len,
328 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
331 unsigned char *buf,
332 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200333{
334 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
336 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200337
338 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200339 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200342 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
343 goto exit;
344 }
345#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 mbedtls_record rec;
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
350 if (ret != 0) {
351 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200352 goto exit;
353 }
354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (ssl->transform_in != NULL) {
356 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
357 if (ret != 0) {
358 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200359 goto exit;
360 }
361 }
362 }
363#endif /* MBEDTLS_SSL_PROTO_DTLS */
364
365exit:
366 /* On success, we have decrypted the buffer in-place, so make
367 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200369
370 /* For the purpose of this API, treat messages with unexpected CID
371 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
373 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200374 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
375 }
376
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
378 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200379}
380
Hanno Becker67bc7c32018-08-06 11:33:50 +0100381#define SSL_DONT_FORCE_FLUSH 0
382#define SSL_FORCE_FLUSH 1
383
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200384#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100385
Hanno Beckerd5847772018-08-28 10:09:23 +0100386/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
388 uint8_t slot);
389static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200390MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100393static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100395static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100397static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
398 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100401
Gilles Peskine449bd832023-01-11 14:50:10 +0100402static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100403{
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000405#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
406 size_t out_buf_len = ssl->out_buf_len;
407#else
408 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
409#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 if (mtu != 0 && mtu < out_buf_len) {
412 return mtu;
413 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100414
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100416}
417
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100419static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420{
Hanno Becker11682cc2018-08-22 14:41:02 +0100421 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100423
424 /* Double-check that the write-index hasn't gone
425 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100427 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100429 }
430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100432}
433
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200434MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100435static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100436{
Janos Follath865b3eb2019-12-16 11:46:15 +0000437 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100438 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400439 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100440
441#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100443
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100445 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100447
448 /* By the standard (RFC 6066 Sect. 4), the MFL extension
449 * only limits the maximum record payload size, so in theory
450 * we would be allowed to pack multiple records of payload size
451 * MFL into a single datagram. However, this would mean that there's
452 * no way to explicitly communicate MTU restrictions to the peer.
453 *
454 * The following reduction of max_len makes sure that we never
455 * write datagrams larger than MFL + Record Expansion Overhead.
456 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 if (max_len <= ssl->out_left) {
458 return 0;
459 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100460
461 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462#endif
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 ret = ssl_get_remaining_space_in_datagram(ssl);
465 if (ret < 0) {
466 return ret;
467 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100468 remaining = (size_t) ret;
469
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 ret = mbedtls_ssl_get_record_expansion(ssl);
471 if (ret < 0) {
472 return ret;
473 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474 expansion = (size_t) ret;
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (remaining <= expansion) {
477 return 0;
478 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100479
480 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100482 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100486}
487
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488/*
489 * Double the retransmit timeout value, within the allowed range,
490 * returning -1 if the maximum value has already been reached.
491 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100493static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200494{
495 uint32_t new_timeout;
496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
498 return -1;
499 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200501 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
502 * in the following way: after the initial transmission and a first
503 * retransmission, back off to a temporary estimated MTU of 508 bytes.
504 * This value is guaranteed to be deliverable (if not guaranteed to be
505 * delivered) of any compliant IPv4 (and IPv6) network, and should work
506 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200508 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400510 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200511
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200512 new_timeout = 2 * ssl->handshake->retransmit_timeout;
513
514 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 if (new_timeout < ssl->handshake->retransmit_timeout ||
516 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200518 }
519
520 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
522 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200525}
526
Gilles Peskine449bd832023-01-11 14:50:10 +0100527static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200528{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200529 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
531 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200532}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200534
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100535/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000536 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200537 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000538
Ronald Cron6f135e12021-12-08 16:57:54 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541static size_t ssl_compute_padding_length(size_t len,
542 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100543{
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100545}
546
Hanno Becker581bc1b2020-05-04 12:20:03 +0100547/* This functions transforms a (D)TLS plaintext fragment and a record content
548 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
549 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
550 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100551 *
552 * struct {
553 * opaque content[DTLSPlaintext.length];
554 * ContentType real_type;
555 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100556 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Input:
559 * - `content`: The beginning of the buffer holding the
560 * plaintext to be wrapped.
561 * - `*content_size`: The length of the plaintext in Bytes.
562 * - `max_len`: The number of Bytes available starting from
563 * `content`. This must be `>= *content_size`.
564 * - `rec_type`: The desired record content type.
565 *
566 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100567 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
568 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 *
570 * Returns:
571 * - `0` on success.
572 * - A negative error code if `max_len` didn't offer enough space
573 * for the expansion.
574 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200575MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100576static int ssl_build_inner_plaintext(unsigned char *content,
577 size_t *content_size,
578 size_t remaining,
579 uint8_t rec_type,
580 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100581{
582 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100583
584 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (remaining == 0) {
586 return -1;
587 }
588 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589 len++;
590 remaining--;
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (remaining < pad) {
593 return -1;
594 }
595 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100596 len += pad;
597 remaining -= pad;
598
599 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100601}
602
Hanno Becker581bc1b2020-05-04 12:20:03 +0100603/* This function parses a (D)TLSInnerPlaintext structure.
604 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200605MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100606static int ssl_parse_inner_plaintext(unsigned char const *content,
607 size_t *content_size,
608 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100609{
610 size_t remaining = *content_size;
611
612 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 do {
614 if (remaining == 0) {
615 return -1;
616 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100617 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100619
620 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624}
Ronald Cron6f135e12021-12-08 16:57:54 +0100625#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100626
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200627/* The size of the `add_data` structure depends on various
628 * factors, namely
629 *
630 * 1) CID functionality disabled
631 *
632 * additional_data =
633 * 8: seq_num +
634 * 1: type +
635 * 2: version +
636 * 2: length of inner plaintext +
637 *
638 * size = 13 bytes
639 *
640 * 2) CID functionality based on RFC 9146 enabled
641 *
642 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
643 * = 23 + CID-length
644 *
645 * 3) CID functionality based on legacy CID version
646 according to draft-ietf-tls-dtls-connection-id-05
647 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
648 *
649 * size = 13 + 1 + CID-length
650 *
651 * More information about the CID usage:
652 *
653 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
654 * size of the additional data structure is calculated as:
655 *
656 * additional_data =
657 * 8: seq_num +
658 * 1: tls12_cid +
659 * 2: DTLSCipherText.version +
660 * n: cid +
661 * 1: cid_length +
662 * 2: length_of_DTLSInnerPlaintext
663 *
664 * Per RFC 9146 the size of the add_data structure is calculated as:
665 *
666 * additional_data =
667 * 8: seq_num_placeholder +
668 * 1: tls12_cid +
669 * 1: cid_length +
670 * 1: tls12_cid +
671 * 2: DTLSCiphertext.version +
672 * 2: epoch +
673 * 6: sequence_number +
674 * n: cid +
675 * 2: length_of_DTLSInnerPlaintext
676 *
677 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static void ssl_extract_add_data_from_record(unsigned char *add_data,
679 size_t *add_data_len,
680 mbedtls_record *rec,
681 mbedtls_ssl_protocol_version
682 tls_version,
683 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000684{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200685 /* Several types of ciphers have been defined for use with TLS and DTLS,
686 * and the MAC calculations for those ciphers differ slightly. Further
687 * variants were added when the CID functionality was added with RFC 9146.
688 * This implementations also considers the use of a legacy version of the
689 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
690 * which is used in deployments.
691 *
692 * We will distinguish between the non-CID and the CID cases below.
693 *
694 * --- Non-CID cases ---
695 *
696 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100697 *
698 * additional_data = seq_num + TLSCompressed.type +
699 * TLSCompressed.version + TLSCompressed.length;
700 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100701 * For TLS 1.3, the record sequence number is dropped from the AAD
702 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000703 * Moreover, the additional data involves the length of the TLS
704 * ciphertext, not the TLS plaintext as in earlier versions.
705 * Quoting RFC 8446 (TLS 1.3):
706 *
707 * additional_data = TLSCiphertext.opaque_type ||
708 * TLSCiphertext.legacy_record_version ||
709 * TLSCiphertext.length
710 *
711 * We pass the tag length to this function in order to compute the
712 * ciphertext length from the inner plaintext length rec->data_len via
713 *
714 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
715 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200716 * --- CID cases ---
717 *
718 * RFC 9146 uses a common pattern when constructing the data
719 * passed into a MAC / AEAD cipher.
720 *
721 * Data concatenation for MACs used with block ciphers with
722 * Encrypt-then-MAC Processing (with CID):
723 *
724 * data = seq_num_placeholder +
725 * tls12_cid +
726 * cid_length +
727 * tls12_cid +
728 * DTLSCiphertext.version +
729 * epoch +
730 * sequence_number +
731 * cid +
732 * DTLSCiphertext.length +
733 * IV +
734 * ENC(content + padding + padding_length)
735 *
736 * Data concatenation for MACs used with block ciphers (with CID):
737 *
738 * data = seq_num_placeholder +
739 * tls12_cid +
740 * cid_length +
741 * tls12_cid +
742 * DTLSCiphertext.version +
743 * epoch +
744 * sequence_number +
745 * cid +
746 * length_of_DTLSInnerPlaintext +
747 * DTLSInnerPlaintext.content +
748 * DTLSInnerPlaintext.real_type +
749 * DTLSInnerPlaintext.zeros
750 *
751 * AEAD ciphers use the following additional data calculation (with CIDs):
752 *
753 * additional_data = seq_num_placeholder +
754 * tls12_cid +
755 * cid_length +
756 * tls12_cid +
757 * DTLSCiphertext.version +
758 * epoch +
759 * sequence_number +
760 * cid +
761 * length_of_DTLSInnerPlaintext
762 *
763 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
764 * defines the additional data calculation as follows:
765 *
766 * additional_data = seq_num +
767 * tls12_cid +
768 * DTLSCipherText.version +
769 * cid +
770 * cid_length +
771 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100773
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100774 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000775 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100776
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200777#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
778 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
779 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
780#endif
781
Ronald Cron6f135e12021-12-08 16:57:54 +0100782#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000784 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
785 * which differs from the length of the TLSInnerPlaintext
786 * by the length of the authentication tag. */
787 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100790 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400791 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000792 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200793
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100794#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
796 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200797 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
799 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200800
801 // tls12_cid type
802 *cur = rec->type;
803 cur++;
804
805 // cid_length
806 *cur = rec->cid_len;
807 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100809#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200810 {
811 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 memcpy(cur, rec->ctr, sizeof(rec->ctr));
813 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200814 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100815 }
816
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100818 *cur = rec->type;
819 cur++;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 memcpy(cur, rec->ver, sizeof(rec->ver));
823 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
826 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829 // CID
830 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 cur += rec->cid_len;
832
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100834 *cur = rec->cid_len;
835 cur++;
836
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200837 // length of inner plaintext
838 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
839 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200841#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
842 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200845 // epoch + sequence number
846 memcpy(cur, rec->ctr, sizeof(rec->ctr));
847 cur += sizeof(rec->ctr);
848
849 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200851 cur += rec->cid_len;
852
853 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100855 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100858 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100860 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100861 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100862
863 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864}
865
Valerio Settie5707042023-10-11 11:54:42 +0200866#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200867MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100868static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100870{
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872}
873
Hanno Becker17263802020-05-28 07:05:48 +0100874/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
875 *
876 * Concretely, this occurs in two variants:
877 *
878 * a) Fixed and dynamic IV lengths add up to total IV length, giving
879 * IV = fixed_iv || dynamic_iv
880 *
Hanno Becker15952812020-06-04 13:31:46 +0100881 * This variant is used in TLS 1.2 when used with GCM or CCM.
882 *
Hanno Becker17263802020-05-28 07:05:48 +0100883 * b) Fixed IV lengths matches total IV length, giving
884 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100885 *
886 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
887 *
888 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100889 *
890 * This function has the precondition that
891 *
892 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
893 *
894 * which has to be ensured by the caller. If this precondition
895 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100896 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100897static void ssl_build_record_nonce(unsigned char *dst_iv,
898 size_t dst_iv_len,
899 unsigned char const *fixed_iv,
900 size_t fixed_iv_len,
901 unsigned char const *dynamic_iv,
902 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100903{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100904 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 memset(dst_iv, 0, dst_iv_len);
906 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100907
Hanno Becker17263802020-05-28 07:05:48 +0100908 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100910}
Valerio Settie5707042023-10-11 11:54:42 +0200911#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100912
Gilles Peskine449bd832023-01-11 14:50:10 +0100913int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
914 mbedtls_ssl_transform *transform,
915 mbedtls_record *rec,
916 int (*f_rng)(void *, unsigned char *, size_t),
917 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000918{
Neil Armstrong136f8402022-03-30 10:58:01 +0200919 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100920 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200922 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 * the description of ssl_extract_add_data_from_record().
924 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200925#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
926 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
927#else
928 unsigned char add_data[13];
929#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100930 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000931 size_t post_avail;
932
933 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000934#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200935 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000936 ((void) ssl);
937#endif
938
939 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200940 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100941#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
942 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000943 ((void) f_rng);
944 ((void) p_rng);
945#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000946
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (transform == NULL) {
950 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
951 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100954 || rec->buf == NULL
955 || rec->buf_len < rec->data_offset
956 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100957#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100958 || rec->cid_len != 0
959#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 ) {
961 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
962 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100963 }
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200966
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000967 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
969 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
970 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000971
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
973 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
974 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
975 rec->data_len,
976 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100979
Hanno Becker92313402020-05-20 13:58:58 +0100980 /* The following two code paths implement the (D)TLSInnerPlaintext
981 * structure present in TLS 1.3 and DTLS 1.2 + CID.
982 *
983 * See ssl_build_inner_plaintext() for more information.
984 *
985 * Note that this changes `rec->data_len`, and hence
986 * `post_avail` needs to be recalculated afterwards.
987 *
988 * Note also that the two code paths cannot occur simultaneously
989 * since they apply to different versions of the protocol. There
990 * is hence no risk of double-addition of the inner plaintext.
991 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100992#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100994 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 ssl_compute_padding_length(rec->data_len,
996 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
997 if (ssl_build_inner_plaintext(data,
998 &rec->data_len,
999 post_avail,
1000 rec->type,
1001 padding) != 0) {
1002 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +01001003 }
1004
1005 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
1006 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001007#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001008
Hanno Beckera0e20d02019-05-15 14:03:01 +01001009#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001010 /*
1011 * Add CID information
1012 */
1013 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1015 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001018 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 ssl_compute_padding_length(rec->data_len,
1020 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001021 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001022 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001023 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001024 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001025 * Note that this changes `rec->data_len`, and hence
1026 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (ssl_build_inner_plaintext(data,
1029 &rec->data_len,
1030 post_avail,
1031 rec->type,
1032 padding) != 0) {
1033 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001034 }
1035
1036 rec->type = MBEDTLS_SSL_MSG_CID;
1037 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001038#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001039
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001041
Paul Bakker5121ce52009-01-03 21:22:43 +00001042 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001043 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001044 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001045#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1047 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1048 if (post_avail < transform->maclen) {
1049 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1050 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001051 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001052#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001053 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001054 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001055#if defined(MBEDTLS_USE_PSA_CRYPTO)
1056 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1058 size_t sign_mac_length = 0;
1059#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1062 transform->tls_version,
1063 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001064
Neil Armstrong26e6d672022-02-23 09:30:33 +01001065#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1067 transform->psa_mac_alg);
1068 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001069 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 status = psa_mac_update(&operation, add_data, add_data_len);
1073 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001074 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 status = psa_mac_update(&operation, data, rec->data_len);
1078 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001079 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1083 &sign_mac_length);
1084 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001085 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001087#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1089 add_data_len);
1090 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001091 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 }
1093 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1094 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001095 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 }
1097 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1098 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001099 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 }
1101 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1102 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001103 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001105#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001108#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1111 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001112
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001113 rec->data_len += transform->maclen;
1114 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001115 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117hmac_failed_etm_disabled:
1118 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001120 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 status = psa_mac_abort(&operation);
1122 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001123 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ret != 0) {
1127 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1128 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001129 }
Paul Bakker577e0062013-08-28 11:57:20 +02001130 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001131#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001132
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001133 /*
1134 * Encrypt
1135 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001136#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1138 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1139 "including %d bytes of padding",
1140 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001141
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001142 /* The only supported stream cipher is "NULL",
1143 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001145#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001146
Valerio Settie5707042023-10-11 11:54:42 +02001147#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001149 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001150 unsigned char *dynamic_iv;
1151 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001152 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001154#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001155 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001156#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001158
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001159 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (post_avail < transform->taglen) {
1161 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1162 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001163 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001164
Paul Bakker68884e32013-01-07 18:20:04 +01001165 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001166 * Build nonce for AEAD encryption.
1167 *
1168 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1169 * part of the IV is prepended to the ciphertext and
1170 * can be chosen freely - in particular, it need not
1171 * agree with the record sequence number.
1172 * However, since ChaChaPoly as well as all AEAD modes
1173 * in TLS 1.3 use the record sequence number as the
1174 * dynamic part of the nonce, we uniformly use the
1175 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001176 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001177 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 ssl_build_record_nonce(iv, sizeof(iv),
1181 transform->iv_enc,
1182 transform->fixed_ivlen,
1183 dynamic_iv,
1184 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001185
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001186 /*
1187 * Build additional data for AEAD encryption.
1188 * This depends on the TLS version.
1189 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1191 transform->tls_version,
1192 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1195 iv, transform->ivlen);
1196 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1197 dynamic_iv,
1198 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1199 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1200 add_data, add_data_len);
1201 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1202 "including 0 bytes of padding",
1203 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001204
Paul Bakker68884e32013-01-07 18:20:04 +01001205 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001206 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001207 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 status = psa_aead_encrypt(transform->psa_key_enc,
1210 transform->psa_alg,
1211 iv, transform->ivlen,
1212 add_data, add_data_len,
1213 data, rec->data_len,
1214 data, rec->buf_len - (data - rec->buf),
1215 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001218 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1220 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001221 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001222#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1224 iv, transform->ivlen,
1225 add_data, add_data_len,
1226 data, rec->data_len, /* src */
1227 data, rec->buf_len - (data - rec->buf), /* dst */
1228 &rec->data_len,
1229 transform->taglen)) != 0) {
1230 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1231 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001232 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001233#endif /* MBEDTLS_USE_PSA_CRYPTO */
1234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1236 data + rec->data_len - transform->taglen,
1237 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001238 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001239 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001240
1241 /*
1242 * Prefix record content with dynamic IV in case it is explicit.
1243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 if (dynamic_iv_is_explicit != 0) {
1245 if (rec->data_offset < dynamic_iv_len) {
1246 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1247 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001248 }
1249
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001251 rec->data_offset -= dynamic_iv_len;
1252 rec->data_len += dynamic_iv_len;
1253 }
1254
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001255 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 } else
Valerio Settie5707042023-10-11 11:54:42 +02001257#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001258#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1260 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001262 size_t padlen, i;
1263 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001264#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001266 size_t part_len;
1267 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1268#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001269
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001270 /* Currently we're always using minimal padding
1271 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001272 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1273 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001274 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001275 }
1276
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 /* Check there's enough space in the buffer for the padding. */
1278 if (post_avail < padlen + 1) {
1279 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1280 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1281 }
1282
1283 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001284 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001286
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001287 rec->data_len += padlen + 1;
1288 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001289
TRodziewicz0f82ec62021-05-12 17:49:18 +02001290#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001291 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001292 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001293 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 if (f_rng == NULL) {
1296 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1297 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001298 }
TRodziewicz345165c2021-07-06 13:42:11 +02001299
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 if (rec->data_offset < transform->ivlen) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1302 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001303 }
1304
1305 /*
1306 * Generate IV
1307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1309 if (ret != 0) {
1310 return ret;
1311 }
TRodziewicz345165c2021-07-06 13:42:11 +02001312
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001314#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001315
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1317 "including %"
1318 MBEDTLS_PRINTF_SIZET
1319 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1320 rec->data_len, transform->ivlen,
1321 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001322
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001323#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 status = psa_cipher_encrypt_setup(&cipher_op,
1325 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001328 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1330 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001331 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001336 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1338 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001339
1340 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 status = psa_cipher_update(&cipher_op,
1343 data, rec->data_len,
1344 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001347 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1349 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001350
1351 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 status = psa_cipher_finish(&cipher_op,
1354 data + olen, rec->data_len - olen,
1355 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001358 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1360 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001361
1362 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001363
1364 olen += part_len;
1365#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1367 transform->iv_enc,
1368 transform->ivlen,
1369 data, rec->data_len,
1370 data, &olen)) != 0) {
1371 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1372 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001373 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001374#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if (rec->data_len != olen) {
1377 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1378 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001379 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001380
TRodziewicz0f82ec62021-05-12 17:49:18 +02001381 data -= transform->ivlen;
1382 rec->data_offset -= transform->ivlen;
1383 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001387 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001388#if defined(MBEDTLS_USE_PSA_CRYPTO)
1389 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1390 size_t sign_mac_length = 0;
1391#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001392
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001393 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001394 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 if (post_avail < transform->maclen) {
1397 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1398 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001399 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl_extract_add_data_from_record(add_data, &add_data_len,
1402 rec, transform->tls_version,
1403 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1406 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1407 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1410 transform->psa_mac_alg);
1411 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001414
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 status = psa_mac_update(&operation, add_data, add_data_len);
1416 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001417 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 status = psa_mac_update(&operation, data, rec->data_len);
1421 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001422 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001424
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1426 &sign_mac_length);
1427 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001428 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001430#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001431
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1433 add_data_len);
1434 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001435 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 }
1437 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1438 data, rec->data_len);
1439 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001440 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 }
1442 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1443 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001444 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 }
1446 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1447 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001448 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001450#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001451
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001453
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001454 rec->data_len += transform->maclen;
1455 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001456 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458hmac_failed_etm_enabled:
1459 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001460#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001461 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 status = psa_mac_abort(&operation);
1463 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001464 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001466#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 if (ret != 0) {
1468 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1469 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001470 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001471 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001472#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001474#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001475 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1477 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001478 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001479
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001480 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 if (auth_done != 1) {
1482 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1483 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001484 }
1485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001489}
1490
Gilles Peskine449bd832023-01-11 14:50:10 +01001491int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1492 mbedtls_ssl_transform *transform,
1493 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001494{
Valerio Settie5707042023-10-11 11:54:42 +02001495#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001496 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001497#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001498 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001499 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001500
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001501 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001502#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001503 size_t padlen = 0;
1504 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001505#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001507 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 * the description of ssl_extract_add_data_from_record().
1509 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001510#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1511 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1512#else
1513 unsigned char add_data[13];
1514#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001515 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516
Hanno Beckera18d1322018-01-03 14:27:32 +00001517#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001518 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 ((void) ssl);
1520#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1523 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001524 rec->buf == NULL ||
1525 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 rec->buf_len - rec->data_offset < rec->data_len) {
1527 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1528 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001529 }
1530
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001531 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001533
Hanno Beckera0e20d02019-05-15 14:03:01 +01001534#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001535 /*
1536 * Match record's CID with incoming CID.
1537 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 if (rec->cid_len != transform->in_cid_len ||
1539 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1540 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001541 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001542#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001543
Hanno Beckerd086bf02021-03-22 13:01:27 +00001544#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001546 if (rec->data_len < transform->maclen) {
1547 MBEDTLS_SSL_DEBUG_MSG(1,
1548 ("Record too short for MAC:"
1549 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1550 rec->data_len, transform->maclen));
1551 return MBEDTLS_ERR_SSL_INVALID_MAC;
1552 }
1553
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001554 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001555 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001557#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001558#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001560 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001561 unsigned char *dynamic_iv;
1562 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001563#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001565#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001566
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001567 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001568 * Extract dynamic part of nonce for AEAD decryption.
1569 *
1570 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1571 * part of the IV is prepended to the ciphertext and
1572 * can be chosen freely - in particular, it need not
1573 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 dynamic_iv_len = sizeof(rec->ctr);
1576 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1577 if (rec->data_len < dynamic_iv_len) {
1578 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1579 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1580 rec->data_len,
1581 dynamic_iv_len));
1582 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001583 }
1584 dynamic_iv = data;
1585
1586 data += dynamic_iv_len;
1587 rec->data_offset += dynamic_iv_len;
1588 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001590 dynamic_iv = rec->ctr;
1591 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001592
1593 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (rec->data_len < transform->taglen) {
1595 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1596 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1597 rec->data_len,
1598 transform->taglen));
1599 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001600 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001601 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001602
Hanno Beckerdf8be222020-05-21 15:30:57 +01001603 /*
1604 * Prepare nonce from dynamic and static parts.
1605 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 ssl_build_record_nonce(iv, sizeof(iv),
1607 transform->iv_dec,
1608 transform->fixed_ivlen,
1609 dynamic_iv,
1610 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001611
Hanno Beckerdf8be222020-05-21 15:30:57 +01001612 /*
1613 * Build additional data for AEAD encryption.
1614 * This depends on the TLS version.
1615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1617 transform->tls_version,
1618 transform->taglen);
1619 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1620 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001621
Hanno Beckerd96a6522019-07-10 13:55:25 +01001622 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001623 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001624 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001625 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001626 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1629 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1630 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001631
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001632 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001633 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001634 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001635#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 status = psa_aead_decrypt(transform->psa_key_dec,
1637 transform->psa_alg,
1638 iv, transform->ivlen,
1639 add_data, add_data_len,
1640 data, rec->data_len + transform->taglen,
1641 data, rec->buf_len - (data - rec->buf),
1642 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001645 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1647 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001648 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001649#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1651 iv, transform->ivlen,
1652 add_data, add_data_len,
1653 data, rec->data_len + transform->taglen, /* src */
1654 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1655 transform->taglen)) != 0) {
1656 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001657
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1659 return MBEDTLS_ERR_SSL_INVALID_MAC;
1660 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001661
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001663 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001664#endif /* MBEDTLS_USE_PSA_CRYPTO */
1665
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001666 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001667
Hanno Beckerd96a6522019-07-10 13:55:25 +01001668 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 if (olen != rec->data_len) {
1670 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1671 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001672 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 } else
Valerio Settie5707042023-10-11 11:54:42 +02001674#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001675#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1677 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001678 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001679#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001680 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001681 size_t part_len;
1682 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1683#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001684
Paul Bakker5121ce52009-01-03 21:22:43 +00001685 /*
Paul Bakker45829992013-01-03 14:52:21 +01001686 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001687 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001689 /* The ciphertext is prefixed with the CBC IV. */
1690 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001691#endif
Paul Bakker45829992013-01-03 14:52:21 +01001692
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001693 /* Size considerations:
1694 *
1695 * - The CBC cipher text must not be empty and hence
1696 * at least of size transform->ivlen.
1697 *
1698 * Together with the potential IV-prefix, this explains
1699 * the first of the two checks below.
1700 *
1701 * - The record must contain a MAC, either in plain or
1702 * encrypted, depending on whether Encrypt-then-MAC
1703 * is used or not.
1704 * - If it is, the message contains the IV-prefix,
1705 * the CBC ciphertext, and the MAC.
1706 * - If it is not, the padded plaintext, and hence
1707 * the CBC ciphertext, has at least length maclen + 1
1708 * because there is at least the padding length byte.
1709 *
1710 * As the CBC ciphertext is not empty, both cases give the
1711 * lower bound minlen + maclen + 1 on the record size, which
1712 * we test for in the second check below.
1713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 if (rec->data_len < minlen + transform->ivlen ||
1715 rec->data_len < minlen + transform->maclen + 1) {
1716 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1717 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1718 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1719 "+ 1 ) ( + expl IV )",
1720 rec->data_len,
1721 transform->ivlen,
1722 transform->maclen));
1723 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001724 }
1725
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001726 /*
1727 * Authenticate before decrypt if enabled
1728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001731#if defined(MBEDTLS_USE_PSA_CRYPTO)
1732 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1733#else
Hanno Becker992b6872017-11-09 18:57:39 +00001734 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001735#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001738
Hanno Beckerd96a6522019-07-10 13:55:25 +01001739 /* Update data_len in tandem with add_data.
1740 *
1741 * The subtraction is safe because of the previous check
1742 * data_len >= minlen + maclen + 1.
1743 *
1744 * Afterwards, we know that data + data_len is followed by at
1745 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001746 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001747 *
1748 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001749 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1751 transform->tls_version,
1752 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001753
Hanno Beckerd96a6522019-07-10 13:55:25 +01001754 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1756 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001757#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1759 transform->psa_mac_alg);
1760 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001761 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 status = psa_mac_update(&operation, add_data, add_data_len);
1765 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001766 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 status = psa_mac_update(&operation, data, rec->data_len);
1770 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001771 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001773
1774 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1776 transform->maclen);
1777 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001778 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001780#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1782 add_data_len);
1783 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001784 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 }
1786 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1787 data, rec->data_len);
1788 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001789 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 }
1791 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1792 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001793 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 }
1795 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1796 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001797 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1801 transform->maclen);
1802 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1803 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001804
Hanno Beckerd96a6522019-07-10 13:55:25 +01001805 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1807 transform->maclen) != 0) {
1808 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001809 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1810 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001811 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001812#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001813 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001816#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001817 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 status = psa_mac_abort(&operation);
1819 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001820 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001822#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001824#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 if (ret != 0) {
1826 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1827 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1828 }
1829 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001830 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001831 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001833
1834 /*
1835 * Check length sanity
1836 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001837
1838 /* We know from above that data_len > minlen >= 0,
1839 * so the following check in particular implies that
1840 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if (rec->data_len % transform->ivlen != 0) {
1842 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1843 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1844 rec->data_len, transform->ivlen));
1845 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001846 }
1847
TRodziewicz0f82ec62021-05-12 17:49:18 +02001848#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001849 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001850 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001851 */
TRodziewicz345165c2021-07-06 13:42:11 +02001852 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001854
TRodziewicz345165c2021-07-06 13:42:11 +02001855 data += transform->ivlen;
1856 rec->data_offset += transform->ivlen;
1857 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001858#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001859
Hanno Beckerd96a6522019-07-10 13:55:25 +01001860 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1861
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001862#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 status = psa_cipher_decrypt_setup(&cipher_op,
1864 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001867 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1869 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001870 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001875 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1877 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001878 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 status = psa_cipher_update(&cipher_op,
1881 data, rec->data_len,
1882 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001883
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001885 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1887 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001888 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 status = psa_cipher_finish(&cipher_op,
1891 data + olen, rec->data_len - olen,
1892 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001895 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1897 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001898 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001899
1900 olen += part_len;
1901#else
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1904 transform->iv_dec, transform->ivlen,
1905 data, rec->data_len, data, &olen)) != 0) {
1906 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1907 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001908 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001909#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001910
Hanno Beckerd96a6522019-07-10 13:55:25 +01001911 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (rec->data_len != olen) {
1913 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1914 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001915 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001916
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001917 /* Safe since data_len >= minlen + maclen + 1, so after having
1918 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001919 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1920 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001921 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001924 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 rec->data_len,
1926 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001927 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001928 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001930#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (rec->data_len < transform->maclen + padlen + 1) {
1932 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1933 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1934 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1935 rec->data_len,
1936 transform->maclen,
1937 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001938 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001939#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001940 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 rec->data_len,
1942 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001943 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001944 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001945 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001946
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001947 padlen++;
1948
1949 /* Regardless of the validity of the padding,
1950 * we have data_len >= padlen here. */
1951
TRodziewicz0f82ec62021-05-12 17:49:18 +02001952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001953 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 * consecutive memory reads at the end of the record
1955 * plaintext buffer. In order to hide the length and
1956 * validity of the padding, always perform exactly
1957 * `min(256,plaintext_len)` reads (but take into account
1958 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001959 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001961
1962 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001964 size_t const padding_idx = rec->data_len - padlen;
1965 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1966 size_t const start_idx = rec->data_len - num_checks;
1967 size_t idx;
1968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001970 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 * (check[idx] == padlen - 1);
1972 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001973 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001974 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001975 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001976 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001977 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001978 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001979 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001982 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1984 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001985#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001986 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001987
TRodziewicz0f82ec62021-05-12 17:49:18 +02001988#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001989
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001990 /* If the padding was found to be invalid, padlen == 0
1991 * and the subtraction is safe. If the padding was found valid,
1992 * padlen hasn't been changed and the previous assertion
1993 * data_len >= padlen still holds. */
1994 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001996#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001997 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1999 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02002000 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002001
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002002#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
2004 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002005#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002006
2007 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01002008 * Authenticate if not done yet.
2009 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002010 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002011#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002013 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2014 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002015
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002016 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002017 * data_len < maclen + padlen + 1, then padlen
2018 * got reset to 1, and the initial check
2019 * data_len >= minlen + maclen + 1
2020 * guarantees that at this point we still
2021 * have at least data_len >= maclen.
2022 *
2023 * If the initial value of padlen was such that
2024 * data_len >= maclen + padlen + 1, then we have
2025 * subtracted either padlen + 1 (if the padding was correct)
2026 * or 0 (if the padding was incorrect) since then,
2027 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002028 *
2029 * For stream ciphers, we checked above that
2030 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002031 */
2032 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2034 transform->tls_version,
2035 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002036
TRodziewicz0f82ec62021-05-12 17:49:18 +02002037#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002038 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 * The next two sizes are the minimum and maximum values of
2040 * data_len over all padlen values.
2041 *
2042 * They're independent of padlen, since we previously did
2043 * data_len -= padlen.
2044 *
2045 * Note that max_len + maclen is never more than the buffer
2046 * length, as we previously did in_msglen -= maclen too.
2047 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002048 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002050
Neil Armstronge8589962022-02-25 15:14:29 +01002051#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2053 transform->psa_mac_alg,
2054 add_data, add_data_len,
2055 data, rec->data_len, min_len, max_len,
2056 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002057#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2059 add_data, add_data_len,
2060 data, rec->data_len, min_len, max_len,
2061 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002062#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (ret != 0) {
2064 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002065 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002066 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 mbedtls_ct_memcpy_offset(mac_peer, data,
2069 rec->data_len,
2070 min_len, max_len,
2071 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002072#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002073
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002074#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2076 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002077#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2080 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002083#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002084 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002085 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002086 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088hmac_failed_etm_disabled:
2089 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2090 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2091 if (ret != 0) {
2092 return ret;
2093 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002094 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002095
2096 /*
2097 * Finally check the correct flag
2098 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002099 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return MBEDTLS_ERR_SSL_INVALID_MAC;
2101 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002102#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002103
2104 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (auth_done != 1) {
2106 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2107 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002108 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002109
Ronald Cron6f135e12021-12-08 16:57:54 +01002110#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002112 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2114 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (ret != 0) {
2117 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2118 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002119 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002120#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002121
Hanno Beckera0e20d02019-05-15 14:03:01 +01002122#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (rec->cid_len != 0) {
2124 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2125 &rec->type);
2126 if (ret != 0) {
2127 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2128 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002129 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002130#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002135}
2136
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002137#undef MAC_NONE
2138#undef MAC_PLAINTEXT
2139#undef MAC_CIPHERTEXT
2140
Paul Bakker5121ce52009-01-03 21:22:43 +00002141/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002142 * Fill the input message buffer by appending data to it.
2143 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002144 *
2145 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2146 * available (from this read and/or a previous one). Otherwise, an error code
2147 * is returned (possibly EOF or WANT_READ).
2148 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002149 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2150 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2151 * since we always read a whole datagram at once.
2152 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002153 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002154 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002157{
Janos Follath865b3eb2019-12-16 11:46:15 +00002158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002159 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002160#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2161 size_t in_buf_len = ssl->in_buf_len;
2162#else
2163 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2164#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2169 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002171 }
2172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2174 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002176 }
2177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002180 uint32_t timeout;
2181
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002182 /*
2183 * The point is, we need to always read a full datagram at once, so we
2184 * sometimes read more then requested, and handle the additional data.
2185 * It could be the rest of the current record (while fetching the
2186 * header) and/or some other records in the same datagram.
2187 */
2188
2189 /*
2190 * Move to the next record in the already read datagram if applicable
2191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if (ssl->next_record_offset != 0) {
2193 if (ssl->in_left < ssl->next_record_offset) {
2194 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2195 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002196 }
2197
2198 ssl->in_left -= ssl->next_record_offset;
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (ssl->in_left != 0) {
2201 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2202 MBEDTLS_PRINTF_SIZET,
2203 ssl->next_record_offset));
2204 memmove(ssl->in_hdr,
2205 ssl->in_hdr + ssl->next_record_offset,
2206 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002207 }
2208
2209 ssl->next_record_offset = 0;
2210 }
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2213 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2214 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002215
2216 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002217 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002218 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (nb_want <= ssl->in_left) {
2220 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2221 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002222 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002223
2224 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002225 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002226 * are not at the beginning of a new record, the caller did something
2227 * wrong.
2228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 if (ssl->in_left != 0) {
2230 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2231 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002232 }
2233
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002234 /*
2235 * Don't even try to read if time's out already.
2236 * This avoids by-passing the timer when repeatedly receiving messages
2237 * that will end up being dropped.
2238 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (mbedtls_ssl_check_timer(ssl) != 0) {
2240 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002241 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 } else {
2243 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002246 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002248 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 if (ssl->f_recv_timeout != NULL) {
2254 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2255 timeout);
2256 } else {
2257 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2258 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ret == 0) {
2263 return MBEDTLS_ERR_SSL_CONN_EOF;
2264 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002265 }
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2268 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2269 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2272 if (ssl_double_retransmit_timeout(ssl) != 0) {
2273 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2274 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002275 }
2276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2278 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2279 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002280 }
2281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002283 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2286 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2287 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2288 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2289 ret);
2290 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002291 }
2292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002294 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002296 }
2297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 if (ret < 0) {
2299 return ret;
2300 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002301
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002302 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002304#endif
2305 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2307 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2308 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002311 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002314 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 } else {
2316 if (ssl->f_recv_timeout != NULL) {
2317 ret = ssl->f_recv_timeout(ssl->p_bio,
2318 ssl->in_hdr + ssl->in_left, len,
2319 ssl->conf->read_timeout);
2320 } else {
2321 ret = ssl->f_recv(ssl->p_bio,
2322 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002323 }
2324 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2327 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2328 ssl->in_left, nb_want));
2329 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 if (ret == 0) {
2332 return MBEDTLS_ERR_SSL_CONN_EOF;
2333 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 if (ret < 0) {
2336 return ret;
2337 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002338
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002339 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_DEBUG_MSG(1,
2341 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2342 " were requested",
2343 ret, len));
2344 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002345 }
2346
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002347 ssl->in_left += ret;
2348 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002349 }
2350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002354}
2355
2356/*
2357 * Flush any data not yet written
2358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002359int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002360{
Janos Follath865b3eb2019-12-16 11:46:15 +00002361 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002362 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (ssl->f_send == NULL) {
2367 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2368 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002369 }
2370
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002371 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (ssl->out_left == 0) {
2373 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2374 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002375 }
2376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 while (ssl->out_left > 0) {
2378 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2379 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2380 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002381
Hanno Becker2b1e3542018-08-06 11:19:13 +01002382 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 if (ret <= 0) {
2388 return ret;
2389 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002390
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002391 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 MBEDTLS_SSL_DEBUG_MSG(1,
2393 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2394 " bytes were sent",
2395 ret, ssl->out_left));
2396 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002397 }
2398
Paul Bakker5121ce52009-01-03 21:22:43 +00002399 ssl->out_left -= ret;
2400 }
2401
Hanno Becker2b1e3542018-08-06 11:19:13 +01002402#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002404 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002406#endif
2407 {
2408 ssl->out_hdr = ssl->out_buf + 8;
2409 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002413
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002415}
2416
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002417/*
2418 * Functions to handle the DTLS retransmission state machine
2419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421/*
2422 * Append current handshake message to current outgoing flight
2423 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002424MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002425static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2429 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2430 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002431
2432 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2434 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2435 sizeof(mbedtls_ssl_flight_item)));
2436 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437 }
2438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2440 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2441 ssl->out_msglen));
2442 mbedtls_free(msg);
2443 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002444 }
2445
2446 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002449 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002450 msg->next = NULL;
2451
2452 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002454 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002458 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002460 cur->next = msg;
2461 }
2462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2464 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465}
2466
2467/*
2468 * Free the current flight of handshake messages
2469 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002470void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002471{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 mbedtls_ssl_flight_item *cur = flight;
2473 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002476 next = cur->next;
2477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 mbedtls_free(cur->p);
2479 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002480
2481 cur = next;
2482 }
2483}
2484
2485/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002486 * Swap transform_out and out_ctr with the alternative ones
2487 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002488MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002489static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002490{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002492 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2495 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2496 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002497 }
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002500
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002501 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002502 tmp_transform = ssl->transform_out;
2503 ssl->transform_out = ssl->handshake->alt_transform_out;
2504 ssl->handshake->alt_transform_out = tmp_transform;
2505
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002506 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2508 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2509 sizeof(ssl->cur_out_ctr));
2510 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2511 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002512
2513 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002517}
2518
2519/*
2520 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002522int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002523{
2524 int ret = 0;
2525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002533}
2534
2535/*
2536 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002537 *
2538 * Need to remember the current message in case flush_output returns
2539 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002540 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002541 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002542int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002543{
Janos Follath865b3eb2019-12-16 11:46:15 +00002544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2548 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002549
2550 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002551 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 ret = ssl_swap_epochs(ssl);
2553 if (ret != 0) {
2554 return ret;
2555 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002558 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002561 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002562 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002563
Hanno Beckere1dcb032018-08-17 16:47:58 +01002564 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2566 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002567
Ronald Cron00d012f22022-03-08 15:57:12 +01002568 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002570
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002571 /* Swap epochs before sending Finished: we can't do it after
2572 * sending ChangeCipherSpec, in case write returns WANT_READ.
2573 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2575 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2576 ret = ssl_swap_epochs(ssl);
2577 if (ret != 0) {
2578 return ret;
2579 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002580 }
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 ret = ssl_get_remaining_payload_in_datagram(ssl);
2583 if (ret < 0) {
2584 return ret;
2585 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002586 max_frag_len = (size_t) ret;
2587
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002588 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2590 if (max_frag_len == 0) {
2591 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2592 return ret;
2593 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002594
2595 continue;
2596 }
2597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002599 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002600 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002601
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002602 /* Update position inside current message */
2603 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002605 const unsigned char * const p = ssl->handshake->cur_msg_p;
2606 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002608 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002609 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2612 if (is_finished) {
2613 ret = ssl_swap_epochs(ssl);
2614 if (ret != 0) {
2615 return ret;
2616 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002617 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002618
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2620 return ret;
2621 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002622
2623 continue;
2624 }
2625 max_hs_frag_len = max_frag_len - 12;
2626
2627 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2631 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2632 (unsigned) cur_hs_frag_len,
2633 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002634 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002635
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002636 /* Messages are stored with handshake headers as if not fragmented,
2637 * copy beginning of headers then fill fragmentation fields.
2638 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2642 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2643 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2646 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2647 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002650
Hanno Becker3f7b9732018-08-28 09:53:25 +01002651 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002653 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002654 ssl->out_msgtype = cur->type;
2655
2656 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002657 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002658 }
2659
2660 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2662 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002663 ssl->handshake->cur_msg = cur->next;
2664 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002666 ssl->handshake->cur_msg = NULL;
2667 ssl->handshake->cur_msg_p = NULL;
2668 }
2669 }
2670
2671 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2673 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2674 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002675 }
2676 }
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2679 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002680 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 /* Update state and set timer */
2683 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2684 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2685 } else {
2686 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2687 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2688 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2691
2692 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002693}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002694
2695/*
2696 * To be called when the last message of an incoming flight is received.
2697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002698void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002699{
2700 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002702 ssl->handshake->flight = NULL;
2703 ssl->handshake->cur_msg = NULL;
2704
2705 /* The next incoming flight will start with this msg_seq */
2706 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2707
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002708 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002709 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002710
Hanno Becker0271f962018-08-16 13:23:47 +01002711 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002713
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002714 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2718 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002723}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002724
2725/*
2726 * To be called when the last message of an outgoing flight is send.
2727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002728void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002729{
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 ssl_reset_retransmit_timeout(ssl);
2731 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002732
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2734 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002739}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002741
Paul Bakker5121ce52009-01-03 21:22:43 +00002742/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002743 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002745int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2746 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002747{
2748 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002749 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002750 * ...
2751 * HandshakeType msg_type;
2752 * uint24 length;
2753 * ...
2754 */
2755 *buf = ssl->out_msg + 4;
2756 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2757
2758 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2759 ssl->out_msg[0] = hs_type;
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002762}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002763
2764/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002765 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002766 *
2767 * - fill in handshake headers
2768 * - update handshake checksum
2769 * - DTLS: save message for resending
2770 * - then pass to the record layer
2771 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002772 * DTLS: except for HelloRequest, messages are only queued, and will only be
2773 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002774 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002775 * Inputs:
2776 * - ssl->out_msglen: 4 + actual handshake message len
2777 * (4 is the size of handshake headers for TLS)
2778 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2779 * - ssl->out_msg + 4: the handshake message body
2780 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002781 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002782 * - ssl->out_msglen: the length of the record contents
2783 * (including handshake headers but excluding record headers)
2784 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002785 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002786int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2787 int update_checksum,
2788 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002789{
Janos Follath865b3eb2019-12-16 11:46:15 +00002790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002791 const size_t hs_len = ssl->out_msglen - 4;
2792 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002795
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002796 /*
2797 * Sanity checks
2798 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2800 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2801 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2802 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002803 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002804
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002805 /* Whenever we send anything different from a
2806 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2808 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2809 ssl->handshake == NULL) {
2810 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2811 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002812 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002816 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2818 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2819 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002820 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002821#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002822
Hanno Beckerb50a2532018-08-06 11:52:54 +01002823 /* Double-check that we did not exceed the bounds
2824 * of the outgoing record buffer.
2825 * This should never fail as the various message
2826 * writing functions must obey the bounds of the
2827 * outgoing record buffer, but better be safe.
2828 *
2829 * Note: We deliberately do not check for the MTU or MFL here.
2830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2832 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2833 "size %" MBEDTLS_PRINTF_SIZET
2834 ", maximum %" MBEDTLS_PRINTF_SIZET,
2835 ssl->out_msglen,
2836 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2837 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002838 }
2839
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002840 /*
2841 * Fill handshake headers
2842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2844 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2845 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2846 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002847
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002848 /*
2849 * DTLS has additional fields in the Handshake layer,
2850 * between the length field and the actual payload:
2851 * uint16 message_seq;
2852 * uint24 fragment_offset;
2853 * uint24 fragment_length;
2854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002857 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2859 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2860 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2861 MBEDTLS_PRINTF_SIZET,
2862 hs_len,
2863 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002865 }
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002868 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002869
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002870 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2872 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2873 ++(ssl->handshake->out_msg_seq);
2874 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002875 ssl->out_msg[4] = 0;
2876 ssl->out_msg[5] = 0;
2877 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002878
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002879 /* Handshake hashes are computed without fragmentation,
2880 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 memset(ssl->out_msg + 6, 0x00, 3);
2882 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002883 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002885
Hanno Becker0207e532018-08-28 10:28:28 +01002886 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002888 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2889 ssl->out_msglen);
2890 if (ret != 0) {
2891 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2892 return ret;
2893 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002895 }
2896
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002897 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2900 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2901 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2902 if ((ret = ssl_flight_append(ssl)) != 0) {
2903 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2904 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002905 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002907#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002908 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2910 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2911 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002912 }
2913 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002918}
2919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2921 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002922{
2923 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2924 size_t msg_with_header_len;
2925 ((void) buf_len);
2926
2927 /* Add reserved 4 bytes for handshake header */
2928 msg_with_header_len = msg_len + 4;
2929 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002931
2932cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002934}
2935
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002936/*
2937 * Record layer functions
2938 */
2939
2940/*
2941 * Write current record.
2942 *
2943 * Uses:
2944 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2945 * - ssl->out_msglen: length of the record content (excl headers)
2946 * - ssl->out_msg: record content
2947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002948int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002949{
2950 int ret, done = 0;
2951 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002952 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002957 unsigned i;
2958 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002959#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2960 size_t out_buf_len = ssl->out_buf_len;
2961#else
2962 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2963#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002964 /* Skip writing the record content type to after the encryption,
2965 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002966 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002967#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002968 /* TLS 1.3 still uses the TLS 1.2 version identifier
2969 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002971 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002973#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2975 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2978 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002981 mbedtls_record rec;
2982
2983 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002985 rec.data_len = ssl->out_msglen;
2986 rec.data_offset = ssl->out_msg - rec.buf;
2987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2989 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002990 rec.type = ssl->out_msgtype;
2991
Hanno Beckera0e20d02019-05-15 14:03:01 +01002992#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002993 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002994 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002995#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2998 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2999 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
3000 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00003001 }
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 if (rec.data_offset != 0) {
3004 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3005 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00003006 }
3007
Hanno Becker6430faf2019-05-08 11:57:13 +01003008 /* Update the record content type and CID. */
3009 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003010#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3011 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003012#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003013 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003015 }
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003018
3019#if defined(MBEDTLS_SSL_PROTO_DTLS)
3020 /* In case of DTLS, double-check that we don't exceed
3021 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3023 ret = ssl_get_remaining_space_in_datagram(ssl);
3024 if (ret < 0) {
3025 return ret;
3026 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003029 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003031 }
3032 }
3033#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003034
Hanno Becker6430faf2019-05-08 11:57:13 +01003035 /* Now write the potentially updated record content type. */
3036 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3039 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3040 ssl->out_hdr[0], ssl->out_hdr[1],
3041 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3044 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003045
3046 ssl->out_left += protected_record_size;
3047 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3051 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003052 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 }
3054 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003055
Gabor Mezei96ae9262022-06-28 11:45:18 +02003056 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (i == mbedtls_ssl_ep_len(ssl)) {
3058 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3059 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003060 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003061 }
3062
Hanno Becker67bc7c32018-08-06 11:33:50 +01003063#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3065 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003066 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 ret = ssl_get_remaining_payload_in_datagram(ssl);
3068 if (ret < 0) {
3069 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3070 ret);
3071 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003072 }
3073
3074 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003076 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 } else {
3078 MBEDTLS_SSL_DEBUG_MSG(2,
3079 ("Still %u bytes available in current datagram",
3080 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003081 }
3082 }
3083#endif /* MBEDTLS_SSL_PROTO_DTLS */
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 if ((flush == SSL_FORCE_FLUSH) &&
3086 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3087 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3088 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003089 }
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003094}
3095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003097
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003098MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003099static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003100{
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 if (ssl->in_msglen < ssl->in_hslen ||
3102 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3103 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3104 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003105 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003107}
Hanno Becker44650b72018-08-16 12:51:11 +01003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003110{
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return (ssl->in_msg[9] << 16) |
3112 (ssl->in_msg[10] << 8) |
3113 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003114}
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003117{
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 return (ssl->in_msg[6] << 16) |
3119 (ssl->in_msg[7] << 8) |
3120 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003121}
3122
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003124static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003125{
3126 uint32_t msg_len, frag_off, frag_len;
3127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 msg_len = ssl_get_hs_total_len(ssl);
3129 frag_off = ssl_get_hs_frag_off(ssl);
3130 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 if (frag_off > msg_len) {
3133 return -1;
3134 }
Hanno Becker44650b72018-08-16 12:51:11 +01003135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 if (frag_len > msg_len - frag_off) {
3137 return -1;
3138 }
Hanno Becker44650b72018-08-16 12:51:11 +01003139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 if (frag_len + 12 > ssl->in_msglen) {
3141 return -1;
3142 }
Hanno Becker44650b72018-08-16 12:51:11 +01003143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003145}
3146
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003147/*
3148 * Mark bits in bitmask (used for DTLS HS reassembly)
3149 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003150static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003151{
3152 unsigned int start_bits, end_bits;
3153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 start_bits = 8 - (offset % 8);
3155 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003156 size_t first_byte_idx = offset / 8;
3157
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003158 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 if (len <= start_bits) {
3160 for (; len != 0; len--) {
3161 mask[first_byte_idx] |= 1 << (start_bits - len);
3162 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003163
3164 /* Avoid potential issues with offset or len becoming invalid */
3165 return;
3166 }
3167
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003168 offset += start_bits; /* Now offset % 8 == 0 */
3169 len -= start_bits;
3170
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 for (; start_bits != 0; start_bits--) {
3172 mask[first_byte_idx] |= 1 << (start_bits - 1);
3173 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003174 }
3175
3176 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (end_bits != 0) {
3178 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003179
3180 len -= end_bits; /* Now len % 8 == 0 */
3181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 for (; end_bits != 0; end_bits--) {
3183 mask[last_byte_idx] |= 1 << (8 - end_bits);
3184 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003185 }
3186
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003188}
3189
3190/*
3191 * Check that bitmask is full
3192 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003193MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003194static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003195{
3196 size_t i;
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 for (i = 0; i < len / 8; i++) {
3199 if (mask[i] != 0xFF) {
3200 return -1;
3201 }
3202 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 for (i = 0; i < len % 8; i++) {
3205 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3206 return -1;
3207 }
3208 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003211}
3212
Hanno Becker56e205e2018-08-16 09:06:12 +01003213/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003214static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3215 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003216{
Hanno Becker56e205e2018-08-16 09:06:12 +01003217 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003218
Hanno Becker56e205e2018-08-16 09:06:12 +01003219 alloc_len = 12; /* Handshake header */
3220 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003221
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 if (add_bitmap) {
3223 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 }
3226 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003227}
Hanno Becker56e205e2018-08-16 09:06:12 +01003228
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003232{
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 return (ssl->in_msg[1] << 16) |
3234 (ssl->in_msg[2] << 8) |
3235 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003236}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003239{
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3241 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3242 ssl->in_msglen));
3243 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003244 }
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003247
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3249 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3250 MBEDTLS_PRINTF_SIZET,
3251 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (ssl_check_hs_header(ssl) != 0) {
3259 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3260 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003261 }
3262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (ssl->handshake != NULL &&
3264 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3265 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3266 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3267 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3268 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3269 MBEDTLS_SSL_DEBUG_MSG(2,
3270 (
3271 "received future handshake message of sequence number %u (next %u)",
3272 recv_msg_seq,
3273 ssl->handshake->in_msg_seq));
3274 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003275 }
3276
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003277 /* Retransmit only on last message from previous flight, to avoid
3278 * too many retransmissions.
3279 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3281 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3282 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3283 "message_seq = %u, start_of_flight = %u",
3284 recv_msg_seq,
3285 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003286
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3288 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3289 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003290 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 } else {
3292 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3293 "message_seq = %u, expected = %u",
3294 recv_msg_seq,
3295 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003296 }
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003299 }
3300 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003301
Hanno Becker6d97ef52018-08-16 13:09:04 +01003302 /* Message reassembly is handled alongside buffering of future
3303 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003304 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003305 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3307 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3308 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003311#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003312 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 if (ssl->in_msglen < ssl->in_hslen) {
3314 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3315 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003316 }
3317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003319}
3320
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003321int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003322{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003324 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003327 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3328 if (ret != 0) {
3329 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3330 return ret;
3331 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003332 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003333
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003334 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3337 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003338 unsigned offset;
3339 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003340
Hanno Becker0271f962018-08-16 13:23:47 +01003341 /* Increment handshake sequence number */
3342 hs->in_msg_seq++;
3343
3344 /*
3345 * Clear up handshake buffering and reassembly structure.
3346 */
3347
3348 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003350
3351 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003353 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003355 *hs_buf = *(hs_buf + 1);
3356 }
3357
3358 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003360 }
3361#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003362 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003363}
3364
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003365/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003366 * DTLS anti-replay: RFC 6347 4.1.2.6
3367 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003368 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3369 * Bit n is set iff record number in_window_top - n has been seen.
3370 *
3371 * Usually, in_window_top is the last record number seen and the lsb of
3372 * in_window is set. The only exception is the initial state (record number 0
3373 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003376void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003377{
3378 ssl->in_window_top = 0;
3379 ssl->in_window = 0;
3380}
3381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003383{
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 return ((uint64_t) buf[0] << 40) |
3385 ((uint64_t) buf[1] << 32) |
3386 ((uint64_t) buf[2] << 24) |
3387 ((uint64_t) buf[3] << 16) |
3388 ((uint64_t) buf[4] << 8) |
3389 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003390}
3391
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003393static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003394{
Janos Follath865b3eb2019-12-16 11:46:15 +00003395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003396 unsigned char *original_in_ctr;
3397
3398 // save original in_ctr
3399 original_in_ctr = ssl->in_ctr;
3400
3401 // use counter from record
3402 ssl->in_ctr = record_in_ctr;
3403
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003405
3406 // restore the counter
3407 ssl->in_ctr = original_in_ctr;
3408
3409 return ret;
3410}
3411
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003412/*
3413 * Return 0 if sequence number is acceptable, -1 otherwise
3414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003415int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003416{
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003418 uint64_t bit;
3419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3421 return 0;
3422 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (rec_seqnum > ssl->in_window_top) {
3425 return 0;
3426 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003427
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003428 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 if (bit >= 64) {
3431 return -1;
3432 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003433
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3435 return -1;
3436 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003437
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003439}
3440
3441/*
3442 * Update replay window on new validated record
3443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003444void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003445{
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003449 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453 /* Update window_top and the contents of the window */
3454 uint64_t shift = rec_seqnum - ssl->in_window_top;
3455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003457 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003460 ssl->in_window |= 1;
3461 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462
3463 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003465 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003466 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003467
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003469 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003471 }
3472}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003474
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003475#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003476/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003477 * Check if a datagram looks like a ClientHello with a valid cookie,
3478 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003479 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003480 *
3481 * - if cookie is valid, return 0
3482 * - if ClientHello looks superficially valid but cookie is not,
3483 * fill obuf and set olen, then
3484 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3485 * - otherwise return a specific error code
3486 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003487MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003488MBEDTLS_STATIC_TESTABLE
3489int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 mbedtls_ssl_context *ssl,
3491 const unsigned char *cli_id, size_t cli_id_len,
3492 const unsigned char *in, size_t in_len,
3493 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003494{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003495 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003496 unsigned char *p;
3497
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003498 /*
3499 * Structure of ClientHello with record and handshake headers,
3500 * and expected values. We don't need to check a lot, more checks will be
3501 * done when actually parsing the ClientHello - skipping those checks
3502 * avoids code duplication and does not make cookie forging any easier.
3503 *
3504 * 0-0 ContentType type; copied, must be handshake
3505 * 1-2 ProtocolVersion version; copied
3506 * 3-4 uint16 epoch; copied, must be 0
3507 * 5-10 uint48 sequence_number; copied
3508 * 11-12 uint16 length; (ignored)
3509 *
3510 * 13-13 HandshakeType msg_type; (ignored)
3511 * 14-16 uint24 length; (ignored)
3512 * 17-18 uint16 message_seq; copied
3513 * 19-21 uint24 fragment_offset; copied, must be 0
3514 * 22-24 uint24 fragment_length; (ignored)
3515 *
3516 * 25-26 ProtocolVersion client_version; (ignored)
3517 * 27-58 Random random; (ignored)
3518 * 59-xx SessionID session_id; 1 byte len + sid_len content
3519 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3520 * ...
3521 *
3522 * Minimum length is 61 bytes.
3523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003524 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3525 (unsigned) in_len));
3526 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3527 if (in_len < 61) {
3528 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3529 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003530 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003531
Gilles Peskine449bd832023-01-11 14:50:10 +01003532 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3533 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003534
Gilles Peskine449bd832023-01-11 14:50:10 +01003535 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3536 fragment_offset != 0) {
3537 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3538 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3539 in[0], (unsigned) epoch,
3540 (unsigned) fragment_offset));
3541 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003542 }
3543
3544 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 if (59 + 1 + sid_len + 1 > in_len) {
3546 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3547 (unsigned) sid_len,
3548 (unsigned) in_len - 61));
3549 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003550 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003551 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3552 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003553
3554 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003555 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3556 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3557 (unsigned) cookie_len,
3558 (unsigned) (in_len - sid_len - 61)));
3559 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003560 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003561
Gilles Peskine449bd832023-01-11 14:50:10 +01003562 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3563 in + sid_len + 61, cookie_len);
3564 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3565 in + sid_len + 61, cookie_len,
3566 cli_id, cli_id_len) == 0) {
3567 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3568 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003569 }
3570
3571 /*
3572 * If we get here, we've got an invalid cookie, let's prepare HVR.
3573 *
3574 * 0-0 ContentType type; copied
3575 * 1-2 ProtocolVersion version; copied
3576 * 3-4 uint16 epoch; copied
3577 * 5-10 uint48 sequence_number; copied
3578 * 11-12 uint16 length; olen - 13
3579 *
3580 * 13-13 HandshakeType msg_type; hello_verify_request
3581 * 14-16 uint24 length; olen - 25
3582 * 17-18 uint16 message_seq; copied
3583 * 19-21 uint24 fragment_offset; copied
3584 * 22-24 uint24 fragment_length; olen - 25
3585 *
3586 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3587 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3588 *
3589 * Minimum length is 28.
3590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (buf_len < 28) {
3592 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3593 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003594
3595 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003596 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003597 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3598 obuf[25] = 0xfe;
3599 obuf[26] = 0xff;
3600
3601 /* Generate and write actual cookie */
3602 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003603 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3604 &p, obuf + buf_len,
3605 cli_id, cli_id_len) != 0) {
3606 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003607 }
3608
3609 *olen = p - obuf;
3610
3611 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003613
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3615 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3616 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003617
Gilles Peskine449bd832023-01-11 14:50:10 +01003618 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003619
Gilles Peskine449bd832023-01-11 14:50:10 +01003620 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003621}
3622
3623/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003624 * Handle possible client reconnect with the same UDP quadruplet
3625 * (RFC 6347 Section 4.2.8).
3626 *
3627 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3628 * that looks like a ClientHello.
3629 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003631 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003632 * - if the input looks like a ClientHello with a valid cookie,
3633 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003634 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003635 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003636 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003637 * This function is called (through ssl_check_client_reconnect()) when an
3638 * unexpected record is found in ssl_get_next_record(), which will discard the
3639 * record if we return 0, and bubble up the return value otherwise (this
3640 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3641 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003642 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003643MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003644static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003645{
Janos Follath865b3eb2019-12-16 11:46:15 +00003646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003647 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 if (ssl->conf->f_cookie_write == NULL ||
3650 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003651 /* If we can't use cookies to verify reachability of the peer,
3652 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3654 "can't check reconnect validity"));
3655 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003656 }
3657
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003658 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 ssl,
3660 ssl->cli_id, ssl->cli_id_len,
3661 ssl->in_buf, ssl->in_left,
3662 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003663
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003665
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003667 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3669 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3670 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003671 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003672 * If the error is permanent we'll catch it later,
3673 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3675 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003676 (void) send_ret;
3677
Gilles Peskine449bd832023-01-11 14:50:10 +01003678 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003679 }
3680
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 if (ret == 0) {
3682 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3683 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3684 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3685 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003686 }
3687
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003689 }
3690
Gilles Peskine449bd832023-01-11 14:50:10 +01003691 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003692}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003693#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003694
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003695MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003696static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003697{
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003699 record_type != MBEDTLS_SSL_MSG_ALERT &&
3700 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3702 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003703 }
3704
Gilles Peskine449bd832023-01-11 14:50:10 +01003705 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003706}
3707
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003708/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003709 * ContentType type;
3710 * ProtocolVersion version;
3711 * uint16 epoch; // DTLS only
3712 * uint48 sequence_number; // DTLS only
3713 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003714 *
3715 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003716 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003717 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3718 *
3719 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003720 * 1. proceed with the record if this function returns 0
3721 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3722 * 3. return CLIENT_RECONNECT if this function return that value
3723 * 4. drop the whole datagram if this function returns anything else.
3724 * Point 2 is needed when the peer is resending, and we have already received
3725 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003726 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003727MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003728static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3729 unsigned char *buf,
3730 size_t len,
3731 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003732{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003733 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003734
Hanno Beckere5e7e782019-07-11 12:29:35 +01003735 size_t const rec_hdr_type_offset = 0;
3736 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003737
Hanno Beckere5e7e782019-07-11 12:29:35 +01003738 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3739 rec_hdr_type_len;
3740 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003741
Hanno Beckere5e7e782019-07-11 12:29:35 +01003742 size_t const rec_hdr_ctr_len = 8;
3743#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003744 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003745 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3746 rec_hdr_version_len;
3747
Hanno Beckera0e20d02019-05-15 14:03:01 +01003748#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003749 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3750 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003751 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003752#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3753#endif /* MBEDTLS_SSL_PROTO_DTLS */
3754
3755 size_t rec_hdr_len_offset; /* To be determined */
3756 size_t const rec_hdr_len_len = 2;
3757
3758 /*
3759 * Check minimum lengths for record header.
3760 */
3761
3762#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003764 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003766#endif /* MBEDTLS_SSL_PROTO_DTLS */
3767 {
3768 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3769 }
3770
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3772 MBEDTLS_SSL_DEBUG_MSG(1,
3773 (
3774 "datagram of length %u too small to hold DTLS record header of length %u",
3775 (unsigned) len,
3776 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3777 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003778 }
3779
3780 /*
3781 * Parse and validate record content type
3782 */
3783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003785
3786 /* Check record content type */
3787#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3788 rec->cid_len = 0;
3789
Gilles Peskine449bd832023-01-11 14:50:10 +01003790 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003791 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003792 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003793 /* Shift pointers to account for record header including CID
3794 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003795 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003796 * ProtocolVersion version;
3797 * uint16 epoch;
3798 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003799 * opaque cid[cid_length]; // Additional field compared to
3800 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003801 * uint16 length;
3802 * opaque enc_content[DTLSCiphertext.length];
3803 * } DTLSCiphertext;
3804 */
3805
3806 /* So far, we only support static CID lengths
3807 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003808 rec_hdr_cid_len = ssl->conf->cid_len;
3809 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003810
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3812 MBEDTLS_SSL_DEBUG_MSG(1,
3813 (
3814 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3815 (unsigned) len,
3816 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3817 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003818 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003819
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003820 /* configured CID len is guaranteed at most 255, see
3821 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3822 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3824 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003826 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 if (ssl_check_record_type(rec->type)) {
3828 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3829 (unsigned) rec->type));
3830 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003831 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003832 }
3833
Hanno Beckere5e7e782019-07-11 12:29:35 +01003834 /*
3835 * Parse and validate record version
3836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3838 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003839 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3840 buf + rec_hdr_version_offset,
3841 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003842
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 if (tls_version > ssl->conf->max_tls_version) {
3844 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3845 (unsigned) tls_version,
3846 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003847
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003849 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003850 /*
3851 * Parse/Copy record sequence number.
3852 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003853
Hanno Beckere5e7e782019-07-11 12:29:35 +01003854#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003856 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3858 rec_hdr_ctr_len);
3859 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003860#endif /* MBEDTLS_SSL_PROTO_DTLS */
3861 {
3862 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003864 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003865
Hanno Beckere5e7e782019-07-11 12:29:35 +01003866 /*
3867 * Parse record length.
3868 */
3869
Hanno Beckere5e7e782019-07-11 12:29:35 +01003870 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003871 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3872 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3873 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003874
Gilles Peskine449bd832023-01-11 14:50:10 +01003875 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3876 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3877 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003878
3879 rec->buf = buf;
3880 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003881
Gilles Peskine449bd832023-01-11 14:50:10 +01003882 if (rec->data_len == 0) {
3883 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3884 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003885
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003886 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003887 * DTLS-related tests.
3888 * Check epoch before checking length constraint because
3889 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3890 * message gets duplicated before the corresponding Finished message,
3891 * the second ChangeCipherSpec should be discarded because it belongs
3892 * to an old epoch, but not because its length is shorter than
3893 * the minimum record length for packets using the new record transform.
3894 * Note that these two kinds of failures are handled differently,
3895 * as an unexpected record is silently skipped but an invalid
3896 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003897 */
3898#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3900 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003901
Hanno Becker955a5c92019-07-10 17:12:07 +01003902 /* Check that the datagram is large enough to contain a record
3903 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (len < rec->data_offset + rec->data_len) {
3905 MBEDTLS_SSL_DEBUG_MSG(1,
3906 (
3907 "Datagram of length %u too small to contain record of advertised length %u.",
3908 (unsigned) len,
3909 (unsigned) (rec->data_offset + rec->data_len)));
3910 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003911 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003912
Hanno Becker37cfe732019-07-10 17:20:01 +01003913 /* Records from other, non-matching epochs are silently discarded.
3914 * (The case of same-port Client reconnects must be considered in
3915 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 if (rec_epoch != ssl->in_epoch) {
3917 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3918 "expected %u, received %lu",
3919 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003920
Hanno Becker552f7472019-07-19 10:59:12 +01003921 /* Records from the next epoch are considered for buffering
3922 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3924 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3925 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003926 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003927
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003929 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003930#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003931 /* For records from the correct epoch, check whether their
3932 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3934 &rec->ctr[0]) != 0) {
3935 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3936 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003937 }
3938#endif
3939 }
3940#endif /* MBEDTLS_SSL_PROTO_DTLS */
3941
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003943}
Paul Bakker5121ce52009-01-03 21:22:43 +00003944
Paul Bakker5121ce52009-01-03 21:22:43 +00003945
Hanno Becker2fddd372019-07-10 14:37:41 +01003946#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003947MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003948static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003949{
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003951
3952 /*
3953 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3954 * access the first byte of record content (handshake type), as we
3955 * have an active transform (possibly iv_len != 0), so use the
3956 * fact that the record header len is 13 instead.
3957 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003959 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003961 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3962 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3964 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3965 "from the same port"));
3966 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003967 }
3968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003970}
Hanno Becker2fddd372019-07-10 14:37:41 +01003971#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003972
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003973/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003974 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003975 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003976MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003977static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3978 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003979{
3980 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003981
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3983 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003984
Ronald Cron7e38cba2021-11-24 12:43:39 +01003985 /*
3986 * In TLS 1.3, always treat ChangeCipherSpec records
3987 * as unencrypted. The only thing we do with them is
3988 * check the length and content and ignore them.
3989 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003990#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (ssl->transform_in != NULL &&
3992 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3993 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003994 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003996 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003997#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01004000 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
4003 rec)) != 0) {
4004 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01004005
Hanno Beckera0e20d02019-05-15 14:03:01 +01004006#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004008 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4010 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004011 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004012 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004013#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004016 }
4017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (old_msg_type != rec->type) {
4019 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4020 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004021 }
4022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4024 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004025
Hanno Beckera0e20d02019-05-15 14:03:01 +01004026#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004027 /* We have already checked the record content type
4028 * in ssl_parse_record_header(), failing or silently
4029 * dropping the record in the case of an unknown type.
4030 *
4031 * Since with the use of CIDs, the record content type
4032 * might change during decryption, re-check the record
4033 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl_check_record_type(rec->type)) {
4035 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4036 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004037 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004038#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004039
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004041#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4043 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004044 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4046 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004047 }
4048#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4049
4050 ssl->nb_zero++;
4051
4052 /*
4053 * Three or more empty messages may be a DoS attack
4054 * (excessive CPU consumption).
4055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 if (ssl->nb_zero > 3) {
4057 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4058 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004059 /* Treat the records as if they were not properly authenticated,
4060 * thereby failing the connection if we see more than allowed
4061 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004063 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004065 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004067
4068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004070 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004072#endif
4073 {
4074 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4076 i > mbedtls_ssl_ep_len(ssl); i--) {
4077 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004078 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004080 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004081
4082 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (i == mbedtls_ssl_ep_len(ssl)) {
4084 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4085 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004086 }
4087 }
4088
Paul Bakker5121ce52009-01-03 21:22:43 +00004089 }
4090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004091#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4093 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004094 }
4095#endif
4096
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004097 /* Check actual (decrypted) record content length against
4098 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4100 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4101 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004102 }
4103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004105}
4106
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004107/*
4108 * Read a record.
4109 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004110 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4111 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4112 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004113 */
Hanno Becker1097b342018-08-15 14:09:41 +01004114
4115/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004116MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004117static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004118MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004119static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004121static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4124 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004125{
Janos Follath865b3eb2019-12-16 11:46:15 +00004126 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004129
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004131 do {
Simon Butcher99000142016-10-13 17:21:01 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 ret = ssl_consume_current_message(ssl);
4134 if (ret != 0) {
4135 return ret;
4136 }
Hanno Becker26994592018-08-15 14:14:59 +01004137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004139 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004140#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004141
Hanno Becker40f50842018-08-15 14:48:01 +01004142 /* We only check for buffered messages if the
4143 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4145 ssl_next_record_is_in_datagram(ssl) == 0) {
4146 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004147 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 }
Hanno Becker40f50842018-08-15 14:48:01 +01004149 }
4150
Hanno Becker40f50842018-08-15 14:48:01 +01004151#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (dtls_have_buffered == 0) {
4153 ret = ssl_get_next_record(ssl);
4154 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004155 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 }
Hanno Becker40f50842018-08-15 14:48:01 +01004157
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (ret != 0) {
4159 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4160 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004161 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004162 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004163 }
4164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004166
Hanno Becker40f50842018-08-15 14:48:01 +01004167#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004169 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 ret = ssl_buffer_message(ssl);
4171 if (ret != 0) {
4172 return ret;
4173 }
Hanno Becker40f50842018-08-15 14:48:01 +01004174
4175 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4176 }
4177#endif /* MBEDTLS_SSL_PROTO_DTLS */
4178
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4180 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (0 != ret) {
4183 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4184 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004185 }
4186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4188 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004189 ret = mbedtls_ssl_update_handshake_status(ssl);
4190 if (0 != ret) {
4191 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4192 return ret;
4193 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004194 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 } else {
4196 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004197 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004198 }
4199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004203}
4204
Hanno Becker40f50842018-08-15 14:48:01 +01004205#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004206MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004207static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004208{
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (ssl->in_left > ssl->next_record_offset) {
4210 return 1;
4211 }
Simon Butcher99000142016-10-13 17:21:01 +01004212
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004214}
4215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004217static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004218{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004219 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004221 int ret = 0;
4222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (hs == NULL) {
4224 return -1;
4225 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004226
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4230 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004231 /* Check if we have seen a ChangeCipherSpec before.
4232 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (!hs->buffering.seen_ccs) {
4234 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004235 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004236 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004237 }
4238
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004240 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4241 ssl->in_msglen = 1;
4242 ssl->in_msg[0] = 1;
4243
4244 /* As long as they are equal, the exact value doesn't matter. */
4245 ssl->in_left = 0;
4246 ssl->next_record_offset = 0;
4247
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004248 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004249 goto exit;
4250 }
Hanno Becker37f95322018-08-16 13:55:32 +01004251
Hanno Beckerb8f50142018-08-28 10:01:34 +01004252#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004253 /* Debug only */
4254 {
4255 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004257 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 if (hs_buf->is_valid == 1) {
4259 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4260 hs->in_msg_seq + offset,
4261 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004262 }
4263 }
4264 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004265#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004266
4267 /* Check if we have buffered and/or fully reassembled the
4268 * next handshake message. */
4269 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004271 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 size_t msg_len = (hs_buf->data[1] << 16) |
4273 (hs_buf->data[2] << 8) |
4274 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004275
4276 /* Double-check that we haven't accidentally buffered
4277 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4279 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4280 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004281 }
4282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4284 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4285 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004286
4287 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4288 ssl->in_hslen = msg_len + 12;
4289 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004291
4292 ret = 0;
4293 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 } else {
4295 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4296 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004297 }
4298
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004299 ret = -1;
4300
4301exit:
4302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4304 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004305}
4306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004308static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4309 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004310{
4311 int offset;
4312 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4314 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004315
Hanno Becker01315ea2018-08-21 17:22:17 +01004316 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004318
4319 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4321 hs->buffering.total_bytes_buffered)) {
4322 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4323 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004324 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004325
Hanno Becker4f432ad2018-08-28 10:02:32 +01004326 /* We don't have enough space to buffer the next expected handshake
4327 * message. Remove buffers used for future messages to gain space,
4328 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4330 offset >= 0; offset--) {
4331 MBEDTLS_SSL_DEBUG_MSG(2,
4332 (
4333 "Free buffering slot %d to make space for reassembly of next handshake message",
4334 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004337
4338 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4340 hs->buffering.total_bytes_buffered)) {
4341 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4342 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004343 }
4344 }
4345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004347}
4348
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004349MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004350static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004351{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004352 int ret = 0;
4353 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (hs == NULL) {
4356 return 0;
4357 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004360
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004362 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004364
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004365 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004366 break;
4367
4368 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004369 {
4370 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004372 mbedtls_ssl_hs_buffer *hs_buf;
4373 size_t msg_len = ssl->in_hslen - 12;
4374
4375 /* We should never receive an old handshake
4376 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4378 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4379 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004380 }
4381
4382 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004384 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 MBEDTLS_SSL_DEBUG_MSG(2,
4386 ("Ignore future HS message with sequence number %u, "
4387 "buffering window %u - %u",
4388 recv_msg_seq, ssl->handshake->in_msg_seq,
4389 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4390 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004391
4392 goto exit;
4393 }
4394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4396 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004399
4400 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004402 size_t reassembly_buf_sz;
4403
Hanno Becker37f95322018-08-16 13:55:32 +01004404 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004406
4407 /* We copy the message back into the input buffer
4408 * after reassembly, so check that it's not too large.
4409 * This is an implementation-specific limitation
4410 * and not one from the standard, hence it is not
4411 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004413 /* Ignore message */
4414 goto exit;
4415 }
4416
Hanno Beckere0b150f2018-08-21 15:51:03 +01004417 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (hs->buffering.total_bytes_buffered >
4419 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4420 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4421 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004422 }
4423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4425 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4428 hs->buffering.total_bytes_buffered)) {
4429 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004430 /* If we can't buffer a future message because
4431 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 MBEDTLS_SSL_DEBUG_MSG(2,
4433 ("Buffering of future message of size %"
4434 MBEDTLS_PRINTF_SIZET
4435 " would exceed the compile-time limit %"
4436 MBEDTLS_PRINTF_SIZET
4437 " (already %" MBEDTLS_PRINTF_SIZET
4438 " bytes buffered) -- ignore\n",
4439 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4440 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004441 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 } else {
4443 MBEDTLS_SSL_DEBUG_MSG(2,
4444 ("Buffering of future message of size %"
4445 MBEDTLS_PRINTF_SIZET
4446 " would exceed the compile-time limit %"
4447 MBEDTLS_PRINTF_SIZET
4448 " (already %" MBEDTLS_PRINTF_SIZET
4449 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4450 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4451 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004452 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4455 MBEDTLS_SSL_DEBUG_MSG(2,
4456 ("Reassembly of next message of size %"
4457 MBEDTLS_PRINTF_SIZET
4458 " (%" MBEDTLS_PRINTF_SIZET
4459 " with bitmap) would exceed"
4460 " the compile-time limit %"
4461 MBEDTLS_PRINTF_SIZET
4462 " (already %" MBEDTLS_PRINTF_SIZET
4463 " bytes buffered) -- fail\n",
4464 msg_len,
4465 reassembly_buf_sz,
4466 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4467 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004468 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4469 goto exit;
4470 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004471 }
4472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 MBEDTLS_SSL_DEBUG_MSG(2,
4474 ("initialize reassembly, total length = %"
4475 MBEDTLS_PRINTF_SIZET,
4476 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4479 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004480 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004481 goto exit;
4482 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004483 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004484
4485 /* Prepare final header: copy msg_type, length and message_seq,
4486 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 memcpy(hs_buf->data, ssl->in_msg, 6);
4488 memset(hs_buf->data + 6, 0, 3);
4489 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004490
4491 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004492
4493 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004495 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4497 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004498 /* Ignore */
4499 goto exit;
4500 }
4501 }
4502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004504 size_t frag_len, frag_off;
4505 unsigned char * const msg = hs_buf->data + 12;
4506
4507 /*
4508 * Check and copy current fragment
4509 */
4510
4511 /* Validation of header fields already done in
4512 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 frag_off = ssl_get_hs_frag_off(ssl);
4514 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4517 ", length = %" MBEDTLS_PRINTF_SIZET,
4518 frag_off, frag_len));
4519 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004522 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 ssl_bitmask_set(bitmask, frag_off, frag_len);
4524 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4525 msg_len) == 0);
4526 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004527 hs_buf->is_complete = 1;
4528 }
4529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4531 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004532 }
4533
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004534 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004535 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004536
4537 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004538 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004539 break;
4540 }
4541
4542exit:
4543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4545 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004546}
4547#endif /* MBEDTLS_SSL_PROTO_DTLS */
4548
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004549MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004550static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004551{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004552 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004553 * Consume last content-layer message and potentially
4554 * update in_msglen which keeps track of the contents'
4555 * consumption state.
4556 *
4557 * (1) Handshake messages:
4558 * Remove last handshake message, move content
4559 * and adapt in_msglen.
4560 *
4561 * (2) Alert messages:
4562 * Consume whole record content, in_msglen = 0.
4563 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004564 * (3) Change cipher spec:
4565 * Consume whole record content, in_msglen = 0.
4566 *
4567 * (4) Application data:
4568 * Don't do anything - the record layer provides
4569 * the application data as a stream transport
4570 * and consumes through mbedtls_ssl_read only.
4571 *
4572 */
4573
4574 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004576 /* Hard assertion to be sure that no application data
4577 * is in flight, as corrupting ssl->in_msglen during
4578 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl->in_offt != NULL) {
4580 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4581 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004582 }
4583
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004584 /*
4585 * Get next Handshake message in the current record
4586 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004587
Hanno Becker4a810fb2017-05-24 16:27:30 +01004588 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004589 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004590 * current handshake content: If DTLS handshake
4591 * fragmentation is used, that's the fragment
4592 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004593 * size here is faulty and should be changed at
4594 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004595 * (2) While it doesn't seem to cause problems, one
4596 * has to be very careful not to assume that in_hslen
4597 * is always <= in_msglen in a sensible communication.
4598 * Again, it's wrong for DTLS handshake fragmentation.
4599 * The following check is therefore mandatory, and
4600 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004601 * Additionally, ssl->in_hslen might be arbitrarily out of
4602 * bounds after handling a DTLS message with an unexpected
4603 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004606 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4608 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004609
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4611 ssl->in_msg, ssl->in_msglen);
4612 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004613 ssl->in_msglen = 0;
4614 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004615
Hanno Becker4a810fb2017-05-24 16:27:30 +01004616 ssl->in_hslen = 0;
4617 }
4618 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 else if (ssl->in_offt != NULL) {
4620 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004621 }
4622 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004624 ssl->in_msglen = 0;
4625 }
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004628}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004629
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004630MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004631static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004632{
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (ssl->in_msglen > 0) {
4634 return 1;
4635 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004638}
4639
Hanno Becker5f066e72018-08-16 14:56:31 +01004640#if defined(MBEDTLS_SSL_PROTO_DTLS)
4641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004643{
4644 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004646 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004650 hs->buffering.total_bytes_buffered -=
4651 hs->buffering.future_record.len;
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004654 hs->buffering.future_record.data = NULL;
4655 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004656}
4657
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004658MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004659static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004660{
4661 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004663 size_t rec_len;
4664 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004665#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4666 size_t in_buf_len = ssl->in_buf_len;
4667#else
4668 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4669#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4671 return 0;
4672 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if (hs == NULL) {
4675 return 0;
4676 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004677
Hanno Becker5f066e72018-08-16 14:56:31 +01004678 rec = hs->buffering.future_record.data;
4679 rec_len = hs->buffering.future_record.len;
4680 rec_epoch = hs->buffering.future_record.epoch;
4681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (rec == NULL) {
4683 return 0;
4684 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004685
Hanno Becker4cb782d2018-08-20 11:19:05 +01004686 /* Only consider loading future records if the
4687 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4689 return 0;
4690 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (rec_epoch != ssl->in_epoch) {
4695 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004696 goto exit;
4697 }
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004700
4701 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4703 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004705 }
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004708 ssl->in_left = rec_len;
4709 ssl->next_record_offset = 0;
4710
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004712
4713exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4715 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004716}
4717
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004719static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4720 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004721{
4722 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004723
4724 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (hs == NULL) {
4726 return 0;
4727 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004728
4729 /* Only buffer handshake records (we are only interested
4730 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4732 return 0;
4733 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004734
4735 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (hs->buffering.future_record.data != NULL) {
4737 return 0;
4738 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004739
Hanno Becker01315ea2018-08-21 17:22:17 +01004740 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4742 hs->buffering.total_bytes_buffered)) {
4743 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4744 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4745 " (already %" MBEDTLS_PRINTF_SIZET
4746 " bytes buffered) -- ignore\n",
4747 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4748 hs->buffering.total_bytes_buffered));
4749 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004750 }
4751
Hanno Becker5f066e72018-08-16 14:56:31 +01004752 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4754 ssl->in_epoch + 1U));
4755 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004756
4757 /* ssl_parse_record_header() only considers records
4758 * of the next epoch as candidates for buffering. */
4759 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004760 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004761
4762 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 mbedtls_calloc(1, hs->buffering.future_record.len);
4764 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004765 /* If we run out of RAM trying to buffer a
4766 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004768 }
4769
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004771
Hanno Becker519f15d2019-07-11 12:43:20 +01004772 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004774}
4775
4776#endif /* MBEDTLS_SSL_PROTO_DTLS */
4777
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004778MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004779static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004780{
Janos Follath865b3eb2019-12-16 11:46:15 +00004781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004782 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004783
Hanno Becker5f066e72018-08-16 14:56:31 +01004784#if defined(MBEDTLS_SSL_PROTO_DTLS)
4785 /* We might have buffered a future record; if so,
4786 * and if the epoch matches now, load it.
4787 * On success, this call will set ssl->in_left to
4788 * the length of the buffered record, so that
4789 * the calls to ssl_fetch_input() below will
4790 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 ret = ssl_load_buffered_record(ssl);
4792 if (ret != 0) {
4793 return ret;
4794 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004795#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004796
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004797 /* Ensure that we have enough space available for the default form
4798 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4799 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4801 if (ret != 0) {
4802 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4803 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004804 }
4805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4807 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004808#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4810 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4811 ret = ssl_buffer_future_record(ssl, &rec);
4812 if (ret != 0) {
4813 return ret;
4814 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004815
4816 /* Fall through to handling of unexpected records */
4817 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4818 }
4819
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004821#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004822 /* Reset in pointers to default state for TLS/DTLS records,
4823 * assuming no CID and no offset between record content and
4824 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004826
Hanno Becker7ae20e02019-07-12 08:33:49 +01004827 /* Setup internal message pointers from record structure. */
4828 ssl->in_msgtype = rec.type;
4829#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4830 ssl->in_len = ssl->in_cid + rec.cid_len;
4831#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4832 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4833 ssl->in_msglen = rec.data_len;
4834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 ret = ssl_check_client_reconnect(ssl);
4836 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4837 if (ret != 0) {
4838 return ret;
4839 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004840#endif
4841
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004842 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004843 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4846 "(header)"));
4847 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004848 /* Skip invalid record and the rest of the datagram */
4849 ssl->next_record_offset = 0;
4850 ssl->in_left = 0;
4851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4853 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004854 }
4855
4856 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4858 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004859#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004860 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004862 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004863 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004865#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004867 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004868 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (ssl->next_record_offset < ssl->in_left) {
4870 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004871 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004873#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004874 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004875 /*
4876 * Fetch record contents from underlying transport.
4877 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4879 if (ret != 0) {
4880 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4881 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004882 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004883
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004884 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004885 }
4886
4887 /*
4888 * Decrypt record contents.
4889 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004892#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004894 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004896 /* Except when waiting for Finished as a bad mac here
4897 * probably means something went wrong in the handshake
4898 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4900 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004901#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4903 mbedtls_ssl_send_alert_message(ssl,
4904 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4905 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004906 }
4907#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004909 }
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (ssl->conf->badmac_limit != 0 &&
4912 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4913 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4914 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004915 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004916
Hanno Becker4a810fb2017-05-24 16:27:30 +01004917 /* As above, invalid records cause
4918 * dismissal of the whole datagram. */
4919
4920 ssl->next_record_offset = 0;
4921 ssl->in_left = 0;
4922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4924 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004925 }
4926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 return ret;
4928 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004929#endif
4930 {
4931 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004932#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4934 mbedtls_ssl_send_alert_message(ssl,
4935 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4936 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004937 }
4938#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004940 }
4941 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004942
Hanno Becker44d89b22019-07-12 09:40:44 +01004943
4944 /* Reset in pointers to default state for TLS/DTLS records,
4945 * assuming no CID and no offset between record content and
4946 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004948#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4949 ssl->in_len = ssl->in_cid + rec.cid_len;
4950#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004951 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004952
Hanno Becker8685c822019-07-12 09:37:30 +01004953 /* The record content type may change during decryption,
4954 * so re-read it. */
4955 ssl->in_msgtype = rec.type;
4956 /* Also update the input buffer, because unfortunately
4957 * the server-side ssl_parse_client_hello() reparses the
4958 * record header when receiving a ClientHello initiating
4959 * a renegotiation. */
4960 ssl->in_hdr[0] = rec.type;
4961 ssl->in_msg = rec.buf + rec.data_offset;
4962 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004966}
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004969{
Janos Follath865b3eb2019-12-16 11:46:15 +00004970 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004971
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004972 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004973 * Handle particular types of records
4974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4976 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4977 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004978 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004979 }
4980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4982 if (ssl->in_msglen != 1) {
4983 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4984 ssl->in_msglen));
4985 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004986 }
4987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if (ssl->in_msg[0] != 1) {
4989 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4990 ssl->in_msg[0]));
4991 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004992 }
4993
4994#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004996 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4998 if (ssl->handshake == NULL) {
4999 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
5000 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005001 }
5002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
5004 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005005 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005006#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005007
Ronald Cron6f135e12021-12-08 16:57:54 +01005008#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005010#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 MBEDTLS_SSL_DEBUG_MSG(1,
5012 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5013 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005014#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 MBEDTLS_SSL_DEBUG_MSG(1,
5016 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5017 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005018#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5019 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005020#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005021 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5024 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005025 /* Note: Standard allows for more than one 2 byte alert
5026 to be packed in a single message, but Mbed TLS doesn't
5027 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5029 ssl->in_msglen));
5030 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005031 }
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5034 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005035
5036 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005037 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5040 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5041 ssl->in_msg[1]));
5042 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005043 }
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5046 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5047 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5048 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005049 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005050
5051#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5053 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5054 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005055 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005057 }
5058#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005059 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005060 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005061 }
5062
Hanno Beckerc76c6192017-06-06 10:03:17 +01005063#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005065 /* Drop unexpected ApplicationData records,
5066 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5068 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005069#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5071 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005072#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 ) {
5074 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5075 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005076 }
5077
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ssl->handshake != NULL &&
5079 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5080 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005081 }
5082 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005083#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005084
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005086}
5087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005089{
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 return mbedtls_ssl_send_alert_message(ssl,
5091 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5092 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005093}
5094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5096 unsigned char level,
5097 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005098{
Janos Follath865b3eb2019-12-16 11:46:15 +00005099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 if (ssl == NULL || ssl->conf == NULL) {
5102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5103 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (ssl->out_left != 0) {
5106 return mbedtls_ssl_flush_output(ssl);
5107 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5110 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005113 ssl->out_msglen = 2;
5114 ssl->out_msg[0] = level;
5115 ssl->out_msg[1] = message;
5116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5119 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005120 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005124}
5125
Gilles Peskine449bd832023-01-11 14:50:10 +01005126int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005127{
Janos Follath865b3eb2019-12-16 11:46:15 +00005128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005133 ssl->out_msglen = 1;
5134 ssl->out_msg[0] = 1;
5135
Paul Bakker5121ce52009-01-03 21:22:43 +00005136 ssl->state++;
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5139 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5140 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005141 }
5142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005144
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005146}
5147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005149{
Janos Follath865b3eb2019-12-16 11:46:15 +00005150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005153
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5155 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5156 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005157 }
5158
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5160 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5161 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5162 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5163 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005164 }
5165
Hanno Beckere678eaa2018-08-21 14:57:46 +01005166 /* CCS records are only accepted if they have length 1 and content '1',
5167 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005168
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005169 /*
5170 * Switch to our negotiated transform and session parameters for inbound
5171 * data.
5172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005174#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005175 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005176#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005177 ssl->session_in = ssl->session_negotiate;
5178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005179#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005183#endif
5184
5185 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (++ssl->in_epoch == 0) {
5187 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005188 /* This is highly unlikely to happen for legitimate reasons, so
5189 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005195
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005197
Paul Bakker5121ce52009-01-03 21:22:43 +00005198 ssl->state++;
5199
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005203}
5204
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005205/* Once ssl->out_hdr as the address of the beginning of the
5206 * next outgoing record is set, deduce the other pointers.
5207 *
5208 * Note: For TLS, we save the implicit record sequence number
5209 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5210 * and the caller has to make sure there's space for this.
5211 */
5212
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005213static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005215{
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005217}
5218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5220 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005221{
5222#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005224 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005225#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005226 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005227 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005229 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005231#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005232 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005233#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005234 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005236#endif
5237 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005238 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005239#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005240 ssl->out_cid = ssl->out_len;
5241#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005242 ssl->out_iv = ssl->out_hdr + 5;
5243 }
5244
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005245 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005246 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (transform != NULL) {
5248 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5249 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005250}
5251
5252/* Once ssl->in_hdr as the address of the beginning of the
5253 * next incoming record is set, deduce the other pointers.
5254 *
5255 * Note: For TLS, we save the implicit record sequence number
5256 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5257 * and the caller has to make sure there's space for this.
5258 */
5259
Gilles Peskine449bd832023-01-11 14:50:10 +01005260void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005261{
Hanno Becker79594fd2019-05-08 09:38:41 +01005262 /* This function sets the pointers to match the case
5263 * of unprotected TLS/DTLS records, with both ssl->in_iv
5264 * and ssl->in_msg pointing to the beginning of the record
5265 * content.
5266 *
5267 * When decrypting a protected record, ssl->in_msg
5268 * will be shifted to point to the beginning of the
5269 * record plaintext.
5270 */
5271
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005272#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005274 /* This sets the header pointers to match records
5275 * without CID. When we receive a record containing
5276 * a CID, the fields are shifted accordingly in
5277 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005278 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005279#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005280 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005281 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005282#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005283 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005284#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005285 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005287#endif
5288 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005289 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005290 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005291#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005292 ssl->in_cid = ssl->in_len;
5293#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005294 ssl->in_iv = ssl->in_hdr + 5;
5295 }
5296
Hanno Becker79594fd2019-05-08 09:38:41 +01005297 /* This will be adjusted at record decryption time. */
5298 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005299}
5300
Paul Bakker5121ce52009-01-03 21:22:43 +00005301/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005302 * Setup an SSL context
5303 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005306{
5307 /* Set the incoming and outgoing record pointers. */
5308#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005310 ssl->out_hdr = ssl->out_buf;
5311 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005313#endif /* MBEDTLS_SSL_PROTO_DTLS */
5314 {
Hanno Becker12078f42021-03-02 15:28:41 +00005315 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005316 ssl->out_hdr = ssl->out_buf + 8;
5317 ssl->in_hdr = ssl->in_buf + 8;
5318 }
5319
5320 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5322 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005323}
5324
Paul Bakker5121ce52009-01-03 21:22:43 +00005325/*
5326 * SSL get accessors
5327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005328size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005329{
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005331}
5332
Gilles Peskine449bd832023-01-11 14:50:10 +01005333int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005334{
5335 /*
5336 * Case A: We're currently holding back
5337 * a message for further processing.
5338 */
5339
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (ssl->keep_current_message == 1) {
5341 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5342 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005343 }
5344
5345 /*
5346 * Case B: Further records are pending in the current datagram.
5347 */
5348
5349#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5351 ssl->in_left > ssl->next_record_offset) {
5352 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5353 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005354 }
5355#endif /* MBEDTLS_SSL_PROTO_DTLS */
5356
5357 /*
5358 * Case C: A handshake message is being processed.
5359 */
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5362 MBEDTLS_SSL_DEBUG_MSG(3,
5363 ("ssl_check_pending: more handshake messages within current record"));
5364 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005365 }
5366
5367 /*
5368 * Case D: An application data message is being processed
5369 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 if (ssl->in_offt != NULL) {
5371 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5372 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005373 }
5374
5375 /*
5376 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005377 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005378 * we implement support for multiple alerts in single records.
5379 */
5380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5382 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005383}
5384
Paul Bakker43ca69c2011-01-15 17:35:19 +00005385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005387{
Hanno Becker3136ede2018-08-17 15:28:19 +01005388 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005389 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005390 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005391#if defined(MBEDTLS_USE_PSA_CRYPTO)
5392 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5393 psa_key_type_t key_type;
5394#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005395
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (transform == NULL) {
5399 return (int) out_hdr_len;
5400 }
Hanno Becker78640902018-08-13 16:35:15 +01005401
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005402
5403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (transform->psa_alg == PSA_ALG_GCM ||
5405 transform->psa_alg == PSA_ALG_CCM ||
5406 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5407 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5408 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005409 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5411 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5412 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005413
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005415
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005416 /* Expansion due to the addition of the MAC. */
5417 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005418
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005419 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005420 * Theoretically up to 256 bytes, but we never use
5421 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005422 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005423
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005424 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005425 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005426#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005427 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005428#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 } else {
5430 MBEDTLS_SSL_DEBUG_MSG(1,
5431 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5432 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005433 }
5434#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 case MBEDTLS_MODE_GCM:
5437 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005438 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005440 transform_expansion = transform->minlen;
5441 break;
5442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005444
5445 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005447
Hanno Becker3136ede2018-08-17 15:28:19 +01005448 /* Expansion due to the addition of the MAC. */
5449 transform_expansion += transform->maclen;
5450
5451 /* Expansion due to the addition of CBC padding;
5452 * Theoretically up to 256 bytes, but we never use
5453 * more than the block size of the underlying cipher. */
5454 transform_expansion += block_size;
5455
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005456 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005457 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005458#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005459 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005460#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005461
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005462 break;
5463
5464 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5466 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005467 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005468#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005469
Hanno Beckera0e20d02019-05-15 14:03:01 +01005470#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005472 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005474#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005475
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005477}
5478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005480/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005481 * Check record counters and renegotiate if they're above the limit.
5482 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005483MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005484static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005485{
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005487 int in_ctr_cmp;
5488 int out_ctr_cmp;
5489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5493 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005494 }
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5497 &ssl->conf->renego_period[ep_len],
5498 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5499 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005500 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005502
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5504 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005505 }
5506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5508 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005509}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005511
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005512#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5513
5514#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005516static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005517{
5518
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5520 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5521 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005522 }
5523
5524 ssl->keep_current_message = 1;
5525
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5527 mbedtls_ssl_handshake_set_state(ssl,
5528 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005531}
5532#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5533
Jerry Yua0446a02022-07-13 11:22:55 +08005534MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005535static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005536{
5537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005539
5540#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5542 int ret = ssl_tls13_check_new_session_ticket(ssl);
5543 if (ret != 0) {
5544 return ret;
5545 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005546 }
5547#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5548
5549 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005551}
5552#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5553
5554#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005555/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005556 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005557 * may only be sent for the purpose of initiating renegotiations.
5558 *
5559 * This function is introduced as a separate helper since the handling
5560 * of post-handshake handshake messages changes significantly in TLS 1.3,
5561 * and having a helper function allows to distinguish between TLS <= 1.2 and
5562 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5563 */
Jerry Yua0446a02022-07-13 11:22:55 +08005564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005565static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005566{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005567 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005568
5569 /*
5570 * - For client-side, expect SERVER_HELLO_REQUEST.
5571 * - For server-side, expect CLIENT_HELLO.
5572 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5573 */
5574
5575#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5577 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5578 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5579 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005580
5581 /* With DTLS, drop the packet (probably from last handshake) */
5582#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5584 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005585 }
5586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005588 }
5589#endif /* MBEDTLS_SSL_CLI_C */
5590
5591#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5593 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5594 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005595
5596 /* With DTLS, drop the packet (probably from last handshake) */
5597#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5599 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005600 }
5601#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005603 }
5604#endif /* MBEDTLS_SSL_SRV_C */
5605
5606#if defined(MBEDTLS_SSL_RENEGOTIATION)
5607 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5609 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5610 ssl->conf->allow_legacy_renegotiation ==
5611 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005612 /*
5613 * Accept renegotiation request
5614 */
5615
5616 /* DTLS clients need to know renego is server-initiated */
5617#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5619 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005620 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5621 }
5622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 ret = mbedtls_ssl_start_renegotiation(ssl);
5624 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5625 ret != 0) {
5626 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5627 ret);
5628 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005629 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005631#endif /* MBEDTLS_SSL_RENEGOTIATION */
5632 {
5633 /*
5634 * Refuse renegotiation
5635 */
5636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005638
Gilles Peskine449bd832023-01-11 14:50:10 +01005639 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5640 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5641 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5642 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005643 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005644 }
5645
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005647}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005648#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5649
5650MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005651static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005652{
5653 /* Check protocol version and dispatch accordingly. */
5654#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5656 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005657 }
5658#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5659
5660#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5662 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005663 }
5664#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5665
5666 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005668}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005669
Paul Bakker48916f92012-09-16 19:57:18 +00005670/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005671 * Receive application data decrypted from the SSL layer
5672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005673int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005674{
Janos Follath865b3eb2019-12-16 11:46:15 +00005675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005676 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (ssl == NULL || ssl->conf == NULL) {
5679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5680 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005684#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5686 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5687 return ret;
5688 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (ssl->handshake != NULL &&
5691 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5692 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5693 return ret;
5694 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005695 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005696 }
5697#endif
5698
Hanno Becker4a810fb2017-05-24 16:27:30 +01005699 /*
5700 * Check if renegotiation is necessary and/or handshake is
5701 * in process. If yes, perform/continue, and fall through
5702 * if an unexpected packet is received while the client
5703 * is waiting for the ServerHello.
5704 *
5705 * (There is no equivalent to the last condition on
5706 * the server-side as it is not treated as within
5707 * a handshake while waiting for the ClientHello
5708 * after a renegotiation request.)
5709 */
5710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 ret = ssl_check_ctr_renegotiate(ssl);
5713 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5714 ret != 0) {
5715 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5716 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005717 }
5718#endif
5719
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5721 ret = mbedtls_ssl_handshake(ssl);
5722 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5723 ret != 0) {
5724 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5725 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005726 }
5727 }
5728
Hanno Beckere41158b2017-10-23 13:30:32 +01005729 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005731 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if (ssl->f_get_timer != NULL &&
5733 ssl->f_get_timer(ssl->p_timer) == -1) {
5734 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005735 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5738 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5739 return 0;
5740 }
Paul Bakker831a7552011-05-18 13:32:51 +00005741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5743 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005744 }
5745
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 if (ssl->in_msglen == 0 &&
5747 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005748 /*
5749 * OpenSSL sends empty messages to randomize the IV
5750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5752 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5753 return 0;
5754 }
Paul Bakker831a7552011-05-18 13:32:51 +00005755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5757 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005758 }
5759 }
5760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5762 ret = ssl_handle_hs_message_post_handshake(ssl);
5763 if (ret != 0) {
5764 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5765 ret);
5766 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005767 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005768
Hanno Beckerf26cc722021-04-21 07:30:13 +01005769 /* At this point, we don't know whether the renegotiation triggered
5770 * by the post-handshake message has been completed or not. The cases
5771 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005772 * 1) The renegotiation is complete. In this case, no new record
5773 * has been read yet.
5774 * 2) The renegotiation is incomplete because the client received
5775 * an application data record while awaiting the ServerHello.
5776 * 3) The renegotiation is incomplete because the client received
5777 * a non-handshake, non-application data message while awaiting
5778 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005779 *
5780 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005781 * - For 1), the next iteration will read a new record and check
5782 * if it's application data.
5783 * - For 2), the loop condition isn't satisfied as application data
5784 * is present, hence continue is the same as break
5785 * - For 3), the loop condition is satisfied and read_record
5786 * will re-deliver the message that was held back by the client
5787 * when expecting the ServerHello.
5788 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005789
Hanno Becker90333da2017-10-10 11:27:13 +01005790 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005791 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005792#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5794 if (ssl->conf->renego_max_records >= 0) {
5795 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5796 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5797 "but not honored by client"));
5798 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005799 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005800 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005801 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005804 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5806 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5807 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005808 }
5809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5811 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5812 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005813 }
5814
5815 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005816
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005817 /* We're going to return something now, cancel timer,
5818 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5820 mbedtls_ssl_set_timer(ssl, 0);
5821 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005822
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005823#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005824 /* If we requested renego but received AppData, resend HelloRequest.
5825 * Do it now, after setting in_offt, to avoid taking this branch
5826 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005827#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5829 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5830 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5831 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5832 ret);
5833 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005834 }
5835 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005836#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005837#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005838 }
5839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005841 ? len : ssl->in_msglen;
5842
ashesman937d6d52022-02-17 11:08:27 +13005843 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005844 memcpy(buf, ssl->in_offt, n);
5845 ssl->in_msglen -= n;
5846 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005847
gabor-mezei-arma3214132020-07-15 10:55:00 +02005848 /* Zeroising the plaintext buffer to erase unused application data
5849 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005853 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005854 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005855 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005857 /* more data available */
5858 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005859 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005860
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005864}
5865
5866/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005867 * Send application data to be encrypted by the SSL layer, taking care of max
5868 * fragment length and buffer size.
5869 *
5870 * According to RFC 5246 Section 6.2.1:
5871 *
5872 * Zero-length fragments of Application data MAY be sent as they are
5873 * potentially useful as a traffic analysis countermeasure.
5874 *
5875 * Therefore, it is possible that the input message length is 0 and the
5876 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005877 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005878MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005879static int ssl_write_real(mbedtls_ssl_context *ssl,
5880 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005881{
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005883 const size_t max_len = (size_t) ret;
5884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (ret < 0) {
5886 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5887 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005888 }
5889
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005891#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5893 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5894 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5895 " > %" MBEDTLS_PRINTF_SIZET,
5896 len, max_len));
5897 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5898 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005899#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005901 }
Paul Bakker887bd502011-06-08 13:10:54 +00005902
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005904 /*
5905 * The user has previously tried to send the data and
5906 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5907 * written. In this case, we expect the high-level write function
5908 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5911 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5912 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005913 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005915 /*
5916 * The user is trying to send a message the first time, so we need to
5917 * copy the data into the internal buffers and setup the data structure
5918 * to keep track of partial writes
5919 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005920 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005921 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005922 if (len > 0) {
5923 memcpy(ssl->out_msg, buf, len);
5924 }
Paul Bakker887bd502011-06-08 13:10:54 +00005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5927 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5928 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005929 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005930 }
5931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005933}
5934
5935/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005936 * Write application data (public-facing wrapper)
5937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005938int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005939{
Janos Follath865b3eb2019-12-16 11:46:15 +00005940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 if (ssl == NULL || ssl->conf == NULL) {
5945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5946 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005947
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005948#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5950 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5951 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005952 }
5953#endif
5954
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5956 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5957 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5958 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005959 }
5960 }
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005963
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005967}
5968
5969/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005970 * Notify the peer that the connection is being closed
5971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005972int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005973{
Janos Follath865b3eb2019-12-16 11:46:15 +00005974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005975
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (ssl == NULL || ssl->conf == NULL) {
5977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5978 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005979
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 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5983 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5984 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5985 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5986 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5987 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005988 }
5989 }
5990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005994}
5995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005997{
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005999 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006001
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006002#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 psa_destroy_key(transform->psa_key_enc);
6004 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006005#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6007 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006008#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006009
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006010#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006011#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 psa_destroy_key(transform->psa_mac_enc);
6013 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006014#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 mbedtls_md_free(&transform->md_ctx_enc);
6016 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006017#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006018#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006021}
6022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6024 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006025{
Jerry Yuc7875b52021-09-05 21:05:50 +08006026 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006028}
6029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6031 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006032{
6033 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006035}
6036
Hanno Becker0271f962018-08-16 13:23:47 +01006037#if defined(MBEDTLS_SSL_PROTO_DTLS)
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006040{
6041 unsigned offset;
6042 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006045 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 }
Hanno Becker0271f962018-08-16 13:23:47 +01006047
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6051 ssl_buffering_free_slot(ssl, offset);
6052 }
Hanno Beckere605b192018-08-21 15:59:07 +01006053}
6054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6056 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006057{
6058 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6059 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006062 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006064
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006066 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006067 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006069 }
6070}
6071
6072#endif /* MBEDTLS_SSL_PROTO_DTLS */
6073
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006074/*
6075 * Convert version numbers to/from wire format
6076 * and, for DTLS, to/from TLS equivalent.
6077 *
6078 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006079 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006080 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006081 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6084 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006085{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006086 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006089 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006091 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006092#else
6093 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006094#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006095 {
6096 tls_version_formatted = (uint16_t) tls_version;
6097 }
6098 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006099}
6100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6102 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006103{
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006105#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006107 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6109 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006110#else
6111 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006112#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006113 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006114}
6115
Jerry Yue7047812021-09-13 19:26:39 +08006116/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006117 * Send pending fatal alert.
6118 * 0, No alert message.
6119 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6120 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006122int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006123{
6124 int ret;
6125
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006126 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 if (ssl->send_alert == 0) {
6128 return 0;
6129 }
Jerry Yu394ece62021-09-14 22:17:21 +08006130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 ret = mbedtls_ssl_send_alert_message(ssl,
6132 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6133 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006134
Jerry Yu3bf1f972021-09-22 21:37:18 +08006135 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6136 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006139 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006140 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006141
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 if (ret != 0) {
6143 return ret;
6144 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006145
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006147}
6148
Jerry Yu394ece62021-09-14 22:17:21 +08006149/*
6150 * Set pending fatal alert flag.
6151 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006152void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6153 unsigned char alert_type,
6154 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006155{
6156 ssl->send_alert = 1;
6157 ssl->alert_type = alert_type;
6158 ssl->alert_reason = alert_reason;
6159}
6160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006161#endif /* MBEDTLS_SSL_TLS_C */