blob: 2726cbc9d5a1888cfc4f15a1758d40b5fb6938fc [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
Hanno Becker67a37db2020-05-28 16:27:07 +0100866#if defined(MBEDTLS_GCM_C) || \
867 defined(MBEDTLS_CCM_C) || \
868 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200869MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100870static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872{
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100874}
875
Hanno Becker17263802020-05-28 07:05:48 +0100876/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
877 *
878 * Concretely, this occurs in two variants:
879 *
880 * a) Fixed and dynamic IV lengths add up to total IV length, giving
881 * IV = fixed_iv || dynamic_iv
882 *
Hanno Becker15952812020-06-04 13:31:46 +0100883 * This variant is used in TLS 1.2 when used with GCM or CCM.
884 *
Hanno Becker17263802020-05-28 07:05:48 +0100885 * b) Fixed IV lengths matches total IV length, giving
886 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100887 *
888 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
889 *
890 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100891 *
892 * This function has the precondition that
893 *
894 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
895 *
896 * which has to be ensured by the caller. If this precondition
897 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100898 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100899static void ssl_build_record_nonce(unsigned char *dst_iv,
900 size_t dst_iv_len,
901 unsigned char const *fixed_iv,
902 size_t fixed_iv_len,
903 unsigned char const *dynamic_iv,
904 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100905{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100906 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(dst_iv, 0, dst_iv_len);
908 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100909
Hanno Becker17263802020-05-28 07:05:48 +0100910 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100912}
Hanno Becker67a37db2020-05-28 16:27:07 +0100913#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100914
Gilles Peskine449bd832023-01-11 14:50:10 +0100915int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
916 mbedtls_ssl_transform *transform,
917 mbedtls_record *rec,
918 int (*f_rng)(void *, unsigned char *, size_t),
919 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000920{
Neil Armstrong136f8402022-03-30 10:58:01 +0200921 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100922 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200924 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 * the description of ssl_extract_add_data_from_record().
926 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200927#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
928 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
929#else
930 unsigned char add_data[13];
931#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100932 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 size_t post_avail;
934
935 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000936#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200937 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 ((void) ssl);
939#endif
940
941 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200942 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100943#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
944 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 ((void) f_rng);
946 ((void) p_rng);
947#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000950
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 if (transform == NULL) {
952 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
953 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000954 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100956 || rec->buf == NULL
957 || rec->buf_len < rec->data_offset
958 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100959#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100960 || rec->cid_len != 0
961#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 ) {
963 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
964 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100965 }
966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200968
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
971 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
972 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
975 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
976 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
977 rec->data_len,
978 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100981
Hanno Becker92313402020-05-20 13:58:58 +0100982 /* The following two code paths implement the (D)TLSInnerPlaintext
983 * structure present in TLS 1.3 and DTLS 1.2 + CID.
984 *
985 * See ssl_build_inner_plaintext() for more information.
986 *
987 * Note that this changes `rec->data_len`, and hence
988 * `post_avail` needs to be recalculated afterwards.
989 *
990 * Note also that the two code paths cannot occur simultaneously
991 * since they apply to different versions of the protocol. There
992 * is hence no risk of double-addition of the inner plaintext.
993 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100994#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100996 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 ssl_compute_padding_length(rec->data_len,
998 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
999 if (ssl_build_inner_plaintext(data,
1000 &rec->data_len,
1001 post_avail,
1002 rec->type,
1003 padding) != 0) {
1004 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +01001005 }
1006
1007 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
1008 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001009#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001010
Hanno Beckera0e20d02019-05-15 14:03:01 +01001011#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001012 /*
1013 * Add CID information
1014 */
1015 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1017 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001020 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 ssl_compute_padding_length(rec->data_len,
1022 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001023 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001024 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001025 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001026 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001027 * Note that this changes `rec->data_len`, and hence
1028 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 if (ssl_build_inner_plaintext(data,
1031 &rec->data_len,
1032 post_avail,
1033 rec->type,
1034 padding) != 0) {
1035 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001036 }
1037
1038 rec->type = MBEDTLS_SSL_MSG_CID;
1039 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001040#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001043
Paul Bakker5121ce52009-01-03 21:22:43 +00001044 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001045 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001046 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1049 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1050 if (post_avail < transform->maclen) {
1051 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1052 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001053 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001055 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001057#if defined(MBEDTLS_USE_PSA_CRYPTO)
1058 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1060 size_t sign_mac_length = 0;
1061#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001062
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1064 transform->tls_version,
1065 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001066
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1069 transform->psa_mac_alg);
1070 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001071 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 status = psa_mac_update(&operation, add_data, add_data_len);
1075 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001076 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 status = psa_mac_update(&operation, data, rec->data_len);
1080 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001081 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1085 &sign_mac_length);
1086 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001089#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1091 add_data_len);
1092 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001093 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
1095 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1096 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001097 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 }
1099 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1100 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001101 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 }
1103 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1104 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001105 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001110#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1113 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001114
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001115 rec->data_len += transform->maclen;
1116 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001117 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119hmac_failed_etm_disabled:
1120 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001122 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 status = psa_mac_abort(&operation);
1124 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001125 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001127#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (ret != 0) {
1129 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1130 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001131 }
Paul Bakker577e0062013-08-28 11:57:20 +02001132 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001135 /*
1136 * Encrypt
1137 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001138#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1140 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1141 "including %d bytes of padding",
1142 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001143
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001144 /* The only supported stream cipher is "NULL",
1145 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001147#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001148
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001149#if defined(MBEDTLS_GCM_C) || \
1150 defined(MBEDTLS_CCM_C) || \
1151 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001153 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001154 unsigned char *dynamic_iv;
1155 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001156 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001158#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001160#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001162
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001163 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (post_avail < transform->taglen) {
1165 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1166 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001167 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001168
Paul Bakker68884e32013-01-07 18:20:04 +01001169 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001170 * Build nonce for AEAD encryption.
1171 *
1172 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1173 * part of the IV is prepended to the ciphertext and
1174 * can be chosen freely - in particular, it need not
1175 * agree with the record sequence number.
1176 * However, since ChaChaPoly as well as all AEAD modes
1177 * in TLS 1.3 use the record sequence number as the
1178 * dynamic part of the nonce, we uniformly use the
1179 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001180 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001181 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 ssl_build_record_nonce(iv, sizeof(iv),
1185 transform->iv_enc,
1186 transform->fixed_ivlen,
1187 dynamic_iv,
1188 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001189
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001190 /*
1191 * Build additional data for AEAD encryption.
1192 * This depends on the TLS version.
1193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1195 transform->tls_version,
1196 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1199 iv, transform->ivlen);
1200 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1201 dynamic_iv,
1202 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1203 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1204 add_data, add_data_len);
1205 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1206 "including 0 bytes of padding",
1207 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001208
Paul Bakker68884e32013-01-07 18:20:04 +01001209 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001210 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001211 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001212#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 status = psa_aead_encrypt(transform->psa_key_enc,
1214 transform->psa_alg,
1215 iv, transform->ivlen,
1216 add_data, add_data_len,
1217 data, rec->data_len,
1218 data, rec->buf_len - (data - rec->buf),
1219 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1224 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001225 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1228 iv, transform->ivlen,
1229 add_data, add_data_len,
1230 data, rec->data_len, /* src */
1231 data, rec->buf_len - (data - rec->buf), /* dst */
1232 &rec->data_len,
1233 transform->taglen)) != 0) {
1234 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1235 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001236 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001237#endif /* MBEDTLS_USE_PSA_CRYPTO */
1238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1240 data + rec->data_len - transform->taglen,
1241 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001242 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001243 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001244
1245 /*
1246 * Prefix record content with dynamic IV in case it is explicit.
1247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (dynamic_iv_is_explicit != 0) {
1249 if (rec->data_offset < dynamic_iv_len) {
1250 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1251 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001252 }
1253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001255 rec->data_offset -= dynamic_iv_len;
1256 rec->data_len += dynamic_iv_len;
1257 }
1258
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001259 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 } else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001261#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001262#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1264 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001265 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001266 size_t padlen, i;
1267 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001268#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001270 size_t part_len;
1271 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001273
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001274 /* Currently we're always using minimal padding
1275 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1277 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001279 }
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 /* Check there's enough space in the buffer for the padding. */
1282 if (post_avail < padlen + 1) {
1283 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1284 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1285 }
1286
1287 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001288 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001291 rec->data_len += padlen + 1;
1292 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001293
TRodziewicz0f82ec62021-05-12 17:49:18 +02001294#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001295 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001296 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001297 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (f_rng == NULL) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1301 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001302 }
TRodziewicz345165c2021-07-06 13:42:11 +02001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (rec->data_offset < transform->ivlen) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1306 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001307 }
1308
1309 /*
1310 * Generate IV
1311 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1313 if (ret != 0) {
1314 return ret;
1315 }
TRodziewicz345165c2021-07-06 13:42:11 +02001316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001318#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1321 "including %"
1322 MBEDTLS_PRINTF_SIZET
1323 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1324 rec->data_len, transform->ivlen,
1325 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001327#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 status = psa_cipher_encrypt_setup(&cipher_op,
1329 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001332 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1334 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001335 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001336
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001340 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1342 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001343
1344 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_cipher_update(&cipher_op,
1347 data, rec->data_len,
1348 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001351 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1353 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001354
1355 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 status = psa_cipher_finish(&cipher_op,
1358 data + olen, rec->data_len - olen,
1359 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001362 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1364 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001365
1366 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001367
1368 olen += part_len;
1369#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1371 transform->iv_enc,
1372 transform->ivlen,
1373 data, rec->data_len,
1374 data, &olen)) != 0) {
1375 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1376 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001377 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001378#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (rec->data_len != olen) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1382 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001383 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001384
TRodziewicz0f82ec62021-05-12 17:49:18 +02001385 data -= transform->ivlen;
1386 rec->data_offset -= transform->ivlen;
1387 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001391 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001392#if defined(MBEDTLS_USE_PSA_CRYPTO)
1393 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1394 size_t sign_mac_length = 0;
1395#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001396
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001397 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 if (post_avail < transform->maclen) {
1401 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1402 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001403 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl_extract_add_data_from_record(add_data, &add_data_len,
1406 rec, transform->tls_version,
1407 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1410 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1411 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1414 transform->psa_mac_alg);
1415 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001416 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 status = psa_mac_update(&operation, add_data, add_data_len);
1420 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001421 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_mac_update(&operation, data, rec->data_len);
1425 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001426 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1430 &sign_mac_length);
1431 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001432 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001434#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1437 add_data_len);
1438 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001439 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 }
1441 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1442 data, rec->data_len);
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_finish(&transform->md_ctx_enc, mac);
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 }
1450 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1451 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001452 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001454#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001457
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001458 rec->data_len += transform->maclen;
1459 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001460 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462hmac_failed_etm_enabled:
1463 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001465 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 status = psa_mac_abort(&operation);
1467 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001468 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001470#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (ret != 0) {
1472 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1473 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001474 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001475 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001478#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001479 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1481 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001482 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001484 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 if (auth_done != 1) {
1486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1487 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001488 }
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001493}
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1496 mbedtls_ssl_transform *transform,
1497 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001498{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001499#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001501#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001502 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001503 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001504
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001505 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001506#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001507 size_t padlen = 0, correct = 1;
1508#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001510 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 * the description of ssl_extract_add_data_from_record().
1512 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001513#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1514 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1515#else
1516 unsigned char add_data[13];
1517#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001518 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519
Hanno Beckera18d1322018-01-03 14:27:32 +00001520#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001521 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 ((void) ssl);
1523#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1526 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 rec->buf == NULL ||
1528 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 rec->buf_len - rec->data_offset < rec->data_len) {
1530 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1531 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001532 }
1533
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001536
Hanno Beckera0e20d02019-05-15 14:03:01 +01001537#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001538 /*
1539 * Match record's CID with incoming CID.
1540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 if (rec->cid_len != transform->in_cid_len ||
1542 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1543 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001544 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001545#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001546
Hanno Beckerd086bf02021-03-22 13:01:27 +00001547#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001549 if (rec->data_len < transform->maclen) {
1550 MBEDTLS_SSL_DEBUG_MSG(1,
1551 ("Record too short for MAC:"
1552 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1553 rec->data_len, transform->maclen));
1554 return MBEDTLS_ERR_SSL_INVALID_MAC;
1555 }
1556
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001557 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001558 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001560#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001561#if defined(MBEDTLS_GCM_C) || \
1562 defined(MBEDTLS_CCM_C) || \
1563 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001565 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001566 unsigned char *dynamic_iv;
1567 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001568#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001570#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001571
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001572 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001573 * Extract dynamic part of nonce for AEAD decryption.
1574 *
1575 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1576 * part of the IV is prepended to the ciphertext and
1577 * can be chosen freely - in particular, it need not
1578 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 dynamic_iv_len = sizeof(rec->ctr);
1581 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1582 if (rec->data_len < dynamic_iv_len) {
1583 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1584 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1585 rec->data_len,
1586 dynamic_iv_len));
1587 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001588 }
1589 dynamic_iv = data;
1590
1591 data += dynamic_iv_len;
1592 rec->data_offset += dynamic_iv_len;
1593 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001595 dynamic_iv = rec->ctr;
1596 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001597
1598 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (rec->data_len < transform->taglen) {
1600 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1601 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1602 rec->data_len,
1603 transform->taglen));
1604 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001605 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001606 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001607
Hanno Beckerdf8be222020-05-21 15:30:57 +01001608 /*
1609 * Prepare nonce from dynamic and static parts.
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 ssl_build_record_nonce(iv, sizeof(iv),
1612 transform->iv_dec,
1613 transform->fixed_ivlen,
1614 dynamic_iv,
1615 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001616
Hanno Beckerdf8be222020-05-21 15:30:57 +01001617 /*
1618 * Build additional data for AEAD encryption.
1619 * This depends on the TLS version.
1620 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1622 transform->tls_version,
1623 transform->taglen);
1624 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1625 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001626
Hanno Beckerd96a6522019-07-10 13:55:25 +01001627 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001628 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001629 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001630 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001631 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1634 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1635 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001636
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001637 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001638 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001639 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 status = psa_aead_decrypt(transform->psa_key_dec,
1642 transform->psa_alg,
1643 iv, transform->ivlen,
1644 add_data, add_data_len,
1645 data, rec->data_len + transform->taglen,
1646 data, rec->buf_len - (data - rec->buf),
1647 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001650 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1652 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001653 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001654#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1656 iv, transform->ivlen,
1657 add_data, add_data_len,
1658 data, rec->data_len + transform->taglen, /* src */
1659 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1660 transform->taglen)) != 0) {
1661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1664 return MBEDTLS_ERR_SSL_INVALID_MAC;
1665 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001668 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001669#endif /* MBEDTLS_USE_PSA_CRYPTO */
1670
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001671 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001672
Hanno Beckerd96a6522019-07-10 13:55:25 +01001673 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 if (olen != rec->data_len) {
1675 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1676 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001677 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001680#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1682 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001683 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001684#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001685 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001686 size_t part_len;
1687 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1688#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001689
Paul Bakker5121ce52009-01-03 21:22:43 +00001690 /*
Paul Bakker45829992013-01-03 14:52:21 +01001691 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001692 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001693#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001694 /* The ciphertext is prefixed with the CBC IV. */
1695 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001696#endif
Paul Bakker45829992013-01-03 14:52:21 +01001697
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001698 /* Size considerations:
1699 *
1700 * - The CBC cipher text must not be empty and hence
1701 * at least of size transform->ivlen.
1702 *
1703 * Together with the potential IV-prefix, this explains
1704 * the first of the two checks below.
1705 *
1706 * - The record must contain a MAC, either in plain or
1707 * encrypted, depending on whether Encrypt-then-MAC
1708 * is used or not.
1709 * - If it is, the message contains the IV-prefix,
1710 * the CBC ciphertext, and the MAC.
1711 * - If it is not, the padded plaintext, and hence
1712 * the CBC ciphertext, has at least length maclen + 1
1713 * because there is at least the padding length byte.
1714 *
1715 * As the CBC ciphertext is not empty, both cases give the
1716 * lower bound minlen + maclen + 1 on the record size, which
1717 * we test for in the second check below.
1718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (rec->data_len < minlen + transform->ivlen ||
1720 rec->data_len < minlen + transform->maclen + 1) {
1721 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1722 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1723 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1724 "+ 1 ) ( + expl IV )",
1725 rec->data_len,
1726 transform->ivlen,
1727 transform->maclen));
1728 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001729 }
1730
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001731 /*
1732 * Authenticate before decrypt if enabled
1733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001736#if defined(MBEDTLS_USE_PSA_CRYPTO)
1737 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1738#else
Hanno Becker992b6872017-11-09 18:57:39 +00001739 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001740#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001743
Hanno Beckerd96a6522019-07-10 13:55:25 +01001744 /* Update data_len in tandem with add_data.
1745 *
1746 * The subtraction is safe because of the previous check
1747 * data_len >= minlen + maclen + 1.
1748 *
1749 * Afterwards, we know that data + data_len is followed by at
1750 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001751 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001752 *
1753 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001754 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1756 transform->tls_version,
1757 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001758
Hanno Beckerd96a6522019-07-10 13:55:25 +01001759 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1761 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001762#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1764 transform->psa_mac_alg);
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, add_data, add_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
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 status = psa_mac_update(&operation, data, rec->data_len);
1775 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001776 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001778
1779 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1781 transform->maclen);
1782 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001783 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001785#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1787 add_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_update(&transform->md_ctx_dec,
1792 data, rec->data_len);
1793 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001794 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 }
1796 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1797 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001798 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 }
1800 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1801 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001802 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1806 transform->maclen);
1807 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1808 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001809
Hanno Beckerd96a6522019-07-10 13:55:25 +01001810 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1812 transform->maclen) != 0) {
1813 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001814 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1815 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001816 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001817#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001818 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001819
Gilles Peskine449bd832023-01-11 14:50:10 +01001820hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001821#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001822 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 status = psa_mac_abort(&operation);
1824 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001825 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001827#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001829#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (ret != 0) {
1831 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1832 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1833 }
1834 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001835 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001836 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001838
1839 /*
1840 * Check length sanity
1841 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001842
1843 /* We know from above that data_len > minlen >= 0,
1844 * so the following check in particular implies that
1845 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (rec->data_len % transform->ivlen != 0) {
1847 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1848 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1849 rec->data_len, transform->ivlen));
1850 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001851 }
1852
TRodziewicz0f82ec62021-05-12 17:49:18 +02001853#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001854 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001855 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001856 */
TRodziewicz345165c2021-07-06 13:42:11 +02001857 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001859
TRodziewicz345165c2021-07-06 13:42:11 +02001860 data += transform->ivlen;
1861 rec->data_offset += transform->ivlen;
1862 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001863#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001864
Hanno Beckerd96a6522019-07-10 13:55:25 +01001865 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1866
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001867#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 status = psa_cipher_decrypt_setup(&cipher_op,
1869 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001872 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1874 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001875 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001880 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1882 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001883 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001884
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 status = psa_cipher_update(&cipher_op,
1886 data, rec->data_len,
1887 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001888
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001890 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1892 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001893 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001894
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 status = psa_cipher_finish(&cipher_op,
1896 data + olen, rec->data_len - olen,
1897 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001900 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1902 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001903 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001904
1905 olen += part_len;
1906#else
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1909 transform->iv_dec, transform->ivlen,
1910 data, rec->data_len, data, &olen)) != 0) {
1911 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1912 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001913 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001914#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001915
Hanno Beckerd96a6522019-07-10 13:55:25 +01001916 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (rec->data_len != olen) {
1918 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1919 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001920 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001921
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001922 /* Safe since data_len >= minlen + maclen + 1, so after having
1923 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001924 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1925 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001926 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001929 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 rec->data_len,
1931 padlen + 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001932 correct = mbedtls_ct_size_if_else_0(ge, correct);
1933 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 if (rec->data_len < transform->maclen + padlen + 1) {
1937 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1938 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1939 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1940 rec->data_len,
1941 transform->maclen,
1942 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001943 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001944#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001945 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 rec->data_len,
1947 transform->maclen + padlen + 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001948 correct = mbedtls_ct_size_if_else_0(ge, correct);
1949 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001950 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001951
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001952 padlen++;
1953
1954 /* Regardless of the validity of the padding,
1955 * we have data_len >= padlen here. */
1956
TRodziewicz0f82ec62021-05-12 17:49:18 +02001957#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001958 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 * consecutive memory reads at the end of the record
1960 * plaintext buffer. In order to hide the length and
1961 * validity of the padding, always perform exactly
1962 * `min(256,plaintext_len)` reads (but take into account
1963 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001964 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001966
1967 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001969 size_t const padding_idx = rec->data_len - padlen;
1970 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1971 size_t const start_idx = rec->data_len - num_checks;
1972 size_t idx;
1973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001975 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 * (check[idx] == padlen - 1);
1977 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001978 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001979 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001980 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001981 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001982 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001983 }
Dave Rodgman98ddc012023-08-10 12:11:31 +01001984 correct = mbedtls_ct_size_if_else_0(mbedtls_ct_uint_eq(pad_count, padlen), padlen);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 if (padlen > 0 && correct == 0) {
1988 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1989 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001990#endif
Dave Rodgman98ddc012023-08-10 12:11:31 +01001991 padlen = mbedtls_ct_size_if_else_0(mbedtls_ct_bool(correct), padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001992
TRodziewicz0f82ec62021-05-12 17:49:18 +02001993#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001994
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001995 /* If the padding was found to be invalid, padlen == 0
1996 * and the subtraction is safe. If the padding was found valid,
1997 * padlen hasn't been changed and the previous assertion
1998 * data_len >= padlen still holds. */
1999 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02002001#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02002002 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2004 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02002005 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002006
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002007#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
2009 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002010#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002011
2012 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01002013 * Authenticate if not done yet.
2014 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002015 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002016#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002018 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2019 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002020
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002021 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002022 * data_len < maclen + padlen + 1, then padlen
2023 * got reset to 1, and the initial check
2024 * data_len >= minlen + maclen + 1
2025 * guarantees that at this point we still
2026 * have at least data_len >= maclen.
2027 *
2028 * If the initial value of padlen was such that
2029 * data_len >= maclen + padlen + 1, then we have
2030 * subtracted either padlen + 1 (if the padding was correct)
2031 * or 0 (if the padding was incorrect) since then,
2032 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02002033 *
2034 * For stream ciphers, we checked above that
2035 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002036 */
2037 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2039 transform->tls_version,
2040 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002041
TRodziewicz0f82ec62021-05-12 17:49:18 +02002042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002043 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 * The next two sizes are the minimum and maximum values of
2045 * data_len over all padlen values.
2046 *
2047 * They're independent of padlen, since we previously did
2048 * data_len -= padlen.
2049 *
2050 * Note that max_len + maclen is never more than the buffer
2051 * length, as we previously did in_msglen -= maclen too.
2052 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002053 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002055
Neil Armstronge8589962022-02-25 15:14:29 +01002056#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2058 transform->psa_mac_alg,
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#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2064 add_data, add_data_len,
2065 data, rec->data_len, min_len, max_len,
2066 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002067#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if (ret != 0) {
2069 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002070 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002071 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 mbedtls_ct_memcpy_offset(mac_peer, data,
2074 rec->data_len,
2075 min_len, max_len,
2076 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002078
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002079#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2081 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002082#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2085 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002088#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002089 correct = 0;
2090 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002091 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093hmac_failed_etm_disabled:
2094 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2095 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2096 if (ret != 0) {
2097 return ret;
2098 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002099 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002100
2101 /*
2102 * Finally check the correct flag
2103 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (correct == 0) {
2105 return MBEDTLS_ERR_SSL_INVALID_MAC;
2106 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002107#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002108
2109 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (auth_done != 1) {
2111 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2112 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002113 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002114
Ronald Cron6f135e12021-12-08 16:57:54 +01002115#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002117 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2119 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (ret != 0) {
2122 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2123 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002124 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002125#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002126
Hanno Beckera0e20d02019-05-15 14:03:01 +01002127#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (rec->cid_len != 0) {
2129 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2130 &rec->type);
2131 if (ret != 0) {
2132 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2133 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002134 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002135#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002140}
2141
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002142#undef MAC_NONE
2143#undef MAC_PLAINTEXT
2144#undef MAC_CIPHERTEXT
2145
Paul Bakker5121ce52009-01-03 21:22:43 +00002146/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002147 * Fill the input message buffer by appending data to it.
2148 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002149 *
2150 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2151 * available (from this read and/or a previous one). Otherwise, an error code
2152 * is returned (possibly EOF or WANT_READ).
2153 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002154 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2155 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2156 * since we always read a whole datagram at once.
2157 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002158 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002159 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002161int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002162{
Janos Follath865b3eb2019-12-16 11:46:15 +00002163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002164 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002165#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2166 size_t in_buf_len = ssl->in_buf_len;
2167#else
2168 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2169#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002170
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2174 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002176 }
2177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2179 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002181 }
2182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002185 uint32_t timeout;
2186
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002187 /*
2188 * The point is, we need to always read a full datagram at once, so we
2189 * sometimes read more then requested, and handle the additional data.
2190 * It could be the rest of the current record (while fetching the
2191 * header) and/or some other records in the same datagram.
2192 */
2193
2194 /*
2195 * Move to the next record in the already read datagram if applicable
2196 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 if (ssl->next_record_offset != 0) {
2198 if (ssl->in_left < ssl->next_record_offset) {
2199 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2200 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002201 }
2202
2203 ssl->in_left -= ssl->next_record_offset;
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->in_left != 0) {
2206 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2207 MBEDTLS_PRINTF_SIZET,
2208 ssl->next_record_offset));
2209 memmove(ssl->in_hdr,
2210 ssl->in_hdr + ssl->next_record_offset,
2211 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002212 }
2213
2214 ssl->next_record_offset = 0;
2215 }
2216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2218 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2219 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002220
2221 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002222 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 if (nb_want <= ssl->in_left) {
2225 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2226 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002227 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002228
2229 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002230 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002231 * are not at the beginning of a new record, the caller did something
2232 * wrong.
2233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (ssl->in_left != 0) {
2235 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2236 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002237 }
2238
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002239 /*
2240 * Don't even try to read if time's out already.
2241 * This avoids by-passing the timer when repeatedly receiving messages
2242 * that will end up being dropped.
2243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 if (mbedtls_ssl_check_timer(ssl) != 0) {
2245 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002246 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 } else {
2248 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002251 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002253 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->f_recv_timeout != NULL) {
2259 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2260 timeout);
2261 } else {
2262 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2263 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (ret == 0) {
2268 return MBEDTLS_ERR_SSL_CONN_EOF;
2269 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002270 }
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2273 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2274 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2277 if (ssl_double_retransmit_timeout(ssl) != 0) {
2278 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2279 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002280 }
2281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2283 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2284 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002285 }
2286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002288 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2291 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2292 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2293 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2294 ret);
2295 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002296 }
2297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002299 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002301 }
2302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (ret < 0) {
2304 return ret;
2305 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002306
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002307 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002309#endif
2310 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2312 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2313 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002316 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002319 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 } else {
2321 if (ssl->f_recv_timeout != NULL) {
2322 ret = ssl->f_recv_timeout(ssl->p_bio,
2323 ssl->in_hdr + ssl->in_left, len,
2324 ssl->conf->read_timeout);
2325 } else {
2326 ret = ssl->f_recv(ssl->p_bio,
2327 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002328 }
2329 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2332 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2333 ssl->in_left, nb_want));
2334 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if (ret == 0) {
2337 return MBEDTLS_ERR_SSL_CONN_EOF;
2338 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 if (ret < 0) {
2341 return ret;
2342 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002343
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002344 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 MBEDTLS_SSL_DEBUG_MSG(1,
2346 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2347 " were requested",
2348 ret, len));
2349 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002350 }
2351
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002352 ssl->in_left += ret;
2353 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002354 }
2355
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002359}
2360
2361/*
2362 * Flush any data not yet written
2363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002364int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002365{
Janos Follath865b3eb2019-12-16 11:46:15 +00002366 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002367 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 if (ssl->f_send == NULL) {
2372 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2373 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002374 }
2375
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002376 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (ssl->out_left == 0) {
2378 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2379 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002380 }
2381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 while (ssl->out_left > 0) {
2383 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2384 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2385 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002386
Hanno Becker2b1e3542018-08-06 11:19:13 +01002387 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002389
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (ret <= 0) {
2393 return ret;
2394 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002395
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002396 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 MBEDTLS_SSL_DEBUG_MSG(1,
2398 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2399 " bytes were sent",
2400 ret, ssl->out_left));
2401 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002402 }
2403
Paul Bakker5121ce52009-01-03 21:22:43 +00002404 ssl->out_left -= ret;
2405 }
2406
Hanno Becker2b1e3542018-08-06 11:19:13 +01002407#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002409 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002411#endif
2412 {
2413 ssl->out_hdr = ssl->out_buf + 8;
2414 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002420}
2421
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422/*
2423 * Functions to handle the DTLS retransmission state machine
2424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426/*
2427 * Append current handshake message to current outgoing flight
2428 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002430static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002431{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2434 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2435 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002436
2437 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2439 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2440 sizeof(mbedtls_ssl_flight_item)));
2441 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002442 }
2443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2445 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2446 ssl->out_msglen));
2447 mbedtls_free(msg);
2448 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002449 }
2450
2451 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002453 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002454 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002455 msg->next = NULL;
2456
2457 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002459 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002463 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465 cur->next = msg;
2466 }
2467
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2469 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002470}
2471
2472/*
2473 * Free the current flight of handshake messages
2474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002475void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002476{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477 mbedtls_ssl_flight_item *cur = flight;
2478 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002481 next = cur->next;
2482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 mbedtls_free(cur->p);
2484 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002485
2486 cur = next;
2487 }
2488}
2489
2490/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002491 * Swap transform_out and out_ctr with the alternative ones
2492 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002493MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002494static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002495{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002497 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2500 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2501 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002502 }
2503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002505
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002506 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002507 tmp_transform = ssl->transform_out;
2508 ssl->transform_out = ssl->handshake->alt_transform_out;
2509 ssl->handshake->alt_transform_out = tmp_transform;
2510
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002511 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2513 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2514 sizeof(ssl->cur_out_ctr));
2515 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2516 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002517
2518 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002522}
2523
2524/*
2525 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002527int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002528{
2529 int ret = 0;
2530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002538}
2539
2540/*
2541 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002542 *
2543 * Need to remember the current message in case flush_output returns
2544 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002545 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002546 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002547int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002548{
Janos Follath865b3eb2019-12-16 11:46:15 +00002549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2553 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002554
2555 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002556 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 ret = ssl_swap_epochs(ssl);
2558 if (ret != 0) {
2559 return ret;
2560 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002563 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002566 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002567 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002568
Hanno Beckere1dcb032018-08-17 16:47:58 +01002569 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2571 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002572
Ronald Cron00d012f22022-03-08 15:57:12 +01002573 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002575
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002576 /* Swap epochs before sending Finished: we can't do it after
2577 * sending ChangeCipherSpec, in case write returns WANT_READ.
2578 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2580 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2581 ret = ssl_swap_epochs(ssl);
2582 if (ret != 0) {
2583 return ret;
2584 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002585 }
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 ret = ssl_get_remaining_payload_in_datagram(ssl);
2588 if (ret < 0) {
2589 return ret;
2590 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002591 max_frag_len = (size_t) ret;
2592
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002593 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2595 if (max_frag_len == 0) {
2596 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2597 return ret;
2598 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002599
2600 continue;
2601 }
2602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002604 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002605 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002606
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002607 /* Update position inside current message */
2608 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002610 const unsigned char * const p = ssl->handshake->cur_msg_p;
2611 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002613 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002614 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002615
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2617 if (is_finished) {
2618 ret = ssl_swap_epochs(ssl);
2619 if (ret != 0) {
2620 return ret;
2621 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002622 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2625 return ret;
2626 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002627
2628 continue;
2629 }
2630 max_hs_frag_len = max_frag_len - 12;
2631
2632 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2636 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2637 (unsigned) cur_hs_frag_len,
2638 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002639 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002640
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002641 /* Messages are stored with handshake headers as if not fragmented,
2642 * copy beginning of headers then fill fragmentation fields.
2643 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2647 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2648 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2651 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2652 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002655
Hanno Becker3f7b9732018-08-28 09:53:25 +01002656 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002658 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002659 ssl->out_msgtype = cur->type;
2660
2661 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002662 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002663 }
2664
2665 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2667 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002668 ssl->handshake->cur_msg = cur->next;
2669 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002671 ssl->handshake->cur_msg = NULL;
2672 ssl->handshake->cur_msg_p = NULL;
2673 }
2674 }
2675
2676 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2678 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2679 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002680 }
2681 }
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2684 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002685 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 /* Update state and set timer */
2688 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2689 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2690 } else {
2691 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2692 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2693 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2696
2697 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002698}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002699
2700/*
2701 * To be called when the last message of an incoming flight is received.
2702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002703void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002704{
2705 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002707 ssl->handshake->flight = NULL;
2708 ssl->handshake->cur_msg = NULL;
2709
2710 /* The next incoming flight will start with this msg_seq */
2711 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2712
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002713 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002714 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002715
Hanno Becker0271f962018-08-16 13:23:47 +01002716 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002718
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002719 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002721
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2723 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002728}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002729
2730/*
2731 * To be called when the last message of an outgoing flight is send.
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002734{
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 ssl_reset_retransmit_timeout(ssl);
2736 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2739 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002744}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002746
Paul Bakker5121ce52009-01-03 21:22:43 +00002747/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002748 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2751 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002752{
2753 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002754 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002755 * ...
2756 * HandshakeType msg_type;
2757 * uint24 length;
2758 * ...
2759 */
2760 *buf = ssl->out_msg + 4;
2761 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2762
2763 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2764 ssl->out_msg[0] = hs_type;
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002767}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002768
2769/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002770 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002771 *
2772 * - fill in handshake headers
2773 * - update handshake checksum
2774 * - DTLS: save message for resending
2775 * - then pass to the record layer
2776 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002777 * DTLS: except for HelloRequest, messages are only queued, and will only be
2778 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002779 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002780 * Inputs:
2781 * - ssl->out_msglen: 4 + actual handshake message len
2782 * (4 is the size of handshake headers for TLS)
2783 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2784 * - ssl->out_msg + 4: the handshake message body
2785 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002786 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002787 * - ssl->out_msglen: the length of the record contents
2788 * (including handshake headers but excluding record headers)
2789 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002791int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2792 int update_checksum,
2793 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002794{
Janos Follath865b3eb2019-12-16 11:46:15 +00002795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002796 const size_t hs_len = ssl->out_msglen - 4;
2797 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002800
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002801 /*
2802 * Sanity checks
2803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2805 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2806 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2807 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002808 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002809
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002810 /* Whenever we send anything different from a
2811 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2813 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2814 ssl->handshake == NULL) {
2815 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2816 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002817 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002821 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2823 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2824 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002825 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002826#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002827
Hanno Beckerb50a2532018-08-06 11:52:54 +01002828 /* Double-check that we did not exceed the bounds
2829 * of the outgoing record buffer.
2830 * This should never fail as the various message
2831 * writing functions must obey the bounds of the
2832 * outgoing record buffer, but better be safe.
2833 *
2834 * Note: We deliberately do not check for the MTU or MFL here.
2835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2837 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2838 "size %" MBEDTLS_PRINTF_SIZET
2839 ", maximum %" MBEDTLS_PRINTF_SIZET,
2840 ssl->out_msglen,
2841 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2842 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002843 }
2844
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002845 /*
2846 * Fill handshake headers
2847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2849 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2850 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2851 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002852
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002853 /*
2854 * DTLS has additional fields in the Handshake layer,
2855 * between the length field and the actual payload:
2856 * uint16 message_seq;
2857 * uint24 fragment_offset;
2858 * uint24 fragment_length;
2859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002862 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2864 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2865 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2866 MBEDTLS_PRINTF_SIZET,
2867 hs_len,
2868 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2869 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002870 }
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002873 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002874
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002875 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2877 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2878 ++(ssl->handshake->out_msg_seq);
2879 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002880 ssl->out_msg[4] = 0;
2881 ssl->out_msg[5] = 0;
2882 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002883
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002884 /* Handshake hashes are computed without fragmentation,
2885 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 memset(ssl->out_msg + 6, 0x00, 3);
2887 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002888 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002890
Hanno Becker0207e532018-08-28 10:28:28 +01002891 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002893 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2894 ssl->out_msglen);
2895 if (ret != 0) {
2896 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2897 return ret;
2898 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002900 }
2901
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002902 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2905 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2906 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2907 if ((ret = ssl_flight_append(ssl)) != 0) {
2908 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2909 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002910 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002912#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002913 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2915 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2916 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002917 }
2918 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002923}
2924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2926 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002927{
2928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2929 size_t msg_with_header_len;
2930 ((void) buf_len);
2931
2932 /* Add reserved 4 bytes for handshake header */
2933 msg_with_header_len = msg_len + 4;
2934 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002936
2937cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002939}
2940
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002941/*
2942 * Record layer functions
2943 */
2944
2945/*
2946 * Write current record.
2947 *
2948 * Uses:
2949 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2950 * - ssl->out_msglen: length of the record content (excl headers)
2951 * - ssl->out_msg: record content
2952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002954{
2955 int ret, done = 0;
2956 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002957 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002962 unsigned i;
2963 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002964#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2965 size_t out_buf_len = ssl->out_buf_len;
2966#else
2967 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2968#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002969 /* Skip writing the record content type to after the encryption,
2970 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002971 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002972#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002973 /* TLS 1.3 still uses the TLS 1.2 version identifier
2974 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002976 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002978#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2980 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2983 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002986 mbedtls_record rec;
2987
2988 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002990 rec.data_len = ssl->out_msglen;
2991 rec.data_offset = ssl->out_msg - rec.buf;
2992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2994 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002995 rec.type = ssl->out_msgtype;
2996
Hanno Beckera0e20d02019-05-15 14:03:01 +01002997#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002998 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002999 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01003000#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
3003 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
3004 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
3005 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00003006 }
3007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if (rec.data_offset != 0) {
3009 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3010 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00003011 }
3012
Hanno Becker6430faf2019-05-08 11:57:13 +01003013 /* Update the record content type and CID. */
3014 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003015#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3016 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003017#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003018 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003020 }
3021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003023
3024#if defined(MBEDTLS_SSL_PROTO_DTLS)
3025 /* In case of DTLS, double-check that we don't exceed
3026 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3028 ret = ssl_get_remaining_space_in_datagram(ssl);
3029 if (ret < 0) {
3030 return ret;
3031 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003034 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003036 }
3037 }
3038#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003039
Hanno Becker6430faf2019-05-08 11:57:13 +01003040 /* Now write the potentially updated record content type. */
3041 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3044 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3045 ssl->out_hdr[0], ssl->out_hdr[1],
3046 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3049 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003050
3051 ssl->out_left += protected_record_size;
3052 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3056 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003057 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 }
3059 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003060
Gabor Mezei96ae9262022-06-28 11:45:18 +02003061 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (i == mbedtls_ssl_ep_len(ssl)) {
3063 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3064 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003065 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003066 }
3067
Hanno Becker67bc7c32018-08-06 11:33:50 +01003068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3070 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003071 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 ret = ssl_get_remaining_payload_in_datagram(ssl);
3073 if (ret < 0) {
3074 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3075 ret);
3076 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003077 }
3078
3079 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003081 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 } else {
3083 MBEDTLS_SSL_DEBUG_MSG(2,
3084 ("Still %u bytes available in current datagram",
3085 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003086 }
3087 }
3088#endif /* MBEDTLS_SSL_PROTO_DTLS */
3089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if ((flush == SSL_FORCE_FLUSH) &&
3091 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3092 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3093 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003094 }
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003099}
3100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003102
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003103MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003104static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003105{
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 if (ssl->in_msglen < ssl->in_hslen ||
3107 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3108 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3109 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003110 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003112}
Hanno Becker44650b72018-08-16 12:51:11 +01003113
Gilles Peskine449bd832023-01-11 14:50:10 +01003114static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003115{
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return (ssl->in_msg[9] << 16) |
3117 (ssl->in_msg[10] << 8) |
3118 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003119}
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003122{
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 return (ssl->in_msg[6] << 16) |
3124 (ssl->in_msg[7] << 8) |
3125 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003126}
3127
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003129static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003130{
3131 uint32_t msg_len, frag_off, frag_len;
3132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 msg_len = ssl_get_hs_total_len(ssl);
3134 frag_off = ssl_get_hs_frag_off(ssl);
3135 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003136
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (frag_off > msg_len) {
3138 return -1;
3139 }
Hanno Becker44650b72018-08-16 12:51:11 +01003140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 if (frag_len > msg_len - frag_off) {
3142 return -1;
3143 }
Hanno Becker44650b72018-08-16 12:51:11 +01003144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 if (frag_len + 12 > ssl->in_msglen) {
3146 return -1;
3147 }
Hanno Becker44650b72018-08-16 12:51:11 +01003148
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003150}
3151
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003152/*
3153 * Mark bits in bitmask (used for DTLS HS reassembly)
3154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003155static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003156{
3157 unsigned int start_bits, end_bits;
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 start_bits = 8 - (offset % 8);
3160 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003161 size_t first_byte_idx = offset / 8;
3162
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003163 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 if (len <= start_bits) {
3165 for (; len != 0; len--) {
3166 mask[first_byte_idx] |= 1 << (start_bits - len);
3167 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003168
3169 /* Avoid potential issues with offset or len becoming invalid */
3170 return;
3171 }
3172
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173 offset += start_bits; /* Now offset % 8 == 0 */
3174 len -= start_bits;
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 for (; start_bits != 0; start_bits--) {
3177 mask[first_byte_idx] |= 1 << (start_bits - 1);
3178 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003179 }
3180
3181 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 if (end_bits != 0) {
3183 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003184
3185 len -= end_bits; /* Now len % 8 == 0 */
3186
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 for (; end_bits != 0; end_bits--) {
3188 mask[last_byte_idx] |= 1 << (8 - end_bits);
3189 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003190 }
3191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003193}
3194
3195/*
3196 * Check that bitmask is full
3197 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003198MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003199static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003200{
3201 size_t i;
3202
Gilles Peskine449bd832023-01-11 14:50:10 +01003203 for (i = 0; i < len / 8; i++) {
3204 if (mask[i] != 0xFF) {
3205 return -1;
3206 }
3207 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003208
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 for (i = 0; i < len % 8; i++) {
3210 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3211 return -1;
3212 }
3213 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003216}
3217
Hanno Becker56e205e2018-08-16 09:06:12 +01003218/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003219static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3220 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003221{
Hanno Becker56e205e2018-08-16 09:06:12 +01003222 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003223
Hanno Becker56e205e2018-08-16 09:06:12 +01003224 alloc_len = 12; /* Handshake header */
3225 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003226
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 if (add_bitmap) {
3228 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 }
3231 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003232}
Hanno Becker56e205e2018-08-16 09:06:12 +01003233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003237{
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 return (ssl->in_msg[1] << 16) |
3239 (ssl->in_msg[2] << 8) |
3240 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003241}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003244{
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3246 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3247 ssl->in_msglen));
3248 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003249 }
3250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3254 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3255 MBEDTLS_PRINTF_SIZET,
3256 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003260 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (ssl_check_hs_header(ssl) != 0) {
3264 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3265 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003266 }
3267
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (ssl->handshake != NULL &&
3269 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3270 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3271 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3272 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3273 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3274 MBEDTLS_SSL_DEBUG_MSG(2,
3275 (
3276 "received future handshake message of sequence number %u (next %u)",
3277 recv_msg_seq,
3278 ssl->handshake->in_msg_seq));
3279 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003280 }
3281
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003282 /* Retransmit only on last message from previous flight, to avoid
3283 * too many retransmissions.
3284 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3286 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3287 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3288 "message_seq = %u, start_of_flight = %u",
3289 recv_msg_seq,
3290 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3293 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3294 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003295 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 } else {
3297 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3298 "message_seq = %u, expected = %u",
3299 recv_msg_seq,
3300 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003301 }
3302
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003304 }
3305 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003306
Hanno Becker6d97ef52018-08-16 13:09:04 +01003307 /* Message reassembly is handled alongside buffering of future
3308 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003309 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003310 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3312 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3313 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003314 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003317 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 if (ssl->in_msglen < ssl->in_hslen) {
3319 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3320 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003321 }
3322
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003324}
3325
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003326int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003327{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003328 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003329 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003330
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003332 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3333 if (ret != 0) {
3334 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3335 return ret;
3336 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003337 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003338
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003339 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3342 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003343 unsigned offset;
3344 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003345
Hanno Becker0271f962018-08-16 13:23:47 +01003346 /* Increment handshake sequence number */
3347 hs->in_msg_seq++;
3348
3349 /*
3350 * Clear up handshake buffering and reassembly structure.
3351 */
3352
3353 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003355
3356 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003358 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003360 *hs_buf = *(hs_buf + 1);
3361 }
3362
3363 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003365 }
3366#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003367 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003368}
3369
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003370/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003371 * DTLS anti-replay: RFC 6347 4.1.2.6
3372 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003373 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3374 * Bit n is set iff record number in_window_top - n has been seen.
3375 *
3376 * Usually, in_window_top is the last record number seen and the lsb of
3377 * in_window is set. The only exception is the initial state (record number 0
3378 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003381void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003382{
3383 ssl->in_window_top = 0;
3384 ssl->in_window = 0;
3385}
3386
Gilles Peskine449bd832023-01-11 14:50:10 +01003387static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003388{
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 return ((uint64_t) buf[0] << 40) |
3390 ((uint64_t) buf[1] << 32) |
3391 ((uint64_t) buf[2] << 24) |
3392 ((uint64_t) buf[3] << 16) |
3393 ((uint64_t) buf[4] << 8) |
3394 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003395}
3396
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003398static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003399{
Janos Follath865b3eb2019-12-16 11:46:15 +00003400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003401 unsigned char *original_in_ctr;
3402
3403 // save original in_ctr
3404 original_in_ctr = ssl->in_ctr;
3405
3406 // use counter from record
3407 ssl->in_ctr = record_in_ctr;
3408
Gilles Peskine449bd832023-01-11 14:50:10 +01003409 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003410
3411 // restore the counter
3412 ssl->in_ctr = original_in_ctr;
3413
3414 return ret;
3415}
3416
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003417/*
3418 * Return 0 if sequence number is acceptable, -1 otherwise
3419 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003420int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003421{
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003423 uint64_t bit;
3424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3426 return 0;
3427 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if (rec_seqnum > ssl->in_window_top) {
3430 return 0;
3431 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003432
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003433 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003434
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 if (bit >= 64) {
3436 return -1;
3437 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003438
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3440 return -1;
3441 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003444}
3445
3446/*
3447 * Update replay window on new validated record
3448 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003449void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003450{
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003454 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003456
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003458 /* Update window_top and the contents of the window */
3459 uint64_t shift = rec_seqnum - ssl->in_window_top;
3460
Gilles Peskine449bd832023-01-11 14:50:10 +01003461 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003462 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003464 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003465 ssl->in_window |= 1;
3466 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003467
3468 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003470 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003471 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003472
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003474 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003476 }
3477}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003479
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003480#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003481/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003482 * Check if a datagram looks like a ClientHello with a valid cookie,
3483 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003484 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003485 *
3486 * - if cookie is valid, return 0
3487 * - if ClientHello looks superficially valid but cookie is not,
3488 * fill obuf and set olen, then
3489 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3490 * - otherwise return a specific error code
3491 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003492MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003493MBEDTLS_STATIC_TESTABLE
3494int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 mbedtls_ssl_context *ssl,
3496 const unsigned char *cli_id, size_t cli_id_len,
3497 const unsigned char *in, size_t in_len,
3498 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003499{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003500 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003501 unsigned char *p;
3502
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003503 /*
3504 * Structure of ClientHello with record and handshake headers,
3505 * and expected values. We don't need to check a lot, more checks will be
3506 * done when actually parsing the ClientHello - skipping those checks
3507 * avoids code duplication and does not make cookie forging any easier.
3508 *
3509 * 0-0 ContentType type; copied, must be handshake
3510 * 1-2 ProtocolVersion version; copied
3511 * 3-4 uint16 epoch; copied, must be 0
3512 * 5-10 uint48 sequence_number; copied
3513 * 11-12 uint16 length; (ignored)
3514 *
3515 * 13-13 HandshakeType msg_type; (ignored)
3516 * 14-16 uint24 length; (ignored)
3517 * 17-18 uint16 message_seq; copied
3518 * 19-21 uint24 fragment_offset; copied, must be 0
3519 * 22-24 uint24 fragment_length; (ignored)
3520 *
3521 * 25-26 ProtocolVersion client_version; (ignored)
3522 * 27-58 Random random; (ignored)
3523 * 59-xx SessionID session_id; 1 byte len + sid_len content
3524 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3525 * ...
3526 *
3527 * Minimum length is 61 bytes.
3528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3530 (unsigned) in_len));
3531 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3532 if (in_len < 61) {
3533 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3534 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003535 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003536
Gilles Peskine449bd832023-01-11 14:50:10 +01003537 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3538 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003539
Gilles Peskine449bd832023-01-11 14:50:10 +01003540 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3541 fragment_offset != 0) {
3542 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3543 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3544 in[0], (unsigned) epoch,
3545 (unsigned) fragment_offset));
3546 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003547 }
3548
3549 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 if (59 + 1 + sid_len + 1 > in_len) {
3551 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3552 (unsigned) sid_len,
3553 (unsigned) in_len - 61));
3554 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003555 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003556 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3557 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003558
3559 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003560 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3561 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3562 (unsigned) cookie_len,
3563 (unsigned) (in_len - sid_len - 61)));
3564 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003565 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003566
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3568 in + sid_len + 61, cookie_len);
3569 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3570 in + sid_len + 61, cookie_len,
3571 cli_id, cli_id_len) == 0) {
3572 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3573 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003574 }
3575
3576 /*
3577 * If we get here, we've got an invalid cookie, let's prepare HVR.
3578 *
3579 * 0-0 ContentType type; copied
3580 * 1-2 ProtocolVersion version; copied
3581 * 3-4 uint16 epoch; copied
3582 * 5-10 uint48 sequence_number; copied
3583 * 11-12 uint16 length; olen - 13
3584 *
3585 * 13-13 HandshakeType msg_type; hello_verify_request
3586 * 14-16 uint24 length; olen - 25
3587 * 17-18 uint16 message_seq; copied
3588 * 19-21 uint24 fragment_offset; copied
3589 * 22-24 uint24 fragment_length; olen - 25
3590 *
3591 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3592 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3593 *
3594 * Minimum length is 28.
3595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003596 if (buf_len < 28) {
3597 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3598 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003599
3600 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003601 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003602 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3603 obuf[25] = 0xfe;
3604 obuf[26] = 0xff;
3605
3606 /* Generate and write actual cookie */
3607 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3609 &p, obuf + buf_len,
3610 cli_id, cli_id_len) != 0) {
3611 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003612 }
3613
3614 *olen = p - obuf;
3615
3616 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003617 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003618
Gilles Peskine449bd832023-01-11 14:50:10 +01003619 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3620 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3621 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003622
Gilles Peskine449bd832023-01-11 14:50:10 +01003623 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003624
Gilles Peskine449bd832023-01-11 14:50:10 +01003625 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003626}
3627
3628/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003629 * Handle possible client reconnect with the same UDP quadruplet
3630 * (RFC 6347 Section 4.2.8).
3631 *
3632 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3633 * that looks like a ClientHello.
3634 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003635 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003636 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003637 * - if the input looks like a ClientHello with a valid cookie,
3638 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003639 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003640 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003641 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003642 * This function is called (through ssl_check_client_reconnect()) when an
3643 * unexpected record is found in ssl_get_next_record(), which will discard the
3644 * record if we return 0, and bubble up the return value otherwise (this
3645 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3646 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003647 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003648MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003649static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003650{
Janos Follath865b3eb2019-12-16 11:46:15 +00003651 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003652 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003653
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 if (ssl->conf->f_cookie_write == NULL ||
3655 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003656 /* If we can't use cookies to verify reachability of the peer,
3657 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3659 "can't check reconnect validity"));
3660 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003661 }
3662
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003663 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 ssl,
3665 ssl->cli_id, ssl->cli_id_len,
3666 ssl->in_buf, ssl->in_left,
3667 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003668
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003670
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003672 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3674 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3675 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003676 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003677 * If the error is permanent we'll catch it later,
3678 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3680 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003681 (void) send_ret;
3682
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003684 }
3685
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 if (ret == 0) {
3687 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3688 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3689 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3690 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003691 }
3692
Gilles Peskine449bd832023-01-11 14:50:10 +01003693 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003694 }
3695
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003697}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003698#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003699
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003701static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003702{
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003704 record_type != MBEDTLS_SSL_MSG_ALERT &&
3705 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3707 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003708 }
3709
Gilles Peskine449bd832023-01-11 14:50:10 +01003710 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003711}
3712
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003713/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003714 * ContentType type;
3715 * ProtocolVersion version;
3716 * uint16 epoch; // DTLS only
3717 * uint48 sequence_number; // DTLS only
3718 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003719 *
3720 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003721 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003722 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3723 *
3724 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003725 * 1. proceed with the record if this function returns 0
3726 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3727 * 3. return CLIENT_RECONNECT if this function return that value
3728 * 4. drop the whole datagram if this function returns anything else.
3729 * Point 2 is needed when the peer is resending, and we have already received
3730 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003731 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003733static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3734 unsigned char *buf,
3735 size_t len,
3736 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003737{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003738 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003739
Hanno Beckere5e7e782019-07-11 12:29:35 +01003740 size_t const rec_hdr_type_offset = 0;
3741 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003742
Hanno Beckere5e7e782019-07-11 12:29:35 +01003743 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3744 rec_hdr_type_len;
3745 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003746
Hanno Beckere5e7e782019-07-11 12:29:35 +01003747 size_t const rec_hdr_ctr_len = 8;
3748#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003749 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003750 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3751 rec_hdr_version_len;
3752
Hanno Beckera0e20d02019-05-15 14:03:01 +01003753#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003754 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3755 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003756 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003757#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3758#endif /* MBEDTLS_SSL_PROTO_DTLS */
3759
3760 size_t rec_hdr_len_offset; /* To be determined */
3761 size_t const rec_hdr_len_len = 2;
3762
3763 /*
3764 * Check minimum lengths for record header.
3765 */
3766
3767#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003769 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003771#endif /* MBEDTLS_SSL_PROTO_DTLS */
3772 {
3773 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3774 }
3775
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3777 MBEDTLS_SSL_DEBUG_MSG(1,
3778 (
3779 "datagram of length %u too small to hold DTLS record header of length %u",
3780 (unsigned) len,
3781 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3782 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003783 }
3784
3785 /*
3786 * Parse and validate record content type
3787 */
3788
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003790
3791 /* Check record content type */
3792#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3793 rec->cid_len = 0;
3794
Gilles Peskine449bd832023-01-11 14:50:10 +01003795 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003796 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003797 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003798 /* Shift pointers to account for record header including CID
3799 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003800 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003801 * ProtocolVersion version;
3802 * uint16 epoch;
3803 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003804 * opaque cid[cid_length]; // Additional field compared to
3805 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003806 * uint16 length;
3807 * opaque enc_content[DTLSCiphertext.length];
3808 * } DTLSCiphertext;
3809 */
3810
3811 /* So far, we only support static CID lengths
3812 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003813 rec_hdr_cid_len = ssl->conf->cid_len;
3814 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003815
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3817 MBEDTLS_SSL_DEBUG_MSG(1,
3818 (
3819 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3820 (unsigned) len,
3821 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3822 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003823 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003824
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003825 /* configured CID len is guaranteed at most 255, see
3826 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3827 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3829 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003830#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003831 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 if (ssl_check_record_type(rec->type)) {
3833 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3834 (unsigned) rec->type));
3835 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003836 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003837 }
3838
Hanno Beckere5e7e782019-07-11 12:29:35 +01003839 /*
3840 * Parse and validate record version
3841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3843 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003844 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3845 buf + rec_hdr_version_offset,
3846 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003847
Gilles Peskine449bd832023-01-11 14:50:10 +01003848 if (tls_version > ssl->conf->max_tls_version) {
3849 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3850 (unsigned) tls_version,
3851 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003852
Gilles Peskine449bd832023-01-11 14:50:10 +01003853 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003854 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003855 /*
3856 * Parse/Copy record sequence number.
3857 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003858
Hanno Beckere5e7e782019-07-11 12:29:35 +01003859#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003860 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003861 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3863 rec_hdr_ctr_len);
3864 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003865#endif /* MBEDTLS_SSL_PROTO_DTLS */
3866 {
3867 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003869 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003870
Hanno Beckere5e7e782019-07-11 12:29:35 +01003871 /*
3872 * Parse record length.
3873 */
3874
Hanno Beckere5e7e782019-07-11 12:29:35 +01003875 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3877 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3878 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003879
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3881 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3882 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003883
3884 rec->buf = buf;
3885 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003886
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 if (rec->data_len == 0) {
3888 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3889 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003890
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003891 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003892 * DTLS-related tests.
3893 * Check epoch before checking length constraint because
3894 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3895 * message gets duplicated before the corresponding Finished message,
3896 * the second ChangeCipherSpec should be discarded because it belongs
3897 * to an old epoch, but not because its length is shorter than
3898 * the minimum record length for packets using the new record transform.
3899 * Note that these two kinds of failures are handled differently,
3900 * as an unexpected record is silently skipped but an invalid
3901 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003902 */
3903#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3905 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003906
Hanno Becker955a5c92019-07-10 17:12:07 +01003907 /* Check that the datagram is large enough to contain a record
3908 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 if (len < rec->data_offset + rec->data_len) {
3910 MBEDTLS_SSL_DEBUG_MSG(1,
3911 (
3912 "Datagram of length %u too small to contain record of advertised length %u.",
3913 (unsigned) len,
3914 (unsigned) (rec->data_offset + rec->data_len)));
3915 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003916 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003917
Hanno Becker37cfe732019-07-10 17:20:01 +01003918 /* Records from other, non-matching epochs are silently discarded.
3919 * (The case of same-port Client reconnects must be considered in
3920 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (rec_epoch != ssl->in_epoch) {
3922 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3923 "expected %u, received %lu",
3924 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003925
Hanno Becker552f7472019-07-19 10:59:12 +01003926 /* Records from the next epoch are considered for buffering
3927 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3929 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3930 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003931 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003932
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003934 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003935#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003936 /* For records from the correct epoch, check whether their
3937 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3939 &rec->ctr[0]) != 0) {
3940 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3941 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003942 }
3943#endif
3944 }
3945#endif /* MBEDTLS_SSL_PROTO_DTLS */
3946
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003948}
Paul Bakker5121ce52009-01-03 21:22:43 +00003949
Paul Bakker5121ce52009-01-03 21:22:43 +00003950
Hanno Becker2fddd372019-07-10 14:37:41 +01003951#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003953static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003954{
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003956
3957 /*
3958 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3959 * access the first byte of record content (handshake type), as we
3960 * have an active transform (possibly iv_len != 0), so use the
3961 * fact that the record header len is 13 instead.
3962 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003964 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003966 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3967 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003968 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3969 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3970 "from the same port"));
3971 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003972 }
3973
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003975}
Hanno Becker2fddd372019-07-10 14:37:41 +01003976#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003977
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003978/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003979 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003980 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003981MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003982static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3983 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003984{
3985 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003986
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3988 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003989
Ronald Cron7e38cba2021-11-24 12:43:39 +01003990 /*
3991 * In TLS 1.3, always treat ChangeCipherSpec records
3992 * as unencrypted. The only thing we do with them is
3993 * check the length and content and ignore them.
3994 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003995#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if (ssl->transform_in != NULL &&
3997 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3998 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003999 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01004001 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004002#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01004003
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01004005 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
4008 rec)) != 0) {
4009 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01004010
Hanno Beckera0e20d02019-05-15 14:03:01 +01004011#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004013 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4015 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004016 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004017 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004018#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004021 }
4022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (old_msg_type != rec->type) {
4024 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4025 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004026 }
4027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4029 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004030
Hanno Beckera0e20d02019-05-15 14:03:01 +01004031#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004032 /* We have already checked the record content type
4033 * in ssl_parse_record_header(), failing or silently
4034 * dropping the record in the case of an unknown type.
4035 *
4036 * Since with the use of CIDs, the record content type
4037 * might change during decryption, re-check the record
4038 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 if (ssl_check_record_type(rec->type)) {
4040 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4041 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004042 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004043#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004046#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4048 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004049 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4051 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004052 }
4053#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4054
4055 ssl->nb_zero++;
4056
4057 /*
4058 * Three or more empty messages may be a DoS attack
4059 * (excessive CPU consumption).
4060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (ssl->nb_zero > 3) {
4062 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4063 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004064 /* Treat the records as if they were not properly authenticated,
4065 * thereby failing the connection if we see more than allowed
4066 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004068 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004070 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004072
4073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004075 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004077#endif
4078 {
4079 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4081 i > mbedtls_ssl_ep_len(ssl); i--) {
4082 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004083 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004085 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004086
4087 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if (i == mbedtls_ssl_ep_len(ssl)) {
4089 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4090 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004091 }
4092 }
4093
Paul Bakker5121ce52009-01-03 21:22:43 +00004094 }
4095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004096#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4098 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004099 }
4100#endif
4101
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004102 /* Check actual (decrypted) record content length against
4103 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4105 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4106 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004107 }
4108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004110}
4111
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004112/*
4113 * Read a record.
4114 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004115 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4116 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4117 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004118 */
Hanno Becker1097b342018-08-15 14:09:41 +01004119
4120/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004121MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004122static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004124static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004125MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004126static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4129 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004130{
Janos Follath865b3eb2019-12-16 11:46:15 +00004131 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004136 do {
Simon Butcher99000142016-10-13 17:21:01 +01004137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 ret = ssl_consume_current_message(ssl);
4139 if (ret != 0) {
4140 return ret;
4141 }
Hanno Becker26994592018-08-15 14:14:59 +01004142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004144 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004145#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004146
Hanno Becker40f50842018-08-15 14:48:01 +01004147 /* We only check for buffered messages if the
4148 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4150 ssl_next_record_is_in_datagram(ssl) == 0) {
4151 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004152 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 }
Hanno Becker40f50842018-08-15 14:48:01 +01004154 }
4155
Hanno Becker40f50842018-08-15 14:48:01 +01004156#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (dtls_have_buffered == 0) {
4158 ret = ssl_get_next_record(ssl);
4159 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004160 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 }
Hanno Becker40f50842018-08-15 14:48:01 +01004162
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (ret != 0) {
4164 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4165 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004166 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004167 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004168 }
4169
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004171
Hanno Becker40f50842018-08-15 14:48:01 +01004172#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004174 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 ret = ssl_buffer_message(ssl);
4176 if (ret != 0) {
4177 return ret;
4178 }
Hanno Becker40f50842018-08-15 14:48:01 +01004179
4180 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4181 }
4182#endif /* MBEDTLS_SSL_PROTO_DTLS */
4183
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4185 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if (0 != ret) {
4188 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4189 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004190 }
4191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4193 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004194 ret = mbedtls_ssl_update_handshake_status(ssl);
4195 if (0 != ret) {
4196 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4197 return ret;
4198 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004199 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 } else {
4201 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004202 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004203 }
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004208}
4209
Hanno Becker40f50842018-08-15 14:48:01 +01004210#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004212static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004213{
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 if (ssl->in_left > ssl->next_record_offset) {
4215 return 1;
4216 }
Simon Butcher99000142016-10-13 17:21:01 +01004217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004219}
4220
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004221MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004222static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004223{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004226 int ret = 0;
4227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (hs == NULL) {
4229 return -1;
4230 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004231
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4235 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004236 /* Check if we have seen a ChangeCipherSpec before.
4237 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (!hs->buffering.seen_ccs) {
4239 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004240 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004241 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004242 }
4243
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004245 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4246 ssl->in_msglen = 1;
4247 ssl->in_msg[0] = 1;
4248
4249 /* As long as they are equal, the exact value doesn't matter. */
4250 ssl->in_left = 0;
4251 ssl->next_record_offset = 0;
4252
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004253 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004254 goto exit;
4255 }
Hanno Becker37f95322018-08-16 13:55:32 +01004256
Hanno Beckerb8f50142018-08-28 10:01:34 +01004257#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004258 /* Debug only */
4259 {
4260 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004262 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (hs_buf->is_valid == 1) {
4264 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4265 hs->in_msg_seq + offset,
4266 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004267 }
4268 }
4269 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004270#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004271
4272 /* Check if we have buffered and/or fully reassembled the
4273 * next handshake message. */
4274 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004276 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 size_t msg_len = (hs_buf->data[1] << 16) |
4278 (hs_buf->data[2] << 8) |
4279 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004280
4281 /* Double-check that we haven't accidentally buffered
4282 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4284 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4285 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004286 }
4287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4289 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4290 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004291
4292 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4293 ssl->in_hslen = msg_len + 12;
4294 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004296
4297 ret = 0;
4298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 } else {
4300 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4301 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004302 }
4303
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004304 ret = -1;
4305
4306exit:
4307
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4309 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004310}
4311
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004313static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4314 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004315{
4316 int offset;
4317 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4319 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004320
Hanno Becker01315ea2018-08-21 17:22:17 +01004321 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004323
4324 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4326 hs->buffering.total_bytes_buffered)) {
4327 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4328 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004329 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004330
Hanno Becker4f432ad2018-08-28 10:02:32 +01004331 /* We don't have enough space to buffer the next expected handshake
4332 * message. Remove buffers used for future messages to gain space,
4333 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4335 offset >= 0; offset--) {
4336 MBEDTLS_SSL_DEBUG_MSG(2,
4337 (
4338 "Free buffering slot %d to make space for reassembly of next handshake message",
4339 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004342
4343 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4345 hs->buffering.total_bytes_buffered)) {
4346 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4347 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004348 }
4349 }
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004352}
4353
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004354MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004355static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004356{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004357 int ret = 0;
4358 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if (hs == NULL) {
4361 return 0;
4362 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004367 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004369
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004370 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004371 break;
4372
4373 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004374 {
4375 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004377 mbedtls_ssl_hs_buffer *hs_buf;
4378 size_t msg_len = ssl->in_hslen - 12;
4379
4380 /* We should never receive an old handshake
4381 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4383 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004385 }
4386
4387 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004389 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 MBEDTLS_SSL_DEBUG_MSG(2,
4391 ("Ignore future HS message with sequence number %u, "
4392 "buffering window %u - %u",
4393 recv_msg_seq, ssl->handshake->in_msg_seq,
4394 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4395 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004396
4397 goto exit;
4398 }
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4401 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004404
4405 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004407 size_t reassembly_buf_sz;
4408
Hanno Becker37f95322018-08-16 13:55:32 +01004409 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004411
4412 /* We copy the message back into the input buffer
4413 * after reassembly, so check that it's not too large.
4414 * This is an implementation-specific limitation
4415 * and not one from the standard, hence it is not
4416 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004418 /* Ignore message */
4419 goto exit;
4420 }
4421
Hanno Beckere0b150f2018-08-21 15:51:03 +01004422 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (hs->buffering.total_bytes_buffered >
4424 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4425 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4426 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004427 }
4428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4430 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4433 hs->buffering.total_bytes_buffered)) {
4434 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004435 /* If we can't buffer a future message because
4436 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 MBEDTLS_SSL_DEBUG_MSG(2,
4438 ("Buffering of future message of size %"
4439 MBEDTLS_PRINTF_SIZET
4440 " would exceed the compile-time limit %"
4441 MBEDTLS_PRINTF_SIZET
4442 " (already %" MBEDTLS_PRINTF_SIZET
4443 " bytes buffered) -- ignore\n",
4444 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4445 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 } else {
4448 MBEDTLS_SSL_DEBUG_MSG(2,
4449 ("Buffering of future message of size %"
4450 MBEDTLS_PRINTF_SIZET
4451 " would exceed the compile-time limit %"
4452 MBEDTLS_PRINTF_SIZET
4453 " (already %" MBEDTLS_PRINTF_SIZET
4454 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4455 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4456 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004457 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4460 MBEDTLS_SSL_DEBUG_MSG(2,
4461 ("Reassembly of next message of size %"
4462 MBEDTLS_PRINTF_SIZET
4463 " (%" MBEDTLS_PRINTF_SIZET
4464 " with bitmap) would exceed"
4465 " the compile-time limit %"
4466 MBEDTLS_PRINTF_SIZET
4467 " (already %" MBEDTLS_PRINTF_SIZET
4468 " bytes buffered) -- fail\n",
4469 msg_len,
4470 reassembly_buf_sz,
4471 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4472 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004473 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4474 goto exit;
4475 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004476 }
4477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 MBEDTLS_SSL_DEBUG_MSG(2,
4479 ("initialize reassembly, total length = %"
4480 MBEDTLS_PRINTF_SIZET,
4481 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4484 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004485 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004486 goto exit;
4487 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004488 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004489
4490 /* Prepare final header: copy msg_type, length and message_seq,
4491 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 memcpy(hs_buf->data, ssl->in_msg, 6);
4493 memset(hs_buf->data + 6, 0, 3);
4494 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004495
4496 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004497
4498 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004500 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4502 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004503 /* Ignore */
4504 goto exit;
4505 }
4506 }
4507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004509 size_t frag_len, frag_off;
4510 unsigned char * const msg = hs_buf->data + 12;
4511
4512 /*
4513 * Check and copy current fragment
4514 */
4515
4516 /* Validation of header fields already done in
4517 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 frag_off = ssl_get_hs_frag_off(ssl);
4519 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4522 ", length = %" MBEDTLS_PRINTF_SIZET,
4523 frag_off, frag_len));
4524 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004525
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004527 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 ssl_bitmask_set(bitmask, frag_off, frag_len);
4529 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4530 msg_len) == 0);
4531 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004532 hs_buf->is_complete = 1;
4533 }
4534
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4536 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004537 }
4538
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004539 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004540 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004541
4542 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004543 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004544 break;
4545 }
4546
4547exit:
4548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4550 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004551}
4552#endif /* MBEDTLS_SSL_PROTO_DTLS */
4553
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004555static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004556{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004557 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004558 * Consume last content-layer message and potentially
4559 * update in_msglen which keeps track of the contents'
4560 * consumption state.
4561 *
4562 * (1) Handshake messages:
4563 * Remove last handshake message, move content
4564 * and adapt in_msglen.
4565 *
4566 * (2) Alert messages:
4567 * Consume whole record content, in_msglen = 0.
4568 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004569 * (3) Change cipher spec:
4570 * Consume whole record content, in_msglen = 0.
4571 *
4572 * (4) Application data:
4573 * Don't do anything - the record layer provides
4574 * the application data as a stream transport
4575 * and consumes through mbedtls_ssl_read only.
4576 *
4577 */
4578
4579 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004581 /* Hard assertion to be sure that no application data
4582 * is in flight, as corrupting ssl->in_msglen during
4583 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->in_offt != NULL) {
4585 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4586 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004587 }
4588
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004589 /*
4590 * Get next Handshake message in the current record
4591 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004592
Hanno Becker4a810fb2017-05-24 16:27:30 +01004593 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004594 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004595 * current handshake content: If DTLS handshake
4596 * fragmentation is used, that's the fragment
4597 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004598 * size here is faulty and should be changed at
4599 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004600 * (2) While it doesn't seem to cause problems, one
4601 * has to be very careful not to assume that in_hslen
4602 * is always <= in_msglen in a sensible communication.
4603 * Again, it's wrong for DTLS handshake fragmentation.
4604 * The following check is therefore mandatory, and
4605 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004606 * Additionally, ssl->in_hslen might be arbitrarily out of
4607 * bounds after handling a DTLS message with an unexpected
4608 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004611 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4613 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4616 ssl->in_msg, ssl->in_msglen);
4617 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004618 ssl->in_msglen = 0;
4619 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004620
Hanno Becker4a810fb2017-05-24 16:27:30 +01004621 ssl->in_hslen = 0;
4622 }
4623 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 else if (ssl->in_offt != NULL) {
4625 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004626 }
4627 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004629 ssl->in_msglen = 0;
4630 }
4631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004633}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004634
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004636static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004637{
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (ssl->in_msglen > 0) {
4639 return 1;
4640 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004643}
4644
Hanno Becker5f066e72018-08-16 14:56:31 +01004645#if defined(MBEDTLS_SSL_PROTO_DTLS)
4646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004648{
4649 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004651 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004655 hs->buffering.total_bytes_buffered -=
4656 hs->buffering.future_record.len;
4657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004659 hs->buffering.future_record.data = NULL;
4660 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004661}
4662
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004663MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004664static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004665{
4666 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004668 size_t rec_len;
4669 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004670#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4671 size_t in_buf_len = ssl->in_buf_len;
4672#else
4673 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4674#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4676 return 0;
4677 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 if (hs == NULL) {
4680 return 0;
4681 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004682
Hanno Becker5f066e72018-08-16 14:56:31 +01004683 rec = hs->buffering.future_record.data;
4684 rec_len = hs->buffering.future_record.len;
4685 rec_epoch = hs->buffering.future_record.epoch;
4686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 if (rec == NULL) {
4688 return 0;
4689 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004690
Hanno Becker4cb782d2018-08-20 11:19:05 +01004691 /* Only consider loading future records if the
4692 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4694 return 0;
4695 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 if (rec_epoch != ssl->in_epoch) {
4700 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004701 goto exit;
4702 }
4703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004705
4706 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4708 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4709 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004710 }
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004713 ssl->in_left = rec_len;
4714 ssl->next_record_offset = 0;
4715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004717
4718exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4720 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004721}
4722
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004723MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004724static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4725 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004726{
4727 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004728
4729 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if (hs == NULL) {
4731 return 0;
4732 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004733
4734 /* Only buffer handshake records (we are only interested
4735 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4737 return 0;
4738 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004739
4740 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (hs->buffering.future_record.data != NULL) {
4742 return 0;
4743 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004744
Hanno Becker01315ea2018-08-21 17:22:17 +01004745 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4747 hs->buffering.total_bytes_buffered)) {
4748 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4749 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4750 " (already %" MBEDTLS_PRINTF_SIZET
4751 " bytes buffered) -- ignore\n",
4752 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4753 hs->buffering.total_bytes_buffered));
4754 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004755 }
4756
Hanno Becker5f066e72018-08-16 14:56:31 +01004757 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4759 ssl->in_epoch + 1U));
4760 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004761
4762 /* ssl_parse_record_header() only considers records
4763 * of the next epoch as candidates for buffering. */
4764 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004765 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004766
4767 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 mbedtls_calloc(1, hs->buffering.future_record.len);
4769 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004770 /* If we run out of RAM trying to buffer a
4771 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004773 }
4774
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004776
Hanno Becker519f15d2019-07-11 12:43:20 +01004777 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004779}
4780
4781#endif /* MBEDTLS_SSL_PROTO_DTLS */
4782
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004783MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004784static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004785{
Janos Follath865b3eb2019-12-16 11:46:15 +00004786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004787 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004788
Hanno Becker5f066e72018-08-16 14:56:31 +01004789#if defined(MBEDTLS_SSL_PROTO_DTLS)
4790 /* We might have buffered a future record; if so,
4791 * and if the epoch matches now, load it.
4792 * On success, this call will set ssl->in_left to
4793 * the length of the buffered record, so that
4794 * the calls to ssl_fetch_input() below will
4795 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 ret = ssl_load_buffered_record(ssl);
4797 if (ret != 0) {
4798 return ret;
4799 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004800#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004801
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004802 /* Ensure that we have enough space available for the default form
4803 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4804 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4806 if (ret != 0) {
4807 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4808 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004809 }
4810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4812 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004813#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4815 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4816 ret = ssl_buffer_future_record(ssl, &rec);
4817 if (ret != 0) {
4818 return ret;
4819 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004820
4821 /* Fall through to handling of unexpected records */
4822 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4823 }
4824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004826#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004827 /* Reset in pointers to default state for TLS/DTLS records,
4828 * assuming no CID and no offset between record content and
4829 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004831
Hanno Becker7ae20e02019-07-12 08:33:49 +01004832 /* Setup internal message pointers from record structure. */
4833 ssl->in_msgtype = rec.type;
4834#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4835 ssl->in_len = ssl->in_cid + rec.cid_len;
4836#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4837 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4838 ssl->in_msglen = rec.data_len;
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 ret = ssl_check_client_reconnect(ssl);
4841 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4842 if (ret != 0) {
4843 return ret;
4844 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004845#endif
4846
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004847 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004848 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4851 "(header)"));
4852 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004853 /* Skip invalid record and the rest of the datagram */
4854 ssl->next_record_offset = 0;
4855 ssl->in_left = 0;
4856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4858 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004859 }
4860
4861 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4863 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004864#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004865 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004867 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004868 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004870#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004872 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004873 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (ssl->next_record_offset < ssl->in_left) {
4875 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004876 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004878#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004879 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004880 /*
4881 * Fetch record contents from underlying transport.
4882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4884 if (ret != 0) {
4885 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4886 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004887 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004888
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004889 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004890 }
4891
4892 /*
4893 * Decrypt record contents.
4894 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004899 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004901 /* Except when waiting for Finished as a bad mac here
4902 * probably means something went wrong in the handshake
4903 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4905 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004906#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4908 mbedtls_ssl_send_alert_message(ssl,
4909 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4910 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004911 }
4912#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004914 }
4915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (ssl->conf->badmac_limit != 0 &&
4917 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4918 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4919 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004920 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004921
Hanno Becker4a810fb2017-05-24 16:27:30 +01004922 /* As above, invalid records cause
4923 * dismissal of the whole datagram. */
4924
4925 ssl->next_record_offset = 0;
4926 ssl->in_left = 0;
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4929 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004930 }
4931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 return ret;
4933 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004934#endif
4935 {
4936 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4939 mbedtls_ssl_send_alert_message(ssl,
4940 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4941 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004942 }
4943#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004945 }
4946 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004947
Hanno Becker44d89b22019-07-12 09:40:44 +01004948
4949 /* Reset in pointers to default state for TLS/DTLS records,
4950 * assuming no CID and no offset between record content and
4951 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004953#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4954 ssl->in_len = ssl->in_cid + rec.cid_len;
4955#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004956 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004957
Hanno Becker8685c822019-07-12 09:37:30 +01004958 /* The record content type may change during decryption,
4959 * so re-read it. */
4960 ssl->in_msgtype = rec.type;
4961 /* Also update the input buffer, because unfortunately
4962 * the server-side ssl_parse_client_hello() reparses the
4963 * record header when receiving a ClientHello initiating
4964 * a renegotiation. */
4965 ssl->in_hdr[0] = rec.type;
4966 ssl->in_msg = rec.buf + rec.data_offset;
4967 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004971}
4972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004974{
Janos Follath865b3eb2019-12-16 11:46:15 +00004975 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004976
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004977 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004978 * Handle particular types of records
4979 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4981 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4982 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004983 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004984 }
4985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4987 if (ssl->in_msglen != 1) {
4988 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4989 ssl->in_msglen));
4990 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004991 }
4992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 if (ssl->in_msg[0] != 1) {
4994 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4995 ssl->in_msg[0]));
4996 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004997 }
4998
4999#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01005001 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
5003 if (ssl->handshake == NULL) {
5004 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
5005 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005006 }
5007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
5009 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005010 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005011#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005012
Ronald Cron6f135e12021-12-08 16:57:54 +01005013#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005015#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 MBEDTLS_SSL_DEBUG_MSG(1,
5017 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5018 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005019#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 MBEDTLS_SSL_DEBUG_MSG(1,
5021 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5022 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005023#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5024 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005025#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005026 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5029 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005030 /* Note: Standard allows for more than one 2 byte alert
5031 to be packed in a single message, but Mbed TLS doesn't
5032 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5034 ssl->in_msglen));
5035 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005036 }
5037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5039 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005040
5041 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005042 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5045 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5046 ssl->in_msg[1]));
5047 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005048 }
5049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5051 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5052 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5053 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005054 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005055
5056#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5058 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5059 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005060 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005062 }
5063#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005064 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005065 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005066 }
5067
Hanno Beckerc76c6192017-06-06 10:03:17 +01005068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005070 /* Drop unexpected ApplicationData records,
5071 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5073 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005074#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5076 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005077#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 ) {
5079 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5080 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005081 }
5082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if (ssl->handshake != NULL &&
5084 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5085 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005086 }
5087 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005088#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005091}
5092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005094{
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 return mbedtls_ssl_send_alert_message(ssl,
5096 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5097 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005098}
5099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5101 unsigned char level,
5102 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005103{
Janos Follath865b3eb2019-12-16 11:46:15 +00005104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005105
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 if (ssl == NULL || ssl->conf == NULL) {
5107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5108 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (ssl->out_left != 0) {
5111 return mbedtls_ssl_flush_output(ssl);
5112 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5115 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005118 ssl->out_msglen = 2;
5119 ssl->out_msg[0] = level;
5120 ssl->out_msg[1] = message;
5121
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5124 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005125 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005129}
5130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005132{
Janos Follath865b3eb2019-12-16 11:46:15 +00005133 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005138 ssl->out_msglen = 1;
5139 ssl->out_msg[0] = 1;
5140
Paul Bakker5121ce52009-01-03 21:22:43 +00005141 ssl->state++;
5142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5144 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5145 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005146 }
5147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005151}
5152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005154{
Janos Follath865b3eb2019-12-16 11:46:15 +00005155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005158
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5160 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5161 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005162 }
5163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5165 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5166 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5167 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5168 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005169 }
5170
Hanno Beckere678eaa2018-08-21 14:57:46 +01005171 /* CCS records are only accepted if they have length 1 and content '1',
5172 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005173
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005174 /*
5175 * Switch to our negotiated transform and session parameters for inbound
5176 * data.
5177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005179#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005180 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005181#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005182 ssl->session_in = ssl->session_negotiate;
5183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005186#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005188#endif
5189
5190 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (++ssl->in_epoch == 0) {
5192 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005193 /* This is highly unlikely to happen for legitimate reasons, so
5194 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005196 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005202
Paul Bakker5121ce52009-01-03 21:22:43 +00005203 ssl->state++;
5204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005208}
5209
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005210/* Once ssl->out_hdr as the address of the beginning of the
5211 * next outgoing record is set, deduce the other pointers.
5212 *
5213 * Note: For TLS, we save the implicit record sequence number
5214 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5215 * and the caller has to make sure there's space for this.
5216 */
5217
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005218static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005220{
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005222}
5223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5225 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005226{
5227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005229 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005230#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005231 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005232 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005234 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005236#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005237 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005238#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005239 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005241#endif
5242 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005243 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005244#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005245 ssl->out_cid = ssl->out_len;
5246#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005247 ssl->out_iv = ssl->out_hdr + 5;
5248 }
5249
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005250 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005251 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (transform != NULL) {
5253 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5254 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005255}
5256
5257/* Once ssl->in_hdr as the address of the beginning of the
5258 * next incoming record is set, deduce the other pointers.
5259 *
5260 * Note: For TLS, we save the implicit record sequence number
5261 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5262 * and the caller has to make sure there's space for this.
5263 */
5264
Gilles Peskine449bd832023-01-11 14:50:10 +01005265void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005266{
Hanno Becker79594fd2019-05-08 09:38:41 +01005267 /* This function sets the pointers to match the case
5268 * of unprotected TLS/DTLS records, with both ssl->in_iv
5269 * and ssl->in_msg pointing to the beginning of the record
5270 * content.
5271 *
5272 * When decrypting a protected record, ssl->in_msg
5273 * will be shifted to point to the beginning of the
5274 * record plaintext.
5275 */
5276
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005277#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005279 /* This sets the header pointers to match records
5280 * without CID. When we receive a record containing
5281 * a CID, the fields are shifted accordingly in
5282 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005283 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005284#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005285 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005286 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005287#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005288 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005289#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005290 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005292#endif
5293 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005294 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005295 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005297 ssl->in_cid = ssl->in_len;
5298#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005299 ssl->in_iv = ssl->in_hdr + 5;
5300 }
5301
Hanno Becker79594fd2019-05-08 09:38:41 +01005302 /* This will be adjusted at record decryption time. */
5303 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005304}
5305
Paul Bakker5121ce52009-01-03 21:22:43 +00005306/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005307 * Setup an SSL context
5308 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005311{
5312 /* Set the incoming and outgoing record pointers. */
5313#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005315 ssl->out_hdr = ssl->out_buf;
5316 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005318#endif /* MBEDTLS_SSL_PROTO_DTLS */
5319 {
Hanno Becker12078f42021-03-02 15:28:41 +00005320 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005321 ssl->out_hdr = ssl->out_buf + 8;
5322 ssl->in_hdr = ssl->in_buf + 8;
5323 }
5324
5325 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5327 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005328}
5329
Paul Bakker5121ce52009-01-03 21:22:43 +00005330/*
5331 * SSL get accessors
5332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005333size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005334{
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005336}
5337
Gilles Peskine449bd832023-01-11 14:50:10 +01005338int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005339{
5340 /*
5341 * Case A: We're currently holding back
5342 * a message for further processing.
5343 */
5344
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (ssl->keep_current_message == 1) {
5346 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5347 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005348 }
5349
5350 /*
5351 * Case B: Further records are pending in the current datagram.
5352 */
5353
5354#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5356 ssl->in_left > ssl->next_record_offset) {
5357 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5358 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005359 }
5360#endif /* MBEDTLS_SSL_PROTO_DTLS */
5361
5362 /*
5363 * Case C: A handshake message is being processed.
5364 */
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5367 MBEDTLS_SSL_DEBUG_MSG(3,
5368 ("ssl_check_pending: more handshake messages within current record"));
5369 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005370 }
5371
5372 /*
5373 * Case D: An application data message is being processed
5374 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if (ssl->in_offt != NULL) {
5376 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5377 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005378 }
5379
5380 /*
5381 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005382 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005383 * we implement support for multiple alerts in single records.
5384 */
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5387 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005388}
5389
Paul Bakker43ca69c2011-01-15 17:35:19 +00005390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005392{
Hanno Becker3136ede2018-08-17 15:28:19 +01005393 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005394 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005395 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005396#if defined(MBEDTLS_USE_PSA_CRYPTO)
5397 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5398 psa_key_type_t key_type;
5399#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005402
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if (transform == NULL) {
5404 return (int) out_hdr_len;
5405 }
Hanno Becker78640902018-08-13 16:35:15 +01005406
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005407
5408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if (transform->psa_alg == PSA_ALG_GCM ||
5410 transform->psa_alg == PSA_ALG_CCM ||
5411 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5412 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5413 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005414 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5416 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5417 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005420
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005421 /* Expansion due to the addition of the MAC. */
5422 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005423
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005424 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005425 * Theoretically up to 256 bytes, but we never use
5426 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005427 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005428
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005429 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005430 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005431#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005432 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005433#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 } else {
5435 MBEDTLS_SSL_DEBUG_MSG(1,
5436 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5437 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005438 }
5439#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 case MBEDTLS_MODE_GCM:
5442 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005443 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005444 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005445 transform_expansion = transform->minlen;
5446 break;
5447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005449
5450 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005452
Hanno Becker3136ede2018-08-17 15:28:19 +01005453 /* Expansion due to the addition of the MAC. */
5454 transform_expansion += transform->maclen;
5455
5456 /* Expansion due to the addition of CBC padding;
5457 * Theoretically up to 256 bytes, but we never use
5458 * more than the block size of the underlying cipher. */
5459 transform_expansion += block_size;
5460
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005461 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005462 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005464 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005465#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005466
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005467 break;
5468
5469 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005472 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005473#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005474
Hanno Beckera0e20d02019-05-15 14:03:01 +01005475#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005477 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005479#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005482}
5483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005485/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005486 * Check record counters and renegotiate if they're above the limit.
5487 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005488MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005489static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005490{
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005492 int in_ctr_cmp;
5493 int out_ctr_cmp;
5494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5498 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005499 }
5500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5502 &ssl->conf->renego_period[ep_len],
5503 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5504 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005505 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5509 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005510 }
5511
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5513 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005514}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005516
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5518
5519#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005520MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005521static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005522{
5523
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5525 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5526 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005527 }
5528
5529 ssl->keep_current_message = 1;
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5532 mbedtls_ssl_handshake_set_state(ssl,
5533 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005534
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005536}
5537#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5538
Jerry Yua0446a02022-07-13 11:22:55 +08005539MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005540static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005541{
5542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005544
5545#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5547 int ret = ssl_tls13_check_new_session_ticket(ssl);
5548 if (ret != 0) {
5549 return ret;
5550 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005551 }
5552#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5553
5554 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005556}
5557#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5558
5559#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005560/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005561 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005562 * may only be sent for the purpose of initiating renegotiations.
5563 *
5564 * This function is introduced as a separate helper since the handling
5565 * of post-handshake handshake messages changes significantly in TLS 1.3,
5566 * and having a helper function allows to distinguish between TLS <= 1.2 and
5567 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5568 */
Jerry Yua0446a02022-07-13 11:22:55 +08005569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005570static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005571{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005573
5574 /*
5575 * - For client-side, expect SERVER_HELLO_REQUEST.
5576 * - For server-side, expect CLIENT_HELLO.
5577 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5578 */
5579
5580#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5582 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5583 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5584 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005585
5586 /* With DTLS, drop the packet (probably from last handshake) */
5587#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5589 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005590 }
5591#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005593 }
5594#endif /* MBEDTLS_SSL_CLI_C */
5595
5596#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5598 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5599 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005600
5601 /* With DTLS, drop the packet (probably from last handshake) */
5602#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5604 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005605 }
5606#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005608 }
5609#endif /* MBEDTLS_SSL_SRV_C */
5610
5611#if defined(MBEDTLS_SSL_RENEGOTIATION)
5612 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5614 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5615 ssl->conf->allow_legacy_renegotiation ==
5616 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005617 /*
5618 * Accept renegotiation request
5619 */
5620
5621 /* DTLS clients need to know renego is server-initiated */
5622#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5624 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005625 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5626 }
5627#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 ret = mbedtls_ssl_start_renegotiation(ssl);
5629 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5630 ret != 0) {
5631 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5632 ret);
5633 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005634 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005636#endif /* MBEDTLS_SSL_RENEGOTIATION */
5637 {
5638 /*
5639 * Refuse renegotiation
5640 */
5641
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005643
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5645 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5646 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5647 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005648 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005649 }
5650
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005652}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005653#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5654
5655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005656static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005657{
5658 /* Check protocol version and dispatch accordingly. */
5659#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5661 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005662 }
5663#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5664
5665#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5667 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005668 }
5669#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5670
5671 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005673}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005674
Paul Bakker48916f92012-09-16 19:57:18 +00005675/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005676 * Receive application data decrypted from the SSL layer
5677 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005678int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005679{
Janos Follath865b3eb2019-12-16 11:46:15 +00005680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005681 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 if (ssl == NULL || ssl->conf == NULL) {
5684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5685 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005686
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5691 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5692 return ret;
5693 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (ssl->handshake != NULL &&
5696 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5697 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5698 return ret;
5699 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005700 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005701 }
5702#endif
5703
Hanno Becker4a810fb2017-05-24 16:27:30 +01005704 /*
5705 * Check if renegotiation is necessary and/or handshake is
5706 * in process. If yes, perform/continue, and fall through
5707 * if an unexpected packet is received while the client
5708 * is waiting for the ServerHello.
5709 *
5710 * (There is no equivalent to the last condition on
5711 * the server-side as it is not treated as within
5712 * a handshake while waiting for the ClientHello
5713 * after a renegotiation request.)
5714 */
5715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005716#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 ret = ssl_check_ctr_renegotiate(ssl);
5718 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5719 ret != 0) {
5720 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5721 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005722 }
5723#endif
5724
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5726 ret = mbedtls_ssl_handshake(ssl);
5727 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5728 ret != 0) {
5729 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5730 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005731 }
5732 }
5733
Hanno Beckere41158b2017-10-23 13:30:32 +01005734 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005736 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 if (ssl->f_get_timer != NULL &&
5738 ssl->f_get_timer(ssl->p_timer) == -1) {
5739 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005740 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5743 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5744 return 0;
5745 }
Paul Bakker831a7552011-05-18 13:32:51 +00005746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5748 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005749 }
5750
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 if (ssl->in_msglen == 0 &&
5752 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005753 /*
5754 * OpenSSL sends empty messages to randomize the IV
5755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5757 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5758 return 0;
5759 }
Paul Bakker831a7552011-05-18 13:32:51 +00005760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5762 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005763 }
5764 }
5765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5767 ret = ssl_handle_hs_message_post_handshake(ssl);
5768 if (ret != 0) {
5769 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5770 ret);
5771 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005772 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005773
Hanno Beckerf26cc722021-04-21 07:30:13 +01005774 /* At this point, we don't know whether the renegotiation triggered
5775 * by the post-handshake message has been completed or not. The cases
5776 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005777 * 1) The renegotiation is complete. In this case, no new record
5778 * has been read yet.
5779 * 2) The renegotiation is incomplete because the client received
5780 * an application data record while awaiting the ServerHello.
5781 * 3) The renegotiation is incomplete because the client received
5782 * a non-handshake, non-application data message while awaiting
5783 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005784 *
5785 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005786 * - For 1), the next iteration will read a new record and check
5787 * if it's application data.
5788 * - For 2), the loop condition isn't satisfied as application data
5789 * is present, hence continue is the same as break
5790 * - For 3), the loop condition is satisfied and read_record
5791 * will re-deliver the message that was held back by the client
5792 * when expecting the ServerHello.
5793 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005794
Hanno Becker90333da2017-10-10 11:27:13 +01005795 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005796 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005797#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5799 if (ssl->conf->renego_max_records >= 0) {
5800 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5801 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5802 "but not honored by client"));
5803 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005804 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005805 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005806 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005807#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5811 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5812 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005813 }
5814
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5816 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5817 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005818 }
5819
5820 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005821
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005822 /* We're going to return something now, cancel timer,
5823 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5825 mbedtls_ssl_set_timer(ssl, 0);
5826 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005827
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005828#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005829 /* If we requested renego but received AppData, resend HelloRequest.
5830 * Do it now, after setting in_offt, to avoid taking this branch
5831 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005832#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5834 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5835 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5836 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5837 ret);
5838 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005839 }
5840 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005841#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005842#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005843 }
5844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005846 ? len : ssl->in_msglen;
5847
ashesman937d6d52022-02-17 11:08:27 +13005848 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005849 memcpy(buf, ssl->in_offt, n);
5850 ssl->in_msglen -= n;
5851 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005852
gabor-mezei-arma3214132020-07-15 10:55:00 +02005853 /* Zeroising the plaintext buffer to erase unused application data
5854 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005858 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005859 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005860 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005862 /* more data available */
5863 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005864 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005865
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005867
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005869}
5870
5871/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005872 * Send application data to be encrypted by the SSL layer, taking care of max
5873 * fragment length and buffer size.
5874 *
5875 * According to RFC 5246 Section 6.2.1:
5876 *
5877 * Zero-length fragments of Application data MAY be sent as they are
5878 * potentially useful as a traffic analysis countermeasure.
5879 *
5880 * Therefore, it is possible that the input message length is 0 and the
5881 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005882 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005883MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005884static int ssl_write_real(mbedtls_ssl_context *ssl,
5885 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005886{
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005888 const size_t max_len = (size_t) ret;
5889
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 if (ret < 0) {
5891 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5892 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005893 }
5894
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005896#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5898 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5899 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5900 " > %" MBEDTLS_PRINTF_SIZET,
5901 len, max_len));
5902 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5903 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005904#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005906 }
Paul Bakker887bd502011-06-08 13:10:54 +00005907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005909 /*
5910 * The user has previously tried to send the data and
5911 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5912 * written. In this case, we expect the high-level write function
5913 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5914 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5916 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5917 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005920 /*
5921 * The user is trying to send a message the first time, so we need to
5922 * copy the data into the internal buffers and setup the data structure
5923 * to keep track of partial writes
5924 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005925 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005926 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005927 if (len > 0) {
5928 memcpy(ssl->out_msg, buf, len);
5929 }
Paul Bakker887bd502011-06-08 13:10:54 +00005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5932 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5933 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005934 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005935 }
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005938}
5939
5940/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005941 * Write application data (public-facing wrapper)
5942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005943int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005944{
Janos Follath865b3eb2019-12-16 11:46:15 +00005945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005946
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 if (ssl == NULL || ssl->conf == NULL) {
5950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5951 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005952
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005953#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5955 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5956 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005957 }
5958#endif
5959
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5961 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5962 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5963 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005964 }
5965 }
5966
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005972}
5973
5974/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005975 * Notify the peer that the connection is being closed
5976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005977int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005978{
Janos Follath865b3eb2019-12-16 11:46:15 +00005979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 if (ssl == NULL || ssl->conf == NULL) {
5982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5983 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005984
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005986
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5988 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5989 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5990 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5991 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5992 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005993 }
5994 }
5995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005997
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005999}
6000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006002{
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006004 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006006
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006007#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 psa_destroy_key(transform->psa_key_enc);
6009 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006010#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6012 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006013#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006014
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006015#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006016#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 psa_destroy_key(transform->psa_mac_enc);
6018 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006019#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 mbedtls_md_free(&transform->md_ctx_enc);
6021 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006022#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006023#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006024
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006026}
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6029 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006030{
Jerry Yuc7875b52021-09-05 21:05:50 +08006031 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006033}
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6036 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006037{
6038 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006040}
6041
Hanno Becker0271f962018-08-16 13:23:47 +01006042#if defined(MBEDTLS_SSL_PROTO_DTLS)
6043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006045{
6046 unsigned offset;
6047 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006050 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 }
Hanno Becker0271f962018-08-16 13:23:47 +01006052
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6056 ssl_buffering_free_slot(ssl, offset);
6057 }
Hanno Beckere605b192018-08-21 15:59:07 +01006058}
6059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6061 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006062{
6063 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6064 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006067 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006071 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006072 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006074 }
6075}
6076
6077#endif /* MBEDTLS_SSL_PROTO_DTLS */
6078
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006079/*
6080 * Convert version numbers to/from wire format
6081 * and, for DTLS, to/from TLS equivalent.
6082 *
6083 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006084 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006085 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006086 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006088void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6089 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006090{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006091 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006092#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006094 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006096 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006097#else
6098 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006099#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006100 {
6101 tls_version_formatted = (uint16_t) tls_version;
6102 }
6103 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006104}
6105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6107 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006108{
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006110#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006112 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6114 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006115#else
6116 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006117#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006118 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006119}
6120
Jerry Yue7047812021-09-13 19:26:39 +08006121/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006122 * Send pending fatal alert.
6123 * 0, No alert message.
6124 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6125 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006126 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006127int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006128{
6129 int ret;
6130
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006131 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (ssl->send_alert == 0) {
6133 return 0;
6134 }
Jerry Yu394ece62021-09-14 22:17:21 +08006135
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 ret = mbedtls_ssl_send_alert_message(ssl,
6137 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6138 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006139
Jerry Yu3bf1f972021-09-22 21:37:18 +08006140 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6141 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006144 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006145 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006146
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (ret != 0) {
6148 return ret;
6149 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006152}
6153
Jerry Yu394ece62021-09-14 22:17:21 +08006154/*
6155 * Set pending fatal alert flag.
6156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006157void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6158 unsigned char alert_type,
6159 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006160{
6161 ssl->send_alert = 1;
6162 ssl->alert_type = alert_type;
6163 ssl->alert_reason = alert_reason;
6164}
6165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006166#endif /* MBEDTLS_SSL_TLS_C */