blob: 54ea129617bdb83b668b10192f8f333b4dc794c3 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010062
Hanno Beckera0e20d02019-05-15 14:03:01 +010063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010064/* Top-level Connection ID API */
65
Hanno Becker8367ccc2019-05-14 11:30:10 +010066int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
67 size_t len,
68 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010069{
70 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
71 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
72
Hanno Becker611ac772019-05-14 11:45:26 +010073 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
74 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
75 {
76 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
77 }
78
79 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010080 conf->cid_len = len;
81 return( 0 );
82}
83
Hanno Beckerf8542cf2019-04-09 15:22:03 +010084int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
85 int enable,
86 unsigned char const *own_cid,
87 size_t own_cid_len )
88{
Hanno Becker76a79ab2019-05-03 14:38:32 +010089 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
90 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
91
Hanno Beckerca092242019-04-25 16:01:49 +010092 ssl->negotiate_cid = enable;
93 if( enable == MBEDTLS_SSL_CID_DISABLED )
94 {
95 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
96 return( 0 );
97 }
98 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +010099 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100100
Hanno Beckerad4a1372019-05-03 13:06:44 +0100101 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100102 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
104 (unsigned) own_cid_len,
105 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100106 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
107 }
108
109 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100110 /* Truncation is not an issue here because
111 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
112 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100114 return( 0 );
115}
116
Paul Elliott0113cf12022-03-11 20:26:47 +0000117int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
118 int *enabled,
119 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
120 size_t *own_cid_len )
121{
122 *enabled = MBEDTLS_SSL_CID_DISABLED;
123
124 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
126
127 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
128 * zero as this is indistinguishable from not requesting to use
129 * the CID extension. */
130 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
131 return( 0 );
132
133 if( own_cid_len != NULL )
134 {
135 *own_cid_len = ssl->own_cid_len;
136 if( own_cid != NULL )
137 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
138 }
139
140 *enabled = MBEDTLS_SSL_CID_ENABLED;
141
142 return( 0 );
143}
144
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100145int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
146 int *enabled,
147 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
148 size_t *peer_cid_len )
149{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100150 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100151
Hanno Becker76a79ab2019-05-03 14:38:32 +0100152 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000153 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100154 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100156 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100157
Hanno Beckerc5f24222019-05-03 12:54:52 +0100158 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
159 * were used, but client and server requested the empty CID.
160 * This is indistinguishable from not using the CID extension
161 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100162 if( ssl->transform_in->in_cid_len == 0 &&
163 ssl->transform_in->out_cid_len == 0 )
164 {
165 return( 0 );
166 }
167
Hanno Becker615ef172019-05-22 16:50:35 +0100168 if( peer_cid_len != NULL )
169 {
170 *peer_cid_len = ssl->transform_in->out_cid_len;
171 if( peer_cid != NULL )
172 {
173 memcpy( peer_cid, ssl->transform_in->out_cid,
174 ssl->transform_in->out_cid_len );
175 }
176 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177
178 *enabled = MBEDTLS_SSL_CID_ENABLED;
179
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100180 return( 0 );
181}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200187/*
188 * Convert max_fragment_length codes to length.
189 * RFC 6066 says:
190 * enum{
191 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
192 * } MaxFragmentLength;
193 * and we add 0 -> extension unused
194 */
Angus Grattond8213d02016-05-25 20:56:48 +1000195static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196{
Angus Grattond8213d02016-05-25 20:56:48 +1000197 switch( mfl )
198 {
199 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
200 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
201 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
202 return 512;
203 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
204 return 1024;
205 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
206 return 2048;
207 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
208 return 4096;
209 default:
210 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
211 }
212}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214
Hanno Becker52055ae2019-02-06 14:30:46 +0000215int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
216 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200217{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 mbedtls_ssl_session_free( dst );
219 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200220
吴敬辉0b716112021-11-29 10:46:35 +0800221#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
222 dst->ticket = NULL;
223#endif
224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000226
227#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200228 if( src->peer_cert != NULL )
229 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000230 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200231
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200232 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200233 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200234 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200239 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200242 dst->peer_cert = NULL;
243 return( ret );
244 }
245 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000247 if( src->peer_cert_digest != NULL )
248 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000249 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000250 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000251 if( dst->peer_cert_digest == NULL )
252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
253
254 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
255 src->peer_cert_digest_len );
256 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000257 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000258 }
259#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 if( src->ticket != NULL )
265 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200266 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200267 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200268 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200269
270 memcpy( dst->ticket, src->ticket, src->ticket_len );
271 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200272#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200273
274 return( 0 );
275}
276
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500277#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
278static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
279{
280 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
281 if( resized_buffer == NULL )
282 return -1;
283
284 /* We want to copy len_new bytes when downsizing the buffer, and
285 * len_old bytes when upsizing, so we choose the smaller of two sizes,
286 * to fit one buffer into another. Size checks, ensuring that no data is
287 * lost, are done outside of this function. */
288 memcpy( resized_buffer, *buffer,
289 ( len_new < *len_old ) ? len_new : *len_old );
290 mbedtls_platform_zeroize( *buffer, *len_old );
291 mbedtls_free( *buffer );
292
293 *buffer = resized_buffer;
294 *len_old = len_new;
295
296 return 0;
297}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200298
299static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500300 size_t in_buf_new_len,
301 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200302{
303 int modified = 0;
304 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
305 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
306 if( ssl->in_buf != NULL )
307 {
308 written_in = ssl->in_msg - ssl->in_buf;
309 iv_offset_in = ssl->in_iv - ssl->in_buf;
310 len_offset_in = ssl->in_len - ssl->in_buf;
311 if( downsizing ?
312 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
313 ssl->in_buf_len < in_buf_new_len )
314 {
315 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
316 {
317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
318 }
319 else
320 {
Paul Elliottb7449902021-03-10 18:14:58 +0000321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
322 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323 modified = 1;
324 }
325 }
326 }
327
328 if( ssl->out_buf != NULL )
329 {
330 written_out = ssl->out_msg - ssl->out_buf;
331 iv_offset_out = ssl->out_iv - ssl->out_buf;
332 len_offset_out = ssl->out_len - ssl->out_buf;
333 if( downsizing ?
334 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
335 ssl->out_buf_len < out_buf_new_len )
336 {
337 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
338 {
339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
340 }
341 else
342 {
Paul Elliottb7449902021-03-10 18:14:58 +0000343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
344 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349 if( modified )
350 {
351 /* Update pointers here to avoid doing it twice. */
352 mbedtls_ssl_reset_in_out_pointers( ssl );
353 /* Fields below might not be properly updated with record
354 * splitting or with CID, so they are manually updated here. */
355 ssl->out_msg = ssl->out_buf + written_out;
356 ssl->out_len = ssl->out_buf + len_offset_out;
357 ssl->out_iv = ssl->out_buf + iv_offset_out;
358
359 ssl->in_msg = ssl->in_buf + written_in;
360 ssl->in_len = ssl->in_buf + len_offset_in;
361 ssl->in_iv = ssl->in_buf + iv_offset_in;
362 }
363}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500364#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
365
Jerry Yudb8c48a2022-01-27 14:54:54 +0800366#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800367
368#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
369typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
370 const char *label,
371 const unsigned char *random, size_t rlen,
372 unsigned char *dstbuf, size_t dlen );
373
374static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
375
376#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
377
378/* Type for the TLS PRF */
379typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
380 const unsigned char *, size_t,
381 unsigned char *, size_t);
382
383static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
384 int ciphersuite,
385 const unsigned char master[48],
386#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
387 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
388 int encrypt_then_mac,
389#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
390 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
391 ssl_tls_prf_t tls_prf,
392 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400393 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800394 unsigned endpoint,
395 const mbedtls_ssl_context *ssl );
396
397#if defined(MBEDTLS_SHA256_C)
398static int tls_prf_sha256( const unsigned char *secret, size_t slen,
399 const char *label,
400 const unsigned char *random, size_t rlen,
401 unsigned char *dstbuf, size_t dlen );
402static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
403static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
404
405#endif /* MBEDTLS_SHA256_C */
406
407#if defined(MBEDTLS_SHA384_C)
408static int tls_prf_sha384( const unsigned char *secret, size_t slen,
409 const char *label,
410 const unsigned char *random, size_t rlen,
411 unsigned char *dstbuf, size_t dlen );
412
413static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
414static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
415#endif /* MBEDTLS_SHA384_C */
416
417static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
418 unsigned char *buf,
419 size_t buf_len );
420static int ssl_session_load_tls12( mbedtls_ssl_session *session,
421 const unsigned char *buf,
422 size_t len );
423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
424
Jerry Yu53d23e22022-02-09 16:25:09 +0800425static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
426
Jerry Yudb8c48a2022-01-27 14:54:54 +0800427#if defined(MBEDTLS_SHA256_C)
428static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800429#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800430
431#if defined(MBEDTLS_SHA384_C)
432static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800433#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000434
Ron Eldor51d3ab52019-05-12 14:54:30 +0300435int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
436 const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen )
440{
441 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
442
443 switch( prf )
444 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200446#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300447 case MBEDTLS_SSL_TLS_PRF_SHA384:
448 tls_prf = tls_prf_sha384;
449 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200450#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300451#if defined(MBEDTLS_SHA256_C)
452 case MBEDTLS_SSL_TLS_PRF_SHA256:
453 tls_prf = tls_prf_sha256;
454 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300455#endif /* MBEDTLS_SHA256_C */
456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300457 default:
458 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
459 }
460
461 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
462}
463
Jerry Yuc73c6182022-02-08 20:29:25 +0800464#if defined(MBEDTLS_X509_CRT_PARSE_C)
465static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
466{
467#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
468 if( session->peer_cert != NULL )
469 {
470 mbedtls_x509_crt_free( session->peer_cert );
471 mbedtls_free( session->peer_cert );
472 session->peer_cert = NULL;
473 }
474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
475 if( session->peer_cert_digest != NULL )
476 {
477 /* Zeroization is not necessary. */
478 mbedtls_free( session->peer_cert_digest );
479 session->peer_cert_digest = NULL;
480 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
481 session->peer_cert_digest_len = 0;
482 }
483#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
484}
485#endif /* MBEDTLS_X509_CRT_PARSE_C */
486
487void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
488 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
489{
490 ((void) ciphersuite_info);
491
492#if defined(MBEDTLS_SHA384_C)
493 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
494 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
495 else
496#endif
497#if defined(MBEDTLS_SHA256_C)
498 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
499 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
500 else
501#endif
502 {
503 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
504 return;
505 }
506}
507
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100508static void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
509 unsigned hs_type,
510 size_t total_hs_len )
511{
512 unsigned char hs_hdr[4];
513
514 /* Build HS header for checksum update. */
515 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
516 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
517 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
518 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
519
520 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
521}
522
523void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
524 unsigned hs_type,
525 unsigned char const *msg,
526 size_t msg_len )
527{
528 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
529 ssl->handshake->update_checksum( ssl, msg, msg_len );
530}
531
Jerry Yuc73c6182022-02-08 20:29:25 +0800532void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
533{
534 ((void) ssl);
535#if defined(MBEDTLS_SHA256_C)
536#if defined(MBEDTLS_USE_PSA_CRYPTO)
537 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
538 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
539#else
540 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
541#endif
542#endif
543#if defined(MBEDTLS_SHA384_C)
544#if defined(MBEDTLS_USE_PSA_CRYPTO)
545 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
546 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
547#else
548 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
549#endif
550#endif
551}
552
553static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
554 const unsigned char *buf, size_t len )
555{
556#if defined(MBEDTLS_SHA256_C)
557#if defined(MBEDTLS_USE_PSA_CRYPTO)
558 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
559#else
560 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
561#endif
562#endif
563#if defined(MBEDTLS_SHA384_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
566#else
567 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
568#endif
569#endif
570}
571
572#if defined(MBEDTLS_SHA256_C)
573static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
574 const unsigned char *buf, size_t len )
575{
576#if defined(MBEDTLS_USE_PSA_CRYPTO)
577 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
578#else
579 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
580#endif
581}
582#endif
583
584#if defined(MBEDTLS_SHA384_C)
585static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
586 const unsigned char *buf, size_t len )
587{
588#if defined(MBEDTLS_USE_PSA_CRYPTO)
589 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
590#else
591 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
592#endif
593}
594#endif
595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500601#if defined(MBEDTLS_USE_PSA_CRYPTO)
602 handshake->fin_sha256_psa = psa_hash_operation_init();
603 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
604#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200606 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200607#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500608#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200609#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500610#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500611 handshake->fin_sha384_psa = psa_hash_operation_init();
612 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500613#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200615 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200616#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500617#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200618
619 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100620
621#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100622 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100623 mbedtls_ssl_sig_hash_set_init( &handshake->hash_algs );
624#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626#if defined(MBEDTLS_DHM_C)
627 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200628#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629#if defined(MBEDTLS_ECDH_C)
630 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200631#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200632#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200633 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200634#if defined(MBEDTLS_SSL_CLI_C)
635 handshake->ecjpake_cache = NULL;
636 handshake->ecjpake_cache_len = 0;
637#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200638#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200639
Gilles Peskineeccd8882020-03-10 12:19:08 +0100640#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200641 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200642#endif
643
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
645 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
646#endif
Hanno Becker75173122019-02-06 16:18:31 +0000647
648#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
649 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
650 mbedtls_pk_init( &handshake->peer_pubkey );
651#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200652}
653
Hanno Beckera18d1322018-01-03 14:27:32 +0000654void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200655{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200657
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100658#if defined(MBEDTLS_USE_PSA_CRYPTO)
659 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
660 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100661#else
662 mbedtls_cipher_init( &transform->cipher_ctx_enc );
663 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100664#endif
665
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000666#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100667#if defined(MBEDTLS_USE_PSA_CRYPTO)
668 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
669 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100670#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 mbedtls_md_init( &transform->md_ctx_enc );
672 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000673#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200680}
681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000683{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200684 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000685 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200687 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200689 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200690 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200691
692 /*
693 * Either the pointers are now NULL or cleared properly and can be freed.
694 * Now allocate missing structures.
695 */
696 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200697 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200698 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200699 }
Paul Bakker48916f92012-09-16 19:57:18 +0000700
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200702 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200703 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200704 }
Paul Bakker48916f92012-09-16 19:57:18 +0000705
Paul Bakker82788fb2014-10-20 13:59:19 +0200706 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200707 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200708 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200709 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500710#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
711 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400712
Andrzej Kurek4a063792020-10-21 15:08:44 +0200713 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
714 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500715#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000716
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200717 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000718 if( ssl->handshake == NULL ||
719 ssl->transform_negotiate == NULL ||
720 ssl->session_negotiate == NULL )
721 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 mbedtls_free( ssl->handshake );
725 mbedtls_free( ssl->transform_negotiate );
726 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200727
728 ssl->handshake = NULL;
729 ssl->transform_negotiate = NULL;
730 ssl->session_negotiate = NULL;
731
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000733 }
734
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200735 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000737 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200738 ssl_handshake_params_init( ssl->handshake );
739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200741 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
742 {
743 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200744
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200745 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
746 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
747 else
748 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200749
Hanno Becker0f57a652020-02-05 10:37:26 +0000750 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200751 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200752#endif
753
Brett Warrene0edc842021-08-17 09:53:13 +0100754/*
755 * curve_list is translated to IANA TLS group identifiers here because
756 * mbedtls_ssl_conf_curves returns void and so can't return
757 * any error codes.
758 */
759#if defined(MBEDTLS_ECP_C)
760#if !defined(MBEDTLS_DEPRECATED_REMOVED)
761 /* Heap allocate and translate curve_list from internal to IANA group ids */
762 if ( ssl->conf->curve_list != NULL )
763 {
764 size_t length;
765 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
766
767 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
768 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
769
770 /* Leave room for zero termination */
771 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
772 if ( group_list == NULL )
773 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
774
775 for( size_t i = 0; i < length; i++ )
776 {
777 const mbedtls_ecp_curve_info *info =
778 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
779 if ( info == NULL )
780 {
781 mbedtls_free( group_list );
782 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
783 }
784 group_list[i] = info->tls_id;
785 }
786
787 group_list[length] = 0;
788
789 ssl->handshake->group_list = group_list;
790 ssl->handshake->group_list_heap_allocated = 1;
791 }
792 else
793 {
794 ssl->handshake->group_list = ssl->conf->group_list;
795 ssl->handshake->group_list_heap_allocated = 0;
796 }
797#endif /* MBEDTLS_DEPRECATED_REMOVED */
798#endif /* MBEDTLS_ECP_C */
799
Jerry Yuf017ee42022-01-12 15:49:48 +0800800#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
801#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800802#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800803 /* Heap allocate and translate sig_hashes from internal hash identifiers to
804 signature algorithms IANA identifiers. */
805 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800806 ssl->conf->sig_hashes != NULL )
807 {
808 const int *md;
809 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800810 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800811 uint16_t *p;
812
Jerry Yub476a442022-01-21 18:14:45 +0800813#if defined(static_assert)
814 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
815 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
816 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800817#endif
818
Jerry Yuf017ee42022-01-12 15:49:48 +0800819 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
820 {
821 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
822 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800823#if defined(MBEDTLS_ECDSA_C)
824 sig_algs_len += sizeof( uint16_t );
825#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800826
Jerry Yub476a442022-01-21 18:14:45 +0800827#if defined(MBEDTLS_RSA_C)
828 sig_algs_len += sizeof( uint16_t );
829#endif
830 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
831 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800832 }
833
Jerry Yub476a442022-01-21 18:14:45 +0800834 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
836
Jerry Yub476a442022-01-21 18:14:45 +0800837 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
838 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800839 if( ssl->handshake->sig_algs == NULL )
840 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
841
842 p = (uint16_t *)ssl->handshake->sig_algs;
843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
846 if( hash == MBEDTLS_SSL_HASH_NONE )
847 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800848#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800849 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
850 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800851#endif
852#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800853 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
854 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800855#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857 *p = MBEDTLS_TLS1_3_SIG_NONE;
858 ssl->handshake->sig_algs_heap_allocated = 1;
859 }
860 else
Jerry Yua69269a2022-01-17 21:06:01 +0800861#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800862 {
863 ssl->handshake->sig_algs = ssl->conf->sig_algs;
864 ssl->handshake->sig_algs_heap_allocated = 0;
865 }
866#endif /* MBEDTLS_DEPRECATED_REMOVED */
867#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000868 return( 0 );
869}
870
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200871#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200872/* Dummy cookie callbacks for defaults */
873static int ssl_cookie_write_dummy( void *ctx,
874 unsigned char **p, unsigned char *end,
875 const unsigned char *cli_id, size_t cli_id_len )
876{
877 ((void) ctx);
878 ((void) p);
879 ((void) end);
880 ((void) cli_id);
881 ((void) cli_id_len);
882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200884}
885
886static int ssl_cookie_check_dummy( void *ctx,
887 const unsigned char *cookie, size_t cookie_len,
888 const unsigned char *cli_id, size_t cli_id_len )
889{
890 ((void) ctx);
891 ((void) cookie);
892 ((void) cookie_len);
893 ((void) cli_id);
894 ((void) cli_id_len);
895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200898#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200899
Paul Bakker5121ce52009-01-03 21:22:43 +0000900/*
901 * Initialize an SSL context
902 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200903void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
904{
905 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
906}
907
Jerry Yu60835a82021-08-04 10:13:52 +0800908static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
909{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100910 const mbedtls_ssl_config *conf = ssl->conf;
911
Ronald Cron6f135e12021-12-08 16:57:54 +0100912#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100913 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
914 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
916 {
917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
920
Jerry Yu60835a82021-08-04 10:13:52 +0800921 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
922 return( 0 );
923 }
924#endif
925
926#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100927 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800928 {
929 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
930 return( 0 );
931 }
932#endif
933
Ronald Cron6f135e12021-12-08 16:57:54 +0100934#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100935 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800936 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000937 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
938 {
939 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
940 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
941 }
942
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
944 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800945 }
946#endif
947
948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
949 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
950}
951
952static int ssl_conf_check(const mbedtls_ssl_context *ssl)
953{
954 int ret;
955 ret = ssl_conf_version_check( ssl );
956 if( ret != 0 )
957 return( ret );
958
959 /* Space for further checks */
960
961 return( 0 );
962}
963
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200964/*
965 * Setup an SSL context
966 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100967
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200968int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200969 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000970{
Janos Follath865b3eb2019-12-16 11:46:15 +0000971 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000972 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
973 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000974
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200975 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000976
Jerry Yu60835a82021-08-04 10:13:52 +0800977 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
978 return( ret );
979
Paul Bakker62f2dee2012-09-28 07:31:51 +0000980 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100981 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000982 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200983
984 /* Set to NULL in case of an error condition */
985 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200986
Darryl Greenb33cc762019-11-28 14:29:44 +0000987#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
988 ssl->in_buf_len = in_buf_len;
989#endif
990 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +1000991 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +0000992 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000993 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +0200994 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +0200995 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +1000996 }
997
Darryl Greenb33cc762019-11-28 14:29:44 +0000998#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
999 ssl->out_buf_len = out_buf_len;
1000#endif
1001 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001002 if( ssl->out_buf == NULL )
1003 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001005 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001006 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001007 }
1008
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001009 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001010
Johan Pascalb62bb512015-12-03 21:56:45 +01001011#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001012 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001013#endif
1014
Paul Bakker48916f92012-09-16 19:57:18 +00001015 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001016 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001017
1018 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001019
1020error:
1021 mbedtls_free( ssl->in_buf );
1022 mbedtls_free( ssl->out_buf );
1023
1024 ssl->conf = NULL;
1025
Darryl Greenb33cc762019-11-28 14:29:44 +00001026#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1027 ssl->in_buf_len = 0;
1028 ssl->out_buf_len = 0;
1029#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001030 ssl->in_buf = NULL;
1031 ssl->out_buf = NULL;
1032
1033 ssl->in_hdr = NULL;
1034 ssl->in_ctr = NULL;
1035 ssl->in_len = NULL;
1036 ssl->in_iv = NULL;
1037 ssl->in_msg = NULL;
1038
1039 ssl->out_hdr = NULL;
1040 ssl->out_ctr = NULL;
1041 ssl->out_len = NULL;
1042 ssl->out_iv = NULL;
1043 ssl->out_msg = NULL;
1044
k-stachowiak9f7798e2018-07-31 16:52:32 +02001045 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001046}
1047
1048/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001049 * Reset an initialized and used SSL context for re-use while retaining
1050 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001051 *
1052 * If partial is non-zero, keep data in the input buffer and client ID.
1053 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001054 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001055void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1056 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001057{
Darryl Greenb33cc762019-11-28 14:29:44 +00001058#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1059 size_t in_buf_len = ssl->in_buf_len;
1060 size_t out_buf_len = ssl->out_buf_len;
1061#else
1062 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1063 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1064#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001065
Hanno Beckerb0302c42021-08-03 09:39:42 +01001066#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1067 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001068#endif
1069
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001070 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001071 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001072
Hanno Beckerb0302c42021-08-03 09:39:42 +01001073 mbedtls_ssl_reset_in_out_pointers( ssl );
1074
1075 /* Reset incoming message parsing */
1076 ssl->in_offt = NULL;
1077 ssl->nb_zero = 0;
1078 ssl->in_msgtype = 0;
1079 ssl->in_msglen = 0;
1080 ssl->in_hslen = 0;
1081 ssl->keep_current_message = 0;
1082 ssl->transform_in = NULL;
1083
1084#if defined(MBEDTLS_SSL_PROTO_DTLS)
1085 ssl->next_record_offset = 0;
1086 ssl->in_epoch = 0;
1087#endif
1088
1089 /* Keep current datagram if partial == 1 */
1090 if( partial == 0 )
1091 {
1092 ssl->in_left = 0;
1093 memset( ssl->in_buf, 0, in_buf_len );
1094 }
1095
1096 /* Reset outgoing message writing */
1097 ssl->out_msgtype = 0;
1098 ssl->out_msglen = 0;
1099 ssl->out_left = 0;
1100 memset( ssl->out_buf, 0, out_buf_len );
1101 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1102 ssl->transform_out = NULL;
1103
1104#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1105 mbedtls_ssl_dtls_replay_reset( ssl );
1106#endif
1107
XiaokangQian2b01dc32022-01-21 02:53:13 +00001108#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001109 if( ssl->transform )
1110 {
1111 mbedtls_ssl_transform_free( ssl->transform );
1112 mbedtls_free( ssl->transform );
1113 ssl->transform = NULL;
1114 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001115#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1116
XiaokangQian2b01dc32022-01-21 02:53:13 +00001117#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1118 mbedtls_ssl_transform_free( ssl->transform_application );
1119 mbedtls_free( ssl->transform_application );
1120 ssl->transform_application = NULL;
1121
1122 if( ssl->handshake != NULL )
1123 {
1124 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1125 mbedtls_free( ssl->handshake->transform_earlydata );
1126 ssl->handshake->transform_earlydata = NULL;
1127
1128 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1129 mbedtls_free( ssl->handshake->transform_handshake );
1130 ssl->handshake->transform_handshake = NULL;
1131 }
1132
XiaokangQian2b01dc32022-01-21 02:53:13 +00001133#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001134}
1135
1136int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1137{
1138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1139
1140 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1141
XiaokangQian78b1fa72022-01-19 06:56:30 +00001142 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001143
1144 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145#if defined(MBEDTLS_SSL_RENEGOTIATION)
1146 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001147 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001148
1149 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1151 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001152#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001154
Hanno Beckerb0302c42021-08-03 09:39:42 +01001155 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001156 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001157 if( ssl->session )
1158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 mbedtls_ssl_session_free( ssl->session );
1160 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001161 ssl->session = NULL;
1162 }
1163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001165 ssl->alpn_chosen = NULL;
1166#endif
1167
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001168#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001169#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001170 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001171#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001172 {
1173 mbedtls_free( ssl->cli_id );
1174 ssl->cli_id = NULL;
1175 ssl->cli_id_len = 0;
1176 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001177#endif
1178
Paul Bakker48916f92012-09-16 19:57:18 +00001179 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1180 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001181
1182 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001183}
1184
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001185/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001186 * Reset an initialized and used SSL context for re-use while retaining
1187 * all application-set variables, function pointers and data.
1188 */
1189int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1190{
Hanno Becker43aefe22020-02-05 10:44:56 +00001191 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001192}
1193
1194/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001195 * SSL set accessors
1196 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001197void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001198{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001199 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001200}
1201
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001202void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001204 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001205}
1206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001208void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001209{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001210 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001211}
1212#endif
1213
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001214void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001216 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001217}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001220
Hanno Becker1841b0a2018-08-24 11:13:57 +01001221void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1222 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001223{
1224 ssl->disable_datagram_packing = !allow_packing;
1225}
1226
1227void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1228 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001229{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001230 conf->hs_timeout_min = min;
1231 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001232}
1233#endif
1234
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001235void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001236{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001237 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001238}
1239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001241void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001242 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001243 void *p_vrfy )
1244{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001245 conf->f_vrfy = f_vrfy;
1246 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001247}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001251 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001252 void *p_rng )
1253{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001254 conf->f_rng = f_rng;
1255 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001256}
1257
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001258void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001259 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001260 void *p_dbg )
1261{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001262 conf->f_dbg = f_dbg;
1263 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001264}
1265
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001267 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001268 mbedtls_ssl_send_t *f_send,
1269 mbedtls_ssl_recv_t *f_recv,
1270 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001271{
1272 ssl->p_bio = p_bio;
1273 ssl->f_send = f_send;
1274 ssl->f_recv = f_recv;
1275 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001276}
1277
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001278#if defined(MBEDTLS_SSL_PROTO_DTLS)
1279void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1280{
1281 ssl->mtu = mtu;
1282}
1283#endif
1284
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001285void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001286{
1287 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001288}
1289
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001290void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1291 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001292 mbedtls_ssl_set_timer_t *f_set_timer,
1293 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001294{
1295 ssl->p_timer = p_timer;
1296 ssl->f_set_timer = f_set_timer;
1297 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001298
1299 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001300 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001301}
1302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001304void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001305 void *p_cache,
1306 mbedtls_ssl_cache_get_t *f_get_cache,
1307 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001308{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001309 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001310 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001311 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001312}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_CLI_C)
1316int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001317{
Janos Follath865b3eb2019-12-16 11:46:15 +00001318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001319
1320 if( ssl == NULL ||
1321 session == NULL ||
1322 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001323 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001324 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001326 }
1327
Hanno Beckere810bbc2021-05-14 16:01:05 +01001328 if( ssl->handshake->resume == 1 )
1329 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1330
Hanno Becker52055ae2019-02-06 14:30:46 +00001331 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1332 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001333 return( ret );
1334
Paul Bakker0a597072012-09-25 21:55:46 +00001335 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001336
1337 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001338}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001340
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001341void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1342 const int *ciphersuites )
1343{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001344 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001345}
1346
Ronald Cron6f135e12021-12-08 16:57:54 +01001347#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001348void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001349 const int kex_modes )
1350{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001351 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001352}
Ronald Cron6f135e12021-12-08 16:57:54 +01001353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001355#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001356void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001357 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001358{
1359 conf->cert_profile = profile;
1360}
1361
Glenn Strauss36872db2022-01-22 05:06:31 -05001362static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1363{
1364 mbedtls_ssl_key_cert *cur = key_cert, *next;
1365
1366 while( cur != NULL )
1367 {
1368 next = cur->next;
1369 mbedtls_free( cur );
1370 cur = next;
1371 }
1372}
1373
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001374/* Append a new keycert entry to a (possibly empty) list */
1375static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1376 mbedtls_x509_crt *cert,
1377 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001378{
niisato8ee24222018-06-25 19:05:48 +09001379 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001380
Glenn Strauss36872db2022-01-22 05:06:31 -05001381 if( cert == NULL )
1382 {
1383 /* Free list if cert is null */
1384 ssl_key_cert_free( *head );
1385 *head = NULL;
1386 return( 0 );
1387 }
1388
niisato8ee24222018-06-25 19:05:48 +09001389 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1390 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001391 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001392
niisato8ee24222018-06-25 19:05:48 +09001393 new_cert->cert = cert;
1394 new_cert->key = key;
1395 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001396
Glenn Strauss36872db2022-01-22 05:06:31 -05001397 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001398 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001399 {
niisato8ee24222018-06-25 19:05:48 +09001400 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001401 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001402 else
1403 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001404 mbedtls_ssl_key_cert *cur = *head;
1405 while( cur->next != NULL )
1406 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001407 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001408 }
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410 return( 0 );
1411}
1412
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001413int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001414 mbedtls_x509_crt *own_cert,
1415 mbedtls_pk_context *pk_key )
1416{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001417 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001418}
1419
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001420void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001421 mbedtls_x509_crt *ca_chain,
1422 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001423{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001424 conf->ca_chain = ca_chain;
1425 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001426
1427#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1428 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1429 * cannot be used together. */
1430 conf->f_ca_cb = NULL;
1431 conf->p_ca_cb = NULL;
1432#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001433}
Hanno Becker5adaad92019-03-27 16:54:37 +00001434
1435#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1436void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001437 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001438 void *p_ca_cb )
1439{
1440 conf->f_ca_cb = f_ca_cb;
1441 conf->p_ca_cb = p_ca_cb;
1442
1443 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1444 * cannot be used together. */
1445 conf->ca_chain = NULL;
1446 conf->ca_crl = NULL;
1447}
1448#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001450
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001451#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001452const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1453 size_t *name_len )
1454{
1455 *name_len = ssl->handshake->sni_name_len;
1456 return( ssl->handshake->sni_name );
1457}
1458
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001459int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1460 mbedtls_x509_crt *own_cert,
1461 mbedtls_pk_context *pk_key )
1462{
1463 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1464 own_cert, pk_key ) );
1465}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001466
1467void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1468 mbedtls_x509_crt *ca_chain,
1469 mbedtls_x509_crl *ca_crl )
1470{
1471 ssl->handshake->sni_ca_chain = ca_chain;
1472 ssl->handshake->sni_ca_crl = ca_crl;
1473}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001474
1475void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1476 int authmode )
1477{
1478 ssl->handshake->sni_authmode = authmode;
1479}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001480#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1481
Hanno Becker8927c832019-04-03 12:52:50 +01001482#if defined(MBEDTLS_X509_CRT_PARSE_C)
1483void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1484 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1485 void *p_vrfy )
1486{
1487 ssl->f_vrfy = f_vrfy;
1488 ssl->p_vrfy = p_vrfy;
1489}
1490#endif
1491
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001492#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001493/*
1494 * Set EC J-PAKE password for current handshake
1495 */
1496int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1497 const unsigned char *pw,
1498 size_t pw_len )
1499{
1500 mbedtls_ecjpake_role role;
1501
Janos Follath8eb64132016-06-03 15:40:57 +01001502 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001503 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1504
1505 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1506 role = MBEDTLS_ECJPAKE_SERVER;
1507 else
1508 role = MBEDTLS_ECJPAKE_CLIENT;
1509
1510 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1511 role,
1512 MBEDTLS_MD_SHA256,
1513 MBEDTLS_ECP_DP_SECP256R1,
1514 pw, pw_len ) );
1515}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001516#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001517
Gilles Peskineeccd8882020-03-10 12:19:08 +01001518#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001519
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001520static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1521{
1522#if defined(MBEDTLS_USE_PSA_CRYPTO)
1523 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1524 return( 1 );
1525#endif /* MBEDTLS_USE_PSA_CRYPTO */
1526
1527 if( conf->psk != NULL )
1528 return( 1 );
1529
1530 return( 0 );
1531}
1532
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001533static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1534{
1535 /* Remove reference to existing PSK, if any. */
1536#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001537 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001538 {
1539 /* The maintenance of the PSK key slot is the
1540 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001541 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001542 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001543 /* This and the following branch should never
1544 * be taken simultaenously as we maintain the
1545 * invariant that raw and opaque PSKs are never
1546 * configured simultaneously. As a safeguard,
1547 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001548#endif /* MBEDTLS_USE_PSA_CRYPTO */
1549 if( conf->psk != NULL )
1550 {
1551 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1552
1553 mbedtls_free( conf->psk );
1554 conf->psk = NULL;
1555 conf->psk_len = 0;
1556 }
1557
1558 /* Remove reference to PSK identity, if any. */
1559 if( conf->psk_identity != NULL )
1560 {
1561 mbedtls_free( conf->psk_identity );
1562 conf->psk_identity = NULL;
1563 conf->psk_identity_len = 0;
1564 }
1565}
1566
Hanno Becker7390c712018-11-15 13:33:04 +00001567/* This function assumes that PSK identity in the SSL config is unset.
1568 * It checks that the provided identity is well-formed and attempts
1569 * to make a copy of it in the SSL config.
1570 * On failure, the PSK identity in the config remains unset. */
1571static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1572 unsigned char const *psk_identity,
1573 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001574{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001575 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001576 if( psk_identity == NULL ||
1577 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001578 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001579 {
1580 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1581 }
1582
Hanno Becker7390c712018-11-15 13:33:04 +00001583 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1584 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001585 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001586
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001587 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001588 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001589
1590 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001591}
1592
Hanno Becker7390c712018-11-15 13:33:04 +00001593int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1594 const unsigned char *psk, size_t psk_len,
1595 const unsigned char *psk_identity, size_t psk_identity_len )
1596{
Janos Follath865b3eb2019-12-16 11:46:15 +00001597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001598
1599 /* We currently only support one PSK, raw or opaque. */
1600 if( ssl_conf_psk_is_configured( conf ) )
1601 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001602
1603 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001604 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001605 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001606 if( psk_len == 0 )
1607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1608 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1609 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1610
Hanno Becker7390c712018-11-15 13:33:04 +00001611 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1612 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1613 conf->psk_len = psk_len;
1614 memcpy( conf->psk, psk, conf->psk_len );
1615
1616 /* Check and set PSK Identity */
1617 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1618 if( ret != 0 )
1619 ssl_conf_remove_psk( conf );
1620
1621 return( ret );
1622}
1623
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001624static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1625{
1626#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001627 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001628 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001629 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001630 }
1631 else
1632#endif /* MBEDTLS_USE_PSA_CRYPTO */
1633 if( ssl->handshake->psk != NULL )
1634 {
1635 mbedtls_platform_zeroize( ssl->handshake->psk,
1636 ssl->handshake->psk_len );
1637 mbedtls_free( ssl->handshake->psk );
1638 ssl->handshake->psk_len = 0;
1639 }
1640}
1641
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001642int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1643 const unsigned char *psk, size_t psk_len )
1644{
1645 if( psk == NULL || ssl->handshake == NULL )
1646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1647
1648 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1649 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1650
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001651 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001652
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001653 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001654 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001655
1656 ssl->handshake->psk_len = psk_len;
1657 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1658
1659 return( 0 );
1660}
1661
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001662#if defined(MBEDTLS_USE_PSA_CRYPTO)
1663int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001664 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001665 const unsigned char *psk_identity,
1666 size_t psk_identity_len )
1667{
Janos Follath865b3eb2019-12-16 11:46:15 +00001668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001669
1670 /* We currently only support one PSK, raw or opaque. */
1671 if( ssl_conf_psk_is_configured( conf ) )
1672 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001673
Hanno Becker7390c712018-11-15 13:33:04 +00001674 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001675 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001676 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001677 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001678
1679 /* Check and set PSK Identity */
1680 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1681 psk_identity_len );
1682 if( ret != 0 )
1683 ssl_conf_remove_psk( conf );
1684
1685 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001686}
1687
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001688int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1689 mbedtls_svc_key_id_t psk )
1690{
1691 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1692 ( ssl->handshake == NULL ) )
1693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1694
1695 ssl_remove_psk( ssl );
1696 ssl->handshake->psk_opaque = psk;
1697 return( 0 );
1698}
1699#endif /* MBEDTLS_USE_PSA_CRYPTO */
1700
1701void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1702 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1703 size_t),
1704 void *p_psk )
1705{
1706 conf->f_psk = f_psk;
1707 conf->p_psk = p_psk;
1708}
1709#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1710
1711#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001712psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001713 size_t taglen,
1714 psa_algorithm_t *alg,
1715 psa_key_type_t *key_type,
1716 size_t *key_size )
1717{
1718 switch ( mbedtls_cipher_type )
1719 {
1720 case MBEDTLS_CIPHER_AES_128_CBC:
1721 *alg = PSA_ALG_CBC_NO_PADDING;
1722 *key_type = PSA_KEY_TYPE_AES;
1723 *key_size = 128;
1724 break;
1725 case MBEDTLS_CIPHER_AES_128_CCM:
1726 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1727 *key_type = PSA_KEY_TYPE_AES;
1728 *key_size = 128;
1729 break;
1730 case MBEDTLS_CIPHER_AES_128_GCM:
1731 *alg = PSA_ALG_GCM;
1732 *key_type = PSA_KEY_TYPE_AES;
1733 *key_size = 128;
1734 break;
1735 case MBEDTLS_CIPHER_AES_192_CCM:
1736 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1737 *key_type = PSA_KEY_TYPE_AES;
1738 *key_size = 192;
1739 break;
1740 case MBEDTLS_CIPHER_AES_192_GCM:
1741 *alg = PSA_ALG_GCM;
1742 *key_type = PSA_KEY_TYPE_AES;
1743 *key_size = 192;
1744 break;
1745 case MBEDTLS_CIPHER_AES_256_CBC:
1746 *alg = PSA_ALG_CBC_NO_PADDING;
1747 *key_type = PSA_KEY_TYPE_AES;
1748 *key_size = 256;
1749 break;
1750 case MBEDTLS_CIPHER_AES_256_CCM:
1751 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1752 *key_type = PSA_KEY_TYPE_AES;
1753 *key_size = 256;
1754 break;
1755 case MBEDTLS_CIPHER_AES_256_GCM:
1756 *alg = PSA_ALG_GCM;
1757 *key_type = PSA_KEY_TYPE_AES;
1758 *key_size = 256;
1759 break;
1760 case MBEDTLS_CIPHER_ARIA_128_CBC:
1761 *alg = PSA_ALG_CBC_NO_PADDING;
1762 *key_type = PSA_KEY_TYPE_ARIA;
1763 *key_size = 128;
1764 break;
1765 case MBEDTLS_CIPHER_ARIA_128_CCM:
1766 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1767 *key_type = PSA_KEY_TYPE_ARIA;
1768 *key_size = 128;
1769 break;
1770 case MBEDTLS_CIPHER_ARIA_128_GCM:
1771 *alg = PSA_ALG_GCM;
1772 *key_type = PSA_KEY_TYPE_ARIA;
1773 *key_size = 128;
1774 break;
1775 case MBEDTLS_CIPHER_ARIA_192_CCM:
1776 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1777 *key_type = PSA_KEY_TYPE_ARIA;
1778 *key_size = 192;
1779 break;
1780 case MBEDTLS_CIPHER_ARIA_192_GCM:
1781 *alg = PSA_ALG_GCM;
1782 *key_type = PSA_KEY_TYPE_ARIA;
1783 *key_size = 192;
1784 break;
1785 case MBEDTLS_CIPHER_ARIA_256_CBC:
1786 *alg = PSA_ALG_CBC_NO_PADDING;
1787 *key_type = PSA_KEY_TYPE_ARIA;
1788 *key_size = 256;
1789 break;
1790 case MBEDTLS_CIPHER_ARIA_256_CCM:
1791 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1792 *key_type = PSA_KEY_TYPE_ARIA;
1793 *key_size = 256;
1794 break;
1795 case MBEDTLS_CIPHER_ARIA_256_GCM:
1796 *alg = PSA_ALG_GCM;
1797 *key_type = PSA_KEY_TYPE_ARIA;
1798 *key_size = 256;
1799 break;
1800 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1801 *alg = PSA_ALG_CBC_NO_PADDING;
1802 *key_type = PSA_KEY_TYPE_CAMELLIA;
1803 *key_size = 128;
1804 break;
1805 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1806 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1807 *key_type = PSA_KEY_TYPE_CAMELLIA;
1808 *key_size = 128;
1809 break;
1810 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1811 *alg = PSA_ALG_GCM;
1812 *key_type = PSA_KEY_TYPE_CAMELLIA;
1813 *key_size = 128;
1814 break;
1815 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1816 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1817 *key_type = PSA_KEY_TYPE_CAMELLIA;
1818 *key_size = 192;
1819 break;
1820 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1821 *alg = PSA_ALG_GCM;
1822 *key_type = PSA_KEY_TYPE_CAMELLIA;
1823 *key_size = 192;
1824 break;
1825 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1826 *alg = PSA_ALG_CBC_NO_PADDING;
1827 *key_type = PSA_KEY_TYPE_CAMELLIA;
1828 *key_size = 256;
1829 break;
1830 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1831 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1832 *key_type = PSA_KEY_TYPE_CAMELLIA;
1833 *key_size = 256;
1834 break;
1835 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1836 *alg = PSA_ALG_GCM;
1837 *key_type = PSA_KEY_TYPE_CAMELLIA;
1838 *key_size = 256;
1839 break;
1840 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1841 *alg = PSA_ALG_CHACHA20_POLY1305;
1842 *key_type = PSA_KEY_TYPE_CHACHA20;
1843 *key_size = 256;
1844 break;
1845 case MBEDTLS_CIPHER_NULL:
1846 *alg = MBEDTLS_SSL_NULL_CIPHER;
1847 *key_type = 0;
1848 *key_size = 0;
1849 break;
1850 default:
1851 return PSA_ERROR_NOT_SUPPORTED;
1852 }
1853
1854 return PSA_SUCCESS;
1855}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001856#endif /* MBEDTLS_USE_PSA_CRYPTO */
1857
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001858#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001859int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1860 const unsigned char *dhm_P, size_t P_len,
1861 const unsigned char *dhm_G, size_t G_len )
1862{
Janos Follath865b3eb2019-12-16 11:46:15 +00001863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001864
Glenn Strausscee11292021-12-20 01:43:17 -05001865 mbedtls_mpi_free( &conf->dhm_P );
1866 mbedtls_mpi_free( &conf->dhm_G );
1867
Hanno Beckera90658f2017-10-04 15:29:08 +01001868 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1869 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1870 {
1871 mbedtls_mpi_free( &conf->dhm_P );
1872 mbedtls_mpi_free( &conf->dhm_G );
1873 return( ret );
1874 }
1875
1876 return( 0 );
1877}
Paul Bakker5121ce52009-01-03 21:22:43 +00001878
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001879int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001880{
Janos Follath865b3eb2019-12-16 11:46:15 +00001881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001882
Glenn Strausscee11292021-12-20 01:43:17 -05001883 mbedtls_mpi_free( &conf->dhm_P );
1884 mbedtls_mpi_free( &conf->dhm_G );
1885
Gilles Peskinee5702482021-06-11 21:59:08 +02001886 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1887 &conf->dhm_P ) ) != 0 ||
1888 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1889 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001890 {
1891 mbedtls_mpi_free( &conf->dhm_P );
1892 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001893 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001894 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001895
1896 return( 0 );
1897}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001898#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001899
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001900#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1901/*
1902 * Set the minimum length for Diffie-Hellman parameters
1903 */
1904void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1905 unsigned int bitlen )
1906{
1907 conf->dhm_min_bitlen = bitlen;
1908}
1909#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1910
Gilles Peskineeccd8882020-03-10 12:19:08 +01001911#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001912#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001913/*
1914 * Set allowed/preferred hashes for handshake signatures
1915 */
1916void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1917 const int *hashes )
1918{
1919 conf->sig_hashes = hashes;
1920}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001921#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001922
Jerry Yuf017ee42022-01-12 15:49:48 +08001923/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001924void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1925 const uint16_t* sig_algs )
1926{
Jerry Yuf017ee42022-01-12 15:49:48 +08001927#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1928 conf->sig_hashes = NULL;
1929#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1930 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001931}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001932#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001933
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001934#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001935#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001936/*
1937 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001938 *
1939 * mbedtls_ssl_setup() takes the provided list
1940 * and translates it to a list of IANA TLS group identifiers,
1941 * stored in ssl->handshake->group_list.
1942 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001943 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001944void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001945 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001946{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001947 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001948 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001949}
Brett Warrene0edc842021-08-17 09:53:13 +01001950#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001951#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001952
Brett Warrene0edc842021-08-17 09:53:13 +01001953/*
1954 * Set the allowed groups
1955 */
1956void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1957 const uint16_t *group_list )
1958{
1959#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1960 conf->curve_list = NULL;
1961#endif
1962 conf->group_list = group_list;
1963}
1964
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001965#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001967{
Hanno Becker947194e2017-04-07 13:25:49 +01001968 /* Initialize to suppress unnecessary compiler warning */
1969 size_t hostname_len = 0;
1970
1971 /* Check if new hostname is valid before
1972 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001973 if( hostname != NULL )
1974 {
1975 hostname_len = strlen( hostname );
1976
1977 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1978 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1979 }
1980
1981 /* Now it's clear that we will overwrite the old hostname,
1982 * so we can free it safely */
1983
1984 if( ssl->hostname != NULL )
1985 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001986 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01001987 mbedtls_free( ssl->hostname );
1988 }
1989
1990 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01001991
Paul Bakker5121ce52009-01-03 21:22:43 +00001992 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01001993 {
1994 ssl->hostname = NULL;
1995 }
1996 else
1997 {
1998 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01001999 if( ssl->hostname == NULL )
2000 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002001
Hanno Becker947194e2017-04-07 13:25:49 +01002002 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002003
Hanno Becker947194e2017-04-07 13:25:49 +01002004 ssl->hostname[hostname_len] = '\0';
2005 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002006
2007 return( 0 );
2008}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002009#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002010
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002011#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002012void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002014 const unsigned char *, size_t),
2015 void *p_sni )
2016{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002017 conf->f_sni = f_sni;
2018 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002019}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002023int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002024{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002025 size_t cur_len, tot_len;
2026 const char **p;
2027
2028 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002029 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2030 * MUST NOT be truncated."
2031 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002032 */
2033 tot_len = 0;
2034 for( p = protos; *p != NULL; p++ )
2035 {
2036 cur_len = strlen( *p );
2037 tot_len += cur_len;
2038
Ronald Cron8216dd32020-04-23 16:41:44 +02002039 if( ( cur_len == 0 ) ||
2040 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2041 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002043 }
2044
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002045 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002046
2047 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002048}
2049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002051{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002052 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002053}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002055
Johan Pascalb62bb512015-12-03 21:56:45 +01002056#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002057void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2058 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002059{
2060 conf->dtls_srtp_mki_support = support_mki_value;
2061}
2062
Ron Eldoref72faf2018-07-12 11:54:20 +03002063int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2064 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002065 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002066{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002067 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002068 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002069 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002070 }
Ron Eldor591f1622018-01-22 12:30:04 +02002071
2072 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002073 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002074 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002075 }
Ron Eldor591f1622018-01-22 12:30:04 +02002076
2077 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2078 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002079 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002080}
2081
Ron Eldoref72faf2018-07-12 11:54:20 +03002082int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002083 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002084{
Johan Pascal253d0262020-09-22 13:04:45 +02002085 const mbedtls_ssl_srtp_profile *p;
2086 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002087
Johan Pascal253d0262020-09-22 13:04:45 +02002088 /* check the profiles list: all entry must be valid,
2089 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002090 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2091 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2092 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002093 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002094 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002095 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002096 list_size++;
2097 }
2098 else
2099 {
2100 /* unsupported value, stop parsing and set the size to an error value */
2101 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002102 }
2103 }
2104
Johan Pascal5ef72d22020-10-28 17:05:47 +01002105 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002106 {
Johan Pascal253d0262020-09-22 13:04:45 +02002107 conf->dtls_srtp_profile_list = NULL;
2108 conf->dtls_srtp_profile_list_len = 0;
2109 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2110 }
2111
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002112 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002113 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002114
2115 return( 0 );
2116}
2117
Johan Pascal5ef72d22020-10-28 17:05:47 +01002118void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2119 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002120{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002121 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2122 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002123 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002124 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002125 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002126 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002127 else
2128 {
2129 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002130 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2131 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002132 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002133}
Johan Pascalb62bb512015-12-03 21:56:45 +01002134#endif /* MBEDTLS_SSL_DTLS_SRTP */
2135
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002136void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002137{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002138 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002139}
2140
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002141void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002142{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002143 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002144}
2145
Janos Follath088ce432017-04-10 12:42:31 +01002146#if defined(MBEDTLS_SSL_SRV_C)
2147void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2148 char cert_req_ca_list )
2149{
2150 conf->cert_req_ca_list = cert_req_ca_list;
2151}
2152#endif
2153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002155void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002156{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002157 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002158}
2159#endif
2160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002162void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002163{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002164 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002165}
2166#endif
2167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002169int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002170{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002172 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002173 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002175 }
2176
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002177 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002178
2179 return( 0 );
2180}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002182
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002183void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002184{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002185 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002186}
2187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002189void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002190{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002191 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002192}
2193
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002194void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002195{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002196 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002197}
2198
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002199void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002200 const unsigned char period[8] )
2201{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002202 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002203}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002207#if defined(MBEDTLS_SSL_CLI_C)
2208void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002209{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002210 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002211}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002212#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002213
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002214#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002215void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2216 mbedtls_ssl_ticket_write_t *f_ticket_write,
2217 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2218 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002219{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002220 conf->f_ticket_write = f_ticket_write;
2221 conf->f_ticket_parse = f_ticket_parse;
2222 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002223}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002224#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002226
Hanno Becker7e6c1782021-06-08 09:24:55 +01002227void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2228 mbedtls_ssl_export_keys_t *f_export_keys,
2229 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002230{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002231 ssl->f_export_keys = f_export_keys;
2232 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002233}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002234
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002235#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002236void mbedtls_ssl_conf_async_private_cb(
2237 mbedtls_ssl_config *conf,
2238 mbedtls_ssl_async_sign_t *f_async_sign,
2239 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2240 mbedtls_ssl_async_resume_t *f_async_resume,
2241 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002242 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002243{
2244 conf->f_async_sign_start = f_async_sign;
2245 conf->f_async_decrypt_start = f_async_decrypt;
2246 conf->f_async_resume = f_async_resume;
2247 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002248 conf->p_async_config_data = async_config_data;
2249}
2250
Gilles Peskine8f97af72018-04-26 11:46:10 +02002251void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2252{
2253 return( conf->p_async_config_data );
2254}
2255
Gilles Peskine1febfef2018-04-30 11:54:39 +02002256void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002257{
2258 if( ssl->handshake == NULL )
2259 return( NULL );
2260 else
2261 return( ssl->handshake->user_async_ctx );
2262}
2263
Gilles Peskine1febfef2018-04-30 11:54:39 +02002264void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002265 void *ctx )
2266{
2267 if( ssl->handshake != NULL )
2268 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002269}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002270#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002271
Paul Bakker5121ce52009-01-03 21:22:43 +00002272/*
2273 * SSL get accessors
2274 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002275uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002276{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002277 if( ssl->session != NULL )
2278 return( ssl->session->verify_result );
2279
2280 if( ssl->session_negotiate != NULL )
2281 return( ssl->session_negotiate->verify_result );
2282
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002283 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002284}
2285
Glenn Strauss8f526902022-01-13 00:04:49 -05002286int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2287{
2288 if( ssl == NULL || ssl->session == NULL )
2289 return( 0 );
2290
2291 return( ssl->session->ciphersuite );
2292}
2293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002294const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002295{
Paul Bakker926c8e42013-03-06 10:23:34 +01002296 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002297 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002300}
2301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002303{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002305 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002306 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002307 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002308 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002309 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002310 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002311 default:
2312 return( "unknown (DTLS)" );
2313 }
2314 }
2315#endif
2316
Glenn Strauss60bfe602022-03-14 19:04:24 -04002317 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002318 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002319 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002320 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002321 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002322 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002323 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002324 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002325 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002326}
2327
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002328#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002329size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2330{
David Horstmann95d516f2021-05-04 18:36:56 +01002331 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002332 size_t read_mfl;
2333
2334 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2335 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2336 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2337 {
2338 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2339 }
2340
2341 /* Check if a smaller max length was negotiated */
2342 if( ssl->session_out != NULL )
2343 {
2344 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2345 if( read_mfl < max_len )
2346 {
2347 max_len = read_mfl;
2348 }
2349 }
2350
2351 // During a handshake, use the value being negotiated
2352 if( ssl->session_negotiate != NULL )
2353 {
2354 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2355 if( read_mfl < max_len )
2356 {
2357 max_len = read_mfl;
2358 }
2359 }
2360
2361 return( max_len );
2362}
2363
2364size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002365{
2366 size_t max_len;
2367
2368 /*
2369 * Assume mfl_code is correct since it was checked when set
2370 */
Angus Grattond8213d02016-05-25 20:56:48 +10002371 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002372
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002373 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002374 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002375 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002376 {
Angus Grattond8213d02016-05-25 20:56:48 +10002377 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002378 }
2379
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002380 /* During a handshake, use the value being negotiated */
2381 if( ssl->session_negotiate != NULL &&
2382 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2383 {
2384 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2385 }
2386
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002387 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002388}
2389#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2390
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002391#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002392size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002393{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002394 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2395 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2396 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2397 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2398 return ( 0 );
2399
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002400 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2401 return( ssl->mtu );
2402
2403 if( ssl->mtu == 0 )
2404 return( ssl->handshake->mtu );
2405
2406 return( ssl->mtu < ssl->handshake->mtu ?
2407 ssl->mtu : ssl->handshake->mtu );
2408}
2409#endif /* MBEDTLS_SSL_PROTO_DTLS */
2410
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002411int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2412{
2413 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2414
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002415#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2416 !defined(MBEDTLS_SSL_PROTO_DTLS)
2417 (void) ssl;
2418#endif
2419
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002420#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002421 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002422
2423 if( max_len > mfl )
2424 max_len = mfl;
2425#endif
2426
2427#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002428 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002429 {
Hanno Becker89490712020-02-05 10:50:12 +00002430 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002431 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2432 const size_t overhead = (size_t) ret;
2433
2434 if( ret < 0 )
2435 return( ret );
2436
2437 if( mtu <= overhead )
2438 {
2439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2440 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2441 }
2442
2443 if( max_len > mtu - overhead )
2444 max_len = mtu - overhead;
2445 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002446#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002447
Hanno Becker0defedb2018-08-10 12:35:02 +01002448#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2449 !defined(MBEDTLS_SSL_PROTO_DTLS)
2450 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002451#endif
2452
2453 return( (int) max_len );
2454}
2455
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002456int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2457{
2458 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2459
2460#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2461 (void) ssl;
2462#endif
2463
2464#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2465 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2466
2467 if( max_len > mfl )
2468 max_len = mfl;
2469#endif
2470
2471 return( (int) max_len );
2472}
2473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474#if defined(MBEDTLS_X509_CRT_PARSE_C)
2475const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002476{
2477 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002478 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002479
Hanno Beckere6824572019-02-07 13:18:46 +00002480#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002481 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002482#else
2483 return( NULL );
2484#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002485}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002487
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002489int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2490 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002491{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002492 int ret;
2493
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002494 if( ssl == NULL ||
2495 dst == NULL ||
2496 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002497 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002498 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002500 }
2501
Hanno Beckere810bbc2021-05-14 16:01:05 +01002502 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2503 * idempotent: Each session can only be exported once.
2504 *
2505 * (This is in preparation for TLS 1.3 support where we will
2506 * need the ability to export multiple sessions (aka tickets),
2507 * which will be achieved by calling mbedtls_ssl_get_session()
2508 * multiple times until it fails.)
2509 *
2510 * Check whether we have already exported the current session,
2511 * and fail if so.
2512 */
2513 if( ssl->session->exported == 1 )
2514 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2515
2516 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2517 if( ret != 0 )
2518 return( ret );
2519
2520 /* Remember that we've exported the session. */
2521 ssl->session->exported = 1;
2522 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002525
Paul Bakker5121ce52009-01-03 21:22:43 +00002526/*
Hanno Beckera835da52019-05-16 12:39:07 +01002527 * Define ticket header determining Mbed TLS version
2528 * and structure of the ticket.
2529 */
2530
Hanno Becker94ef3b32019-05-16 12:50:45 +01002531/*
Hanno Becker50b59662019-05-28 14:30:45 +01002532 * Define bitflag determining compile-time settings influencing
2533 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002534 */
2535
Hanno Becker50b59662019-05-28 14:30:45 +01002536#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002537#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002538#else
Hanno Becker3e088662019-05-29 11:10:18 +01002539#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002540#endif /* MBEDTLS_HAVE_TIME */
2541
2542#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002543#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002544#else
Hanno Becker3e088662019-05-29 11:10:18 +01002545#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002546#endif /* MBEDTLS_X509_CRT_PARSE_C */
2547
2548#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002549#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002550#else
Hanno Becker3e088662019-05-29 11:10:18 +01002551#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002552#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2553
2554#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002555#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002556#else
Hanno Becker3e088662019-05-29 11:10:18 +01002557#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002558#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2559
Hanno Becker94ef3b32019-05-16 12:50:45 +01002560#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002561#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002562#else
Hanno Becker3e088662019-05-29 11:10:18 +01002563#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002564#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2565
Hanno Becker94ef3b32019-05-16 12:50:45 +01002566#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2567#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2568#else
2569#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2570#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2571
Hanno Becker3e088662019-05-29 11:10:18 +01002572#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2573#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2574#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2575#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002576#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2577#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002578
Hanno Becker50b59662019-05-28 14:30:45 +01002579#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002580 ( (uint16_t) ( \
2581 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2582 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2583 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2584 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002585 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002586 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002587
Hanno Beckerf8787072019-05-16 12:41:07 +01002588static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002589 MBEDTLS_VERSION_MAJOR,
2590 MBEDTLS_VERSION_MINOR,
2591 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002592 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2593 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002594};
Hanno Beckera835da52019-05-16 12:39:07 +01002595
2596/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002597 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002598 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002599 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002600 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002601 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002602 * opaque mbedtls_version[3]; // library version: major, minor, patch
2603 * opaque session_format[2]; // library-version specific 16-bit field
2604 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002605 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002606 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002607 * Note: When updating the format, remember to keep
2608 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002609 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002610 * // In this version, `session_format` determines
2611 * // the setting of those compile-time
2612 * // configuration options which influence
2613 * // the structure of mbedtls_ssl_session.
2614 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002615 * uint8_t minor_ver; // Protocol minor version. Possible values:
2616 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002617 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002618 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002619 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002620 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002621 * serialized_session_tls12 data;
2622 *
2623 * };
2624 *
2625 * } serialized_session;
2626 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002627 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002628
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002629static int ssl_session_save( const mbedtls_ssl_session *session,
2630 unsigned char omit_header,
2631 unsigned char *buf,
2632 size_t buf_len,
2633 size_t *olen )
2634{
2635 unsigned char *p = buf;
2636 size_t used = 0;
2637
2638 if( !omit_header )
2639 {
2640 /*
2641 * Add Mbed TLS version identifier
2642 */
2643
2644 used += sizeof( ssl_serialized_session_header );
2645
2646 if( used <= buf_len )
2647 {
2648 memcpy( p, ssl_serialized_session_header,
2649 sizeof( ssl_serialized_session_header ) );
2650 p += sizeof( ssl_serialized_session_header );
2651 }
2652 }
2653
2654 /*
2655 * TLS version identifier
2656 */
2657 used += 1;
2658 if( used <= buf_len )
2659 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002660 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002661 }
2662
2663 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002664 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002665 {
2666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002667 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002668 {
2669 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2670 used += ssl_session_save_tls12( session, p, remaining_len );
2671 break;
2672 }
2673#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2674
2675 default:
2676 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2677 }
2678
2679 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002680 if( used > buf_len )
2681 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002682
2683 return( 0 );
2684}
2685
2686/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002687 * Public wrapper for ssl_session_save()
2688 */
2689int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2690 unsigned char *buf,
2691 size_t buf_len,
2692 size_t *olen )
2693{
2694 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2695}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002696
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002697/*
2698 * Deserialize session, see mbedtls_ssl_session_save() for format.
2699 *
2700 * This internal version is wrapped by a public function that cleans up in
2701 * case of error, and has an extra option omit_header.
2702 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002703static int ssl_session_load( mbedtls_ssl_session *session,
2704 unsigned char omit_header,
2705 const unsigned char *buf,
2706 size_t len )
2707{
2708 const unsigned char *p = buf;
2709 const unsigned char * const end = buf + len;
2710
2711 if( !omit_header )
2712 {
2713 /*
2714 * Check Mbed TLS version identifier
2715 */
2716
2717 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2718 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2719
2720 if( memcmp( p, ssl_serialized_session_header,
2721 sizeof( ssl_serialized_session_header ) ) != 0 )
2722 {
2723 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2724 }
2725 p += sizeof( ssl_serialized_session_header );
2726 }
2727
2728 /*
2729 * TLS version identifier
2730 */
2731 if( 1 > (size_t)( end - p ) )
2732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002733 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002734
2735 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002736 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002737 {
2738#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002739 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002740 {
2741 size_t remaining_len = ( end - p );
2742 return( ssl_session_load_tls12( session, p, remaining_len ) );
2743 }
2744#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2745
2746 default:
2747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2748 }
2749}
2750
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002751/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002752 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002753 */
2754int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2755 const unsigned char *buf,
2756 size_t len )
2757{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002758 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002759
2760 if( ret != 0 )
2761 mbedtls_ssl_session_free( session );
2762
2763 return( ret );
2764}
2765
2766/*
Paul Bakker1961b702013-01-25 14:49:24 +01002767 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002768 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002769static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2770{
2771 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2772
Ronald Cron66dbf912022-02-02 15:33:46 +01002773 /*
2774 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002775 * that were written into the output buffer by the previous handshake step,
2776 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002777 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2778 * We proceed to the next handshake step only when all data from the
2779 * previous one have been sent to the peer, thus we make sure that this is
2780 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2781 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2782 * we have to wait before to go ahead.
2783 * In the case of TLS 1.3, handshake step handlers do not send data to the
2784 * peer. Data are only sent here and through
2785 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2786 * alert occured.
2787 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002788 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2789 return( ret );
2790
2791#if defined(MBEDTLS_SSL_PROTO_DTLS)
2792 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2793 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2794 {
2795 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2796 return( ret );
2797 }
2798#endif /* MBEDTLS_SSL_PROTO_DTLS */
2799
2800 return( ret );
2801}
2802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002804{
Hanno Becker41934dd2021-08-07 19:13:43 +01002805 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002806
Hanno Becker41934dd2021-08-07 19:13:43 +01002807 if( ssl == NULL ||
2808 ssl->conf == NULL ||
2809 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002810 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002811 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002812 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002813 }
2814
2815 ret = ssl_prepare_handshake_step( ssl );
2816 if( ret != 0 )
2817 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002818
Jerry Yue7047812021-09-13 19:26:39 +08002819 ret = mbedtls_ssl_handle_pending_alert( ssl );
2820 if( ret != 0 )
2821 goto cleanup;
2822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002824 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002825 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2827 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002828
Ronald Cron9f0fba32022-02-10 16:45:15 +01002829 switch( ssl->state )
2830 {
2831 case MBEDTLS_SSL_HELLO_REQUEST:
2832 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2833 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002834
Ronald Cron9f0fba32022-02-10 16:45:15 +01002835 case MBEDTLS_SSL_CLIENT_HELLO:
2836 ret = mbedtls_ssl_write_client_hello( ssl );
2837 break;
2838
2839 default:
2840#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002841 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002842 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2843 else
2844 ret = mbedtls_ssl_handshake_client_step( ssl );
2845#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2846 ret = mbedtls_ssl_handshake_client_step( ssl );
2847#else
2848 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2849#endif
2850 }
Jerry Yub9930e72021-08-06 17:11:51 +08002851 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002852#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002854 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002855 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002856#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002857 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002858 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002859#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002860
2861#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2862 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2863 ret = mbedtls_ssl_handshake_server_step( ssl );
2864#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2865 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002866#endif
2867
Jerry Yue7047812021-09-13 19:26:39 +08002868 if( ret != 0 )
2869 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002870 /* handshake_step return error. And it is same
2871 * with alert_reason.
2872 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002873 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002874 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002875 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002876 goto cleanup;
2877 }
2878 }
2879
2880cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002881 return( ret );
2882}
2883
2884/*
2885 * Perform the SSL handshake
2886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002888{
2889 int ret = 0;
2890
Hanno Beckera817ea42020-10-20 15:20:23 +01002891 /* Sanity checks */
2892
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002893 if( ssl == NULL || ssl->conf == NULL )
2894 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2895
Hanno Beckera817ea42020-10-20 15:20:23 +01002896#if defined(MBEDTLS_SSL_PROTO_DTLS)
2897 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2898 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2899 {
2900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2901 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2902 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2903 }
2904#endif /* MBEDTLS_SSL_PROTO_DTLS */
2905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002907
Hanno Beckera817ea42020-10-20 15:20:23 +01002908 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002909 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002912
2913 if( ret != 0 )
2914 break;
2915 }
2916
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002918
2919 return( ret );
2920}
2921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#if defined(MBEDTLS_SSL_RENEGOTIATION)
2923#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002924/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002925 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002928{
Janos Follath865b3eb2019-12-16 11:46:15 +00002929 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002932
2933 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2935 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002936
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002937 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002938 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002940 return( ret );
2941 }
2942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002944
2945 return( 0 );
2946}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002948
2949/*
2950 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * - any side: calling mbedtls_ssl_renegotiate(),
2952 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2953 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002954 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002955 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002957 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002958int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002959{
Janos Follath865b3eb2019-12-16 11:46:15 +00002960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002963
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002964 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2965 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002966
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002967 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2968 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002970 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002972 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002973 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002974 ssl->handshake->out_msg_seq = 1;
2975 else
2976 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002977 }
2978#endif
2979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2981 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00002982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00002984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002986 return( ret );
2987 }
2988
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002990
2991 return( 0 );
2992}
2993
2994/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002995 * Renegotiate current connection on client,
2996 * or request renegotiation on server
2997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002999{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003001
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003002 if( ssl == NULL || ssl->conf == NULL )
3003 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003006 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003007 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003008 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003009 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003013
3014 /* Did we already try/start sending HelloRequest? */
3015 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003017
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003018 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003019 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003023 /*
3024 * On client, either start the renegotiation process or,
3025 * if already in progress, continue the handshake
3026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003028 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003029 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003031
Hanno Becker40cdaa12020-02-05 10:48:27 +00003032 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003033 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003034 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003035 return( ret );
3036 }
3037 }
3038 else
3039 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003041 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003043 return( ret );
3044 }
3045 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003047
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003048 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003049}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003051
Gilles Peskine9b562d52018-04-25 20:32:43 +02003052void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003053{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003054 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3055
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003056 if( handshake == NULL )
3057 return;
3058
Brett Warrene0edc842021-08-17 09:53:13 +01003059#if defined(MBEDTLS_ECP_C)
3060#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3061 if ( ssl->handshake->group_list_heap_allocated )
3062 mbedtls_free( (void*) handshake->group_list );
3063 handshake->group_list = NULL;
3064#endif /* MBEDTLS_DEPRECATED_REMOVED */
3065#endif /* MBEDTLS_ECP_C */
3066
Jerry Yuf017ee42022-01-12 15:49:48 +08003067#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3068#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3069 if ( ssl->handshake->sig_algs_heap_allocated )
3070 mbedtls_free( (void*) handshake->sig_algs );
3071 handshake->sig_algs = NULL;
3072#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003073#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3074 if( ssl->handshake->certificate_request_context )
3075 {
3076 mbedtls_free( (void*) handshake->certificate_request_context );
3077 }
3078#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003079#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3080
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003081#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3082 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3083 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003084 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003085 handshake->async_in_progress = 0;
3086 }
3087#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3088
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003089#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003090#if defined(MBEDTLS_USE_PSA_CRYPTO)
3091 psa_hash_abort( &handshake->fin_sha256_psa );
3092#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003093 mbedtls_sha256_free( &handshake->fin_sha256 );
3094#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003095#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003096#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003097#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003098 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003099#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003100 mbedtls_sha512_free( &handshake->fin_sha512 );
3101#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003102#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#if defined(MBEDTLS_DHM_C)
3105 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003106#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#if defined(MBEDTLS_ECDH_C)
3108 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003109#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003110#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003111 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003112#if defined(MBEDTLS_SSL_CLI_C)
3113 mbedtls_free( handshake->ecjpake_cache );
3114 handshake->ecjpake_cache = NULL;
3115 handshake->ecjpake_cache_len = 0;
3116#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003117#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003118
Janos Follath4ae5c292016-02-10 11:27:43 +00003119#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3120 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003121 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003123#endif
3124
Gilles Peskineeccd8882020-03-10 12:19:08 +01003125#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003126 if( handshake->psk != NULL )
3127 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003128 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003129 mbedtls_free( handshake->psk );
3130 }
3131#endif
3132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3134 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003135 /*
3136 * Free only the linked list wrapper, not the keys themselves
3137 * since the belong to the SNI callback
3138 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003139 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003140#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003141
Gilles Peskineeccd8882020-03-10 12:19:08 +01003142#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003143 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003144 if( handshake->ecrs_peer_cert != NULL )
3145 {
3146 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3147 mbedtls_free( handshake->ecrs_peer_cert );
3148 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003149#endif
3150
Hanno Becker75173122019-02-06 16:18:31 +00003151#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3152 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3153 mbedtls_pk_free( &handshake->peer_pubkey );
3154#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3155
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003156#if defined(MBEDTLS_SSL_CLI_C) && \
3157 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3158 mbedtls_free( handshake->cookie );
3159#endif /* MBEDTLS_SSL_CLI_C &&
3160 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003161
3162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003163 mbedtls_ssl_flight_free( handshake->flight );
3164 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003165#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003166
Ronald Cronf12b81d2022-03-15 10:42:41 +01003167#if defined(MBEDTLS_ECDH_C) && \
3168 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003169 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003170 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003171#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3172
Ronald Cron6f135e12021-12-08 16:57:54 +01003173#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003174 mbedtls_ssl_transform_free( handshake->transform_handshake );
3175 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003176 mbedtls_free( handshake->transform_earlydata );
3177 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003178#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003179
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003180
3181#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3182 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3183 * processes datagrams and the fact that a datagram is allowed to have
3184 * several records in it, it is possible that the I/O buffers are not
3185 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003186 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3187 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003188#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003189
Jerry Yuba9c7272021-10-30 11:54:10 +08003190 /* mbedtls_platform_zeroize MUST be last one in this function */
3191 mbedtls_platform_zeroize( handshake,
3192 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003193}
3194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003196{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003197 if( session == NULL )
3198 return;
3199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003201 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003202#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003203
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003204#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003206#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003207
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003208 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003209}
3210
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003211#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003212
3213#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3214#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3215#else
3216#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3217#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3218
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003219#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003220
3221#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3222#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3223#else
3224#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3225#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3226
3227#if defined(MBEDTLS_SSL_ALPN)
3228#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3229#else
3230#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3231#endif /* MBEDTLS_SSL_ALPN */
3232
3233#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3234#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3235#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3236#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3237
3238#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3239 ( (uint32_t) ( \
3240 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3241 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3242 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3243 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3244 0u ) )
3245
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003246static unsigned char ssl_serialized_context_header[] = {
3247 MBEDTLS_VERSION_MAJOR,
3248 MBEDTLS_VERSION_MINOR,
3249 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003250 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3251 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3252 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3253 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3254 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003255};
3256
Paul Bakker5121ce52009-01-03 21:22:43 +00003257/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003258 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003259 *
3260 * The format of the serialized data is:
3261 * (in the presentation language of TLS, RFC 8446 section 3)
3262 *
3263 * // header
3264 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003265 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003266 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003267 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003268 * Note: When updating the format, remember to keep these
3269 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003270 *
3271 * // session sub-structure
3272 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3273 * // transform sub-structure
3274 * uint8 random[64]; // ServerHello.random+ClientHello.random
3275 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3276 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3277 * // fields from ssl_context
3278 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3279 * uint64 in_window_top; // DTLS: last validated record seq_num
3280 * uint64 in_window; // DTLS: bitmask for replay protection
3281 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3282 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3283 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3284 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3285 *
3286 * Note that many fields of the ssl_context or sub-structures are not
3287 * serialized, as they fall in one of the following categories:
3288 *
3289 * 1. forced value (eg in_left must be 0)
3290 * 2. pointer to dynamically-allocated memory (eg session, transform)
3291 * 3. value can be re-derived from other data (eg session keys from MS)
3292 * 4. value was temporary (eg content of input buffer)
3293 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003294 */
3295int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3296 unsigned char *buf,
3297 size_t buf_len,
3298 size_t *olen )
3299{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003300 unsigned char *p = buf;
3301 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003302 size_t session_len;
3303 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003304
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003305 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003306 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3307 * this function's documentation.
3308 *
3309 * These are due to assumptions/limitations in the implementation. Some of
3310 * them are likely to stay (no handshake in progress) some might go away
3311 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003312 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003313 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003314 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003315 {
3316 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003317 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003318 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003319 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003320 {
3321 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003322 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003323 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003324 /* Double-check that sub-structures are indeed ready */
3325 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003326 {
3327 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003328 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003329 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003330 /* There must be no pending incoming or outgoing data */
3331 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003332 {
3333 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003334 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003335 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003336 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003337 {
3338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003339 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003340 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003341 /* Protocol must be DLTS, not TLS */
3342 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003343 {
3344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003345 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003346 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003347 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003348 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003349 {
3350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003351 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003352 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003353 /* We must be using an AEAD ciphersuite */
3354 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003355 {
3356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003357 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003358 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003359 /* Renegotiation must not be enabled */
3360#if defined(MBEDTLS_SSL_RENEGOTIATION)
3361 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003362 {
3363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003364 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003365 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003366#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003367
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003368 /*
3369 * Version and format identifier
3370 */
3371 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003372
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003373 if( used <= buf_len )
3374 {
3375 memcpy( p, ssl_serialized_context_header,
3376 sizeof( ssl_serialized_context_header ) );
3377 p += sizeof( ssl_serialized_context_header );
3378 }
3379
3380 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003381 * Session (length + data)
3382 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003383 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003384 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3385 return( ret );
3386
3387 used += 4 + session_len;
3388 if( used <= buf_len )
3389 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003390 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3391 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003392
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003393 ret = ssl_session_save( ssl->session, 1,
3394 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003395 if( ret != 0 )
3396 return( ret );
3397
3398 p += session_len;
3399 }
3400
3401 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003402 * Transform
3403 */
3404 used += sizeof( ssl->transform->randbytes );
3405 if( used <= buf_len )
3406 {
3407 memcpy( p, ssl->transform->randbytes,
3408 sizeof( ssl->transform->randbytes ) );
3409 p += sizeof( ssl->transform->randbytes );
3410 }
3411
3412#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3413 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3414 if( used <= buf_len )
3415 {
3416 *p++ = ssl->transform->in_cid_len;
3417 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3418 p += ssl->transform->in_cid_len;
3419
3420 *p++ = ssl->transform->out_cid_len;
3421 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3422 p += ssl->transform->out_cid_len;
3423 }
3424#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3425
3426 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003427 * Saved fields from top-level ssl_context structure
3428 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003429 used += 4;
3430 if( used <= buf_len )
3431 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003432 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3433 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003434 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003435
3436#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3437 used += 16;
3438 if( used <= buf_len )
3439 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003440 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3441 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003442
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003443 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3444 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003445 }
3446#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3447
3448#if defined(MBEDTLS_SSL_PROTO_DTLS)
3449 used += 1;
3450 if( used <= buf_len )
3451 {
3452 *p++ = ssl->disable_datagram_packing;
3453 }
3454#endif /* MBEDTLS_SSL_PROTO_DTLS */
3455
Jerry Yuae0b2e22021-10-08 15:21:19 +08003456 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003457 if( used <= buf_len )
3458 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003459 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3460 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003461 }
3462
3463#if defined(MBEDTLS_SSL_PROTO_DTLS)
3464 used += 2;
3465 if( used <= buf_len )
3466 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003467 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3468 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003469 }
3470#endif /* MBEDTLS_SSL_PROTO_DTLS */
3471
3472#if defined(MBEDTLS_SSL_ALPN)
3473 {
3474 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003475 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003476 : 0;
3477
3478 used += 1 + alpn_len;
3479 if( used <= buf_len )
3480 {
3481 *p++ = alpn_len;
3482
3483 if( ssl->alpn_chosen != NULL )
3484 {
3485 memcpy( p, ssl->alpn_chosen, alpn_len );
3486 p += alpn_len;
3487 }
3488 }
3489 }
3490#endif /* MBEDTLS_SSL_ALPN */
3491
3492 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003493 * Done
3494 */
3495 *olen = used;
3496
3497 if( used > buf_len )
3498 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003499
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003500 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3501
Hanno Becker43aefe22020-02-05 10:44:56 +00003502 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003503}
3504
3505/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003506 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003507 *
3508 * This internal version is wrapped by a public function that cleans up in
3509 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003510 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003511static int ssl_context_load( mbedtls_ssl_context *ssl,
3512 const unsigned char *buf,
3513 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003514{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003515 const unsigned char *p = buf;
3516 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003517 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003519
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003520 /*
3521 * The context should have been freshly setup or reset.
3522 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003523 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003524 * renegotiating, or if the user mistakenly loaded a session first.)
3525 */
3526 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3527 ssl->session != NULL )
3528 {
3529 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3530 }
3531
3532 /*
3533 * We can't check that the config matches the initial one, but we can at
3534 * least check it matches the requirements for serializing.
3535 */
3536 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003537 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3538 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003539#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003540 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003541#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003542 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003543 {
3544 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3545 }
3546
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003547 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3548
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003549 /*
3550 * Check version identifier
3551 */
3552 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3553 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3554
3555 if( memcmp( p, ssl_serialized_context_header,
3556 sizeof( ssl_serialized_context_header ) ) != 0 )
3557 {
3558 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3559 }
3560 p += sizeof( ssl_serialized_context_header );
3561
3562 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003563 * Session
3564 */
3565 if( (size_t)( end - p ) < 4 )
3566 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3567
3568 session_len = ( (size_t) p[0] << 24 ) |
3569 ( (size_t) p[1] << 16 ) |
3570 ( (size_t) p[2] << 8 ) |
3571 ( (size_t) p[3] );
3572 p += 4;
3573
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003574 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003575 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003576 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003577 ssl->session_in = ssl->session;
3578 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003579 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003580
3581 if( (size_t)( end - p ) < session_len )
3582 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3583
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003584 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003585 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003586 {
3587 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003588 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003589 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003590
3591 p += session_len;
3592
3593 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003594 * Transform
3595 */
3596
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003597 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003598 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003599 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003600 ssl->transform_in = ssl->transform;
3601 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003602 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003603
3604 /* Read random bytes and populate structure */
3605 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3606 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003607#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003608 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003609 ssl->session->ciphersuite,
3610 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003611#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3612 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003613 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003614#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3615 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003616 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3617 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003618 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003619 ssl->conf->endpoint,
3620 ssl );
3621 if( ret != 0 )
3622 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003623#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003624 p += sizeof( ssl->transform->randbytes );
3625
3626#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3627 /* Read connection IDs and store them */
3628 if( (size_t)( end - p ) < 1 )
3629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3630
3631 ssl->transform->in_cid_len = *p++;
3632
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003633 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003634 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3635
3636 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3637 p += ssl->transform->in_cid_len;
3638
3639 ssl->transform->out_cid_len = *p++;
3640
3641 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3642 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3643
3644 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3645 p += ssl->transform->out_cid_len;
3646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3647
3648 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003649 * Saved fields from top-level ssl_context structure
3650 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003651 if( (size_t)( end - p ) < 4 )
3652 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3653
3654 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3655 ( (uint32_t) p[1] << 16 ) |
3656 ( (uint32_t) p[2] << 8 ) |
3657 ( (uint32_t) p[3] );
3658 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003659
3660#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3661 if( (size_t)( end - p ) < 16 )
3662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3663
3664 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3665 ( (uint64_t) p[1] << 48 ) |
3666 ( (uint64_t) p[2] << 40 ) |
3667 ( (uint64_t) p[3] << 32 ) |
3668 ( (uint64_t) p[4] << 24 ) |
3669 ( (uint64_t) p[5] << 16 ) |
3670 ( (uint64_t) p[6] << 8 ) |
3671 ( (uint64_t) p[7] );
3672 p += 8;
3673
3674 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3675 ( (uint64_t) p[1] << 48 ) |
3676 ( (uint64_t) p[2] << 40 ) |
3677 ( (uint64_t) p[3] << 32 ) |
3678 ( (uint64_t) p[4] << 24 ) |
3679 ( (uint64_t) p[5] << 16 ) |
3680 ( (uint64_t) p[6] << 8 ) |
3681 ( (uint64_t) p[7] );
3682 p += 8;
3683#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3684
3685#if defined(MBEDTLS_SSL_PROTO_DTLS)
3686 if( (size_t)( end - p ) < 1 )
3687 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3688
3689 ssl->disable_datagram_packing = *p++;
3690#endif /* MBEDTLS_SSL_PROTO_DTLS */
3691
Jerry Yud9a94fe2021-09-28 18:58:59 +08003692 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003693 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003694 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3695 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003696
3697#if defined(MBEDTLS_SSL_PROTO_DTLS)
3698 if( (size_t)( end - p ) < 2 )
3699 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3700
3701 ssl->mtu = ( p[0] << 8 ) | p[1];
3702 p += 2;
3703#endif /* MBEDTLS_SSL_PROTO_DTLS */
3704
3705#if defined(MBEDTLS_SSL_ALPN)
3706 {
3707 uint8_t alpn_len;
3708 const char **cur;
3709
3710 if( (size_t)( end - p ) < 1 )
3711 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3712
3713 alpn_len = *p++;
3714
3715 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3716 {
3717 /* alpn_chosen should point to an item in the configured list */
3718 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3719 {
3720 if( strlen( *cur ) == alpn_len &&
3721 memcmp( p, cur, alpn_len ) == 0 )
3722 {
3723 ssl->alpn_chosen = *cur;
3724 break;
3725 }
3726 }
3727 }
3728
3729 /* can only happen on conf mismatch */
3730 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3731 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3732
3733 p += alpn_len;
3734 }
3735#endif /* MBEDTLS_SSL_ALPN */
3736
3737 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003738 * Forced fields from top-level ssl_context structure
3739 *
3740 * Most of them already set to the correct value by mbedtls_ssl_init() and
3741 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3742 */
3743 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003744 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003745
Hanno Becker361b10d2019-08-30 10:42:49 +01003746 /* Adjust pointers for header fields of outgoing records to
3747 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003748 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003749
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003750#if defined(MBEDTLS_SSL_PROTO_DTLS)
3751 ssl->in_epoch = 1;
3752#endif
3753
3754 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3755 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003756 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3757 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003758 if( ssl->handshake != NULL )
3759 {
3760 mbedtls_ssl_handshake_free( ssl );
3761 mbedtls_free( ssl->handshake );
3762 ssl->handshake = NULL;
3763 }
3764
3765 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003766 * Done - should have consumed entire buffer
3767 */
3768 if( p != end )
3769 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003770
3771 return( 0 );
3772}
3773
3774/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003775 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003776 */
3777int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3778 const unsigned char *buf,
3779 size_t len )
3780{
3781 int ret = ssl_context_load( context, buf, len );
3782
3783 if( ret != 0 )
3784 mbedtls_ssl_free( context );
3785
3786 return( ret );
3787}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003788#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003789
3790/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003791 * Free an SSL context
3792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003794{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003795 if( ssl == NULL )
3796 return;
3797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003799
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003800 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003801 {
sander-visserb8aa2072020-05-06 22:05:13 +02003802#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3803 size_t out_buf_len = ssl->out_buf_len;
3804#else
3805 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3806#endif
3807
Darryl Greenb33cc762019-11-28 14:29:44 +00003808 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003809 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003810 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003811 }
3812
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003813 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003814 {
sander-visserb8aa2072020-05-06 22:05:13 +02003815#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3816 size_t in_buf_len = ssl->in_buf_len;
3817#else
3818 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3819#endif
3820
Darryl Greenb33cc762019-11-28 14:29:44 +00003821 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003822 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003823 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003824 }
3825
Paul Bakker48916f92012-09-16 19:57:18 +00003826 if( ssl->transform )
3827 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003828 mbedtls_ssl_transform_free( ssl->transform );
3829 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003830 }
3831
3832 if( ssl->handshake )
3833 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003834 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3836 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838 mbedtls_free( ssl->handshake );
3839 mbedtls_free( ssl->transform_negotiate );
3840 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003841 }
3842
Ronald Cron6f135e12021-12-08 16:57:54 +01003843#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003844 mbedtls_ssl_transform_free( ssl->transform_application );
3845 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003846#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003847
Paul Bakkerc0463502013-02-14 11:19:38 +01003848 if( ssl->session )
3849 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850 mbedtls_ssl_session_free( ssl->session );
3851 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003852 }
3853
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003854#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003855 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003856 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003857 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003858 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003859 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003860#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003861
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003862#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003863 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003864#endif
3865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003867
Paul Bakker86f04f42013-02-14 11:20:09 +01003868 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003869 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003870}
3871
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003872/*
3873 * Initialze mbedtls_ssl_config
3874 */
3875void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3876{
3877 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3878}
3879
Gilles Peskineeccd8882020-03-10 12:19:08 +01003880#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003881#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003882/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003883 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3884 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003885 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3886 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003887static int ssl_preset_default_hashes[] = {
3888#if defined(MBEDTLS_SHA512_C)
3889 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003890#endif
3891#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003892 MBEDTLS_MD_SHA384,
3893#endif
3894#if defined(MBEDTLS_SHA256_C)
3895 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003896#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003897 MBEDTLS_MD_NONE
3898};
Jerry Yuf017ee42022-01-12 15:49:48 +08003899#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3900#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003901
Gilles Peskineae270bf2021-06-02 00:05:29 +02003902/* The selection should be the same as mbedtls_x509_crt_profile_default in
3903 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003904 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003905 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003906 * about this list.
3907 */
Brett Warrene0edc842021-08-17 09:53:13 +01003908static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003909#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003910 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003911#endif
3912#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003913 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003914#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003915#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003916 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003917#endif
3918#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003919 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003920#endif
3921#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003922 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003923#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003924#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003925 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003926#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003927#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003928 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003929#endif
3930#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003931 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003932#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003933 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003934};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003935
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003936static int ssl_preset_suiteb_ciphersuites[] = {
3937 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3938 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3939 0
3940};
3941
Gilles Peskineeccd8882020-03-10 12:19:08 +01003942#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003943#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003944static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003945#if defined(MBEDTLS_SHA256_C)
3946 MBEDTLS_MD_SHA256,
3947#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003948#if defined(MBEDTLS_SHA384_C)
3949 MBEDTLS_MD_SHA384,
3950#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003951 MBEDTLS_MD_NONE
3952};
Jerry Yuf017ee42022-01-12 15:49:48 +08003953#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003954
Jerry Yu909df7b2022-01-22 11:56:27 +08003955/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003956 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003957 * rules SHOULD be upheld.
3958 * - No duplicate entries.
3959 * - But if there is a good reason, do not change the order of the algorithms.
3960 * - ssl_tls12_present* is for TLS 1.2 use only.
3961 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003962 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003963static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003964
Jerry Yued5e9f42022-01-26 11:21:34 +08003965#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3966 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3967 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3968#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3969 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003970
Jerry Yu909df7b2022-01-22 11:56:27 +08003971#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3972 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3973 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3974#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3975 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3976
Jerry Yued5e9f42022-01-26 11:21:34 +08003977#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3978 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3979 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
3980#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3981 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003982
Jerry Yu909df7b2022-01-22 11:56:27 +08003983#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3984 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3985#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
3986
Ronald Cron8540cf62022-03-16 08:01:09 +01003987#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
3988 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
3989#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
3990
3991#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
3992 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
3993#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
3994
Jerry Yu53037892022-01-25 11:02:06 +08003995#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
3996 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
3997#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
3998
Jerry Yu909df7b2022-01-22 11:56:27 +08003999 MBEDTLS_TLS1_3_SIG_NONE
4000};
4001
4002/* NOTICE: see above */
4003#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4004static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004005#if defined(MBEDTLS_SHA512_C)
4006 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4007#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004008#if defined(MBEDTLS_SHA384_C)
4009 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4010#endif
4011#if defined(MBEDTLS_SHA256_C)
4012 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4013#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004014 MBEDTLS_TLS1_3_SIG_NONE
4015};
4016#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4017/* NOTICE: see above */
4018static uint16_t ssl_preset_suiteb_sig_algs[] = {
4019
Jerry Yu909df7b2022-01-22 11:56:27 +08004020#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4021 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4022 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4023#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4024 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4025
Jerry Yu53037892022-01-25 11:02:06 +08004026#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4027 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4028 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4029#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4030 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004031
4032#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4033 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4034#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004035
Jerry Yu53037892022-01-25 11:02:06 +08004036#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4037 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4038#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4039
Jerry Yu713013f2022-01-17 18:16:35 +08004040 MBEDTLS_TLS1_3_SIG_NONE
4041};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004042
Jerry Yu909df7b2022-01-22 11:56:27 +08004043/* NOTICE: see above */
4044#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4045static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004046#if defined(MBEDTLS_SHA256_C)
4047 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4048#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004049#if defined(MBEDTLS_SHA384_C)
4050 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4051#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004052 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004053};
Jerry Yu909df7b2022-01-22 11:56:27 +08004054#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4055
Jerry Yu1a8b4812022-01-20 17:56:50 +08004056#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004057
Brett Warrene0edc842021-08-17 09:53:13 +01004058static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004059#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004060 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004061#endif
4062#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004063 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004064#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004065 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004066};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004067
Jerry Yu1a8b4812022-01-20 17:56:50 +08004068#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004069/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004070 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004071static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004072{
4073 size_t i, j;
4074 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004075
Jerry Yuf377d642022-01-25 10:43:59 +08004076 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004077 {
Jerry Yuf377d642022-01-25 10:43:59 +08004078 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004079 {
Jerry Yuf377d642022-01-25 10:43:59 +08004080 if( sig_algs[i] != sig_algs[j] )
4081 continue;
4082 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4083 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4084 sig_algs[i], j, i );
4085 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004086 }
4087 }
4088 return( ret );
4089}
4090
4091#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4092
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004093/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004094 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004095 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004096int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004097 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004098{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004099#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004101#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004102
Jerry Yu1a8b4812022-01-20 17:56:50 +08004103#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004104 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004105 {
4106 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4107 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4108 }
4109
Jerry Yuf377d642022-01-25 10:43:59 +08004110 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004111 {
4112 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4113 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4114 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004115
4116#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004117 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004118 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004119 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004120 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4121 }
4122
Jerry Yuf377d642022-01-25 10:43:59 +08004123 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004124 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004125 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004126 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4127 }
4128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004129#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4130
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004131 /* Use the functions here so that they are covered in tests,
4132 * but otherwise access member directly for efficiency */
4133 mbedtls_ssl_conf_endpoint( conf, endpoint );
4134 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004135
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004136 /*
4137 * Things that are common to all presets
4138 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004139#if defined(MBEDTLS_SSL_CLI_C)
4140 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4141 {
4142 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4143#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4144 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4145#endif
4146 }
4147#endif
4148
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004149#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4150 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4151#endif
4152
4153#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4154 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4155#endif
4156
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004157#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004158 conf->f_cookie_write = ssl_cookie_write_dummy;
4159 conf->f_cookie_check = ssl_cookie_check_dummy;
4160#endif
4161
4162#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4163 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4164#endif
4165
Janos Follath088ce432017-04-10 12:42:31 +01004166#if defined(MBEDTLS_SSL_SRV_C)
4167 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004168 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004169#endif
4170
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004171#if defined(MBEDTLS_SSL_PROTO_DTLS)
4172 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4173 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4174#endif
4175
4176#if defined(MBEDTLS_SSL_RENEGOTIATION)
4177 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004178 memset( conf->renego_period, 0x00, 2 );
4179 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004180#endif
4181
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004182#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004183 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4184 {
4185 const unsigned char dhm_p[] =
4186 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4187 const unsigned char dhm_g[] =
4188 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004189
Hanno Beckere2defad2021-07-24 05:59:17 +01004190 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4191 dhm_p, sizeof( dhm_p ),
4192 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4193 {
4194 return( ret );
4195 }
4196 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004197#endif
4198
Ronald Cron6f135e12021-12-08 16:57:54 +01004199#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004200 /*
4201 * Allow all TLS 1.3 key exchange modes by default.
4202 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004203 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004204#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004205
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004206 if( ( endpoint == MBEDTLS_SSL_IS_SERVER ) ||
4207 ( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) )
4208 {
4209#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4210 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4211 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4212#else
4213 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4214#endif
4215 }
4216 else
4217 {
4218#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4219 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4220 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4221#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4222 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4223 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4224#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4225 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4226 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4227#else
4228 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4229#endif
4230 }
4231
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004232 /*
4233 * Preset-specific defaults
4234 */
4235 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004236 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004237 /*
4238 * NSA Suite B
4239 */
4240 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004241
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004242 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004243
4244#if defined(MBEDTLS_X509_CRT_PARSE_C)
4245 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004246#endif
4247
Gilles Peskineeccd8882020-03-10 12:19:08 +01004248#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004249#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004250 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004251#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004252#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4253 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4254 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4255 else
4256#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4257 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004258#endif
4259
Brett Warrene0edc842021-08-17 09:53:13 +01004260#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4261 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004262#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004263 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004264 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004265
4266 /*
4267 * Default
4268 */
4269 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004270
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004271 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004272
4273#if defined(MBEDTLS_X509_CRT_PARSE_C)
4274 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4275#endif
4276
Gilles Peskineeccd8882020-03-10 12:19:08 +01004277#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004278#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004279 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004280#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004281#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4282 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4283 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4284 else
4285#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4286 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004287#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004288
Brett Warrene0edc842021-08-17 09:53:13 +01004289#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4290 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004291#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004292 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004293
4294#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4295 conf->dhm_min_bitlen = 1024;
4296#endif
4297 }
4298
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004299 return( 0 );
4300}
4301
4302/*
4303 * Free mbedtls_ssl_config
4304 */
4305void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4306{
4307#if defined(MBEDTLS_DHM_C)
4308 mbedtls_mpi_free( &conf->dhm_P );
4309 mbedtls_mpi_free( &conf->dhm_G );
4310#endif
4311
Gilles Peskineeccd8882020-03-10 12:19:08 +01004312#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004313 if( conf->psk != NULL )
4314 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004315 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004316 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004317 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004318 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004319 }
4320
4321 if( conf->psk_identity != NULL )
4322 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004323 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004324 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004325 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004326 conf->psk_identity_len = 0;
4327 }
4328#endif
4329
4330#if defined(MBEDTLS_X509_CRT_PARSE_C)
4331 ssl_key_cert_free( conf->key_cert );
4332#endif
4333
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004334 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004335}
4336
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004337#if defined(MBEDTLS_PK_C) && \
4338 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004339/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004340 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004342unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004343{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004344#if defined(MBEDTLS_RSA_C)
4345 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4346 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004347#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004348#if defined(MBEDTLS_ECDSA_C)
4349 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4350 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004351#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004353}
4354
Hanno Becker7e5437a2017-04-28 17:15:26 +01004355unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4356{
4357 switch( type ) {
4358 case MBEDTLS_PK_RSA:
4359 return( MBEDTLS_SSL_SIG_RSA );
4360 case MBEDTLS_PK_ECDSA:
4361 case MBEDTLS_PK_ECKEY:
4362 return( MBEDTLS_SSL_SIG_ECDSA );
4363 default:
4364 return( MBEDTLS_SSL_SIG_ANON );
4365 }
4366}
4367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004368mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004369{
4370 switch( sig )
4371 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004372#if defined(MBEDTLS_RSA_C)
4373 case MBEDTLS_SSL_SIG_RSA:
4374 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004375#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004376#if defined(MBEDTLS_ECDSA_C)
4377 case MBEDTLS_SSL_SIG_ECDSA:
4378 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004379#endif
4380 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004381 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004382 }
4383}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004384#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004385
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004386/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004387 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004389mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004390{
4391 switch( hash )
4392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004393#if defined(MBEDTLS_MD5_C)
4394 case MBEDTLS_SSL_HASH_MD5:
4395 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004396#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004397#if defined(MBEDTLS_SHA1_C)
4398 case MBEDTLS_SSL_HASH_SHA1:
4399 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004400#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004401#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004402 case MBEDTLS_SSL_HASH_SHA224:
4403 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004404#endif
4405#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004406 case MBEDTLS_SSL_HASH_SHA256:
4407 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004408#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004409#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004410 case MBEDTLS_SSL_HASH_SHA384:
4411 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004412#endif
4413#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004414 case MBEDTLS_SSL_HASH_SHA512:
4415 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004416#endif
4417 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004418 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004419 }
4420}
4421
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004422/*
4423 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4424 */
4425unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4426{
4427 switch( md )
4428 {
4429#if defined(MBEDTLS_MD5_C)
4430 case MBEDTLS_MD_MD5:
4431 return( MBEDTLS_SSL_HASH_MD5 );
4432#endif
4433#if defined(MBEDTLS_SHA1_C)
4434 case MBEDTLS_MD_SHA1:
4435 return( MBEDTLS_SSL_HASH_SHA1 );
4436#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004437#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004438 case MBEDTLS_MD_SHA224:
4439 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004440#endif
4441#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004442 case MBEDTLS_MD_SHA256:
4443 return( MBEDTLS_SSL_HASH_SHA256 );
4444#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004445#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004446 case MBEDTLS_MD_SHA384:
4447 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004448#endif
4449#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004450 case MBEDTLS_MD_SHA512:
4451 return( MBEDTLS_SSL_HASH_SHA512 );
4452#endif
4453 default:
4454 return( MBEDTLS_SSL_HASH_NONE );
4455 }
4456}
4457
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004458/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004459 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004460 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004461 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004462int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004463{
Brett Warrene0edc842021-08-17 09:53:13 +01004464 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004465
Brett Warrene0edc842021-08-17 09:53:13 +01004466 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004467 return( -1 );
4468
Brett Warrene0edc842021-08-17 09:53:13 +01004469 for( ; *group_list != 0; group_list++ )
4470 {
4471 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004472 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004473 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004474
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004475 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004476}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004477
4478#if defined(MBEDTLS_ECP_C)
4479/*
4480 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4481 */
4482int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4483{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004484 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004485 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4486}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004487#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004489#if defined(MBEDTLS_X509_CRT_PARSE_C)
4490int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4491 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004492 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004493 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004494{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004495 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004496 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004497 const char *ext_oid;
4498 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004500 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004501 {
4502 /* Server part of the key exchange */
4503 switch( ciphersuite->key_exchange )
4504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004505 case MBEDTLS_KEY_EXCHANGE_RSA:
4506 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004507 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004508 break;
4509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4511 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4512 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4513 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004514 break;
4515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4517 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004518 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004519 break;
4520
4521 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004522 case MBEDTLS_KEY_EXCHANGE_NONE:
4523 case MBEDTLS_KEY_EXCHANGE_PSK:
4524 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4525 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004526 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004527 usage = 0;
4528 }
4529 }
4530 else
4531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4533 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004534 }
4535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004536 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004537 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004538 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004539 ret = -1;
4540 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004542 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004543 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004544 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4545 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004546 }
4547 else
4548 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4550 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004551 }
4552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004554 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004555 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004556 ret = -1;
4557 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004558
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004559 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004560}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004562
Jerry Yu148165c2021-09-24 23:20:59 +08004563#if defined(MBEDTLS_USE_PSA_CRYPTO)
4564int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4565 const mbedtls_md_type_t md,
4566 unsigned char *dst,
4567 size_t dst_len,
4568 size_t *olen )
4569{
Ronald Cronf6893e12022-01-07 22:09:01 +01004570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4571 psa_hash_operation_t *hash_operation_to_clone;
4572 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4573
Jerry Yu148165c2021-09-24 23:20:59 +08004574 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004575
4576 switch( md )
4577 {
4578#if defined(MBEDTLS_SHA384_C)
4579 case MBEDTLS_MD_SHA384:
4580 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4581 break;
4582#endif
4583
4584#if defined(MBEDTLS_SHA256_C)
4585 case MBEDTLS_MD_SHA256:
4586 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4587 break;
4588#endif
4589
4590 default:
4591 goto exit;
4592 }
4593
4594 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4595 if( status != PSA_SUCCESS )
4596 goto exit;
4597
4598 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4599 if( status != PSA_SUCCESS )
4600 goto exit;
4601
4602exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004603 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004604}
4605#else /* MBEDTLS_USE_PSA_CRYPTO */
4606
Jerry Yu24c0ec32021-09-09 14:21:07 +08004607#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004608static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4609 unsigned char *dst,
4610 size_t dst_len,
4611 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004612{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004613 int ret;
4614 mbedtls_sha512_context sha512;
4615
4616 if( dst_len < 48 )
4617 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4618
4619 mbedtls_sha512_init( &sha512 );
4620 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4621
4622 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4623 {
4624 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4625 goto exit;
4626 }
4627
4628 *olen = 48;
4629
4630exit:
4631
4632 mbedtls_sha512_free( &sha512 );
4633 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004634}
4635#endif /* MBEDTLS_SHA384_C */
4636
4637#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004638static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4639 unsigned char *dst,
4640 size_t dst_len,
4641 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004642{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004643 int ret;
4644 mbedtls_sha256_context sha256;
4645
4646 if( dst_len < 32 )
4647 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4648
4649 mbedtls_sha256_init( &sha256 );
4650 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004651
Jerry Yu24c0ec32021-09-09 14:21:07 +08004652 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4653 {
4654 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4655 goto exit;
4656 }
4657
4658 *olen = 32;
4659
4660exit:
4661
4662 mbedtls_sha256_free( &sha256 );
4663 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004664}
4665#endif /* MBEDTLS_SHA256_C */
4666
Jerry Yu000f9762021-09-14 11:12:51 +08004667int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4668 const mbedtls_md_type_t md,
4669 unsigned char *dst,
4670 size_t dst_len,
4671 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004672{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004673 switch( md )
4674 {
4675
Jerry Yu24c0ec32021-09-09 14:21:07 +08004676#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004677 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004678 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004679#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004680
Jerry Yu24c0ec32021-09-09 14:21:07 +08004681#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004682 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004683 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004684#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004685
4686 default:
4687 break;
4688 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004689 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004690}
XiaokangQian647719a2021-12-07 09:16:29 +00004691
Jerry Yu148165c2021-09-24 23:20:59 +08004692#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004693
Jerry Yudc7bd172022-02-17 13:44:15 +08004694#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4695
4696#if defined(MBEDTLS_USE_PSA_CRYPTO)
4697
4698static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4699 mbedtls_svc_key_id_t key,
4700 psa_algorithm_t alg,
4701 const unsigned char* seed, size_t seed_length,
4702 const unsigned char* label, size_t label_length,
4703 size_t capacity )
4704{
4705 psa_status_t status;
4706
4707 status = psa_key_derivation_setup( derivation, alg );
4708 if( status != PSA_SUCCESS )
4709 return( status );
4710
4711 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4712 {
4713 status = psa_key_derivation_input_bytes( derivation,
4714 PSA_KEY_DERIVATION_INPUT_SEED,
4715 seed, seed_length );
4716 if( status != PSA_SUCCESS )
4717 return( status );
4718
4719 if( mbedtls_svc_key_id_is_null( key ) )
4720 {
4721 status = psa_key_derivation_input_bytes(
4722 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4723 NULL, 0 );
4724 }
4725 else
4726 {
4727 status = psa_key_derivation_input_key(
4728 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4729 }
4730 if( status != PSA_SUCCESS )
4731 return( status );
4732
4733 status = psa_key_derivation_input_bytes( derivation,
4734 PSA_KEY_DERIVATION_INPUT_LABEL,
4735 label, label_length );
4736 if( status != PSA_SUCCESS )
4737 return( status );
4738 }
4739 else
4740 {
4741 return( PSA_ERROR_NOT_SUPPORTED );
4742 }
4743
4744 status = psa_key_derivation_set_capacity( derivation, capacity );
4745 if( status != PSA_SUCCESS )
4746 return( status );
4747
4748 return( PSA_SUCCESS );
4749}
4750
4751static int tls_prf_generic( mbedtls_md_type_t md_type,
4752 const unsigned char *secret, size_t slen,
4753 const char *label,
4754 const unsigned char *random, size_t rlen,
4755 unsigned char *dstbuf, size_t dlen )
4756{
4757 psa_status_t status;
4758 psa_algorithm_t alg;
4759 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4760 psa_key_derivation_operation_t derivation =
4761 PSA_KEY_DERIVATION_OPERATION_INIT;
4762
4763 if( md_type == MBEDTLS_MD_SHA384 )
4764 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4765 else
4766 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4767
4768 /* Normally a "secret" should be long enough to be impossible to
4769 * find by brute force, and in particular should not be empty. But
4770 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4771 * and for this use case it makes sense to have a 0-length "secret".
4772 * Since the key API doesn't allow importing a key of length 0,
4773 * keep master_key=0, which setup_psa_key_derivation() understands
4774 * to mean a 0-length "secret" input. */
4775 if( slen != 0 )
4776 {
4777 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4778 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4779 psa_set_key_algorithm( &key_attributes, alg );
4780 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4781
4782 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4783 if( status != PSA_SUCCESS )
4784 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4785 }
4786
4787 status = setup_psa_key_derivation( &derivation,
4788 master_key, alg,
4789 random, rlen,
4790 (unsigned char const *) label,
4791 (size_t) strlen( label ),
4792 dlen );
4793 if( status != PSA_SUCCESS )
4794 {
4795 psa_key_derivation_abort( &derivation );
4796 psa_destroy_key( master_key );
4797 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4798 }
4799
4800 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4801 if( status != PSA_SUCCESS )
4802 {
4803 psa_key_derivation_abort( &derivation );
4804 psa_destroy_key( master_key );
4805 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4806 }
4807
4808 status = psa_key_derivation_abort( &derivation );
4809 if( status != PSA_SUCCESS )
4810 {
4811 psa_destroy_key( master_key );
4812 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4813 }
4814
4815 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4816 status = psa_destroy_key( master_key );
4817 if( status != PSA_SUCCESS )
4818 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4819
4820 return( 0 );
4821}
4822
4823#else /* MBEDTLS_USE_PSA_CRYPTO */
4824
4825static int tls_prf_generic( mbedtls_md_type_t md_type,
4826 const unsigned char *secret, size_t slen,
4827 const char *label,
4828 const unsigned char *random, size_t rlen,
4829 unsigned char *dstbuf, size_t dlen )
4830{
4831 size_t nb;
4832 size_t i, j, k, md_len;
4833 unsigned char *tmp;
4834 size_t tmp_len = 0;
4835 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4836 const mbedtls_md_info_t *md_info;
4837 mbedtls_md_context_t md_ctx;
4838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4839
4840 mbedtls_md_init( &md_ctx );
4841
4842 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4843 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4844
4845 md_len = mbedtls_md_get_size( md_info );
4846
4847 tmp_len = md_len + strlen( label ) + rlen;
4848 tmp = mbedtls_calloc( 1, tmp_len );
4849 if( tmp == NULL )
4850 {
4851 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4852 goto exit;
4853 }
4854
4855 nb = strlen( label );
4856 memcpy( tmp + md_len, label, nb );
4857 memcpy( tmp + md_len + nb, random, rlen );
4858 nb += rlen;
4859
4860 /*
4861 * Compute P_<hash>(secret, label + random)[0..dlen]
4862 */
4863 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4864 goto exit;
4865
4866 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
4867 if( ret != 0 )
4868 goto exit;
4869 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
4870 if( ret != 0 )
4871 goto exit;
4872 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4873 if( ret != 0 )
4874 goto exit;
4875
4876 for( i = 0; i < dlen; i += md_len )
4877 {
4878 ret = mbedtls_md_hmac_reset ( &md_ctx );
4879 if( ret != 0 )
4880 goto exit;
4881 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4882 if( ret != 0 )
4883 goto exit;
4884 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4885 if( ret != 0 )
4886 goto exit;
4887
4888 ret = mbedtls_md_hmac_reset ( &md_ctx );
4889 if( ret != 0 )
4890 goto exit;
4891 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4892 if( ret != 0 )
4893 goto exit;
4894 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4895 if( ret != 0 )
4896 goto exit;
4897
4898 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4899
4900 for( j = 0; j < k; j++ )
4901 dstbuf[i + j] = h_i[j];
4902 }
4903
4904exit:
4905 mbedtls_md_free( &md_ctx );
4906
4907 mbedtls_platform_zeroize( tmp, tmp_len );
4908 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4909
4910 mbedtls_free( tmp );
4911
4912 return( ret );
4913}
4914#endif /* MBEDTLS_USE_PSA_CRYPTO */
4915
4916#if defined(MBEDTLS_SHA256_C)
4917static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4918 const char *label,
4919 const unsigned char *random, size_t rlen,
4920 unsigned char *dstbuf, size_t dlen )
4921{
4922 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4923 label, random, rlen, dstbuf, dlen ) );
4924}
4925#endif /* MBEDTLS_SHA256_C */
4926
4927#if defined(MBEDTLS_SHA384_C)
4928static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4929 const char *label,
4930 const unsigned char *random, size_t rlen,
4931 unsigned char *dstbuf, size_t dlen )
4932{
4933 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4934 label, random, rlen, dstbuf, dlen ) );
4935}
4936#endif /* MBEDTLS_SHA384_C */
4937
Jerry Yuf009d862022-02-17 14:01:37 +08004938/*
4939 * Set appropriate PRF function and other SSL / TLS1.2 functions
4940 *
4941 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08004942 * - hash associated with the ciphersuite (only used by TLS 1.2)
4943 *
4944 * Outputs:
4945 * - the tls_prf, calc_verify and calc_finished members of handshake structure
4946 */
4947static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08004948 mbedtls_md_type_t hash )
4949{
Jerry Yuf009d862022-02-17 14:01:37 +08004950#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01004951 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08004952 {
4953 handshake->tls_prf = tls_prf_sha384;
4954 handshake->calc_verify = ssl_calc_verify_tls_sha384;
4955 handshake->calc_finished = ssl_calc_finished_tls_sha384;
4956 }
4957 else
4958#endif
4959#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08004960 {
Ronald Cron81591aa2022-03-07 09:05:51 +01004961 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004962 handshake->tls_prf = tls_prf_sha256;
4963 handshake->calc_verify = ssl_calc_verify_tls_sha256;
4964 handshake->calc_finished = ssl_calc_finished_tls_sha256;
4965 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004966#else
Jerry Yuf009d862022-02-17 14:01:37 +08004967 {
Jerry Yuf009d862022-02-17 14:01:37 +08004968 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01004969 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004970 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4971 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004972#endif
Jerry Yuf009d862022-02-17 14:01:37 +08004973
4974 return( 0 );
4975}
Jerry Yud6ab2352022-02-17 14:03:43 +08004976
4977#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
4978 defined(MBEDTLS_USE_PSA_CRYPTO)
4979static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
4980{
4981 if( ssl->conf->f_psk != NULL )
4982 {
4983 /* If we've used a callback to select the PSK,
4984 * the static configuration is irrelevant. */
4985 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
4986 return( 1 );
4987
4988 return( 0 );
4989 }
4990
4991 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
4992 return( 1 );
4993
4994 return( 0 );
4995}
4996#endif /* MBEDTLS_USE_PSA_CRYPTO &&
4997 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
4998
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08004999/*
5000 * Compute master secret if needed
5001 *
5002 * Parameters:
5003 * [in/out] handshake
5004 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5005 * (PSA-PSK) ciphersuite_info, psk_opaque
5006 * [out] premaster (cleared)
5007 * [out] master
5008 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5009 * debug: conf->f_dbg, conf->p_dbg
5010 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005011 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005012 */
5013static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5014 unsigned char *master,
5015 const mbedtls_ssl_context *ssl )
5016{
5017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5018
5019 /* cf. RFC 5246, Section 8.1:
5020 * "The master secret is always exactly 48 bytes in length." */
5021 size_t const master_secret_len = 48;
5022
5023#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5024 unsigned char session_hash[48];
5025#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5026
5027 /* The label for the KDF used for key expansion.
5028 * This is either "master secret" or "extended master secret"
5029 * depending on whether the Extended Master Secret extension
5030 * is used. */
5031 char const *lbl = "master secret";
5032
5033 /* The salt for the KDF used for key expansion.
5034 * - If the Extended Master Secret extension is not used,
5035 * this is ClientHello.Random + ServerHello.Random
5036 * (see Sect. 8.1 in RFC 5246).
5037 * - If the Extended Master Secret extension is used,
5038 * this is the transcript of the handshake so far.
5039 * (see Sect. 4 in RFC 7627). */
5040 unsigned char const *salt = handshake->randbytes;
5041 size_t salt_len = 64;
5042
5043#if !defined(MBEDTLS_DEBUG_C) && \
5044 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5045 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5046 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5047 ssl = NULL; /* make sure we don't use it except for those cases */
5048 (void) ssl;
5049#endif
5050
5051 if( handshake->resume != 0 )
5052 {
5053 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5054 return( 0 );
5055 }
5056
5057#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5058 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5059 {
5060 lbl = "extended master secret";
5061 salt = session_hash;
5062 handshake->calc_verify( ssl, session_hash, &salt_len );
5063
5064 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5065 session_hash, salt_len );
5066 }
5067#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5068
5069#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5070 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5071 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005072 ssl_use_opaque_psk( ssl ) == 1 )
5073 {
5074 /* Perform PSK-to-MS expansion in a single step. */
5075 psa_status_t status;
5076 psa_algorithm_t alg;
5077 mbedtls_svc_key_id_t psk;
5078 psa_key_derivation_operation_t derivation =
5079 PSA_KEY_DERIVATION_OPERATION_INIT;
5080 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5081
5082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5083
5084 psk = mbedtls_ssl_get_opaque_psk( ssl );
5085
5086 if( hash_alg == MBEDTLS_MD_SHA384 )
5087 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5088 else
5089 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5090
5091 status = setup_psa_key_derivation( &derivation, psk, alg,
5092 salt, salt_len,
5093 (unsigned char const *) lbl,
5094 (size_t) strlen( lbl ),
5095 master_secret_len );
5096 if( status != PSA_SUCCESS )
5097 {
5098 psa_key_derivation_abort( &derivation );
5099 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5100 }
5101
5102 status = psa_key_derivation_output_bytes( &derivation,
5103 master,
5104 master_secret_len );
5105 if( status != PSA_SUCCESS )
5106 {
5107 psa_key_derivation_abort( &derivation );
5108 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5109 }
5110
5111 status = psa_key_derivation_abort( &derivation );
5112 if( status != PSA_SUCCESS )
5113 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5114 }
5115 else
5116#endif
5117 {
5118 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5119 lbl, salt, salt_len,
5120 master,
5121 master_secret_len );
5122 if( ret != 0 )
5123 {
5124 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5125 return( ret );
5126 }
5127
5128 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5129 handshake->premaster,
5130 handshake->pmslen );
5131
5132 mbedtls_platform_zeroize( handshake->premaster,
5133 sizeof(handshake->premaster) );
5134 }
5135
5136 return( 0 );
5137}
5138
Jerry Yud62f87e2022-02-17 14:09:02 +08005139int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5140{
5141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5142 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5143 ssl->handshake->ciphersuite_info;
5144
5145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5146
5147 /* Set PRF, calc_verify and calc_finished function pointers */
5148 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005149 ciphersuite_info->mac );
5150 if( ret != 0 )
5151 {
5152 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5153 return( ret );
5154 }
5155
5156 /* Compute master secret if needed */
5157 ret = ssl_compute_master( ssl->handshake,
5158 ssl->session_negotiate->master,
5159 ssl );
5160 if( ret != 0 )
5161 {
5162 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5163 return( ret );
5164 }
5165
5166 /* Swap the client and server random values:
5167 * - MS derivation wanted client+server (RFC 5246 8.1)
5168 * - key derivation wants server+client (RFC 5246 6.3) */
5169 {
5170 unsigned char tmp[64];
5171 memcpy( tmp, ssl->handshake->randbytes, 64 );
5172 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5173 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5174 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5175 }
5176
5177 /* Populate transform structure */
5178 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5179 ssl->session_negotiate->ciphersuite,
5180 ssl->session_negotiate->master,
5181#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5182 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5183 ssl->session_negotiate->encrypt_then_mac,
5184#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5185 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5186 ssl->handshake->tls_prf,
5187 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005188 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005189 ssl->conf->endpoint,
5190 ssl );
5191 if( ret != 0 )
5192 {
5193 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5194 return( ret );
5195 }
5196
5197 /* We no longer need Server/ClientHello.random values */
5198 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5199 sizeof( ssl->handshake->randbytes ) );
5200
5201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5202
5203 return( 0 );
5204}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005205
Ronald Cron4dcbca92022-03-07 10:21:40 +01005206int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5207{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005208 switch( md )
5209 {
5210#if defined(MBEDTLS_SHA384_C)
5211 case MBEDTLS_SSL_HASH_SHA384:
5212 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5213 break;
5214#endif
5215#if defined(MBEDTLS_SHA256_C)
5216 case MBEDTLS_SSL_HASH_SHA256:
5217 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5218 break;
5219#endif
5220 default:
5221 return( -1 );
5222 }
5223
Ronald Cronc2f13a02022-03-07 10:25:24 +01005224 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005225}
5226
Jerry Yu8392e0d2022-02-17 14:10:24 +08005227#if defined(MBEDTLS_SHA256_C)
5228void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5229 unsigned char *hash,
5230 size_t *hlen )
5231{
5232#if defined(MBEDTLS_USE_PSA_CRYPTO)
5233 size_t hash_size;
5234 psa_status_t status;
5235 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5236
5237 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5238 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5239 if( status != PSA_SUCCESS )
5240 {
5241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5242 return;
5243 }
5244
5245 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5246 if( status != PSA_SUCCESS )
5247 {
5248 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5249 return;
5250 }
5251
5252 *hlen = 32;
5253 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5254 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5255#else
5256 mbedtls_sha256_context sha256;
5257
5258 mbedtls_sha256_init( &sha256 );
5259
5260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5261
5262 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5263 mbedtls_sha256_finish( &sha256, hash );
5264
5265 *hlen = 32;
5266
5267 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5269
5270 mbedtls_sha256_free( &sha256 );
5271#endif /* MBEDTLS_USE_PSA_CRYPTO */
5272 return;
5273}
5274#endif /* MBEDTLS_SHA256_C */
5275
Jerry Yuc1cb3842022-02-17 14:13:48 +08005276#if defined(MBEDTLS_SHA384_C)
5277void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5278 unsigned char *hash,
5279 size_t *hlen )
5280{
5281#if defined(MBEDTLS_USE_PSA_CRYPTO)
5282 size_t hash_size;
5283 psa_status_t status;
5284 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5285
5286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5287 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5288 if( status != PSA_SUCCESS )
5289 {
5290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5291 return;
5292 }
5293
5294 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5295 if( status != PSA_SUCCESS )
5296 {
5297 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5298 return;
5299 }
5300
5301 *hlen = 48;
5302 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5304#else
5305 mbedtls_sha512_context sha512;
5306
5307 mbedtls_sha512_init( &sha512 );
5308
5309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5310
5311 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5312 mbedtls_sha512_finish( &sha512, hash );
5313
5314 *hlen = 48;
5315
5316 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5317 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5318
5319 mbedtls_sha512_free( &sha512 );
5320#endif /* MBEDTLS_USE_PSA_CRYPTO */
5321 return;
5322}
5323#endif /* MBEDTLS_SHA384_C */
5324
Jerry Yuce3dca42022-02-17 14:16:37 +08005325#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5326int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5327{
5328 unsigned char *p = ssl->handshake->premaster;
5329 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5330 const unsigned char *psk = NULL;
5331 size_t psk_len = 0;
5332
5333 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5334 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5335 {
5336 /*
5337 * This should never happen because the existence of a PSK is always
5338 * checked before calling this function
5339 */
5340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5341 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5342 }
5343
5344 /*
5345 * PMS = struct {
5346 * opaque other_secret<0..2^16-1>;
5347 * opaque psk<0..2^16-1>;
5348 * };
5349 * with "other_secret" depending on the particular key exchange
5350 */
5351#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5352 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5353 {
5354 if( end - p < 2 )
5355 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5356
5357 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5358 p += 2;
5359
5360 if( end < p || (size_t)( end - p ) < psk_len )
5361 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5362
5363 memset( p, 0, psk_len );
5364 p += psk_len;
5365 }
5366 else
5367#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5368#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5369 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5370 {
5371 /*
5372 * other_secret already set by the ClientKeyExchange message,
5373 * and is 48 bytes long
5374 */
5375 if( end - p < 2 )
5376 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5377
5378 *p++ = 0;
5379 *p++ = 48;
5380 p += 48;
5381 }
5382 else
5383#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5384#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5385 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5386 {
5387 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5388 size_t len;
5389
5390 /* Write length only when we know the actual value */
5391 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5392 p + 2, end - ( p + 2 ), &len,
5393 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5394 {
5395 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5396 return( ret );
5397 }
5398 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5399 p += 2 + len;
5400
5401 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5402 }
5403 else
5404#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5405#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5406 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5407 {
5408 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5409 size_t zlen;
5410
5411 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5412 p + 2, end - ( p + 2 ),
5413 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5414 {
5415 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5416 return( ret );
5417 }
5418
5419 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5420 p += 2 + zlen;
5421
5422 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5423 MBEDTLS_DEBUG_ECDH_Z );
5424 }
5425 else
5426#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5427 {
5428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5429 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5430 }
5431
5432 /* opaque psk<0..2^16-1>; */
5433 if( end - p < 2 )
5434 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5435
5436 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5437 p += 2;
5438
5439 if( end < p || (size_t)( end - p ) < psk_len )
5440 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5441
5442 memcpy( p, psk, psk_len );
5443 p += psk_len;
5444
5445 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5446
5447 return( 0 );
5448}
5449#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005450
5451#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5452static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5453
5454#if defined(MBEDTLS_SSL_PROTO_DTLS)
5455int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5456{
5457 /* If renegotiation is not enforced, retransmit until we would reach max
5458 * timeout if we were using the usual handshake doubling scheme */
5459 if( ssl->conf->renego_max_records < 0 )
5460 {
5461 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5462 unsigned char doublings = 1;
5463
5464 while( ratio != 0 )
5465 {
5466 ++doublings;
5467 ratio >>= 1;
5468 }
5469
5470 if( ++ssl->renego_records_seen > doublings )
5471 {
5472 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5473 return( 0 );
5474 }
5475 }
5476
5477 return( ssl_write_hello_request( ssl ) );
5478}
5479#endif
5480#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005481
Jerry Yud9526692022-02-17 14:23:47 +08005482/*
5483 * Handshake functions
5484 */
5485#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5486/* No certificate support -> dummy functions */
5487int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5488{
5489 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5490 ssl->handshake->ciphersuite_info;
5491
5492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5493
5494 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5495 {
5496 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5497 ssl->state++;
5498 return( 0 );
5499 }
5500
5501 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5502 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5503}
5504
5505int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5506{
5507 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5508 ssl->handshake->ciphersuite_info;
5509
5510 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5511
5512 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5513 {
5514 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5515 ssl->state++;
5516 return( 0 );
5517 }
5518
5519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5520 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5521}
5522
5523#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5524/* Some certificate support -> implement write and parse */
5525
5526int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5527{
5528 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5529 size_t i, n;
5530 const mbedtls_x509_crt *crt;
5531 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5532 ssl->handshake->ciphersuite_info;
5533
5534 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5535
5536 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5537 {
5538 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5539 ssl->state++;
5540 return( 0 );
5541 }
5542
5543#if defined(MBEDTLS_SSL_CLI_C)
5544 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5545 {
5546 if( ssl->handshake->client_auth == 0 )
5547 {
5548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5549 ssl->state++;
5550 return( 0 );
5551 }
5552 }
5553#endif /* MBEDTLS_SSL_CLI_C */
5554#if defined(MBEDTLS_SSL_SRV_C)
5555 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5556 {
5557 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5558 {
5559 /* Should never happen because we shouldn't have picked the
5560 * ciphersuite if we don't have a certificate. */
5561 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5562 }
5563 }
5564#endif
5565
5566 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5567
5568 /*
5569 * 0 . 0 handshake type
5570 * 1 . 3 handshake length
5571 * 4 . 6 length of all certs
5572 * 7 . 9 length of cert. 1
5573 * 10 . n-1 peer certificate
5574 * n . n+2 length of cert. 2
5575 * n+3 . ... upper level cert, etc.
5576 */
5577 i = 7;
5578 crt = mbedtls_ssl_own_cert( ssl );
5579
5580 while( crt != NULL )
5581 {
5582 n = crt->raw.len;
5583 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5584 {
5585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5586 " > %" MBEDTLS_PRINTF_SIZET,
5587 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5588 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5589 }
5590
5591 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5592 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5593 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5594
5595 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5596 i += n; crt = crt->next;
5597 }
5598
5599 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5600 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5601 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5602
5603 ssl->out_msglen = i;
5604 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5605 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5606
5607 ssl->state++;
5608
5609 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5610 {
5611 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5612 return( ret );
5613 }
5614
5615 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5616
5617 return( ret );
5618}
5619
5620#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5621
5622#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5623static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5624 unsigned char *crt_buf,
5625 size_t crt_buf_len )
5626{
5627 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5628
5629 if( peer_crt == NULL )
5630 return( -1 );
5631
5632 if( peer_crt->raw.len != crt_buf_len )
5633 return( -1 );
5634
5635 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5636}
5637#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5638static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5639 unsigned char *crt_buf,
5640 size_t crt_buf_len )
5641{
5642 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5643 unsigned char const * const peer_cert_digest =
5644 ssl->session->peer_cert_digest;
5645 mbedtls_md_type_t const peer_cert_digest_type =
5646 ssl->session->peer_cert_digest_type;
5647 mbedtls_md_info_t const * const digest_info =
5648 mbedtls_md_info_from_type( peer_cert_digest_type );
5649 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5650 size_t digest_len;
5651
5652 if( peer_cert_digest == NULL || digest_info == NULL )
5653 return( -1 );
5654
5655 digest_len = mbedtls_md_get_size( digest_info );
5656 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5657 return( -1 );
5658
5659 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5660 if( ret != 0 )
5661 return( -1 );
5662
5663 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5664}
5665#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5666#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5667
5668/*
5669 * Once the certificate message is read, parse it into a cert chain and
5670 * perform basic checks, but leave actual verification to the caller
5671 */
5672static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5673 mbedtls_x509_crt *chain )
5674{
5675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5676#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5677 int crt_cnt=0;
5678#endif
5679 size_t i, n;
5680 uint8_t alert;
5681
5682 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5683 {
5684 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5685 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5686 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5687 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5688 }
5689
5690 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5691 {
5692 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5693 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5694 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5695 }
5696
5697 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5698 {
5699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5700 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5701 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5702 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5703 }
5704
5705 i = mbedtls_ssl_hs_hdr_len( ssl );
5706
5707 /*
5708 * Same message structure as in mbedtls_ssl_write_certificate()
5709 */
5710 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5711
5712 if( ssl->in_msg[i] != 0 ||
5713 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5714 {
5715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5716 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5717 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5718 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5719 }
5720
5721 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5722 i += 3;
5723
5724 /* Iterate through and parse the CRTs in the provided chain. */
5725 while( i < ssl->in_hslen )
5726 {
5727 /* Check that there's room for the next CRT's length fields. */
5728 if ( i + 3 > ssl->in_hslen ) {
5729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5730 mbedtls_ssl_send_alert_message( ssl,
5731 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5732 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5733 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5734 }
5735 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5736 * anything beyond 2**16 ~ 64K. */
5737 if( ssl->in_msg[i] != 0 )
5738 {
5739 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5740 mbedtls_ssl_send_alert_message( ssl,
5741 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5742 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5743 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5744 }
5745
5746 /* Read length of the next CRT in the chain. */
5747 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5748 | (unsigned int) ssl->in_msg[i + 2];
5749 i += 3;
5750
5751 if( n < 128 || i + n > ssl->in_hslen )
5752 {
5753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5754 mbedtls_ssl_send_alert_message( ssl,
5755 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5756 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5757 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5758 }
5759
5760 /* Check if we're handling the first CRT in the chain. */
5761#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5762 if( crt_cnt++ == 0 &&
5763 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5764 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5765 {
5766 /* During client-side renegotiation, check that the server's
5767 * end-CRTs hasn't changed compared to the initial handshake,
5768 * mitigating the triple handshake attack. On success, reuse
5769 * the original end-CRT instead of parsing it again. */
5770 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5771 if( ssl_check_peer_crt_unchanged( ssl,
5772 &ssl->in_msg[i],
5773 n ) != 0 )
5774 {
5775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5776 mbedtls_ssl_send_alert_message( ssl,
5777 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5778 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5779 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5780 }
5781
5782 /* Now we can safely free the original chain. */
5783 ssl_clear_peer_cert( ssl->session );
5784 }
5785#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5786
5787 /* Parse the next certificate in the chain. */
5788#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5789 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5790#else
5791 /* If we don't need to store the CRT chain permanently, parse
5792 * it in-place from the input buffer instead of making a copy. */
5793 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5794#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5795 switch( ret )
5796 {
5797 case 0: /*ok*/
5798 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5799 /* Ignore certificate with an unknown algorithm: maybe a
5800 prior certificate was already trusted. */
5801 break;
5802
5803 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5804 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5805 goto crt_parse_der_failed;
5806
5807 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5808 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5809 goto crt_parse_der_failed;
5810
5811 default:
5812 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5813 crt_parse_der_failed:
5814 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5815 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5816 return( ret );
5817 }
5818
5819 i += n;
5820 }
5821
5822 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5823 return( 0 );
5824}
5825
5826#if defined(MBEDTLS_SSL_SRV_C)
5827static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5828{
5829 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5830 return( -1 );
5831
5832 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5833 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5834 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5835 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5836 {
5837 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5838 return( 0 );
5839 }
5840 return( -1 );
5841}
5842#endif /* MBEDTLS_SSL_SRV_C */
5843
5844/* Check if a certificate message is expected.
5845 * Return either
5846 * - SSL_CERTIFICATE_EXPECTED, or
5847 * - SSL_CERTIFICATE_SKIP
5848 * indicating whether a Certificate message is expected or not.
5849 */
5850#define SSL_CERTIFICATE_EXPECTED 0
5851#define SSL_CERTIFICATE_SKIP 1
5852static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5853 int authmode )
5854{
5855 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5856 ssl->handshake->ciphersuite_info;
5857
5858 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5859 return( SSL_CERTIFICATE_SKIP );
5860
5861#if defined(MBEDTLS_SSL_SRV_C)
5862 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5863 {
5864 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5865 return( SSL_CERTIFICATE_SKIP );
5866
5867 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5868 {
5869 ssl->session_negotiate->verify_result =
5870 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5871 return( SSL_CERTIFICATE_SKIP );
5872 }
5873 }
5874#else
5875 ((void) authmode);
5876#endif /* MBEDTLS_SSL_SRV_C */
5877
5878 return( SSL_CERTIFICATE_EXPECTED );
5879}
5880
5881static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5882 int authmode,
5883 mbedtls_x509_crt *chain,
5884 void *rs_ctx )
5885{
5886 int ret = 0;
5887 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5888 ssl->handshake->ciphersuite_info;
5889 int have_ca_chain = 0;
5890
5891 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5892 void *p_vrfy;
5893
5894 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5895 return( 0 );
5896
5897 if( ssl->f_vrfy != NULL )
5898 {
5899 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5900 f_vrfy = ssl->f_vrfy;
5901 p_vrfy = ssl->p_vrfy;
5902 }
5903 else
5904 {
5905 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5906 f_vrfy = ssl->conf->f_vrfy;
5907 p_vrfy = ssl->conf->p_vrfy;
5908 }
5909
5910 /*
5911 * Main check: verify certificate
5912 */
5913#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5914 if( ssl->conf->f_ca_cb != NULL )
5915 {
5916 ((void) rs_ctx);
5917 have_ca_chain = 1;
5918
5919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5920 ret = mbedtls_x509_crt_verify_with_ca_cb(
5921 chain,
5922 ssl->conf->f_ca_cb,
5923 ssl->conf->p_ca_cb,
5924 ssl->conf->cert_profile,
5925 ssl->hostname,
5926 &ssl->session_negotiate->verify_result,
5927 f_vrfy, p_vrfy );
5928 }
5929 else
5930#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5931 {
5932 mbedtls_x509_crt *ca_chain;
5933 mbedtls_x509_crl *ca_crl;
5934
5935#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
5936 if( ssl->handshake->sni_ca_chain != NULL )
5937 {
5938 ca_chain = ssl->handshake->sni_ca_chain;
5939 ca_crl = ssl->handshake->sni_ca_crl;
5940 }
5941 else
5942#endif
5943 {
5944 ca_chain = ssl->conf->ca_chain;
5945 ca_crl = ssl->conf->ca_crl;
5946 }
5947
5948 if( ca_chain != NULL )
5949 have_ca_chain = 1;
5950
5951 ret = mbedtls_x509_crt_verify_restartable(
5952 chain,
5953 ca_chain, ca_crl,
5954 ssl->conf->cert_profile,
5955 ssl->hostname,
5956 &ssl->session_negotiate->verify_result,
5957 f_vrfy, p_vrfy, rs_ctx );
5958 }
5959
5960 if( ret != 0 )
5961 {
5962 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
5963 }
5964
5965#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
5966 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
5967 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
5968#endif
5969
5970 /*
5971 * Secondary checks: always done, but change 'ret' only if it was 0
5972 */
5973
5974#if defined(MBEDTLS_ECP_C)
5975 {
5976 const mbedtls_pk_context *pk = &chain->pk;
5977
5978 /* If certificate uses an EC key, make sure the curve is OK */
5979 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
5980 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
5981 {
5982 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
5983
5984 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
5985 if( ret == 0 )
5986 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
5987 }
5988 }
5989#endif /* MBEDTLS_ECP_C */
5990
5991 if( mbedtls_ssl_check_cert_usage( chain,
5992 ciphersuite_info,
5993 ! ssl->conf->endpoint,
5994 &ssl->session_negotiate->verify_result ) != 0 )
5995 {
5996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
5997 if( ret == 0 )
5998 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
5999 }
6000
6001 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6002 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6003 * with details encoded in the verification flags. All other kinds
6004 * of error codes, including those from the user provided f_vrfy
6005 * functions, are treated as fatal and lead to a failure of
6006 * ssl_parse_certificate even if verification was optional. */
6007 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6008 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6009 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6010 {
6011 ret = 0;
6012 }
6013
6014 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6015 {
6016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6017 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6018 }
6019
6020 if( ret != 0 )
6021 {
6022 uint8_t alert;
6023
6024 /* The certificate may have been rejected for several reasons.
6025 Pick one and send the corresponding alert. Which alert to send
6026 may be a subject of debate in some cases. */
6027 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6028 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6029 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6030 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6031 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6032 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6033 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6034 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6035 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6036 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6037 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6038 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6039 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6040 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6041 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6042 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6043 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6044 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6045 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6046 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6047 else
6048 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6049 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6050 alert );
6051 }
6052
6053#if defined(MBEDTLS_DEBUG_C)
6054 if( ssl->session_negotiate->verify_result != 0 )
6055 {
6056 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6057 (unsigned int) ssl->session_negotiate->verify_result ) );
6058 }
6059 else
6060 {
6061 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6062 }
6063#endif /* MBEDTLS_DEBUG_C */
6064
6065 return( ret );
6066}
6067
6068#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6069static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6070 unsigned char *start, size_t len )
6071{
6072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6073 /* Remember digest of the peer's end-CRT. */
6074 ssl->session_negotiate->peer_cert_digest =
6075 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6076 if( ssl->session_negotiate->peer_cert_digest == NULL )
6077 {
6078 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6079 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6080 mbedtls_ssl_send_alert_message( ssl,
6081 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6082 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6083
6084 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6085 }
6086
6087 ret = mbedtls_md( mbedtls_md_info_from_type(
6088 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6089 start, len,
6090 ssl->session_negotiate->peer_cert_digest );
6091
6092 ssl->session_negotiate->peer_cert_digest_type =
6093 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6094 ssl->session_negotiate->peer_cert_digest_len =
6095 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6096
6097 return( ret );
6098}
6099
6100static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6101 unsigned char *start, size_t len )
6102{
6103 unsigned char *end = start + len;
6104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6105
6106 /* Make a copy of the peer's raw public key. */
6107 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6108 ret = mbedtls_pk_parse_subpubkey( &start, end,
6109 &ssl->handshake->peer_pubkey );
6110 if( ret != 0 )
6111 {
6112 /* We should have parsed the public key before. */
6113 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6114 }
6115
6116 return( 0 );
6117}
6118#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6119
6120int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6121{
6122 int ret = 0;
6123 int crt_expected;
6124#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6125 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6126 ? ssl->handshake->sni_authmode
6127 : ssl->conf->authmode;
6128#else
6129 const int authmode = ssl->conf->authmode;
6130#endif
6131 void *rs_ctx = NULL;
6132 mbedtls_x509_crt *chain = NULL;
6133
6134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6135
6136 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6137 if( crt_expected == SSL_CERTIFICATE_SKIP )
6138 {
6139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6140 goto exit;
6141 }
6142
6143#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6144 if( ssl->handshake->ecrs_enabled &&
6145 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6146 {
6147 chain = ssl->handshake->ecrs_peer_cert;
6148 ssl->handshake->ecrs_peer_cert = NULL;
6149 goto crt_verify;
6150 }
6151#endif
6152
6153 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6154 {
6155 /* mbedtls_ssl_read_record may have sent an alert already. We
6156 let it decide whether to alert. */
6157 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6158 goto exit;
6159 }
6160
6161#if defined(MBEDTLS_SSL_SRV_C)
6162 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6163 {
6164 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6165
6166 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6167 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6168
6169 goto exit;
6170 }
6171#endif /* MBEDTLS_SSL_SRV_C */
6172
6173 /* Clear existing peer CRT structure in case we tried to
6174 * reuse a session but it failed, and allocate a new one. */
6175 ssl_clear_peer_cert( ssl->session_negotiate );
6176
6177 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6178 if( chain == NULL )
6179 {
6180 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6181 sizeof( mbedtls_x509_crt ) ) );
6182 mbedtls_ssl_send_alert_message( ssl,
6183 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6184 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6185
6186 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6187 goto exit;
6188 }
6189 mbedtls_x509_crt_init( chain );
6190
6191 ret = ssl_parse_certificate_chain( ssl, chain );
6192 if( ret != 0 )
6193 goto exit;
6194
6195#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6196 if( ssl->handshake->ecrs_enabled)
6197 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6198
6199crt_verify:
6200 if( ssl->handshake->ecrs_enabled)
6201 rs_ctx = &ssl->handshake->ecrs_ctx;
6202#endif
6203
6204 ret = ssl_parse_certificate_verify( ssl, authmode,
6205 chain, rs_ctx );
6206 if( ret != 0 )
6207 goto exit;
6208
6209#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6210 {
6211 unsigned char *crt_start, *pk_start;
6212 size_t crt_len, pk_len;
6213
6214 /* We parse the CRT chain without copying, so
6215 * these pointers point into the input buffer,
6216 * and are hence still valid after freeing the
6217 * CRT chain. */
6218
6219 crt_start = chain->raw.p;
6220 crt_len = chain->raw.len;
6221
6222 pk_start = chain->pk_raw.p;
6223 pk_len = chain->pk_raw.len;
6224
6225 /* Free the CRT structures before computing
6226 * digest and copying the peer's public key. */
6227 mbedtls_x509_crt_free( chain );
6228 mbedtls_free( chain );
6229 chain = NULL;
6230
6231 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6232 if( ret != 0 )
6233 goto exit;
6234
6235 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6236 if( ret != 0 )
6237 goto exit;
6238 }
6239#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6240 /* Pass ownership to session structure. */
6241 ssl->session_negotiate->peer_cert = chain;
6242 chain = NULL;
6243#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6244
6245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6246
6247exit:
6248
6249 if( ret == 0 )
6250 ssl->state++;
6251
6252#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6253 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6254 {
6255 ssl->handshake->ecrs_peer_cert = chain;
6256 chain = NULL;
6257 }
6258#endif
6259
6260 if( chain != NULL )
6261 {
6262 mbedtls_x509_crt_free( chain );
6263 mbedtls_free( chain );
6264 }
6265
6266 return( ret );
6267}
6268#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6269
Jerry Yu615bd6f2022-02-17 14:25:15 +08006270#if defined(MBEDTLS_SHA256_C)
6271static void ssl_calc_finished_tls_sha256(
6272 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6273{
6274 int len = 12;
6275 const char *sender;
6276 unsigned char padbuf[32];
6277#if defined(MBEDTLS_USE_PSA_CRYPTO)
6278 size_t hash_size;
6279 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6280 psa_status_t status;
6281#else
6282 mbedtls_sha256_context sha256;
6283#endif
6284
6285 mbedtls_ssl_session *session = ssl->session_negotiate;
6286 if( !session )
6287 session = ssl->session;
6288
6289 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6290 ? "client finished"
6291 : "server finished";
6292
6293#if defined(MBEDTLS_USE_PSA_CRYPTO)
6294 sha256_psa = psa_hash_operation_init();
6295
6296 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6297
6298 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6299 if( status != PSA_SUCCESS )
6300 {
6301 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6302 return;
6303 }
6304
6305 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6306 if( status != PSA_SUCCESS )
6307 {
6308 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6309 return;
6310 }
6311 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6312#else
6313
6314 mbedtls_sha256_init( &sha256 );
6315
6316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6317
6318 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6319
6320 /*
6321 * TLSv1.2:
6322 * hash = PRF( master, finished_label,
6323 * Hash( handshake ) )[0.11]
6324 */
6325
6326#if !defined(MBEDTLS_SHA256_ALT)
6327 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6328 sha256.state, sizeof( sha256.state ) );
6329#endif
6330
6331 mbedtls_sha256_finish( &sha256, padbuf );
6332 mbedtls_sha256_free( &sha256 );
6333#endif /* MBEDTLS_USE_PSA_CRYPTO */
6334
6335 ssl->handshake->tls_prf( session->master, 48, sender,
6336 padbuf, 32, buf, len );
6337
6338 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6339
6340 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6341
6342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6343}
6344#endif /* MBEDTLS_SHA256_C */
6345
Jerry Yub7ba49e2022-02-17 14:25:53 +08006346
6347#if defined(MBEDTLS_SHA384_C)
6348
6349static void ssl_calc_finished_tls_sha384(
6350 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6351{
6352 int len = 12;
6353 const char *sender;
6354 unsigned char padbuf[48];
6355#if defined(MBEDTLS_USE_PSA_CRYPTO)
6356 size_t hash_size;
6357 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6358 psa_status_t status;
6359#else
6360 mbedtls_sha512_context sha512;
6361#endif
6362
6363 mbedtls_ssl_session *session = ssl->session_negotiate;
6364 if( !session )
6365 session = ssl->session;
6366
6367 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6368 ? "client finished"
6369 : "server finished";
6370
6371#if defined(MBEDTLS_USE_PSA_CRYPTO)
6372 sha384_psa = psa_hash_operation_init();
6373
6374 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6375
6376 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6377 if( status != PSA_SUCCESS )
6378 {
6379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6380 return;
6381 }
6382
6383 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6384 if( status != PSA_SUCCESS )
6385 {
6386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6387 return;
6388 }
6389 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6390#else
6391 mbedtls_sha512_init( &sha512 );
6392
6393 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6394
6395 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6396
6397 /*
6398 * TLSv1.2:
6399 * hash = PRF( master, finished_label,
6400 * Hash( handshake ) )[0.11]
6401 */
6402
6403#if !defined(MBEDTLS_SHA512_ALT)
6404 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6405 sha512.state, sizeof( sha512.state ) );
6406#endif
6407 mbedtls_sha512_finish( &sha512, padbuf );
6408
6409 mbedtls_sha512_free( &sha512 );
6410#endif
6411
6412 ssl->handshake->tls_prf( session->master, 48, sender,
6413 padbuf, 48, buf, len );
6414
6415 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6416
6417 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6418
6419 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6420}
6421#endif /* MBEDTLS_SHA384_C */
6422
Jerry Yuaef00152022-02-17 14:27:31 +08006423void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6424{
6425 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6426
6427 /*
6428 * Free our handshake params
6429 */
6430 mbedtls_ssl_handshake_free( ssl );
6431 mbedtls_free( ssl->handshake );
6432 ssl->handshake = NULL;
6433
6434 /*
6435 * Free the previous transform and swith in the current one
6436 */
6437 if( ssl->transform )
6438 {
6439 mbedtls_ssl_transform_free( ssl->transform );
6440 mbedtls_free( ssl->transform );
6441 }
6442 ssl->transform = ssl->transform_negotiate;
6443 ssl->transform_negotiate = NULL;
6444
6445 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6446}
6447
Jerry Yu2a9fff52022-02-17 14:28:51 +08006448void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6449{
6450 int resume = ssl->handshake->resume;
6451
6452 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6453
6454#if defined(MBEDTLS_SSL_RENEGOTIATION)
6455 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6456 {
6457 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6458 ssl->renego_records_seen = 0;
6459 }
6460#endif
6461
6462 /*
6463 * Free the previous session and switch in the current one
6464 */
6465 if( ssl->session )
6466 {
6467#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6468 /* RFC 7366 3.1: keep the EtM state */
6469 ssl->session_negotiate->encrypt_then_mac =
6470 ssl->session->encrypt_then_mac;
6471#endif
6472
6473 mbedtls_ssl_session_free( ssl->session );
6474 mbedtls_free( ssl->session );
6475 }
6476 ssl->session = ssl->session_negotiate;
6477 ssl->session_negotiate = NULL;
6478
6479 /*
6480 * Add cache entry
6481 */
6482 if( ssl->conf->f_set_cache != NULL &&
6483 ssl->session->id_len != 0 &&
6484 resume == 0 )
6485 {
6486 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6487 ssl->session->id,
6488 ssl->session->id_len,
6489 ssl->session ) != 0 )
6490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6491 }
6492
6493#if defined(MBEDTLS_SSL_PROTO_DTLS)
6494 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6495 ssl->handshake->flight != NULL )
6496 {
6497 /* Cancel handshake timer */
6498 mbedtls_ssl_set_timer( ssl, 0 );
6499
6500 /* Keep last flight around in case we need to resend it:
6501 * we need the handshake and transform structures for that */
6502 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6503 }
6504 else
6505#endif
6506 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6507
6508 ssl->state++;
6509
6510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6511}
6512
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006513int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6514{
6515 int ret, hash_len;
6516
6517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6518
6519 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6520
6521 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6522
6523 /*
6524 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6525 * may define some other value. Currently (early 2016), no defined
6526 * ciphersuite does this (and this is unlikely to change as activity has
6527 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6528 */
6529 hash_len = 12;
6530
6531#if defined(MBEDTLS_SSL_RENEGOTIATION)
6532 ssl->verify_data_len = hash_len;
6533 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6534#endif
6535
6536 ssl->out_msglen = 4 + hash_len;
6537 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6538 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6539
6540 /*
6541 * In case of session resuming, invert the client and server
6542 * ChangeCipherSpec messages order.
6543 */
6544 if( ssl->handshake->resume != 0 )
6545 {
6546#if defined(MBEDTLS_SSL_CLI_C)
6547 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6548 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6549#endif
6550#if defined(MBEDTLS_SSL_SRV_C)
6551 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6552 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6553#endif
6554 }
6555 else
6556 ssl->state++;
6557
6558 /*
6559 * Switch to our negotiated transform and session parameters for outbound
6560 * data.
6561 */
6562 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6563
6564#if defined(MBEDTLS_SSL_PROTO_DTLS)
6565 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6566 {
6567 unsigned char i;
6568
6569 /* Remember current epoch settings for resending */
6570 ssl->handshake->alt_transform_out = ssl->transform_out;
6571 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6572 sizeof( ssl->handshake->alt_out_ctr ) );
6573
6574 /* Set sequence_number to zero */
6575 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6576
6577
6578 /* Increment epoch */
6579 for( i = 2; i > 0; i-- )
6580 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6581 break;
6582
6583 /* The loop goes to its end iff the counter is wrapping */
6584 if( i == 0 )
6585 {
6586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6587 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6588 }
6589 }
6590 else
6591#endif /* MBEDTLS_SSL_PROTO_DTLS */
6592 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6593
6594 ssl->transform_out = ssl->transform_negotiate;
6595 ssl->session_out = ssl->session_negotiate;
6596
6597#if defined(MBEDTLS_SSL_PROTO_DTLS)
6598 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6599 mbedtls_ssl_send_flight_completed( ssl );
6600#endif
6601
6602 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6603 {
6604 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6605 return( ret );
6606 }
6607
6608#if defined(MBEDTLS_SSL_PROTO_DTLS)
6609 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6610 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6611 {
6612 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6613 return( ret );
6614 }
6615#endif
6616
6617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6618
6619 return( 0 );
6620}
6621
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006622#define SSL_MAX_HASH_LEN 12
6623
6624int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6625{
6626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6627 unsigned int hash_len = 12;
6628 unsigned char buf[SSL_MAX_HASH_LEN];
6629
6630 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6631
6632 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6633
6634 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6635 {
6636 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6637 goto exit;
6638 }
6639
6640 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6641 {
6642 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6643 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6644 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6645 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6646 goto exit;
6647 }
6648
6649 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6650 {
6651 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6652 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6653 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6654 goto exit;
6655 }
6656
6657 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6658 {
6659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6660 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6661 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6662 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6663 goto exit;
6664 }
6665
6666 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6667 buf, hash_len ) != 0 )
6668 {
6669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6670 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6671 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6672 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6673 goto exit;
6674 }
6675
6676#if defined(MBEDTLS_SSL_RENEGOTIATION)
6677 ssl->verify_data_len = hash_len;
6678 memcpy( ssl->peer_verify_data, buf, hash_len );
6679#endif
6680
6681 if( ssl->handshake->resume != 0 )
6682 {
6683#if defined(MBEDTLS_SSL_CLI_C)
6684 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6685 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6686#endif
6687#if defined(MBEDTLS_SSL_SRV_C)
6688 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6689 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6690#endif
6691 }
6692 else
6693 ssl->state++;
6694
6695#if defined(MBEDTLS_SSL_PROTO_DTLS)
6696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6697 mbedtls_ssl_recv_flight_completed( ssl );
6698#endif
6699
6700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6701
6702exit:
6703 mbedtls_platform_zeroize( buf, hash_len );
6704 return( ret );
6705}
6706
Jerry Yu392112c2022-02-17 14:34:10 +08006707#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6708/*
6709 * Helper to get TLS 1.2 PRF from ciphersuite
6710 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6711 */
6712static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6713{
6714#if defined(MBEDTLS_SHA384_C)
6715 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6716 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6717
6718 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6719 return( tls_prf_sha384 );
6720#else
6721 (void) ciphersuite_id;
6722#endif
6723 return( tls_prf_sha256 );
6724}
6725#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006726
6727static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6728{
6729 ((void) tls_prf);
6730#if defined(MBEDTLS_SHA384_C)
6731 if( tls_prf == tls_prf_sha384 )
6732 {
6733 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6734 }
6735 else
6736#endif
6737#if defined(MBEDTLS_SHA256_C)
6738 if( tls_prf == tls_prf_sha256 )
6739 {
6740 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6741 }
6742 else
6743#endif
6744 return( MBEDTLS_SSL_TLS_PRF_NONE );
6745}
6746
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006747/*
6748 * Populate a transform structure with session keys and all the other
6749 * necessary information.
6750 *
6751 * Parameters:
6752 * - [in/out]: transform: structure to populate
6753 * [in] must be just initialised with mbedtls_ssl_transform_init()
6754 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6755 * - [in] ciphersuite
6756 * - [in] master
6757 * - [in] encrypt_then_mac
6758 * - [in] compression
6759 * - [in] tls_prf: pointer to PRF to use for key derivation
6760 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006761 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006762 * - [in] endpoint: client or server
6763 * - [in] ssl: used for:
6764 * - ssl->conf->{f,p}_export_keys
6765 * [in] optionally used for:
6766 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6767 */
6768static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6769 int ciphersuite,
6770 const unsigned char master[48],
6771#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6772 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6773 int encrypt_then_mac,
6774#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6775 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6776 ssl_tls_prf_t tls_prf,
6777 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006778 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006779 unsigned endpoint,
6780 const mbedtls_ssl_context *ssl )
6781{
6782 int ret = 0;
6783 unsigned char keyblk[256];
6784 unsigned char *key1;
6785 unsigned char *key2;
6786 unsigned char *mac_enc;
6787 unsigned char *mac_dec;
6788 size_t mac_key_len = 0;
6789 size_t iv_copy_len;
6790 size_t keylen;
6791 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6792 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006793#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006794 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006795#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006796
6797#if defined(MBEDTLS_USE_PSA_CRYPTO)
6798 psa_key_type_t key_type;
6799 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6800 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006801 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006802 size_t key_bits;
6803 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6804#endif
6805
6806#if !defined(MBEDTLS_DEBUG_C) && \
6807 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6808 if( ssl->f_export_keys == NULL )
6809 {
6810 ssl = NULL; /* make sure we don't use it except for these cases */
6811 (void) ssl;
6812 }
6813#endif
6814
6815 /*
6816 * Some data just needs copying into the structure
6817 */
6818#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6819 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6820 transform->encrypt_then_mac = encrypt_then_mac;
6821#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006822 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006823
6824#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6825 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6826#endif
6827
6828#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006829 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006830 {
6831 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6832 * generation separate. This should never happen. */
6833 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6834 }
6835#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6836
6837 /*
6838 * Get various info structures
6839 */
6840 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6841 if( ciphersuite_info == NULL )
6842 {
6843 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6844 ciphersuite ) );
6845 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6846 }
6847
6848 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6849 if( cipher_info == NULL )
6850 {
6851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6852 ciphersuite_info->cipher ) );
6853 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6854 }
6855
Neil Armstronge4512952022-03-08 09:08:22 +01006856#if defined(MBEDTLS_USE_PSA_CRYPTO)
6857 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6858 if( mac_alg == 0 )
6859 {
6860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6861 (unsigned) ciphersuite_info->mac ) );
6862 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6863 }
6864#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006865 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6866 if( md_info == NULL )
6867 {
6868 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6869 (unsigned) ciphersuite_info->mac ) );
6870 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6871 }
Neil Armstronge4512952022-03-08 09:08:22 +01006872#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006873
6874#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6875 /* Copy own and peer's CID if the use of the CID
6876 * extension has been negotiated. */
6877 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6878 {
6879 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6880
6881 transform->in_cid_len = ssl->own_cid_len;
6882 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6883 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6884 transform->in_cid_len );
6885
6886 transform->out_cid_len = ssl->handshake->peer_cid_len;
6887 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6888 ssl->handshake->peer_cid_len );
6889 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6890 transform->out_cid_len );
6891 }
6892#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6893
6894 /*
6895 * Compute key block using the PRF
6896 */
6897 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6898 if( ret != 0 )
6899 {
6900 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6901 return( ret );
6902 }
6903
6904 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6905 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6906 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6907 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6908 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6909
6910 /*
6911 * Determine the appropriate key, IV and MAC length.
6912 */
6913
6914 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6915
6916#if defined(MBEDTLS_GCM_C) || \
6917 defined(MBEDTLS_CCM_C) || \
6918 defined(MBEDTLS_CHACHAPOLY_C)
6919 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6920 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6921 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6922 {
6923 size_t explicit_ivlen;
6924
6925 transform->maclen = 0;
6926 mac_key_len = 0;
6927 transform->taglen =
6928 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6929
6930 /* All modes haves 96-bit IVs, but the length of the static parts vary
6931 * with mode and version:
6932 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6933 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6934 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
6935 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
6936 * sequence number).
6937 */
6938 transform->ivlen = 12;
6939 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6940 transform->fixed_ivlen = 12;
6941 else
6942 transform->fixed_ivlen = 4;
6943
6944 /* Minimum length of encrypted record */
6945 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
6946 transform->minlen = explicit_ivlen + transform->taglen;
6947 }
6948 else
6949#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
6950#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6951 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
6952 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
6953 {
Neil Armstronge4512952022-03-08 09:08:22 +01006954#if defined(MBEDTLS_USE_PSA_CRYPTO)
6955 /* Get MAC length */
6956 mac_key_len = PSA_HASH_LENGTH(mac_alg);
6957#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006958 /* Initialize HMAC contexts */
6959 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
6960 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
6961 {
6962 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
6963 goto end;
6964 }
6965
6966 /* Get MAC length */
6967 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01006968#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006969 transform->maclen = mac_key_len;
6970
6971 /* IV length */
6972 transform->ivlen = cipher_info->iv_size;
6973
6974 /* Minimum length */
6975 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
6976 transform->minlen = transform->maclen;
6977 else
6978 {
6979 /*
6980 * GenericBlockCipher:
6981 * 1. if EtM is in use: one block plus MAC
6982 * otherwise: * first multiple of blocklen greater than maclen
6983 * 2. IV
6984 */
6985#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6986 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
6987 {
6988 transform->minlen = transform->maclen
6989 + cipher_info->block_size;
6990 }
6991 else
6992#endif
6993 {
6994 transform->minlen = transform->maclen
6995 + cipher_info->block_size
6996 - transform->maclen % cipher_info->block_size;
6997 }
6998
Glenn Strauss07c64162022-03-14 12:34:51 -04006999 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007000 {
7001 transform->minlen += transform->ivlen;
7002 }
7003 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007004 {
7005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7006 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7007 goto end;
7008 }
7009 }
7010 }
7011 else
7012#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7013 {
7014 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7015 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7016 }
7017
7018 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7019 (unsigned) keylen,
7020 (unsigned) transform->minlen,
7021 (unsigned) transform->ivlen,
7022 (unsigned) transform->maclen ) );
7023
7024 /*
7025 * Finally setup the cipher contexts, IVs and MAC secrets.
7026 */
7027#if defined(MBEDTLS_SSL_CLI_C)
7028 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7029 {
7030 key1 = keyblk + mac_key_len * 2;
7031 key2 = keyblk + mac_key_len * 2 + keylen;
7032
7033 mac_enc = keyblk;
7034 mac_dec = keyblk + mac_key_len;
7035
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007036 iv_copy_len = ( transform->fixed_ivlen ) ?
7037 transform->fixed_ivlen : transform->ivlen;
7038 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7039 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7040 iv_copy_len );
7041 }
7042 else
7043#endif /* MBEDTLS_SSL_CLI_C */
7044#if defined(MBEDTLS_SSL_SRV_C)
7045 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7046 {
7047 key1 = keyblk + mac_key_len * 2 + keylen;
7048 key2 = keyblk + mac_key_len * 2;
7049
7050 mac_enc = keyblk + mac_key_len;
7051 mac_dec = keyblk;
7052
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007053 iv_copy_len = ( transform->fixed_ivlen ) ?
7054 transform->fixed_ivlen : transform->ivlen;
7055 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7056 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7057 iv_copy_len );
7058 }
7059 else
7060#endif /* MBEDTLS_SSL_SRV_C */
7061 {
7062 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7063 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7064 goto end;
7065 }
7066
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007067 if( ssl != NULL && ssl->f_export_keys != NULL )
7068 {
7069 ssl->f_export_keys( ssl->p_export_keys,
7070 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7071 master, 48,
7072 randbytes + 32,
7073 randbytes,
7074 tls_prf_get_type( tls_prf ) );
7075 }
7076
7077#if defined(MBEDTLS_USE_PSA_CRYPTO)
7078 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7079 transform->taglen,
7080 &alg,
7081 &key_type,
7082 &key_bits ) ) != PSA_SUCCESS )
7083 {
7084 ret = psa_ssl_status_to_mbedtls( status );
7085 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7086 goto end;
7087 }
7088
7089 transform->psa_alg = alg;
7090
7091 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7092 {
7093 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7094 psa_set_key_algorithm( &attributes, alg );
7095 psa_set_key_type( &attributes, key_type );
7096
7097 if( ( status = psa_import_key( &attributes,
7098 key1,
7099 PSA_BITS_TO_BYTES( key_bits ),
7100 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7101 {
7102 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7103 ret = psa_ssl_status_to_mbedtls( status );
7104 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7105 goto end;
7106 }
7107
7108 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7109
7110 if( ( status = psa_import_key( &attributes,
7111 key2,
7112 PSA_BITS_TO_BYTES( key_bits ),
7113 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7114 {
7115 ret = psa_ssl_status_to_mbedtls( status );
7116 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7117 goto end;
7118 }
7119 }
7120#else
7121 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7122 cipher_info ) ) != 0 )
7123 {
7124 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7125 goto end;
7126 }
7127
7128 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7129 cipher_info ) ) != 0 )
7130 {
7131 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7132 goto end;
7133 }
7134
7135 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7136 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7137 MBEDTLS_ENCRYPT ) ) != 0 )
7138 {
7139 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7140 goto end;
7141 }
7142
7143 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7144 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7145 MBEDTLS_DECRYPT ) ) != 0 )
7146 {
7147 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7148 goto end;
7149 }
7150
7151#if defined(MBEDTLS_CIPHER_MODE_CBC)
7152 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7153 {
7154 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7155 MBEDTLS_PADDING_NONE ) ) != 0 )
7156 {
7157 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7158 goto end;
7159 }
7160
7161 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7162 MBEDTLS_PADDING_NONE ) ) != 0 )
7163 {
7164 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7165 goto end;
7166 }
7167 }
7168#endif /* MBEDTLS_CIPHER_MODE_CBC */
7169#endif /* MBEDTLS_USE_PSA_CRYPTO */
7170
Neil Armstrong29c0c042022-03-17 17:47:28 +01007171#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7172 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7173 For AEAD-based ciphersuites, there is nothing to do here. */
7174 if( mac_key_len != 0 )
7175 {
7176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007177 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007178
7179 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007180 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007181 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7182
7183 if( ( status = psa_import_key( &attributes,
7184 mac_enc, mac_key_len,
7185 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7186 {
7187 ret = psa_ssl_status_to_mbedtls( status );
7188 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7189 goto end;
7190 }
7191
Ronald Cronfb39f152022-03-25 14:36:28 +01007192 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7193 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7194 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007195 /* mbedtls_ct_hmac() requires the key to be exportable */
7196 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7197 PSA_KEY_USAGE_VERIFY_HASH );
7198 else
7199 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7200
7201 if( ( status = psa_import_key( &attributes,
7202 mac_dec, mac_key_len,
7203 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7204 {
7205 ret = psa_ssl_status_to_mbedtls( status );
7206 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7207 goto end;
7208 }
7209#else
7210 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7211 if( ret != 0 )
7212 goto end;
7213 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7214 if( ret != 0 )
7215 goto end;
7216#endif /* MBEDTLS_USE_PSA_CRYPTO */
7217 }
7218#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7219
7220 ((void) mac_dec);
7221 ((void) mac_enc);
7222
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007223end:
7224 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7225 return( ret );
7226}
7227
Jerry Yuee40f9d2022-02-17 14:55:16 +08007228#if defined(MBEDTLS_USE_PSA_CRYPTO)
7229int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7230 unsigned char *hash, size_t *hashlen,
7231 unsigned char *data, size_t data_len,
7232 mbedtls_md_type_t md_alg )
7233{
7234 psa_status_t status;
7235 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7236 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7237
7238 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7239
7240 if( ( status = psa_hash_setup( &hash_operation,
7241 hash_alg ) ) != PSA_SUCCESS )
7242 {
7243 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7244 goto exit;
7245 }
7246
7247 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7248 64 ) ) != PSA_SUCCESS )
7249 {
7250 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7251 goto exit;
7252 }
7253
7254 if( ( status = psa_hash_update( &hash_operation,
7255 data, data_len ) ) != PSA_SUCCESS )
7256 {
7257 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7258 goto exit;
7259 }
7260
7261 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7262 hashlen ) ) != PSA_SUCCESS )
7263 {
7264 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7265 goto exit;
7266 }
7267
7268exit:
7269 if( status != PSA_SUCCESS )
7270 {
7271 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7272 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7273 switch( status )
7274 {
7275 case PSA_ERROR_NOT_SUPPORTED:
7276 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7277 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7278 case PSA_ERROR_BUFFER_TOO_SMALL:
7279 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7280 case PSA_ERROR_INSUFFICIENT_MEMORY:
7281 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7282 default:
7283 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7284 }
7285 }
7286 return( 0 );
7287}
7288
7289#else
7290
7291int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7292 unsigned char *hash, size_t *hashlen,
7293 unsigned char *data, size_t data_len,
7294 mbedtls_md_type_t md_alg )
7295{
7296 int ret = 0;
7297 mbedtls_md_context_t ctx;
7298 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7299 *hashlen = mbedtls_md_get_size( md_info );
7300
7301 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7302
7303 mbedtls_md_init( &ctx );
7304
7305 /*
7306 * digitally-signed struct {
7307 * opaque client_random[32];
7308 * opaque server_random[32];
7309 * ServerDHParams params;
7310 * };
7311 */
7312 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7313 {
7314 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7315 goto exit;
7316 }
7317 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7318 {
7319 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7320 goto exit;
7321 }
7322 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7323 {
7324 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7325 goto exit;
7326 }
7327 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7328 {
7329 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7330 goto exit;
7331 }
7332 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7333 {
7334 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7335 goto exit;
7336 }
7337
7338exit:
7339 mbedtls_md_free( &ctx );
7340
7341 if( ret != 0 )
7342 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7343 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7344
7345 return( ret );
7346}
7347#endif /* MBEDTLS_USE_PSA_CRYPTO */
7348
Jerry Yud9d91da2022-02-17 14:57:06 +08007349#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7350
7351/* Find an entry in a signature-hash set matching a given hash algorithm. */
7352mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7353 mbedtls_pk_type_t sig_alg )
7354{
7355 switch( sig_alg )
7356 {
7357 case MBEDTLS_PK_RSA:
7358 return( set->rsa );
7359 case MBEDTLS_PK_ECDSA:
7360 return( set->ecdsa );
7361 default:
7362 return( MBEDTLS_MD_NONE );
7363 }
7364}
7365
7366/* Add a signature-hash-pair to a signature-hash set */
7367void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7368 mbedtls_pk_type_t sig_alg,
7369 mbedtls_md_type_t md_alg )
7370{
7371 switch( sig_alg )
7372 {
7373 case MBEDTLS_PK_RSA:
7374 if( set->rsa == MBEDTLS_MD_NONE )
7375 set->rsa = md_alg;
7376 break;
7377
7378 case MBEDTLS_PK_ECDSA:
7379 if( set->ecdsa == MBEDTLS_MD_NONE )
7380 set->ecdsa = md_alg;
7381 break;
7382
7383 default:
7384 break;
7385 }
7386}
7387
7388/* Allow exactly one hash algorithm for each signature. */
7389void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7390 mbedtls_md_type_t md_alg )
7391{
7392 set->rsa = md_alg;
7393 set->ecdsa = md_alg;
7394}
7395
7396#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7397
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007398/* Serialization of TLS 1.2 sessions:
7399 *
7400 * struct {
7401 * uint64 start_time;
7402 * uint8 ciphersuite[2]; // defined by the standard
7403 * uint8 compression; // 0 or 1
7404 * uint8 session_id_len; // at most 32
7405 * opaque session_id[32];
7406 * opaque master[48]; // fixed length in the standard
7407 * uint32 verify_result;
7408 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7409 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7410 * uint32 ticket_lifetime;
7411 * uint8 mfl_code; // up to 255 according to standard
7412 * uint8 encrypt_then_mac; // 0 or 1
7413 * } serialized_session_tls12;
7414 *
7415 */
7416static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7417 unsigned char *buf,
7418 size_t buf_len )
7419{
7420 unsigned char *p = buf;
7421 size_t used = 0;
7422
7423#if defined(MBEDTLS_HAVE_TIME)
7424 uint64_t start;
7425#endif
7426#if defined(MBEDTLS_X509_CRT_PARSE_C)
7427#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7428 size_t cert_len;
7429#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7430#endif /* MBEDTLS_X509_CRT_PARSE_C */
7431
7432 /*
7433 * Time
7434 */
7435#if defined(MBEDTLS_HAVE_TIME)
7436 used += 8;
7437
7438 if( used <= buf_len )
7439 {
7440 start = (uint64_t) session->start;
7441
7442 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7443 p += 8;
7444 }
7445#endif /* MBEDTLS_HAVE_TIME */
7446
7447 /*
7448 * Basic mandatory fields
7449 */
7450 used += 2 /* ciphersuite */
7451 + 1 /* compression */
7452 + 1 /* id_len */
7453 + sizeof( session->id )
7454 + sizeof( session->master )
7455 + 4; /* verify_result */
7456
7457 if( used <= buf_len )
7458 {
7459 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7460 p += 2;
7461
7462 *p++ = MBEDTLS_BYTE_0( session->compression );
7463
7464 *p++ = MBEDTLS_BYTE_0( session->id_len );
7465 memcpy( p, session->id, 32 );
7466 p += 32;
7467
7468 memcpy( p, session->master, 48 );
7469 p += 48;
7470
7471 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7472 p += 4;
7473 }
7474
7475 /*
7476 * Peer's end-entity certificate
7477 */
7478#if defined(MBEDTLS_X509_CRT_PARSE_C)
7479#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7480 if( session->peer_cert == NULL )
7481 cert_len = 0;
7482 else
7483 cert_len = session->peer_cert->raw.len;
7484
7485 used += 3 + cert_len;
7486
7487 if( used <= buf_len )
7488 {
7489 *p++ = MBEDTLS_BYTE_2( cert_len );
7490 *p++ = MBEDTLS_BYTE_1( cert_len );
7491 *p++ = MBEDTLS_BYTE_0( cert_len );
7492
7493 if( session->peer_cert != NULL )
7494 {
7495 memcpy( p, session->peer_cert->raw.p, cert_len );
7496 p += cert_len;
7497 }
7498 }
7499#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7500 if( session->peer_cert_digest != NULL )
7501 {
7502 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7503 if( used <= buf_len )
7504 {
7505 *p++ = (unsigned char) session->peer_cert_digest_type;
7506 *p++ = (unsigned char) session->peer_cert_digest_len;
7507 memcpy( p, session->peer_cert_digest,
7508 session->peer_cert_digest_len );
7509 p += session->peer_cert_digest_len;
7510 }
7511 }
7512 else
7513 {
7514 used += 2;
7515 if( used <= buf_len )
7516 {
7517 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7518 *p++ = 0;
7519 }
7520 }
7521#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7522#endif /* MBEDTLS_X509_CRT_PARSE_C */
7523
7524 /*
7525 * Session ticket if any, plus associated data
7526 */
7527#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7528 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7529
7530 if( used <= buf_len )
7531 {
7532 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7533 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7534 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7535
7536 if( session->ticket != NULL )
7537 {
7538 memcpy( p, session->ticket, session->ticket_len );
7539 p += session->ticket_len;
7540 }
7541
7542 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7543 p += 4;
7544 }
7545#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7546
7547 /*
7548 * Misc extension-related info
7549 */
7550#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7551 used += 1;
7552
7553 if( used <= buf_len )
7554 *p++ = session->mfl_code;
7555#endif
7556
7557#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7558 used += 1;
7559
7560 if( used <= buf_len )
7561 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7562#endif
7563
7564 return( used );
7565}
7566
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007567static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7568 const unsigned char *buf,
7569 size_t len )
7570{
7571#if defined(MBEDTLS_HAVE_TIME)
7572 uint64_t start;
7573#endif
7574#if defined(MBEDTLS_X509_CRT_PARSE_C)
7575#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7576 size_t cert_len;
7577#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7578#endif /* MBEDTLS_X509_CRT_PARSE_C */
7579
7580 const unsigned char *p = buf;
7581 const unsigned char * const end = buf + len;
7582
7583 /*
7584 * Time
7585 */
7586#if defined(MBEDTLS_HAVE_TIME)
7587 if( 8 > (size_t)( end - p ) )
7588 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7589
7590 start = ( (uint64_t) p[0] << 56 ) |
7591 ( (uint64_t) p[1] << 48 ) |
7592 ( (uint64_t) p[2] << 40 ) |
7593 ( (uint64_t) p[3] << 32 ) |
7594 ( (uint64_t) p[4] << 24 ) |
7595 ( (uint64_t) p[5] << 16 ) |
7596 ( (uint64_t) p[6] << 8 ) |
7597 ( (uint64_t) p[7] );
7598 p += 8;
7599
7600 session->start = (time_t) start;
7601#endif /* MBEDTLS_HAVE_TIME */
7602
7603 /*
7604 * Basic mandatory fields
7605 */
7606 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7608
7609 session->ciphersuite = ( p[0] << 8 ) | p[1];
7610 p += 2;
7611
7612 session->compression = *p++;
7613
7614 session->id_len = *p++;
7615 memcpy( session->id, p, 32 );
7616 p += 32;
7617
7618 memcpy( session->master, p, 48 );
7619 p += 48;
7620
7621 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7622 ( (uint32_t) p[1] << 16 ) |
7623 ( (uint32_t) p[2] << 8 ) |
7624 ( (uint32_t) p[3] );
7625 p += 4;
7626
7627 /* Immediately clear invalid pointer values that have been read, in case
7628 * we exit early before we replaced them with valid ones. */
7629#if defined(MBEDTLS_X509_CRT_PARSE_C)
7630#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7631 session->peer_cert = NULL;
7632#else
7633 session->peer_cert_digest = NULL;
7634#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7635#endif /* MBEDTLS_X509_CRT_PARSE_C */
7636#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7637 session->ticket = NULL;
7638#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7639
7640 /*
7641 * Peer certificate
7642 */
7643#if defined(MBEDTLS_X509_CRT_PARSE_C)
7644#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7645 /* Deserialize CRT from the end of the ticket. */
7646 if( 3 > (size_t)( end - p ) )
7647 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7648
7649 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7650 p += 3;
7651
7652 if( cert_len != 0 )
7653 {
7654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7655
7656 if( cert_len > (size_t)( end - p ) )
7657 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7658
7659 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7660
7661 if( session->peer_cert == NULL )
7662 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7663
7664 mbedtls_x509_crt_init( session->peer_cert );
7665
7666 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7667 p, cert_len ) ) != 0 )
7668 {
7669 mbedtls_x509_crt_free( session->peer_cert );
7670 mbedtls_free( session->peer_cert );
7671 session->peer_cert = NULL;
7672 return( ret );
7673 }
7674
7675 p += cert_len;
7676 }
7677#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7678 /* Deserialize CRT digest from the end of the ticket. */
7679 if( 2 > (size_t)( end - p ) )
7680 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7681
7682 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7683 session->peer_cert_digest_len = (size_t) *p++;
7684
7685 if( session->peer_cert_digest_len != 0 )
7686 {
7687 const mbedtls_md_info_t *md_info =
7688 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7689 if( md_info == NULL )
7690 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7691 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7692 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7693
7694 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7695 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7696
7697 session->peer_cert_digest =
7698 mbedtls_calloc( 1, session->peer_cert_digest_len );
7699 if( session->peer_cert_digest == NULL )
7700 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7701
7702 memcpy( session->peer_cert_digest, p,
7703 session->peer_cert_digest_len );
7704 p += session->peer_cert_digest_len;
7705 }
7706#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7707#endif /* MBEDTLS_X509_CRT_PARSE_C */
7708
7709 /*
7710 * Session ticket and associated data
7711 */
7712#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7713 if( 3 > (size_t)( end - p ) )
7714 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7715
7716 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7717 p += 3;
7718
7719 if( session->ticket_len != 0 )
7720 {
7721 if( session->ticket_len > (size_t)( end - p ) )
7722 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7723
7724 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7725 if( session->ticket == NULL )
7726 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7727
7728 memcpy( session->ticket, p, session->ticket_len );
7729 p += session->ticket_len;
7730 }
7731
7732 if( 4 > (size_t)( end - p ) )
7733 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7734
7735 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7736 ( (uint32_t) p[1] << 16 ) |
7737 ( (uint32_t) p[2] << 8 ) |
7738 ( (uint32_t) p[3] );
7739 p += 4;
7740#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7741
7742 /*
7743 * Misc extension-related info
7744 */
7745#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7746 if( 1 > (size_t)( end - p ) )
7747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7748
7749 session->mfl_code = *p++;
7750#endif
7751
7752#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7753 if( 1 > (size_t)( end - p ) )
7754 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7755
7756 session->encrypt_then_mac = *p++;
7757#endif
7758
7759 /* Done, should have consumed entire buffer */
7760 if( p != end )
7761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7762
7763 return( 0 );
7764}
Jerry Yudc7bd172022-02-17 13:44:15 +08007765#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007767#endif /* MBEDTLS_SSL_TLS_C */