xref: /aosp_15_r20/external/mbedtls/library/ssl_msg.c (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf Ebrahimi /*
2*62c56f98SSadaf Ebrahimi  *  Generic SSL/TLS messaging layer functions
3*62c56f98SSadaf Ebrahimi  *  (record layer + retransmission state machine)
4*62c56f98SSadaf Ebrahimi  *
5*62c56f98SSadaf Ebrahimi  *  Copyright The Mbed TLS Contributors
6*62c56f98SSadaf Ebrahimi  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
7*62c56f98SSadaf Ebrahimi  */
8*62c56f98SSadaf Ebrahimi /*
9*62c56f98SSadaf Ebrahimi  *  http://www.ietf.org/rfc/rfc2246.txt
10*62c56f98SSadaf Ebrahimi  *  http://www.ietf.org/rfc/rfc4346.txt
11*62c56f98SSadaf Ebrahimi  */
12*62c56f98SSadaf Ebrahimi 
13*62c56f98SSadaf Ebrahimi #include "common.h"
14*62c56f98SSadaf Ebrahimi 
15*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_TLS_C)
16*62c56f98SSadaf Ebrahimi 
17*62c56f98SSadaf Ebrahimi #include "mbedtls/platform.h"
18*62c56f98SSadaf Ebrahimi 
19*62c56f98SSadaf Ebrahimi #include "mbedtls/ssl.h"
20*62c56f98SSadaf Ebrahimi #include "ssl_misc.h"
21*62c56f98SSadaf Ebrahimi #include "mbedtls/debug.h"
22*62c56f98SSadaf Ebrahimi #include "mbedtls/error.h"
23*62c56f98SSadaf Ebrahimi #include "mbedtls/platform_util.h"
24*62c56f98SSadaf Ebrahimi #include "mbedtls/version.h"
25*62c56f98SSadaf Ebrahimi #include "constant_time_internal.h"
26*62c56f98SSadaf Ebrahimi #include "mbedtls/constant_time.h"
27*62c56f98SSadaf Ebrahimi 
28*62c56f98SSadaf Ebrahimi #include <string.h>
29*62c56f98SSadaf Ebrahimi 
30*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
31*62c56f98SSadaf Ebrahimi #include "psa_util_internal.h"
32*62c56f98SSadaf Ebrahimi #include "psa/crypto.h"
33*62c56f98SSadaf Ebrahimi #endif
34*62c56f98SSadaf Ebrahimi 
35*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_X509_CRT_PARSE_C)
36*62c56f98SSadaf Ebrahimi #include "mbedtls/oid.h"
37*62c56f98SSadaf Ebrahimi #endif
38*62c56f98SSadaf Ebrahimi 
39*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
40*62c56f98SSadaf Ebrahimi /* Define a local translating function to save code size by not using too many
41*62c56f98SSadaf Ebrahimi  * arguments in each translating place. */
local_err_translation(psa_status_t status)42*62c56f98SSadaf Ebrahimi static int local_err_translation(psa_status_t status)
43*62c56f98SSadaf Ebrahimi {
44*62c56f98SSadaf Ebrahimi     return psa_status_to_mbedtls(status, psa_to_ssl_errors,
45*62c56f98SSadaf Ebrahimi                                  ARRAY_LENGTH(psa_to_ssl_errors),
46*62c56f98SSadaf Ebrahimi                                  psa_generic_status_to_mbedtls);
47*62c56f98SSadaf Ebrahimi }
48*62c56f98SSadaf Ebrahimi #define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
49*62c56f98SSadaf Ebrahimi #endif
50*62c56f98SSadaf Ebrahimi 
51*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
52*62c56f98SSadaf Ebrahimi 
53*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
54*62c56f98SSadaf Ebrahimi 
55*62c56f98SSadaf Ebrahimi #if defined(PSA_WANT_ALG_SHA_384)
56*62c56f98SSadaf Ebrahimi #define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
57*62c56f98SSadaf Ebrahimi #elif defined(PSA_WANT_ALG_SHA_256)
58*62c56f98SSadaf Ebrahimi #define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
59*62c56f98SSadaf Ebrahimi #else /* See check_config.h */
60*62c56f98SSadaf Ebrahimi #define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
61*62c56f98SSadaf Ebrahimi #endif
62*62c56f98SSadaf Ebrahimi 
63*62c56f98SSadaf Ebrahimi MBEDTLS_STATIC_TESTABLE
mbedtls_ct_hmac(mbedtls_svc_key_id_t key,psa_algorithm_t mac_alg,const unsigned char * add_data,size_t add_data_len,const unsigned char * data,size_t data_len_secret,size_t min_data_len,size_t max_data_len,unsigned char * output)64*62c56f98SSadaf Ebrahimi int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
65*62c56f98SSadaf Ebrahimi                     psa_algorithm_t mac_alg,
66*62c56f98SSadaf Ebrahimi                     const unsigned char *add_data,
67*62c56f98SSadaf Ebrahimi                     size_t add_data_len,
68*62c56f98SSadaf Ebrahimi                     const unsigned char *data,
69*62c56f98SSadaf Ebrahimi                     size_t data_len_secret,
70*62c56f98SSadaf Ebrahimi                     size_t min_data_len,
71*62c56f98SSadaf Ebrahimi                     size_t max_data_len,
72*62c56f98SSadaf Ebrahimi                     unsigned char *output)
73*62c56f98SSadaf Ebrahimi {
74*62c56f98SSadaf Ebrahimi     /*
75*62c56f98SSadaf Ebrahimi      * This function breaks the HMAC abstraction and uses psa_hash_clone()
76*62c56f98SSadaf Ebrahimi      * extension in order to get constant-flow behaviour.
77*62c56f98SSadaf Ebrahimi      *
78*62c56f98SSadaf Ebrahimi      * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
79*62c56f98SSadaf Ebrahimi      * concatenation, and okey/ikey are the XOR of the key with some fixed bit
80*62c56f98SSadaf Ebrahimi      * patterns (see RFC 2104, sec. 2).
81*62c56f98SSadaf Ebrahimi      *
82*62c56f98SSadaf Ebrahimi      * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
83*62c56f98SSadaf Ebrahimi      * hashing up to minlen, then cloning the context, and for each byte up
84*62c56f98SSadaf Ebrahimi      * to maxlen finishing up the hash computation, keeping only the
85*62c56f98SSadaf Ebrahimi      * correct result.
86*62c56f98SSadaf Ebrahimi      *
87*62c56f98SSadaf Ebrahimi      * Then we only need to compute HASH(okey + inner_hash) and we're done.
88*62c56f98SSadaf Ebrahimi      */
89*62c56f98SSadaf Ebrahimi     psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
90*62c56f98SSadaf Ebrahimi     const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
91*62c56f98SSadaf Ebrahimi     unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
92*62c56f98SSadaf Ebrahimi     const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
93*62c56f98SSadaf Ebrahimi     psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
94*62c56f98SSadaf Ebrahimi     size_t hash_length;
95*62c56f98SSadaf Ebrahimi 
96*62c56f98SSadaf Ebrahimi     unsigned char aux_out[PSA_HASH_MAX_SIZE];
97*62c56f98SSadaf Ebrahimi     psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
98*62c56f98SSadaf Ebrahimi     size_t offset;
99*62c56f98SSadaf Ebrahimi     psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
100*62c56f98SSadaf Ebrahimi 
101*62c56f98SSadaf Ebrahimi     size_t mac_key_length;
102*62c56f98SSadaf Ebrahimi     size_t i;
103*62c56f98SSadaf Ebrahimi 
104*62c56f98SSadaf Ebrahimi #define PSA_CHK(func_call)        \
105*62c56f98SSadaf Ebrahimi     do {                            \
106*62c56f98SSadaf Ebrahimi         status = (func_call);       \
107*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) \
108*62c56f98SSadaf Ebrahimi         goto cleanup;           \
109*62c56f98SSadaf Ebrahimi     } while (0)
110*62c56f98SSadaf Ebrahimi 
111*62c56f98SSadaf Ebrahimi     /* Export MAC key
112*62c56f98SSadaf Ebrahimi      * We assume key length is always exactly the output size
113*62c56f98SSadaf Ebrahimi      * which is never more than the block size, thus we use block_size
114*62c56f98SSadaf Ebrahimi      * as the key buffer size.
115*62c56f98SSadaf Ebrahimi      */
116*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
117*62c56f98SSadaf Ebrahimi 
118*62c56f98SSadaf Ebrahimi     /* Calculate ikey */
119*62c56f98SSadaf Ebrahimi     for (i = 0; i < mac_key_length; i++) {
120*62c56f98SSadaf Ebrahimi         key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
121*62c56f98SSadaf Ebrahimi     }
122*62c56f98SSadaf Ebrahimi     for (; i < block_size; ++i) {
123*62c56f98SSadaf Ebrahimi         key_buf[i] = 0x36;
124*62c56f98SSadaf Ebrahimi     }
125*62c56f98SSadaf Ebrahimi 
126*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_setup(&operation, hash_alg));
127*62c56f98SSadaf Ebrahimi 
128*62c56f98SSadaf Ebrahimi     /* Now compute inner_hash = HASH(ikey + msg) */
129*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
130*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
131*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_update(&operation, data, min_data_len));
132*62c56f98SSadaf Ebrahimi 
133*62c56f98SSadaf Ebrahimi     /* Fill the hash buffer in advance with something that is
134*62c56f98SSadaf Ebrahimi      * not a valid hash (barring an attack on the hash and
135*62c56f98SSadaf Ebrahimi      * deliberately-crafted input), in case the caller doesn't
136*62c56f98SSadaf Ebrahimi      * check the return status properly. */
137*62c56f98SSadaf Ebrahimi     memset(output, '!', hash_size);
138*62c56f98SSadaf Ebrahimi 
139*62c56f98SSadaf Ebrahimi     /* For each possible length, compute the hash up to that point */
140*62c56f98SSadaf Ebrahimi     for (offset = min_data_len; offset <= max_data_len; offset++) {
141*62c56f98SSadaf Ebrahimi         PSA_CHK(psa_hash_clone(&operation, &aux_operation));
142*62c56f98SSadaf Ebrahimi         PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
143*62c56f98SSadaf Ebrahimi                                 PSA_HASH_MAX_SIZE, &hash_length));
144*62c56f98SSadaf Ebrahimi         /* Keep only the correct inner_hash in the output buffer */
145*62c56f98SSadaf Ebrahimi         mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
146*62c56f98SSadaf Ebrahimi                              output, aux_out, NULL, hash_size);
147*62c56f98SSadaf Ebrahimi 
148*62c56f98SSadaf Ebrahimi         if (offset < max_data_len) {
149*62c56f98SSadaf Ebrahimi             PSA_CHK(psa_hash_update(&operation, data + offset, 1));
150*62c56f98SSadaf Ebrahimi         }
151*62c56f98SSadaf Ebrahimi     }
152*62c56f98SSadaf Ebrahimi 
153*62c56f98SSadaf Ebrahimi     /* Abort current operation to prepare for final operation */
154*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_abort(&operation));
155*62c56f98SSadaf Ebrahimi 
156*62c56f98SSadaf Ebrahimi     /* Calculate okey */
157*62c56f98SSadaf Ebrahimi     for (i = 0; i < mac_key_length; i++) {
158*62c56f98SSadaf Ebrahimi         key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
159*62c56f98SSadaf Ebrahimi     }
160*62c56f98SSadaf Ebrahimi     for (; i < block_size; ++i) {
161*62c56f98SSadaf Ebrahimi         key_buf[i] = 0x5C;
162*62c56f98SSadaf Ebrahimi     }
163*62c56f98SSadaf Ebrahimi 
164*62c56f98SSadaf Ebrahimi     /* Now compute HASH(okey + inner_hash) */
165*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_setup(&operation, hash_alg));
166*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
167*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_update(&operation, output, hash_size));
168*62c56f98SSadaf Ebrahimi     PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
169*62c56f98SSadaf Ebrahimi 
170*62c56f98SSadaf Ebrahimi #undef PSA_CHK
171*62c56f98SSadaf Ebrahimi 
172*62c56f98SSadaf Ebrahimi cleanup:
173*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
174*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
175*62c56f98SSadaf Ebrahimi 
176*62c56f98SSadaf Ebrahimi     psa_hash_abort(&operation);
177*62c56f98SSadaf Ebrahimi     psa_hash_abort(&aux_operation);
178*62c56f98SSadaf Ebrahimi     return PSA_TO_MBEDTLS_ERR(status);
179*62c56f98SSadaf Ebrahimi }
180*62c56f98SSadaf Ebrahimi 
181*62c56f98SSadaf Ebrahimi #undef MAX_HASH_BLOCK_LENGTH
182*62c56f98SSadaf Ebrahimi 
183*62c56f98SSadaf Ebrahimi #else
184*62c56f98SSadaf Ebrahimi MBEDTLS_STATIC_TESTABLE
mbedtls_ct_hmac(mbedtls_md_context_t * ctx,const unsigned char * add_data,size_t add_data_len,const unsigned char * data,size_t data_len_secret,size_t min_data_len,size_t max_data_len,unsigned char * output)185*62c56f98SSadaf Ebrahimi int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
186*62c56f98SSadaf Ebrahimi                     const unsigned char *add_data,
187*62c56f98SSadaf Ebrahimi                     size_t add_data_len,
188*62c56f98SSadaf Ebrahimi                     const unsigned char *data,
189*62c56f98SSadaf Ebrahimi                     size_t data_len_secret,
190*62c56f98SSadaf Ebrahimi                     size_t min_data_len,
191*62c56f98SSadaf Ebrahimi                     size_t max_data_len,
192*62c56f98SSadaf Ebrahimi                     unsigned char *output)
193*62c56f98SSadaf Ebrahimi {
194*62c56f98SSadaf Ebrahimi     /*
195*62c56f98SSadaf Ebrahimi      * This function breaks the HMAC abstraction and uses the md_clone()
196*62c56f98SSadaf Ebrahimi      * extension to the MD API in order to get constant-flow behaviour.
197*62c56f98SSadaf Ebrahimi      *
198*62c56f98SSadaf Ebrahimi      * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
199*62c56f98SSadaf Ebrahimi      * concatenation, and okey/ikey are the XOR of the key with some fixed bit
200*62c56f98SSadaf Ebrahimi      * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
201*62c56f98SSadaf Ebrahimi      *
202*62c56f98SSadaf Ebrahimi      * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
203*62c56f98SSadaf Ebrahimi      * minlen, then cloning the context, and for each byte up to maxlen
204*62c56f98SSadaf Ebrahimi      * finishing up the hash computation, keeping only the correct result.
205*62c56f98SSadaf Ebrahimi      *
206*62c56f98SSadaf Ebrahimi      * Then we only need to compute HASH(okey + inner_hash) and we're done.
207*62c56f98SSadaf Ebrahimi      */
208*62c56f98SSadaf Ebrahimi     const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
209*62c56f98SSadaf Ebrahimi     /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
210*62c56f98SSadaf Ebrahimi      * all of which have the same block size except SHA-384. */
211*62c56f98SSadaf Ebrahimi     const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
212*62c56f98SSadaf Ebrahimi     const unsigned char * const ikey = ctx->hmac_ctx;
213*62c56f98SSadaf Ebrahimi     const unsigned char * const okey = ikey + block_size;
214*62c56f98SSadaf Ebrahimi     const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
215*62c56f98SSadaf Ebrahimi 
216*62c56f98SSadaf Ebrahimi     unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
217*62c56f98SSadaf Ebrahimi     mbedtls_md_context_t aux;
218*62c56f98SSadaf Ebrahimi     size_t offset;
219*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
220*62c56f98SSadaf Ebrahimi 
221*62c56f98SSadaf Ebrahimi     mbedtls_md_init(&aux);
222*62c56f98SSadaf Ebrahimi 
223*62c56f98SSadaf Ebrahimi #define MD_CHK(func_call) \
224*62c56f98SSadaf Ebrahimi     do {                    \
225*62c56f98SSadaf Ebrahimi         ret = (func_call);  \
226*62c56f98SSadaf Ebrahimi         if (ret != 0)      \
227*62c56f98SSadaf Ebrahimi         goto cleanup;   \
228*62c56f98SSadaf Ebrahimi     } while (0)
229*62c56f98SSadaf Ebrahimi 
230*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
231*62c56f98SSadaf Ebrahimi 
232*62c56f98SSadaf Ebrahimi     /* After hmac_start() of hmac_reset(), ikey has already been hashed,
233*62c56f98SSadaf Ebrahimi      * so we can start directly with the message */
234*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
235*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
236*62c56f98SSadaf Ebrahimi 
237*62c56f98SSadaf Ebrahimi     /* Fill the hash buffer in advance with something that is
238*62c56f98SSadaf Ebrahimi      * not a valid hash (barring an attack on the hash and
239*62c56f98SSadaf Ebrahimi      * deliberately-crafted input), in case the caller doesn't
240*62c56f98SSadaf Ebrahimi      * check the return status properly. */
241*62c56f98SSadaf Ebrahimi     memset(output, '!', hash_size);
242*62c56f98SSadaf Ebrahimi 
243*62c56f98SSadaf Ebrahimi     /* For each possible length, compute the hash up to that point */
244*62c56f98SSadaf Ebrahimi     for (offset = min_data_len; offset <= max_data_len; offset++) {
245*62c56f98SSadaf Ebrahimi         MD_CHK(mbedtls_md_clone(&aux, ctx));
246*62c56f98SSadaf Ebrahimi         MD_CHK(mbedtls_md_finish(&aux, aux_out));
247*62c56f98SSadaf Ebrahimi         /* Keep only the correct inner_hash in the output buffer */
248*62c56f98SSadaf Ebrahimi         mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
249*62c56f98SSadaf Ebrahimi                              output, aux_out, NULL, hash_size);
250*62c56f98SSadaf Ebrahimi 
251*62c56f98SSadaf Ebrahimi         if (offset < max_data_len) {
252*62c56f98SSadaf Ebrahimi             MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
253*62c56f98SSadaf Ebrahimi         }
254*62c56f98SSadaf Ebrahimi     }
255*62c56f98SSadaf Ebrahimi 
256*62c56f98SSadaf Ebrahimi     /* The context needs to finish() before it starts() again */
257*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_finish(ctx, aux_out));
258*62c56f98SSadaf Ebrahimi 
259*62c56f98SSadaf Ebrahimi     /* Now compute HASH(okey + inner_hash) */
260*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_starts(ctx));
261*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_update(ctx, okey, block_size));
262*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_update(ctx, output, hash_size));
263*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_finish(ctx, output));
264*62c56f98SSadaf Ebrahimi 
265*62c56f98SSadaf Ebrahimi     /* Done, get ready for next time */
266*62c56f98SSadaf Ebrahimi     MD_CHK(mbedtls_md_hmac_reset(ctx));
267*62c56f98SSadaf Ebrahimi 
268*62c56f98SSadaf Ebrahimi #undef MD_CHK
269*62c56f98SSadaf Ebrahimi 
270*62c56f98SSadaf Ebrahimi cleanup:
271*62c56f98SSadaf Ebrahimi     mbedtls_md_free(&aux);
272*62c56f98SSadaf Ebrahimi     return ret;
273*62c56f98SSadaf Ebrahimi }
274*62c56f98SSadaf Ebrahimi 
275*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
276*62c56f98SSadaf Ebrahimi 
277*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
278*62c56f98SSadaf Ebrahimi 
279*62c56f98SSadaf Ebrahimi static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
280*62c56f98SSadaf Ebrahimi 
281*62c56f98SSadaf Ebrahimi /*
282*62c56f98SSadaf Ebrahimi  * Start a timer.
283*62c56f98SSadaf Ebrahimi  * Passing millisecs = 0 cancels a running timer.
284*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_set_timer(mbedtls_ssl_context * ssl,uint32_t millisecs)285*62c56f98SSadaf Ebrahimi void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
286*62c56f98SSadaf Ebrahimi {
287*62c56f98SSadaf Ebrahimi     if (ssl->f_set_timer == NULL) {
288*62c56f98SSadaf Ebrahimi         return;
289*62c56f98SSadaf Ebrahimi     }
290*62c56f98SSadaf Ebrahimi 
291*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
292*62c56f98SSadaf Ebrahimi     ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
293*62c56f98SSadaf Ebrahimi }
294*62c56f98SSadaf Ebrahimi 
295*62c56f98SSadaf Ebrahimi /*
296*62c56f98SSadaf Ebrahimi  * Return -1 is timer is expired, 0 if it isn't.
297*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_check_timer(mbedtls_ssl_context * ssl)298*62c56f98SSadaf Ebrahimi int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
299*62c56f98SSadaf Ebrahimi {
300*62c56f98SSadaf Ebrahimi     if (ssl->f_get_timer == NULL) {
301*62c56f98SSadaf Ebrahimi         return 0;
302*62c56f98SSadaf Ebrahimi     }
303*62c56f98SSadaf Ebrahimi 
304*62c56f98SSadaf Ebrahimi     if (ssl->f_get_timer(ssl->p_timer) == 2) {
305*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
306*62c56f98SSadaf Ebrahimi         return -1;
307*62c56f98SSadaf Ebrahimi     }
308*62c56f98SSadaf Ebrahimi 
309*62c56f98SSadaf Ebrahimi     return 0;
310*62c56f98SSadaf Ebrahimi }
311*62c56f98SSadaf Ebrahimi 
312*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
313*62c56f98SSadaf Ebrahimi static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
314*62c56f98SSadaf Ebrahimi                                    unsigned char *buf,
315*62c56f98SSadaf Ebrahimi                                    size_t len,
316*62c56f98SSadaf Ebrahimi                                    mbedtls_record *rec);
317*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_check_record(mbedtls_ssl_context const * ssl,unsigned char * buf,size_t buflen)318*62c56f98SSadaf Ebrahimi int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
319*62c56f98SSadaf Ebrahimi                              unsigned char *buf,
320*62c56f98SSadaf Ebrahimi                              size_t buflen)
321*62c56f98SSadaf Ebrahimi {
322*62c56f98SSadaf Ebrahimi     int ret = 0;
323*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
324*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
325*62c56f98SSadaf Ebrahimi 
326*62c56f98SSadaf Ebrahimi     /* We don't support record checking in TLS because
327*62c56f98SSadaf Ebrahimi      * there doesn't seem to be a usecase for it.
328*62c56f98SSadaf Ebrahimi      */
329*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
330*62c56f98SSadaf Ebrahimi         ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
331*62c56f98SSadaf Ebrahimi         goto exit;
332*62c56f98SSadaf Ebrahimi     }
333*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
334*62c56f98SSadaf Ebrahimi     else {
335*62c56f98SSadaf Ebrahimi         mbedtls_record rec;
336*62c56f98SSadaf Ebrahimi 
337*62c56f98SSadaf Ebrahimi         ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
338*62c56f98SSadaf Ebrahimi         if (ret != 0) {
339*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
340*62c56f98SSadaf Ebrahimi             goto exit;
341*62c56f98SSadaf Ebrahimi         }
342*62c56f98SSadaf Ebrahimi 
343*62c56f98SSadaf Ebrahimi         if (ssl->transform_in != NULL) {
344*62c56f98SSadaf Ebrahimi             ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
345*62c56f98SSadaf Ebrahimi             if (ret != 0) {
346*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
347*62c56f98SSadaf Ebrahimi                 goto exit;
348*62c56f98SSadaf Ebrahimi             }
349*62c56f98SSadaf Ebrahimi         }
350*62c56f98SSadaf Ebrahimi     }
351*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
352*62c56f98SSadaf Ebrahimi 
353*62c56f98SSadaf Ebrahimi exit:
354*62c56f98SSadaf Ebrahimi     /* On success, we have decrypted the buffer in-place, so make
355*62c56f98SSadaf Ebrahimi      * sure we don't leak any plaintext data. */
356*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(buf, buflen);
357*62c56f98SSadaf Ebrahimi 
358*62c56f98SSadaf Ebrahimi     /* For the purpose of this API, treat messages with unexpected CID
359*62c56f98SSadaf Ebrahimi      * as well as such from future epochs as unexpected. */
360*62c56f98SSadaf Ebrahimi     if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
361*62c56f98SSadaf Ebrahimi         ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
362*62c56f98SSadaf Ebrahimi         ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
363*62c56f98SSadaf Ebrahimi     }
364*62c56f98SSadaf Ebrahimi 
365*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
366*62c56f98SSadaf Ebrahimi     return ret;
367*62c56f98SSadaf Ebrahimi }
368*62c56f98SSadaf Ebrahimi 
369*62c56f98SSadaf Ebrahimi #define SSL_DONT_FORCE_FLUSH 0
370*62c56f98SSadaf Ebrahimi #define SSL_FORCE_FLUSH      1
371*62c56f98SSadaf Ebrahimi 
372*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
373*62c56f98SSadaf Ebrahimi 
374*62c56f98SSadaf Ebrahimi /* Forward declarations for functions related to message buffering. */
375*62c56f98SSadaf Ebrahimi static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
376*62c56f98SSadaf Ebrahimi                                     uint8_t slot);
377*62c56f98SSadaf Ebrahimi static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
378*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
379*62c56f98SSadaf Ebrahimi static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
380*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
381*62c56f98SSadaf Ebrahimi static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
382*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
383*62c56f98SSadaf Ebrahimi static int ssl_buffer_message(mbedtls_ssl_context *ssl);
384*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
385*62c56f98SSadaf Ebrahimi static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
386*62c56f98SSadaf Ebrahimi                                     mbedtls_record const *rec);
387*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
388*62c56f98SSadaf Ebrahimi static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
389*62c56f98SSadaf Ebrahimi 
ssl_get_maximum_datagram_size(mbedtls_ssl_context const * ssl)390*62c56f98SSadaf Ebrahimi static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
391*62c56f98SSadaf Ebrahimi {
392*62c56f98SSadaf Ebrahimi     size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
393*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
394*62c56f98SSadaf Ebrahimi     size_t out_buf_len = ssl->out_buf_len;
395*62c56f98SSadaf Ebrahimi #else
396*62c56f98SSadaf Ebrahimi     size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
397*62c56f98SSadaf Ebrahimi #endif
398*62c56f98SSadaf Ebrahimi 
399*62c56f98SSadaf Ebrahimi     if (mtu != 0 && mtu < out_buf_len) {
400*62c56f98SSadaf Ebrahimi         return mtu;
401*62c56f98SSadaf Ebrahimi     }
402*62c56f98SSadaf Ebrahimi 
403*62c56f98SSadaf Ebrahimi     return out_buf_len;
404*62c56f98SSadaf Ebrahimi }
405*62c56f98SSadaf Ebrahimi 
406*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const * ssl)407*62c56f98SSadaf Ebrahimi static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
408*62c56f98SSadaf Ebrahimi {
409*62c56f98SSadaf Ebrahimi     size_t const bytes_written = ssl->out_left;
410*62c56f98SSadaf Ebrahimi     size_t const mtu           = ssl_get_maximum_datagram_size(ssl);
411*62c56f98SSadaf Ebrahimi 
412*62c56f98SSadaf Ebrahimi     /* Double-check that the write-index hasn't gone
413*62c56f98SSadaf Ebrahimi      * past what we can transmit in a single datagram. */
414*62c56f98SSadaf Ebrahimi     if (bytes_written > mtu) {
415*62c56f98SSadaf Ebrahimi         /* Should never happen... */
416*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
417*62c56f98SSadaf Ebrahimi     }
418*62c56f98SSadaf Ebrahimi 
419*62c56f98SSadaf Ebrahimi     return (int) (mtu - bytes_written);
420*62c56f98SSadaf Ebrahimi }
421*62c56f98SSadaf Ebrahimi 
422*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const * ssl)423*62c56f98SSadaf Ebrahimi static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
424*62c56f98SSadaf Ebrahimi {
425*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
426*62c56f98SSadaf Ebrahimi     size_t remaining, expansion;
427*62c56f98SSadaf Ebrahimi     size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
428*62c56f98SSadaf Ebrahimi 
429*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
430*62c56f98SSadaf Ebrahimi     const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
431*62c56f98SSadaf Ebrahimi 
432*62c56f98SSadaf Ebrahimi     if (max_len > mfl) {
433*62c56f98SSadaf Ebrahimi         max_len = mfl;
434*62c56f98SSadaf Ebrahimi     }
435*62c56f98SSadaf Ebrahimi 
436*62c56f98SSadaf Ebrahimi     /* By the standard (RFC 6066 Sect. 4), the MFL extension
437*62c56f98SSadaf Ebrahimi      * only limits the maximum record payload size, so in theory
438*62c56f98SSadaf Ebrahimi      * we would be allowed to pack multiple records of payload size
439*62c56f98SSadaf Ebrahimi      * MFL into a single datagram. However, this would mean that there's
440*62c56f98SSadaf Ebrahimi      * no way to explicitly communicate MTU restrictions to the peer.
441*62c56f98SSadaf Ebrahimi      *
442*62c56f98SSadaf Ebrahimi      * The following reduction of max_len makes sure that we never
443*62c56f98SSadaf Ebrahimi      * write datagrams larger than MFL + Record Expansion Overhead.
444*62c56f98SSadaf Ebrahimi      */
445*62c56f98SSadaf Ebrahimi     if (max_len <= ssl->out_left) {
446*62c56f98SSadaf Ebrahimi         return 0;
447*62c56f98SSadaf Ebrahimi     }
448*62c56f98SSadaf Ebrahimi 
449*62c56f98SSadaf Ebrahimi     max_len -= ssl->out_left;
450*62c56f98SSadaf Ebrahimi #endif
451*62c56f98SSadaf Ebrahimi 
452*62c56f98SSadaf Ebrahimi     ret = ssl_get_remaining_space_in_datagram(ssl);
453*62c56f98SSadaf Ebrahimi     if (ret < 0) {
454*62c56f98SSadaf Ebrahimi         return ret;
455*62c56f98SSadaf Ebrahimi     }
456*62c56f98SSadaf Ebrahimi     remaining = (size_t) ret;
457*62c56f98SSadaf Ebrahimi 
458*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_get_record_expansion(ssl);
459*62c56f98SSadaf Ebrahimi     if (ret < 0) {
460*62c56f98SSadaf Ebrahimi         return ret;
461*62c56f98SSadaf Ebrahimi     }
462*62c56f98SSadaf Ebrahimi     expansion = (size_t) ret;
463*62c56f98SSadaf Ebrahimi 
464*62c56f98SSadaf Ebrahimi     if (remaining <= expansion) {
465*62c56f98SSadaf Ebrahimi         return 0;
466*62c56f98SSadaf Ebrahimi     }
467*62c56f98SSadaf Ebrahimi 
468*62c56f98SSadaf Ebrahimi     remaining -= expansion;
469*62c56f98SSadaf Ebrahimi     if (remaining >= max_len) {
470*62c56f98SSadaf Ebrahimi         remaining = max_len;
471*62c56f98SSadaf Ebrahimi     }
472*62c56f98SSadaf Ebrahimi 
473*62c56f98SSadaf Ebrahimi     return (int) remaining;
474*62c56f98SSadaf Ebrahimi }
475*62c56f98SSadaf Ebrahimi 
476*62c56f98SSadaf Ebrahimi /*
477*62c56f98SSadaf Ebrahimi  * Double the retransmit timeout value, within the allowed range,
478*62c56f98SSadaf Ebrahimi  * returning -1 if the maximum value has already been reached.
479*62c56f98SSadaf Ebrahimi  */
480*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_double_retransmit_timeout(mbedtls_ssl_context * ssl)481*62c56f98SSadaf Ebrahimi static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
482*62c56f98SSadaf Ebrahimi {
483*62c56f98SSadaf Ebrahimi     uint32_t new_timeout;
484*62c56f98SSadaf Ebrahimi 
485*62c56f98SSadaf Ebrahimi     if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
486*62c56f98SSadaf Ebrahimi         return -1;
487*62c56f98SSadaf Ebrahimi     }
488*62c56f98SSadaf Ebrahimi 
489*62c56f98SSadaf Ebrahimi     /* Implement the final paragraph of RFC 6347 section 4.1.1.1
490*62c56f98SSadaf Ebrahimi      * in the following way: after the initial transmission and a first
491*62c56f98SSadaf Ebrahimi      * retransmission, back off to a temporary estimated MTU of 508 bytes.
492*62c56f98SSadaf Ebrahimi      * This value is guaranteed to be deliverable (if not guaranteed to be
493*62c56f98SSadaf Ebrahimi      * delivered) of any compliant IPv4 (and IPv6) network, and should work
494*62c56f98SSadaf Ebrahimi      * on most non-IP stacks too. */
495*62c56f98SSadaf Ebrahimi     if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
496*62c56f98SSadaf Ebrahimi         ssl->handshake->mtu = 508;
497*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
498*62c56f98SSadaf Ebrahimi     }
499*62c56f98SSadaf Ebrahimi 
500*62c56f98SSadaf Ebrahimi     new_timeout = 2 * ssl->handshake->retransmit_timeout;
501*62c56f98SSadaf Ebrahimi 
502*62c56f98SSadaf Ebrahimi     /* Avoid arithmetic overflow and range overflow */
503*62c56f98SSadaf Ebrahimi     if (new_timeout < ssl->handshake->retransmit_timeout ||
504*62c56f98SSadaf Ebrahimi         new_timeout > ssl->conf->hs_timeout_max) {
505*62c56f98SSadaf Ebrahimi         new_timeout = ssl->conf->hs_timeout_max;
506*62c56f98SSadaf Ebrahimi     }
507*62c56f98SSadaf Ebrahimi 
508*62c56f98SSadaf Ebrahimi     ssl->handshake->retransmit_timeout = new_timeout;
509*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
510*62c56f98SSadaf Ebrahimi                               (unsigned long) ssl->handshake->retransmit_timeout));
511*62c56f98SSadaf Ebrahimi 
512*62c56f98SSadaf Ebrahimi     return 0;
513*62c56f98SSadaf Ebrahimi }
514*62c56f98SSadaf Ebrahimi 
ssl_reset_retransmit_timeout(mbedtls_ssl_context * ssl)515*62c56f98SSadaf Ebrahimi static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
516*62c56f98SSadaf Ebrahimi {
517*62c56f98SSadaf Ebrahimi     ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
518*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
519*62c56f98SSadaf Ebrahimi                               (unsigned long) ssl->handshake->retransmit_timeout));
520*62c56f98SSadaf Ebrahimi }
521*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
522*62c56f98SSadaf Ebrahimi 
523*62c56f98SSadaf Ebrahimi /*
524*62c56f98SSadaf Ebrahimi  * Encryption/decryption functions
525*62c56f98SSadaf Ebrahimi  */
526*62c56f98SSadaf Ebrahimi 
527*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
528*62c56f98SSadaf Ebrahimi 
ssl_compute_padding_length(size_t len,size_t granularity)529*62c56f98SSadaf Ebrahimi static size_t ssl_compute_padding_length(size_t len,
530*62c56f98SSadaf Ebrahimi                                          size_t granularity)
531*62c56f98SSadaf Ebrahimi {
532*62c56f98SSadaf Ebrahimi     return (granularity - (len + 1) % granularity) % granularity;
533*62c56f98SSadaf Ebrahimi }
534*62c56f98SSadaf Ebrahimi 
535*62c56f98SSadaf Ebrahimi /* This functions transforms a (D)TLS plaintext fragment and a record content
536*62c56f98SSadaf Ebrahimi  * type into an instance of the (D)TLSInnerPlaintext structure. This is used
537*62c56f98SSadaf Ebrahimi  * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
538*62c56f98SSadaf Ebrahimi  * a record's content type.
539*62c56f98SSadaf Ebrahimi  *
540*62c56f98SSadaf Ebrahimi  *        struct {
541*62c56f98SSadaf Ebrahimi  *            opaque content[DTLSPlaintext.length];
542*62c56f98SSadaf Ebrahimi  *            ContentType real_type;
543*62c56f98SSadaf Ebrahimi  *            uint8 zeros[length_of_padding];
544*62c56f98SSadaf Ebrahimi  *        } (D)TLSInnerPlaintext;
545*62c56f98SSadaf Ebrahimi  *
546*62c56f98SSadaf Ebrahimi  *  Input:
547*62c56f98SSadaf Ebrahimi  *  - `content`: The beginning of the buffer holding the
548*62c56f98SSadaf Ebrahimi  *               plaintext to be wrapped.
549*62c56f98SSadaf Ebrahimi  *  - `*content_size`: The length of the plaintext in Bytes.
550*62c56f98SSadaf Ebrahimi  *  - `max_len`: The number of Bytes available starting from
551*62c56f98SSadaf Ebrahimi  *               `content`. This must be `>= *content_size`.
552*62c56f98SSadaf Ebrahimi  *  - `rec_type`: The desired record content type.
553*62c56f98SSadaf Ebrahimi  *
554*62c56f98SSadaf Ebrahimi  *  Output:
555*62c56f98SSadaf Ebrahimi  *  - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
556*62c56f98SSadaf Ebrahimi  *  - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
557*62c56f98SSadaf Ebrahimi  *
558*62c56f98SSadaf Ebrahimi  *  Returns:
559*62c56f98SSadaf Ebrahimi  *  - `0` on success.
560*62c56f98SSadaf Ebrahimi  *  - A negative error code if `max_len` didn't offer enough space
561*62c56f98SSadaf Ebrahimi  *    for the expansion.
562*62c56f98SSadaf Ebrahimi  */
563*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_build_inner_plaintext(unsigned char * content,size_t * content_size,size_t remaining,uint8_t rec_type,size_t pad)564*62c56f98SSadaf Ebrahimi static int ssl_build_inner_plaintext(unsigned char *content,
565*62c56f98SSadaf Ebrahimi                                      size_t *content_size,
566*62c56f98SSadaf Ebrahimi                                      size_t remaining,
567*62c56f98SSadaf Ebrahimi                                      uint8_t rec_type,
568*62c56f98SSadaf Ebrahimi                                      size_t pad)
569*62c56f98SSadaf Ebrahimi {
570*62c56f98SSadaf Ebrahimi     size_t len = *content_size;
571*62c56f98SSadaf Ebrahimi 
572*62c56f98SSadaf Ebrahimi     /* Write real content type */
573*62c56f98SSadaf Ebrahimi     if (remaining == 0) {
574*62c56f98SSadaf Ebrahimi         return -1;
575*62c56f98SSadaf Ebrahimi     }
576*62c56f98SSadaf Ebrahimi     content[len] = rec_type;
577*62c56f98SSadaf Ebrahimi     len++;
578*62c56f98SSadaf Ebrahimi     remaining--;
579*62c56f98SSadaf Ebrahimi 
580*62c56f98SSadaf Ebrahimi     if (remaining < pad) {
581*62c56f98SSadaf Ebrahimi         return -1;
582*62c56f98SSadaf Ebrahimi     }
583*62c56f98SSadaf Ebrahimi     memset(content + len, 0, pad);
584*62c56f98SSadaf Ebrahimi     len += pad;
585*62c56f98SSadaf Ebrahimi     remaining -= pad;
586*62c56f98SSadaf Ebrahimi 
587*62c56f98SSadaf Ebrahimi     *content_size = len;
588*62c56f98SSadaf Ebrahimi     return 0;
589*62c56f98SSadaf Ebrahimi }
590*62c56f98SSadaf Ebrahimi 
591*62c56f98SSadaf Ebrahimi /* This function parses a (D)TLSInnerPlaintext structure.
592*62c56f98SSadaf Ebrahimi  * See ssl_build_inner_plaintext() for details. */
593*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_parse_inner_plaintext(unsigned char const * content,size_t * content_size,uint8_t * rec_type)594*62c56f98SSadaf Ebrahimi static int ssl_parse_inner_plaintext(unsigned char const *content,
595*62c56f98SSadaf Ebrahimi                                      size_t *content_size,
596*62c56f98SSadaf Ebrahimi                                      uint8_t *rec_type)
597*62c56f98SSadaf Ebrahimi {
598*62c56f98SSadaf Ebrahimi     size_t remaining = *content_size;
599*62c56f98SSadaf Ebrahimi 
600*62c56f98SSadaf Ebrahimi     /* Determine length of padding by skipping zeroes from the back. */
601*62c56f98SSadaf Ebrahimi     do {
602*62c56f98SSadaf Ebrahimi         if (remaining == 0) {
603*62c56f98SSadaf Ebrahimi             return -1;
604*62c56f98SSadaf Ebrahimi         }
605*62c56f98SSadaf Ebrahimi         remaining--;
606*62c56f98SSadaf Ebrahimi     } while (content[remaining] == 0);
607*62c56f98SSadaf Ebrahimi 
608*62c56f98SSadaf Ebrahimi     *content_size = remaining;
609*62c56f98SSadaf Ebrahimi     *rec_type = content[remaining];
610*62c56f98SSadaf Ebrahimi 
611*62c56f98SSadaf Ebrahimi     return 0;
612*62c56f98SSadaf Ebrahimi }
613*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
614*62c56f98SSadaf Ebrahimi 
615*62c56f98SSadaf Ebrahimi /* The size of the `add_data` structure depends on various
616*62c56f98SSadaf Ebrahimi  * factors, namely
617*62c56f98SSadaf Ebrahimi  *
618*62c56f98SSadaf Ebrahimi  * 1) CID functionality disabled
619*62c56f98SSadaf Ebrahimi  *
620*62c56f98SSadaf Ebrahimi  * additional_data =
621*62c56f98SSadaf Ebrahimi  *    8:                    seq_num +
622*62c56f98SSadaf Ebrahimi  *    1:                       type +
623*62c56f98SSadaf Ebrahimi  *    2:                    version +
624*62c56f98SSadaf Ebrahimi  *    2:  length of inner plaintext +
625*62c56f98SSadaf Ebrahimi  *
626*62c56f98SSadaf Ebrahimi  * size = 13 bytes
627*62c56f98SSadaf Ebrahimi  *
628*62c56f98SSadaf Ebrahimi  * 2) CID functionality based on RFC 9146 enabled
629*62c56f98SSadaf Ebrahimi  *
630*62c56f98SSadaf Ebrahimi  * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
631*62c56f98SSadaf Ebrahimi  *      = 23 + CID-length
632*62c56f98SSadaf Ebrahimi  *
633*62c56f98SSadaf Ebrahimi  * 3) CID functionality based on legacy CID version
634*62c56f98SSadaf Ebrahimi     according to draft-ietf-tls-dtls-connection-id-05
635*62c56f98SSadaf Ebrahimi  *  https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
636*62c56f98SSadaf Ebrahimi  *
637*62c56f98SSadaf Ebrahimi  * size = 13 + 1 + CID-length
638*62c56f98SSadaf Ebrahimi  *
639*62c56f98SSadaf Ebrahimi  * More information about the CID usage:
640*62c56f98SSadaf Ebrahimi  *
641*62c56f98SSadaf Ebrahimi  * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
642*62c56f98SSadaf Ebrahimi  * size of the additional data structure is calculated as:
643*62c56f98SSadaf Ebrahimi  *
644*62c56f98SSadaf Ebrahimi  * additional_data =
645*62c56f98SSadaf Ebrahimi  *    8:                    seq_num +
646*62c56f98SSadaf Ebrahimi  *    1:                  tls12_cid +
647*62c56f98SSadaf Ebrahimi  *    2:     DTLSCipherText.version +
648*62c56f98SSadaf Ebrahimi  *    n:                        cid +
649*62c56f98SSadaf Ebrahimi  *    1:                 cid_length +
650*62c56f98SSadaf Ebrahimi  *    2: length_of_DTLSInnerPlaintext
651*62c56f98SSadaf Ebrahimi  *
652*62c56f98SSadaf Ebrahimi  * Per RFC 9146 the size of the add_data structure is calculated as:
653*62c56f98SSadaf Ebrahimi  *
654*62c56f98SSadaf Ebrahimi  * additional_data =
655*62c56f98SSadaf Ebrahimi  *    8:        seq_num_placeholder +
656*62c56f98SSadaf Ebrahimi  *    1:                  tls12_cid +
657*62c56f98SSadaf Ebrahimi  *    1:                 cid_length +
658*62c56f98SSadaf Ebrahimi  *    1:                  tls12_cid +
659*62c56f98SSadaf Ebrahimi  *    2:     DTLSCiphertext.version +
660*62c56f98SSadaf Ebrahimi  *    2:                      epoch +
661*62c56f98SSadaf Ebrahimi  *    6:            sequence_number +
662*62c56f98SSadaf Ebrahimi  *    n:                        cid +
663*62c56f98SSadaf Ebrahimi  *    2: length_of_DTLSInnerPlaintext
664*62c56f98SSadaf Ebrahimi  *
665*62c56f98SSadaf Ebrahimi  */
ssl_extract_add_data_from_record(unsigned char * add_data,size_t * add_data_len,mbedtls_record * rec,mbedtls_ssl_protocol_version tls_version,size_t taglen)666*62c56f98SSadaf Ebrahimi static void ssl_extract_add_data_from_record(unsigned char *add_data,
667*62c56f98SSadaf Ebrahimi                                              size_t *add_data_len,
668*62c56f98SSadaf Ebrahimi                                              mbedtls_record *rec,
669*62c56f98SSadaf Ebrahimi                                              mbedtls_ssl_protocol_version
670*62c56f98SSadaf Ebrahimi                                              tls_version,
671*62c56f98SSadaf Ebrahimi                                              size_t taglen)
672*62c56f98SSadaf Ebrahimi {
673*62c56f98SSadaf Ebrahimi     /* Several types of ciphers have been defined for use with TLS and DTLS,
674*62c56f98SSadaf Ebrahimi      * and the MAC calculations for those ciphers differ slightly. Further
675*62c56f98SSadaf Ebrahimi      * variants were added when the CID functionality was added with RFC 9146.
676*62c56f98SSadaf Ebrahimi      * This implementations also considers the use of a legacy version of the
677*62c56f98SSadaf Ebrahimi      * CID specification published in draft-ietf-tls-dtls-connection-id-05,
678*62c56f98SSadaf Ebrahimi      * which is used in deployments.
679*62c56f98SSadaf Ebrahimi      *
680*62c56f98SSadaf Ebrahimi      * We will distinguish between the non-CID and the CID cases below.
681*62c56f98SSadaf Ebrahimi      *
682*62c56f98SSadaf Ebrahimi      * --- Non-CID cases ---
683*62c56f98SSadaf Ebrahimi      *
684*62c56f98SSadaf Ebrahimi      * Quoting RFC 5246 (TLS 1.2):
685*62c56f98SSadaf Ebrahimi      *
686*62c56f98SSadaf Ebrahimi      *    additional_data = seq_num + TLSCompressed.type +
687*62c56f98SSadaf Ebrahimi      *                      TLSCompressed.version + TLSCompressed.length;
688*62c56f98SSadaf Ebrahimi      *
689*62c56f98SSadaf Ebrahimi      * For TLS 1.3, the record sequence number is dropped from the AAD
690*62c56f98SSadaf Ebrahimi      * and encoded within the nonce of the AEAD operation instead.
691*62c56f98SSadaf Ebrahimi      * Moreover, the additional data involves the length of the TLS
692*62c56f98SSadaf Ebrahimi      * ciphertext, not the TLS plaintext as in earlier versions.
693*62c56f98SSadaf Ebrahimi      * Quoting RFC 8446 (TLS 1.3):
694*62c56f98SSadaf Ebrahimi      *
695*62c56f98SSadaf Ebrahimi      *      additional_data = TLSCiphertext.opaque_type ||
696*62c56f98SSadaf Ebrahimi      *                        TLSCiphertext.legacy_record_version ||
697*62c56f98SSadaf Ebrahimi      *                        TLSCiphertext.length
698*62c56f98SSadaf Ebrahimi      *
699*62c56f98SSadaf Ebrahimi      * We pass the tag length to this function in order to compute the
700*62c56f98SSadaf Ebrahimi      * ciphertext length from the inner plaintext length rec->data_len via
701*62c56f98SSadaf Ebrahimi      *
702*62c56f98SSadaf Ebrahimi      *     TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
703*62c56f98SSadaf Ebrahimi      *
704*62c56f98SSadaf Ebrahimi      * --- CID cases ---
705*62c56f98SSadaf Ebrahimi      *
706*62c56f98SSadaf Ebrahimi      * RFC 9146 uses a common pattern when constructing the data
707*62c56f98SSadaf Ebrahimi      * passed into a MAC / AEAD cipher.
708*62c56f98SSadaf Ebrahimi      *
709*62c56f98SSadaf Ebrahimi      * Data concatenation for MACs used with block ciphers with
710*62c56f98SSadaf Ebrahimi      * Encrypt-then-MAC Processing (with CID):
711*62c56f98SSadaf Ebrahimi      *
712*62c56f98SSadaf Ebrahimi      *  data = seq_num_placeholder +
713*62c56f98SSadaf Ebrahimi      *         tls12_cid +
714*62c56f98SSadaf Ebrahimi      *         cid_length +
715*62c56f98SSadaf Ebrahimi      *         tls12_cid +
716*62c56f98SSadaf Ebrahimi      *         DTLSCiphertext.version +
717*62c56f98SSadaf Ebrahimi      *         epoch +
718*62c56f98SSadaf Ebrahimi      *         sequence_number +
719*62c56f98SSadaf Ebrahimi      *         cid +
720*62c56f98SSadaf Ebrahimi      *         DTLSCiphertext.length +
721*62c56f98SSadaf Ebrahimi      *         IV +
722*62c56f98SSadaf Ebrahimi      *         ENC(content + padding + padding_length)
723*62c56f98SSadaf Ebrahimi      *
724*62c56f98SSadaf Ebrahimi      * Data concatenation for MACs used with block ciphers (with CID):
725*62c56f98SSadaf Ebrahimi      *
726*62c56f98SSadaf Ebrahimi      *  data =  seq_num_placeholder +
727*62c56f98SSadaf Ebrahimi      *          tls12_cid +
728*62c56f98SSadaf Ebrahimi      *          cid_length +
729*62c56f98SSadaf Ebrahimi      *          tls12_cid +
730*62c56f98SSadaf Ebrahimi      *          DTLSCiphertext.version +
731*62c56f98SSadaf Ebrahimi      *          epoch +
732*62c56f98SSadaf Ebrahimi      *          sequence_number +
733*62c56f98SSadaf Ebrahimi      *          cid +
734*62c56f98SSadaf Ebrahimi      *          length_of_DTLSInnerPlaintext +
735*62c56f98SSadaf Ebrahimi      *          DTLSInnerPlaintext.content +
736*62c56f98SSadaf Ebrahimi      *          DTLSInnerPlaintext.real_type +
737*62c56f98SSadaf Ebrahimi      *          DTLSInnerPlaintext.zeros
738*62c56f98SSadaf Ebrahimi      *
739*62c56f98SSadaf Ebrahimi      * AEAD ciphers use the following additional data calculation (with CIDs):
740*62c56f98SSadaf Ebrahimi      *
741*62c56f98SSadaf Ebrahimi      *     additional_data = seq_num_placeholder +
742*62c56f98SSadaf Ebrahimi      *                tls12_cid +
743*62c56f98SSadaf Ebrahimi      *                cid_length +
744*62c56f98SSadaf Ebrahimi      *                tls12_cid +
745*62c56f98SSadaf Ebrahimi      *                DTLSCiphertext.version +
746*62c56f98SSadaf Ebrahimi      *                epoch +
747*62c56f98SSadaf Ebrahimi      *                sequence_number +
748*62c56f98SSadaf Ebrahimi      *                cid +
749*62c56f98SSadaf Ebrahimi      *                length_of_DTLSInnerPlaintext
750*62c56f98SSadaf Ebrahimi      *
751*62c56f98SSadaf Ebrahimi      * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
752*62c56f98SSadaf Ebrahimi      * defines the additional data calculation as follows:
753*62c56f98SSadaf Ebrahimi      *
754*62c56f98SSadaf Ebrahimi      *     additional_data = seq_num +
755*62c56f98SSadaf Ebrahimi      *                tls12_cid +
756*62c56f98SSadaf Ebrahimi      *                DTLSCipherText.version +
757*62c56f98SSadaf Ebrahimi      *                cid +
758*62c56f98SSadaf Ebrahimi      *                cid_length +
759*62c56f98SSadaf Ebrahimi      *                length_of_DTLSInnerPlaintext
760*62c56f98SSadaf Ebrahimi      */
761*62c56f98SSadaf Ebrahimi 
762*62c56f98SSadaf Ebrahimi     unsigned char *cur = add_data;
763*62c56f98SSadaf Ebrahimi     size_t ad_len_field = rec->data_len;
764*62c56f98SSadaf Ebrahimi 
765*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
766*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
767*62c56f98SSadaf Ebrahimi     const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
768*62c56f98SSadaf Ebrahimi #endif
769*62c56f98SSadaf Ebrahimi 
770*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
771*62c56f98SSadaf Ebrahimi     if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
772*62c56f98SSadaf Ebrahimi         /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
773*62c56f98SSadaf Ebrahimi          * which differs from the length of the TLSInnerPlaintext
774*62c56f98SSadaf Ebrahimi          * by the length of the authentication tag. */
775*62c56f98SSadaf Ebrahimi         ad_len_field += taglen;
776*62c56f98SSadaf Ebrahimi     } else
777*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
778*62c56f98SSadaf Ebrahimi     {
779*62c56f98SSadaf Ebrahimi         ((void) tls_version);
780*62c56f98SSadaf Ebrahimi         ((void) taglen);
781*62c56f98SSadaf Ebrahimi 
782*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
783*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
784*62c56f98SSadaf Ebrahimi         if (rec->cid_len != 0) {
785*62c56f98SSadaf Ebrahimi             // seq_num_placeholder
786*62c56f98SSadaf Ebrahimi             memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
787*62c56f98SSadaf Ebrahimi             cur += sizeof(seq_num_placeholder);
788*62c56f98SSadaf Ebrahimi 
789*62c56f98SSadaf Ebrahimi             // tls12_cid type
790*62c56f98SSadaf Ebrahimi             *cur = rec->type;
791*62c56f98SSadaf Ebrahimi             cur++;
792*62c56f98SSadaf Ebrahimi 
793*62c56f98SSadaf Ebrahimi             // cid_length
794*62c56f98SSadaf Ebrahimi             *cur = rec->cid_len;
795*62c56f98SSadaf Ebrahimi             cur++;
796*62c56f98SSadaf Ebrahimi         } else
797*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
798*62c56f98SSadaf Ebrahimi         {
799*62c56f98SSadaf Ebrahimi             // epoch + sequence number
800*62c56f98SSadaf Ebrahimi             memcpy(cur, rec->ctr, sizeof(rec->ctr));
801*62c56f98SSadaf Ebrahimi             cur += sizeof(rec->ctr);
802*62c56f98SSadaf Ebrahimi         }
803*62c56f98SSadaf Ebrahimi     }
804*62c56f98SSadaf Ebrahimi 
805*62c56f98SSadaf Ebrahimi     // type
806*62c56f98SSadaf Ebrahimi     *cur = rec->type;
807*62c56f98SSadaf Ebrahimi     cur++;
808*62c56f98SSadaf Ebrahimi 
809*62c56f98SSadaf Ebrahimi     // version
810*62c56f98SSadaf Ebrahimi     memcpy(cur, rec->ver, sizeof(rec->ver));
811*62c56f98SSadaf Ebrahimi     cur += sizeof(rec->ver);
812*62c56f98SSadaf Ebrahimi 
813*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
814*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
815*62c56f98SSadaf Ebrahimi 
816*62c56f98SSadaf Ebrahimi     if (rec->cid_len != 0) {
817*62c56f98SSadaf Ebrahimi         // CID
818*62c56f98SSadaf Ebrahimi         memcpy(cur, rec->cid, rec->cid_len);
819*62c56f98SSadaf Ebrahimi         cur += rec->cid_len;
820*62c56f98SSadaf Ebrahimi 
821*62c56f98SSadaf Ebrahimi         // cid_length
822*62c56f98SSadaf Ebrahimi         *cur = rec->cid_len;
823*62c56f98SSadaf Ebrahimi         cur++;
824*62c56f98SSadaf Ebrahimi 
825*62c56f98SSadaf Ebrahimi         // length of inner plaintext
826*62c56f98SSadaf Ebrahimi         MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
827*62c56f98SSadaf Ebrahimi         cur += 2;
828*62c56f98SSadaf Ebrahimi     } else
829*62c56f98SSadaf Ebrahimi #elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
830*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
831*62c56f98SSadaf Ebrahimi 
832*62c56f98SSadaf Ebrahimi     if (rec->cid_len != 0) {
833*62c56f98SSadaf Ebrahimi         // epoch + sequence number
834*62c56f98SSadaf Ebrahimi         memcpy(cur, rec->ctr, sizeof(rec->ctr));
835*62c56f98SSadaf Ebrahimi         cur += sizeof(rec->ctr);
836*62c56f98SSadaf Ebrahimi 
837*62c56f98SSadaf Ebrahimi         // CID
838*62c56f98SSadaf Ebrahimi         memcpy(cur, rec->cid, rec->cid_len);
839*62c56f98SSadaf Ebrahimi         cur += rec->cid_len;
840*62c56f98SSadaf Ebrahimi 
841*62c56f98SSadaf Ebrahimi         // length of inner plaintext
842*62c56f98SSadaf Ebrahimi         MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
843*62c56f98SSadaf Ebrahimi         cur += 2;
844*62c56f98SSadaf Ebrahimi     } else
845*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
846*62c56f98SSadaf Ebrahimi     {
847*62c56f98SSadaf Ebrahimi         MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
848*62c56f98SSadaf Ebrahimi         cur += 2;
849*62c56f98SSadaf Ebrahimi     }
850*62c56f98SSadaf Ebrahimi 
851*62c56f98SSadaf Ebrahimi     *add_data_len = cur - add_data;
852*62c56f98SSadaf Ebrahimi }
853*62c56f98SSadaf Ebrahimi 
854*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_GCM_C) || \
855*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CCM_C) || \
856*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CHACHAPOLY_C)
857*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_transform_aead_dynamic_iv_is_explicit(mbedtls_ssl_transform const * transform)858*62c56f98SSadaf Ebrahimi static int ssl_transform_aead_dynamic_iv_is_explicit(
859*62c56f98SSadaf Ebrahimi     mbedtls_ssl_transform const *transform)
860*62c56f98SSadaf Ebrahimi {
861*62c56f98SSadaf Ebrahimi     return transform->ivlen != transform->fixed_ivlen;
862*62c56f98SSadaf Ebrahimi }
863*62c56f98SSadaf Ebrahimi 
864*62c56f98SSadaf Ebrahimi /* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
865*62c56f98SSadaf Ebrahimi  *
866*62c56f98SSadaf Ebrahimi  * Concretely, this occurs in two variants:
867*62c56f98SSadaf Ebrahimi  *
868*62c56f98SSadaf Ebrahimi  * a) Fixed and dynamic IV lengths add up to total IV length, giving
869*62c56f98SSadaf Ebrahimi  *       IV = fixed_iv || dynamic_iv
870*62c56f98SSadaf Ebrahimi  *
871*62c56f98SSadaf Ebrahimi  *    This variant is used in TLS 1.2 when used with GCM or CCM.
872*62c56f98SSadaf Ebrahimi  *
873*62c56f98SSadaf Ebrahimi  * b) Fixed IV lengths matches total IV length, giving
874*62c56f98SSadaf Ebrahimi  *       IV = fixed_iv XOR ( 0 || dynamic_iv )
875*62c56f98SSadaf Ebrahimi  *
876*62c56f98SSadaf Ebrahimi  *    This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
877*62c56f98SSadaf Ebrahimi  *
878*62c56f98SSadaf Ebrahimi  * See also the documentation of mbedtls_ssl_transform.
879*62c56f98SSadaf Ebrahimi  *
880*62c56f98SSadaf Ebrahimi  * This function has the precondition that
881*62c56f98SSadaf Ebrahimi  *
882*62c56f98SSadaf Ebrahimi  *     dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
883*62c56f98SSadaf Ebrahimi  *
884*62c56f98SSadaf Ebrahimi  * which has to be ensured by the caller. If this precondition
885*62c56f98SSadaf Ebrahimi  * violated, the behavior of this function is undefined.
886*62c56f98SSadaf Ebrahimi  */
ssl_build_record_nonce(unsigned char * dst_iv,size_t dst_iv_len,unsigned char const * fixed_iv,size_t fixed_iv_len,unsigned char const * dynamic_iv,size_t dynamic_iv_len)887*62c56f98SSadaf Ebrahimi static void ssl_build_record_nonce(unsigned char *dst_iv,
888*62c56f98SSadaf Ebrahimi                                    size_t dst_iv_len,
889*62c56f98SSadaf Ebrahimi                                    unsigned char const *fixed_iv,
890*62c56f98SSadaf Ebrahimi                                    size_t fixed_iv_len,
891*62c56f98SSadaf Ebrahimi                                    unsigned char const *dynamic_iv,
892*62c56f98SSadaf Ebrahimi                                    size_t dynamic_iv_len)
893*62c56f98SSadaf Ebrahimi {
894*62c56f98SSadaf Ebrahimi     /* Start with Fixed IV || 0 */
895*62c56f98SSadaf Ebrahimi     memset(dst_iv, 0, dst_iv_len);
896*62c56f98SSadaf Ebrahimi     memcpy(dst_iv, fixed_iv, fixed_iv_len);
897*62c56f98SSadaf Ebrahimi 
898*62c56f98SSadaf Ebrahimi     dst_iv += dst_iv_len - dynamic_iv_len;
899*62c56f98SSadaf Ebrahimi     mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
900*62c56f98SSadaf Ebrahimi }
901*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
902*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_encrypt_buf(mbedtls_ssl_context * ssl,mbedtls_ssl_transform * transform,mbedtls_record * rec,int (* f_rng)(void *,unsigned char *,size_t),void * p_rng)903*62c56f98SSadaf Ebrahimi int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
904*62c56f98SSadaf Ebrahimi                             mbedtls_ssl_transform *transform,
905*62c56f98SSadaf Ebrahimi                             mbedtls_record *rec,
906*62c56f98SSadaf Ebrahimi                             int (*f_rng)(void *, unsigned char *, size_t),
907*62c56f98SSadaf Ebrahimi                             void *p_rng)
908*62c56f98SSadaf Ebrahimi {
909*62c56f98SSadaf Ebrahimi     mbedtls_ssl_mode_t ssl_mode;
910*62c56f98SSadaf Ebrahimi     int auth_done = 0;
911*62c56f98SSadaf Ebrahimi     unsigned char *data;
912*62c56f98SSadaf Ebrahimi     /* For an explanation of the additional data length see
913*62c56f98SSadaf Ebrahimi      * the description of ssl_extract_add_data_from_record().
914*62c56f98SSadaf Ebrahimi      */
915*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
916*62c56f98SSadaf Ebrahimi     unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
917*62c56f98SSadaf Ebrahimi #else
918*62c56f98SSadaf Ebrahimi     unsigned char add_data[13];
919*62c56f98SSadaf Ebrahimi #endif
920*62c56f98SSadaf Ebrahimi     size_t add_data_len;
921*62c56f98SSadaf Ebrahimi     size_t post_avail;
922*62c56f98SSadaf Ebrahimi 
923*62c56f98SSadaf Ebrahimi     /* The SSL context is only used for debugging purposes! */
924*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_DEBUG_C)
925*62c56f98SSadaf Ebrahimi     ssl = NULL; /* make sure we don't use it except for debug */
926*62c56f98SSadaf Ebrahimi     ((void) ssl);
927*62c56f98SSadaf Ebrahimi #endif
928*62c56f98SSadaf Ebrahimi 
929*62c56f98SSadaf Ebrahimi     /* The PRNG is used for dynamic IV generation that's used
930*62c56f98SSadaf Ebrahimi      * for CBC transformations in TLS 1.2. */
931*62c56f98SSadaf Ebrahimi #if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
932*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_SSL_PROTO_TLS1_2))
933*62c56f98SSadaf Ebrahimi     ((void) f_rng);
934*62c56f98SSadaf Ebrahimi     ((void) p_rng);
935*62c56f98SSadaf Ebrahimi #endif
936*62c56f98SSadaf Ebrahimi 
937*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
938*62c56f98SSadaf Ebrahimi 
939*62c56f98SSadaf Ebrahimi     if (transform == NULL) {
940*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
941*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
942*62c56f98SSadaf Ebrahimi     }
943*62c56f98SSadaf Ebrahimi     if (rec == NULL
944*62c56f98SSadaf Ebrahimi         || rec->buf == NULL
945*62c56f98SSadaf Ebrahimi         || rec->buf_len < rec->data_offset
946*62c56f98SSadaf Ebrahimi         || rec->buf_len - rec->data_offset < rec->data_len
947*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
948*62c56f98SSadaf Ebrahimi         || rec->cid_len != 0
949*62c56f98SSadaf Ebrahimi #endif
950*62c56f98SSadaf Ebrahimi         ) {
951*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
952*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
953*62c56f98SSadaf Ebrahimi     }
954*62c56f98SSadaf Ebrahimi 
955*62c56f98SSadaf Ebrahimi     ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
956*62c56f98SSadaf Ebrahimi 
957*62c56f98SSadaf Ebrahimi     data = rec->buf + rec->data_offset;
958*62c56f98SSadaf Ebrahimi     post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
959*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
960*62c56f98SSadaf Ebrahimi                           data, rec->data_len);
961*62c56f98SSadaf Ebrahimi 
962*62c56f98SSadaf Ebrahimi     if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
963*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
964*62c56f98SSadaf Ebrahimi                                   " too large, maximum %" MBEDTLS_PRINTF_SIZET,
965*62c56f98SSadaf Ebrahimi                                   rec->data_len,
966*62c56f98SSadaf Ebrahimi                                   (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
967*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
968*62c56f98SSadaf Ebrahimi     }
969*62c56f98SSadaf Ebrahimi 
970*62c56f98SSadaf Ebrahimi     /* The following two code paths implement the (D)TLSInnerPlaintext
971*62c56f98SSadaf Ebrahimi      * structure present in TLS 1.3 and DTLS 1.2 + CID.
972*62c56f98SSadaf Ebrahimi      *
973*62c56f98SSadaf Ebrahimi      * See ssl_build_inner_plaintext() for more information.
974*62c56f98SSadaf Ebrahimi      *
975*62c56f98SSadaf Ebrahimi      * Note that this changes `rec->data_len`, and hence
976*62c56f98SSadaf Ebrahimi      * `post_avail` needs to be recalculated afterwards.
977*62c56f98SSadaf Ebrahimi      *
978*62c56f98SSadaf Ebrahimi      * Note also that the two code paths cannot occur simultaneously
979*62c56f98SSadaf Ebrahimi      * since they apply to different versions of the protocol. There
980*62c56f98SSadaf Ebrahimi      * is hence no risk of double-addition of the inner plaintext.
981*62c56f98SSadaf Ebrahimi      */
982*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
983*62c56f98SSadaf Ebrahimi     if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
984*62c56f98SSadaf Ebrahimi         size_t padding =
985*62c56f98SSadaf Ebrahimi             ssl_compute_padding_length(rec->data_len,
986*62c56f98SSadaf Ebrahimi                                        MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
987*62c56f98SSadaf Ebrahimi         if (ssl_build_inner_plaintext(data,
988*62c56f98SSadaf Ebrahimi                                       &rec->data_len,
989*62c56f98SSadaf Ebrahimi                                       post_avail,
990*62c56f98SSadaf Ebrahimi                                       rec->type,
991*62c56f98SSadaf Ebrahimi                                       padding) != 0) {
992*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
993*62c56f98SSadaf Ebrahimi         }
994*62c56f98SSadaf Ebrahimi 
995*62c56f98SSadaf Ebrahimi         rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
996*62c56f98SSadaf Ebrahimi     }
997*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
998*62c56f98SSadaf Ebrahimi 
999*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1000*62c56f98SSadaf Ebrahimi     /*
1001*62c56f98SSadaf Ebrahimi      * Add CID information
1002*62c56f98SSadaf Ebrahimi      */
1003*62c56f98SSadaf Ebrahimi     rec->cid_len = transform->out_cid_len;
1004*62c56f98SSadaf Ebrahimi     memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1005*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
1006*62c56f98SSadaf Ebrahimi 
1007*62c56f98SSadaf Ebrahimi     if (rec->cid_len != 0) {
1008*62c56f98SSadaf Ebrahimi         size_t padding =
1009*62c56f98SSadaf Ebrahimi             ssl_compute_padding_length(rec->data_len,
1010*62c56f98SSadaf Ebrahimi                                        MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
1011*62c56f98SSadaf Ebrahimi         /*
1012*62c56f98SSadaf Ebrahimi          * Wrap plaintext into DTLSInnerPlaintext structure.
1013*62c56f98SSadaf Ebrahimi          * See ssl_build_inner_plaintext() for more information.
1014*62c56f98SSadaf Ebrahimi          *
1015*62c56f98SSadaf Ebrahimi          * Note that this changes `rec->data_len`, and hence
1016*62c56f98SSadaf Ebrahimi          * `post_avail` needs to be recalculated afterwards.
1017*62c56f98SSadaf Ebrahimi          */
1018*62c56f98SSadaf Ebrahimi         if (ssl_build_inner_plaintext(data,
1019*62c56f98SSadaf Ebrahimi                                       &rec->data_len,
1020*62c56f98SSadaf Ebrahimi                                       post_avail,
1021*62c56f98SSadaf Ebrahimi                                       rec->type,
1022*62c56f98SSadaf Ebrahimi                                       padding) != 0) {
1023*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1024*62c56f98SSadaf Ebrahimi         }
1025*62c56f98SSadaf Ebrahimi 
1026*62c56f98SSadaf Ebrahimi         rec->type = MBEDTLS_SSL_MSG_CID;
1027*62c56f98SSadaf Ebrahimi     }
1028*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1029*62c56f98SSadaf Ebrahimi 
1030*62c56f98SSadaf Ebrahimi     post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
1031*62c56f98SSadaf Ebrahimi 
1032*62c56f98SSadaf Ebrahimi     /*
1033*62c56f98SSadaf Ebrahimi      * Add MAC before if needed
1034*62c56f98SSadaf Ebrahimi      */
1035*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1036*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1037*62c56f98SSadaf Ebrahimi         ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1038*62c56f98SSadaf Ebrahimi         if (post_avail < transform->maclen) {
1039*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1040*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1041*62c56f98SSadaf Ebrahimi         }
1042*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1043*62c56f98SSadaf Ebrahimi         unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1044*62c56f98SSadaf Ebrahimi         int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1045*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1046*62c56f98SSadaf Ebrahimi         psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1047*62c56f98SSadaf Ebrahimi         psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1048*62c56f98SSadaf Ebrahimi         size_t sign_mac_length = 0;
1049*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1050*62c56f98SSadaf Ebrahimi 
1051*62c56f98SSadaf Ebrahimi         ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1052*62c56f98SSadaf Ebrahimi                                          transform->tls_version,
1053*62c56f98SSadaf Ebrahimi                                          transform->taglen);
1054*62c56f98SSadaf Ebrahimi 
1055*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1056*62c56f98SSadaf Ebrahimi         status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1057*62c56f98SSadaf Ebrahimi                                     transform->psa_mac_alg);
1058*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1059*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1060*62c56f98SSadaf Ebrahimi         }
1061*62c56f98SSadaf Ebrahimi 
1062*62c56f98SSadaf Ebrahimi         status = psa_mac_update(&operation, add_data, add_data_len);
1063*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1064*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1065*62c56f98SSadaf Ebrahimi         }
1066*62c56f98SSadaf Ebrahimi 
1067*62c56f98SSadaf Ebrahimi         status = psa_mac_update(&operation, data, rec->data_len);
1068*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1069*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1070*62c56f98SSadaf Ebrahimi         }
1071*62c56f98SSadaf Ebrahimi 
1072*62c56f98SSadaf Ebrahimi         status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1073*62c56f98SSadaf Ebrahimi                                      &sign_mac_length);
1074*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1075*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1076*62c56f98SSadaf Ebrahimi         }
1077*62c56f98SSadaf Ebrahimi #else
1078*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1079*62c56f98SSadaf Ebrahimi                                      add_data_len);
1080*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1081*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1082*62c56f98SSadaf Ebrahimi         }
1083*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1084*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1085*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1086*62c56f98SSadaf Ebrahimi         }
1087*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1088*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1089*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1090*62c56f98SSadaf Ebrahimi         }
1091*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1092*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1093*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
1094*62c56f98SSadaf Ebrahimi         }
1095*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1096*62c56f98SSadaf Ebrahimi 
1097*62c56f98SSadaf Ebrahimi         memcpy(data + rec->data_len, mac, transform->maclen);
1098*62c56f98SSadaf Ebrahimi #endif
1099*62c56f98SSadaf Ebrahimi 
1100*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1101*62c56f98SSadaf Ebrahimi                               transform->maclen);
1102*62c56f98SSadaf Ebrahimi 
1103*62c56f98SSadaf Ebrahimi         rec->data_len += transform->maclen;
1104*62c56f98SSadaf Ebrahimi         post_avail -= transform->maclen;
1105*62c56f98SSadaf Ebrahimi         auth_done++;
1106*62c56f98SSadaf Ebrahimi 
1107*62c56f98SSadaf Ebrahimi hmac_failed_etm_disabled:
1108*62c56f98SSadaf Ebrahimi         mbedtls_platform_zeroize(mac, transform->maclen);
1109*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1110*62c56f98SSadaf Ebrahimi         ret = PSA_TO_MBEDTLS_ERR(status);
1111*62c56f98SSadaf Ebrahimi         status = psa_mac_abort(&operation);
1112*62c56f98SSadaf Ebrahimi         if (ret == 0 && status != PSA_SUCCESS) {
1113*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1114*62c56f98SSadaf Ebrahimi         }
1115*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1116*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1117*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1118*62c56f98SSadaf Ebrahimi             return ret;
1119*62c56f98SSadaf Ebrahimi         }
1120*62c56f98SSadaf Ebrahimi     }
1121*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1122*62c56f98SSadaf Ebrahimi 
1123*62c56f98SSadaf Ebrahimi     /*
1124*62c56f98SSadaf Ebrahimi      * Encrypt
1125*62c56f98SSadaf Ebrahimi      */
1126*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
1127*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1128*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1129*62c56f98SSadaf Ebrahimi                                                                                     "including %d bytes of padding",
1130*62c56f98SSadaf Ebrahimi                                   rec->data_len, 0));
1131*62c56f98SSadaf Ebrahimi 
1132*62c56f98SSadaf Ebrahimi         /* The only supported stream cipher is "NULL",
1133*62c56f98SSadaf Ebrahimi          * so there's nothing to do here.*/
1134*62c56f98SSadaf Ebrahimi     } else
1135*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
1136*62c56f98SSadaf Ebrahimi 
1137*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_GCM_C) || \
1138*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CCM_C) || \
1139*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CHACHAPOLY_C)
1140*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
1141*62c56f98SSadaf Ebrahimi         unsigned char iv[12];
1142*62c56f98SSadaf Ebrahimi         unsigned char *dynamic_iv;
1143*62c56f98SSadaf Ebrahimi         size_t dynamic_iv_len;
1144*62c56f98SSadaf Ebrahimi         int dynamic_iv_is_explicit =
1145*62c56f98SSadaf Ebrahimi             ssl_transform_aead_dynamic_iv_is_explicit(transform);
1146*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1147*62c56f98SSadaf Ebrahimi         psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1148*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1149*62c56f98SSadaf Ebrahimi         int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1150*62c56f98SSadaf Ebrahimi 
1151*62c56f98SSadaf Ebrahimi         /* Check that there's space for the authentication tag. */
1152*62c56f98SSadaf Ebrahimi         if (post_avail < transform->taglen) {
1153*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1154*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1155*62c56f98SSadaf Ebrahimi         }
1156*62c56f98SSadaf Ebrahimi 
1157*62c56f98SSadaf Ebrahimi         /*
1158*62c56f98SSadaf Ebrahimi          * Build nonce for AEAD encryption.
1159*62c56f98SSadaf Ebrahimi          *
1160*62c56f98SSadaf Ebrahimi          * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1161*62c56f98SSadaf Ebrahimi          *       part of the IV is prepended to the ciphertext and
1162*62c56f98SSadaf Ebrahimi          *       can be chosen freely - in particular, it need not
1163*62c56f98SSadaf Ebrahimi          *       agree with the record sequence number.
1164*62c56f98SSadaf Ebrahimi          *       However, since ChaChaPoly as well as all AEAD modes
1165*62c56f98SSadaf Ebrahimi          *       in TLS 1.3 use the record sequence number as the
1166*62c56f98SSadaf Ebrahimi          *       dynamic part of the nonce, we uniformly use the
1167*62c56f98SSadaf Ebrahimi          *       record sequence number here in all cases.
1168*62c56f98SSadaf Ebrahimi          */
1169*62c56f98SSadaf Ebrahimi         dynamic_iv     = rec->ctr;
1170*62c56f98SSadaf Ebrahimi         dynamic_iv_len = sizeof(rec->ctr);
1171*62c56f98SSadaf Ebrahimi 
1172*62c56f98SSadaf Ebrahimi         ssl_build_record_nonce(iv, sizeof(iv),
1173*62c56f98SSadaf Ebrahimi                                transform->iv_enc,
1174*62c56f98SSadaf Ebrahimi                                transform->fixed_ivlen,
1175*62c56f98SSadaf Ebrahimi                                dynamic_iv,
1176*62c56f98SSadaf Ebrahimi                                dynamic_iv_len);
1177*62c56f98SSadaf Ebrahimi 
1178*62c56f98SSadaf Ebrahimi         /*
1179*62c56f98SSadaf Ebrahimi          * Build additional data for AEAD encryption.
1180*62c56f98SSadaf Ebrahimi          * This depends on the TLS version.
1181*62c56f98SSadaf Ebrahimi          */
1182*62c56f98SSadaf Ebrahimi         ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1183*62c56f98SSadaf Ebrahimi                                          transform->tls_version,
1184*62c56f98SSadaf Ebrahimi                                          transform->taglen);
1185*62c56f98SSadaf Ebrahimi 
1186*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1187*62c56f98SSadaf Ebrahimi                               iv, transform->ivlen);
1188*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1189*62c56f98SSadaf Ebrahimi                               dynamic_iv,
1190*62c56f98SSadaf Ebrahimi                               dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1191*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1192*62c56f98SSadaf Ebrahimi                               add_data, add_data_len);
1193*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1194*62c56f98SSadaf Ebrahimi                                                                                     "including 0 bytes of padding",
1195*62c56f98SSadaf Ebrahimi                                   rec->data_len));
1196*62c56f98SSadaf Ebrahimi 
1197*62c56f98SSadaf Ebrahimi         /*
1198*62c56f98SSadaf Ebrahimi          * Encrypt and authenticate
1199*62c56f98SSadaf Ebrahimi          */
1200*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1201*62c56f98SSadaf Ebrahimi         status = psa_aead_encrypt(transform->psa_key_enc,
1202*62c56f98SSadaf Ebrahimi                                   transform->psa_alg,
1203*62c56f98SSadaf Ebrahimi                                   iv, transform->ivlen,
1204*62c56f98SSadaf Ebrahimi                                   add_data, add_data_len,
1205*62c56f98SSadaf Ebrahimi                                   data, rec->data_len,
1206*62c56f98SSadaf Ebrahimi                                   data, rec->buf_len - (data - rec->buf),
1207*62c56f98SSadaf Ebrahimi                                   &rec->data_len);
1208*62c56f98SSadaf Ebrahimi 
1209*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1210*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1211*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1212*62c56f98SSadaf Ebrahimi             return ret;
1213*62c56f98SSadaf Ebrahimi         }
1214*62c56f98SSadaf Ebrahimi #else
1215*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1216*62c56f98SSadaf Ebrahimi                                                    iv, transform->ivlen,
1217*62c56f98SSadaf Ebrahimi                                                    add_data, add_data_len,
1218*62c56f98SSadaf Ebrahimi                                                    data, rec->data_len, /* src */
1219*62c56f98SSadaf Ebrahimi                                                    data, rec->buf_len - (data - rec->buf), /* dst */
1220*62c56f98SSadaf Ebrahimi                                                    &rec->data_len,
1221*62c56f98SSadaf Ebrahimi                                                    transform->taglen)) != 0) {
1222*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1223*62c56f98SSadaf Ebrahimi             return ret;
1224*62c56f98SSadaf Ebrahimi         }
1225*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1226*62c56f98SSadaf Ebrahimi 
1227*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1228*62c56f98SSadaf Ebrahimi                               data + rec->data_len - transform->taglen,
1229*62c56f98SSadaf Ebrahimi                               transform->taglen);
1230*62c56f98SSadaf Ebrahimi         /* Account for authentication tag. */
1231*62c56f98SSadaf Ebrahimi         post_avail -= transform->taglen;
1232*62c56f98SSadaf Ebrahimi 
1233*62c56f98SSadaf Ebrahimi         /*
1234*62c56f98SSadaf Ebrahimi          * Prefix record content with dynamic IV in case it is explicit.
1235*62c56f98SSadaf Ebrahimi          */
1236*62c56f98SSadaf Ebrahimi         if (dynamic_iv_is_explicit != 0) {
1237*62c56f98SSadaf Ebrahimi             if (rec->data_offset < dynamic_iv_len) {
1238*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1239*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1240*62c56f98SSadaf Ebrahimi             }
1241*62c56f98SSadaf Ebrahimi 
1242*62c56f98SSadaf Ebrahimi             memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
1243*62c56f98SSadaf Ebrahimi             rec->data_offset -= dynamic_iv_len;
1244*62c56f98SSadaf Ebrahimi             rec->data_len    += dynamic_iv_len;
1245*62c56f98SSadaf Ebrahimi         }
1246*62c56f98SSadaf Ebrahimi 
1247*62c56f98SSadaf Ebrahimi         auth_done++;
1248*62c56f98SSadaf Ebrahimi     } else
1249*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
1250*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
1251*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1252*62c56f98SSadaf Ebrahimi         ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
1253*62c56f98SSadaf Ebrahimi         int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1254*62c56f98SSadaf Ebrahimi         size_t padlen, i;
1255*62c56f98SSadaf Ebrahimi         size_t olen;
1256*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1257*62c56f98SSadaf Ebrahimi         psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1258*62c56f98SSadaf Ebrahimi         size_t part_len;
1259*62c56f98SSadaf Ebrahimi         psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1260*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1261*62c56f98SSadaf Ebrahimi 
1262*62c56f98SSadaf Ebrahimi         /* Currently we're always using minimal padding
1263*62c56f98SSadaf Ebrahimi          * (up to 255 bytes would be allowed). */
1264*62c56f98SSadaf Ebrahimi         padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1265*62c56f98SSadaf Ebrahimi         if (padlen == transform->ivlen) {
1266*62c56f98SSadaf Ebrahimi             padlen = 0;
1267*62c56f98SSadaf Ebrahimi         }
1268*62c56f98SSadaf Ebrahimi 
1269*62c56f98SSadaf Ebrahimi         /* Check there's enough space in the buffer for the padding. */
1270*62c56f98SSadaf Ebrahimi         if (post_avail < padlen + 1) {
1271*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1272*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1273*62c56f98SSadaf Ebrahimi         }
1274*62c56f98SSadaf Ebrahimi 
1275*62c56f98SSadaf Ebrahimi         for (i = 0; i <= padlen; i++) {
1276*62c56f98SSadaf Ebrahimi             data[rec->data_len + i] = (unsigned char) padlen;
1277*62c56f98SSadaf Ebrahimi         }
1278*62c56f98SSadaf Ebrahimi 
1279*62c56f98SSadaf Ebrahimi         rec->data_len += padlen + 1;
1280*62c56f98SSadaf Ebrahimi         post_avail -= padlen + 1;
1281*62c56f98SSadaf Ebrahimi 
1282*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1283*62c56f98SSadaf Ebrahimi         /*
1284*62c56f98SSadaf Ebrahimi          * Prepend per-record IV for block cipher in TLS v1.2 as per
1285*62c56f98SSadaf Ebrahimi          * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
1286*62c56f98SSadaf Ebrahimi          */
1287*62c56f98SSadaf Ebrahimi         if (f_rng == NULL) {
1288*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1289*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1290*62c56f98SSadaf Ebrahimi         }
1291*62c56f98SSadaf Ebrahimi 
1292*62c56f98SSadaf Ebrahimi         if (rec->data_offset < transform->ivlen) {
1293*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1294*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1295*62c56f98SSadaf Ebrahimi         }
1296*62c56f98SSadaf Ebrahimi 
1297*62c56f98SSadaf Ebrahimi         /*
1298*62c56f98SSadaf Ebrahimi          * Generate IV
1299*62c56f98SSadaf Ebrahimi          */
1300*62c56f98SSadaf Ebrahimi         ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1301*62c56f98SSadaf Ebrahimi         if (ret != 0) {
1302*62c56f98SSadaf Ebrahimi             return ret;
1303*62c56f98SSadaf Ebrahimi         }
1304*62c56f98SSadaf Ebrahimi 
1305*62c56f98SSadaf Ebrahimi         memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
1306*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1307*62c56f98SSadaf Ebrahimi 
1308*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1309*62c56f98SSadaf Ebrahimi                                                                                     "including %"
1310*62c56f98SSadaf Ebrahimi                                   MBEDTLS_PRINTF_SIZET
1311*62c56f98SSadaf Ebrahimi                                   " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1312*62c56f98SSadaf Ebrahimi                                   rec->data_len, transform->ivlen,
1313*62c56f98SSadaf Ebrahimi                                   padlen + 1));
1314*62c56f98SSadaf Ebrahimi 
1315*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1316*62c56f98SSadaf Ebrahimi         status = psa_cipher_encrypt_setup(&cipher_op,
1317*62c56f98SSadaf Ebrahimi                                           transform->psa_key_enc, transform->psa_alg);
1318*62c56f98SSadaf Ebrahimi 
1319*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1320*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1321*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1322*62c56f98SSadaf Ebrahimi             return ret;
1323*62c56f98SSadaf Ebrahimi         }
1324*62c56f98SSadaf Ebrahimi 
1325*62c56f98SSadaf Ebrahimi         status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
1326*62c56f98SSadaf Ebrahimi 
1327*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1328*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1329*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1330*62c56f98SSadaf Ebrahimi             return ret;
1331*62c56f98SSadaf Ebrahimi 
1332*62c56f98SSadaf Ebrahimi         }
1333*62c56f98SSadaf Ebrahimi 
1334*62c56f98SSadaf Ebrahimi         status = psa_cipher_update(&cipher_op,
1335*62c56f98SSadaf Ebrahimi                                    data, rec->data_len,
1336*62c56f98SSadaf Ebrahimi                                    data, rec->data_len, &olen);
1337*62c56f98SSadaf Ebrahimi 
1338*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1339*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1340*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1341*62c56f98SSadaf Ebrahimi             return ret;
1342*62c56f98SSadaf Ebrahimi 
1343*62c56f98SSadaf Ebrahimi         }
1344*62c56f98SSadaf Ebrahimi 
1345*62c56f98SSadaf Ebrahimi         status = psa_cipher_finish(&cipher_op,
1346*62c56f98SSadaf Ebrahimi                                    data + olen, rec->data_len - olen,
1347*62c56f98SSadaf Ebrahimi                                    &part_len);
1348*62c56f98SSadaf Ebrahimi 
1349*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1350*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1351*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1352*62c56f98SSadaf Ebrahimi             return ret;
1353*62c56f98SSadaf Ebrahimi 
1354*62c56f98SSadaf Ebrahimi         }
1355*62c56f98SSadaf Ebrahimi 
1356*62c56f98SSadaf Ebrahimi         olen += part_len;
1357*62c56f98SSadaf Ebrahimi #else
1358*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1359*62c56f98SSadaf Ebrahimi                                         transform->iv_enc,
1360*62c56f98SSadaf Ebrahimi                                         transform->ivlen,
1361*62c56f98SSadaf Ebrahimi                                         data, rec->data_len,
1362*62c56f98SSadaf Ebrahimi                                         data, &olen)) != 0) {
1363*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1364*62c56f98SSadaf Ebrahimi             return ret;
1365*62c56f98SSadaf Ebrahimi         }
1366*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1367*62c56f98SSadaf Ebrahimi 
1368*62c56f98SSadaf Ebrahimi         if (rec->data_len != olen) {
1369*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1370*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1371*62c56f98SSadaf Ebrahimi         }
1372*62c56f98SSadaf Ebrahimi 
1373*62c56f98SSadaf Ebrahimi         data             -= transform->ivlen;
1374*62c56f98SSadaf Ebrahimi         rec->data_offset -= transform->ivlen;
1375*62c56f98SSadaf Ebrahimi         rec->data_len    += transform->ivlen;
1376*62c56f98SSadaf Ebrahimi 
1377*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1378*62c56f98SSadaf Ebrahimi         if (auth_done == 0) {
1379*62c56f98SSadaf Ebrahimi             unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1380*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1381*62c56f98SSadaf Ebrahimi             psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1382*62c56f98SSadaf Ebrahimi             size_t sign_mac_length = 0;
1383*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1384*62c56f98SSadaf Ebrahimi 
1385*62c56f98SSadaf Ebrahimi             /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
1386*62c56f98SSadaf Ebrahimi              */
1387*62c56f98SSadaf Ebrahimi 
1388*62c56f98SSadaf Ebrahimi             if (post_avail < transform->maclen) {
1389*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1390*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1391*62c56f98SSadaf Ebrahimi             }
1392*62c56f98SSadaf Ebrahimi 
1393*62c56f98SSadaf Ebrahimi             ssl_extract_add_data_from_record(add_data, &add_data_len,
1394*62c56f98SSadaf Ebrahimi                                              rec, transform->tls_version,
1395*62c56f98SSadaf Ebrahimi                                              transform->taglen);
1396*62c56f98SSadaf Ebrahimi 
1397*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1398*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1399*62c56f98SSadaf Ebrahimi                                   add_data_len);
1400*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1401*62c56f98SSadaf Ebrahimi             status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1402*62c56f98SSadaf Ebrahimi                                         transform->psa_mac_alg);
1403*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1404*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1405*62c56f98SSadaf Ebrahimi             }
1406*62c56f98SSadaf Ebrahimi 
1407*62c56f98SSadaf Ebrahimi             status = psa_mac_update(&operation, add_data, add_data_len);
1408*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1409*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1410*62c56f98SSadaf Ebrahimi             }
1411*62c56f98SSadaf Ebrahimi 
1412*62c56f98SSadaf Ebrahimi             status = psa_mac_update(&operation, data, rec->data_len);
1413*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1414*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1415*62c56f98SSadaf Ebrahimi             }
1416*62c56f98SSadaf Ebrahimi 
1417*62c56f98SSadaf Ebrahimi             status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1418*62c56f98SSadaf Ebrahimi                                          &sign_mac_length);
1419*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1420*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1421*62c56f98SSadaf Ebrahimi             }
1422*62c56f98SSadaf Ebrahimi #else
1423*62c56f98SSadaf Ebrahimi 
1424*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1425*62c56f98SSadaf Ebrahimi                                          add_data_len);
1426*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1427*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1428*62c56f98SSadaf Ebrahimi             }
1429*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1430*62c56f98SSadaf Ebrahimi                                          data, rec->data_len);
1431*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1432*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1433*62c56f98SSadaf Ebrahimi             }
1434*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1435*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1436*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1437*62c56f98SSadaf Ebrahimi             }
1438*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1439*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1440*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1441*62c56f98SSadaf Ebrahimi             }
1442*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1443*62c56f98SSadaf Ebrahimi 
1444*62c56f98SSadaf Ebrahimi             memcpy(data + rec->data_len, mac, transform->maclen);
1445*62c56f98SSadaf Ebrahimi 
1446*62c56f98SSadaf Ebrahimi             rec->data_len += transform->maclen;
1447*62c56f98SSadaf Ebrahimi             post_avail -= transform->maclen;
1448*62c56f98SSadaf Ebrahimi             auth_done++;
1449*62c56f98SSadaf Ebrahimi 
1450*62c56f98SSadaf Ebrahimi hmac_failed_etm_enabled:
1451*62c56f98SSadaf Ebrahimi             mbedtls_platform_zeroize(mac, transform->maclen);
1452*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1453*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1454*62c56f98SSadaf Ebrahimi             status = psa_mac_abort(&operation);
1455*62c56f98SSadaf Ebrahimi             if (ret == 0 && status != PSA_SUCCESS) {
1456*62c56f98SSadaf Ebrahimi                 ret = PSA_TO_MBEDTLS_ERR(status);
1457*62c56f98SSadaf Ebrahimi             }
1458*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1459*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1460*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1461*62c56f98SSadaf Ebrahimi                 return ret;
1462*62c56f98SSadaf Ebrahimi             }
1463*62c56f98SSadaf Ebrahimi         }
1464*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1465*62c56f98SSadaf Ebrahimi     } else
1466*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
1467*62c56f98SSadaf Ebrahimi     {
1468*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1469*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1470*62c56f98SSadaf Ebrahimi     }
1471*62c56f98SSadaf Ebrahimi 
1472*62c56f98SSadaf Ebrahimi     /* Make extra sure authentication was performed, exactly once */
1473*62c56f98SSadaf Ebrahimi     if (auth_done != 1) {
1474*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1475*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1476*62c56f98SSadaf Ebrahimi     }
1477*62c56f98SSadaf Ebrahimi 
1478*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
1479*62c56f98SSadaf Ebrahimi 
1480*62c56f98SSadaf Ebrahimi     return 0;
1481*62c56f98SSadaf Ebrahimi }
1482*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const * ssl,mbedtls_ssl_transform * transform,mbedtls_record * rec)1483*62c56f98SSadaf Ebrahimi int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1484*62c56f98SSadaf Ebrahimi                             mbedtls_ssl_transform *transform,
1485*62c56f98SSadaf Ebrahimi                             mbedtls_record *rec)
1486*62c56f98SSadaf Ebrahimi {
1487*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
1488*62c56f98SSadaf Ebrahimi     size_t olen;
1489*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
1490*62c56f98SSadaf Ebrahimi     mbedtls_ssl_mode_t ssl_mode;
1491*62c56f98SSadaf Ebrahimi     int ret;
1492*62c56f98SSadaf Ebrahimi 
1493*62c56f98SSadaf Ebrahimi     int auth_done = 0;
1494*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1495*62c56f98SSadaf Ebrahimi     size_t padlen = 0;
1496*62c56f98SSadaf Ebrahimi     mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
1497*62c56f98SSadaf Ebrahimi #endif
1498*62c56f98SSadaf Ebrahimi     unsigned char *data;
1499*62c56f98SSadaf Ebrahimi     /* For an explanation of the additional data length see
1500*62c56f98SSadaf Ebrahimi      * the description of ssl_extract_add_data_from_record().
1501*62c56f98SSadaf Ebrahimi      */
1502*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1503*62c56f98SSadaf Ebrahimi     unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1504*62c56f98SSadaf Ebrahimi #else
1505*62c56f98SSadaf Ebrahimi     unsigned char add_data[13];
1506*62c56f98SSadaf Ebrahimi #endif
1507*62c56f98SSadaf Ebrahimi     size_t add_data_len;
1508*62c56f98SSadaf Ebrahimi 
1509*62c56f98SSadaf Ebrahimi #if !defined(MBEDTLS_DEBUG_C)
1510*62c56f98SSadaf Ebrahimi     ssl = NULL; /* make sure we don't use it except for debug */
1511*62c56f98SSadaf Ebrahimi     ((void) ssl);
1512*62c56f98SSadaf Ebrahimi #endif
1513*62c56f98SSadaf Ebrahimi 
1514*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1515*62c56f98SSadaf Ebrahimi     if (rec == NULL                     ||
1516*62c56f98SSadaf Ebrahimi         rec->buf == NULL                ||
1517*62c56f98SSadaf Ebrahimi         rec->buf_len < rec->data_offset ||
1518*62c56f98SSadaf Ebrahimi         rec->buf_len - rec->data_offset < rec->data_len) {
1519*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1520*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1521*62c56f98SSadaf Ebrahimi     }
1522*62c56f98SSadaf Ebrahimi 
1523*62c56f98SSadaf Ebrahimi     data = rec->buf + rec->data_offset;
1524*62c56f98SSadaf Ebrahimi     ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
1525*62c56f98SSadaf Ebrahimi 
1526*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1527*62c56f98SSadaf Ebrahimi     /*
1528*62c56f98SSadaf Ebrahimi      * Match record's CID with incoming CID.
1529*62c56f98SSadaf Ebrahimi      */
1530*62c56f98SSadaf Ebrahimi     if (rec->cid_len != transform->in_cid_len ||
1531*62c56f98SSadaf Ebrahimi         memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1532*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
1533*62c56f98SSadaf Ebrahimi     }
1534*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1535*62c56f98SSadaf Ebrahimi 
1536*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
1537*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1538*62c56f98SSadaf Ebrahimi         if (rec->data_len < transform->maclen) {
1539*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
1540*62c56f98SSadaf Ebrahimi                                   ("Record too short for MAC:"
1541*62c56f98SSadaf Ebrahimi                                    " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1542*62c56f98SSadaf Ebrahimi                                    rec->data_len, transform->maclen));
1543*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_MAC;
1544*62c56f98SSadaf Ebrahimi         }
1545*62c56f98SSadaf Ebrahimi 
1546*62c56f98SSadaf Ebrahimi         /* The only supported stream cipher is "NULL",
1547*62c56f98SSadaf Ebrahimi          * so there's no encryption to do here.*/
1548*62c56f98SSadaf Ebrahimi     } else
1549*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
1550*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_GCM_C) || \
1551*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CCM_C) || \
1552*62c56f98SSadaf Ebrahimi     defined(MBEDTLS_CHACHAPOLY_C)
1553*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
1554*62c56f98SSadaf Ebrahimi         unsigned char iv[12];
1555*62c56f98SSadaf Ebrahimi         unsigned char *dynamic_iv;
1556*62c56f98SSadaf Ebrahimi         size_t dynamic_iv_len;
1557*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1558*62c56f98SSadaf Ebrahimi         psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1559*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1560*62c56f98SSadaf Ebrahimi 
1561*62c56f98SSadaf Ebrahimi         /*
1562*62c56f98SSadaf Ebrahimi          * Extract dynamic part of nonce for AEAD decryption.
1563*62c56f98SSadaf Ebrahimi          *
1564*62c56f98SSadaf Ebrahimi          * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1565*62c56f98SSadaf Ebrahimi          *       part of the IV is prepended to the ciphertext and
1566*62c56f98SSadaf Ebrahimi          *       can be chosen freely - in particular, it need not
1567*62c56f98SSadaf Ebrahimi          *       agree with the record sequence number.
1568*62c56f98SSadaf Ebrahimi          */
1569*62c56f98SSadaf Ebrahimi         dynamic_iv_len = sizeof(rec->ctr);
1570*62c56f98SSadaf Ebrahimi         if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1571*62c56f98SSadaf Ebrahimi             if (rec->data_len < dynamic_iv_len) {
1572*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1573*62c56f98SSadaf Ebrahimi                                           " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1574*62c56f98SSadaf Ebrahimi                                           rec->data_len,
1575*62c56f98SSadaf Ebrahimi                                           dynamic_iv_len));
1576*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INVALID_MAC;
1577*62c56f98SSadaf Ebrahimi             }
1578*62c56f98SSadaf Ebrahimi             dynamic_iv = data;
1579*62c56f98SSadaf Ebrahimi 
1580*62c56f98SSadaf Ebrahimi             data += dynamic_iv_len;
1581*62c56f98SSadaf Ebrahimi             rec->data_offset += dynamic_iv_len;
1582*62c56f98SSadaf Ebrahimi             rec->data_len    -= dynamic_iv_len;
1583*62c56f98SSadaf Ebrahimi         } else {
1584*62c56f98SSadaf Ebrahimi             dynamic_iv = rec->ctr;
1585*62c56f98SSadaf Ebrahimi         }
1586*62c56f98SSadaf Ebrahimi 
1587*62c56f98SSadaf Ebrahimi         /* Check that there's space for the authentication tag. */
1588*62c56f98SSadaf Ebrahimi         if (rec->data_len < transform->taglen) {
1589*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1590*62c56f98SSadaf Ebrahimi                                       ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1591*62c56f98SSadaf Ebrahimi                                       rec->data_len,
1592*62c56f98SSadaf Ebrahimi                                       transform->taglen));
1593*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_MAC;
1594*62c56f98SSadaf Ebrahimi         }
1595*62c56f98SSadaf Ebrahimi         rec->data_len -= transform->taglen;
1596*62c56f98SSadaf Ebrahimi 
1597*62c56f98SSadaf Ebrahimi         /*
1598*62c56f98SSadaf Ebrahimi          * Prepare nonce from dynamic and static parts.
1599*62c56f98SSadaf Ebrahimi          */
1600*62c56f98SSadaf Ebrahimi         ssl_build_record_nonce(iv, sizeof(iv),
1601*62c56f98SSadaf Ebrahimi                                transform->iv_dec,
1602*62c56f98SSadaf Ebrahimi                                transform->fixed_ivlen,
1603*62c56f98SSadaf Ebrahimi                                dynamic_iv,
1604*62c56f98SSadaf Ebrahimi                                dynamic_iv_len);
1605*62c56f98SSadaf Ebrahimi 
1606*62c56f98SSadaf Ebrahimi         /*
1607*62c56f98SSadaf Ebrahimi          * Build additional data for AEAD encryption.
1608*62c56f98SSadaf Ebrahimi          * This depends on the TLS version.
1609*62c56f98SSadaf Ebrahimi          */
1610*62c56f98SSadaf Ebrahimi         ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1611*62c56f98SSadaf Ebrahimi                                          transform->tls_version,
1612*62c56f98SSadaf Ebrahimi                                          transform->taglen);
1613*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1614*62c56f98SSadaf Ebrahimi                               add_data, add_data_len);
1615*62c56f98SSadaf Ebrahimi 
1616*62c56f98SSadaf Ebrahimi         /* Because of the check above, we know that there are
1617*62c56f98SSadaf Ebrahimi          * explicit_iv_len Bytes preceding data, and taglen
1618*62c56f98SSadaf Ebrahimi          * bytes following data + data_len. This justifies
1619*62c56f98SSadaf Ebrahimi          * the debug message and the invocation of
1620*62c56f98SSadaf Ebrahimi          * mbedtls_cipher_auth_decrypt_ext() below. */
1621*62c56f98SSadaf Ebrahimi 
1622*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1623*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1624*62c56f98SSadaf Ebrahimi                               transform->taglen);
1625*62c56f98SSadaf Ebrahimi 
1626*62c56f98SSadaf Ebrahimi         /*
1627*62c56f98SSadaf Ebrahimi          * Decrypt and authenticate
1628*62c56f98SSadaf Ebrahimi          */
1629*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1630*62c56f98SSadaf Ebrahimi         status = psa_aead_decrypt(transform->psa_key_dec,
1631*62c56f98SSadaf Ebrahimi                                   transform->psa_alg,
1632*62c56f98SSadaf Ebrahimi                                   iv, transform->ivlen,
1633*62c56f98SSadaf Ebrahimi                                   add_data, add_data_len,
1634*62c56f98SSadaf Ebrahimi                                   data, rec->data_len + transform->taglen,
1635*62c56f98SSadaf Ebrahimi                                   data, rec->buf_len - (data - rec->buf),
1636*62c56f98SSadaf Ebrahimi                                   &olen);
1637*62c56f98SSadaf Ebrahimi 
1638*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1639*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1640*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1641*62c56f98SSadaf Ebrahimi             return ret;
1642*62c56f98SSadaf Ebrahimi         }
1643*62c56f98SSadaf Ebrahimi #else
1644*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1645*62c56f98SSadaf Ebrahimi                                                    iv, transform->ivlen,
1646*62c56f98SSadaf Ebrahimi                                                    add_data, add_data_len,
1647*62c56f98SSadaf Ebrahimi                                                    data, rec->data_len + transform->taglen, /* src */
1648*62c56f98SSadaf Ebrahimi                                                    data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1649*62c56f98SSadaf Ebrahimi                                                    transform->taglen)) != 0) {
1650*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
1651*62c56f98SSadaf Ebrahimi 
1652*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1653*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INVALID_MAC;
1654*62c56f98SSadaf Ebrahimi             }
1655*62c56f98SSadaf Ebrahimi 
1656*62c56f98SSadaf Ebrahimi             return ret;
1657*62c56f98SSadaf Ebrahimi         }
1658*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1659*62c56f98SSadaf Ebrahimi 
1660*62c56f98SSadaf Ebrahimi         auth_done++;
1661*62c56f98SSadaf Ebrahimi 
1662*62c56f98SSadaf Ebrahimi         /* Double-check that AEAD decryption doesn't change content length. */
1663*62c56f98SSadaf Ebrahimi         if (olen != rec->data_len) {
1664*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1665*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1666*62c56f98SSadaf Ebrahimi         }
1667*62c56f98SSadaf Ebrahimi     } else
1668*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1669*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
1670*62c56f98SSadaf Ebrahimi     if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1671*62c56f98SSadaf Ebrahimi         ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
1672*62c56f98SSadaf Ebrahimi         size_t minlen = 0;
1673*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1674*62c56f98SSadaf Ebrahimi         psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1675*62c56f98SSadaf Ebrahimi         size_t part_len;
1676*62c56f98SSadaf Ebrahimi         psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1677*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1678*62c56f98SSadaf Ebrahimi 
1679*62c56f98SSadaf Ebrahimi         /*
1680*62c56f98SSadaf Ebrahimi          * Check immediate ciphertext sanity
1681*62c56f98SSadaf Ebrahimi          */
1682*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1683*62c56f98SSadaf Ebrahimi         /* The ciphertext is prefixed with the CBC IV. */
1684*62c56f98SSadaf Ebrahimi         minlen += transform->ivlen;
1685*62c56f98SSadaf Ebrahimi #endif
1686*62c56f98SSadaf Ebrahimi 
1687*62c56f98SSadaf Ebrahimi         /* Size considerations:
1688*62c56f98SSadaf Ebrahimi          *
1689*62c56f98SSadaf Ebrahimi          * - The CBC cipher text must not be empty and hence
1690*62c56f98SSadaf Ebrahimi          *   at least of size transform->ivlen.
1691*62c56f98SSadaf Ebrahimi          *
1692*62c56f98SSadaf Ebrahimi          * Together with the potential IV-prefix, this explains
1693*62c56f98SSadaf Ebrahimi          * the first of the two checks below.
1694*62c56f98SSadaf Ebrahimi          *
1695*62c56f98SSadaf Ebrahimi          * - The record must contain a MAC, either in plain or
1696*62c56f98SSadaf Ebrahimi          *   encrypted, depending on whether Encrypt-then-MAC
1697*62c56f98SSadaf Ebrahimi          *   is used or not.
1698*62c56f98SSadaf Ebrahimi          *   - If it is, the message contains the IV-prefix,
1699*62c56f98SSadaf Ebrahimi          *     the CBC ciphertext, and the MAC.
1700*62c56f98SSadaf Ebrahimi          *   - If it is not, the padded plaintext, and hence
1701*62c56f98SSadaf Ebrahimi          *     the CBC ciphertext, has at least length maclen + 1
1702*62c56f98SSadaf Ebrahimi          *     because there is at least the padding length byte.
1703*62c56f98SSadaf Ebrahimi          *
1704*62c56f98SSadaf Ebrahimi          * As the CBC ciphertext is not empty, both cases give the
1705*62c56f98SSadaf Ebrahimi          * lower bound minlen + maclen + 1 on the record size, which
1706*62c56f98SSadaf Ebrahimi          * we test for in the second check below.
1707*62c56f98SSadaf Ebrahimi          */
1708*62c56f98SSadaf Ebrahimi         if (rec->data_len < minlen + transform->ivlen ||
1709*62c56f98SSadaf Ebrahimi             rec->data_len < minlen + transform->maclen + 1) {
1710*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1711*62c56f98SSadaf Ebrahimi                                       ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1712*62c56f98SSadaf Ebrahimi                                       "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1713*62c56f98SSadaf Ebrahimi                                                                           "+ 1 ) ( + expl IV )",
1714*62c56f98SSadaf Ebrahimi                                       rec->data_len,
1715*62c56f98SSadaf Ebrahimi                                       transform->ivlen,
1716*62c56f98SSadaf Ebrahimi                                       transform->maclen));
1717*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_MAC;
1718*62c56f98SSadaf Ebrahimi         }
1719*62c56f98SSadaf Ebrahimi 
1720*62c56f98SSadaf Ebrahimi         /*
1721*62c56f98SSadaf Ebrahimi          * Authenticate before decrypt if enabled
1722*62c56f98SSadaf Ebrahimi          */
1723*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1724*62c56f98SSadaf Ebrahimi         if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
1725*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1726*62c56f98SSadaf Ebrahimi             psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1727*62c56f98SSadaf Ebrahimi #else
1728*62c56f98SSadaf Ebrahimi             unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
1729*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1730*62c56f98SSadaf Ebrahimi 
1731*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1732*62c56f98SSadaf Ebrahimi 
1733*62c56f98SSadaf Ebrahimi             /* Update data_len in tandem with add_data.
1734*62c56f98SSadaf Ebrahimi              *
1735*62c56f98SSadaf Ebrahimi              * The subtraction is safe because of the previous check
1736*62c56f98SSadaf Ebrahimi              * data_len >= minlen + maclen + 1.
1737*62c56f98SSadaf Ebrahimi              *
1738*62c56f98SSadaf Ebrahimi              * Afterwards, we know that data + data_len is followed by at
1739*62c56f98SSadaf Ebrahimi              * least maclen Bytes, which justifies the call to
1740*62c56f98SSadaf Ebrahimi              * mbedtls_ct_memcmp() below.
1741*62c56f98SSadaf Ebrahimi              *
1742*62c56f98SSadaf Ebrahimi              * Further, we still know that data_len > minlen */
1743*62c56f98SSadaf Ebrahimi             rec->data_len -= transform->maclen;
1744*62c56f98SSadaf Ebrahimi             ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1745*62c56f98SSadaf Ebrahimi                                              transform->tls_version,
1746*62c56f98SSadaf Ebrahimi                                              transform->taglen);
1747*62c56f98SSadaf Ebrahimi 
1748*62c56f98SSadaf Ebrahimi             /* Calculate expected MAC. */
1749*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1750*62c56f98SSadaf Ebrahimi                                   add_data_len);
1751*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1752*62c56f98SSadaf Ebrahimi             status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1753*62c56f98SSadaf Ebrahimi                                           transform->psa_mac_alg);
1754*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1755*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1756*62c56f98SSadaf Ebrahimi             }
1757*62c56f98SSadaf Ebrahimi 
1758*62c56f98SSadaf Ebrahimi             status = psa_mac_update(&operation, add_data, add_data_len);
1759*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1760*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1761*62c56f98SSadaf Ebrahimi             }
1762*62c56f98SSadaf Ebrahimi 
1763*62c56f98SSadaf Ebrahimi             status = psa_mac_update(&operation, data, rec->data_len);
1764*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1765*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1766*62c56f98SSadaf Ebrahimi             }
1767*62c56f98SSadaf Ebrahimi 
1768*62c56f98SSadaf Ebrahimi             /* Compare expected MAC with MAC at the end of the record. */
1769*62c56f98SSadaf Ebrahimi             status = psa_mac_verify_finish(&operation, data + rec->data_len,
1770*62c56f98SSadaf Ebrahimi                                            transform->maclen);
1771*62c56f98SSadaf Ebrahimi             if (status != PSA_SUCCESS) {
1772*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1773*62c56f98SSadaf Ebrahimi             }
1774*62c56f98SSadaf Ebrahimi #else
1775*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1776*62c56f98SSadaf Ebrahimi                                          add_data_len);
1777*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1778*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1779*62c56f98SSadaf Ebrahimi             }
1780*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1781*62c56f98SSadaf Ebrahimi                                          data, rec->data_len);
1782*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1783*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1784*62c56f98SSadaf Ebrahimi             }
1785*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1786*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1787*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1788*62c56f98SSadaf Ebrahimi             }
1789*62c56f98SSadaf Ebrahimi             ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1790*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1791*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1792*62c56f98SSadaf Ebrahimi             }
1793*62c56f98SSadaf Ebrahimi 
1794*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(4, "message  mac", data + rec->data_len,
1795*62c56f98SSadaf Ebrahimi                                   transform->maclen);
1796*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1797*62c56f98SSadaf Ebrahimi                                   transform->maclen);
1798*62c56f98SSadaf Ebrahimi 
1799*62c56f98SSadaf Ebrahimi             /* Compare expected MAC with MAC at the end of the record. */
1800*62c56f98SSadaf Ebrahimi             if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1801*62c56f98SSadaf Ebrahimi                                   transform->maclen) != 0) {
1802*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
1803*62c56f98SSadaf Ebrahimi                 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1804*62c56f98SSadaf Ebrahimi                 goto hmac_failed_etm_enabled;
1805*62c56f98SSadaf Ebrahimi             }
1806*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1807*62c56f98SSadaf Ebrahimi             auth_done++;
1808*62c56f98SSadaf Ebrahimi 
1809*62c56f98SSadaf Ebrahimi hmac_failed_etm_enabled:
1810*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1811*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1812*62c56f98SSadaf Ebrahimi             status = psa_mac_abort(&operation);
1813*62c56f98SSadaf Ebrahimi             if (ret == 0 && status != PSA_SUCCESS) {
1814*62c56f98SSadaf Ebrahimi                 ret = PSA_TO_MBEDTLS_ERR(status);
1815*62c56f98SSadaf Ebrahimi             }
1816*62c56f98SSadaf Ebrahimi #else
1817*62c56f98SSadaf Ebrahimi             mbedtls_platform_zeroize(mac_expect, transform->maclen);
1818*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1819*62c56f98SSadaf Ebrahimi             if (ret != 0) {
1820*62c56f98SSadaf Ebrahimi                 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1821*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1822*62c56f98SSadaf Ebrahimi                 }
1823*62c56f98SSadaf Ebrahimi                 return ret;
1824*62c56f98SSadaf Ebrahimi             }
1825*62c56f98SSadaf Ebrahimi         }
1826*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1827*62c56f98SSadaf Ebrahimi 
1828*62c56f98SSadaf Ebrahimi         /*
1829*62c56f98SSadaf Ebrahimi          * Check length sanity
1830*62c56f98SSadaf Ebrahimi          */
1831*62c56f98SSadaf Ebrahimi 
1832*62c56f98SSadaf Ebrahimi         /* We know from above that data_len > minlen >= 0,
1833*62c56f98SSadaf Ebrahimi          * so the following check in particular implies that
1834*62c56f98SSadaf Ebrahimi          * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
1835*62c56f98SSadaf Ebrahimi         if (rec->data_len % transform->ivlen != 0) {
1836*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1837*62c56f98SSadaf Ebrahimi                                       ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1838*62c56f98SSadaf Ebrahimi                                       rec->data_len, transform->ivlen));
1839*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_MAC;
1840*62c56f98SSadaf Ebrahimi         }
1841*62c56f98SSadaf Ebrahimi 
1842*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1843*62c56f98SSadaf Ebrahimi         /*
1844*62c56f98SSadaf Ebrahimi          * Initialize for prepended IV for block cipher in TLS v1.2
1845*62c56f98SSadaf Ebrahimi          */
1846*62c56f98SSadaf Ebrahimi         /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1847*62c56f98SSadaf Ebrahimi         memcpy(transform->iv_dec, data, transform->ivlen);
1848*62c56f98SSadaf Ebrahimi 
1849*62c56f98SSadaf Ebrahimi         data += transform->ivlen;
1850*62c56f98SSadaf Ebrahimi         rec->data_offset += transform->ivlen;
1851*62c56f98SSadaf Ebrahimi         rec->data_len -= transform->ivlen;
1852*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1853*62c56f98SSadaf Ebrahimi 
1854*62c56f98SSadaf Ebrahimi         /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1855*62c56f98SSadaf Ebrahimi 
1856*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
1857*62c56f98SSadaf Ebrahimi         status = psa_cipher_decrypt_setup(&cipher_op,
1858*62c56f98SSadaf Ebrahimi                                           transform->psa_key_dec, transform->psa_alg);
1859*62c56f98SSadaf Ebrahimi 
1860*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1861*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1862*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1863*62c56f98SSadaf Ebrahimi             return ret;
1864*62c56f98SSadaf Ebrahimi         }
1865*62c56f98SSadaf Ebrahimi 
1866*62c56f98SSadaf Ebrahimi         status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
1867*62c56f98SSadaf Ebrahimi 
1868*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1869*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1870*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1871*62c56f98SSadaf Ebrahimi             return ret;
1872*62c56f98SSadaf Ebrahimi         }
1873*62c56f98SSadaf Ebrahimi 
1874*62c56f98SSadaf Ebrahimi         status = psa_cipher_update(&cipher_op,
1875*62c56f98SSadaf Ebrahimi                                    data, rec->data_len,
1876*62c56f98SSadaf Ebrahimi                                    data, rec->data_len, &olen);
1877*62c56f98SSadaf Ebrahimi 
1878*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1879*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1880*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1881*62c56f98SSadaf Ebrahimi             return ret;
1882*62c56f98SSadaf Ebrahimi         }
1883*62c56f98SSadaf Ebrahimi 
1884*62c56f98SSadaf Ebrahimi         status = psa_cipher_finish(&cipher_op,
1885*62c56f98SSadaf Ebrahimi                                    data + olen, rec->data_len - olen,
1886*62c56f98SSadaf Ebrahimi                                    &part_len);
1887*62c56f98SSadaf Ebrahimi 
1888*62c56f98SSadaf Ebrahimi         if (status != PSA_SUCCESS) {
1889*62c56f98SSadaf Ebrahimi             ret = PSA_TO_MBEDTLS_ERR(status);
1890*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1891*62c56f98SSadaf Ebrahimi             return ret;
1892*62c56f98SSadaf Ebrahimi         }
1893*62c56f98SSadaf Ebrahimi 
1894*62c56f98SSadaf Ebrahimi         olen += part_len;
1895*62c56f98SSadaf Ebrahimi #else
1896*62c56f98SSadaf Ebrahimi 
1897*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1898*62c56f98SSadaf Ebrahimi                                         transform->iv_dec, transform->ivlen,
1899*62c56f98SSadaf Ebrahimi                                         data, rec->data_len, data, &olen)) != 0) {
1900*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1901*62c56f98SSadaf Ebrahimi             return ret;
1902*62c56f98SSadaf Ebrahimi         }
1903*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
1904*62c56f98SSadaf Ebrahimi 
1905*62c56f98SSadaf Ebrahimi         /* Double-check that length hasn't changed during decryption. */
1906*62c56f98SSadaf Ebrahimi         if (rec->data_len != olen) {
1907*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1908*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1909*62c56f98SSadaf Ebrahimi         }
1910*62c56f98SSadaf Ebrahimi 
1911*62c56f98SSadaf Ebrahimi         /* Safe since data_len >= minlen + maclen + 1, so after having
1912*62c56f98SSadaf Ebrahimi          * subtracted at most minlen and maclen up to this point,
1913*62c56f98SSadaf Ebrahimi          * data_len > 0 (because of data_len % ivlen == 0, it's actually
1914*62c56f98SSadaf Ebrahimi          * >= ivlen ). */
1915*62c56f98SSadaf Ebrahimi         padlen = data[rec->data_len - 1];
1916*62c56f98SSadaf Ebrahimi 
1917*62c56f98SSadaf Ebrahimi         if (auth_done == 1) {
1918*62c56f98SSadaf Ebrahimi             const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
1919*62c56f98SSadaf Ebrahimi                 rec->data_len,
1920*62c56f98SSadaf Ebrahimi                 padlen + 1);
1921*62c56f98SSadaf Ebrahimi             correct = mbedtls_ct_bool_and(ge, correct);
1922*62c56f98SSadaf Ebrahimi             padlen  = mbedtls_ct_size_if_else_0(ge, padlen);
1923*62c56f98SSadaf Ebrahimi         } else {
1924*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DEBUG_ALL)
1925*62c56f98SSadaf Ebrahimi             if (rec->data_len < transform->maclen + padlen + 1) {
1926*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1927*62c56f98SSadaf Ebrahimi                                           ") < maclen (%" MBEDTLS_PRINTF_SIZET
1928*62c56f98SSadaf Ebrahimi                                           ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1929*62c56f98SSadaf Ebrahimi                                           rec->data_len,
1930*62c56f98SSadaf Ebrahimi                                           transform->maclen,
1931*62c56f98SSadaf Ebrahimi                                           padlen + 1));
1932*62c56f98SSadaf Ebrahimi             }
1933*62c56f98SSadaf Ebrahimi #endif
1934*62c56f98SSadaf Ebrahimi             const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
1935*62c56f98SSadaf Ebrahimi                 rec->data_len,
1936*62c56f98SSadaf Ebrahimi                 transform->maclen + padlen + 1);
1937*62c56f98SSadaf Ebrahimi             correct = mbedtls_ct_bool_and(ge, correct);
1938*62c56f98SSadaf Ebrahimi             padlen  = mbedtls_ct_size_if_else_0(ge, padlen);
1939*62c56f98SSadaf Ebrahimi         }
1940*62c56f98SSadaf Ebrahimi 
1941*62c56f98SSadaf Ebrahimi         padlen++;
1942*62c56f98SSadaf Ebrahimi 
1943*62c56f98SSadaf Ebrahimi         /* Regardless of the validity of the padding,
1944*62c56f98SSadaf Ebrahimi          * we have data_len >= padlen here. */
1945*62c56f98SSadaf Ebrahimi 
1946*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1947*62c56f98SSadaf Ebrahimi         /* The padding check involves a series of up to 256
1948*62c56f98SSadaf Ebrahimi          * consecutive memory reads at the end of the record
1949*62c56f98SSadaf Ebrahimi          * plaintext buffer. In order to hide the length and
1950*62c56f98SSadaf Ebrahimi          * validity of the padding, always perform exactly
1951*62c56f98SSadaf Ebrahimi          * `min(256,plaintext_len)` reads (but take into account
1952*62c56f98SSadaf Ebrahimi          * only the last `padlen` bytes for the padding check). */
1953*62c56f98SSadaf Ebrahimi         size_t pad_count = 0;
1954*62c56f98SSadaf Ebrahimi         volatile unsigned char * const check = data;
1955*62c56f98SSadaf Ebrahimi 
1956*62c56f98SSadaf Ebrahimi         /* Index of first padding byte; it has been ensured above
1957*62c56f98SSadaf Ebrahimi          * that the subtraction is safe. */
1958*62c56f98SSadaf Ebrahimi         size_t const padding_idx = rec->data_len - padlen;
1959*62c56f98SSadaf Ebrahimi         size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1960*62c56f98SSadaf Ebrahimi         size_t const start_idx = rec->data_len - num_checks;
1961*62c56f98SSadaf Ebrahimi         size_t idx;
1962*62c56f98SSadaf Ebrahimi 
1963*62c56f98SSadaf Ebrahimi         for (idx = start_idx; idx < rec->data_len; idx++) {
1964*62c56f98SSadaf Ebrahimi             /* pad_count += (idx >= padding_idx) &&
1965*62c56f98SSadaf Ebrahimi              *              (check[idx] == padlen - 1);
1966*62c56f98SSadaf Ebrahimi              */
1967*62c56f98SSadaf Ebrahimi             const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
1968*62c56f98SSadaf Ebrahimi             size_t increment = mbedtls_ct_size_if_else_0(a, 1);
1969*62c56f98SSadaf Ebrahimi             const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
1970*62c56f98SSadaf Ebrahimi             increment = mbedtls_ct_size_if_else_0(b, increment);
1971*62c56f98SSadaf Ebrahimi             pad_count += increment;
1972*62c56f98SSadaf Ebrahimi         }
1973*62c56f98SSadaf Ebrahimi         correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
1974*62c56f98SSadaf Ebrahimi 
1975*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DEBUG_ALL)
1976*62c56f98SSadaf Ebrahimi         if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
1977*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1978*62c56f98SSadaf Ebrahimi         }
1979*62c56f98SSadaf Ebrahimi #endif
1980*62c56f98SSadaf Ebrahimi         padlen = mbedtls_ct_size_if_else_0(correct, padlen);
1981*62c56f98SSadaf Ebrahimi 
1982*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1983*62c56f98SSadaf Ebrahimi 
1984*62c56f98SSadaf Ebrahimi         /* If the padding was found to be invalid, padlen == 0
1985*62c56f98SSadaf Ebrahimi          * and the subtraction is safe. If the padding was found valid,
1986*62c56f98SSadaf Ebrahimi          * padlen hasn't been changed and the previous assertion
1987*62c56f98SSadaf Ebrahimi          * data_len >= padlen still holds. */
1988*62c56f98SSadaf Ebrahimi         rec->data_len -= padlen;
1989*62c56f98SSadaf Ebrahimi     } else
1990*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
1991*62c56f98SSadaf Ebrahimi     {
1992*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1993*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1994*62c56f98SSadaf Ebrahimi     }
1995*62c56f98SSadaf Ebrahimi 
1996*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DEBUG_ALL)
1997*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1998*62c56f98SSadaf Ebrahimi                           data, rec->data_len);
1999*62c56f98SSadaf Ebrahimi #endif
2000*62c56f98SSadaf Ebrahimi 
2001*62c56f98SSadaf Ebrahimi     /*
2002*62c56f98SSadaf Ebrahimi      * Authenticate if not done yet.
2003*62c56f98SSadaf Ebrahimi      * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
2004*62c56f98SSadaf Ebrahimi      */
2005*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
2006*62c56f98SSadaf Ebrahimi     if (auth_done == 0) {
2007*62c56f98SSadaf Ebrahimi         unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2008*62c56f98SSadaf Ebrahimi         unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
2009*62c56f98SSadaf Ebrahimi 
2010*62c56f98SSadaf Ebrahimi         /* For CBC+MAC, If the initial value of padlen was such that
2011*62c56f98SSadaf Ebrahimi          * data_len < maclen + padlen + 1, then padlen
2012*62c56f98SSadaf Ebrahimi          * got reset to 1, and the initial check
2013*62c56f98SSadaf Ebrahimi          * data_len >= minlen + maclen + 1
2014*62c56f98SSadaf Ebrahimi          * guarantees that at this point we still
2015*62c56f98SSadaf Ebrahimi          * have at least data_len >= maclen.
2016*62c56f98SSadaf Ebrahimi          *
2017*62c56f98SSadaf Ebrahimi          * If the initial value of padlen was such that
2018*62c56f98SSadaf Ebrahimi          * data_len >= maclen + padlen + 1, then we have
2019*62c56f98SSadaf Ebrahimi          * subtracted either padlen + 1 (if the padding was correct)
2020*62c56f98SSadaf Ebrahimi          * or 0 (if the padding was incorrect) since then,
2021*62c56f98SSadaf Ebrahimi          * hence data_len >= maclen in any case.
2022*62c56f98SSadaf Ebrahimi          *
2023*62c56f98SSadaf Ebrahimi          * For stream ciphers, we checked above that
2024*62c56f98SSadaf Ebrahimi          * data_len >= maclen.
2025*62c56f98SSadaf Ebrahimi          */
2026*62c56f98SSadaf Ebrahimi         rec->data_len -= transform->maclen;
2027*62c56f98SSadaf Ebrahimi         ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2028*62c56f98SSadaf Ebrahimi                                          transform->tls_version,
2029*62c56f98SSadaf Ebrahimi                                          transform->taglen);
2030*62c56f98SSadaf Ebrahimi 
2031*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2032*62c56f98SSadaf Ebrahimi         /*
2033*62c56f98SSadaf Ebrahimi          * The next two sizes are the minimum and maximum values of
2034*62c56f98SSadaf Ebrahimi          * data_len over all padlen values.
2035*62c56f98SSadaf Ebrahimi          *
2036*62c56f98SSadaf Ebrahimi          * They're independent of padlen, since we previously did
2037*62c56f98SSadaf Ebrahimi          * data_len -= padlen.
2038*62c56f98SSadaf Ebrahimi          *
2039*62c56f98SSadaf Ebrahimi          * Note that max_len + maclen is never more than the buffer
2040*62c56f98SSadaf Ebrahimi          * length, as we previously did in_msglen -= maclen too.
2041*62c56f98SSadaf Ebrahimi          */
2042*62c56f98SSadaf Ebrahimi         const size_t max_len = rec->data_len + padlen;
2043*62c56f98SSadaf Ebrahimi         const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
2044*62c56f98SSadaf Ebrahimi 
2045*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
2046*62c56f98SSadaf Ebrahimi         ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2047*62c56f98SSadaf Ebrahimi                               transform->psa_mac_alg,
2048*62c56f98SSadaf Ebrahimi                               add_data, add_data_len,
2049*62c56f98SSadaf Ebrahimi                               data, rec->data_len, min_len, max_len,
2050*62c56f98SSadaf Ebrahimi                               mac_expect);
2051*62c56f98SSadaf Ebrahimi #else
2052*62c56f98SSadaf Ebrahimi         ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2053*62c56f98SSadaf Ebrahimi                               add_data, add_data_len,
2054*62c56f98SSadaf Ebrahimi                               data, rec->data_len, min_len, max_len,
2055*62c56f98SSadaf Ebrahimi                               mac_expect);
2056*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
2057*62c56f98SSadaf Ebrahimi         if (ret != 0) {
2058*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
2059*62c56f98SSadaf Ebrahimi             goto hmac_failed_etm_disabled;
2060*62c56f98SSadaf Ebrahimi         }
2061*62c56f98SSadaf Ebrahimi 
2062*62c56f98SSadaf Ebrahimi         mbedtls_ct_memcpy_offset(mac_peer, data,
2063*62c56f98SSadaf Ebrahimi                                  rec->data_len,
2064*62c56f98SSadaf Ebrahimi                                  min_len, max_len,
2065*62c56f98SSadaf Ebrahimi                                  transform->maclen);
2066*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2067*62c56f98SSadaf Ebrahimi 
2068*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DEBUG_ALL)
2069*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2070*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "message  mac", mac_peer, transform->maclen);
2071*62c56f98SSadaf Ebrahimi #endif
2072*62c56f98SSadaf Ebrahimi 
2073*62c56f98SSadaf Ebrahimi         if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2074*62c56f98SSadaf Ebrahimi                               transform->maclen) != 0) {
2075*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DEBUG_ALL)
2076*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
2077*62c56f98SSadaf Ebrahimi #endif
2078*62c56f98SSadaf Ebrahimi             correct = MBEDTLS_CT_FALSE;
2079*62c56f98SSadaf Ebrahimi         }
2080*62c56f98SSadaf Ebrahimi         auth_done++;
2081*62c56f98SSadaf Ebrahimi 
2082*62c56f98SSadaf Ebrahimi hmac_failed_etm_disabled:
2083*62c56f98SSadaf Ebrahimi         mbedtls_platform_zeroize(mac_peer, transform->maclen);
2084*62c56f98SSadaf Ebrahimi         mbedtls_platform_zeroize(mac_expect, transform->maclen);
2085*62c56f98SSadaf Ebrahimi         if (ret != 0) {
2086*62c56f98SSadaf Ebrahimi             return ret;
2087*62c56f98SSadaf Ebrahimi         }
2088*62c56f98SSadaf Ebrahimi     }
2089*62c56f98SSadaf Ebrahimi 
2090*62c56f98SSadaf Ebrahimi     /*
2091*62c56f98SSadaf Ebrahimi      * Finally check the correct flag
2092*62c56f98SSadaf Ebrahimi      */
2093*62c56f98SSadaf Ebrahimi     if (correct == MBEDTLS_CT_FALSE) {
2094*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_MAC;
2095*62c56f98SSadaf Ebrahimi     }
2096*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2097*62c56f98SSadaf Ebrahimi 
2098*62c56f98SSadaf Ebrahimi     /* Make extra sure authentication was performed, exactly once */
2099*62c56f98SSadaf Ebrahimi     if (auth_done != 1) {
2100*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2101*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2102*62c56f98SSadaf Ebrahimi     }
2103*62c56f98SSadaf Ebrahimi 
2104*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
2105*62c56f98SSadaf Ebrahimi     if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2106*62c56f98SSadaf Ebrahimi         /* Remove inner padding and infer true content type. */
2107*62c56f98SSadaf Ebrahimi         ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2108*62c56f98SSadaf Ebrahimi                                         &rec->type);
2109*62c56f98SSadaf Ebrahimi 
2110*62c56f98SSadaf Ebrahimi         if (ret != 0) {
2111*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
2112*62c56f98SSadaf Ebrahimi         }
2113*62c56f98SSadaf Ebrahimi     }
2114*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2115*62c56f98SSadaf Ebrahimi 
2116*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2117*62c56f98SSadaf Ebrahimi     if (rec->cid_len != 0) {
2118*62c56f98SSadaf Ebrahimi         ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2119*62c56f98SSadaf Ebrahimi                                         &rec->type);
2120*62c56f98SSadaf Ebrahimi         if (ret != 0) {
2121*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
2122*62c56f98SSadaf Ebrahimi         }
2123*62c56f98SSadaf Ebrahimi     }
2124*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
2125*62c56f98SSadaf Ebrahimi 
2126*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
2127*62c56f98SSadaf Ebrahimi 
2128*62c56f98SSadaf Ebrahimi     return 0;
2129*62c56f98SSadaf Ebrahimi }
2130*62c56f98SSadaf Ebrahimi 
2131*62c56f98SSadaf Ebrahimi #undef MAC_NONE
2132*62c56f98SSadaf Ebrahimi #undef MAC_PLAINTEXT
2133*62c56f98SSadaf Ebrahimi #undef MAC_CIPHERTEXT
2134*62c56f98SSadaf Ebrahimi 
2135*62c56f98SSadaf Ebrahimi /*
2136*62c56f98SSadaf Ebrahimi  * Fill the input message buffer by appending data to it.
2137*62c56f98SSadaf Ebrahimi  * The amount of data already fetched is in ssl->in_left.
2138*62c56f98SSadaf Ebrahimi  *
2139*62c56f98SSadaf Ebrahimi  * If we return 0, is it guaranteed that (at least) nb_want bytes are
2140*62c56f98SSadaf Ebrahimi  * available (from this read and/or a previous one). Otherwise, an error code
2141*62c56f98SSadaf Ebrahimi  * is returned (possibly EOF or WANT_READ).
2142*62c56f98SSadaf Ebrahimi  *
2143*62c56f98SSadaf Ebrahimi  * With stream transport (TLS) on success ssl->in_left == nb_want, but
2144*62c56f98SSadaf Ebrahimi  * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2145*62c56f98SSadaf Ebrahimi  * since we always read a whole datagram at once.
2146*62c56f98SSadaf Ebrahimi  *
2147*62c56f98SSadaf Ebrahimi  * For DTLS, it is up to the caller to set ssl->next_record_offset when
2148*62c56f98SSadaf Ebrahimi  * they're done reading a record.
2149*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_fetch_input(mbedtls_ssl_context * ssl,size_t nb_want)2150*62c56f98SSadaf Ebrahimi int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
2151*62c56f98SSadaf Ebrahimi {
2152*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2153*62c56f98SSadaf Ebrahimi     size_t len;
2154*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2155*62c56f98SSadaf Ebrahimi     size_t in_buf_len = ssl->in_buf_len;
2156*62c56f98SSadaf Ebrahimi #else
2157*62c56f98SSadaf Ebrahimi     size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2158*62c56f98SSadaf Ebrahimi #endif
2159*62c56f98SSadaf Ebrahimi 
2160*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
2161*62c56f98SSadaf Ebrahimi 
2162*62c56f98SSadaf Ebrahimi     if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2163*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2164*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2165*62c56f98SSadaf Ebrahimi     }
2166*62c56f98SSadaf Ebrahimi 
2167*62c56f98SSadaf Ebrahimi     if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2168*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2169*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2170*62c56f98SSadaf Ebrahimi     }
2171*62c56f98SSadaf Ebrahimi 
2172*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2173*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2174*62c56f98SSadaf Ebrahimi         uint32_t timeout;
2175*62c56f98SSadaf Ebrahimi 
2176*62c56f98SSadaf Ebrahimi         /*
2177*62c56f98SSadaf Ebrahimi          * The point is, we need to always read a full datagram at once, so we
2178*62c56f98SSadaf Ebrahimi          * sometimes read more then requested, and handle the additional data.
2179*62c56f98SSadaf Ebrahimi          * It could be the rest of the current record (while fetching the
2180*62c56f98SSadaf Ebrahimi          * header) and/or some other records in the same datagram.
2181*62c56f98SSadaf Ebrahimi          */
2182*62c56f98SSadaf Ebrahimi 
2183*62c56f98SSadaf Ebrahimi         /*
2184*62c56f98SSadaf Ebrahimi          * Move to the next record in the already read datagram if applicable
2185*62c56f98SSadaf Ebrahimi          */
2186*62c56f98SSadaf Ebrahimi         if (ssl->next_record_offset != 0) {
2187*62c56f98SSadaf Ebrahimi             if (ssl->in_left < ssl->next_record_offset) {
2188*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2189*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2190*62c56f98SSadaf Ebrahimi             }
2191*62c56f98SSadaf Ebrahimi 
2192*62c56f98SSadaf Ebrahimi             ssl->in_left -= ssl->next_record_offset;
2193*62c56f98SSadaf Ebrahimi 
2194*62c56f98SSadaf Ebrahimi             if (ssl->in_left != 0) {
2195*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2196*62c56f98SSadaf Ebrahimi                                           MBEDTLS_PRINTF_SIZET,
2197*62c56f98SSadaf Ebrahimi                                           ssl->next_record_offset));
2198*62c56f98SSadaf Ebrahimi                 memmove(ssl->in_hdr,
2199*62c56f98SSadaf Ebrahimi                         ssl->in_hdr + ssl->next_record_offset,
2200*62c56f98SSadaf Ebrahimi                         ssl->in_left);
2201*62c56f98SSadaf Ebrahimi             }
2202*62c56f98SSadaf Ebrahimi 
2203*62c56f98SSadaf Ebrahimi             ssl->next_record_offset = 0;
2204*62c56f98SSadaf Ebrahimi         }
2205*62c56f98SSadaf Ebrahimi 
2206*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2207*62c56f98SSadaf Ebrahimi                                   ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2208*62c56f98SSadaf Ebrahimi                                   ssl->in_left, nb_want));
2209*62c56f98SSadaf Ebrahimi 
2210*62c56f98SSadaf Ebrahimi         /*
2211*62c56f98SSadaf Ebrahimi          * Done if we already have enough data.
2212*62c56f98SSadaf Ebrahimi          */
2213*62c56f98SSadaf Ebrahimi         if (nb_want <= ssl->in_left) {
2214*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2215*62c56f98SSadaf Ebrahimi             return 0;
2216*62c56f98SSadaf Ebrahimi         }
2217*62c56f98SSadaf Ebrahimi 
2218*62c56f98SSadaf Ebrahimi         /*
2219*62c56f98SSadaf Ebrahimi          * A record can't be split across datagrams. If we need to read but
2220*62c56f98SSadaf Ebrahimi          * are not at the beginning of a new record, the caller did something
2221*62c56f98SSadaf Ebrahimi          * wrong.
2222*62c56f98SSadaf Ebrahimi          */
2223*62c56f98SSadaf Ebrahimi         if (ssl->in_left != 0) {
2224*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2225*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2226*62c56f98SSadaf Ebrahimi         }
2227*62c56f98SSadaf Ebrahimi 
2228*62c56f98SSadaf Ebrahimi         /*
2229*62c56f98SSadaf Ebrahimi          * Don't even try to read if time's out already.
2230*62c56f98SSadaf Ebrahimi          * This avoids by-passing the timer when repeatedly receiving messages
2231*62c56f98SSadaf Ebrahimi          * that will end up being dropped.
2232*62c56f98SSadaf Ebrahimi          */
2233*62c56f98SSadaf Ebrahimi         if (mbedtls_ssl_check_timer(ssl) != 0) {
2234*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
2235*62c56f98SSadaf Ebrahimi             ret = MBEDTLS_ERR_SSL_TIMEOUT;
2236*62c56f98SSadaf Ebrahimi         } else {
2237*62c56f98SSadaf Ebrahimi             len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
2238*62c56f98SSadaf Ebrahimi 
2239*62c56f98SSadaf Ebrahimi             if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
2240*62c56f98SSadaf Ebrahimi                 timeout = ssl->handshake->retransmit_timeout;
2241*62c56f98SSadaf Ebrahimi             } else {
2242*62c56f98SSadaf Ebrahimi                 timeout = ssl->conf->read_timeout;
2243*62c56f98SSadaf Ebrahimi             }
2244*62c56f98SSadaf Ebrahimi 
2245*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
2246*62c56f98SSadaf Ebrahimi 
2247*62c56f98SSadaf Ebrahimi             if (ssl->f_recv_timeout != NULL) {
2248*62c56f98SSadaf Ebrahimi                 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2249*62c56f98SSadaf Ebrahimi                                           timeout);
2250*62c56f98SSadaf Ebrahimi             } else {
2251*62c56f98SSadaf Ebrahimi                 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2252*62c56f98SSadaf Ebrahimi             }
2253*62c56f98SSadaf Ebrahimi 
2254*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
2255*62c56f98SSadaf Ebrahimi 
2256*62c56f98SSadaf Ebrahimi             if (ret == 0) {
2257*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_CONN_EOF;
2258*62c56f98SSadaf Ebrahimi             }
2259*62c56f98SSadaf Ebrahimi         }
2260*62c56f98SSadaf Ebrahimi 
2261*62c56f98SSadaf Ebrahimi         if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2262*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2263*62c56f98SSadaf Ebrahimi             mbedtls_ssl_set_timer(ssl, 0);
2264*62c56f98SSadaf Ebrahimi 
2265*62c56f98SSadaf Ebrahimi             if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2266*62c56f98SSadaf Ebrahimi                 if (ssl_double_retransmit_timeout(ssl) != 0) {
2267*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2268*62c56f98SSadaf Ebrahimi                     return MBEDTLS_ERR_SSL_TIMEOUT;
2269*62c56f98SSadaf Ebrahimi                 }
2270*62c56f98SSadaf Ebrahimi 
2271*62c56f98SSadaf Ebrahimi                 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2272*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2273*62c56f98SSadaf Ebrahimi                     return ret;
2274*62c56f98SSadaf Ebrahimi                 }
2275*62c56f98SSadaf Ebrahimi 
2276*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_WANT_READ;
2277*62c56f98SSadaf Ebrahimi             }
2278*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
2279*62c56f98SSadaf Ebrahimi             else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2280*62c56f98SSadaf Ebrahimi                      ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2281*62c56f98SSadaf Ebrahimi                 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2282*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2283*62c56f98SSadaf Ebrahimi                                           ret);
2284*62c56f98SSadaf Ebrahimi                     return ret;
2285*62c56f98SSadaf Ebrahimi                 }
2286*62c56f98SSadaf Ebrahimi 
2287*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_WANT_READ;
2288*62c56f98SSadaf Ebrahimi             }
2289*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
2290*62c56f98SSadaf Ebrahimi         }
2291*62c56f98SSadaf Ebrahimi 
2292*62c56f98SSadaf Ebrahimi         if (ret < 0) {
2293*62c56f98SSadaf Ebrahimi             return ret;
2294*62c56f98SSadaf Ebrahimi         }
2295*62c56f98SSadaf Ebrahimi 
2296*62c56f98SSadaf Ebrahimi         ssl->in_left = ret;
2297*62c56f98SSadaf Ebrahimi     } else
2298*62c56f98SSadaf Ebrahimi #endif
2299*62c56f98SSadaf Ebrahimi     {
2300*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2301*62c56f98SSadaf Ebrahimi                                   ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2302*62c56f98SSadaf Ebrahimi                                   ssl->in_left, nb_want));
2303*62c56f98SSadaf Ebrahimi 
2304*62c56f98SSadaf Ebrahimi         while (ssl->in_left < nb_want) {
2305*62c56f98SSadaf Ebrahimi             len = nb_want - ssl->in_left;
2306*62c56f98SSadaf Ebrahimi 
2307*62c56f98SSadaf Ebrahimi             if (mbedtls_ssl_check_timer(ssl) != 0) {
2308*62c56f98SSadaf Ebrahimi                 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2309*62c56f98SSadaf Ebrahimi             } else {
2310*62c56f98SSadaf Ebrahimi                 if (ssl->f_recv_timeout != NULL) {
2311*62c56f98SSadaf Ebrahimi                     ret = ssl->f_recv_timeout(ssl->p_bio,
2312*62c56f98SSadaf Ebrahimi                                               ssl->in_hdr + ssl->in_left, len,
2313*62c56f98SSadaf Ebrahimi                                               ssl->conf->read_timeout);
2314*62c56f98SSadaf Ebrahimi                 } else {
2315*62c56f98SSadaf Ebrahimi                     ret = ssl->f_recv(ssl->p_bio,
2316*62c56f98SSadaf Ebrahimi                                       ssl->in_hdr + ssl->in_left, len);
2317*62c56f98SSadaf Ebrahimi                 }
2318*62c56f98SSadaf Ebrahimi             }
2319*62c56f98SSadaf Ebrahimi 
2320*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2321*62c56f98SSadaf Ebrahimi                                       ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2322*62c56f98SSadaf Ebrahimi                                       ssl->in_left, nb_want));
2323*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
2324*62c56f98SSadaf Ebrahimi 
2325*62c56f98SSadaf Ebrahimi             if (ret == 0) {
2326*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_CONN_EOF;
2327*62c56f98SSadaf Ebrahimi             }
2328*62c56f98SSadaf Ebrahimi 
2329*62c56f98SSadaf Ebrahimi             if (ret < 0) {
2330*62c56f98SSadaf Ebrahimi                 return ret;
2331*62c56f98SSadaf Ebrahimi             }
2332*62c56f98SSadaf Ebrahimi 
2333*62c56f98SSadaf Ebrahimi             if ((size_t) ret > len) {
2334*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1,
2335*62c56f98SSadaf Ebrahimi                                       ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2336*62c56f98SSadaf Ebrahimi                                        " were requested",
2337*62c56f98SSadaf Ebrahimi                                        ret, len));
2338*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2339*62c56f98SSadaf Ebrahimi             }
2340*62c56f98SSadaf Ebrahimi 
2341*62c56f98SSadaf Ebrahimi             ssl->in_left += ret;
2342*62c56f98SSadaf Ebrahimi         }
2343*62c56f98SSadaf Ebrahimi     }
2344*62c56f98SSadaf Ebrahimi 
2345*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2346*62c56f98SSadaf Ebrahimi 
2347*62c56f98SSadaf Ebrahimi     return 0;
2348*62c56f98SSadaf Ebrahimi }
2349*62c56f98SSadaf Ebrahimi 
2350*62c56f98SSadaf Ebrahimi /*
2351*62c56f98SSadaf Ebrahimi  * Flush any data not yet written
2352*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_flush_output(mbedtls_ssl_context * ssl)2353*62c56f98SSadaf Ebrahimi int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
2354*62c56f98SSadaf Ebrahimi {
2355*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2356*62c56f98SSadaf Ebrahimi     unsigned char *buf;
2357*62c56f98SSadaf Ebrahimi 
2358*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
2359*62c56f98SSadaf Ebrahimi 
2360*62c56f98SSadaf Ebrahimi     if (ssl->f_send == NULL) {
2361*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2362*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2363*62c56f98SSadaf Ebrahimi     }
2364*62c56f98SSadaf Ebrahimi 
2365*62c56f98SSadaf Ebrahimi     /* Avoid incrementing counter if data is flushed */
2366*62c56f98SSadaf Ebrahimi     if (ssl->out_left == 0) {
2367*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2368*62c56f98SSadaf Ebrahimi         return 0;
2369*62c56f98SSadaf Ebrahimi     }
2370*62c56f98SSadaf Ebrahimi 
2371*62c56f98SSadaf Ebrahimi     while (ssl->out_left > 0) {
2372*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2373*62c56f98SSadaf Ebrahimi                                   ", out_left: %" MBEDTLS_PRINTF_SIZET,
2374*62c56f98SSadaf Ebrahimi                                   mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
2375*62c56f98SSadaf Ebrahimi 
2376*62c56f98SSadaf Ebrahimi         buf = ssl->out_hdr - ssl->out_left;
2377*62c56f98SSadaf Ebrahimi         ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
2378*62c56f98SSadaf Ebrahimi 
2379*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
2380*62c56f98SSadaf Ebrahimi 
2381*62c56f98SSadaf Ebrahimi         if (ret <= 0) {
2382*62c56f98SSadaf Ebrahimi             return ret;
2383*62c56f98SSadaf Ebrahimi         }
2384*62c56f98SSadaf Ebrahimi 
2385*62c56f98SSadaf Ebrahimi         if ((size_t) ret > ssl->out_left) {
2386*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
2387*62c56f98SSadaf Ebrahimi                                   ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2388*62c56f98SSadaf Ebrahimi                                    " bytes were sent",
2389*62c56f98SSadaf Ebrahimi                                    ret, ssl->out_left));
2390*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2391*62c56f98SSadaf Ebrahimi         }
2392*62c56f98SSadaf Ebrahimi 
2393*62c56f98SSadaf Ebrahimi         ssl->out_left -= ret;
2394*62c56f98SSadaf Ebrahimi     }
2395*62c56f98SSadaf Ebrahimi 
2396*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2397*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2398*62c56f98SSadaf Ebrahimi         ssl->out_hdr = ssl->out_buf;
2399*62c56f98SSadaf Ebrahimi     } else
2400*62c56f98SSadaf Ebrahimi #endif
2401*62c56f98SSadaf Ebrahimi     {
2402*62c56f98SSadaf Ebrahimi         ssl->out_hdr = ssl->out_buf + 8;
2403*62c56f98SSadaf Ebrahimi     }
2404*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
2405*62c56f98SSadaf Ebrahimi 
2406*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2407*62c56f98SSadaf Ebrahimi 
2408*62c56f98SSadaf Ebrahimi     return 0;
2409*62c56f98SSadaf Ebrahimi }
2410*62c56f98SSadaf Ebrahimi 
2411*62c56f98SSadaf Ebrahimi /*
2412*62c56f98SSadaf Ebrahimi  * Functions to handle the DTLS retransmission state machine
2413*62c56f98SSadaf Ebrahimi  */
2414*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2415*62c56f98SSadaf Ebrahimi /*
2416*62c56f98SSadaf Ebrahimi  * Append current handshake message to current outgoing flight
2417*62c56f98SSadaf Ebrahimi  */
2418*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_flight_append(mbedtls_ssl_context * ssl)2419*62c56f98SSadaf Ebrahimi static int ssl_flight_append(mbedtls_ssl_context *ssl)
2420*62c56f98SSadaf Ebrahimi {
2421*62c56f98SSadaf Ebrahimi     mbedtls_ssl_flight_item *msg;
2422*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2423*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2424*62c56f98SSadaf Ebrahimi                           ssl->out_msg, ssl->out_msglen);
2425*62c56f98SSadaf Ebrahimi 
2426*62c56f98SSadaf Ebrahimi     /* Allocate space for current message */
2427*62c56f98SSadaf Ebrahimi     if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2428*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2429*62c56f98SSadaf Ebrahimi                                   sizeof(mbedtls_ssl_flight_item)));
2430*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2431*62c56f98SSadaf Ebrahimi     }
2432*62c56f98SSadaf Ebrahimi 
2433*62c56f98SSadaf Ebrahimi     if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2434*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2435*62c56f98SSadaf Ebrahimi                                   ssl->out_msglen));
2436*62c56f98SSadaf Ebrahimi         mbedtls_free(msg);
2437*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2438*62c56f98SSadaf Ebrahimi     }
2439*62c56f98SSadaf Ebrahimi 
2440*62c56f98SSadaf Ebrahimi     /* Copy current handshake message with headers */
2441*62c56f98SSadaf Ebrahimi     memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
2442*62c56f98SSadaf Ebrahimi     msg->len = ssl->out_msglen;
2443*62c56f98SSadaf Ebrahimi     msg->type = ssl->out_msgtype;
2444*62c56f98SSadaf Ebrahimi     msg->next = NULL;
2445*62c56f98SSadaf Ebrahimi 
2446*62c56f98SSadaf Ebrahimi     /* Append to the current flight */
2447*62c56f98SSadaf Ebrahimi     if (ssl->handshake->flight == NULL) {
2448*62c56f98SSadaf Ebrahimi         ssl->handshake->flight = msg;
2449*62c56f98SSadaf Ebrahimi     } else {
2450*62c56f98SSadaf Ebrahimi         mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
2451*62c56f98SSadaf Ebrahimi         while (cur->next != NULL) {
2452*62c56f98SSadaf Ebrahimi             cur = cur->next;
2453*62c56f98SSadaf Ebrahimi         }
2454*62c56f98SSadaf Ebrahimi         cur->next = msg;
2455*62c56f98SSadaf Ebrahimi     }
2456*62c56f98SSadaf Ebrahimi 
2457*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2458*62c56f98SSadaf Ebrahimi     return 0;
2459*62c56f98SSadaf Ebrahimi }
2460*62c56f98SSadaf Ebrahimi 
2461*62c56f98SSadaf Ebrahimi /*
2462*62c56f98SSadaf Ebrahimi  * Free the current flight of handshake messages
2463*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_flight_free(mbedtls_ssl_flight_item * flight)2464*62c56f98SSadaf Ebrahimi void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
2465*62c56f98SSadaf Ebrahimi {
2466*62c56f98SSadaf Ebrahimi     mbedtls_ssl_flight_item *cur = flight;
2467*62c56f98SSadaf Ebrahimi     mbedtls_ssl_flight_item *next;
2468*62c56f98SSadaf Ebrahimi 
2469*62c56f98SSadaf Ebrahimi     while (cur != NULL) {
2470*62c56f98SSadaf Ebrahimi         next = cur->next;
2471*62c56f98SSadaf Ebrahimi 
2472*62c56f98SSadaf Ebrahimi         mbedtls_free(cur->p);
2473*62c56f98SSadaf Ebrahimi         mbedtls_free(cur);
2474*62c56f98SSadaf Ebrahimi 
2475*62c56f98SSadaf Ebrahimi         cur = next;
2476*62c56f98SSadaf Ebrahimi     }
2477*62c56f98SSadaf Ebrahimi }
2478*62c56f98SSadaf Ebrahimi 
2479*62c56f98SSadaf Ebrahimi /*
2480*62c56f98SSadaf Ebrahimi  * Swap transform_out and out_ctr with the alternative ones
2481*62c56f98SSadaf Ebrahimi  */
2482*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_swap_epochs(mbedtls_ssl_context * ssl)2483*62c56f98SSadaf Ebrahimi static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
2484*62c56f98SSadaf Ebrahimi {
2485*62c56f98SSadaf Ebrahimi     mbedtls_ssl_transform *tmp_transform;
2486*62c56f98SSadaf Ebrahimi     unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
2487*62c56f98SSadaf Ebrahimi 
2488*62c56f98SSadaf Ebrahimi     if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2489*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2490*62c56f98SSadaf Ebrahimi         return 0;
2491*62c56f98SSadaf Ebrahimi     }
2492*62c56f98SSadaf Ebrahimi 
2493*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
2494*62c56f98SSadaf Ebrahimi 
2495*62c56f98SSadaf Ebrahimi     /* Swap transforms */
2496*62c56f98SSadaf Ebrahimi     tmp_transform                     = ssl->transform_out;
2497*62c56f98SSadaf Ebrahimi     ssl->transform_out                = ssl->handshake->alt_transform_out;
2498*62c56f98SSadaf Ebrahimi     ssl->handshake->alt_transform_out = tmp_transform;
2499*62c56f98SSadaf Ebrahimi 
2500*62c56f98SSadaf Ebrahimi     /* Swap epoch + sequence_number */
2501*62c56f98SSadaf Ebrahimi     memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2502*62c56f98SSadaf Ebrahimi     memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2503*62c56f98SSadaf Ebrahimi            sizeof(ssl->cur_out_ctr));
2504*62c56f98SSadaf Ebrahimi     memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2505*62c56f98SSadaf Ebrahimi            sizeof(ssl->handshake->alt_out_ctr));
2506*62c56f98SSadaf Ebrahimi 
2507*62c56f98SSadaf Ebrahimi     /* Adjust to the newly activated transform */
2508*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
2509*62c56f98SSadaf Ebrahimi 
2510*62c56f98SSadaf Ebrahimi     return 0;
2511*62c56f98SSadaf Ebrahimi }
2512*62c56f98SSadaf Ebrahimi 
2513*62c56f98SSadaf Ebrahimi /*
2514*62c56f98SSadaf Ebrahimi  * Retransmit the current flight of messages.
2515*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_resend(mbedtls_ssl_context * ssl)2516*62c56f98SSadaf Ebrahimi int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
2517*62c56f98SSadaf Ebrahimi {
2518*62c56f98SSadaf Ebrahimi     int ret = 0;
2519*62c56f98SSadaf Ebrahimi 
2520*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
2521*62c56f98SSadaf Ebrahimi 
2522*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_flight_transmit(ssl);
2523*62c56f98SSadaf Ebrahimi 
2524*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
2525*62c56f98SSadaf Ebrahimi 
2526*62c56f98SSadaf Ebrahimi     return ret;
2527*62c56f98SSadaf Ebrahimi }
2528*62c56f98SSadaf Ebrahimi 
2529*62c56f98SSadaf Ebrahimi /*
2530*62c56f98SSadaf Ebrahimi  * Transmit or retransmit the current flight of messages.
2531*62c56f98SSadaf Ebrahimi  *
2532*62c56f98SSadaf Ebrahimi  * Need to remember the current message in case flush_output returns
2533*62c56f98SSadaf Ebrahimi  * WANT_WRITE, causing us to exit this function and come back later.
2534*62c56f98SSadaf Ebrahimi  * This function must be called until state is no longer SENDING.
2535*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_flight_transmit(mbedtls_ssl_context * ssl)2536*62c56f98SSadaf Ebrahimi int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
2537*62c56f98SSadaf Ebrahimi {
2538*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2539*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
2540*62c56f98SSadaf Ebrahimi 
2541*62c56f98SSadaf Ebrahimi     if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2542*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
2543*62c56f98SSadaf Ebrahimi 
2544*62c56f98SSadaf Ebrahimi         ssl->handshake->cur_msg = ssl->handshake->flight;
2545*62c56f98SSadaf Ebrahimi         ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
2546*62c56f98SSadaf Ebrahimi         ret = ssl_swap_epochs(ssl);
2547*62c56f98SSadaf Ebrahimi         if (ret != 0) {
2548*62c56f98SSadaf Ebrahimi             return ret;
2549*62c56f98SSadaf Ebrahimi         }
2550*62c56f98SSadaf Ebrahimi 
2551*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
2552*62c56f98SSadaf Ebrahimi     }
2553*62c56f98SSadaf Ebrahimi 
2554*62c56f98SSadaf Ebrahimi     while (ssl->handshake->cur_msg != NULL) {
2555*62c56f98SSadaf Ebrahimi         size_t max_frag_len;
2556*62c56f98SSadaf Ebrahimi         const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
2557*62c56f98SSadaf Ebrahimi 
2558*62c56f98SSadaf Ebrahimi         int const is_finished =
2559*62c56f98SSadaf Ebrahimi             (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2560*62c56f98SSadaf Ebrahimi              cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
2561*62c56f98SSadaf Ebrahimi 
2562*62c56f98SSadaf Ebrahimi         int const force_flush = ssl->disable_datagram_packing == 1 ?
2563*62c56f98SSadaf Ebrahimi                                 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2564*62c56f98SSadaf Ebrahimi 
2565*62c56f98SSadaf Ebrahimi         /* Swap epochs before sending Finished: we can't do it after
2566*62c56f98SSadaf Ebrahimi          * sending ChangeCipherSpec, in case write returns WANT_READ.
2567*62c56f98SSadaf Ebrahimi          * Must be done before copying, may change out_msg pointer */
2568*62c56f98SSadaf Ebrahimi         if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2569*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2570*62c56f98SSadaf Ebrahimi             ret = ssl_swap_epochs(ssl);
2571*62c56f98SSadaf Ebrahimi             if (ret != 0) {
2572*62c56f98SSadaf Ebrahimi                 return ret;
2573*62c56f98SSadaf Ebrahimi             }
2574*62c56f98SSadaf Ebrahimi         }
2575*62c56f98SSadaf Ebrahimi 
2576*62c56f98SSadaf Ebrahimi         ret = ssl_get_remaining_payload_in_datagram(ssl);
2577*62c56f98SSadaf Ebrahimi         if (ret < 0) {
2578*62c56f98SSadaf Ebrahimi             return ret;
2579*62c56f98SSadaf Ebrahimi         }
2580*62c56f98SSadaf Ebrahimi         max_frag_len = (size_t) ret;
2581*62c56f98SSadaf Ebrahimi 
2582*62c56f98SSadaf Ebrahimi         /* CCS is copied as is, while HS messages may need fragmentation */
2583*62c56f98SSadaf Ebrahimi         if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2584*62c56f98SSadaf Ebrahimi             if (max_frag_len == 0) {
2585*62c56f98SSadaf Ebrahimi                 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2586*62c56f98SSadaf Ebrahimi                     return ret;
2587*62c56f98SSadaf Ebrahimi                 }
2588*62c56f98SSadaf Ebrahimi 
2589*62c56f98SSadaf Ebrahimi                 continue;
2590*62c56f98SSadaf Ebrahimi             }
2591*62c56f98SSadaf Ebrahimi 
2592*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_msg, cur->p, cur->len);
2593*62c56f98SSadaf Ebrahimi             ssl->out_msglen  = cur->len;
2594*62c56f98SSadaf Ebrahimi             ssl->out_msgtype = cur->type;
2595*62c56f98SSadaf Ebrahimi 
2596*62c56f98SSadaf Ebrahimi             /* Update position inside current message */
2597*62c56f98SSadaf Ebrahimi             ssl->handshake->cur_msg_p += cur->len;
2598*62c56f98SSadaf Ebrahimi         } else {
2599*62c56f98SSadaf Ebrahimi             const unsigned char * const p = ssl->handshake->cur_msg_p;
2600*62c56f98SSadaf Ebrahimi             const size_t hs_len = cur->len - 12;
2601*62c56f98SSadaf Ebrahimi             const size_t frag_off = p - (cur->p + 12);
2602*62c56f98SSadaf Ebrahimi             const size_t rem_len = hs_len - frag_off;
2603*62c56f98SSadaf Ebrahimi             size_t cur_hs_frag_len, max_hs_frag_len;
2604*62c56f98SSadaf Ebrahimi 
2605*62c56f98SSadaf Ebrahimi             if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2606*62c56f98SSadaf Ebrahimi                 if (is_finished) {
2607*62c56f98SSadaf Ebrahimi                     ret = ssl_swap_epochs(ssl);
2608*62c56f98SSadaf Ebrahimi                     if (ret != 0) {
2609*62c56f98SSadaf Ebrahimi                         return ret;
2610*62c56f98SSadaf Ebrahimi                     }
2611*62c56f98SSadaf Ebrahimi                 }
2612*62c56f98SSadaf Ebrahimi 
2613*62c56f98SSadaf Ebrahimi                 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2614*62c56f98SSadaf Ebrahimi                     return ret;
2615*62c56f98SSadaf Ebrahimi                 }
2616*62c56f98SSadaf Ebrahimi 
2617*62c56f98SSadaf Ebrahimi                 continue;
2618*62c56f98SSadaf Ebrahimi             }
2619*62c56f98SSadaf Ebrahimi             max_hs_frag_len = max_frag_len - 12;
2620*62c56f98SSadaf Ebrahimi 
2621*62c56f98SSadaf Ebrahimi             cur_hs_frag_len = rem_len > max_hs_frag_len ?
2622*62c56f98SSadaf Ebrahimi                               max_hs_frag_len : rem_len;
2623*62c56f98SSadaf Ebrahimi 
2624*62c56f98SSadaf Ebrahimi             if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2625*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2626*62c56f98SSadaf Ebrahimi                                           (unsigned) cur_hs_frag_len,
2627*62c56f98SSadaf Ebrahimi                                           (unsigned) max_hs_frag_len));
2628*62c56f98SSadaf Ebrahimi             }
2629*62c56f98SSadaf Ebrahimi 
2630*62c56f98SSadaf Ebrahimi             /* Messages are stored with handshake headers as if not fragmented,
2631*62c56f98SSadaf Ebrahimi              * copy beginning of headers then fill fragmentation fields.
2632*62c56f98SSadaf Ebrahimi              * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2633*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_msg, cur->p, 6);
2634*62c56f98SSadaf Ebrahimi 
2635*62c56f98SSadaf Ebrahimi             ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2636*62c56f98SSadaf Ebrahimi             ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2637*62c56f98SSadaf Ebrahimi             ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
2638*62c56f98SSadaf Ebrahimi 
2639*62c56f98SSadaf Ebrahimi             ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2640*62c56f98SSadaf Ebrahimi             ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2641*62c56f98SSadaf Ebrahimi             ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
2642*62c56f98SSadaf Ebrahimi 
2643*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
2644*62c56f98SSadaf Ebrahimi 
2645*62c56f98SSadaf Ebrahimi             /* Copy the handshake message content and set records fields */
2646*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
2647*62c56f98SSadaf Ebrahimi             ssl->out_msglen = cur_hs_frag_len + 12;
2648*62c56f98SSadaf Ebrahimi             ssl->out_msgtype = cur->type;
2649*62c56f98SSadaf Ebrahimi 
2650*62c56f98SSadaf Ebrahimi             /* Update position inside current message */
2651*62c56f98SSadaf Ebrahimi             ssl->handshake->cur_msg_p += cur_hs_frag_len;
2652*62c56f98SSadaf Ebrahimi         }
2653*62c56f98SSadaf Ebrahimi 
2654*62c56f98SSadaf Ebrahimi         /* If done with the current message move to the next one if any */
2655*62c56f98SSadaf Ebrahimi         if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2656*62c56f98SSadaf Ebrahimi             if (cur->next != NULL) {
2657*62c56f98SSadaf Ebrahimi                 ssl->handshake->cur_msg = cur->next;
2658*62c56f98SSadaf Ebrahimi                 ssl->handshake->cur_msg_p = cur->next->p + 12;
2659*62c56f98SSadaf Ebrahimi             } else {
2660*62c56f98SSadaf Ebrahimi                 ssl->handshake->cur_msg = NULL;
2661*62c56f98SSadaf Ebrahimi                 ssl->handshake->cur_msg_p = NULL;
2662*62c56f98SSadaf Ebrahimi             }
2663*62c56f98SSadaf Ebrahimi         }
2664*62c56f98SSadaf Ebrahimi 
2665*62c56f98SSadaf Ebrahimi         /* Actually send the message out */
2666*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2667*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2668*62c56f98SSadaf Ebrahimi             return ret;
2669*62c56f98SSadaf Ebrahimi         }
2670*62c56f98SSadaf Ebrahimi     }
2671*62c56f98SSadaf Ebrahimi 
2672*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2673*62c56f98SSadaf Ebrahimi         return ret;
2674*62c56f98SSadaf Ebrahimi     }
2675*62c56f98SSadaf Ebrahimi 
2676*62c56f98SSadaf Ebrahimi     /* Update state and set timer */
2677*62c56f98SSadaf Ebrahimi     if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2678*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2679*62c56f98SSadaf Ebrahimi     } else {
2680*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2681*62c56f98SSadaf Ebrahimi         mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2682*62c56f98SSadaf Ebrahimi     }
2683*62c56f98SSadaf Ebrahimi 
2684*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2685*62c56f98SSadaf Ebrahimi 
2686*62c56f98SSadaf Ebrahimi     return 0;
2687*62c56f98SSadaf Ebrahimi }
2688*62c56f98SSadaf Ebrahimi 
2689*62c56f98SSadaf Ebrahimi /*
2690*62c56f98SSadaf Ebrahimi  * To be called when the last message of an incoming flight is received.
2691*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context * ssl)2692*62c56f98SSadaf Ebrahimi void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
2693*62c56f98SSadaf Ebrahimi {
2694*62c56f98SSadaf Ebrahimi     /* We won't need to resend that one any more */
2695*62c56f98SSadaf Ebrahimi     mbedtls_ssl_flight_free(ssl->handshake->flight);
2696*62c56f98SSadaf Ebrahimi     ssl->handshake->flight = NULL;
2697*62c56f98SSadaf Ebrahimi     ssl->handshake->cur_msg = NULL;
2698*62c56f98SSadaf Ebrahimi 
2699*62c56f98SSadaf Ebrahimi     /* The next incoming flight will start with this msg_seq */
2700*62c56f98SSadaf Ebrahimi     ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2701*62c56f98SSadaf Ebrahimi 
2702*62c56f98SSadaf Ebrahimi     /* We don't want to remember CCS's across flight boundaries. */
2703*62c56f98SSadaf Ebrahimi     ssl->handshake->buffering.seen_ccs = 0;
2704*62c56f98SSadaf Ebrahimi 
2705*62c56f98SSadaf Ebrahimi     /* Clear future message buffering structure. */
2706*62c56f98SSadaf Ebrahimi     mbedtls_ssl_buffering_free(ssl);
2707*62c56f98SSadaf Ebrahimi 
2708*62c56f98SSadaf Ebrahimi     /* Cancel timer */
2709*62c56f98SSadaf Ebrahimi     mbedtls_ssl_set_timer(ssl, 0);
2710*62c56f98SSadaf Ebrahimi 
2711*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2712*62c56f98SSadaf Ebrahimi         ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
2713*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2714*62c56f98SSadaf Ebrahimi     } else {
2715*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
2716*62c56f98SSadaf Ebrahimi     }
2717*62c56f98SSadaf Ebrahimi }
2718*62c56f98SSadaf Ebrahimi 
2719*62c56f98SSadaf Ebrahimi /*
2720*62c56f98SSadaf Ebrahimi  * To be called when the last message of an outgoing flight is send.
2721*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_send_flight_completed(mbedtls_ssl_context * ssl)2722*62c56f98SSadaf Ebrahimi void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
2723*62c56f98SSadaf Ebrahimi {
2724*62c56f98SSadaf Ebrahimi     ssl_reset_retransmit_timeout(ssl);
2725*62c56f98SSadaf Ebrahimi     mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2726*62c56f98SSadaf Ebrahimi 
2727*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2728*62c56f98SSadaf Ebrahimi         ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
2729*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2730*62c56f98SSadaf Ebrahimi     } else {
2731*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2732*62c56f98SSadaf Ebrahimi     }
2733*62c56f98SSadaf Ebrahimi }
2734*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
2735*62c56f98SSadaf Ebrahimi 
2736*62c56f98SSadaf Ebrahimi /*
2737*62c56f98SSadaf Ebrahimi  * Handshake layer functions
2738*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context * ssl,unsigned hs_type,unsigned char ** buf,size_t * buf_len)2739*62c56f98SSadaf Ebrahimi int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2740*62c56f98SSadaf Ebrahimi                                     unsigned char **buf, size_t *buf_len)
2741*62c56f98SSadaf Ebrahimi {
2742*62c56f98SSadaf Ebrahimi     /*
2743*62c56f98SSadaf Ebrahimi      * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
2744*62c56f98SSadaf Ebrahimi      *    ...
2745*62c56f98SSadaf Ebrahimi      *    HandshakeType msg_type;
2746*62c56f98SSadaf Ebrahimi      *    uint24 length;
2747*62c56f98SSadaf Ebrahimi      *    ...
2748*62c56f98SSadaf Ebrahimi      */
2749*62c56f98SSadaf Ebrahimi     *buf = ssl->out_msg + 4;
2750*62c56f98SSadaf Ebrahimi     *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2751*62c56f98SSadaf Ebrahimi 
2752*62c56f98SSadaf Ebrahimi     ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2753*62c56f98SSadaf Ebrahimi     ssl->out_msg[0]  = hs_type;
2754*62c56f98SSadaf Ebrahimi 
2755*62c56f98SSadaf Ebrahimi     return 0;
2756*62c56f98SSadaf Ebrahimi }
2757*62c56f98SSadaf Ebrahimi 
2758*62c56f98SSadaf Ebrahimi /*
2759*62c56f98SSadaf Ebrahimi  * Write (DTLS: or queue) current handshake (including CCS) message.
2760*62c56f98SSadaf Ebrahimi  *
2761*62c56f98SSadaf Ebrahimi  *  - fill in handshake headers
2762*62c56f98SSadaf Ebrahimi  *  - update handshake checksum
2763*62c56f98SSadaf Ebrahimi  *  - DTLS: save message for resending
2764*62c56f98SSadaf Ebrahimi  *  - then pass to the record layer
2765*62c56f98SSadaf Ebrahimi  *
2766*62c56f98SSadaf Ebrahimi  * DTLS: except for HelloRequest, messages are only queued, and will only be
2767*62c56f98SSadaf Ebrahimi  * actually sent when calling flight_transmit() or resend().
2768*62c56f98SSadaf Ebrahimi  *
2769*62c56f98SSadaf Ebrahimi  * Inputs:
2770*62c56f98SSadaf Ebrahimi  *  - ssl->out_msglen: 4 + actual handshake message len
2771*62c56f98SSadaf Ebrahimi  *      (4 is the size of handshake headers for TLS)
2772*62c56f98SSadaf Ebrahimi  *  - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2773*62c56f98SSadaf Ebrahimi  *  - ssl->out_msg + 4: the handshake message body
2774*62c56f98SSadaf Ebrahimi  *
2775*62c56f98SSadaf Ebrahimi  * Outputs, ie state before passing to flight_append() or write_record():
2776*62c56f98SSadaf Ebrahimi  *   - ssl->out_msglen: the length of the record contents
2777*62c56f98SSadaf Ebrahimi  *      (including handshake headers but excluding record headers)
2778*62c56f98SSadaf Ebrahimi  *   - ssl->out_msg: the record contents (handshake headers + content)
2779*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context * ssl,int update_checksum,int force_flush)2780*62c56f98SSadaf Ebrahimi int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2781*62c56f98SSadaf Ebrahimi                                         int update_checksum,
2782*62c56f98SSadaf Ebrahimi                                         int force_flush)
2783*62c56f98SSadaf Ebrahimi {
2784*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2785*62c56f98SSadaf Ebrahimi     const size_t hs_len = ssl->out_msglen - 4;
2786*62c56f98SSadaf Ebrahimi     const unsigned char hs_type = ssl->out_msg[0];
2787*62c56f98SSadaf Ebrahimi 
2788*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
2789*62c56f98SSadaf Ebrahimi 
2790*62c56f98SSadaf Ebrahimi     /*
2791*62c56f98SSadaf Ebrahimi      * Sanity checks
2792*62c56f98SSadaf Ebrahimi      */
2793*62c56f98SSadaf Ebrahimi     if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE          &&
2794*62c56f98SSadaf Ebrahimi         ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2795*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2796*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2797*62c56f98SSadaf Ebrahimi     }
2798*62c56f98SSadaf Ebrahimi 
2799*62c56f98SSadaf Ebrahimi     /* Whenever we send anything different from a
2800*62c56f98SSadaf Ebrahimi      * HelloRequest we should be in a handshake - double check. */
2801*62c56f98SSadaf Ebrahimi     if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2802*62c56f98SSadaf Ebrahimi           hs_type          == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2803*62c56f98SSadaf Ebrahimi         ssl->handshake == NULL) {
2804*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2805*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2806*62c56f98SSadaf Ebrahimi     }
2807*62c56f98SSadaf Ebrahimi 
2808*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2809*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2810*62c56f98SSadaf Ebrahimi         ssl->handshake != NULL &&
2811*62c56f98SSadaf Ebrahimi         ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2812*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2813*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2814*62c56f98SSadaf Ebrahimi     }
2815*62c56f98SSadaf Ebrahimi #endif
2816*62c56f98SSadaf Ebrahimi 
2817*62c56f98SSadaf Ebrahimi     /* Double-check that we did not exceed the bounds
2818*62c56f98SSadaf Ebrahimi      * of the outgoing record buffer.
2819*62c56f98SSadaf Ebrahimi      * This should never fail as the various message
2820*62c56f98SSadaf Ebrahimi      * writing functions must obey the bounds of the
2821*62c56f98SSadaf Ebrahimi      * outgoing record buffer, but better be safe.
2822*62c56f98SSadaf Ebrahimi      *
2823*62c56f98SSadaf Ebrahimi      * Note: We deliberately do not check for the MTU or MFL here.
2824*62c56f98SSadaf Ebrahimi      */
2825*62c56f98SSadaf Ebrahimi     if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2826*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2827*62c56f98SSadaf Ebrahimi                                   "size %" MBEDTLS_PRINTF_SIZET
2828*62c56f98SSadaf Ebrahimi                                   ", maximum %" MBEDTLS_PRINTF_SIZET,
2829*62c56f98SSadaf Ebrahimi                                   ssl->out_msglen,
2830*62c56f98SSadaf Ebrahimi                                   (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2831*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2832*62c56f98SSadaf Ebrahimi     }
2833*62c56f98SSadaf Ebrahimi 
2834*62c56f98SSadaf Ebrahimi     /*
2835*62c56f98SSadaf Ebrahimi      * Fill handshake headers
2836*62c56f98SSadaf Ebrahimi      */
2837*62c56f98SSadaf Ebrahimi     if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2838*62c56f98SSadaf Ebrahimi         ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2839*62c56f98SSadaf Ebrahimi         ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2840*62c56f98SSadaf Ebrahimi         ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
2841*62c56f98SSadaf Ebrahimi 
2842*62c56f98SSadaf Ebrahimi         /*
2843*62c56f98SSadaf Ebrahimi          * DTLS has additional fields in the Handshake layer,
2844*62c56f98SSadaf Ebrahimi          * between the length field and the actual payload:
2845*62c56f98SSadaf Ebrahimi          *      uint16 message_seq;
2846*62c56f98SSadaf Ebrahimi          *      uint24 fragment_offset;
2847*62c56f98SSadaf Ebrahimi          *      uint24 fragment_length;
2848*62c56f98SSadaf Ebrahimi          */
2849*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2850*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2851*62c56f98SSadaf Ebrahimi             /* Make room for the additional DTLS fields */
2852*62c56f98SSadaf Ebrahimi             if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2853*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2854*62c56f98SSadaf Ebrahimi                                           "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2855*62c56f98SSadaf Ebrahimi                                           MBEDTLS_PRINTF_SIZET,
2856*62c56f98SSadaf Ebrahimi                                           hs_len,
2857*62c56f98SSadaf Ebrahimi                                           (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2858*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2859*62c56f98SSadaf Ebrahimi             }
2860*62c56f98SSadaf Ebrahimi 
2861*62c56f98SSadaf Ebrahimi             memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
2862*62c56f98SSadaf Ebrahimi             ssl->out_msglen += 8;
2863*62c56f98SSadaf Ebrahimi 
2864*62c56f98SSadaf Ebrahimi             /* Write message_seq and update it, except for HelloRequest */
2865*62c56f98SSadaf Ebrahimi             if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2866*62c56f98SSadaf Ebrahimi                 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2867*62c56f98SSadaf Ebrahimi                 ++(ssl->handshake->out_msg_seq);
2868*62c56f98SSadaf Ebrahimi             } else {
2869*62c56f98SSadaf Ebrahimi                 ssl->out_msg[4] = 0;
2870*62c56f98SSadaf Ebrahimi                 ssl->out_msg[5] = 0;
2871*62c56f98SSadaf Ebrahimi             }
2872*62c56f98SSadaf Ebrahimi 
2873*62c56f98SSadaf Ebrahimi             /* Handshake hashes are computed without fragmentation,
2874*62c56f98SSadaf Ebrahimi              * so set frag_offset = 0 and frag_len = hs_len for now */
2875*62c56f98SSadaf Ebrahimi             memset(ssl->out_msg + 6, 0x00, 3);
2876*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
2877*62c56f98SSadaf Ebrahimi         }
2878*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
2879*62c56f98SSadaf Ebrahimi 
2880*62c56f98SSadaf Ebrahimi         /* Update running hashes of handshake messages seen */
2881*62c56f98SSadaf Ebrahimi         if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
2882*62c56f98SSadaf Ebrahimi             ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2883*62c56f98SSadaf Ebrahimi                                                   ssl->out_msglen);
2884*62c56f98SSadaf Ebrahimi             if (ret != 0) {
2885*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2886*62c56f98SSadaf Ebrahimi                 return ret;
2887*62c56f98SSadaf Ebrahimi             }
2888*62c56f98SSadaf Ebrahimi         }
2889*62c56f98SSadaf Ebrahimi     }
2890*62c56f98SSadaf Ebrahimi 
2891*62c56f98SSadaf Ebrahimi     /* Either send now, or just save to be sent (and resent) later */
2892*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
2893*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2894*62c56f98SSadaf Ebrahimi         !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2895*62c56f98SSadaf Ebrahimi           hs_type          == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2896*62c56f98SSadaf Ebrahimi         if ((ret = ssl_flight_append(ssl)) != 0) {
2897*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2898*62c56f98SSadaf Ebrahimi             return ret;
2899*62c56f98SSadaf Ebrahimi         }
2900*62c56f98SSadaf Ebrahimi     } else
2901*62c56f98SSadaf Ebrahimi #endif
2902*62c56f98SSadaf Ebrahimi     {
2903*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2904*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2905*62c56f98SSadaf Ebrahimi             return ret;
2906*62c56f98SSadaf Ebrahimi         }
2907*62c56f98SSadaf Ebrahimi     }
2908*62c56f98SSadaf Ebrahimi 
2909*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
2910*62c56f98SSadaf Ebrahimi 
2911*62c56f98SSadaf Ebrahimi     return 0;
2912*62c56f98SSadaf Ebrahimi }
2913*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context * ssl,size_t buf_len,size_t msg_len)2914*62c56f98SSadaf Ebrahimi int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2915*62c56f98SSadaf Ebrahimi                                      size_t buf_len, size_t msg_len)
2916*62c56f98SSadaf Ebrahimi {
2917*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2918*62c56f98SSadaf Ebrahimi     size_t msg_with_header_len;
2919*62c56f98SSadaf Ebrahimi     ((void) buf_len);
2920*62c56f98SSadaf Ebrahimi 
2921*62c56f98SSadaf Ebrahimi     /* Add reserved 4 bytes for handshake header */
2922*62c56f98SSadaf Ebrahimi     msg_with_header_len = msg_len + 4;
2923*62c56f98SSadaf Ebrahimi     ssl->out_msglen = msg_with_header_len;
2924*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
2925*62c56f98SSadaf Ebrahimi 
2926*62c56f98SSadaf Ebrahimi cleanup:
2927*62c56f98SSadaf Ebrahimi     return ret;
2928*62c56f98SSadaf Ebrahimi }
2929*62c56f98SSadaf Ebrahimi 
2930*62c56f98SSadaf Ebrahimi /*
2931*62c56f98SSadaf Ebrahimi  * Record layer functions
2932*62c56f98SSadaf Ebrahimi  */
2933*62c56f98SSadaf Ebrahimi 
2934*62c56f98SSadaf Ebrahimi /*
2935*62c56f98SSadaf Ebrahimi  * Write current record.
2936*62c56f98SSadaf Ebrahimi  *
2937*62c56f98SSadaf Ebrahimi  * Uses:
2938*62c56f98SSadaf Ebrahimi  *  - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2939*62c56f98SSadaf Ebrahimi  *  - ssl->out_msglen: length of the record content (excl headers)
2940*62c56f98SSadaf Ebrahimi  *  - ssl->out_msg: record content
2941*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_write_record(mbedtls_ssl_context * ssl,int force_flush)2942*62c56f98SSadaf Ebrahimi int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
2943*62c56f98SSadaf Ebrahimi {
2944*62c56f98SSadaf Ebrahimi     int ret, done = 0;
2945*62c56f98SSadaf Ebrahimi     size_t len = ssl->out_msglen;
2946*62c56f98SSadaf Ebrahimi     int flush = force_flush;
2947*62c56f98SSadaf Ebrahimi 
2948*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
2949*62c56f98SSadaf Ebrahimi 
2950*62c56f98SSadaf Ebrahimi     if (!done) {
2951*62c56f98SSadaf Ebrahimi         unsigned i;
2952*62c56f98SSadaf Ebrahimi         size_t protected_record_size;
2953*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2954*62c56f98SSadaf Ebrahimi         size_t out_buf_len = ssl->out_buf_len;
2955*62c56f98SSadaf Ebrahimi #else
2956*62c56f98SSadaf Ebrahimi         size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2957*62c56f98SSadaf Ebrahimi #endif
2958*62c56f98SSadaf Ebrahimi         /* Skip writing the record content type to after the encryption,
2959*62c56f98SSadaf Ebrahimi          * as it may change when using the CID extension. */
2960*62c56f98SSadaf Ebrahimi         mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
2961*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
2962*62c56f98SSadaf Ebrahimi         /* TLS 1.3 still uses the TLS 1.2 version identifier
2963*62c56f98SSadaf Ebrahimi          * for backwards compatibility. */
2964*62c56f98SSadaf Ebrahimi         if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
2965*62c56f98SSadaf Ebrahimi             tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
2966*62c56f98SSadaf Ebrahimi         }
2967*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2968*62c56f98SSadaf Ebrahimi         mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2969*62c56f98SSadaf Ebrahimi                                   tls_ver);
2970*62c56f98SSadaf Ebrahimi 
2971*62c56f98SSadaf Ebrahimi         memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2972*62c56f98SSadaf Ebrahimi         MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
2973*62c56f98SSadaf Ebrahimi 
2974*62c56f98SSadaf Ebrahimi         if (ssl->transform_out != NULL) {
2975*62c56f98SSadaf Ebrahimi             mbedtls_record rec;
2976*62c56f98SSadaf Ebrahimi 
2977*62c56f98SSadaf Ebrahimi             rec.buf         = ssl->out_iv;
2978*62c56f98SSadaf Ebrahimi             rec.buf_len     = out_buf_len - (ssl->out_iv - ssl->out_buf);
2979*62c56f98SSadaf Ebrahimi             rec.data_len    = ssl->out_msglen;
2980*62c56f98SSadaf Ebrahimi             rec.data_offset = ssl->out_msg - rec.buf;
2981*62c56f98SSadaf Ebrahimi 
2982*62c56f98SSadaf Ebrahimi             memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2983*62c56f98SSadaf Ebrahimi             mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
2984*62c56f98SSadaf Ebrahimi             rec.type = ssl->out_msgtype;
2985*62c56f98SSadaf Ebrahimi 
2986*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2987*62c56f98SSadaf Ebrahimi             /* The CID is set by mbedtls_ssl_encrypt_buf(). */
2988*62c56f98SSadaf Ebrahimi             rec.cid_len = 0;
2989*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
2990*62c56f98SSadaf Ebrahimi 
2991*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2992*62c56f98SSadaf Ebrahimi                                                ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2993*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2994*62c56f98SSadaf Ebrahimi                 return ret;
2995*62c56f98SSadaf Ebrahimi             }
2996*62c56f98SSadaf Ebrahimi 
2997*62c56f98SSadaf Ebrahimi             if (rec.data_offset != 0) {
2998*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2999*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3000*62c56f98SSadaf Ebrahimi             }
3001*62c56f98SSadaf Ebrahimi 
3002*62c56f98SSadaf Ebrahimi             /* Update the record content type and CID. */
3003*62c56f98SSadaf Ebrahimi             ssl->out_msgtype = rec.type;
3004*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3005*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_cid, rec.cid, rec.cid_len);
3006*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3007*62c56f98SSadaf Ebrahimi             ssl->out_msglen = len = rec.data_len;
3008*62c56f98SSadaf Ebrahimi             MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
3009*62c56f98SSadaf Ebrahimi         }
3010*62c56f98SSadaf Ebrahimi 
3011*62c56f98SSadaf Ebrahimi         protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
3012*62c56f98SSadaf Ebrahimi 
3013*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3014*62c56f98SSadaf Ebrahimi         /* In case of DTLS, double-check that we don't exceed
3015*62c56f98SSadaf Ebrahimi          * the remaining space in the datagram. */
3016*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3017*62c56f98SSadaf Ebrahimi             ret = ssl_get_remaining_space_in_datagram(ssl);
3018*62c56f98SSadaf Ebrahimi             if (ret < 0) {
3019*62c56f98SSadaf Ebrahimi                 return ret;
3020*62c56f98SSadaf Ebrahimi             }
3021*62c56f98SSadaf Ebrahimi 
3022*62c56f98SSadaf Ebrahimi             if (protected_record_size > (size_t) ret) {
3023*62c56f98SSadaf Ebrahimi                 /* Should never happen */
3024*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3025*62c56f98SSadaf Ebrahimi             }
3026*62c56f98SSadaf Ebrahimi         }
3027*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3028*62c56f98SSadaf Ebrahimi 
3029*62c56f98SSadaf Ebrahimi         /* Now write the potentially updated record content type. */
3030*62c56f98SSadaf Ebrahimi         ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3031*62c56f98SSadaf Ebrahimi 
3032*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3033*62c56f98SSadaf Ebrahimi                                   "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3034*62c56f98SSadaf Ebrahimi                                   ssl->out_hdr[0], ssl->out_hdr[1],
3035*62c56f98SSadaf Ebrahimi                                   ssl->out_hdr[2], len));
3036*62c56f98SSadaf Ebrahimi 
3037*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3038*62c56f98SSadaf Ebrahimi                               ssl->out_hdr, protected_record_size);
3039*62c56f98SSadaf Ebrahimi 
3040*62c56f98SSadaf Ebrahimi         ssl->out_left += protected_record_size;
3041*62c56f98SSadaf Ebrahimi         ssl->out_hdr  += protected_record_size;
3042*62c56f98SSadaf Ebrahimi         mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
3043*62c56f98SSadaf Ebrahimi 
3044*62c56f98SSadaf Ebrahimi         for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3045*62c56f98SSadaf Ebrahimi             if (++ssl->cur_out_ctr[i - 1] != 0) {
3046*62c56f98SSadaf Ebrahimi                 break;
3047*62c56f98SSadaf Ebrahimi             }
3048*62c56f98SSadaf Ebrahimi         }
3049*62c56f98SSadaf Ebrahimi 
3050*62c56f98SSadaf Ebrahimi         /* The loop goes to its end if the counter is wrapping */
3051*62c56f98SSadaf Ebrahimi         if (i == mbedtls_ssl_ep_len(ssl)) {
3052*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3053*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
3054*62c56f98SSadaf Ebrahimi         }
3055*62c56f98SSadaf Ebrahimi     }
3056*62c56f98SSadaf Ebrahimi 
3057*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3058*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3059*62c56f98SSadaf Ebrahimi         flush == SSL_DONT_FORCE_FLUSH) {
3060*62c56f98SSadaf Ebrahimi         size_t remaining;
3061*62c56f98SSadaf Ebrahimi         ret = ssl_get_remaining_payload_in_datagram(ssl);
3062*62c56f98SSadaf Ebrahimi         if (ret < 0) {
3063*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3064*62c56f98SSadaf Ebrahimi                                   ret);
3065*62c56f98SSadaf Ebrahimi             return ret;
3066*62c56f98SSadaf Ebrahimi         }
3067*62c56f98SSadaf Ebrahimi 
3068*62c56f98SSadaf Ebrahimi         remaining = (size_t) ret;
3069*62c56f98SSadaf Ebrahimi         if (remaining == 0) {
3070*62c56f98SSadaf Ebrahimi             flush = SSL_FORCE_FLUSH;
3071*62c56f98SSadaf Ebrahimi         } else {
3072*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2,
3073*62c56f98SSadaf Ebrahimi                                   ("Still %u bytes available in current datagram",
3074*62c56f98SSadaf Ebrahimi                                    (unsigned) remaining));
3075*62c56f98SSadaf Ebrahimi         }
3076*62c56f98SSadaf Ebrahimi     }
3077*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3078*62c56f98SSadaf Ebrahimi 
3079*62c56f98SSadaf Ebrahimi     if ((flush == SSL_FORCE_FLUSH) &&
3080*62c56f98SSadaf Ebrahimi         (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3081*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3082*62c56f98SSadaf Ebrahimi         return ret;
3083*62c56f98SSadaf Ebrahimi     }
3084*62c56f98SSadaf Ebrahimi 
3085*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
3086*62c56f98SSadaf Ebrahimi 
3087*62c56f98SSadaf Ebrahimi     return 0;
3088*62c56f98SSadaf Ebrahimi }
3089*62c56f98SSadaf Ebrahimi 
3090*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3091*62c56f98SSadaf Ebrahimi 
3092*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_hs_is_proper_fragment(mbedtls_ssl_context * ssl)3093*62c56f98SSadaf Ebrahimi static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
3094*62c56f98SSadaf Ebrahimi {
3095*62c56f98SSadaf Ebrahimi     if (ssl->in_msglen < ssl->in_hslen ||
3096*62c56f98SSadaf Ebrahimi         memcmp(ssl->in_msg + 6, "\0\0\0",        3) != 0 ||
3097*62c56f98SSadaf Ebrahimi         memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3098*62c56f98SSadaf Ebrahimi         return 1;
3099*62c56f98SSadaf Ebrahimi     }
3100*62c56f98SSadaf Ebrahimi     return 0;
3101*62c56f98SSadaf Ebrahimi }
3102*62c56f98SSadaf Ebrahimi 
ssl_get_hs_frag_len(mbedtls_ssl_context const * ssl)3103*62c56f98SSadaf Ebrahimi static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
3104*62c56f98SSadaf Ebrahimi {
3105*62c56f98SSadaf Ebrahimi     return (ssl->in_msg[9] << 16) |
3106*62c56f98SSadaf Ebrahimi            (ssl->in_msg[10] << 8) |
3107*62c56f98SSadaf Ebrahimi            ssl->in_msg[11];
3108*62c56f98SSadaf Ebrahimi }
3109*62c56f98SSadaf Ebrahimi 
ssl_get_hs_frag_off(mbedtls_ssl_context const * ssl)3110*62c56f98SSadaf Ebrahimi static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
3111*62c56f98SSadaf Ebrahimi {
3112*62c56f98SSadaf Ebrahimi     return (ssl->in_msg[6] << 16) |
3113*62c56f98SSadaf Ebrahimi            (ssl->in_msg[7] << 8) |
3114*62c56f98SSadaf Ebrahimi            ssl->in_msg[8];
3115*62c56f98SSadaf Ebrahimi }
3116*62c56f98SSadaf Ebrahimi 
3117*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_check_hs_header(mbedtls_ssl_context const * ssl)3118*62c56f98SSadaf Ebrahimi static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
3119*62c56f98SSadaf Ebrahimi {
3120*62c56f98SSadaf Ebrahimi     uint32_t msg_len, frag_off, frag_len;
3121*62c56f98SSadaf Ebrahimi 
3122*62c56f98SSadaf Ebrahimi     msg_len  = ssl_get_hs_total_len(ssl);
3123*62c56f98SSadaf Ebrahimi     frag_off = ssl_get_hs_frag_off(ssl);
3124*62c56f98SSadaf Ebrahimi     frag_len = ssl_get_hs_frag_len(ssl);
3125*62c56f98SSadaf Ebrahimi 
3126*62c56f98SSadaf Ebrahimi     if (frag_off > msg_len) {
3127*62c56f98SSadaf Ebrahimi         return -1;
3128*62c56f98SSadaf Ebrahimi     }
3129*62c56f98SSadaf Ebrahimi 
3130*62c56f98SSadaf Ebrahimi     if (frag_len > msg_len - frag_off) {
3131*62c56f98SSadaf Ebrahimi         return -1;
3132*62c56f98SSadaf Ebrahimi     }
3133*62c56f98SSadaf Ebrahimi 
3134*62c56f98SSadaf Ebrahimi     if (frag_len + 12 > ssl->in_msglen) {
3135*62c56f98SSadaf Ebrahimi         return -1;
3136*62c56f98SSadaf Ebrahimi     }
3137*62c56f98SSadaf Ebrahimi 
3138*62c56f98SSadaf Ebrahimi     return 0;
3139*62c56f98SSadaf Ebrahimi }
3140*62c56f98SSadaf Ebrahimi 
3141*62c56f98SSadaf Ebrahimi /*
3142*62c56f98SSadaf Ebrahimi  * Mark bits in bitmask (used for DTLS HS reassembly)
3143*62c56f98SSadaf Ebrahimi  */
ssl_bitmask_set(unsigned char * mask,size_t offset,size_t len)3144*62c56f98SSadaf Ebrahimi static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
3145*62c56f98SSadaf Ebrahimi {
3146*62c56f98SSadaf Ebrahimi     unsigned int start_bits, end_bits;
3147*62c56f98SSadaf Ebrahimi 
3148*62c56f98SSadaf Ebrahimi     start_bits = 8 - (offset % 8);
3149*62c56f98SSadaf Ebrahimi     if (start_bits != 8) {
3150*62c56f98SSadaf Ebrahimi         size_t first_byte_idx = offset / 8;
3151*62c56f98SSadaf Ebrahimi 
3152*62c56f98SSadaf Ebrahimi         /* Special case */
3153*62c56f98SSadaf Ebrahimi         if (len <= start_bits) {
3154*62c56f98SSadaf Ebrahimi             for (; len != 0; len--) {
3155*62c56f98SSadaf Ebrahimi                 mask[first_byte_idx] |= 1 << (start_bits - len);
3156*62c56f98SSadaf Ebrahimi             }
3157*62c56f98SSadaf Ebrahimi 
3158*62c56f98SSadaf Ebrahimi             /* Avoid potential issues with offset or len becoming invalid */
3159*62c56f98SSadaf Ebrahimi             return;
3160*62c56f98SSadaf Ebrahimi         }
3161*62c56f98SSadaf Ebrahimi 
3162*62c56f98SSadaf Ebrahimi         offset += start_bits; /* Now offset % 8 == 0 */
3163*62c56f98SSadaf Ebrahimi         len -= start_bits;
3164*62c56f98SSadaf Ebrahimi 
3165*62c56f98SSadaf Ebrahimi         for (; start_bits != 0; start_bits--) {
3166*62c56f98SSadaf Ebrahimi             mask[first_byte_idx] |= 1 << (start_bits - 1);
3167*62c56f98SSadaf Ebrahimi         }
3168*62c56f98SSadaf Ebrahimi     }
3169*62c56f98SSadaf Ebrahimi 
3170*62c56f98SSadaf Ebrahimi     end_bits = len % 8;
3171*62c56f98SSadaf Ebrahimi     if (end_bits != 0) {
3172*62c56f98SSadaf Ebrahimi         size_t last_byte_idx = (offset + len) / 8;
3173*62c56f98SSadaf Ebrahimi 
3174*62c56f98SSadaf Ebrahimi         len -= end_bits; /* Now len % 8 == 0 */
3175*62c56f98SSadaf Ebrahimi 
3176*62c56f98SSadaf Ebrahimi         for (; end_bits != 0; end_bits--) {
3177*62c56f98SSadaf Ebrahimi             mask[last_byte_idx] |= 1 << (8 - end_bits);
3178*62c56f98SSadaf Ebrahimi         }
3179*62c56f98SSadaf Ebrahimi     }
3180*62c56f98SSadaf Ebrahimi 
3181*62c56f98SSadaf Ebrahimi     memset(mask + offset / 8, 0xFF, len / 8);
3182*62c56f98SSadaf Ebrahimi }
3183*62c56f98SSadaf Ebrahimi 
3184*62c56f98SSadaf Ebrahimi /*
3185*62c56f98SSadaf Ebrahimi  * Check that bitmask is full
3186*62c56f98SSadaf Ebrahimi  */
3187*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_bitmask_check(unsigned char * mask,size_t len)3188*62c56f98SSadaf Ebrahimi static int ssl_bitmask_check(unsigned char *mask, size_t len)
3189*62c56f98SSadaf Ebrahimi {
3190*62c56f98SSadaf Ebrahimi     size_t i;
3191*62c56f98SSadaf Ebrahimi 
3192*62c56f98SSadaf Ebrahimi     for (i = 0; i < len / 8; i++) {
3193*62c56f98SSadaf Ebrahimi         if (mask[i] != 0xFF) {
3194*62c56f98SSadaf Ebrahimi             return -1;
3195*62c56f98SSadaf Ebrahimi         }
3196*62c56f98SSadaf Ebrahimi     }
3197*62c56f98SSadaf Ebrahimi 
3198*62c56f98SSadaf Ebrahimi     for (i = 0; i < len % 8; i++) {
3199*62c56f98SSadaf Ebrahimi         if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3200*62c56f98SSadaf Ebrahimi             return -1;
3201*62c56f98SSadaf Ebrahimi         }
3202*62c56f98SSadaf Ebrahimi     }
3203*62c56f98SSadaf Ebrahimi 
3204*62c56f98SSadaf Ebrahimi     return 0;
3205*62c56f98SSadaf Ebrahimi }
3206*62c56f98SSadaf Ebrahimi 
3207*62c56f98SSadaf Ebrahimi /* msg_len does not include the handshake header */
ssl_get_reassembly_buffer_size(size_t msg_len,unsigned add_bitmap)3208*62c56f98SSadaf Ebrahimi static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3209*62c56f98SSadaf Ebrahimi                                              unsigned add_bitmap)
3210*62c56f98SSadaf Ebrahimi {
3211*62c56f98SSadaf Ebrahimi     size_t alloc_len;
3212*62c56f98SSadaf Ebrahimi 
3213*62c56f98SSadaf Ebrahimi     alloc_len  = 12;                                 /* Handshake header */
3214*62c56f98SSadaf Ebrahimi     alloc_len += msg_len;                            /* Content buffer   */
3215*62c56f98SSadaf Ebrahimi 
3216*62c56f98SSadaf Ebrahimi     if (add_bitmap) {
3217*62c56f98SSadaf Ebrahimi         alloc_len += msg_len / 8 + (msg_len % 8 != 0);   /* Bitmap       */
3218*62c56f98SSadaf Ebrahimi 
3219*62c56f98SSadaf Ebrahimi     }
3220*62c56f98SSadaf Ebrahimi     return alloc_len;
3221*62c56f98SSadaf Ebrahimi }
3222*62c56f98SSadaf Ebrahimi 
3223*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3224*62c56f98SSadaf Ebrahimi 
ssl_get_hs_total_len(mbedtls_ssl_context const * ssl)3225*62c56f98SSadaf Ebrahimi static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
3226*62c56f98SSadaf Ebrahimi {
3227*62c56f98SSadaf Ebrahimi     return (ssl->in_msg[1] << 16) |
3228*62c56f98SSadaf Ebrahimi            (ssl->in_msg[2] << 8) |
3229*62c56f98SSadaf Ebrahimi            ssl->in_msg[3];
3230*62c56f98SSadaf Ebrahimi }
3231*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context * ssl)3232*62c56f98SSadaf Ebrahimi int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
3233*62c56f98SSadaf Ebrahimi {
3234*62c56f98SSadaf Ebrahimi     if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3235*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3236*62c56f98SSadaf Ebrahimi                                   ssl->in_msglen));
3237*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
3238*62c56f98SSadaf Ebrahimi     }
3239*62c56f98SSadaf Ebrahimi 
3240*62c56f98SSadaf Ebrahimi     ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
3241*62c56f98SSadaf Ebrahimi 
3242*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3243*62c56f98SSadaf Ebrahimi                               " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3244*62c56f98SSadaf Ebrahimi                               MBEDTLS_PRINTF_SIZET,
3245*62c56f98SSadaf Ebrahimi                               ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
3246*62c56f98SSadaf Ebrahimi 
3247*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3248*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3249*62c56f98SSadaf Ebrahimi         int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3250*62c56f98SSadaf Ebrahimi         unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
3251*62c56f98SSadaf Ebrahimi 
3252*62c56f98SSadaf Ebrahimi         if (ssl_check_hs_header(ssl) != 0) {
3253*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3254*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
3255*62c56f98SSadaf Ebrahimi         }
3256*62c56f98SSadaf Ebrahimi 
3257*62c56f98SSadaf Ebrahimi         if (ssl->handshake != NULL &&
3258*62c56f98SSadaf Ebrahimi             ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3259*62c56f98SSadaf Ebrahimi               recv_msg_seq != ssl->handshake->in_msg_seq) ||
3260*62c56f98SSadaf Ebrahimi              (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3261*62c56f98SSadaf Ebrahimi               ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3262*62c56f98SSadaf Ebrahimi             if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3263*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2,
3264*62c56f98SSadaf Ebrahimi                                       (
3265*62c56f98SSadaf Ebrahimi                                           "received future handshake message of sequence number %u (next %u)",
3266*62c56f98SSadaf Ebrahimi                                           recv_msg_seq,
3267*62c56f98SSadaf Ebrahimi                                           ssl->handshake->in_msg_seq));
3268*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
3269*62c56f98SSadaf Ebrahimi             }
3270*62c56f98SSadaf Ebrahimi 
3271*62c56f98SSadaf Ebrahimi             /* Retransmit only on last message from previous flight, to avoid
3272*62c56f98SSadaf Ebrahimi              * too many retransmissions.
3273*62c56f98SSadaf Ebrahimi              * Besides, No sane server ever retransmits HelloVerifyRequest */
3274*62c56f98SSadaf Ebrahimi             if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3275*62c56f98SSadaf Ebrahimi                 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3276*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3277*62c56f98SSadaf Ebrahimi                                           "message_seq = %u, start_of_flight = %u",
3278*62c56f98SSadaf Ebrahimi                                           recv_msg_seq,
3279*62c56f98SSadaf Ebrahimi                                           ssl->handshake->in_flight_start_seq));
3280*62c56f98SSadaf Ebrahimi 
3281*62c56f98SSadaf Ebrahimi                 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3282*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3283*62c56f98SSadaf Ebrahimi                     return ret;
3284*62c56f98SSadaf Ebrahimi                 }
3285*62c56f98SSadaf Ebrahimi             } else {
3286*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3287*62c56f98SSadaf Ebrahimi                                           "message_seq = %u, expected = %u",
3288*62c56f98SSadaf Ebrahimi                                           recv_msg_seq,
3289*62c56f98SSadaf Ebrahimi                                           ssl->handshake->in_msg_seq));
3290*62c56f98SSadaf Ebrahimi             }
3291*62c56f98SSadaf Ebrahimi 
3292*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3293*62c56f98SSadaf Ebrahimi         }
3294*62c56f98SSadaf Ebrahimi         /* Wait until message completion to increment in_msg_seq */
3295*62c56f98SSadaf Ebrahimi 
3296*62c56f98SSadaf Ebrahimi         /* Message reassembly is handled alongside buffering of future
3297*62c56f98SSadaf Ebrahimi          * messages; the commonality is that both handshake fragments and
3298*62c56f98SSadaf Ebrahimi          * future messages cannot be forwarded immediately to the
3299*62c56f98SSadaf Ebrahimi          * handshake logic layer. */
3300*62c56f98SSadaf Ebrahimi         if (ssl_hs_is_proper_fragment(ssl) == 1) {
3301*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3302*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
3303*62c56f98SSadaf Ebrahimi         }
3304*62c56f98SSadaf Ebrahimi     } else
3305*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3306*62c56f98SSadaf Ebrahimi     /* With TLS we don't handle fragmentation (for now) */
3307*62c56f98SSadaf Ebrahimi     if (ssl->in_msglen < ssl->in_hslen) {
3308*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3309*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3310*62c56f98SSadaf Ebrahimi     }
3311*62c56f98SSadaf Ebrahimi 
3312*62c56f98SSadaf Ebrahimi     return 0;
3313*62c56f98SSadaf Ebrahimi }
3314*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_update_handshake_status(mbedtls_ssl_context * ssl)3315*62c56f98SSadaf Ebrahimi int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
3316*62c56f98SSadaf Ebrahimi {
3317*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3318*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3319*62c56f98SSadaf Ebrahimi 
3320*62c56f98SSadaf Ebrahimi     if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
3321*62c56f98SSadaf Ebrahimi         ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3322*62c56f98SSadaf Ebrahimi         if (ret != 0) {
3323*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3324*62c56f98SSadaf Ebrahimi             return ret;
3325*62c56f98SSadaf Ebrahimi         }
3326*62c56f98SSadaf Ebrahimi     }
3327*62c56f98SSadaf Ebrahimi 
3328*62c56f98SSadaf Ebrahimi     /* Handshake message is complete, increment counter */
3329*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3330*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3331*62c56f98SSadaf Ebrahimi         ssl->handshake != NULL) {
3332*62c56f98SSadaf Ebrahimi         unsigned offset;
3333*62c56f98SSadaf Ebrahimi         mbedtls_ssl_hs_buffer *hs_buf;
3334*62c56f98SSadaf Ebrahimi 
3335*62c56f98SSadaf Ebrahimi         /* Increment handshake sequence number */
3336*62c56f98SSadaf Ebrahimi         hs->in_msg_seq++;
3337*62c56f98SSadaf Ebrahimi 
3338*62c56f98SSadaf Ebrahimi         /*
3339*62c56f98SSadaf Ebrahimi          * Clear up handshake buffering and reassembly structure.
3340*62c56f98SSadaf Ebrahimi          */
3341*62c56f98SSadaf Ebrahimi 
3342*62c56f98SSadaf Ebrahimi         /* Free first entry */
3343*62c56f98SSadaf Ebrahimi         ssl_buffering_free_slot(ssl, 0);
3344*62c56f98SSadaf Ebrahimi 
3345*62c56f98SSadaf Ebrahimi         /* Shift all other entries */
3346*62c56f98SSadaf Ebrahimi         for (offset = 0, hs_buf = &hs->buffering.hs[0];
3347*62c56f98SSadaf Ebrahimi              offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
3348*62c56f98SSadaf Ebrahimi              offset++, hs_buf++) {
3349*62c56f98SSadaf Ebrahimi             *hs_buf = *(hs_buf + 1);
3350*62c56f98SSadaf Ebrahimi         }
3351*62c56f98SSadaf Ebrahimi 
3352*62c56f98SSadaf Ebrahimi         /* Create a fresh last entry */
3353*62c56f98SSadaf Ebrahimi         memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
3354*62c56f98SSadaf Ebrahimi     }
3355*62c56f98SSadaf Ebrahimi #endif
3356*62c56f98SSadaf Ebrahimi     return 0;
3357*62c56f98SSadaf Ebrahimi }
3358*62c56f98SSadaf Ebrahimi 
3359*62c56f98SSadaf Ebrahimi /*
3360*62c56f98SSadaf Ebrahimi  * DTLS anti-replay: RFC 6347 4.1.2.6
3361*62c56f98SSadaf Ebrahimi  *
3362*62c56f98SSadaf Ebrahimi  * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3363*62c56f98SSadaf Ebrahimi  * Bit n is set iff record number in_window_top - n has been seen.
3364*62c56f98SSadaf Ebrahimi  *
3365*62c56f98SSadaf Ebrahimi  * Usually, in_window_top is the last record number seen and the lsb of
3366*62c56f98SSadaf Ebrahimi  * in_window is set. The only exception is the initial state (record number 0
3367*62c56f98SSadaf Ebrahimi  * not seen yet).
3368*62c56f98SSadaf Ebrahimi  */
3369*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context * ssl)3370*62c56f98SSadaf Ebrahimi void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
3371*62c56f98SSadaf Ebrahimi {
3372*62c56f98SSadaf Ebrahimi     ssl->in_window_top = 0;
3373*62c56f98SSadaf Ebrahimi     ssl->in_window = 0;
3374*62c56f98SSadaf Ebrahimi }
3375*62c56f98SSadaf Ebrahimi 
ssl_load_six_bytes(unsigned char * buf)3376*62c56f98SSadaf Ebrahimi static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
3377*62c56f98SSadaf Ebrahimi {
3378*62c56f98SSadaf Ebrahimi     return ((uint64_t) buf[0] << 40) |
3379*62c56f98SSadaf Ebrahimi            ((uint64_t) buf[1] << 32) |
3380*62c56f98SSadaf Ebrahimi            ((uint64_t) buf[2] << 24) |
3381*62c56f98SSadaf Ebrahimi            ((uint64_t) buf[3] << 16) |
3382*62c56f98SSadaf Ebrahimi            ((uint64_t) buf[4] <<  8) |
3383*62c56f98SSadaf Ebrahimi            ((uint64_t) buf[5]);
3384*62c56f98SSadaf Ebrahimi }
3385*62c56f98SSadaf Ebrahimi 
3386*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context * ssl,uint8_t * record_in_ctr)3387*62c56f98SSadaf Ebrahimi static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
3388*62c56f98SSadaf Ebrahimi {
3389*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3390*62c56f98SSadaf Ebrahimi     unsigned char *original_in_ctr;
3391*62c56f98SSadaf Ebrahimi 
3392*62c56f98SSadaf Ebrahimi     // save original in_ctr
3393*62c56f98SSadaf Ebrahimi     original_in_ctr = ssl->in_ctr;
3394*62c56f98SSadaf Ebrahimi 
3395*62c56f98SSadaf Ebrahimi     // use counter from record
3396*62c56f98SSadaf Ebrahimi     ssl->in_ctr = record_in_ctr;
3397*62c56f98SSadaf Ebrahimi 
3398*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
3399*62c56f98SSadaf Ebrahimi 
3400*62c56f98SSadaf Ebrahimi     // restore the counter
3401*62c56f98SSadaf Ebrahimi     ssl->in_ctr = original_in_ctr;
3402*62c56f98SSadaf Ebrahimi 
3403*62c56f98SSadaf Ebrahimi     return ret;
3404*62c56f98SSadaf Ebrahimi }
3405*62c56f98SSadaf Ebrahimi 
3406*62c56f98SSadaf Ebrahimi /*
3407*62c56f98SSadaf Ebrahimi  * Return 0 if sequence number is acceptable, -1 otherwise
3408*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const * ssl)3409*62c56f98SSadaf Ebrahimi int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
3410*62c56f98SSadaf Ebrahimi {
3411*62c56f98SSadaf Ebrahimi     uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
3412*62c56f98SSadaf Ebrahimi     uint64_t bit;
3413*62c56f98SSadaf Ebrahimi 
3414*62c56f98SSadaf Ebrahimi     if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3415*62c56f98SSadaf Ebrahimi         return 0;
3416*62c56f98SSadaf Ebrahimi     }
3417*62c56f98SSadaf Ebrahimi 
3418*62c56f98SSadaf Ebrahimi     if (rec_seqnum > ssl->in_window_top) {
3419*62c56f98SSadaf Ebrahimi         return 0;
3420*62c56f98SSadaf Ebrahimi     }
3421*62c56f98SSadaf Ebrahimi 
3422*62c56f98SSadaf Ebrahimi     bit = ssl->in_window_top - rec_seqnum;
3423*62c56f98SSadaf Ebrahimi 
3424*62c56f98SSadaf Ebrahimi     if (bit >= 64) {
3425*62c56f98SSadaf Ebrahimi         return -1;
3426*62c56f98SSadaf Ebrahimi     }
3427*62c56f98SSadaf Ebrahimi 
3428*62c56f98SSadaf Ebrahimi     if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3429*62c56f98SSadaf Ebrahimi         return -1;
3430*62c56f98SSadaf Ebrahimi     }
3431*62c56f98SSadaf Ebrahimi 
3432*62c56f98SSadaf Ebrahimi     return 0;
3433*62c56f98SSadaf Ebrahimi }
3434*62c56f98SSadaf Ebrahimi 
3435*62c56f98SSadaf Ebrahimi /*
3436*62c56f98SSadaf Ebrahimi  * Update replay window on new validated record
3437*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context * ssl)3438*62c56f98SSadaf Ebrahimi void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
3439*62c56f98SSadaf Ebrahimi {
3440*62c56f98SSadaf Ebrahimi     uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
3441*62c56f98SSadaf Ebrahimi 
3442*62c56f98SSadaf Ebrahimi     if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3443*62c56f98SSadaf Ebrahimi         return;
3444*62c56f98SSadaf Ebrahimi     }
3445*62c56f98SSadaf Ebrahimi 
3446*62c56f98SSadaf Ebrahimi     if (rec_seqnum > ssl->in_window_top) {
3447*62c56f98SSadaf Ebrahimi         /* Update window_top and the contents of the window */
3448*62c56f98SSadaf Ebrahimi         uint64_t shift = rec_seqnum - ssl->in_window_top;
3449*62c56f98SSadaf Ebrahimi 
3450*62c56f98SSadaf Ebrahimi         if (shift >= 64) {
3451*62c56f98SSadaf Ebrahimi             ssl->in_window = 1;
3452*62c56f98SSadaf Ebrahimi         } else {
3453*62c56f98SSadaf Ebrahimi             ssl->in_window <<= shift;
3454*62c56f98SSadaf Ebrahimi             ssl->in_window |= 1;
3455*62c56f98SSadaf Ebrahimi         }
3456*62c56f98SSadaf Ebrahimi 
3457*62c56f98SSadaf Ebrahimi         ssl->in_window_top = rec_seqnum;
3458*62c56f98SSadaf Ebrahimi     } else {
3459*62c56f98SSadaf Ebrahimi         /* Mark that number as seen in the current window */
3460*62c56f98SSadaf Ebrahimi         uint64_t bit = ssl->in_window_top - rec_seqnum;
3461*62c56f98SSadaf Ebrahimi 
3462*62c56f98SSadaf Ebrahimi         if (bit < 64) { /* Always true, but be extra sure */
3463*62c56f98SSadaf Ebrahimi             ssl->in_window |= (uint64_t) 1 << bit;
3464*62c56f98SSadaf Ebrahimi         }
3465*62c56f98SSadaf Ebrahimi     }
3466*62c56f98SSadaf Ebrahimi }
3467*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3468*62c56f98SSadaf Ebrahimi 
3469*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3470*62c56f98SSadaf Ebrahimi /*
3471*62c56f98SSadaf Ebrahimi  * Check if a datagram looks like a ClientHello with a valid cookie,
3472*62c56f98SSadaf Ebrahimi  * and if it doesn't, generate a HelloVerifyRequest message.
3473*62c56f98SSadaf Ebrahimi  * Both input and output include full DTLS headers.
3474*62c56f98SSadaf Ebrahimi  *
3475*62c56f98SSadaf Ebrahimi  * - if cookie is valid, return 0
3476*62c56f98SSadaf Ebrahimi  * - if ClientHello looks superficially valid but cookie is not,
3477*62c56f98SSadaf Ebrahimi  *   fill obuf and set olen, then
3478*62c56f98SSadaf Ebrahimi  *   return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3479*62c56f98SSadaf Ebrahimi  * - otherwise return a specific error code
3480*62c56f98SSadaf Ebrahimi  */
3481*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
3482*62c56f98SSadaf Ebrahimi MBEDTLS_STATIC_TESTABLE
mbedtls_ssl_check_dtls_clihlo_cookie(mbedtls_ssl_context * ssl,const unsigned char * cli_id,size_t cli_id_len,const unsigned char * in,size_t in_len,unsigned char * obuf,size_t buf_len,size_t * olen)3483*62c56f98SSadaf Ebrahimi int mbedtls_ssl_check_dtls_clihlo_cookie(
3484*62c56f98SSadaf Ebrahimi     mbedtls_ssl_context *ssl,
3485*62c56f98SSadaf Ebrahimi     const unsigned char *cli_id, size_t cli_id_len,
3486*62c56f98SSadaf Ebrahimi     const unsigned char *in, size_t in_len,
3487*62c56f98SSadaf Ebrahimi     unsigned char *obuf, size_t buf_len, size_t *olen)
3488*62c56f98SSadaf Ebrahimi {
3489*62c56f98SSadaf Ebrahimi     size_t sid_len, cookie_len, epoch, fragment_offset;
3490*62c56f98SSadaf Ebrahimi     unsigned char *p;
3491*62c56f98SSadaf Ebrahimi 
3492*62c56f98SSadaf Ebrahimi     /*
3493*62c56f98SSadaf Ebrahimi      * Structure of ClientHello with record and handshake headers,
3494*62c56f98SSadaf Ebrahimi      * and expected values. We don't need to check a lot, more checks will be
3495*62c56f98SSadaf Ebrahimi      * done when actually parsing the ClientHello - skipping those checks
3496*62c56f98SSadaf Ebrahimi      * avoids code duplication and does not make cookie forging any easier.
3497*62c56f98SSadaf Ebrahimi      *
3498*62c56f98SSadaf Ebrahimi      *  0-0  ContentType type;                  copied, must be handshake
3499*62c56f98SSadaf Ebrahimi      *  1-2  ProtocolVersion version;           copied
3500*62c56f98SSadaf Ebrahimi      *  3-4  uint16 epoch;                      copied, must be 0
3501*62c56f98SSadaf Ebrahimi      *  5-10 uint48 sequence_number;            copied
3502*62c56f98SSadaf Ebrahimi      * 11-12 uint16 length;                     (ignored)
3503*62c56f98SSadaf Ebrahimi      *
3504*62c56f98SSadaf Ebrahimi      * 13-13 HandshakeType msg_type;            (ignored)
3505*62c56f98SSadaf Ebrahimi      * 14-16 uint24 length;                     (ignored)
3506*62c56f98SSadaf Ebrahimi      * 17-18 uint16 message_seq;                copied
3507*62c56f98SSadaf Ebrahimi      * 19-21 uint24 fragment_offset;            copied, must be 0
3508*62c56f98SSadaf Ebrahimi      * 22-24 uint24 fragment_length;            (ignored)
3509*62c56f98SSadaf Ebrahimi      *
3510*62c56f98SSadaf Ebrahimi      * 25-26 ProtocolVersion client_version;    (ignored)
3511*62c56f98SSadaf Ebrahimi      * 27-58 Random random;                     (ignored)
3512*62c56f98SSadaf Ebrahimi      * 59-xx SessionID session_id;              1 byte len + sid_len content
3513*62c56f98SSadaf Ebrahimi      * 60+   opaque cookie<0..2^8-1>;           1 byte len + content
3514*62c56f98SSadaf Ebrahimi      *       ...
3515*62c56f98SSadaf Ebrahimi      *
3516*62c56f98SSadaf Ebrahimi      * Minimum length is 61 bytes.
3517*62c56f98SSadaf Ebrahimi      */
3518*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3519*62c56f98SSadaf Ebrahimi                               (unsigned) in_len));
3520*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3521*62c56f98SSadaf Ebrahimi     if (in_len < 61) {
3522*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3523*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_DECODE_ERROR;
3524*62c56f98SSadaf Ebrahimi     }
3525*62c56f98SSadaf Ebrahimi 
3526*62c56f98SSadaf Ebrahimi     epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3527*62c56f98SSadaf Ebrahimi     fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
3528*62c56f98SSadaf Ebrahimi 
3529*62c56f98SSadaf Ebrahimi     if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3530*62c56f98SSadaf Ebrahimi         fragment_offset != 0) {
3531*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3532*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("    type=%u epoch=%u fragment_offset=%u",
3533*62c56f98SSadaf Ebrahimi                                   in[0], (unsigned) epoch,
3534*62c56f98SSadaf Ebrahimi                                   (unsigned) fragment_offset));
3535*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_DECODE_ERROR;
3536*62c56f98SSadaf Ebrahimi     }
3537*62c56f98SSadaf Ebrahimi 
3538*62c56f98SSadaf Ebrahimi     sid_len = in[59];
3539*62c56f98SSadaf Ebrahimi     if (59 + 1 + sid_len + 1 > in_len) {
3540*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3541*62c56f98SSadaf Ebrahimi                                   (unsigned) sid_len,
3542*62c56f98SSadaf Ebrahimi                                   (unsigned) in_len - 61));
3543*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_DECODE_ERROR;
3544*62c56f98SSadaf Ebrahimi     }
3545*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3546*62c56f98SSadaf Ebrahimi                           in + 60, sid_len);
3547*62c56f98SSadaf Ebrahimi 
3548*62c56f98SSadaf Ebrahimi     cookie_len = in[60 + sid_len];
3549*62c56f98SSadaf Ebrahimi     if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3550*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3551*62c56f98SSadaf Ebrahimi                                   (unsigned) cookie_len,
3552*62c56f98SSadaf Ebrahimi                                   (unsigned) (in_len - sid_len - 61)));
3553*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_DECODE_ERROR;
3554*62c56f98SSadaf Ebrahimi     }
3555*62c56f98SSadaf Ebrahimi 
3556*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3557*62c56f98SSadaf Ebrahimi                           in + sid_len + 61, cookie_len);
3558*62c56f98SSadaf Ebrahimi     if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3559*62c56f98SSadaf Ebrahimi                                   in + sid_len + 61, cookie_len,
3560*62c56f98SSadaf Ebrahimi                                   cli_id, cli_id_len) == 0) {
3561*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3562*62c56f98SSadaf Ebrahimi         return 0;
3563*62c56f98SSadaf Ebrahimi     }
3564*62c56f98SSadaf Ebrahimi 
3565*62c56f98SSadaf Ebrahimi     /*
3566*62c56f98SSadaf Ebrahimi      * If we get here, we've got an invalid cookie, let's prepare HVR.
3567*62c56f98SSadaf Ebrahimi      *
3568*62c56f98SSadaf Ebrahimi      *  0-0  ContentType type;                  copied
3569*62c56f98SSadaf Ebrahimi      *  1-2  ProtocolVersion version;           copied
3570*62c56f98SSadaf Ebrahimi      *  3-4  uint16 epoch;                      copied
3571*62c56f98SSadaf Ebrahimi      *  5-10 uint48 sequence_number;            copied
3572*62c56f98SSadaf Ebrahimi      * 11-12 uint16 length;                     olen - 13
3573*62c56f98SSadaf Ebrahimi      *
3574*62c56f98SSadaf Ebrahimi      * 13-13 HandshakeType msg_type;            hello_verify_request
3575*62c56f98SSadaf Ebrahimi      * 14-16 uint24 length;                     olen - 25
3576*62c56f98SSadaf Ebrahimi      * 17-18 uint16 message_seq;                copied
3577*62c56f98SSadaf Ebrahimi      * 19-21 uint24 fragment_offset;            copied
3578*62c56f98SSadaf Ebrahimi      * 22-24 uint24 fragment_length;            olen - 25
3579*62c56f98SSadaf Ebrahimi      *
3580*62c56f98SSadaf Ebrahimi      * 25-26 ProtocolVersion server_version;    0xfe 0xff
3581*62c56f98SSadaf Ebrahimi      * 27-27 opaque cookie<0..2^8-1>;           cookie_len = olen - 27, cookie
3582*62c56f98SSadaf Ebrahimi      *
3583*62c56f98SSadaf Ebrahimi      * Minimum length is 28.
3584*62c56f98SSadaf Ebrahimi      */
3585*62c56f98SSadaf Ebrahimi     if (buf_len < 28) {
3586*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3587*62c56f98SSadaf Ebrahimi     }
3588*62c56f98SSadaf Ebrahimi 
3589*62c56f98SSadaf Ebrahimi     /* Copy most fields and adapt others */
3590*62c56f98SSadaf Ebrahimi     memcpy(obuf, in, 25);
3591*62c56f98SSadaf Ebrahimi     obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3592*62c56f98SSadaf Ebrahimi     obuf[25] = 0xfe;
3593*62c56f98SSadaf Ebrahimi     obuf[26] = 0xff;
3594*62c56f98SSadaf Ebrahimi 
3595*62c56f98SSadaf Ebrahimi     /* Generate and write actual cookie */
3596*62c56f98SSadaf Ebrahimi     p = obuf + 28;
3597*62c56f98SSadaf Ebrahimi     if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3598*62c56f98SSadaf Ebrahimi                                   &p, obuf + buf_len,
3599*62c56f98SSadaf Ebrahimi                                   cli_id, cli_id_len) != 0) {
3600*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3601*62c56f98SSadaf Ebrahimi     }
3602*62c56f98SSadaf Ebrahimi 
3603*62c56f98SSadaf Ebrahimi     *olen = p - obuf;
3604*62c56f98SSadaf Ebrahimi 
3605*62c56f98SSadaf Ebrahimi     /* Go back and fill length fields */
3606*62c56f98SSadaf Ebrahimi     obuf[27] = (unsigned char) (*olen - 28);
3607*62c56f98SSadaf Ebrahimi 
3608*62c56f98SSadaf Ebrahimi     obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3609*62c56f98SSadaf Ebrahimi     obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3610*62c56f98SSadaf Ebrahimi     obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
3611*62c56f98SSadaf Ebrahimi 
3612*62c56f98SSadaf Ebrahimi     MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
3613*62c56f98SSadaf Ebrahimi 
3614*62c56f98SSadaf Ebrahimi     return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
3615*62c56f98SSadaf Ebrahimi }
3616*62c56f98SSadaf Ebrahimi 
3617*62c56f98SSadaf Ebrahimi /*
3618*62c56f98SSadaf Ebrahimi  * Handle possible client reconnect with the same UDP quadruplet
3619*62c56f98SSadaf Ebrahimi  * (RFC 6347 Section 4.2.8).
3620*62c56f98SSadaf Ebrahimi  *
3621*62c56f98SSadaf Ebrahimi  * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3622*62c56f98SSadaf Ebrahimi  * that looks like a ClientHello.
3623*62c56f98SSadaf Ebrahimi  *
3624*62c56f98SSadaf Ebrahimi  * - if the input looks like a ClientHello without cookies,
3625*62c56f98SSadaf Ebrahimi  *   send back HelloVerifyRequest, then return 0
3626*62c56f98SSadaf Ebrahimi  * - if the input looks like a ClientHello with a valid cookie,
3627*62c56f98SSadaf Ebrahimi  *   reset the session of the current context, and
3628*62c56f98SSadaf Ebrahimi  *   return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
3629*62c56f98SSadaf Ebrahimi  * - if anything goes wrong, return a specific error code
3630*62c56f98SSadaf Ebrahimi  *
3631*62c56f98SSadaf Ebrahimi  * This function is called (through ssl_check_client_reconnect()) when an
3632*62c56f98SSadaf Ebrahimi  * unexpected record is found in ssl_get_next_record(), which will discard the
3633*62c56f98SSadaf Ebrahimi  * record if we return 0, and bubble up the return value otherwise (this
3634*62c56f98SSadaf Ebrahimi  * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3635*62c56f98SSadaf Ebrahimi  * errors, and is the right thing to do in both cases).
3636*62c56f98SSadaf Ebrahimi  */
3637*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_handle_possible_reconnect(mbedtls_ssl_context * ssl)3638*62c56f98SSadaf Ebrahimi static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
3639*62c56f98SSadaf Ebrahimi {
3640*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3641*62c56f98SSadaf Ebrahimi     size_t len;
3642*62c56f98SSadaf Ebrahimi 
3643*62c56f98SSadaf Ebrahimi     if (ssl->conf->f_cookie_write == NULL ||
3644*62c56f98SSadaf Ebrahimi         ssl->conf->f_cookie_check == NULL) {
3645*62c56f98SSadaf Ebrahimi         /* If we can't use cookies to verify reachability of the peer,
3646*62c56f98SSadaf Ebrahimi          * drop the record. */
3647*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3648*62c56f98SSadaf Ebrahimi                                   "can't check reconnect validity"));
3649*62c56f98SSadaf Ebrahimi         return 0;
3650*62c56f98SSadaf Ebrahimi     }
3651*62c56f98SSadaf Ebrahimi 
3652*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_check_dtls_clihlo_cookie(
3653*62c56f98SSadaf Ebrahimi         ssl,
3654*62c56f98SSadaf Ebrahimi         ssl->cli_id, ssl->cli_id_len,
3655*62c56f98SSadaf Ebrahimi         ssl->in_buf, ssl->in_left,
3656*62c56f98SSadaf Ebrahimi         ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
3657*62c56f98SSadaf Ebrahimi 
3658*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
3659*62c56f98SSadaf Ebrahimi 
3660*62c56f98SSadaf Ebrahimi     if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
3661*62c56f98SSadaf Ebrahimi         int send_ret;
3662*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3663*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3664*62c56f98SSadaf Ebrahimi                               ssl->out_buf, len);
3665*62c56f98SSadaf Ebrahimi         /* Don't check write errors as we can't do anything here.
3666*62c56f98SSadaf Ebrahimi          * If the error is permanent we'll catch it later,
3667*62c56f98SSadaf Ebrahimi          * if it's not, then hopefully it'll work next time. */
3668*62c56f98SSadaf Ebrahimi         send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3669*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
3670*62c56f98SSadaf Ebrahimi         (void) send_ret;
3671*62c56f98SSadaf Ebrahimi 
3672*62c56f98SSadaf Ebrahimi         return 0;
3673*62c56f98SSadaf Ebrahimi     }
3674*62c56f98SSadaf Ebrahimi 
3675*62c56f98SSadaf Ebrahimi     if (ret == 0) {
3676*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3677*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3678*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3679*62c56f98SSadaf Ebrahimi             return ret;
3680*62c56f98SSadaf Ebrahimi         }
3681*62c56f98SSadaf Ebrahimi 
3682*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
3683*62c56f98SSadaf Ebrahimi     }
3684*62c56f98SSadaf Ebrahimi 
3685*62c56f98SSadaf Ebrahimi     return ret;
3686*62c56f98SSadaf Ebrahimi }
3687*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
3688*62c56f98SSadaf Ebrahimi 
3689*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_check_record_type(uint8_t record_type)3690*62c56f98SSadaf Ebrahimi static int ssl_check_record_type(uint8_t record_type)
3691*62c56f98SSadaf Ebrahimi {
3692*62c56f98SSadaf Ebrahimi     if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3693*62c56f98SSadaf Ebrahimi         record_type != MBEDTLS_SSL_MSG_ALERT &&
3694*62c56f98SSadaf Ebrahimi         record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3695*62c56f98SSadaf Ebrahimi         record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3696*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
3697*62c56f98SSadaf Ebrahimi     }
3698*62c56f98SSadaf Ebrahimi 
3699*62c56f98SSadaf Ebrahimi     return 0;
3700*62c56f98SSadaf Ebrahimi }
3701*62c56f98SSadaf Ebrahimi 
3702*62c56f98SSadaf Ebrahimi /*
3703*62c56f98SSadaf Ebrahimi  * ContentType type;
3704*62c56f98SSadaf Ebrahimi  * ProtocolVersion version;
3705*62c56f98SSadaf Ebrahimi  * uint16 epoch;            // DTLS only
3706*62c56f98SSadaf Ebrahimi  * uint48 sequence_number;  // DTLS only
3707*62c56f98SSadaf Ebrahimi  * uint16 length;
3708*62c56f98SSadaf Ebrahimi  *
3709*62c56f98SSadaf Ebrahimi  * Return 0 if header looks sane (and, for DTLS, the record is expected)
3710*62c56f98SSadaf Ebrahimi  * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
3711*62c56f98SSadaf Ebrahimi  * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3712*62c56f98SSadaf Ebrahimi  *
3713*62c56f98SSadaf Ebrahimi  * With DTLS, mbedtls_ssl_read_record() will:
3714*62c56f98SSadaf Ebrahimi  * 1. proceed with the record if this function returns 0
3715*62c56f98SSadaf Ebrahimi  * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3716*62c56f98SSadaf Ebrahimi  * 3. return CLIENT_RECONNECT if this function return that value
3717*62c56f98SSadaf Ebrahimi  * 4. drop the whole datagram if this function returns anything else.
3718*62c56f98SSadaf Ebrahimi  * Point 2 is needed when the peer is resending, and we have already received
3719*62c56f98SSadaf Ebrahimi  * the first record from a datagram but are still waiting for the others.
3720*62c56f98SSadaf Ebrahimi  */
3721*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_parse_record_header(mbedtls_ssl_context const * ssl,unsigned char * buf,size_t len,mbedtls_record * rec)3722*62c56f98SSadaf Ebrahimi static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3723*62c56f98SSadaf Ebrahimi                                    unsigned char *buf,
3724*62c56f98SSadaf Ebrahimi                                    size_t len,
3725*62c56f98SSadaf Ebrahimi                                    mbedtls_record *rec)
3726*62c56f98SSadaf Ebrahimi {
3727*62c56f98SSadaf Ebrahimi     mbedtls_ssl_protocol_version tls_version;
3728*62c56f98SSadaf Ebrahimi 
3729*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_type_offset    = 0;
3730*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_type_len       = 1;
3731*62c56f98SSadaf Ebrahimi 
3732*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3733*62c56f98SSadaf Ebrahimi                                           rec_hdr_type_len;
3734*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_version_len    = 2;
3735*62c56f98SSadaf Ebrahimi 
3736*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_ctr_len        = 8;
3737*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3738*62c56f98SSadaf Ebrahimi     uint32_t     rec_epoch;
3739*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_ctr_offset     = rec_hdr_version_offset +
3740*62c56f98SSadaf Ebrahimi                                           rec_hdr_version_len;
3741*62c56f98SSadaf Ebrahimi 
3742*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3743*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_cid_offset     = rec_hdr_ctr_offset +
3744*62c56f98SSadaf Ebrahimi                                           rec_hdr_ctr_len;
3745*62c56f98SSadaf Ebrahimi     size_t       rec_hdr_cid_len        = 0;
3746*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3747*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3748*62c56f98SSadaf Ebrahimi 
3749*62c56f98SSadaf Ebrahimi     size_t       rec_hdr_len_offset; /* To be determined */
3750*62c56f98SSadaf Ebrahimi     size_t const rec_hdr_len_len    = 2;
3751*62c56f98SSadaf Ebrahimi 
3752*62c56f98SSadaf Ebrahimi     /*
3753*62c56f98SSadaf Ebrahimi      * Check minimum lengths for record header.
3754*62c56f98SSadaf Ebrahimi      */
3755*62c56f98SSadaf Ebrahimi 
3756*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3757*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3758*62c56f98SSadaf Ebrahimi         rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3759*62c56f98SSadaf Ebrahimi     } else
3760*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3761*62c56f98SSadaf Ebrahimi     {
3762*62c56f98SSadaf Ebrahimi         rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3763*62c56f98SSadaf Ebrahimi     }
3764*62c56f98SSadaf Ebrahimi 
3765*62c56f98SSadaf Ebrahimi     if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3766*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1,
3767*62c56f98SSadaf Ebrahimi                               (
3768*62c56f98SSadaf Ebrahimi                                   "datagram of length %u too small to hold DTLS record header of length %u",
3769*62c56f98SSadaf Ebrahimi                                   (unsigned) len,
3770*62c56f98SSadaf Ebrahimi                                   (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3771*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
3772*62c56f98SSadaf Ebrahimi     }
3773*62c56f98SSadaf Ebrahimi 
3774*62c56f98SSadaf Ebrahimi     /*
3775*62c56f98SSadaf Ebrahimi      * Parse and validate record content type
3776*62c56f98SSadaf Ebrahimi      */
3777*62c56f98SSadaf Ebrahimi 
3778*62c56f98SSadaf Ebrahimi     rec->type = buf[rec_hdr_type_offset];
3779*62c56f98SSadaf Ebrahimi 
3780*62c56f98SSadaf Ebrahimi     /* Check record content type */
3781*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3782*62c56f98SSadaf Ebrahimi     rec->cid_len = 0;
3783*62c56f98SSadaf Ebrahimi 
3784*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3785*62c56f98SSadaf Ebrahimi         ssl->conf->cid_len != 0                                &&
3786*62c56f98SSadaf Ebrahimi         rec->type == MBEDTLS_SSL_MSG_CID) {
3787*62c56f98SSadaf Ebrahimi         /* Shift pointers to account for record header including CID
3788*62c56f98SSadaf Ebrahimi          * struct {
3789*62c56f98SSadaf Ebrahimi          *   ContentType outer_type = tls12_cid;
3790*62c56f98SSadaf Ebrahimi          *   ProtocolVersion version;
3791*62c56f98SSadaf Ebrahimi          *   uint16 epoch;
3792*62c56f98SSadaf Ebrahimi          *   uint48 sequence_number;
3793*62c56f98SSadaf Ebrahimi          *   opaque cid[cid_length]; // Additional field compared to
3794*62c56f98SSadaf Ebrahimi          *                           // default DTLS record format
3795*62c56f98SSadaf Ebrahimi          *   uint16 length;
3796*62c56f98SSadaf Ebrahimi          *   opaque enc_content[DTLSCiphertext.length];
3797*62c56f98SSadaf Ebrahimi          * } DTLSCiphertext;
3798*62c56f98SSadaf Ebrahimi          */
3799*62c56f98SSadaf Ebrahimi 
3800*62c56f98SSadaf Ebrahimi         /* So far, we only support static CID lengths
3801*62c56f98SSadaf Ebrahimi          * fixed in the configuration. */
3802*62c56f98SSadaf Ebrahimi         rec_hdr_cid_len = ssl->conf->cid_len;
3803*62c56f98SSadaf Ebrahimi         rec_hdr_len_offset += rec_hdr_cid_len;
3804*62c56f98SSadaf Ebrahimi 
3805*62c56f98SSadaf Ebrahimi         if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3806*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
3807*62c56f98SSadaf Ebrahimi                                   (
3808*62c56f98SSadaf Ebrahimi                                       "datagram of length %u too small to hold DTLS record header including CID, length %u",
3809*62c56f98SSadaf Ebrahimi                                       (unsigned) len,
3810*62c56f98SSadaf Ebrahimi                                       (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3811*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
3812*62c56f98SSadaf Ebrahimi         }
3813*62c56f98SSadaf Ebrahimi 
3814*62c56f98SSadaf Ebrahimi         /* configured CID len is guaranteed at most 255, see
3815*62c56f98SSadaf Ebrahimi          * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3816*62c56f98SSadaf Ebrahimi         rec->cid_len = (uint8_t) rec_hdr_cid_len;
3817*62c56f98SSadaf Ebrahimi         memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3818*62c56f98SSadaf Ebrahimi     } else
3819*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3820*62c56f98SSadaf Ebrahimi     {
3821*62c56f98SSadaf Ebrahimi         if (ssl_check_record_type(rec->type)) {
3822*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3823*62c56f98SSadaf Ebrahimi                                       (unsigned) rec->type));
3824*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
3825*62c56f98SSadaf Ebrahimi         }
3826*62c56f98SSadaf Ebrahimi     }
3827*62c56f98SSadaf Ebrahimi 
3828*62c56f98SSadaf Ebrahimi     /*
3829*62c56f98SSadaf Ebrahimi      * Parse and validate record version
3830*62c56f98SSadaf Ebrahimi      */
3831*62c56f98SSadaf Ebrahimi     rec->ver[0] = buf[rec_hdr_version_offset + 0];
3832*62c56f98SSadaf Ebrahimi     rec->ver[1] = buf[rec_hdr_version_offset + 1];
3833*62c56f98SSadaf Ebrahimi     tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3834*62c56f98SSadaf Ebrahimi         buf + rec_hdr_version_offset,
3835*62c56f98SSadaf Ebrahimi         ssl->conf->transport);
3836*62c56f98SSadaf Ebrahimi 
3837*62c56f98SSadaf Ebrahimi     if (tls_version > ssl->conf->max_tls_version) {
3838*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3839*62c56f98SSadaf Ebrahimi                                   (unsigned) tls_version,
3840*62c56f98SSadaf Ebrahimi                                   (unsigned) ssl->conf->max_tls_version));
3841*62c56f98SSadaf Ebrahimi 
3842*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
3843*62c56f98SSadaf Ebrahimi     }
3844*62c56f98SSadaf Ebrahimi     /*
3845*62c56f98SSadaf Ebrahimi      * Parse/Copy record sequence number.
3846*62c56f98SSadaf Ebrahimi      */
3847*62c56f98SSadaf Ebrahimi 
3848*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3849*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3850*62c56f98SSadaf Ebrahimi         /* Copy explicit record sequence number from input buffer. */
3851*62c56f98SSadaf Ebrahimi         memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3852*62c56f98SSadaf Ebrahimi                rec_hdr_ctr_len);
3853*62c56f98SSadaf Ebrahimi     } else
3854*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3855*62c56f98SSadaf Ebrahimi     {
3856*62c56f98SSadaf Ebrahimi         /* Copy implicit record sequence number from SSL context structure. */
3857*62c56f98SSadaf Ebrahimi         memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
3858*62c56f98SSadaf Ebrahimi     }
3859*62c56f98SSadaf Ebrahimi 
3860*62c56f98SSadaf Ebrahimi     /*
3861*62c56f98SSadaf Ebrahimi      * Parse record length.
3862*62c56f98SSadaf Ebrahimi      */
3863*62c56f98SSadaf Ebrahimi 
3864*62c56f98SSadaf Ebrahimi     rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
3865*62c56f98SSadaf Ebrahimi     rec->data_len    = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3866*62c56f98SSadaf Ebrahimi                        ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3867*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
3868*62c56f98SSadaf Ebrahimi 
3869*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3870*62c56f98SSadaf Ebrahimi                               "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3871*62c56f98SSadaf Ebrahimi                               rec->type, (unsigned) tls_version, rec->data_len));
3872*62c56f98SSadaf Ebrahimi 
3873*62c56f98SSadaf Ebrahimi     rec->buf     = buf;
3874*62c56f98SSadaf Ebrahimi     rec->buf_len = rec->data_offset + rec->data_len;
3875*62c56f98SSadaf Ebrahimi 
3876*62c56f98SSadaf Ebrahimi     if (rec->data_len == 0) {
3877*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
3878*62c56f98SSadaf Ebrahimi     }
3879*62c56f98SSadaf Ebrahimi 
3880*62c56f98SSadaf Ebrahimi     /*
3881*62c56f98SSadaf Ebrahimi      * DTLS-related tests.
3882*62c56f98SSadaf Ebrahimi      * Check epoch before checking length constraint because
3883*62c56f98SSadaf Ebrahimi      * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3884*62c56f98SSadaf Ebrahimi      * message gets duplicated before the corresponding Finished message,
3885*62c56f98SSadaf Ebrahimi      * the second ChangeCipherSpec should be discarded because it belongs
3886*62c56f98SSadaf Ebrahimi      * to an old epoch, but not because its length is shorter than
3887*62c56f98SSadaf Ebrahimi      * the minimum record length for packets using the new record transform.
3888*62c56f98SSadaf Ebrahimi      * Note that these two kinds of failures are handled differently,
3889*62c56f98SSadaf Ebrahimi      * as an unexpected record is silently skipped but an invalid
3890*62c56f98SSadaf Ebrahimi      * record leads to the entire datagram being dropped.
3891*62c56f98SSadaf Ebrahimi      */
3892*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
3893*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3894*62c56f98SSadaf Ebrahimi         rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
3895*62c56f98SSadaf Ebrahimi 
3896*62c56f98SSadaf Ebrahimi         /* Check that the datagram is large enough to contain a record
3897*62c56f98SSadaf Ebrahimi          * of the advertised length. */
3898*62c56f98SSadaf Ebrahimi         if (len < rec->data_offset + rec->data_len) {
3899*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
3900*62c56f98SSadaf Ebrahimi                                   (
3901*62c56f98SSadaf Ebrahimi                                       "Datagram of length %u too small to contain record of advertised length %u.",
3902*62c56f98SSadaf Ebrahimi                                       (unsigned) len,
3903*62c56f98SSadaf Ebrahimi                                       (unsigned) (rec->data_offset + rec->data_len)));
3904*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
3905*62c56f98SSadaf Ebrahimi         }
3906*62c56f98SSadaf Ebrahimi 
3907*62c56f98SSadaf Ebrahimi         /* Records from other, non-matching epochs are silently discarded.
3908*62c56f98SSadaf Ebrahimi          * (The case of same-port Client reconnects must be considered in
3909*62c56f98SSadaf Ebrahimi          *  the caller). */
3910*62c56f98SSadaf Ebrahimi         if (rec_epoch != ssl->in_epoch) {
3911*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3912*62c56f98SSadaf Ebrahimi                                       "expected %u, received %lu",
3913*62c56f98SSadaf Ebrahimi                                       ssl->in_epoch, (unsigned long) rec_epoch));
3914*62c56f98SSadaf Ebrahimi 
3915*62c56f98SSadaf Ebrahimi             /* Records from the next epoch are considered for buffering
3916*62c56f98SSadaf Ebrahimi              * (concretely: early Finished messages). */
3917*62c56f98SSadaf Ebrahimi             if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3918*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3919*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
3920*62c56f98SSadaf Ebrahimi             }
3921*62c56f98SSadaf Ebrahimi 
3922*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
3923*62c56f98SSadaf Ebrahimi         }
3924*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3925*62c56f98SSadaf Ebrahimi         /* For records from the correct epoch, check whether their
3926*62c56f98SSadaf Ebrahimi          * sequence number has been seen before. */
3927*62c56f98SSadaf Ebrahimi         else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3928*62c56f98SSadaf Ebrahimi                                                       &rec->ctr[0]) != 0) {
3929*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3930*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
3931*62c56f98SSadaf Ebrahimi         }
3932*62c56f98SSadaf Ebrahimi #endif
3933*62c56f98SSadaf Ebrahimi     }
3934*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
3935*62c56f98SSadaf Ebrahimi 
3936*62c56f98SSadaf Ebrahimi     return 0;
3937*62c56f98SSadaf Ebrahimi }
3938*62c56f98SSadaf Ebrahimi 
3939*62c56f98SSadaf Ebrahimi 
3940*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3941*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_check_client_reconnect(mbedtls_ssl_context * ssl)3942*62c56f98SSadaf Ebrahimi static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
3943*62c56f98SSadaf Ebrahimi {
3944*62c56f98SSadaf Ebrahimi     unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
3945*62c56f98SSadaf Ebrahimi 
3946*62c56f98SSadaf Ebrahimi     /*
3947*62c56f98SSadaf Ebrahimi      * Check for an epoch 0 ClientHello. We can't use in_msg here to
3948*62c56f98SSadaf Ebrahimi      * access the first byte of record content (handshake type), as we
3949*62c56f98SSadaf Ebrahimi      * have an active transform (possibly iv_len != 0), so use the
3950*62c56f98SSadaf Ebrahimi      * fact that the record header len is 13 instead.
3951*62c56f98SSadaf Ebrahimi      */
3952*62c56f98SSadaf Ebrahimi     if (rec_epoch == 0 &&
3953*62c56f98SSadaf Ebrahimi         ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3954*62c56f98SSadaf Ebrahimi         mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3955*62c56f98SSadaf Ebrahimi         ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3956*62c56f98SSadaf Ebrahimi         ssl->in_left > 13 &&
3957*62c56f98SSadaf Ebrahimi         ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3958*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3959*62c56f98SSadaf Ebrahimi                                   "from the same port"));
3960*62c56f98SSadaf Ebrahimi         return ssl_handle_possible_reconnect(ssl);
3961*62c56f98SSadaf Ebrahimi     }
3962*62c56f98SSadaf Ebrahimi 
3963*62c56f98SSadaf Ebrahimi     return 0;
3964*62c56f98SSadaf Ebrahimi }
3965*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
3966*62c56f98SSadaf Ebrahimi 
3967*62c56f98SSadaf Ebrahimi /*
3968*62c56f98SSadaf Ebrahimi  * If applicable, decrypt record content
3969*62c56f98SSadaf Ebrahimi  */
3970*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_prepare_record_content(mbedtls_ssl_context * ssl,mbedtls_record * rec)3971*62c56f98SSadaf Ebrahimi static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3972*62c56f98SSadaf Ebrahimi                                       mbedtls_record *rec)
3973*62c56f98SSadaf Ebrahimi {
3974*62c56f98SSadaf Ebrahimi     int ret, done = 0;
3975*62c56f98SSadaf Ebrahimi 
3976*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3977*62c56f98SSadaf Ebrahimi                           rec->buf, rec->buf_len);
3978*62c56f98SSadaf Ebrahimi 
3979*62c56f98SSadaf Ebrahimi     /*
3980*62c56f98SSadaf Ebrahimi      * In TLS 1.3, always treat ChangeCipherSpec records
3981*62c56f98SSadaf Ebrahimi      * as unencrypted. The only thing we do with them is
3982*62c56f98SSadaf Ebrahimi      * check the length and content and ignore them.
3983*62c56f98SSadaf Ebrahimi      */
3984*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3985*62c56f98SSadaf Ebrahimi     if (ssl->transform_in != NULL &&
3986*62c56f98SSadaf Ebrahimi         ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3987*62c56f98SSadaf Ebrahimi         if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
3988*62c56f98SSadaf Ebrahimi             done = 1;
3989*62c56f98SSadaf Ebrahimi         }
3990*62c56f98SSadaf Ebrahimi     }
3991*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3992*62c56f98SSadaf Ebrahimi 
3993*62c56f98SSadaf Ebrahimi     if (!done && ssl->transform_in != NULL) {
3994*62c56f98SSadaf Ebrahimi         unsigned char const old_msg_type = rec->type;
3995*62c56f98SSadaf Ebrahimi 
3996*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3997*62c56f98SSadaf Ebrahimi                                            rec)) != 0) {
3998*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
3999*62c56f98SSadaf Ebrahimi 
4000*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4001*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
4002*62c56f98SSadaf Ebrahimi                 ssl->conf->ignore_unexpected_cid
4003*62c56f98SSadaf Ebrahimi                 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4004*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
4005*62c56f98SSadaf Ebrahimi                 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4006*62c56f98SSadaf Ebrahimi             }
4007*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4008*62c56f98SSadaf Ebrahimi 
4009*62c56f98SSadaf Ebrahimi             return ret;
4010*62c56f98SSadaf Ebrahimi         }
4011*62c56f98SSadaf Ebrahimi 
4012*62c56f98SSadaf Ebrahimi         if (old_msg_type != rec->type) {
4013*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4014*62c56f98SSadaf Ebrahimi                                       old_msg_type, rec->type));
4015*62c56f98SSadaf Ebrahimi         }
4016*62c56f98SSadaf Ebrahimi 
4017*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4018*62c56f98SSadaf Ebrahimi                               rec->buf + rec->data_offset, rec->data_len);
4019*62c56f98SSadaf Ebrahimi 
4020*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4021*62c56f98SSadaf Ebrahimi         /* We have already checked the record content type
4022*62c56f98SSadaf Ebrahimi          * in ssl_parse_record_header(), failing or silently
4023*62c56f98SSadaf Ebrahimi          * dropping the record in the case of an unknown type.
4024*62c56f98SSadaf Ebrahimi          *
4025*62c56f98SSadaf Ebrahimi          * Since with the use of CIDs, the record content type
4026*62c56f98SSadaf Ebrahimi          * might change during decryption, re-check the record
4027*62c56f98SSadaf Ebrahimi          * content type, but treat a failure as fatal this time. */
4028*62c56f98SSadaf Ebrahimi         if (ssl_check_record_type(rec->type)) {
4029*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4030*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
4031*62c56f98SSadaf Ebrahimi         }
4032*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4033*62c56f98SSadaf Ebrahimi 
4034*62c56f98SSadaf Ebrahimi         if (rec->data_len == 0) {
4035*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4036*62c56f98SSadaf Ebrahimi             if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4037*62c56f98SSadaf Ebrahimi                 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
4038*62c56f98SSadaf Ebrahimi                 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
4039*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4040*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INVALID_RECORD;
4041*62c56f98SSadaf Ebrahimi             }
4042*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4043*62c56f98SSadaf Ebrahimi 
4044*62c56f98SSadaf Ebrahimi             ssl->nb_zero++;
4045*62c56f98SSadaf Ebrahimi 
4046*62c56f98SSadaf Ebrahimi             /*
4047*62c56f98SSadaf Ebrahimi              * Three or more empty messages may be a DoS attack
4048*62c56f98SSadaf Ebrahimi              * (excessive CPU consumption).
4049*62c56f98SSadaf Ebrahimi              */
4050*62c56f98SSadaf Ebrahimi             if (ssl->nb_zero > 3) {
4051*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4052*62c56f98SSadaf Ebrahimi                                           "messages, possible DoS attack"));
4053*62c56f98SSadaf Ebrahimi                 /* Treat the records as if they were not properly authenticated,
4054*62c56f98SSadaf Ebrahimi                  * thereby failing the connection if we see more than allowed
4055*62c56f98SSadaf Ebrahimi                  * by the configured bad MAC threshold. */
4056*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INVALID_MAC;
4057*62c56f98SSadaf Ebrahimi             }
4058*62c56f98SSadaf Ebrahimi         } else {
4059*62c56f98SSadaf Ebrahimi             ssl->nb_zero = 0;
4060*62c56f98SSadaf Ebrahimi         }
4061*62c56f98SSadaf Ebrahimi 
4062*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4063*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4064*62c56f98SSadaf Ebrahimi             ; /* in_ctr read from peer, not maintained internally */
4065*62c56f98SSadaf Ebrahimi         } else
4066*62c56f98SSadaf Ebrahimi #endif
4067*62c56f98SSadaf Ebrahimi         {
4068*62c56f98SSadaf Ebrahimi             unsigned i;
4069*62c56f98SSadaf Ebrahimi             for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4070*62c56f98SSadaf Ebrahimi                  i > mbedtls_ssl_ep_len(ssl); i--) {
4071*62c56f98SSadaf Ebrahimi                 if (++ssl->in_ctr[i - 1] != 0) {
4072*62c56f98SSadaf Ebrahimi                     break;
4073*62c56f98SSadaf Ebrahimi                 }
4074*62c56f98SSadaf Ebrahimi             }
4075*62c56f98SSadaf Ebrahimi 
4076*62c56f98SSadaf Ebrahimi             /* The loop goes to its end iff the counter is wrapping */
4077*62c56f98SSadaf Ebrahimi             if (i == mbedtls_ssl_ep_len(ssl)) {
4078*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4079*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
4080*62c56f98SSadaf Ebrahimi             }
4081*62c56f98SSadaf Ebrahimi         }
4082*62c56f98SSadaf Ebrahimi 
4083*62c56f98SSadaf Ebrahimi     }
4084*62c56f98SSadaf Ebrahimi 
4085*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4086*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4087*62c56f98SSadaf Ebrahimi         mbedtls_ssl_dtls_replay_update(ssl);
4088*62c56f98SSadaf Ebrahimi     }
4089*62c56f98SSadaf Ebrahimi #endif
4090*62c56f98SSadaf Ebrahimi 
4091*62c56f98SSadaf Ebrahimi     /* Check actual (decrypted) record content length against
4092*62c56f98SSadaf Ebrahimi      * configured maximum. */
4093*62c56f98SSadaf Ebrahimi     if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4094*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4095*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INVALID_RECORD;
4096*62c56f98SSadaf Ebrahimi     }
4097*62c56f98SSadaf Ebrahimi 
4098*62c56f98SSadaf Ebrahimi     return 0;
4099*62c56f98SSadaf Ebrahimi }
4100*62c56f98SSadaf Ebrahimi 
4101*62c56f98SSadaf Ebrahimi /*
4102*62c56f98SSadaf Ebrahimi  * Read a record.
4103*62c56f98SSadaf Ebrahimi  *
4104*62c56f98SSadaf Ebrahimi  * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4105*62c56f98SSadaf Ebrahimi  * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4106*62c56f98SSadaf Ebrahimi  *
4107*62c56f98SSadaf Ebrahimi  */
4108*62c56f98SSadaf Ebrahimi 
4109*62c56f98SSadaf Ebrahimi /* Helper functions for mbedtls_ssl_read_record(). */
4110*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
4111*62c56f98SSadaf Ebrahimi static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
4112*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
4113*62c56f98SSadaf Ebrahimi static int ssl_get_next_record(mbedtls_ssl_context *ssl);
4114*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
4115*62c56f98SSadaf Ebrahimi static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
4116*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_read_record(mbedtls_ssl_context * ssl,unsigned update_hs_digest)4117*62c56f98SSadaf Ebrahimi int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4118*62c56f98SSadaf Ebrahimi                             unsigned update_hs_digest)
4119*62c56f98SSadaf Ebrahimi {
4120*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4121*62c56f98SSadaf Ebrahimi 
4122*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
4123*62c56f98SSadaf Ebrahimi 
4124*62c56f98SSadaf Ebrahimi     if (ssl->keep_current_message == 0) {
4125*62c56f98SSadaf Ebrahimi         do {
4126*62c56f98SSadaf Ebrahimi 
4127*62c56f98SSadaf Ebrahimi             ret = ssl_consume_current_message(ssl);
4128*62c56f98SSadaf Ebrahimi             if (ret != 0) {
4129*62c56f98SSadaf Ebrahimi                 return ret;
4130*62c56f98SSadaf Ebrahimi             }
4131*62c56f98SSadaf Ebrahimi 
4132*62c56f98SSadaf Ebrahimi             if (ssl_record_is_in_progress(ssl) == 0) {
4133*62c56f98SSadaf Ebrahimi                 int dtls_have_buffered = 0;
4134*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4135*62c56f98SSadaf Ebrahimi 
4136*62c56f98SSadaf Ebrahimi                 /* We only check for buffered messages if the
4137*62c56f98SSadaf Ebrahimi                  * current datagram is fully consumed. */
4138*62c56f98SSadaf Ebrahimi                 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4139*62c56f98SSadaf Ebrahimi                     ssl_next_record_is_in_datagram(ssl) == 0) {
4140*62c56f98SSadaf Ebrahimi                     if (ssl_load_buffered_message(ssl) == 0) {
4141*62c56f98SSadaf Ebrahimi                         dtls_have_buffered = 1;
4142*62c56f98SSadaf Ebrahimi                     }
4143*62c56f98SSadaf Ebrahimi                 }
4144*62c56f98SSadaf Ebrahimi 
4145*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
4146*62c56f98SSadaf Ebrahimi                 if (dtls_have_buffered == 0) {
4147*62c56f98SSadaf Ebrahimi                     ret = ssl_get_next_record(ssl);
4148*62c56f98SSadaf Ebrahimi                     if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
4149*62c56f98SSadaf Ebrahimi                         continue;
4150*62c56f98SSadaf Ebrahimi                     }
4151*62c56f98SSadaf Ebrahimi 
4152*62c56f98SSadaf Ebrahimi                     if (ret != 0) {
4153*62c56f98SSadaf Ebrahimi                         MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4154*62c56f98SSadaf Ebrahimi                         return ret;
4155*62c56f98SSadaf Ebrahimi                     }
4156*62c56f98SSadaf Ebrahimi                 }
4157*62c56f98SSadaf Ebrahimi             }
4158*62c56f98SSadaf Ebrahimi 
4159*62c56f98SSadaf Ebrahimi             ret = mbedtls_ssl_handle_message_type(ssl);
4160*62c56f98SSadaf Ebrahimi 
4161*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4162*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4163*62c56f98SSadaf Ebrahimi                 /* Buffer future message */
4164*62c56f98SSadaf Ebrahimi                 ret = ssl_buffer_message(ssl);
4165*62c56f98SSadaf Ebrahimi                 if (ret != 0) {
4166*62c56f98SSadaf Ebrahimi                     return ret;
4167*62c56f98SSadaf Ebrahimi                 }
4168*62c56f98SSadaf Ebrahimi 
4169*62c56f98SSadaf Ebrahimi                 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4170*62c56f98SSadaf Ebrahimi             }
4171*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
4172*62c56f98SSadaf Ebrahimi 
4173*62c56f98SSadaf Ebrahimi         } while (MBEDTLS_ERR_SSL_NON_FATAL           == ret  ||
4174*62c56f98SSadaf Ebrahimi                  MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
4175*62c56f98SSadaf Ebrahimi 
4176*62c56f98SSadaf Ebrahimi         if (0 != ret) {
4177*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4178*62c56f98SSadaf Ebrahimi             return ret;
4179*62c56f98SSadaf Ebrahimi         }
4180*62c56f98SSadaf Ebrahimi 
4181*62c56f98SSadaf Ebrahimi         if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4182*62c56f98SSadaf Ebrahimi             update_hs_digest == 1) {
4183*62c56f98SSadaf Ebrahimi             ret = mbedtls_ssl_update_handshake_status(ssl);
4184*62c56f98SSadaf Ebrahimi             if (0 != ret) {
4185*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4186*62c56f98SSadaf Ebrahimi                 return ret;
4187*62c56f98SSadaf Ebrahimi             }
4188*62c56f98SSadaf Ebrahimi         }
4189*62c56f98SSadaf Ebrahimi     } else {
4190*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
4191*62c56f98SSadaf Ebrahimi         ssl->keep_current_message = 0;
4192*62c56f98SSadaf Ebrahimi     }
4193*62c56f98SSadaf Ebrahimi 
4194*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
4195*62c56f98SSadaf Ebrahimi 
4196*62c56f98SSadaf Ebrahimi     return 0;
4197*62c56f98SSadaf Ebrahimi }
4198*62c56f98SSadaf Ebrahimi 
4199*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4200*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_next_record_is_in_datagram(mbedtls_ssl_context * ssl)4201*62c56f98SSadaf Ebrahimi static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
4202*62c56f98SSadaf Ebrahimi {
4203*62c56f98SSadaf Ebrahimi     if (ssl->in_left > ssl->next_record_offset) {
4204*62c56f98SSadaf Ebrahimi         return 1;
4205*62c56f98SSadaf Ebrahimi     }
4206*62c56f98SSadaf Ebrahimi 
4207*62c56f98SSadaf Ebrahimi     return 0;
4208*62c56f98SSadaf Ebrahimi }
4209*62c56f98SSadaf Ebrahimi 
4210*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_load_buffered_message(mbedtls_ssl_context * ssl)4211*62c56f98SSadaf Ebrahimi static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
4212*62c56f98SSadaf Ebrahimi {
4213*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4214*62c56f98SSadaf Ebrahimi     mbedtls_ssl_hs_buffer *hs_buf;
4215*62c56f98SSadaf Ebrahimi     int ret = 0;
4216*62c56f98SSadaf Ebrahimi 
4217*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
4218*62c56f98SSadaf Ebrahimi         return -1;
4219*62c56f98SSadaf Ebrahimi     }
4220*62c56f98SSadaf Ebrahimi 
4221*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
4222*62c56f98SSadaf Ebrahimi 
4223*62c56f98SSadaf Ebrahimi     if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4224*62c56f98SSadaf Ebrahimi         ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4225*62c56f98SSadaf Ebrahimi         /* Check if we have seen a ChangeCipherSpec before.
4226*62c56f98SSadaf Ebrahimi          * If yes, synthesize a CCS record. */
4227*62c56f98SSadaf Ebrahimi         if (!hs->buffering.seen_ccs) {
4228*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
4229*62c56f98SSadaf Ebrahimi             ret = -1;
4230*62c56f98SSadaf Ebrahimi             goto exit;
4231*62c56f98SSadaf Ebrahimi         }
4232*62c56f98SSadaf Ebrahimi 
4233*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
4234*62c56f98SSadaf Ebrahimi         ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4235*62c56f98SSadaf Ebrahimi         ssl->in_msglen = 1;
4236*62c56f98SSadaf Ebrahimi         ssl->in_msg[0] = 1;
4237*62c56f98SSadaf Ebrahimi 
4238*62c56f98SSadaf Ebrahimi         /* As long as they are equal, the exact value doesn't matter. */
4239*62c56f98SSadaf Ebrahimi         ssl->in_left            = 0;
4240*62c56f98SSadaf Ebrahimi         ssl->next_record_offset = 0;
4241*62c56f98SSadaf Ebrahimi 
4242*62c56f98SSadaf Ebrahimi         hs->buffering.seen_ccs = 0;
4243*62c56f98SSadaf Ebrahimi         goto exit;
4244*62c56f98SSadaf Ebrahimi     }
4245*62c56f98SSadaf Ebrahimi 
4246*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_DEBUG_C)
4247*62c56f98SSadaf Ebrahimi     /* Debug only */
4248*62c56f98SSadaf Ebrahimi     {
4249*62c56f98SSadaf Ebrahimi         unsigned offset;
4250*62c56f98SSadaf Ebrahimi         for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
4251*62c56f98SSadaf Ebrahimi             hs_buf = &hs->buffering.hs[offset];
4252*62c56f98SSadaf Ebrahimi             if (hs_buf->is_valid == 1) {
4253*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4254*62c56f98SSadaf Ebrahimi                                           hs->in_msg_seq + offset,
4255*62c56f98SSadaf Ebrahimi                                           hs_buf->is_complete ? "fully" : "partially"));
4256*62c56f98SSadaf Ebrahimi             }
4257*62c56f98SSadaf Ebrahimi         }
4258*62c56f98SSadaf Ebrahimi     }
4259*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_DEBUG_C */
4260*62c56f98SSadaf Ebrahimi 
4261*62c56f98SSadaf Ebrahimi     /* Check if we have buffered and/or fully reassembled the
4262*62c56f98SSadaf Ebrahimi      * next handshake message. */
4263*62c56f98SSadaf Ebrahimi     hs_buf = &hs->buffering.hs[0];
4264*62c56f98SSadaf Ebrahimi     if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
4265*62c56f98SSadaf Ebrahimi         /* Synthesize a record containing the buffered HS message. */
4266*62c56f98SSadaf Ebrahimi         size_t msg_len = (hs_buf->data[1] << 16) |
4267*62c56f98SSadaf Ebrahimi                          (hs_buf->data[2] << 8) |
4268*62c56f98SSadaf Ebrahimi                          hs_buf->data[3];
4269*62c56f98SSadaf Ebrahimi 
4270*62c56f98SSadaf Ebrahimi         /* Double-check that we haven't accidentally buffered
4271*62c56f98SSadaf Ebrahimi          * a message that doesn't fit into the input buffer. */
4272*62c56f98SSadaf Ebrahimi         if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4273*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4274*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4275*62c56f98SSadaf Ebrahimi         }
4276*62c56f98SSadaf Ebrahimi 
4277*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4278*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4279*62c56f98SSadaf Ebrahimi                               hs_buf->data, msg_len + 12);
4280*62c56f98SSadaf Ebrahimi 
4281*62c56f98SSadaf Ebrahimi         ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4282*62c56f98SSadaf Ebrahimi         ssl->in_hslen   = msg_len + 12;
4283*62c56f98SSadaf Ebrahimi         ssl->in_msglen  = msg_len + 12;
4284*62c56f98SSadaf Ebrahimi         memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
4285*62c56f98SSadaf Ebrahimi 
4286*62c56f98SSadaf Ebrahimi         ret = 0;
4287*62c56f98SSadaf Ebrahimi         goto exit;
4288*62c56f98SSadaf Ebrahimi     } else {
4289*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4290*62c56f98SSadaf Ebrahimi                                   hs->in_msg_seq));
4291*62c56f98SSadaf Ebrahimi     }
4292*62c56f98SSadaf Ebrahimi 
4293*62c56f98SSadaf Ebrahimi     ret = -1;
4294*62c56f98SSadaf Ebrahimi 
4295*62c56f98SSadaf Ebrahimi exit:
4296*62c56f98SSadaf Ebrahimi 
4297*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4298*62c56f98SSadaf Ebrahimi     return ret;
4299*62c56f98SSadaf Ebrahimi }
4300*62c56f98SSadaf Ebrahimi 
4301*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_buffer_make_space(mbedtls_ssl_context * ssl,size_t desired)4302*62c56f98SSadaf Ebrahimi static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4303*62c56f98SSadaf Ebrahimi                                  size_t desired)
4304*62c56f98SSadaf Ebrahimi {
4305*62c56f98SSadaf Ebrahimi     int offset;
4306*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4307*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4308*62c56f98SSadaf Ebrahimi                               (unsigned) desired));
4309*62c56f98SSadaf Ebrahimi 
4310*62c56f98SSadaf Ebrahimi     /* Get rid of future records epoch first, if such exist. */
4311*62c56f98SSadaf Ebrahimi     ssl_free_buffered_record(ssl);
4312*62c56f98SSadaf Ebrahimi 
4313*62c56f98SSadaf Ebrahimi     /* Check if we have enough space available now. */
4314*62c56f98SSadaf Ebrahimi     if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4315*62c56f98SSadaf Ebrahimi                     hs->buffering.total_bytes_buffered)) {
4316*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4317*62c56f98SSadaf Ebrahimi         return 0;
4318*62c56f98SSadaf Ebrahimi     }
4319*62c56f98SSadaf Ebrahimi 
4320*62c56f98SSadaf Ebrahimi     /* We don't have enough space to buffer the next expected handshake
4321*62c56f98SSadaf Ebrahimi      * message. Remove buffers used for future messages to gain space,
4322*62c56f98SSadaf Ebrahimi      * starting with the most distant one. */
4323*62c56f98SSadaf Ebrahimi     for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4324*62c56f98SSadaf Ebrahimi          offset >= 0; offset--) {
4325*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2,
4326*62c56f98SSadaf Ebrahimi                               (
4327*62c56f98SSadaf Ebrahimi                                   "Free buffering slot %d to make space for reassembly of next handshake message",
4328*62c56f98SSadaf Ebrahimi                                   offset));
4329*62c56f98SSadaf Ebrahimi 
4330*62c56f98SSadaf Ebrahimi         ssl_buffering_free_slot(ssl, (uint8_t) offset);
4331*62c56f98SSadaf Ebrahimi 
4332*62c56f98SSadaf Ebrahimi         /* Check if we have enough space available now. */
4333*62c56f98SSadaf Ebrahimi         if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4334*62c56f98SSadaf Ebrahimi                         hs->buffering.total_bytes_buffered)) {
4335*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4336*62c56f98SSadaf Ebrahimi             return 0;
4337*62c56f98SSadaf Ebrahimi         }
4338*62c56f98SSadaf Ebrahimi     }
4339*62c56f98SSadaf Ebrahimi 
4340*62c56f98SSadaf Ebrahimi     return -1;
4341*62c56f98SSadaf Ebrahimi }
4342*62c56f98SSadaf Ebrahimi 
4343*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_buffer_message(mbedtls_ssl_context * ssl)4344*62c56f98SSadaf Ebrahimi static int ssl_buffer_message(mbedtls_ssl_context *ssl)
4345*62c56f98SSadaf Ebrahimi {
4346*62c56f98SSadaf Ebrahimi     int ret = 0;
4347*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4348*62c56f98SSadaf Ebrahimi 
4349*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
4350*62c56f98SSadaf Ebrahimi         return 0;
4351*62c56f98SSadaf Ebrahimi     }
4352*62c56f98SSadaf Ebrahimi 
4353*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
4354*62c56f98SSadaf Ebrahimi 
4355*62c56f98SSadaf Ebrahimi     switch (ssl->in_msgtype) {
4356*62c56f98SSadaf Ebrahimi         case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4357*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
4358*62c56f98SSadaf Ebrahimi 
4359*62c56f98SSadaf Ebrahimi             hs->buffering.seen_ccs = 1;
4360*62c56f98SSadaf Ebrahimi             break;
4361*62c56f98SSadaf Ebrahimi 
4362*62c56f98SSadaf Ebrahimi         case MBEDTLS_SSL_MSG_HANDSHAKE:
4363*62c56f98SSadaf Ebrahimi         {
4364*62c56f98SSadaf Ebrahimi             unsigned recv_msg_seq_offset;
4365*62c56f98SSadaf Ebrahimi             unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
4366*62c56f98SSadaf Ebrahimi             mbedtls_ssl_hs_buffer *hs_buf;
4367*62c56f98SSadaf Ebrahimi             size_t msg_len = ssl->in_hslen - 12;
4368*62c56f98SSadaf Ebrahimi 
4369*62c56f98SSadaf Ebrahimi             /* We should never receive an old handshake
4370*62c56f98SSadaf Ebrahimi              * message - double-check nonetheless. */
4371*62c56f98SSadaf Ebrahimi             if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4372*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4373*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4374*62c56f98SSadaf Ebrahimi             }
4375*62c56f98SSadaf Ebrahimi 
4376*62c56f98SSadaf Ebrahimi             recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4377*62c56f98SSadaf Ebrahimi             if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
4378*62c56f98SSadaf Ebrahimi                 /* Silently ignore -- message too far in the future */
4379*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2,
4380*62c56f98SSadaf Ebrahimi                                       ("Ignore future HS message with sequence number %u, "
4381*62c56f98SSadaf Ebrahimi                                        "buffering window %u - %u",
4382*62c56f98SSadaf Ebrahimi                                        recv_msg_seq, ssl->handshake->in_msg_seq,
4383*62c56f98SSadaf Ebrahimi                                        ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4384*62c56f98SSadaf Ebrahimi                                        1));
4385*62c56f98SSadaf Ebrahimi 
4386*62c56f98SSadaf Ebrahimi                 goto exit;
4387*62c56f98SSadaf Ebrahimi             }
4388*62c56f98SSadaf Ebrahimi 
4389*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4390*62c56f98SSadaf Ebrahimi                                       recv_msg_seq, recv_msg_seq_offset));
4391*62c56f98SSadaf Ebrahimi 
4392*62c56f98SSadaf Ebrahimi             hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
4393*62c56f98SSadaf Ebrahimi 
4394*62c56f98SSadaf Ebrahimi             /* Check if the buffering for this seq nr has already commenced. */
4395*62c56f98SSadaf Ebrahimi             if (!hs_buf->is_valid) {
4396*62c56f98SSadaf Ebrahimi                 size_t reassembly_buf_sz;
4397*62c56f98SSadaf Ebrahimi 
4398*62c56f98SSadaf Ebrahimi                 hs_buf->is_fragmented =
4399*62c56f98SSadaf Ebrahimi                     (ssl_hs_is_proper_fragment(ssl) == 1);
4400*62c56f98SSadaf Ebrahimi 
4401*62c56f98SSadaf Ebrahimi                 /* We copy the message back into the input buffer
4402*62c56f98SSadaf Ebrahimi                  * after reassembly, so check that it's not too large.
4403*62c56f98SSadaf Ebrahimi                  * This is an implementation-specific limitation
4404*62c56f98SSadaf Ebrahimi                  * and not one from the standard, hence it is not
4405*62c56f98SSadaf Ebrahimi                  * checked in ssl_check_hs_header(). */
4406*62c56f98SSadaf Ebrahimi                 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4407*62c56f98SSadaf Ebrahimi                     /* Ignore message */
4408*62c56f98SSadaf Ebrahimi                     goto exit;
4409*62c56f98SSadaf Ebrahimi                 }
4410*62c56f98SSadaf Ebrahimi 
4411*62c56f98SSadaf Ebrahimi                 /* Check if we have enough space to buffer the message. */
4412*62c56f98SSadaf Ebrahimi                 if (hs->buffering.total_bytes_buffered >
4413*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4414*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4415*62c56f98SSadaf Ebrahimi                     return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4416*62c56f98SSadaf Ebrahimi                 }
4417*62c56f98SSadaf Ebrahimi 
4418*62c56f98SSadaf Ebrahimi                 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4419*62c56f98SSadaf Ebrahimi                                                                    hs_buf->is_fragmented);
4420*62c56f98SSadaf Ebrahimi 
4421*62c56f98SSadaf Ebrahimi                 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4422*62c56f98SSadaf Ebrahimi                                          hs->buffering.total_bytes_buffered)) {
4423*62c56f98SSadaf Ebrahimi                     if (recv_msg_seq_offset > 0) {
4424*62c56f98SSadaf Ebrahimi                         /* If we can't buffer a future message because
4425*62c56f98SSadaf Ebrahimi                          * of space limitations -- ignore. */
4426*62c56f98SSadaf Ebrahimi                         MBEDTLS_SSL_DEBUG_MSG(2,
4427*62c56f98SSadaf Ebrahimi                                               ("Buffering of future message of size %"
4428*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4429*62c56f98SSadaf Ebrahimi                                                " would exceed the compile-time limit %"
4430*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4431*62c56f98SSadaf Ebrahimi                                                " (already %" MBEDTLS_PRINTF_SIZET
4432*62c56f98SSadaf Ebrahimi                                                " bytes buffered) -- ignore\n",
4433*62c56f98SSadaf Ebrahimi                                                msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4434*62c56f98SSadaf Ebrahimi                                                hs->buffering.total_bytes_buffered));
4435*62c56f98SSadaf Ebrahimi                         goto exit;
4436*62c56f98SSadaf Ebrahimi                     } else {
4437*62c56f98SSadaf Ebrahimi                         MBEDTLS_SSL_DEBUG_MSG(2,
4438*62c56f98SSadaf Ebrahimi                                               ("Buffering of future message of size %"
4439*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4440*62c56f98SSadaf Ebrahimi                                                " would exceed the compile-time limit %"
4441*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4442*62c56f98SSadaf Ebrahimi                                                " (already %" MBEDTLS_PRINTF_SIZET
4443*62c56f98SSadaf Ebrahimi                                                " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4444*62c56f98SSadaf Ebrahimi                                                msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4445*62c56f98SSadaf Ebrahimi                                                hs->buffering.total_bytes_buffered));
4446*62c56f98SSadaf Ebrahimi                     }
4447*62c56f98SSadaf Ebrahimi 
4448*62c56f98SSadaf Ebrahimi                     if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4449*62c56f98SSadaf Ebrahimi                         MBEDTLS_SSL_DEBUG_MSG(2,
4450*62c56f98SSadaf Ebrahimi                                               ("Reassembly of next message of size %"
4451*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4452*62c56f98SSadaf Ebrahimi                                                " (%" MBEDTLS_PRINTF_SIZET
4453*62c56f98SSadaf Ebrahimi                                                " with bitmap) would exceed"
4454*62c56f98SSadaf Ebrahimi                                                " the compile-time limit %"
4455*62c56f98SSadaf Ebrahimi                                                MBEDTLS_PRINTF_SIZET
4456*62c56f98SSadaf Ebrahimi                                                " (already %" MBEDTLS_PRINTF_SIZET
4457*62c56f98SSadaf Ebrahimi                                                " bytes buffered) -- fail\n",
4458*62c56f98SSadaf Ebrahimi                                                msg_len,
4459*62c56f98SSadaf Ebrahimi                                                reassembly_buf_sz,
4460*62c56f98SSadaf Ebrahimi                                                (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4461*62c56f98SSadaf Ebrahimi                                                hs->buffering.total_bytes_buffered));
4462*62c56f98SSadaf Ebrahimi                         ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4463*62c56f98SSadaf Ebrahimi                         goto exit;
4464*62c56f98SSadaf Ebrahimi                     }
4465*62c56f98SSadaf Ebrahimi                 }
4466*62c56f98SSadaf Ebrahimi 
4467*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2,
4468*62c56f98SSadaf Ebrahimi                                       ("initialize reassembly, total length = %"
4469*62c56f98SSadaf Ebrahimi                                        MBEDTLS_PRINTF_SIZET,
4470*62c56f98SSadaf Ebrahimi                                        msg_len));
4471*62c56f98SSadaf Ebrahimi 
4472*62c56f98SSadaf Ebrahimi                 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4473*62c56f98SSadaf Ebrahimi                 if (hs_buf->data == NULL) {
4474*62c56f98SSadaf Ebrahimi                     ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4475*62c56f98SSadaf Ebrahimi                     goto exit;
4476*62c56f98SSadaf Ebrahimi                 }
4477*62c56f98SSadaf Ebrahimi                 hs_buf->data_len = reassembly_buf_sz;
4478*62c56f98SSadaf Ebrahimi 
4479*62c56f98SSadaf Ebrahimi                 /* Prepare final header: copy msg_type, length and message_seq,
4480*62c56f98SSadaf Ebrahimi                  * then add standardised fragment_offset and fragment_length */
4481*62c56f98SSadaf Ebrahimi                 memcpy(hs_buf->data, ssl->in_msg, 6);
4482*62c56f98SSadaf Ebrahimi                 memset(hs_buf->data + 6, 0, 3);
4483*62c56f98SSadaf Ebrahimi                 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
4484*62c56f98SSadaf Ebrahimi 
4485*62c56f98SSadaf Ebrahimi                 hs_buf->is_valid = 1;
4486*62c56f98SSadaf Ebrahimi 
4487*62c56f98SSadaf Ebrahimi                 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
4488*62c56f98SSadaf Ebrahimi             } else {
4489*62c56f98SSadaf Ebrahimi                 /* Make sure msg_type and length are consistent */
4490*62c56f98SSadaf Ebrahimi                 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4491*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
4492*62c56f98SSadaf Ebrahimi                     /* Ignore */
4493*62c56f98SSadaf Ebrahimi                     goto exit;
4494*62c56f98SSadaf Ebrahimi                 }
4495*62c56f98SSadaf Ebrahimi             }
4496*62c56f98SSadaf Ebrahimi 
4497*62c56f98SSadaf Ebrahimi             if (!hs_buf->is_complete) {
4498*62c56f98SSadaf Ebrahimi                 size_t frag_len, frag_off;
4499*62c56f98SSadaf Ebrahimi                 unsigned char * const msg = hs_buf->data + 12;
4500*62c56f98SSadaf Ebrahimi 
4501*62c56f98SSadaf Ebrahimi                 /*
4502*62c56f98SSadaf Ebrahimi                  * Check and copy current fragment
4503*62c56f98SSadaf Ebrahimi                  */
4504*62c56f98SSadaf Ebrahimi 
4505*62c56f98SSadaf Ebrahimi                 /* Validation of header fields already done in
4506*62c56f98SSadaf Ebrahimi                  * mbedtls_ssl_prepare_handshake_record(). */
4507*62c56f98SSadaf Ebrahimi                 frag_off = ssl_get_hs_frag_off(ssl);
4508*62c56f98SSadaf Ebrahimi                 frag_len = ssl_get_hs_frag_len(ssl);
4509*62c56f98SSadaf Ebrahimi 
4510*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4511*62c56f98SSadaf Ebrahimi                                           ", length = %" MBEDTLS_PRINTF_SIZET,
4512*62c56f98SSadaf Ebrahimi                                           frag_off, frag_len));
4513*62c56f98SSadaf Ebrahimi                 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
4514*62c56f98SSadaf Ebrahimi 
4515*62c56f98SSadaf Ebrahimi                 if (hs_buf->is_fragmented) {
4516*62c56f98SSadaf Ebrahimi                     unsigned char * const bitmask = msg + msg_len;
4517*62c56f98SSadaf Ebrahimi                     ssl_bitmask_set(bitmask, frag_off, frag_len);
4518*62c56f98SSadaf Ebrahimi                     hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4519*62c56f98SSadaf Ebrahimi                                                              msg_len) == 0);
4520*62c56f98SSadaf Ebrahimi                 } else {
4521*62c56f98SSadaf Ebrahimi                     hs_buf->is_complete = 1;
4522*62c56f98SSadaf Ebrahimi                 }
4523*62c56f98SSadaf Ebrahimi 
4524*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4525*62c56f98SSadaf Ebrahimi                                           hs_buf->is_complete ? "" : "not yet "));
4526*62c56f98SSadaf Ebrahimi             }
4527*62c56f98SSadaf Ebrahimi 
4528*62c56f98SSadaf Ebrahimi             break;
4529*62c56f98SSadaf Ebrahimi         }
4530*62c56f98SSadaf Ebrahimi 
4531*62c56f98SSadaf Ebrahimi         default:
4532*62c56f98SSadaf Ebrahimi             /* We don't buffer other types of messages. */
4533*62c56f98SSadaf Ebrahimi             break;
4534*62c56f98SSadaf Ebrahimi     }
4535*62c56f98SSadaf Ebrahimi 
4536*62c56f98SSadaf Ebrahimi exit:
4537*62c56f98SSadaf Ebrahimi 
4538*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4539*62c56f98SSadaf Ebrahimi     return ret;
4540*62c56f98SSadaf Ebrahimi }
4541*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
4542*62c56f98SSadaf Ebrahimi 
4543*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_consume_current_message(mbedtls_ssl_context * ssl)4544*62c56f98SSadaf Ebrahimi static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
4545*62c56f98SSadaf Ebrahimi {
4546*62c56f98SSadaf Ebrahimi     /*
4547*62c56f98SSadaf Ebrahimi      * Consume last content-layer message and potentially
4548*62c56f98SSadaf Ebrahimi      * update in_msglen which keeps track of the contents'
4549*62c56f98SSadaf Ebrahimi      * consumption state.
4550*62c56f98SSadaf Ebrahimi      *
4551*62c56f98SSadaf Ebrahimi      * (1) Handshake messages:
4552*62c56f98SSadaf Ebrahimi      *     Remove last handshake message, move content
4553*62c56f98SSadaf Ebrahimi      *     and adapt in_msglen.
4554*62c56f98SSadaf Ebrahimi      *
4555*62c56f98SSadaf Ebrahimi      * (2) Alert messages:
4556*62c56f98SSadaf Ebrahimi      *     Consume whole record content, in_msglen = 0.
4557*62c56f98SSadaf Ebrahimi      *
4558*62c56f98SSadaf Ebrahimi      * (3) Change cipher spec:
4559*62c56f98SSadaf Ebrahimi      *     Consume whole record content, in_msglen = 0.
4560*62c56f98SSadaf Ebrahimi      *
4561*62c56f98SSadaf Ebrahimi      * (4) Application data:
4562*62c56f98SSadaf Ebrahimi      *     Don't do anything - the record layer provides
4563*62c56f98SSadaf Ebrahimi      *     the application data as a stream transport
4564*62c56f98SSadaf Ebrahimi      *     and consumes through mbedtls_ssl_read only.
4565*62c56f98SSadaf Ebrahimi      *
4566*62c56f98SSadaf Ebrahimi      */
4567*62c56f98SSadaf Ebrahimi 
4568*62c56f98SSadaf Ebrahimi     /* Case (1): Handshake messages */
4569*62c56f98SSadaf Ebrahimi     if (ssl->in_hslen != 0) {
4570*62c56f98SSadaf Ebrahimi         /* Hard assertion to be sure that no application data
4571*62c56f98SSadaf Ebrahimi          * is in flight, as corrupting ssl->in_msglen during
4572*62c56f98SSadaf Ebrahimi          * ssl->in_offt != NULL is fatal. */
4573*62c56f98SSadaf Ebrahimi         if (ssl->in_offt != NULL) {
4574*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4575*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4576*62c56f98SSadaf Ebrahimi         }
4577*62c56f98SSadaf Ebrahimi 
4578*62c56f98SSadaf Ebrahimi         /*
4579*62c56f98SSadaf Ebrahimi          * Get next Handshake message in the current record
4580*62c56f98SSadaf Ebrahimi          */
4581*62c56f98SSadaf Ebrahimi 
4582*62c56f98SSadaf Ebrahimi         /* Notes:
4583*62c56f98SSadaf Ebrahimi          * (1) in_hslen is not necessarily the size of the
4584*62c56f98SSadaf Ebrahimi          *     current handshake content: If DTLS handshake
4585*62c56f98SSadaf Ebrahimi          *     fragmentation is used, that's the fragment
4586*62c56f98SSadaf Ebrahimi          *     size instead. Using the total handshake message
4587*62c56f98SSadaf Ebrahimi          *     size here is faulty and should be changed at
4588*62c56f98SSadaf Ebrahimi          *     some point.
4589*62c56f98SSadaf Ebrahimi          * (2) While it doesn't seem to cause problems, one
4590*62c56f98SSadaf Ebrahimi          *     has to be very careful not to assume that in_hslen
4591*62c56f98SSadaf Ebrahimi          *     is always <= in_msglen in a sensible communication.
4592*62c56f98SSadaf Ebrahimi          *     Again, it's wrong for DTLS handshake fragmentation.
4593*62c56f98SSadaf Ebrahimi          *     The following check is therefore mandatory, and
4594*62c56f98SSadaf Ebrahimi          *     should not be treated as a silently corrected assertion.
4595*62c56f98SSadaf Ebrahimi          *     Additionally, ssl->in_hslen might be arbitrarily out of
4596*62c56f98SSadaf Ebrahimi          *     bounds after handling a DTLS message with an unexpected
4597*62c56f98SSadaf Ebrahimi          *     sequence number, see mbedtls_ssl_prepare_handshake_record.
4598*62c56f98SSadaf Ebrahimi          */
4599*62c56f98SSadaf Ebrahimi         if (ssl->in_hslen < ssl->in_msglen) {
4600*62c56f98SSadaf Ebrahimi             ssl->in_msglen -= ssl->in_hslen;
4601*62c56f98SSadaf Ebrahimi             memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4602*62c56f98SSadaf Ebrahimi                     ssl->in_msglen);
4603*62c56f98SSadaf Ebrahimi 
4604*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4605*62c56f98SSadaf Ebrahimi                                   ssl->in_msg, ssl->in_msglen);
4606*62c56f98SSadaf Ebrahimi         } else {
4607*62c56f98SSadaf Ebrahimi             ssl->in_msglen = 0;
4608*62c56f98SSadaf Ebrahimi         }
4609*62c56f98SSadaf Ebrahimi 
4610*62c56f98SSadaf Ebrahimi         ssl->in_hslen   = 0;
4611*62c56f98SSadaf Ebrahimi     }
4612*62c56f98SSadaf Ebrahimi     /* Case (4): Application data */
4613*62c56f98SSadaf Ebrahimi     else if (ssl->in_offt != NULL) {
4614*62c56f98SSadaf Ebrahimi         return 0;
4615*62c56f98SSadaf Ebrahimi     }
4616*62c56f98SSadaf Ebrahimi     /* Everything else (CCS & Alerts) */
4617*62c56f98SSadaf Ebrahimi     else {
4618*62c56f98SSadaf Ebrahimi         ssl->in_msglen = 0;
4619*62c56f98SSadaf Ebrahimi     }
4620*62c56f98SSadaf Ebrahimi 
4621*62c56f98SSadaf Ebrahimi     return 0;
4622*62c56f98SSadaf Ebrahimi }
4623*62c56f98SSadaf Ebrahimi 
4624*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_record_is_in_progress(mbedtls_ssl_context * ssl)4625*62c56f98SSadaf Ebrahimi static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
4626*62c56f98SSadaf Ebrahimi {
4627*62c56f98SSadaf Ebrahimi     if (ssl->in_msglen > 0) {
4628*62c56f98SSadaf Ebrahimi         return 1;
4629*62c56f98SSadaf Ebrahimi     }
4630*62c56f98SSadaf Ebrahimi 
4631*62c56f98SSadaf Ebrahimi     return 0;
4632*62c56f98SSadaf Ebrahimi }
4633*62c56f98SSadaf Ebrahimi 
4634*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4635*62c56f98SSadaf Ebrahimi 
ssl_free_buffered_record(mbedtls_ssl_context * ssl)4636*62c56f98SSadaf Ebrahimi static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
4637*62c56f98SSadaf Ebrahimi {
4638*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4639*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
4640*62c56f98SSadaf Ebrahimi         return;
4641*62c56f98SSadaf Ebrahimi     }
4642*62c56f98SSadaf Ebrahimi 
4643*62c56f98SSadaf Ebrahimi     if (hs->buffering.future_record.data != NULL) {
4644*62c56f98SSadaf Ebrahimi         hs->buffering.total_bytes_buffered -=
4645*62c56f98SSadaf Ebrahimi             hs->buffering.future_record.len;
4646*62c56f98SSadaf Ebrahimi 
4647*62c56f98SSadaf Ebrahimi         mbedtls_free(hs->buffering.future_record.data);
4648*62c56f98SSadaf Ebrahimi         hs->buffering.future_record.data = NULL;
4649*62c56f98SSadaf Ebrahimi     }
4650*62c56f98SSadaf Ebrahimi }
4651*62c56f98SSadaf Ebrahimi 
4652*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_load_buffered_record(mbedtls_ssl_context * ssl)4653*62c56f98SSadaf Ebrahimi static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
4654*62c56f98SSadaf Ebrahimi {
4655*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4656*62c56f98SSadaf Ebrahimi     unsigned char *rec;
4657*62c56f98SSadaf Ebrahimi     size_t rec_len;
4658*62c56f98SSadaf Ebrahimi     unsigned rec_epoch;
4659*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4660*62c56f98SSadaf Ebrahimi     size_t in_buf_len = ssl->in_buf_len;
4661*62c56f98SSadaf Ebrahimi #else
4662*62c56f98SSadaf Ebrahimi     size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4663*62c56f98SSadaf Ebrahimi #endif
4664*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4665*62c56f98SSadaf Ebrahimi         return 0;
4666*62c56f98SSadaf Ebrahimi     }
4667*62c56f98SSadaf Ebrahimi 
4668*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
4669*62c56f98SSadaf Ebrahimi         return 0;
4670*62c56f98SSadaf Ebrahimi     }
4671*62c56f98SSadaf Ebrahimi 
4672*62c56f98SSadaf Ebrahimi     rec       = hs->buffering.future_record.data;
4673*62c56f98SSadaf Ebrahimi     rec_len   = hs->buffering.future_record.len;
4674*62c56f98SSadaf Ebrahimi     rec_epoch = hs->buffering.future_record.epoch;
4675*62c56f98SSadaf Ebrahimi 
4676*62c56f98SSadaf Ebrahimi     if (rec == NULL) {
4677*62c56f98SSadaf Ebrahimi         return 0;
4678*62c56f98SSadaf Ebrahimi     }
4679*62c56f98SSadaf Ebrahimi 
4680*62c56f98SSadaf Ebrahimi     /* Only consider loading future records if the
4681*62c56f98SSadaf Ebrahimi      * input buffer is empty. */
4682*62c56f98SSadaf Ebrahimi     if (ssl_next_record_is_in_datagram(ssl) == 1) {
4683*62c56f98SSadaf Ebrahimi         return 0;
4684*62c56f98SSadaf Ebrahimi     }
4685*62c56f98SSadaf Ebrahimi 
4686*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
4687*62c56f98SSadaf Ebrahimi 
4688*62c56f98SSadaf Ebrahimi     if (rec_epoch != ssl->in_epoch) {
4689*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
4690*62c56f98SSadaf Ebrahimi         goto exit;
4691*62c56f98SSadaf Ebrahimi     }
4692*62c56f98SSadaf Ebrahimi 
4693*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
4694*62c56f98SSadaf Ebrahimi 
4695*62c56f98SSadaf Ebrahimi     /* Double-check that the record is not too large */
4696*62c56f98SSadaf Ebrahimi     if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4697*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4698*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4699*62c56f98SSadaf Ebrahimi     }
4700*62c56f98SSadaf Ebrahimi 
4701*62c56f98SSadaf Ebrahimi     memcpy(ssl->in_hdr, rec, rec_len);
4702*62c56f98SSadaf Ebrahimi     ssl->in_left = rec_len;
4703*62c56f98SSadaf Ebrahimi     ssl->next_record_offset = 0;
4704*62c56f98SSadaf Ebrahimi 
4705*62c56f98SSadaf Ebrahimi     ssl_free_buffered_record(ssl);
4706*62c56f98SSadaf Ebrahimi 
4707*62c56f98SSadaf Ebrahimi exit:
4708*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4709*62c56f98SSadaf Ebrahimi     return 0;
4710*62c56f98SSadaf Ebrahimi }
4711*62c56f98SSadaf Ebrahimi 
4712*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_buffer_future_record(mbedtls_ssl_context * ssl,mbedtls_record const * rec)4713*62c56f98SSadaf Ebrahimi static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4714*62c56f98SSadaf Ebrahimi                                     mbedtls_record const *rec)
4715*62c56f98SSadaf Ebrahimi {
4716*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4717*62c56f98SSadaf Ebrahimi 
4718*62c56f98SSadaf Ebrahimi     /* Don't buffer future records outside handshakes. */
4719*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
4720*62c56f98SSadaf Ebrahimi         return 0;
4721*62c56f98SSadaf Ebrahimi     }
4722*62c56f98SSadaf Ebrahimi 
4723*62c56f98SSadaf Ebrahimi     /* Only buffer handshake records (we are only interested
4724*62c56f98SSadaf Ebrahimi      * in Finished messages). */
4725*62c56f98SSadaf Ebrahimi     if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4726*62c56f98SSadaf Ebrahimi         return 0;
4727*62c56f98SSadaf Ebrahimi     }
4728*62c56f98SSadaf Ebrahimi 
4729*62c56f98SSadaf Ebrahimi     /* Don't buffer more than one future epoch record. */
4730*62c56f98SSadaf Ebrahimi     if (hs->buffering.future_record.data != NULL) {
4731*62c56f98SSadaf Ebrahimi         return 0;
4732*62c56f98SSadaf Ebrahimi     }
4733*62c56f98SSadaf Ebrahimi 
4734*62c56f98SSadaf Ebrahimi     /* Don't buffer record if there's not enough buffering space remaining. */
4735*62c56f98SSadaf Ebrahimi     if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4736*62c56f98SSadaf Ebrahimi                         hs->buffering.total_bytes_buffered)) {
4737*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4738*62c56f98SSadaf Ebrahimi                                   " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4739*62c56f98SSadaf Ebrahimi                                   " (already %" MBEDTLS_PRINTF_SIZET
4740*62c56f98SSadaf Ebrahimi                                   " bytes buffered) -- ignore\n",
4741*62c56f98SSadaf Ebrahimi                                   rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4742*62c56f98SSadaf Ebrahimi                                   hs->buffering.total_bytes_buffered));
4743*62c56f98SSadaf Ebrahimi         return 0;
4744*62c56f98SSadaf Ebrahimi     }
4745*62c56f98SSadaf Ebrahimi 
4746*62c56f98SSadaf Ebrahimi     /* Buffer record */
4747*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4748*62c56f98SSadaf Ebrahimi                               ssl->in_epoch + 1U));
4749*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
4750*62c56f98SSadaf Ebrahimi 
4751*62c56f98SSadaf Ebrahimi     /* ssl_parse_record_header() only considers records
4752*62c56f98SSadaf Ebrahimi      * of the next epoch as candidates for buffering. */
4753*62c56f98SSadaf Ebrahimi     hs->buffering.future_record.epoch = ssl->in_epoch + 1;
4754*62c56f98SSadaf Ebrahimi     hs->buffering.future_record.len   = rec->buf_len;
4755*62c56f98SSadaf Ebrahimi 
4756*62c56f98SSadaf Ebrahimi     hs->buffering.future_record.data =
4757*62c56f98SSadaf Ebrahimi         mbedtls_calloc(1, hs->buffering.future_record.len);
4758*62c56f98SSadaf Ebrahimi     if (hs->buffering.future_record.data == NULL) {
4759*62c56f98SSadaf Ebrahimi         /* If we run out of RAM trying to buffer a
4760*62c56f98SSadaf Ebrahimi          * record from the next epoch, just ignore. */
4761*62c56f98SSadaf Ebrahimi         return 0;
4762*62c56f98SSadaf Ebrahimi     }
4763*62c56f98SSadaf Ebrahimi 
4764*62c56f98SSadaf Ebrahimi     memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
4765*62c56f98SSadaf Ebrahimi 
4766*62c56f98SSadaf Ebrahimi     hs->buffering.total_bytes_buffered += rec->buf_len;
4767*62c56f98SSadaf Ebrahimi     return 0;
4768*62c56f98SSadaf Ebrahimi }
4769*62c56f98SSadaf Ebrahimi 
4770*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
4771*62c56f98SSadaf Ebrahimi 
4772*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_get_next_record(mbedtls_ssl_context * ssl)4773*62c56f98SSadaf Ebrahimi static int ssl_get_next_record(mbedtls_ssl_context *ssl)
4774*62c56f98SSadaf Ebrahimi {
4775*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4776*62c56f98SSadaf Ebrahimi     mbedtls_record rec;
4777*62c56f98SSadaf Ebrahimi 
4778*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4779*62c56f98SSadaf Ebrahimi     /* We might have buffered a future record; if so,
4780*62c56f98SSadaf Ebrahimi      * and if the epoch matches now, load it.
4781*62c56f98SSadaf Ebrahimi      * On success, this call will set ssl->in_left to
4782*62c56f98SSadaf Ebrahimi      * the length of the buffered record, so that
4783*62c56f98SSadaf Ebrahimi      * the calls to ssl_fetch_input() below will
4784*62c56f98SSadaf Ebrahimi      * essentially be no-ops. */
4785*62c56f98SSadaf Ebrahimi     ret = ssl_load_buffered_record(ssl);
4786*62c56f98SSadaf Ebrahimi     if (ret != 0) {
4787*62c56f98SSadaf Ebrahimi         return ret;
4788*62c56f98SSadaf Ebrahimi     }
4789*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
4790*62c56f98SSadaf Ebrahimi 
4791*62c56f98SSadaf Ebrahimi     /* Ensure that we have enough space available for the default form
4792*62c56f98SSadaf Ebrahimi      * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4793*62c56f98SSadaf Ebrahimi      * with no space for CIDs counted in). */
4794*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4795*62c56f98SSadaf Ebrahimi     if (ret != 0) {
4796*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4797*62c56f98SSadaf Ebrahimi         return ret;
4798*62c56f98SSadaf Ebrahimi     }
4799*62c56f98SSadaf Ebrahimi 
4800*62c56f98SSadaf Ebrahimi     ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4801*62c56f98SSadaf Ebrahimi     if (ret != 0) {
4802*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4803*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4804*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4805*62c56f98SSadaf Ebrahimi                 ret = ssl_buffer_future_record(ssl, &rec);
4806*62c56f98SSadaf Ebrahimi                 if (ret != 0) {
4807*62c56f98SSadaf Ebrahimi                     return ret;
4808*62c56f98SSadaf Ebrahimi                 }
4809*62c56f98SSadaf Ebrahimi 
4810*62c56f98SSadaf Ebrahimi                 /* Fall through to handling of unexpected records */
4811*62c56f98SSadaf Ebrahimi                 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4812*62c56f98SSadaf Ebrahimi             }
4813*62c56f98SSadaf Ebrahimi 
4814*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
4815*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
4816*62c56f98SSadaf Ebrahimi                 /* Reset in pointers to default state for TLS/DTLS records,
4817*62c56f98SSadaf Ebrahimi                  * assuming no CID and no offset between record content and
4818*62c56f98SSadaf Ebrahimi                  * record plaintext. */
4819*62c56f98SSadaf Ebrahimi                 mbedtls_ssl_update_in_pointers(ssl);
4820*62c56f98SSadaf Ebrahimi 
4821*62c56f98SSadaf Ebrahimi                 /* Setup internal message pointers from record structure. */
4822*62c56f98SSadaf Ebrahimi                 ssl->in_msgtype = rec.type;
4823*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4824*62c56f98SSadaf Ebrahimi                 ssl->in_len = ssl->in_cid + rec.cid_len;
4825*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4826*62c56f98SSadaf Ebrahimi                 ssl->in_iv  = ssl->in_msg = ssl->in_len + 2;
4827*62c56f98SSadaf Ebrahimi                 ssl->in_msglen = rec.data_len;
4828*62c56f98SSadaf Ebrahimi 
4829*62c56f98SSadaf Ebrahimi                 ret = ssl_check_client_reconnect(ssl);
4830*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4831*62c56f98SSadaf Ebrahimi                 if (ret != 0) {
4832*62c56f98SSadaf Ebrahimi                     return ret;
4833*62c56f98SSadaf Ebrahimi                 }
4834*62c56f98SSadaf Ebrahimi #endif
4835*62c56f98SSadaf Ebrahimi 
4836*62c56f98SSadaf Ebrahimi                 /* Skip unexpected record (but not whole datagram) */
4837*62c56f98SSadaf Ebrahimi                 ssl->next_record_offset = rec.buf_len;
4838*62c56f98SSadaf Ebrahimi 
4839*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4840*62c56f98SSadaf Ebrahimi                                           "(header)"));
4841*62c56f98SSadaf Ebrahimi             } else {
4842*62c56f98SSadaf Ebrahimi                 /* Skip invalid record and the rest of the datagram */
4843*62c56f98SSadaf Ebrahimi                 ssl->next_record_offset = 0;
4844*62c56f98SSadaf Ebrahimi                 ssl->in_left = 0;
4845*62c56f98SSadaf Ebrahimi 
4846*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4847*62c56f98SSadaf Ebrahimi                                           "(header)"));
4848*62c56f98SSadaf Ebrahimi             }
4849*62c56f98SSadaf Ebrahimi 
4850*62c56f98SSadaf Ebrahimi             /* Get next record */
4851*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4852*62c56f98SSadaf Ebrahimi         } else
4853*62c56f98SSadaf Ebrahimi #endif
4854*62c56f98SSadaf Ebrahimi         {
4855*62c56f98SSadaf Ebrahimi             return ret;
4856*62c56f98SSadaf Ebrahimi         }
4857*62c56f98SSadaf Ebrahimi     }
4858*62c56f98SSadaf Ebrahimi 
4859*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4860*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4861*62c56f98SSadaf Ebrahimi         /* Remember offset of next record within datagram. */
4862*62c56f98SSadaf Ebrahimi         ssl->next_record_offset = rec.buf_len;
4863*62c56f98SSadaf Ebrahimi         if (ssl->next_record_offset < ssl->in_left) {
4864*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
4865*62c56f98SSadaf Ebrahimi         }
4866*62c56f98SSadaf Ebrahimi     } else
4867*62c56f98SSadaf Ebrahimi #endif
4868*62c56f98SSadaf Ebrahimi     {
4869*62c56f98SSadaf Ebrahimi         /*
4870*62c56f98SSadaf Ebrahimi          * Fetch record contents from underlying transport.
4871*62c56f98SSadaf Ebrahimi          */
4872*62c56f98SSadaf Ebrahimi         ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4873*62c56f98SSadaf Ebrahimi         if (ret != 0) {
4874*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4875*62c56f98SSadaf Ebrahimi             return ret;
4876*62c56f98SSadaf Ebrahimi         }
4877*62c56f98SSadaf Ebrahimi 
4878*62c56f98SSadaf Ebrahimi         ssl->in_left = 0;
4879*62c56f98SSadaf Ebrahimi     }
4880*62c56f98SSadaf Ebrahimi 
4881*62c56f98SSadaf Ebrahimi     /*
4882*62c56f98SSadaf Ebrahimi      * Decrypt record contents.
4883*62c56f98SSadaf Ebrahimi      */
4884*62c56f98SSadaf Ebrahimi 
4885*62c56f98SSadaf Ebrahimi     if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
4886*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4887*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4888*62c56f98SSadaf Ebrahimi             /* Silently discard invalid records */
4889*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4890*62c56f98SSadaf Ebrahimi                 /* Except when waiting for Finished as a bad mac here
4891*62c56f98SSadaf Ebrahimi                  * probably means something went wrong in the handshake
4892*62c56f98SSadaf Ebrahimi                  * (eg wrong psk used, mitm downgrade attempt, etc.) */
4893*62c56f98SSadaf Ebrahimi                 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4894*62c56f98SSadaf Ebrahimi                     ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
4895*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4896*62c56f98SSadaf Ebrahimi                     if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4897*62c56f98SSadaf Ebrahimi                         mbedtls_ssl_send_alert_message(ssl,
4898*62c56f98SSadaf Ebrahimi                                                        MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4899*62c56f98SSadaf Ebrahimi                                                        MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
4900*62c56f98SSadaf Ebrahimi                     }
4901*62c56f98SSadaf Ebrahimi #endif
4902*62c56f98SSadaf Ebrahimi                     return ret;
4903*62c56f98SSadaf Ebrahimi                 }
4904*62c56f98SSadaf Ebrahimi 
4905*62c56f98SSadaf Ebrahimi                 if (ssl->conf->badmac_limit != 0 &&
4906*62c56f98SSadaf Ebrahimi                     ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4907*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4908*62c56f98SSadaf Ebrahimi                     return MBEDTLS_ERR_SSL_INVALID_MAC;
4909*62c56f98SSadaf Ebrahimi                 }
4910*62c56f98SSadaf Ebrahimi 
4911*62c56f98SSadaf Ebrahimi                 /* As above, invalid records cause
4912*62c56f98SSadaf Ebrahimi                  * dismissal of the whole datagram. */
4913*62c56f98SSadaf Ebrahimi 
4914*62c56f98SSadaf Ebrahimi                 ssl->next_record_offset = 0;
4915*62c56f98SSadaf Ebrahimi                 ssl->in_left = 0;
4916*62c56f98SSadaf Ebrahimi 
4917*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4918*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4919*62c56f98SSadaf Ebrahimi             }
4920*62c56f98SSadaf Ebrahimi 
4921*62c56f98SSadaf Ebrahimi             return ret;
4922*62c56f98SSadaf Ebrahimi         } else
4923*62c56f98SSadaf Ebrahimi #endif
4924*62c56f98SSadaf Ebrahimi         {
4925*62c56f98SSadaf Ebrahimi             /* Error out (and send alert) on invalid records */
4926*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4927*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4928*62c56f98SSadaf Ebrahimi                 mbedtls_ssl_send_alert_message(ssl,
4929*62c56f98SSadaf Ebrahimi                                                MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4930*62c56f98SSadaf Ebrahimi                                                MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
4931*62c56f98SSadaf Ebrahimi             }
4932*62c56f98SSadaf Ebrahimi #endif
4933*62c56f98SSadaf Ebrahimi             return ret;
4934*62c56f98SSadaf Ebrahimi         }
4935*62c56f98SSadaf Ebrahimi     }
4936*62c56f98SSadaf Ebrahimi 
4937*62c56f98SSadaf Ebrahimi 
4938*62c56f98SSadaf Ebrahimi     /* Reset in pointers to default state for TLS/DTLS records,
4939*62c56f98SSadaf Ebrahimi      * assuming no CID and no offset between record content and
4940*62c56f98SSadaf Ebrahimi      * record plaintext. */
4941*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_in_pointers(ssl);
4942*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4943*62c56f98SSadaf Ebrahimi     ssl->in_len = ssl->in_cid + rec.cid_len;
4944*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4945*62c56f98SSadaf Ebrahimi     ssl->in_iv  = ssl->in_len + 2;
4946*62c56f98SSadaf Ebrahimi 
4947*62c56f98SSadaf Ebrahimi     /* The record content type may change during decryption,
4948*62c56f98SSadaf Ebrahimi      * so re-read it. */
4949*62c56f98SSadaf Ebrahimi     ssl->in_msgtype = rec.type;
4950*62c56f98SSadaf Ebrahimi     /* Also update the input buffer, because unfortunately
4951*62c56f98SSadaf Ebrahimi      * the server-side ssl_parse_client_hello() reparses the
4952*62c56f98SSadaf Ebrahimi      * record header when receiving a ClientHello initiating
4953*62c56f98SSadaf Ebrahimi      * a renegotiation. */
4954*62c56f98SSadaf Ebrahimi     ssl->in_hdr[0] = rec.type;
4955*62c56f98SSadaf Ebrahimi     ssl->in_msg    = rec.buf + rec.data_offset;
4956*62c56f98SSadaf Ebrahimi     ssl->in_msglen = rec.data_len;
4957*62c56f98SSadaf Ebrahimi     MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
4958*62c56f98SSadaf Ebrahimi 
4959*62c56f98SSadaf Ebrahimi     return 0;
4960*62c56f98SSadaf Ebrahimi }
4961*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_handle_message_type(mbedtls_ssl_context * ssl)4962*62c56f98SSadaf Ebrahimi int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
4963*62c56f98SSadaf Ebrahimi {
4964*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4965*62c56f98SSadaf Ebrahimi 
4966*62c56f98SSadaf Ebrahimi     /*
4967*62c56f98SSadaf Ebrahimi      * Handle particular types of records
4968*62c56f98SSadaf Ebrahimi      */
4969*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4970*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4971*62c56f98SSadaf Ebrahimi             return ret;
4972*62c56f98SSadaf Ebrahimi         }
4973*62c56f98SSadaf Ebrahimi     }
4974*62c56f98SSadaf Ebrahimi 
4975*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4976*62c56f98SSadaf Ebrahimi         if (ssl->in_msglen != 1) {
4977*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4978*62c56f98SSadaf Ebrahimi                                       ssl->in_msglen));
4979*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
4980*62c56f98SSadaf Ebrahimi         }
4981*62c56f98SSadaf Ebrahimi 
4982*62c56f98SSadaf Ebrahimi         if (ssl->in_msg[0] != 1) {
4983*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4984*62c56f98SSadaf Ebrahimi                                       ssl->in_msg[0]));
4985*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
4986*62c56f98SSadaf Ebrahimi         }
4987*62c56f98SSadaf Ebrahimi 
4988*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
4989*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4990*62c56f98SSadaf Ebrahimi             ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC    &&
4991*62c56f98SSadaf Ebrahimi             ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4992*62c56f98SSadaf Ebrahimi             if (ssl->handshake == NULL) {
4993*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4994*62c56f98SSadaf Ebrahimi                 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4995*62c56f98SSadaf Ebrahimi             }
4996*62c56f98SSadaf Ebrahimi 
4997*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4998*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
4999*62c56f98SSadaf Ebrahimi         }
5000*62c56f98SSadaf Ebrahimi #endif
5001*62c56f98SSadaf Ebrahimi 
5002*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5003*62c56f98SSadaf Ebrahimi         if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5004*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
5005*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
5006*62c56f98SSadaf Ebrahimi                                   ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5007*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
5008*62c56f98SSadaf Ebrahimi #else
5009*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1,
5010*62c56f98SSadaf Ebrahimi                                   ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5011*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
5012*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5013*62c56f98SSadaf Ebrahimi         }
5014*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5015*62c56f98SSadaf Ebrahimi     }
5016*62c56f98SSadaf Ebrahimi 
5017*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5018*62c56f98SSadaf Ebrahimi         if (ssl->in_msglen != 2) {
5019*62c56f98SSadaf Ebrahimi             /* Note: Standard allows for more than one 2 byte alert
5020*62c56f98SSadaf Ebrahimi                to be packed in a single message, but Mbed TLS doesn't
5021*62c56f98SSadaf Ebrahimi                currently support this. */
5022*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5023*62c56f98SSadaf Ebrahimi                                       ssl->in_msglen));
5024*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INVALID_RECORD;
5025*62c56f98SSadaf Ebrahimi         }
5026*62c56f98SSadaf Ebrahimi 
5027*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5028*62c56f98SSadaf Ebrahimi                                   ssl->in_msg[0], ssl->in_msg[1]));
5029*62c56f98SSadaf Ebrahimi 
5030*62c56f98SSadaf Ebrahimi         /*
5031*62c56f98SSadaf Ebrahimi          * Ignore non-fatal alerts, except close_notify and no_renegotiation
5032*62c56f98SSadaf Ebrahimi          */
5033*62c56f98SSadaf Ebrahimi         if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5034*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5035*62c56f98SSadaf Ebrahimi                                       ssl->in_msg[1]));
5036*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
5037*62c56f98SSadaf Ebrahimi         }
5038*62c56f98SSadaf Ebrahimi 
5039*62c56f98SSadaf Ebrahimi         if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5040*62c56f98SSadaf Ebrahimi             ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5041*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5042*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
5043*62c56f98SSadaf Ebrahimi         }
5044*62c56f98SSadaf Ebrahimi 
5045*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
5046*62c56f98SSadaf Ebrahimi         if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5047*62c56f98SSadaf Ebrahimi             ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5048*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
5049*62c56f98SSadaf Ebrahimi             /* Will be handled when trying to parse ServerHello */
5050*62c56f98SSadaf Ebrahimi             return 0;
5051*62c56f98SSadaf Ebrahimi         }
5052*62c56f98SSadaf Ebrahimi #endif
5053*62c56f98SSadaf Ebrahimi         /* Silently ignore: fetch new message */
5054*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_NON_FATAL;
5055*62c56f98SSadaf Ebrahimi     }
5056*62c56f98SSadaf Ebrahimi 
5057*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5058*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5059*62c56f98SSadaf Ebrahimi         /* Drop unexpected ApplicationData records,
5060*62c56f98SSadaf Ebrahimi          * except at the beginning of renegotiations */
5061*62c56f98SSadaf Ebrahimi         if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5062*62c56f98SSadaf Ebrahimi             mbedtls_ssl_is_handshake_over(ssl) == 0
5063*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5064*62c56f98SSadaf Ebrahimi             && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5065*62c56f98SSadaf Ebrahimi                  ssl->state == MBEDTLS_SSL_SERVER_HELLO)
5066*62c56f98SSadaf Ebrahimi #endif
5067*62c56f98SSadaf Ebrahimi             ) {
5068*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5069*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_NON_FATAL;
5070*62c56f98SSadaf Ebrahimi         }
5071*62c56f98SSadaf Ebrahimi 
5072*62c56f98SSadaf Ebrahimi         if (ssl->handshake != NULL &&
5073*62c56f98SSadaf Ebrahimi             mbedtls_ssl_is_handshake_over(ssl) == 1) {
5074*62c56f98SSadaf Ebrahimi             mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
5075*62c56f98SSadaf Ebrahimi         }
5076*62c56f98SSadaf Ebrahimi     }
5077*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
5078*62c56f98SSadaf Ebrahimi 
5079*62c56f98SSadaf Ebrahimi     return 0;
5080*62c56f98SSadaf Ebrahimi }
5081*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context * ssl)5082*62c56f98SSadaf Ebrahimi int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
5083*62c56f98SSadaf Ebrahimi {
5084*62c56f98SSadaf Ebrahimi     return mbedtls_ssl_send_alert_message(ssl,
5085*62c56f98SSadaf Ebrahimi                                           MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5086*62c56f98SSadaf Ebrahimi                                           MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
5087*62c56f98SSadaf Ebrahimi }
5088*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_send_alert_message(mbedtls_ssl_context * ssl,unsigned char level,unsigned char message)5089*62c56f98SSadaf Ebrahimi int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5090*62c56f98SSadaf Ebrahimi                                    unsigned char level,
5091*62c56f98SSadaf Ebrahimi                                    unsigned char message)
5092*62c56f98SSadaf Ebrahimi {
5093*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5094*62c56f98SSadaf Ebrahimi 
5095*62c56f98SSadaf Ebrahimi     if (ssl == NULL || ssl->conf == NULL) {
5096*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5097*62c56f98SSadaf Ebrahimi     }
5098*62c56f98SSadaf Ebrahimi 
5099*62c56f98SSadaf Ebrahimi     if (ssl->out_left != 0) {
5100*62c56f98SSadaf Ebrahimi         return mbedtls_ssl_flush_output(ssl);
5101*62c56f98SSadaf Ebrahimi     }
5102*62c56f98SSadaf Ebrahimi 
5103*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5104*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
5105*62c56f98SSadaf Ebrahimi 
5106*62c56f98SSadaf Ebrahimi     ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
5107*62c56f98SSadaf Ebrahimi     ssl->out_msglen = 2;
5108*62c56f98SSadaf Ebrahimi     ssl->out_msg[0] = level;
5109*62c56f98SSadaf Ebrahimi     ssl->out_msg[1] = message;
5110*62c56f98SSadaf Ebrahimi 
5111*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5112*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5113*62c56f98SSadaf Ebrahimi         return ret;
5114*62c56f98SSadaf Ebrahimi     }
5115*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
5116*62c56f98SSadaf Ebrahimi 
5117*62c56f98SSadaf Ebrahimi     return 0;
5118*62c56f98SSadaf Ebrahimi }
5119*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context * ssl)5120*62c56f98SSadaf Ebrahimi int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
5121*62c56f98SSadaf Ebrahimi {
5122*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5123*62c56f98SSadaf Ebrahimi 
5124*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
5125*62c56f98SSadaf Ebrahimi 
5126*62c56f98SSadaf Ebrahimi     ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
5127*62c56f98SSadaf Ebrahimi     ssl->out_msglen  = 1;
5128*62c56f98SSadaf Ebrahimi     ssl->out_msg[0]  = 1;
5129*62c56f98SSadaf Ebrahimi 
5130*62c56f98SSadaf Ebrahimi     ssl->state++;
5131*62c56f98SSadaf Ebrahimi 
5132*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5133*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5134*62c56f98SSadaf Ebrahimi         return ret;
5135*62c56f98SSadaf Ebrahimi     }
5136*62c56f98SSadaf Ebrahimi 
5137*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
5138*62c56f98SSadaf Ebrahimi 
5139*62c56f98SSadaf Ebrahimi     return 0;
5140*62c56f98SSadaf Ebrahimi }
5141*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context * ssl)5142*62c56f98SSadaf Ebrahimi int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
5143*62c56f98SSadaf Ebrahimi {
5144*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5145*62c56f98SSadaf Ebrahimi 
5146*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
5147*62c56f98SSadaf Ebrahimi 
5148*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5149*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5150*62c56f98SSadaf Ebrahimi         return ret;
5151*62c56f98SSadaf Ebrahimi     }
5152*62c56f98SSadaf Ebrahimi 
5153*62c56f98SSadaf Ebrahimi     if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5154*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5155*62c56f98SSadaf Ebrahimi         mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5156*62c56f98SSadaf Ebrahimi                                        MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5157*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5158*62c56f98SSadaf Ebrahimi     }
5159*62c56f98SSadaf Ebrahimi 
5160*62c56f98SSadaf Ebrahimi     /* CCS records are only accepted if they have length 1 and content '1',
5161*62c56f98SSadaf Ebrahimi      * so we don't need to check this here. */
5162*62c56f98SSadaf Ebrahimi 
5163*62c56f98SSadaf Ebrahimi     /*
5164*62c56f98SSadaf Ebrahimi      * Switch to our negotiated transform and session parameters for inbound
5165*62c56f98SSadaf Ebrahimi      * data.
5166*62c56f98SSadaf Ebrahimi      */
5167*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
5168*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5169*62c56f98SSadaf Ebrahimi     ssl->transform_in = ssl->transform_negotiate;
5170*62c56f98SSadaf Ebrahimi #endif
5171*62c56f98SSadaf Ebrahimi     ssl->session_in = ssl->session_negotiate;
5172*62c56f98SSadaf Ebrahimi 
5173*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5174*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5175*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5176*62c56f98SSadaf Ebrahimi         mbedtls_ssl_dtls_replay_reset(ssl);
5177*62c56f98SSadaf Ebrahimi #endif
5178*62c56f98SSadaf Ebrahimi 
5179*62c56f98SSadaf Ebrahimi         /* Increment epoch */
5180*62c56f98SSadaf Ebrahimi         if (++ssl->in_epoch == 0) {
5181*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
5182*62c56f98SSadaf Ebrahimi             /* This is highly unlikely to happen for legitimate reasons, so
5183*62c56f98SSadaf Ebrahimi                treat it as an attack and don't send an alert. */
5184*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
5185*62c56f98SSadaf Ebrahimi         }
5186*62c56f98SSadaf Ebrahimi     } else
5187*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
5188*62c56f98SSadaf Ebrahimi     memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
5189*62c56f98SSadaf Ebrahimi 
5190*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_in_pointers(ssl);
5191*62c56f98SSadaf Ebrahimi 
5192*62c56f98SSadaf Ebrahimi     ssl->state++;
5193*62c56f98SSadaf Ebrahimi 
5194*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
5195*62c56f98SSadaf Ebrahimi 
5196*62c56f98SSadaf Ebrahimi     return 0;
5197*62c56f98SSadaf Ebrahimi }
5198*62c56f98SSadaf Ebrahimi 
5199*62c56f98SSadaf Ebrahimi /* Once ssl->out_hdr as the address of the beginning of the
5200*62c56f98SSadaf Ebrahimi  * next outgoing record is set, deduce the other pointers.
5201*62c56f98SSadaf Ebrahimi  *
5202*62c56f98SSadaf Ebrahimi  * Note: For TLS, we save the implicit record sequence number
5203*62c56f98SSadaf Ebrahimi  *       (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5204*62c56f98SSadaf Ebrahimi  *       and the caller has to make sure there's space for this.
5205*62c56f98SSadaf Ebrahimi  */
5206*62c56f98SSadaf Ebrahimi 
ssl_transform_get_explicit_iv_len(mbedtls_ssl_transform const * transform)5207*62c56f98SSadaf Ebrahimi static size_t ssl_transform_get_explicit_iv_len(
5208*62c56f98SSadaf Ebrahimi     mbedtls_ssl_transform const *transform)
5209*62c56f98SSadaf Ebrahimi {
5210*62c56f98SSadaf Ebrahimi     return transform->ivlen - transform->fixed_ivlen;
5211*62c56f98SSadaf Ebrahimi }
5212*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_update_out_pointers(mbedtls_ssl_context * ssl,mbedtls_ssl_transform * transform)5213*62c56f98SSadaf Ebrahimi void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5214*62c56f98SSadaf Ebrahimi                                      mbedtls_ssl_transform *transform)
5215*62c56f98SSadaf Ebrahimi {
5216*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5217*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5218*62c56f98SSadaf Ebrahimi         ssl->out_ctr = ssl->out_hdr +  3;
5219*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5220*62c56f98SSadaf Ebrahimi         ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5221*62c56f98SSadaf Ebrahimi         ssl->out_len = ssl->out_cid;
5222*62c56f98SSadaf Ebrahimi         if (transform != NULL) {
5223*62c56f98SSadaf Ebrahimi             ssl->out_len += transform->out_cid_len;
5224*62c56f98SSadaf Ebrahimi         }
5225*62c56f98SSadaf Ebrahimi #else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5226*62c56f98SSadaf Ebrahimi         ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5227*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5228*62c56f98SSadaf Ebrahimi         ssl->out_iv  = ssl->out_len + 2;
5229*62c56f98SSadaf Ebrahimi     } else
5230*62c56f98SSadaf Ebrahimi #endif
5231*62c56f98SSadaf Ebrahimi     {
5232*62c56f98SSadaf Ebrahimi         ssl->out_len = ssl->out_hdr + 3;
5233*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5234*62c56f98SSadaf Ebrahimi         ssl->out_cid = ssl->out_len;
5235*62c56f98SSadaf Ebrahimi #endif
5236*62c56f98SSadaf Ebrahimi         ssl->out_iv  = ssl->out_hdr + 5;
5237*62c56f98SSadaf Ebrahimi     }
5238*62c56f98SSadaf Ebrahimi 
5239*62c56f98SSadaf Ebrahimi     ssl->out_msg = ssl->out_iv;
5240*62c56f98SSadaf Ebrahimi     /* Adjust out_msg to make space for explicit IV, if used. */
5241*62c56f98SSadaf Ebrahimi     if (transform != NULL) {
5242*62c56f98SSadaf Ebrahimi         ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5243*62c56f98SSadaf Ebrahimi     }
5244*62c56f98SSadaf Ebrahimi }
5245*62c56f98SSadaf Ebrahimi 
5246*62c56f98SSadaf Ebrahimi /* Once ssl->in_hdr as the address of the beginning of the
5247*62c56f98SSadaf Ebrahimi  * next incoming record is set, deduce the other pointers.
5248*62c56f98SSadaf Ebrahimi  *
5249*62c56f98SSadaf Ebrahimi  * Note: For TLS, we save the implicit record sequence number
5250*62c56f98SSadaf Ebrahimi  *       (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5251*62c56f98SSadaf Ebrahimi  *       and the caller has to make sure there's space for this.
5252*62c56f98SSadaf Ebrahimi  */
5253*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_update_in_pointers(mbedtls_ssl_context * ssl)5254*62c56f98SSadaf Ebrahimi void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
5255*62c56f98SSadaf Ebrahimi {
5256*62c56f98SSadaf Ebrahimi     /* This function sets the pointers to match the case
5257*62c56f98SSadaf Ebrahimi      * of unprotected TLS/DTLS records, with both  ssl->in_iv
5258*62c56f98SSadaf Ebrahimi      * and ssl->in_msg pointing to the beginning of the record
5259*62c56f98SSadaf Ebrahimi      * content.
5260*62c56f98SSadaf Ebrahimi      *
5261*62c56f98SSadaf Ebrahimi      * When decrypting a protected record, ssl->in_msg
5262*62c56f98SSadaf Ebrahimi      * will be shifted to point to the beginning of the
5263*62c56f98SSadaf Ebrahimi      * record plaintext.
5264*62c56f98SSadaf Ebrahimi      */
5265*62c56f98SSadaf Ebrahimi 
5266*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5267*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5268*62c56f98SSadaf Ebrahimi         /* This sets the header pointers to match records
5269*62c56f98SSadaf Ebrahimi          * without CID. When we receive a record containing
5270*62c56f98SSadaf Ebrahimi          * a CID, the fields are shifted accordingly in
5271*62c56f98SSadaf Ebrahimi          * ssl_parse_record_header(). */
5272*62c56f98SSadaf Ebrahimi         ssl->in_ctr = ssl->in_hdr +  3;
5273*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5274*62c56f98SSadaf Ebrahimi         ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5275*62c56f98SSadaf Ebrahimi         ssl->in_len = ssl->in_cid; /* Default: no CID */
5276*62c56f98SSadaf Ebrahimi #else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5277*62c56f98SSadaf Ebrahimi         ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5278*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5279*62c56f98SSadaf Ebrahimi         ssl->in_iv  = ssl->in_len + 2;
5280*62c56f98SSadaf Ebrahimi     } else
5281*62c56f98SSadaf Ebrahimi #endif
5282*62c56f98SSadaf Ebrahimi     {
5283*62c56f98SSadaf Ebrahimi         ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5284*62c56f98SSadaf Ebrahimi         ssl->in_len = ssl->in_hdr + 3;
5285*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5286*62c56f98SSadaf Ebrahimi         ssl->in_cid = ssl->in_len;
5287*62c56f98SSadaf Ebrahimi #endif
5288*62c56f98SSadaf Ebrahimi         ssl->in_iv  = ssl->in_hdr + 5;
5289*62c56f98SSadaf Ebrahimi     }
5290*62c56f98SSadaf Ebrahimi 
5291*62c56f98SSadaf Ebrahimi     /* This will be adjusted at record decryption time. */
5292*62c56f98SSadaf Ebrahimi     ssl->in_msg = ssl->in_iv;
5293*62c56f98SSadaf Ebrahimi }
5294*62c56f98SSadaf Ebrahimi 
5295*62c56f98SSadaf Ebrahimi /*
5296*62c56f98SSadaf Ebrahimi  * Setup an SSL context
5297*62c56f98SSadaf Ebrahimi  */
5298*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context * ssl)5299*62c56f98SSadaf Ebrahimi void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
5300*62c56f98SSadaf Ebrahimi {
5301*62c56f98SSadaf Ebrahimi     /* Set the incoming and outgoing record pointers. */
5302*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5303*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5304*62c56f98SSadaf Ebrahimi         ssl->out_hdr = ssl->out_buf;
5305*62c56f98SSadaf Ebrahimi         ssl->in_hdr  = ssl->in_buf;
5306*62c56f98SSadaf Ebrahimi     } else
5307*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
5308*62c56f98SSadaf Ebrahimi     {
5309*62c56f98SSadaf Ebrahimi         ssl->out_ctr = ssl->out_buf;
5310*62c56f98SSadaf Ebrahimi         ssl->out_hdr = ssl->out_buf + 8;
5311*62c56f98SSadaf Ebrahimi         ssl->in_hdr  = ssl->in_buf  + 8;
5312*62c56f98SSadaf Ebrahimi     }
5313*62c56f98SSadaf Ebrahimi 
5314*62c56f98SSadaf Ebrahimi     /* Derive other internal pointers. */
5315*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5316*62c56f98SSadaf Ebrahimi     mbedtls_ssl_update_in_pointers(ssl);
5317*62c56f98SSadaf Ebrahimi }
5318*62c56f98SSadaf Ebrahimi 
5319*62c56f98SSadaf Ebrahimi /*
5320*62c56f98SSadaf Ebrahimi  * SSL get accessors
5321*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context * ssl)5322*62c56f98SSadaf Ebrahimi size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
5323*62c56f98SSadaf Ebrahimi {
5324*62c56f98SSadaf Ebrahimi     return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
5325*62c56f98SSadaf Ebrahimi }
5326*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_check_pending(const mbedtls_ssl_context * ssl)5327*62c56f98SSadaf Ebrahimi int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
5328*62c56f98SSadaf Ebrahimi {
5329*62c56f98SSadaf Ebrahimi     /*
5330*62c56f98SSadaf Ebrahimi      * Case A: We're currently holding back
5331*62c56f98SSadaf Ebrahimi      * a message for further processing.
5332*62c56f98SSadaf Ebrahimi      */
5333*62c56f98SSadaf Ebrahimi 
5334*62c56f98SSadaf Ebrahimi     if (ssl->keep_current_message == 1) {
5335*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5336*62c56f98SSadaf Ebrahimi         return 1;
5337*62c56f98SSadaf Ebrahimi     }
5338*62c56f98SSadaf Ebrahimi 
5339*62c56f98SSadaf Ebrahimi     /*
5340*62c56f98SSadaf Ebrahimi      * Case B: Further records are pending in the current datagram.
5341*62c56f98SSadaf Ebrahimi      */
5342*62c56f98SSadaf Ebrahimi 
5343*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5344*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5345*62c56f98SSadaf Ebrahimi         ssl->in_left > ssl->next_record_offset) {
5346*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5347*62c56f98SSadaf Ebrahimi         return 1;
5348*62c56f98SSadaf Ebrahimi     }
5349*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
5350*62c56f98SSadaf Ebrahimi 
5351*62c56f98SSadaf Ebrahimi     /*
5352*62c56f98SSadaf Ebrahimi      * Case C: A handshake message is being processed.
5353*62c56f98SSadaf Ebrahimi      */
5354*62c56f98SSadaf Ebrahimi 
5355*62c56f98SSadaf Ebrahimi     if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5356*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3,
5357*62c56f98SSadaf Ebrahimi                               ("ssl_check_pending: more handshake messages within current record"));
5358*62c56f98SSadaf Ebrahimi         return 1;
5359*62c56f98SSadaf Ebrahimi     }
5360*62c56f98SSadaf Ebrahimi 
5361*62c56f98SSadaf Ebrahimi     /*
5362*62c56f98SSadaf Ebrahimi      * Case D: An application data message is being processed
5363*62c56f98SSadaf Ebrahimi      */
5364*62c56f98SSadaf Ebrahimi     if (ssl->in_offt != NULL) {
5365*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5366*62c56f98SSadaf Ebrahimi         return 1;
5367*62c56f98SSadaf Ebrahimi     }
5368*62c56f98SSadaf Ebrahimi 
5369*62c56f98SSadaf Ebrahimi     /*
5370*62c56f98SSadaf Ebrahimi      * In all other cases, the rest of the message can be dropped.
5371*62c56f98SSadaf Ebrahimi      * As in ssl_get_next_record, this needs to be adapted if
5372*62c56f98SSadaf Ebrahimi      * we implement support for multiple alerts in single records.
5373*62c56f98SSadaf Ebrahimi      */
5374*62c56f98SSadaf Ebrahimi 
5375*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5376*62c56f98SSadaf Ebrahimi     return 0;
5377*62c56f98SSadaf Ebrahimi }
5378*62c56f98SSadaf Ebrahimi 
5379*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context * ssl)5380*62c56f98SSadaf Ebrahimi int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
5381*62c56f98SSadaf Ebrahimi {
5382*62c56f98SSadaf Ebrahimi     size_t transform_expansion = 0;
5383*62c56f98SSadaf Ebrahimi     const mbedtls_ssl_transform *transform = ssl->transform_out;
5384*62c56f98SSadaf Ebrahimi     unsigned block_size;
5385*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
5386*62c56f98SSadaf Ebrahimi     psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5387*62c56f98SSadaf Ebrahimi     psa_key_type_t key_type;
5388*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
5389*62c56f98SSadaf Ebrahimi 
5390*62c56f98SSadaf Ebrahimi     size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
5391*62c56f98SSadaf Ebrahimi 
5392*62c56f98SSadaf Ebrahimi     if (transform == NULL) {
5393*62c56f98SSadaf Ebrahimi         return (int) out_hdr_len;
5394*62c56f98SSadaf Ebrahimi     }
5395*62c56f98SSadaf Ebrahimi 
5396*62c56f98SSadaf Ebrahimi 
5397*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
5398*62c56f98SSadaf Ebrahimi     if (transform->psa_alg == PSA_ALG_GCM ||
5399*62c56f98SSadaf Ebrahimi         transform->psa_alg == PSA_ALG_CCM ||
5400*62c56f98SSadaf Ebrahimi         transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5401*62c56f98SSadaf Ebrahimi         transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5402*62c56f98SSadaf Ebrahimi         transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
5403*62c56f98SSadaf Ebrahimi         transform_expansion = transform->minlen;
5404*62c56f98SSadaf Ebrahimi     } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5405*62c56f98SSadaf Ebrahimi         (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5406*62c56f98SSadaf Ebrahimi         key_type = psa_get_key_type(&attr);
5407*62c56f98SSadaf Ebrahimi 
5408*62c56f98SSadaf Ebrahimi         block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
5409*62c56f98SSadaf Ebrahimi 
5410*62c56f98SSadaf Ebrahimi         /* Expansion due to the addition of the MAC. */
5411*62c56f98SSadaf Ebrahimi         transform_expansion += transform->maclen;
5412*62c56f98SSadaf Ebrahimi 
5413*62c56f98SSadaf Ebrahimi         /* Expansion due to the addition of CBC padding;
5414*62c56f98SSadaf Ebrahimi          * Theoretically up to 256 bytes, but we never use
5415*62c56f98SSadaf Ebrahimi          * more than the block size of the underlying cipher. */
5416*62c56f98SSadaf Ebrahimi         transform_expansion += block_size;
5417*62c56f98SSadaf Ebrahimi 
5418*62c56f98SSadaf Ebrahimi         /* For TLS 1.2 or higher, an explicit IV is added
5419*62c56f98SSadaf Ebrahimi          * after the record header. */
5420*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5421*62c56f98SSadaf Ebrahimi         transform_expansion += block_size;
5422*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5423*62c56f98SSadaf Ebrahimi     } else {
5424*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1,
5425*62c56f98SSadaf Ebrahimi                               ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5426*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5427*62c56f98SSadaf Ebrahimi     }
5428*62c56f98SSadaf Ebrahimi #else
5429*62c56f98SSadaf Ebrahimi     switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
5430*62c56f98SSadaf Ebrahimi         case MBEDTLS_MODE_GCM:
5431*62c56f98SSadaf Ebrahimi         case MBEDTLS_MODE_CCM:
5432*62c56f98SSadaf Ebrahimi         case MBEDTLS_MODE_CHACHAPOLY:
5433*62c56f98SSadaf Ebrahimi         case MBEDTLS_MODE_STREAM:
5434*62c56f98SSadaf Ebrahimi             transform_expansion = transform->minlen;
5435*62c56f98SSadaf Ebrahimi             break;
5436*62c56f98SSadaf Ebrahimi 
5437*62c56f98SSadaf Ebrahimi         case MBEDTLS_MODE_CBC:
5438*62c56f98SSadaf Ebrahimi 
5439*62c56f98SSadaf Ebrahimi             block_size = mbedtls_cipher_get_block_size(
5440*62c56f98SSadaf Ebrahimi                 &transform->cipher_ctx_enc);
5441*62c56f98SSadaf Ebrahimi 
5442*62c56f98SSadaf Ebrahimi             /* Expansion due to the addition of the MAC. */
5443*62c56f98SSadaf Ebrahimi             transform_expansion += transform->maclen;
5444*62c56f98SSadaf Ebrahimi 
5445*62c56f98SSadaf Ebrahimi             /* Expansion due to the addition of CBC padding;
5446*62c56f98SSadaf Ebrahimi              * Theoretically up to 256 bytes, but we never use
5447*62c56f98SSadaf Ebrahimi              * more than the block size of the underlying cipher. */
5448*62c56f98SSadaf Ebrahimi             transform_expansion += block_size;
5449*62c56f98SSadaf Ebrahimi 
5450*62c56f98SSadaf Ebrahimi             /* For TLS 1.2 or higher, an explicit IV is added
5451*62c56f98SSadaf Ebrahimi              * after the record header. */
5452*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5453*62c56f98SSadaf Ebrahimi             transform_expansion += block_size;
5454*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5455*62c56f98SSadaf Ebrahimi 
5456*62c56f98SSadaf Ebrahimi             break;
5457*62c56f98SSadaf Ebrahimi 
5458*62c56f98SSadaf Ebrahimi         default:
5459*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5460*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5461*62c56f98SSadaf Ebrahimi     }
5462*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
5463*62c56f98SSadaf Ebrahimi 
5464*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5465*62c56f98SSadaf Ebrahimi     if (transform->out_cid_len != 0) {
5466*62c56f98SSadaf Ebrahimi         transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
5467*62c56f98SSadaf Ebrahimi     }
5468*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5469*62c56f98SSadaf Ebrahimi 
5470*62c56f98SSadaf Ebrahimi     return (int) (out_hdr_len + transform_expansion);
5471*62c56f98SSadaf Ebrahimi }
5472*62c56f98SSadaf Ebrahimi 
5473*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5474*62c56f98SSadaf Ebrahimi /*
5475*62c56f98SSadaf Ebrahimi  * Check record counters and renegotiate if they're above the limit.
5476*62c56f98SSadaf Ebrahimi  */
5477*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_check_ctr_renegotiate(mbedtls_ssl_context * ssl)5478*62c56f98SSadaf Ebrahimi static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
5479*62c56f98SSadaf Ebrahimi {
5480*62c56f98SSadaf Ebrahimi     size_t ep_len = mbedtls_ssl_ep_len(ssl);
5481*62c56f98SSadaf Ebrahimi     int in_ctr_cmp;
5482*62c56f98SSadaf Ebrahimi     int out_ctr_cmp;
5483*62c56f98SSadaf Ebrahimi 
5484*62c56f98SSadaf Ebrahimi     if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
5485*62c56f98SSadaf Ebrahimi         ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
5486*62c56f98SSadaf Ebrahimi         ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5487*62c56f98SSadaf Ebrahimi         return 0;
5488*62c56f98SSadaf Ebrahimi     }
5489*62c56f98SSadaf Ebrahimi 
5490*62c56f98SSadaf Ebrahimi     in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5491*62c56f98SSadaf Ebrahimi                         &ssl->conf->renego_period[ep_len],
5492*62c56f98SSadaf Ebrahimi                         MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5493*62c56f98SSadaf Ebrahimi     out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
5494*62c56f98SSadaf Ebrahimi                          &ssl->conf->renego_period[ep_len],
5495*62c56f98SSadaf Ebrahimi                          sizeof(ssl->cur_out_ctr) - ep_len);
5496*62c56f98SSadaf Ebrahimi 
5497*62c56f98SSadaf Ebrahimi     if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5498*62c56f98SSadaf Ebrahimi         return 0;
5499*62c56f98SSadaf Ebrahimi     }
5500*62c56f98SSadaf Ebrahimi 
5501*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5502*62c56f98SSadaf Ebrahimi     return mbedtls_ssl_renegotiate(ssl);
5503*62c56f98SSadaf Ebrahimi }
5504*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_RENEGOTIATION */
5505*62c56f98SSadaf Ebrahimi 
5506*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5507*62c56f98SSadaf Ebrahimi 
5508*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
5509*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_tls13_check_new_session_ticket(mbedtls_ssl_context * ssl)5510*62c56f98SSadaf Ebrahimi static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
5511*62c56f98SSadaf Ebrahimi {
5512*62c56f98SSadaf Ebrahimi 
5513*62c56f98SSadaf Ebrahimi     if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5514*62c56f98SSadaf Ebrahimi         (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5515*62c56f98SSadaf Ebrahimi         return 0;
5516*62c56f98SSadaf Ebrahimi     }
5517*62c56f98SSadaf Ebrahimi 
5518*62c56f98SSadaf Ebrahimi     ssl->keep_current_message = 1;
5519*62c56f98SSadaf Ebrahimi 
5520*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5521*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_set_state(ssl,
5522*62c56f98SSadaf Ebrahimi                                     MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5523*62c56f98SSadaf Ebrahimi 
5524*62c56f98SSadaf Ebrahimi     return MBEDTLS_ERR_SSL_WANT_READ;
5525*62c56f98SSadaf Ebrahimi }
5526*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5527*62c56f98SSadaf Ebrahimi 
5528*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context * ssl)5529*62c56f98SSadaf Ebrahimi static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
5530*62c56f98SSadaf Ebrahimi {
5531*62c56f98SSadaf Ebrahimi 
5532*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
5533*62c56f98SSadaf Ebrahimi 
5534*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
5535*62c56f98SSadaf Ebrahimi     if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5536*62c56f98SSadaf Ebrahimi         int ret = ssl_tls13_check_new_session_ticket(ssl);
5537*62c56f98SSadaf Ebrahimi         if (ret != 0) {
5538*62c56f98SSadaf Ebrahimi             return ret;
5539*62c56f98SSadaf Ebrahimi         }
5540*62c56f98SSadaf Ebrahimi     }
5541*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5542*62c56f98SSadaf Ebrahimi 
5543*62c56f98SSadaf Ebrahimi     /* Fail in all other cases. */
5544*62c56f98SSadaf Ebrahimi     return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5545*62c56f98SSadaf Ebrahimi }
5546*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5547*62c56f98SSadaf Ebrahimi 
5548*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5549*62c56f98SSadaf Ebrahimi /* This function is called from mbedtls_ssl_read() when a handshake message is
5550*62c56f98SSadaf Ebrahimi  * received after the initial handshake. In this context, handshake messages
5551*62c56f98SSadaf Ebrahimi  * may only be sent for the purpose of initiating renegotiations.
5552*62c56f98SSadaf Ebrahimi  *
5553*62c56f98SSadaf Ebrahimi  * This function is introduced as a separate helper since the handling
5554*62c56f98SSadaf Ebrahimi  * of post-handshake handshake messages changes significantly in TLS 1.3,
5555*62c56f98SSadaf Ebrahimi  * and having a helper function allows to distinguish between TLS <= 1.2 and
5556*62c56f98SSadaf Ebrahimi  * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5557*62c56f98SSadaf Ebrahimi  */
5558*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context * ssl)5559*62c56f98SSadaf Ebrahimi static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
5560*62c56f98SSadaf Ebrahimi {
5561*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5562*62c56f98SSadaf Ebrahimi 
5563*62c56f98SSadaf Ebrahimi     /*
5564*62c56f98SSadaf Ebrahimi      * - For client-side, expect SERVER_HELLO_REQUEST.
5565*62c56f98SSadaf Ebrahimi      * - For server-side, expect CLIENT_HELLO.
5566*62c56f98SSadaf Ebrahimi      * - Fail (TLS) or silently drop record (DTLS) in other cases.
5567*62c56f98SSadaf Ebrahimi      */
5568*62c56f98SSadaf Ebrahimi 
5569*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_CLI_C)
5570*62c56f98SSadaf Ebrahimi     if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5571*62c56f98SSadaf Ebrahimi         (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5572*62c56f98SSadaf Ebrahimi          ssl->in_hslen  != mbedtls_ssl_hs_hdr_len(ssl))) {
5573*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
5574*62c56f98SSadaf Ebrahimi 
5575*62c56f98SSadaf Ebrahimi         /* With DTLS, drop the packet (probably from last handshake) */
5576*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5577*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5578*62c56f98SSadaf Ebrahimi             return 0;
5579*62c56f98SSadaf Ebrahimi         }
5580*62c56f98SSadaf Ebrahimi #endif
5581*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5582*62c56f98SSadaf Ebrahimi     }
5583*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_CLI_C */
5584*62c56f98SSadaf Ebrahimi 
5585*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SRV_C)
5586*62c56f98SSadaf Ebrahimi     if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5587*62c56f98SSadaf Ebrahimi         ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5588*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
5589*62c56f98SSadaf Ebrahimi 
5590*62c56f98SSadaf Ebrahimi         /* With DTLS, drop the packet (probably from last handshake) */
5591*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5592*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5593*62c56f98SSadaf Ebrahimi             return 0;
5594*62c56f98SSadaf Ebrahimi         }
5595*62c56f98SSadaf Ebrahimi #endif
5596*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5597*62c56f98SSadaf Ebrahimi     }
5598*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SRV_C */
5599*62c56f98SSadaf Ebrahimi 
5600*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5601*62c56f98SSadaf Ebrahimi     /* Determine whether renegotiation attempt should be accepted */
5602*62c56f98SSadaf Ebrahimi     if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5603*62c56f98SSadaf Ebrahimi           (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5604*62c56f98SSadaf Ebrahimi            ssl->conf->allow_legacy_renegotiation ==
5605*62c56f98SSadaf Ebrahimi            MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
5606*62c56f98SSadaf Ebrahimi         /*
5607*62c56f98SSadaf Ebrahimi          * Accept renegotiation request
5608*62c56f98SSadaf Ebrahimi          */
5609*62c56f98SSadaf Ebrahimi 
5610*62c56f98SSadaf Ebrahimi         /* DTLS clients need to know renego is server-initiated */
5611*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5612*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5613*62c56f98SSadaf Ebrahimi             ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5614*62c56f98SSadaf Ebrahimi             ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5615*62c56f98SSadaf Ebrahimi         }
5616*62c56f98SSadaf Ebrahimi #endif
5617*62c56f98SSadaf Ebrahimi         ret = mbedtls_ssl_start_renegotiation(ssl);
5618*62c56f98SSadaf Ebrahimi         if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5619*62c56f98SSadaf Ebrahimi             ret != 0) {
5620*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5621*62c56f98SSadaf Ebrahimi                                   ret);
5622*62c56f98SSadaf Ebrahimi             return ret;
5623*62c56f98SSadaf Ebrahimi         }
5624*62c56f98SSadaf Ebrahimi     } else
5625*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_RENEGOTIATION */
5626*62c56f98SSadaf Ebrahimi     {
5627*62c56f98SSadaf Ebrahimi         /*
5628*62c56f98SSadaf Ebrahimi          * Refuse renegotiation
5629*62c56f98SSadaf Ebrahimi          */
5630*62c56f98SSadaf Ebrahimi 
5631*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
5632*62c56f98SSadaf Ebrahimi 
5633*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_send_alert_message(ssl,
5634*62c56f98SSadaf Ebrahimi                                                   MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5635*62c56f98SSadaf Ebrahimi                                                   MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5636*62c56f98SSadaf Ebrahimi             return ret;
5637*62c56f98SSadaf Ebrahimi         }
5638*62c56f98SSadaf Ebrahimi     }
5639*62c56f98SSadaf Ebrahimi 
5640*62c56f98SSadaf Ebrahimi     return 0;
5641*62c56f98SSadaf Ebrahimi }
5642*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5643*62c56f98SSadaf Ebrahimi 
5644*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_handle_hs_message_post_handshake(mbedtls_ssl_context * ssl)5645*62c56f98SSadaf Ebrahimi static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
5646*62c56f98SSadaf Ebrahimi {
5647*62c56f98SSadaf Ebrahimi     /* Check protocol version and dispatch accordingly. */
5648*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5649*62c56f98SSadaf Ebrahimi     if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5650*62c56f98SSadaf Ebrahimi         return ssl_tls13_handle_hs_message_post_handshake(ssl);
5651*62c56f98SSadaf Ebrahimi     }
5652*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5653*62c56f98SSadaf Ebrahimi 
5654*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5655*62c56f98SSadaf Ebrahimi     if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5656*62c56f98SSadaf Ebrahimi         return ssl_tls12_handle_hs_message_post_handshake(ssl);
5657*62c56f98SSadaf Ebrahimi     }
5658*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5659*62c56f98SSadaf Ebrahimi 
5660*62c56f98SSadaf Ebrahimi     /* Should never happen */
5661*62c56f98SSadaf Ebrahimi     return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5662*62c56f98SSadaf Ebrahimi }
5663*62c56f98SSadaf Ebrahimi 
5664*62c56f98SSadaf Ebrahimi /*
5665*62c56f98SSadaf Ebrahimi  * Receive application data decrypted from the SSL layer
5666*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_read(mbedtls_ssl_context * ssl,unsigned char * buf,size_t len)5667*62c56f98SSadaf Ebrahimi int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5668*62c56f98SSadaf Ebrahimi {
5669*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5670*62c56f98SSadaf Ebrahimi     size_t n;
5671*62c56f98SSadaf Ebrahimi 
5672*62c56f98SSadaf Ebrahimi     if (ssl == NULL || ssl->conf == NULL) {
5673*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5674*62c56f98SSadaf Ebrahimi     }
5675*62c56f98SSadaf Ebrahimi 
5676*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
5677*62c56f98SSadaf Ebrahimi 
5678*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5679*62c56f98SSadaf Ebrahimi     if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5680*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5681*62c56f98SSadaf Ebrahimi             return ret;
5682*62c56f98SSadaf Ebrahimi         }
5683*62c56f98SSadaf Ebrahimi 
5684*62c56f98SSadaf Ebrahimi         if (ssl->handshake != NULL &&
5685*62c56f98SSadaf Ebrahimi             ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5686*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5687*62c56f98SSadaf Ebrahimi                 return ret;
5688*62c56f98SSadaf Ebrahimi             }
5689*62c56f98SSadaf Ebrahimi         }
5690*62c56f98SSadaf Ebrahimi     }
5691*62c56f98SSadaf Ebrahimi #endif
5692*62c56f98SSadaf Ebrahimi 
5693*62c56f98SSadaf Ebrahimi     /*
5694*62c56f98SSadaf Ebrahimi      * Check if renegotiation is necessary and/or handshake is
5695*62c56f98SSadaf Ebrahimi      * in process. If yes, perform/continue, and fall through
5696*62c56f98SSadaf Ebrahimi      * if an unexpected packet is received while the client
5697*62c56f98SSadaf Ebrahimi      * is waiting for the ServerHello.
5698*62c56f98SSadaf Ebrahimi      *
5699*62c56f98SSadaf Ebrahimi      * (There is no equivalent to the last condition on
5700*62c56f98SSadaf Ebrahimi      *  the server-side as it is not treated as within
5701*62c56f98SSadaf Ebrahimi      *  a handshake while waiting for the ClientHello
5702*62c56f98SSadaf Ebrahimi      *  after a renegotiation request.)
5703*62c56f98SSadaf Ebrahimi      */
5704*62c56f98SSadaf Ebrahimi 
5705*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5706*62c56f98SSadaf Ebrahimi     ret = ssl_check_ctr_renegotiate(ssl);
5707*62c56f98SSadaf Ebrahimi     if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5708*62c56f98SSadaf Ebrahimi         ret != 0) {
5709*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5710*62c56f98SSadaf Ebrahimi         return ret;
5711*62c56f98SSadaf Ebrahimi     }
5712*62c56f98SSadaf Ebrahimi #endif
5713*62c56f98SSadaf Ebrahimi 
5714*62c56f98SSadaf Ebrahimi     if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5715*62c56f98SSadaf Ebrahimi         ret = mbedtls_ssl_handshake(ssl);
5716*62c56f98SSadaf Ebrahimi         if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5717*62c56f98SSadaf Ebrahimi             ret != 0) {
5718*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5719*62c56f98SSadaf Ebrahimi             return ret;
5720*62c56f98SSadaf Ebrahimi         }
5721*62c56f98SSadaf Ebrahimi     }
5722*62c56f98SSadaf Ebrahimi 
5723*62c56f98SSadaf Ebrahimi     /* Loop as long as no application data record is available */
5724*62c56f98SSadaf Ebrahimi     while (ssl->in_offt == NULL) {
5725*62c56f98SSadaf Ebrahimi         /* Start timer if not already running */
5726*62c56f98SSadaf Ebrahimi         if (ssl->f_get_timer != NULL &&
5727*62c56f98SSadaf Ebrahimi             ssl->f_get_timer(ssl->p_timer) == -1) {
5728*62c56f98SSadaf Ebrahimi             mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
5729*62c56f98SSadaf Ebrahimi         }
5730*62c56f98SSadaf Ebrahimi 
5731*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5732*62c56f98SSadaf Ebrahimi             if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5733*62c56f98SSadaf Ebrahimi                 return 0;
5734*62c56f98SSadaf Ebrahimi             }
5735*62c56f98SSadaf Ebrahimi 
5736*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5737*62c56f98SSadaf Ebrahimi             return ret;
5738*62c56f98SSadaf Ebrahimi         }
5739*62c56f98SSadaf Ebrahimi 
5740*62c56f98SSadaf Ebrahimi         if (ssl->in_msglen  == 0 &&
5741*62c56f98SSadaf Ebrahimi             ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5742*62c56f98SSadaf Ebrahimi             /*
5743*62c56f98SSadaf Ebrahimi              * OpenSSL sends empty messages to randomize the IV
5744*62c56f98SSadaf Ebrahimi              */
5745*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5746*62c56f98SSadaf Ebrahimi                 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5747*62c56f98SSadaf Ebrahimi                     return 0;
5748*62c56f98SSadaf Ebrahimi                 }
5749*62c56f98SSadaf Ebrahimi 
5750*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5751*62c56f98SSadaf Ebrahimi                 return ret;
5752*62c56f98SSadaf Ebrahimi             }
5753*62c56f98SSadaf Ebrahimi         }
5754*62c56f98SSadaf Ebrahimi 
5755*62c56f98SSadaf Ebrahimi         if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5756*62c56f98SSadaf Ebrahimi             ret = ssl_handle_hs_message_post_handshake(ssl);
5757*62c56f98SSadaf Ebrahimi             if (ret != 0) {
5758*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5759*62c56f98SSadaf Ebrahimi                                       ret);
5760*62c56f98SSadaf Ebrahimi                 return ret;
5761*62c56f98SSadaf Ebrahimi             }
5762*62c56f98SSadaf Ebrahimi 
5763*62c56f98SSadaf Ebrahimi             /* At this point, we don't know whether the renegotiation triggered
5764*62c56f98SSadaf Ebrahimi              * by the post-handshake message has been completed or not. The cases
5765*62c56f98SSadaf Ebrahimi              * to consider are the following:
5766*62c56f98SSadaf Ebrahimi              * 1) The renegotiation is complete. In this case, no new record
5767*62c56f98SSadaf Ebrahimi              *    has been read yet.
5768*62c56f98SSadaf Ebrahimi              * 2) The renegotiation is incomplete because the client received
5769*62c56f98SSadaf Ebrahimi              *    an application data record while awaiting the ServerHello.
5770*62c56f98SSadaf Ebrahimi              * 3) The renegotiation is incomplete because the client received
5771*62c56f98SSadaf Ebrahimi              *    a non-handshake, non-application data message while awaiting
5772*62c56f98SSadaf Ebrahimi              *    the ServerHello.
5773*62c56f98SSadaf Ebrahimi              *
5774*62c56f98SSadaf Ebrahimi              * In each of these cases, looping will be the proper action:
5775*62c56f98SSadaf Ebrahimi              * - For 1), the next iteration will read a new record and check
5776*62c56f98SSadaf Ebrahimi              *   if it's application data.
5777*62c56f98SSadaf Ebrahimi              * - For 2), the loop condition isn't satisfied as application data
5778*62c56f98SSadaf Ebrahimi              *   is present, hence continue is the same as break
5779*62c56f98SSadaf Ebrahimi              * - For 3), the loop condition is satisfied and read_record
5780*62c56f98SSadaf Ebrahimi              *   will re-deliver the message that was held back by the client
5781*62c56f98SSadaf Ebrahimi              *   when expecting the ServerHello.
5782*62c56f98SSadaf Ebrahimi              */
5783*62c56f98SSadaf Ebrahimi 
5784*62c56f98SSadaf Ebrahimi             continue;
5785*62c56f98SSadaf Ebrahimi         }
5786*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5787*62c56f98SSadaf Ebrahimi         else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5788*62c56f98SSadaf Ebrahimi             if (ssl->conf->renego_max_records >= 0) {
5789*62c56f98SSadaf Ebrahimi                 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5790*62c56f98SSadaf Ebrahimi                     MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5791*62c56f98SSadaf Ebrahimi                                               "but not honored by client"));
5792*62c56f98SSadaf Ebrahimi                     return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5793*62c56f98SSadaf Ebrahimi                 }
5794*62c56f98SSadaf Ebrahimi             }
5795*62c56f98SSadaf Ebrahimi         }
5796*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_RENEGOTIATION */
5797*62c56f98SSadaf Ebrahimi 
5798*62c56f98SSadaf Ebrahimi         /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5799*62c56f98SSadaf Ebrahimi         if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5800*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5801*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_WANT_READ;
5802*62c56f98SSadaf Ebrahimi         }
5803*62c56f98SSadaf Ebrahimi 
5804*62c56f98SSadaf Ebrahimi         if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5805*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5806*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
5807*62c56f98SSadaf Ebrahimi         }
5808*62c56f98SSadaf Ebrahimi 
5809*62c56f98SSadaf Ebrahimi         ssl->in_offt = ssl->in_msg;
5810*62c56f98SSadaf Ebrahimi 
5811*62c56f98SSadaf Ebrahimi         /* We're going to return something now, cancel timer,
5812*62c56f98SSadaf Ebrahimi          * except if handshake (renegotiation) is in progress */
5813*62c56f98SSadaf Ebrahimi         if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5814*62c56f98SSadaf Ebrahimi             mbedtls_ssl_set_timer(ssl, 0);
5815*62c56f98SSadaf Ebrahimi         }
5816*62c56f98SSadaf Ebrahimi 
5817*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5818*62c56f98SSadaf Ebrahimi         /* If we requested renego but received AppData, resend HelloRequest.
5819*62c56f98SSadaf Ebrahimi          * Do it now, after setting in_offt, to avoid taking this branch
5820*62c56f98SSadaf Ebrahimi          * again if ssl_write_hello_request() returns WANT_WRITE */
5821*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5822*62c56f98SSadaf Ebrahimi         if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5823*62c56f98SSadaf Ebrahimi             ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5824*62c56f98SSadaf Ebrahimi             if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5825*62c56f98SSadaf Ebrahimi                 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5826*62c56f98SSadaf Ebrahimi                                       ret);
5827*62c56f98SSadaf Ebrahimi                 return ret;
5828*62c56f98SSadaf Ebrahimi             }
5829*62c56f98SSadaf Ebrahimi         }
5830*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
5831*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
5832*62c56f98SSadaf Ebrahimi     }
5833*62c56f98SSadaf Ebrahimi 
5834*62c56f98SSadaf Ebrahimi     n = (len < ssl->in_msglen)
5835*62c56f98SSadaf Ebrahimi         ? len : ssl->in_msglen;
5836*62c56f98SSadaf Ebrahimi 
5837*62c56f98SSadaf Ebrahimi     if (len != 0) {
5838*62c56f98SSadaf Ebrahimi         memcpy(buf, ssl->in_offt, n);
5839*62c56f98SSadaf Ebrahimi         ssl->in_msglen -= n;
5840*62c56f98SSadaf Ebrahimi     }
5841*62c56f98SSadaf Ebrahimi 
5842*62c56f98SSadaf Ebrahimi     /* Zeroising the plaintext buffer to erase unused application data
5843*62c56f98SSadaf Ebrahimi        from the memory. */
5844*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(ssl->in_offt, n);
5845*62c56f98SSadaf Ebrahimi 
5846*62c56f98SSadaf Ebrahimi     if (ssl->in_msglen == 0) {
5847*62c56f98SSadaf Ebrahimi         /* all bytes consumed */
5848*62c56f98SSadaf Ebrahimi         ssl->in_offt = NULL;
5849*62c56f98SSadaf Ebrahimi         ssl->keep_current_message = 0;
5850*62c56f98SSadaf Ebrahimi     } else {
5851*62c56f98SSadaf Ebrahimi         /* more data available */
5852*62c56f98SSadaf Ebrahimi         ssl->in_offt += n;
5853*62c56f98SSadaf Ebrahimi     }
5854*62c56f98SSadaf Ebrahimi 
5855*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
5856*62c56f98SSadaf Ebrahimi 
5857*62c56f98SSadaf Ebrahimi     return (int) n;
5858*62c56f98SSadaf Ebrahimi }
5859*62c56f98SSadaf Ebrahimi 
5860*62c56f98SSadaf Ebrahimi /*
5861*62c56f98SSadaf Ebrahimi  * Send application data to be encrypted by the SSL layer, taking care of max
5862*62c56f98SSadaf Ebrahimi  * fragment length and buffer size.
5863*62c56f98SSadaf Ebrahimi  *
5864*62c56f98SSadaf Ebrahimi  * According to RFC 5246 Section 6.2.1:
5865*62c56f98SSadaf Ebrahimi  *
5866*62c56f98SSadaf Ebrahimi  *      Zero-length fragments of Application data MAY be sent as they are
5867*62c56f98SSadaf Ebrahimi  *      potentially useful as a traffic analysis countermeasure.
5868*62c56f98SSadaf Ebrahimi  *
5869*62c56f98SSadaf Ebrahimi  * Therefore, it is possible that the input message length is 0 and the
5870*62c56f98SSadaf Ebrahimi  * corresponding return code is 0 on success.
5871*62c56f98SSadaf Ebrahimi  */
5872*62c56f98SSadaf Ebrahimi MBEDTLS_CHECK_RETURN_CRITICAL
ssl_write_real(mbedtls_ssl_context * ssl,const unsigned char * buf,size_t len)5873*62c56f98SSadaf Ebrahimi static int ssl_write_real(mbedtls_ssl_context *ssl,
5874*62c56f98SSadaf Ebrahimi                           const unsigned char *buf, size_t len)
5875*62c56f98SSadaf Ebrahimi {
5876*62c56f98SSadaf Ebrahimi     int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
5877*62c56f98SSadaf Ebrahimi     const size_t max_len = (size_t) ret;
5878*62c56f98SSadaf Ebrahimi 
5879*62c56f98SSadaf Ebrahimi     if (ret < 0) {
5880*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5881*62c56f98SSadaf Ebrahimi         return ret;
5882*62c56f98SSadaf Ebrahimi     }
5883*62c56f98SSadaf Ebrahimi 
5884*62c56f98SSadaf Ebrahimi     if (len > max_len) {
5885*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
5886*62c56f98SSadaf Ebrahimi         if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5887*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5888*62c56f98SSadaf Ebrahimi                                       "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5889*62c56f98SSadaf Ebrahimi                                       " > %" MBEDTLS_PRINTF_SIZET,
5890*62c56f98SSadaf Ebrahimi                                       len, max_len));
5891*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5892*62c56f98SSadaf Ebrahimi         } else
5893*62c56f98SSadaf Ebrahimi #endif
5894*62c56f98SSadaf Ebrahimi         len = max_len;
5895*62c56f98SSadaf Ebrahimi     }
5896*62c56f98SSadaf Ebrahimi 
5897*62c56f98SSadaf Ebrahimi     if (ssl->out_left != 0) {
5898*62c56f98SSadaf Ebrahimi         /*
5899*62c56f98SSadaf Ebrahimi          * The user has previously tried to send the data and
5900*62c56f98SSadaf Ebrahimi          * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5901*62c56f98SSadaf Ebrahimi          * written. In this case, we expect the high-level write function
5902*62c56f98SSadaf Ebrahimi          * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5903*62c56f98SSadaf Ebrahimi          */
5904*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5905*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5906*62c56f98SSadaf Ebrahimi             return ret;
5907*62c56f98SSadaf Ebrahimi         }
5908*62c56f98SSadaf Ebrahimi     } else {
5909*62c56f98SSadaf Ebrahimi         /*
5910*62c56f98SSadaf Ebrahimi          * The user is trying to send a message the first time, so we need to
5911*62c56f98SSadaf Ebrahimi          * copy the data into the internal buffers and setup the data structure
5912*62c56f98SSadaf Ebrahimi          * to keep track of partial writes
5913*62c56f98SSadaf Ebrahimi          */
5914*62c56f98SSadaf Ebrahimi         ssl->out_msglen  = len;
5915*62c56f98SSadaf Ebrahimi         ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
5916*62c56f98SSadaf Ebrahimi         if (len > 0) {
5917*62c56f98SSadaf Ebrahimi             memcpy(ssl->out_msg, buf, len);
5918*62c56f98SSadaf Ebrahimi         }
5919*62c56f98SSadaf Ebrahimi 
5920*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5921*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5922*62c56f98SSadaf Ebrahimi             return ret;
5923*62c56f98SSadaf Ebrahimi         }
5924*62c56f98SSadaf Ebrahimi     }
5925*62c56f98SSadaf Ebrahimi 
5926*62c56f98SSadaf Ebrahimi     return (int) len;
5927*62c56f98SSadaf Ebrahimi }
5928*62c56f98SSadaf Ebrahimi 
5929*62c56f98SSadaf Ebrahimi /*
5930*62c56f98SSadaf Ebrahimi  * Write application data (public-facing wrapper)
5931*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_write(mbedtls_ssl_context * ssl,const unsigned char * buf,size_t len)5932*62c56f98SSadaf Ebrahimi int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
5933*62c56f98SSadaf Ebrahimi {
5934*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5935*62c56f98SSadaf Ebrahimi 
5936*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
5937*62c56f98SSadaf Ebrahimi 
5938*62c56f98SSadaf Ebrahimi     if (ssl == NULL || ssl->conf == NULL) {
5939*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5940*62c56f98SSadaf Ebrahimi     }
5941*62c56f98SSadaf Ebrahimi 
5942*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_RENEGOTIATION)
5943*62c56f98SSadaf Ebrahimi     if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5944*62c56f98SSadaf Ebrahimi         MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5945*62c56f98SSadaf Ebrahimi         return ret;
5946*62c56f98SSadaf Ebrahimi     }
5947*62c56f98SSadaf Ebrahimi #endif
5948*62c56f98SSadaf Ebrahimi 
5949*62c56f98SSadaf Ebrahimi     if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5950*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5951*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5952*62c56f98SSadaf Ebrahimi             return ret;
5953*62c56f98SSadaf Ebrahimi         }
5954*62c56f98SSadaf Ebrahimi     }
5955*62c56f98SSadaf Ebrahimi 
5956*62c56f98SSadaf Ebrahimi     ret = ssl_write_real(ssl, buf, len);
5957*62c56f98SSadaf Ebrahimi 
5958*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
5959*62c56f98SSadaf Ebrahimi 
5960*62c56f98SSadaf Ebrahimi     return ret;
5961*62c56f98SSadaf Ebrahimi }
5962*62c56f98SSadaf Ebrahimi 
5963*62c56f98SSadaf Ebrahimi /*
5964*62c56f98SSadaf Ebrahimi  * Notify the peer that the connection is being closed
5965*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_close_notify(mbedtls_ssl_context * ssl)5966*62c56f98SSadaf Ebrahimi int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
5967*62c56f98SSadaf Ebrahimi {
5968*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5969*62c56f98SSadaf Ebrahimi 
5970*62c56f98SSadaf Ebrahimi     if (ssl == NULL || ssl->conf == NULL) {
5971*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5972*62c56f98SSadaf Ebrahimi     }
5973*62c56f98SSadaf Ebrahimi 
5974*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
5975*62c56f98SSadaf Ebrahimi 
5976*62c56f98SSadaf Ebrahimi     if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5977*62c56f98SSadaf Ebrahimi         if ((ret = mbedtls_ssl_send_alert_message(ssl,
5978*62c56f98SSadaf Ebrahimi                                                   MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5979*62c56f98SSadaf Ebrahimi                                                   MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5980*62c56f98SSadaf Ebrahimi             MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5981*62c56f98SSadaf Ebrahimi             return ret;
5982*62c56f98SSadaf Ebrahimi         }
5983*62c56f98SSadaf Ebrahimi     }
5984*62c56f98SSadaf Ebrahimi 
5985*62c56f98SSadaf Ebrahimi     MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
5986*62c56f98SSadaf Ebrahimi 
5987*62c56f98SSadaf Ebrahimi     return 0;
5988*62c56f98SSadaf Ebrahimi }
5989*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_transform_free(mbedtls_ssl_transform * transform)5990*62c56f98SSadaf Ebrahimi void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
5991*62c56f98SSadaf Ebrahimi {
5992*62c56f98SSadaf Ebrahimi     if (transform == NULL) {
5993*62c56f98SSadaf Ebrahimi         return;
5994*62c56f98SSadaf Ebrahimi     }
5995*62c56f98SSadaf Ebrahimi 
5996*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
5997*62c56f98SSadaf Ebrahimi     psa_destroy_key(transform->psa_key_enc);
5998*62c56f98SSadaf Ebrahimi     psa_destroy_key(transform->psa_key_dec);
5999*62c56f98SSadaf Ebrahimi #else
6000*62c56f98SSadaf Ebrahimi     mbedtls_cipher_free(&transform->cipher_ctx_enc);
6001*62c56f98SSadaf Ebrahimi     mbedtls_cipher_free(&transform->cipher_ctx_dec);
6002*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
6003*62c56f98SSadaf Ebrahimi 
6004*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6005*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_USE_PSA_CRYPTO)
6006*62c56f98SSadaf Ebrahimi     psa_destroy_key(transform->psa_mac_enc);
6007*62c56f98SSadaf Ebrahimi     psa_destroy_key(transform->psa_mac_dec);
6008*62c56f98SSadaf Ebrahimi #else
6009*62c56f98SSadaf Ebrahimi     mbedtls_md_free(&transform->md_ctx_enc);
6010*62c56f98SSadaf Ebrahimi     mbedtls_md_free(&transform->md_ctx_dec);
6011*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_USE_PSA_CRYPTO */
6012*62c56f98SSadaf Ebrahimi #endif
6013*62c56f98SSadaf Ebrahimi 
6014*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
6015*62c56f98SSadaf Ebrahimi }
6016*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context * ssl,mbedtls_ssl_transform * transform)6017*62c56f98SSadaf Ebrahimi void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6018*62c56f98SSadaf Ebrahimi                                        mbedtls_ssl_transform *transform)
6019*62c56f98SSadaf Ebrahimi {
6020*62c56f98SSadaf Ebrahimi     ssl->transform_in = transform;
6021*62c56f98SSadaf Ebrahimi     memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
6022*62c56f98SSadaf Ebrahimi }
6023*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context * ssl,mbedtls_ssl_transform * transform)6024*62c56f98SSadaf Ebrahimi void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6025*62c56f98SSadaf Ebrahimi                                         mbedtls_ssl_transform *transform)
6026*62c56f98SSadaf Ebrahimi {
6027*62c56f98SSadaf Ebrahimi     ssl->transform_out = transform;
6028*62c56f98SSadaf Ebrahimi     memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
6029*62c56f98SSadaf Ebrahimi }
6030*62c56f98SSadaf Ebrahimi 
6031*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
6032*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_buffering_free(mbedtls_ssl_context * ssl)6033*62c56f98SSadaf Ebrahimi void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
6034*62c56f98SSadaf Ebrahimi {
6035*62c56f98SSadaf Ebrahimi     unsigned offset;
6036*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6037*62c56f98SSadaf Ebrahimi 
6038*62c56f98SSadaf Ebrahimi     if (hs == NULL) {
6039*62c56f98SSadaf Ebrahimi         return;
6040*62c56f98SSadaf Ebrahimi     }
6041*62c56f98SSadaf Ebrahimi 
6042*62c56f98SSadaf Ebrahimi     ssl_free_buffered_record(ssl);
6043*62c56f98SSadaf Ebrahimi 
6044*62c56f98SSadaf Ebrahimi     for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6045*62c56f98SSadaf Ebrahimi         ssl_buffering_free_slot(ssl, offset);
6046*62c56f98SSadaf Ebrahimi     }
6047*62c56f98SSadaf Ebrahimi }
6048*62c56f98SSadaf Ebrahimi 
ssl_buffering_free_slot(mbedtls_ssl_context * ssl,uint8_t slot)6049*62c56f98SSadaf Ebrahimi static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6050*62c56f98SSadaf Ebrahimi                                     uint8_t slot)
6051*62c56f98SSadaf Ebrahimi {
6052*62c56f98SSadaf Ebrahimi     mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6053*62c56f98SSadaf Ebrahimi     mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
6054*62c56f98SSadaf Ebrahimi 
6055*62c56f98SSadaf Ebrahimi     if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
6056*62c56f98SSadaf Ebrahimi         return;
6057*62c56f98SSadaf Ebrahimi     }
6058*62c56f98SSadaf Ebrahimi 
6059*62c56f98SSadaf Ebrahimi     if (hs_buf->is_valid == 1) {
6060*62c56f98SSadaf Ebrahimi         hs->buffering.total_bytes_buffered -= hs_buf->data_len;
6061*62c56f98SSadaf Ebrahimi         mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
6062*62c56f98SSadaf Ebrahimi         memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
6063*62c56f98SSadaf Ebrahimi     }
6064*62c56f98SSadaf Ebrahimi }
6065*62c56f98SSadaf Ebrahimi 
6066*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_PROTO_DTLS */
6067*62c56f98SSadaf Ebrahimi 
6068*62c56f98SSadaf Ebrahimi /*
6069*62c56f98SSadaf Ebrahimi  * Convert version numbers to/from wire format
6070*62c56f98SSadaf Ebrahimi  * and, for DTLS, to/from TLS equivalent.
6071*62c56f98SSadaf Ebrahimi  *
6072*62c56f98SSadaf Ebrahimi  * For TLS this is the identity.
6073*62c56f98SSadaf Ebrahimi  * For DTLS, map as follows, then use 1's complement (v -> ~v):
6074*62c56f98SSadaf Ebrahimi  * 1.x <-> 3.x+1    for x != 0 (DTLS 1.2 based on TLS 1.2)
6075*62c56f98SSadaf Ebrahimi  *                  DTLS 1.0 is stored as TLS 1.1 internally
6076*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_write_version(unsigned char version[2],int transport,mbedtls_ssl_protocol_version tls_version)6077*62c56f98SSadaf Ebrahimi void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6078*62c56f98SSadaf Ebrahimi                                mbedtls_ssl_protocol_version tls_version)
6079*62c56f98SSadaf Ebrahimi {
6080*62c56f98SSadaf Ebrahimi     uint16_t tls_version_formatted;
6081*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
6082*62c56f98SSadaf Ebrahimi     if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
6083*62c56f98SSadaf Ebrahimi         tls_version_formatted =
6084*62c56f98SSadaf Ebrahimi             ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
6085*62c56f98SSadaf Ebrahimi     } else
6086*62c56f98SSadaf Ebrahimi #else
6087*62c56f98SSadaf Ebrahimi     ((void) transport);
6088*62c56f98SSadaf Ebrahimi #endif
6089*62c56f98SSadaf Ebrahimi     {
6090*62c56f98SSadaf Ebrahimi         tls_version_formatted = (uint16_t) tls_version;
6091*62c56f98SSadaf Ebrahimi     }
6092*62c56f98SSadaf Ebrahimi     MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
6093*62c56f98SSadaf Ebrahimi }
6094*62c56f98SSadaf Ebrahimi 
mbedtls_ssl_read_version(const unsigned char version[2],int transport)6095*62c56f98SSadaf Ebrahimi uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6096*62c56f98SSadaf Ebrahimi                                   int transport)
6097*62c56f98SSadaf Ebrahimi {
6098*62c56f98SSadaf Ebrahimi     uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
6099*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_SSL_PROTO_DTLS)
6100*62c56f98SSadaf Ebrahimi     if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
6101*62c56f98SSadaf Ebrahimi         tls_version =
6102*62c56f98SSadaf Ebrahimi             ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6103*62c56f98SSadaf Ebrahimi     }
6104*62c56f98SSadaf Ebrahimi #else
6105*62c56f98SSadaf Ebrahimi     ((void) transport);
6106*62c56f98SSadaf Ebrahimi #endif
6107*62c56f98SSadaf Ebrahimi     return tls_version;
6108*62c56f98SSadaf Ebrahimi }
6109*62c56f98SSadaf Ebrahimi 
6110*62c56f98SSadaf Ebrahimi /*
6111*62c56f98SSadaf Ebrahimi  * Send pending fatal alert.
6112*62c56f98SSadaf Ebrahimi  * 0,   No alert message.
6113*62c56f98SSadaf Ebrahimi  * !0,  if mbedtls_ssl_send_alert_message() returned in error, the error code it
6114*62c56f98SSadaf Ebrahimi  *      returned, ssl->alert_reason otherwise.
6115*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context * ssl)6116*62c56f98SSadaf Ebrahimi int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
6117*62c56f98SSadaf Ebrahimi {
6118*62c56f98SSadaf Ebrahimi     int ret;
6119*62c56f98SSadaf Ebrahimi 
6120*62c56f98SSadaf Ebrahimi     /* No pending alert, return success*/
6121*62c56f98SSadaf Ebrahimi     if (ssl->send_alert == 0) {
6122*62c56f98SSadaf Ebrahimi         return 0;
6123*62c56f98SSadaf Ebrahimi     }
6124*62c56f98SSadaf Ebrahimi 
6125*62c56f98SSadaf Ebrahimi     ret = mbedtls_ssl_send_alert_message(ssl,
6126*62c56f98SSadaf Ebrahimi                                          MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6127*62c56f98SSadaf Ebrahimi                                          ssl->alert_type);
6128*62c56f98SSadaf Ebrahimi 
6129*62c56f98SSadaf Ebrahimi     /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6130*62c56f98SSadaf Ebrahimi      * do not clear the alert to be able to send it later.
6131*62c56f98SSadaf Ebrahimi      */
6132*62c56f98SSadaf Ebrahimi     if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
6133*62c56f98SSadaf Ebrahimi         ssl->send_alert = 0;
6134*62c56f98SSadaf Ebrahimi     }
6135*62c56f98SSadaf Ebrahimi 
6136*62c56f98SSadaf Ebrahimi     if (ret != 0) {
6137*62c56f98SSadaf Ebrahimi         return ret;
6138*62c56f98SSadaf Ebrahimi     }
6139*62c56f98SSadaf Ebrahimi 
6140*62c56f98SSadaf Ebrahimi     return ssl->alert_reason;
6141*62c56f98SSadaf Ebrahimi }
6142*62c56f98SSadaf Ebrahimi 
6143*62c56f98SSadaf Ebrahimi /*
6144*62c56f98SSadaf Ebrahimi  * Set pending fatal alert flag.
6145*62c56f98SSadaf Ebrahimi  */
mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context * ssl,unsigned char alert_type,int alert_reason)6146*62c56f98SSadaf Ebrahimi void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6147*62c56f98SSadaf Ebrahimi                                   unsigned char alert_type,
6148*62c56f98SSadaf Ebrahimi                                   int alert_reason)
6149*62c56f98SSadaf Ebrahimi {
6150*62c56f98SSadaf Ebrahimi     ssl->send_alert = 1;
6151*62c56f98SSadaf Ebrahimi     ssl->alert_type = alert_type;
6152*62c56f98SSadaf Ebrahimi     ssl->alert_reason = alert_reason;
6153*62c56f98SSadaf Ebrahimi }
6154*62c56f98SSadaf Ebrahimi 
6155*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_SSL_TLS_C */
6156