blob: 4f1bac67dfa881f31772c6281d9385f52a3f01c7 [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 {
915 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jerry Yu60835a82021-08-04 10:13:52 +0800916 {
Ronald Cron086ee0b2022-03-15 15:18:51 +0100917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
Jerry Yu60835a82021-08-04 10:13:52 +0800918 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
919 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200920
921 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
922 {
923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
924 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
925 }
926
Jerry Yu60835a82021-08-04 10:13:52 +0800927 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
928 return( 0 );
929 }
930#endif
931
932#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100933 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800934 {
935 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
936 return( 0 );
937 }
938#endif
939
Ronald Cron6f135e12021-12-08 16:57:54 +0100940#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100941 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800942 {
Ronald Crone1d3f062022-02-10 14:50:54 +0100943 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
944 {
945 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
946 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
947 }
Ronald Cron37bdaab2022-03-30 16:45:51 +0200948
949 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
950 {
951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
952 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
953 }
954
Ronald Crone1d3f062022-02-10 14:50:54 +0100955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
956 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800957 }
958#endif
959
960 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
961 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
962}
963
964static int ssl_conf_check(const mbedtls_ssl_context *ssl)
965{
966 int ret;
967 ret = ssl_conf_version_check( ssl );
968 if( ret != 0 )
969 return( ret );
970
971 /* Space for further checks */
972
973 return( 0 );
974}
975
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200976/*
977 * Setup an SSL context
978 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100979
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200980int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200981 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +0000982{
Janos Follath865b3eb2019-12-16 11:46:15 +0000983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +0000984 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
985 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +0000986
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200987 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +0000988
Jerry Yu60835a82021-08-04 10:13:52 +0800989 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
990 return( ret );
991
Paul Bakker62f2dee2012-09-28 07:31:51 +0000992 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +0100993 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +0000994 */
k-stachowiakc9a5f022018-07-24 13:53:31 +0200995
996 /* Set to NULL in case of an error condition */
997 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +0200998
Darryl Greenb33cc762019-11-28 14:29:44 +0000999#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1000 ssl->in_buf_len = in_buf_len;
1001#endif
1002 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001003 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001006 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001007 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001008 }
1009
Darryl Greenb33cc762019-11-28 14:29:44 +00001010#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1011 ssl->out_buf_len = out_buf_len;
1012#endif
1013 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001014 if( ssl->out_buf == NULL )
1015 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001016 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001017 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001018 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001019 }
1020
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001021 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001022
Johan Pascalb62bb512015-12-03 21:56:45 +01001023#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001024 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001025#endif
1026
Paul Bakker48916f92012-09-16 19:57:18 +00001027 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001028 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001029
1030 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001031
1032error:
1033 mbedtls_free( ssl->in_buf );
1034 mbedtls_free( ssl->out_buf );
1035
1036 ssl->conf = NULL;
1037
Darryl Greenb33cc762019-11-28 14:29:44 +00001038#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1039 ssl->in_buf_len = 0;
1040 ssl->out_buf_len = 0;
1041#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001042 ssl->in_buf = NULL;
1043 ssl->out_buf = NULL;
1044
1045 ssl->in_hdr = NULL;
1046 ssl->in_ctr = NULL;
1047 ssl->in_len = NULL;
1048 ssl->in_iv = NULL;
1049 ssl->in_msg = NULL;
1050
1051 ssl->out_hdr = NULL;
1052 ssl->out_ctr = NULL;
1053 ssl->out_len = NULL;
1054 ssl->out_iv = NULL;
1055 ssl->out_msg = NULL;
1056
k-stachowiak9f7798e2018-07-31 16:52:32 +02001057 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001058}
1059
1060/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001061 * Reset an initialized and used SSL context for re-use while retaining
1062 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001063 *
1064 * If partial is non-zero, keep data in the input buffer and client ID.
1065 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001066 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001067void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1068 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001069{
Darryl Greenb33cc762019-11-28 14:29:44 +00001070#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1071 size_t in_buf_len = ssl->in_buf_len;
1072 size_t out_buf_len = ssl->out_buf_len;
1073#else
1074 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1075 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Hanno Beckerb0302c42021-08-03 09:39:42 +01001078#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1079 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001080#endif
1081
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001082 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001083 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001084
Hanno Beckerb0302c42021-08-03 09:39:42 +01001085 mbedtls_ssl_reset_in_out_pointers( ssl );
1086
1087 /* Reset incoming message parsing */
1088 ssl->in_offt = NULL;
1089 ssl->nb_zero = 0;
1090 ssl->in_msgtype = 0;
1091 ssl->in_msglen = 0;
1092 ssl->in_hslen = 0;
1093 ssl->keep_current_message = 0;
1094 ssl->transform_in = NULL;
1095
1096#if defined(MBEDTLS_SSL_PROTO_DTLS)
1097 ssl->next_record_offset = 0;
1098 ssl->in_epoch = 0;
1099#endif
1100
1101 /* Keep current datagram if partial == 1 */
1102 if( partial == 0 )
1103 {
1104 ssl->in_left = 0;
1105 memset( ssl->in_buf, 0, in_buf_len );
1106 }
1107
1108 /* Reset outgoing message writing */
1109 ssl->out_msgtype = 0;
1110 ssl->out_msglen = 0;
1111 ssl->out_left = 0;
1112 memset( ssl->out_buf, 0, out_buf_len );
1113 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1114 ssl->transform_out = NULL;
1115
1116#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1117 mbedtls_ssl_dtls_replay_reset( ssl );
1118#endif
1119
XiaokangQian2b01dc32022-01-21 02:53:13 +00001120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001121 if( ssl->transform )
1122 {
1123 mbedtls_ssl_transform_free( ssl->transform );
1124 mbedtls_free( ssl->transform );
1125 ssl->transform = NULL;
1126 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1128
XiaokangQian2b01dc32022-01-21 02:53:13 +00001129#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1130 mbedtls_ssl_transform_free( ssl->transform_application );
1131 mbedtls_free( ssl->transform_application );
1132 ssl->transform_application = NULL;
1133
1134 if( ssl->handshake != NULL )
1135 {
1136 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1137 mbedtls_free( ssl->handshake->transform_earlydata );
1138 ssl->handshake->transform_earlydata = NULL;
1139
1140 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1141 mbedtls_free( ssl->handshake->transform_handshake );
1142 ssl->handshake->transform_handshake = NULL;
1143 }
1144
XiaokangQian2b01dc32022-01-21 02:53:13 +00001145#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001146}
1147
1148int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1149{
1150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1151
1152 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1153
XiaokangQian78b1fa72022-01-19 06:56:30 +00001154 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001155
1156 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157#if defined(MBEDTLS_SSL_RENEGOTIATION)
1158 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001159 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001160
1161 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1163 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001164#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001166
Hanno Beckerb0302c42021-08-03 09:39:42 +01001167 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001168 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001169 if( ssl->session )
1170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 mbedtls_ssl_session_free( ssl->session );
1172 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001173 ssl->session = NULL;
1174 }
1175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001177 ssl->alpn_chosen = NULL;
1178#endif
1179
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001180#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001181#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001182 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001183#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001184 {
1185 mbedtls_free( ssl->cli_id );
1186 ssl->cli_id = NULL;
1187 ssl->cli_id_len = 0;
1188 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001189#endif
1190
Paul Bakker48916f92012-09-16 19:57:18 +00001191 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1192 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001193
1194 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001195}
1196
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001197/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001198 * Reset an initialized and used SSL context for re-use while retaining
1199 * all application-set variables, function pointers and data.
1200 */
1201int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1202{
Hanno Becker43aefe22020-02-05 10:44:56 +00001203 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001204}
1205
1206/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001207 * SSL set accessors
1208 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001209void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001210{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001212}
1213
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001214void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001215{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001216 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001217}
1218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001220void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001222 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001223}
1224#endif
1225
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001226void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001227{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001228 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001229}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001232
Hanno Becker1841b0a2018-08-24 11:13:57 +01001233void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1234 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001235{
1236 ssl->disable_datagram_packing = !allow_packing;
1237}
1238
1239void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1240 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001241{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001242 conf->hs_timeout_min = min;
1243 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001244}
1245#endif
1246
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001247void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001248{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001249 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001250}
1251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001253void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001254 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001255 void *p_vrfy )
1256{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001257 conf->f_vrfy = f_vrfy;
1258 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001259}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001261
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001262void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001263 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001264 void *p_rng )
1265{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001266 conf->f_rng = f_rng;
1267 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001268}
1269
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001270void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001271 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001272 void *p_dbg )
1273{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001274 conf->f_dbg = f_dbg;
1275 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001276}
1277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001279 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001280 mbedtls_ssl_send_t *f_send,
1281 mbedtls_ssl_recv_t *f_recv,
1282 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001283{
1284 ssl->p_bio = p_bio;
1285 ssl->f_send = f_send;
1286 ssl->f_recv = f_recv;
1287 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001288}
1289
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001290#if defined(MBEDTLS_SSL_PROTO_DTLS)
1291void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1292{
1293 ssl->mtu = mtu;
1294}
1295#endif
1296
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001297void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001298{
1299 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001300}
1301
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001302void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1303 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_set_timer_t *f_set_timer,
1305 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001306{
1307 ssl->p_timer = p_timer;
1308 ssl->f_set_timer = f_set_timer;
1309 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001310
1311 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001312 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001313}
1314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001316void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001317 void *p_cache,
1318 mbedtls_ssl_cache_get_t *f_get_cache,
1319 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001320{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001321 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001322 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001323 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001324}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327#if defined(MBEDTLS_SSL_CLI_C)
1328int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001329{
Janos Follath865b3eb2019-12-16 11:46:15 +00001330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001331
1332 if( ssl == NULL ||
1333 session == NULL ||
1334 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001335 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001338 }
1339
Hanno Beckere810bbc2021-05-14 16:01:05 +01001340 if( ssl->handshake->resume == 1 )
1341 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1342
Hanno Becker52055ae2019-02-06 14:30:46 +00001343 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1344 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001345 return( ret );
1346
Paul Bakker0a597072012-09-25 21:55:46 +00001347 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001348
1349 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001350}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001352
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001353void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1354 const int *ciphersuites )
1355{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001356 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001357}
1358
Ronald Cron6f135e12021-12-08 16:57:54 +01001359#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001360void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001361 const int kex_modes )
1362{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001363 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001364}
Ronald Cron6f135e12021-12-08 16:57:54 +01001365#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001368void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001369 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001370{
1371 conf->cert_profile = profile;
1372}
1373
Glenn Strauss36872db2022-01-22 05:06:31 -05001374static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1375{
1376 mbedtls_ssl_key_cert *cur = key_cert, *next;
1377
1378 while( cur != NULL )
1379 {
1380 next = cur->next;
1381 mbedtls_free( cur );
1382 cur = next;
1383 }
1384}
1385
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001386/* Append a new keycert entry to a (possibly empty) list */
1387static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1388 mbedtls_x509_crt *cert,
1389 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001390{
niisato8ee24222018-06-25 19:05:48 +09001391 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001392
Glenn Strauss36872db2022-01-22 05:06:31 -05001393 if( cert == NULL )
1394 {
1395 /* Free list if cert is null */
1396 ssl_key_cert_free( *head );
1397 *head = NULL;
1398 return( 0 );
1399 }
1400
niisato8ee24222018-06-25 19:05:48 +09001401 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1402 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001403 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001404
niisato8ee24222018-06-25 19:05:48 +09001405 new_cert->cert = cert;
1406 new_cert->key = key;
1407 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001408
Glenn Strauss36872db2022-01-22 05:06:31 -05001409 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001411 {
niisato8ee24222018-06-25 19:05:48 +09001412 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001413 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001414 else
1415 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001416 mbedtls_ssl_key_cert *cur = *head;
1417 while( cur->next != NULL )
1418 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001419 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001420 }
1421
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001422 return( 0 );
1423}
1424
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001425int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001426 mbedtls_x509_crt *own_cert,
1427 mbedtls_pk_context *pk_key )
1428{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001429 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001430}
1431
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001432void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001433 mbedtls_x509_crt *ca_chain,
1434 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001435{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001436 conf->ca_chain = ca_chain;
1437 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001438
1439#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1440 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1441 * cannot be used together. */
1442 conf->f_ca_cb = NULL;
1443 conf->p_ca_cb = NULL;
1444#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001445}
Hanno Becker5adaad92019-03-27 16:54:37 +00001446
1447#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1448void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001449 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001450 void *p_ca_cb )
1451{
1452 conf->f_ca_cb = f_ca_cb;
1453 conf->p_ca_cb = p_ca_cb;
1454
1455 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1456 * cannot be used together. */
1457 conf->ca_chain = NULL;
1458 conf->ca_crl = NULL;
1459}
1460#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001462
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001463#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001464const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1465 size_t *name_len )
1466{
1467 *name_len = ssl->handshake->sni_name_len;
1468 return( ssl->handshake->sni_name );
1469}
1470
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001471int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1472 mbedtls_x509_crt *own_cert,
1473 mbedtls_pk_context *pk_key )
1474{
1475 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1476 own_cert, pk_key ) );
1477}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001478
1479void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1480 mbedtls_x509_crt *ca_chain,
1481 mbedtls_x509_crl *ca_crl )
1482{
1483 ssl->handshake->sni_ca_chain = ca_chain;
1484 ssl->handshake->sni_ca_crl = ca_crl;
1485}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001486
1487void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1488 int authmode )
1489{
1490 ssl->handshake->sni_authmode = authmode;
1491}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001492#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1493
Hanno Becker8927c832019-04-03 12:52:50 +01001494#if defined(MBEDTLS_X509_CRT_PARSE_C)
1495void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1496 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1497 void *p_vrfy )
1498{
1499 ssl->f_vrfy = f_vrfy;
1500 ssl->p_vrfy = p_vrfy;
1501}
1502#endif
1503
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001504#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001505/*
1506 * Set EC J-PAKE password for current handshake
1507 */
1508int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1509 const unsigned char *pw,
1510 size_t pw_len )
1511{
1512 mbedtls_ecjpake_role role;
1513
Janos Follath8eb64132016-06-03 15:40:57 +01001514 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001515 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1516
1517 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1518 role = MBEDTLS_ECJPAKE_SERVER;
1519 else
1520 role = MBEDTLS_ECJPAKE_CLIENT;
1521
1522 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1523 role,
1524 MBEDTLS_MD_SHA256,
1525 MBEDTLS_ECP_DP_SECP256R1,
1526 pw, pw_len ) );
1527}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001528#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001529
Gilles Peskineeccd8882020-03-10 12:19:08 +01001530#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001531
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001532static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1533{
1534#if defined(MBEDTLS_USE_PSA_CRYPTO)
1535 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1536 return( 1 );
1537#endif /* MBEDTLS_USE_PSA_CRYPTO */
1538
1539 if( conf->psk != NULL )
1540 return( 1 );
1541
1542 return( 0 );
1543}
1544
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001545static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1546{
1547 /* Remove reference to existing PSK, if any. */
1548#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001549 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001550 {
1551 /* The maintenance of the PSK key slot is the
1552 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001553 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001554 }
Hanno Beckera63ac3f2018-11-05 12:47:16 +00001555 /* This and the following branch should never
1556 * be taken simultaenously as we maintain the
1557 * invariant that raw and opaque PSKs are never
1558 * configured simultaneously. As a safeguard,
1559 * though, `else` is omitted here. */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001560#endif /* MBEDTLS_USE_PSA_CRYPTO */
1561 if( conf->psk != NULL )
1562 {
1563 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1564
1565 mbedtls_free( conf->psk );
1566 conf->psk = NULL;
1567 conf->psk_len = 0;
1568 }
1569
1570 /* Remove reference to PSK identity, if any. */
1571 if( conf->psk_identity != NULL )
1572 {
1573 mbedtls_free( conf->psk_identity );
1574 conf->psk_identity = NULL;
1575 conf->psk_identity_len = 0;
1576 }
1577}
1578
Hanno Becker7390c712018-11-15 13:33:04 +00001579/* This function assumes that PSK identity in the SSL config is unset.
1580 * It checks that the provided identity is well-formed and attempts
1581 * to make a copy of it in the SSL config.
1582 * On failure, the PSK identity in the config remains unset. */
1583static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1584 unsigned char const *psk_identity,
1585 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001586{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001587 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001588 if( psk_identity == NULL ||
1589 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001590 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001591 {
1592 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1593 }
1594
Hanno Becker7390c712018-11-15 13:33:04 +00001595 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1596 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001597 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001598
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001599 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001600 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001601
1602 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001603}
1604
Hanno Becker7390c712018-11-15 13:33:04 +00001605int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1606 const unsigned char *psk, size_t psk_len,
1607 const unsigned char *psk_identity, size_t psk_identity_len )
1608{
Janos Follath865b3eb2019-12-16 11:46:15 +00001609 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001610
1611 /* We currently only support one PSK, raw or opaque. */
1612 if( ssl_conf_psk_is_configured( conf ) )
1613 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001614
1615 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001616 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001617 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001618 if( psk_len == 0 )
1619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1620 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1622
Hanno Becker7390c712018-11-15 13:33:04 +00001623 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1624 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1625 conf->psk_len = psk_len;
1626 memcpy( conf->psk, psk, conf->psk_len );
1627
1628 /* Check and set PSK Identity */
1629 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1630 if( ret != 0 )
1631 ssl_conf_remove_psk( conf );
1632
1633 return( ret );
1634}
1635
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001636static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1637{
1638#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001639 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001640 {
Ronald Croncf56a0a2020-08-04 09:51:30 +02001641 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001642 }
1643 else
1644#endif /* MBEDTLS_USE_PSA_CRYPTO */
1645 if( ssl->handshake->psk != NULL )
1646 {
1647 mbedtls_platform_zeroize( ssl->handshake->psk,
1648 ssl->handshake->psk_len );
1649 mbedtls_free( ssl->handshake->psk );
1650 ssl->handshake->psk_len = 0;
1651 }
1652}
1653
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001654int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1655 const unsigned char *psk, size_t psk_len )
1656{
1657 if( psk == NULL || ssl->handshake == NULL )
1658 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1659
1660 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1661 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1662
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001663 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001664
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001665 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001666 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001667
1668 ssl->handshake->psk_len = psk_len;
1669 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1670
1671 return( 0 );
1672}
1673
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001674#if defined(MBEDTLS_USE_PSA_CRYPTO)
1675int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001676 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001677 const unsigned char *psk_identity,
1678 size_t psk_identity_len )
1679{
Janos Follath865b3eb2019-12-16 11:46:15 +00001680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001681
1682 /* We currently only support one PSK, raw or opaque. */
1683 if( ssl_conf_psk_is_configured( conf ) )
1684 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001685
Hanno Becker7390c712018-11-15 13:33:04 +00001686 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001687 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001688 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001689 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001690
1691 /* Check and set PSK Identity */
1692 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1693 psk_identity_len );
1694 if( ret != 0 )
1695 ssl_conf_remove_psk( conf );
1696
1697 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001698}
1699
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001700int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1701 mbedtls_svc_key_id_t psk )
1702{
1703 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1704 ( ssl->handshake == NULL ) )
1705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1706
1707 ssl_remove_psk( ssl );
1708 ssl->handshake->psk_opaque = psk;
1709 return( 0 );
1710}
1711#endif /* MBEDTLS_USE_PSA_CRYPTO */
1712
1713void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1714 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1715 size_t),
1716 void *p_psk )
1717{
1718 conf->f_psk = f_psk;
1719 conf->p_psk = p_psk;
1720}
1721#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1722
1723#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001724psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001725 size_t taglen,
1726 psa_algorithm_t *alg,
1727 psa_key_type_t *key_type,
1728 size_t *key_size )
1729{
1730 switch ( mbedtls_cipher_type )
1731 {
1732 case MBEDTLS_CIPHER_AES_128_CBC:
1733 *alg = PSA_ALG_CBC_NO_PADDING;
1734 *key_type = PSA_KEY_TYPE_AES;
1735 *key_size = 128;
1736 break;
1737 case MBEDTLS_CIPHER_AES_128_CCM:
1738 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1739 *key_type = PSA_KEY_TYPE_AES;
1740 *key_size = 128;
1741 break;
1742 case MBEDTLS_CIPHER_AES_128_GCM:
1743 *alg = PSA_ALG_GCM;
1744 *key_type = PSA_KEY_TYPE_AES;
1745 *key_size = 128;
1746 break;
1747 case MBEDTLS_CIPHER_AES_192_CCM:
1748 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1749 *key_type = PSA_KEY_TYPE_AES;
1750 *key_size = 192;
1751 break;
1752 case MBEDTLS_CIPHER_AES_192_GCM:
1753 *alg = PSA_ALG_GCM;
1754 *key_type = PSA_KEY_TYPE_AES;
1755 *key_size = 192;
1756 break;
1757 case MBEDTLS_CIPHER_AES_256_CBC:
1758 *alg = PSA_ALG_CBC_NO_PADDING;
1759 *key_type = PSA_KEY_TYPE_AES;
1760 *key_size = 256;
1761 break;
1762 case MBEDTLS_CIPHER_AES_256_CCM:
1763 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1764 *key_type = PSA_KEY_TYPE_AES;
1765 *key_size = 256;
1766 break;
1767 case MBEDTLS_CIPHER_AES_256_GCM:
1768 *alg = PSA_ALG_GCM;
1769 *key_type = PSA_KEY_TYPE_AES;
1770 *key_size = 256;
1771 break;
1772 case MBEDTLS_CIPHER_ARIA_128_CBC:
1773 *alg = PSA_ALG_CBC_NO_PADDING;
1774 *key_type = PSA_KEY_TYPE_ARIA;
1775 *key_size = 128;
1776 break;
1777 case MBEDTLS_CIPHER_ARIA_128_CCM:
1778 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1779 *key_type = PSA_KEY_TYPE_ARIA;
1780 *key_size = 128;
1781 break;
1782 case MBEDTLS_CIPHER_ARIA_128_GCM:
1783 *alg = PSA_ALG_GCM;
1784 *key_type = PSA_KEY_TYPE_ARIA;
1785 *key_size = 128;
1786 break;
1787 case MBEDTLS_CIPHER_ARIA_192_CCM:
1788 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1789 *key_type = PSA_KEY_TYPE_ARIA;
1790 *key_size = 192;
1791 break;
1792 case MBEDTLS_CIPHER_ARIA_192_GCM:
1793 *alg = PSA_ALG_GCM;
1794 *key_type = PSA_KEY_TYPE_ARIA;
1795 *key_size = 192;
1796 break;
1797 case MBEDTLS_CIPHER_ARIA_256_CBC:
1798 *alg = PSA_ALG_CBC_NO_PADDING;
1799 *key_type = PSA_KEY_TYPE_ARIA;
1800 *key_size = 256;
1801 break;
1802 case MBEDTLS_CIPHER_ARIA_256_CCM:
1803 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1804 *key_type = PSA_KEY_TYPE_ARIA;
1805 *key_size = 256;
1806 break;
1807 case MBEDTLS_CIPHER_ARIA_256_GCM:
1808 *alg = PSA_ALG_GCM;
1809 *key_type = PSA_KEY_TYPE_ARIA;
1810 *key_size = 256;
1811 break;
1812 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1813 *alg = PSA_ALG_CBC_NO_PADDING;
1814 *key_type = PSA_KEY_TYPE_CAMELLIA;
1815 *key_size = 128;
1816 break;
1817 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
1818 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1819 *key_type = PSA_KEY_TYPE_CAMELLIA;
1820 *key_size = 128;
1821 break;
1822 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
1823 *alg = PSA_ALG_GCM;
1824 *key_type = PSA_KEY_TYPE_CAMELLIA;
1825 *key_size = 128;
1826 break;
1827 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
1828 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1829 *key_type = PSA_KEY_TYPE_CAMELLIA;
1830 *key_size = 192;
1831 break;
1832 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
1833 *alg = PSA_ALG_GCM;
1834 *key_type = PSA_KEY_TYPE_CAMELLIA;
1835 *key_size = 192;
1836 break;
1837 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
1838 *alg = PSA_ALG_CBC_NO_PADDING;
1839 *key_type = PSA_KEY_TYPE_CAMELLIA;
1840 *key_size = 256;
1841 break;
1842 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
1843 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1844 *key_type = PSA_KEY_TYPE_CAMELLIA;
1845 *key_size = 256;
1846 break;
1847 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
1848 *alg = PSA_ALG_GCM;
1849 *key_type = PSA_KEY_TYPE_CAMELLIA;
1850 *key_size = 256;
1851 break;
1852 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
1853 *alg = PSA_ALG_CHACHA20_POLY1305;
1854 *key_type = PSA_KEY_TYPE_CHACHA20;
1855 *key_size = 256;
1856 break;
1857 case MBEDTLS_CIPHER_NULL:
1858 *alg = MBEDTLS_SSL_NULL_CIPHER;
1859 *key_type = 0;
1860 *key_size = 0;
1861 break;
1862 default:
1863 return PSA_ERROR_NOT_SUPPORTED;
1864 }
1865
1866 return PSA_SUCCESS;
1867}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001868#endif /* MBEDTLS_USE_PSA_CRYPTO */
1869
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001870#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01001871int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1872 const unsigned char *dhm_P, size_t P_len,
1873 const unsigned char *dhm_G, size_t G_len )
1874{
Janos Follath865b3eb2019-12-16 11:46:15 +00001875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01001876
Glenn Strausscee11292021-12-20 01:43:17 -05001877 mbedtls_mpi_free( &conf->dhm_P );
1878 mbedtls_mpi_free( &conf->dhm_G );
1879
Hanno Beckera90658f2017-10-04 15:29:08 +01001880 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
1881 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
1882 {
1883 mbedtls_mpi_free( &conf->dhm_P );
1884 mbedtls_mpi_free( &conf->dhm_G );
1885 return( ret );
1886 }
1887
1888 return( 0 );
1889}
Paul Bakker5121ce52009-01-03 21:22:43 +00001890
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001891int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00001892{
Janos Follath865b3eb2019-12-16 11:46:15 +00001893 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00001894
Glenn Strausscee11292021-12-20 01:43:17 -05001895 mbedtls_mpi_free( &conf->dhm_P );
1896 mbedtls_mpi_free( &conf->dhm_G );
1897
Gilles Peskinee5702482021-06-11 21:59:08 +02001898 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
1899 &conf->dhm_P ) ) != 0 ||
1900 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
1901 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001902 {
1903 mbedtls_mpi_free( &conf->dhm_P );
1904 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00001905 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001906 }
Paul Bakker1b57b062011-01-06 15:48:19 +00001907
1908 return( 0 );
1909}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001910#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00001911
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001912#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1913/*
1914 * Set the minimum length for Diffie-Hellman parameters
1915 */
1916void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1917 unsigned int bitlen )
1918{
1919 conf->dhm_min_bitlen = bitlen;
1920}
1921#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1922
Gilles Peskineeccd8882020-03-10 12:19:08 +01001923#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001924#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001925/*
1926 * Set allowed/preferred hashes for handshake signatures
1927 */
1928void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1929 const int *hashes )
1930{
1931 conf->sig_hashes = hashes;
1932}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001933#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001934
Jerry Yuf017ee42022-01-12 15:49:48 +08001935/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001936void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
1937 const uint16_t* sig_algs )
1938{
Jerry Yuf017ee42022-01-12 15:49:48 +08001939#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1940 conf->sig_hashes = NULL;
1941#endif /* !MBEDTLS_DEPRECATED_REMOVED */
1942 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01001943}
Gilles Peskineeccd8882020-03-10 12:19:08 +01001944#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001945
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001946#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001947#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001948/*
1949 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01001950 *
1951 * mbedtls_ssl_setup() takes the provided list
1952 * and translates it to a list of IANA TLS group identifiers,
1953 * stored in ssl->handshake->group_list.
1954 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001955 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001956void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001957 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001958{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001959 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01001960 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001961}
Brett Warrene0edc842021-08-17 09:53:13 +01001962#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01001963#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01001964
Brett Warrene0edc842021-08-17 09:53:13 +01001965/*
1966 * Set the allowed groups
1967 */
1968void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
1969 const uint16_t *group_list )
1970{
1971#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
1972 conf->curve_list = NULL;
1973#endif
1974 conf->group_list = group_list;
1975}
1976
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001977#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00001979{
Hanno Becker947194e2017-04-07 13:25:49 +01001980 /* Initialize to suppress unnecessary compiler warning */
1981 size_t hostname_len = 0;
1982
1983 /* Check if new hostname is valid before
1984 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01001985 if( hostname != NULL )
1986 {
1987 hostname_len = strlen( hostname );
1988
1989 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
1990 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1991 }
1992
1993 /* Now it's clear that we will overwrite the old hostname,
1994 * so we can free it safely */
1995
1996 if( ssl->hostname != NULL )
1997 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05001998 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01001999 mbedtls_free( ssl->hostname );
2000 }
2001
2002 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002003
Paul Bakker5121ce52009-01-03 21:22:43 +00002004 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002005 {
2006 ssl->hostname = NULL;
2007 }
2008 else
2009 {
2010 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002011 if( ssl->hostname == NULL )
2012 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002013
Hanno Becker947194e2017-04-07 13:25:49 +01002014 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002015
Hanno Becker947194e2017-04-07 13:25:49 +01002016 ssl->hostname[hostname_len] = '\0';
2017 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002018
2019 return( 0 );
2020}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002021#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002022
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002023#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002024void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002026 const unsigned char *, size_t),
2027 void *p_sni )
2028{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002029 conf->f_sni = f_sni;
2030 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002031}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002035int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002036{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002037 size_t cur_len, tot_len;
2038 const char **p;
2039
2040 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002041 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2042 * MUST NOT be truncated."
2043 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002044 */
2045 tot_len = 0;
2046 for( p = protos; *p != NULL; p++ )
2047 {
2048 cur_len = strlen( *p );
2049 tot_len += cur_len;
2050
Ronald Cron8216dd32020-04-23 16:41:44 +02002051 if( ( cur_len == 0 ) ||
2052 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2053 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002055 }
2056
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002057 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002058
2059 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002060}
2061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002063{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002064 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002065}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002067
Johan Pascalb62bb512015-12-03 21:56:45 +01002068#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002069void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2070 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002071{
2072 conf->dtls_srtp_mki_support = support_mki_value;
2073}
2074
Ron Eldoref72faf2018-07-12 11:54:20 +03002075int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2076 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002077 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002078{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002079 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002080 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002081 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002082 }
Ron Eldor591f1622018-01-22 12:30:04 +02002083
2084 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002085 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002086 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002087 }
Ron Eldor591f1622018-01-22 12:30:04 +02002088
2089 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2090 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002091 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002092}
2093
Ron Eldoref72faf2018-07-12 11:54:20 +03002094int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002095 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002096{
Johan Pascal253d0262020-09-22 13:04:45 +02002097 const mbedtls_ssl_srtp_profile *p;
2098 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002099
Johan Pascal253d0262020-09-22 13:04:45 +02002100 /* check the profiles list: all entry must be valid,
2101 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002102 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2103 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2104 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002105 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002106 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002107 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002108 list_size++;
2109 }
2110 else
2111 {
2112 /* unsupported value, stop parsing and set the size to an error value */
2113 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002114 }
2115 }
2116
Johan Pascal5ef72d22020-10-28 17:05:47 +01002117 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002118 {
Johan Pascal253d0262020-09-22 13:04:45 +02002119 conf->dtls_srtp_profile_list = NULL;
2120 conf->dtls_srtp_profile_list_len = 0;
2121 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2122 }
2123
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002124 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002125 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002126
2127 return( 0 );
2128}
2129
Johan Pascal5ef72d22020-10-28 17:05:47 +01002130void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2131 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002132{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002133 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2134 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002135 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002136 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002137 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002138 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002139 else
2140 {
2141 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002142 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2143 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002144 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002145}
Johan Pascalb62bb512015-12-03 21:56:45 +01002146#endif /* MBEDTLS_SSL_DTLS_SRTP */
2147
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002148void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002149{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002150 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002151}
2152
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002153void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002154{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002155 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002156}
2157
Janos Follath088ce432017-04-10 12:42:31 +01002158#if defined(MBEDTLS_SSL_SRV_C)
2159void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2160 char cert_req_ca_list )
2161{
2162 conf->cert_req_ca_list = cert_req_ca_list;
2163}
2164#endif
2165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002167void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002168{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002169 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002170}
2171#endif
2172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002174void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002175{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002176 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002177}
2178#endif
2179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002181int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002182{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002184 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002187 }
2188
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002189 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002190
2191 return( 0 );
2192}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002194
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002195void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002196{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002197 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002198}
2199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002201void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002202{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002203 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002204}
2205
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002206void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002207{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002208 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002209}
2210
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002211void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002212 const unsigned char period[8] )
2213{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002214 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002215}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002219#if defined(MBEDTLS_SSL_CLI_C)
2220void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002221{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002222 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002223}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002224#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002225
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002226#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002227void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2228 mbedtls_ssl_ticket_write_t *f_ticket_write,
2229 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2230 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002231{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002232 conf->f_ticket_write = f_ticket_write;
2233 conf->f_ticket_parse = f_ticket_parse;
2234 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002235}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002236#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002238
Hanno Becker7e6c1782021-06-08 09:24:55 +01002239void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2240 mbedtls_ssl_export_keys_t *f_export_keys,
2241 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002242{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002243 ssl->f_export_keys = f_export_keys;
2244 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002245}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002246
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002247#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002248void mbedtls_ssl_conf_async_private_cb(
2249 mbedtls_ssl_config *conf,
2250 mbedtls_ssl_async_sign_t *f_async_sign,
2251 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2252 mbedtls_ssl_async_resume_t *f_async_resume,
2253 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002254 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002255{
2256 conf->f_async_sign_start = f_async_sign;
2257 conf->f_async_decrypt_start = f_async_decrypt;
2258 conf->f_async_resume = f_async_resume;
2259 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002260 conf->p_async_config_data = async_config_data;
2261}
2262
Gilles Peskine8f97af72018-04-26 11:46:10 +02002263void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2264{
2265 return( conf->p_async_config_data );
2266}
2267
Gilles Peskine1febfef2018-04-30 11:54:39 +02002268void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002269{
2270 if( ssl->handshake == NULL )
2271 return( NULL );
2272 else
2273 return( ssl->handshake->user_async_ctx );
2274}
2275
Gilles Peskine1febfef2018-04-30 11:54:39 +02002276void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002277 void *ctx )
2278{
2279 if( ssl->handshake != NULL )
2280 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002281}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002282#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002283
Paul Bakker5121ce52009-01-03 21:22:43 +00002284/*
2285 * SSL get accessors
2286 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002287uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002288{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002289 if( ssl->session != NULL )
2290 return( ssl->session->verify_result );
2291
2292 if( ssl->session_negotiate != NULL )
2293 return( ssl->session_negotiate->verify_result );
2294
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002295 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002296}
2297
Glenn Strauss8f526902022-01-13 00:04:49 -05002298int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2299{
2300 if( ssl == NULL || ssl->session == NULL )
2301 return( 0 );
2302
2303 return( ssl->session->ciphersuite );
2304}
2305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002307{
Paul Bakker926c8e42013-03-06 10:23:34 +01002308 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002309 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002312}
2313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002315{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002317 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002318 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002319 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002320 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002321 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002322 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002323 default:
2324 return( "unknown (DTLS)" );
2325 }
2326 }
2327#endif
2328
Glenn Strauss60bfe602022-03-14 19:04:24 -04002329 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002330 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002331 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002332 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002333 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002334 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002335 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002336 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002337 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002338}
2339
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002340#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002341size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2342{
David Horstmann95d516f2021-05-04 18:36:56 +01002343 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002344 size_t read_mfl;
2345
2346 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2347 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2348 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2349 {
2350 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2351 }
2352
2353 /* Check if a smaller max length was negotiated */
2354 if( ssl->session_out != NULL )
2355 {
2356 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2357 if( read_mfl < max_len )
2358 {
2359 max_len = read_mfl;
2360 }
2361 }
2362
2363 // During a handshake, use the value being negotiated
2364 if( ssl->session_negotiate != NULL )
2365 {
2366 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2367 if( read_mfl < max_len )
2368 {
2369 max_len = read_mfl;
2370 }
2371 }
2372
2373 return( max_len );
2374}
2375
2376size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002377{
2378 size_t max_len;
2379
2380 /*
2381 * Assume mfl_code is correct since it was checked when set
2382 */
Angus Grattond8213d02016-05-25 20:56:48 +10002383 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002384
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002385 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002386 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002387 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002388 {
Angus Grattond8213d02016-05-25 20:56:48 +10002389 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002390 }
2391
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002392 /* During a handshake, use the value being negotiated */
2393 if( ssl->session_negotiate != NULL &&
2394 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2395 {
2396 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2397 }
2398
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002399 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002400}
2401#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2402
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002403#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002404size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002405{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002406 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2407 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2408 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2409 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2410 return ( 0 );
2411
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002412 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2413 return( ssl->mtu );
2414
2415 if( ssl->mtu == 0 )
2416 return( ssl->handshake->mtu );
2417
2418 return( ssl->mtu < ssl->handshake->mtu ?
2419 ssl->mtu : ssl->handshake->mtu );
2420}
2421#endif /* MBEDTLS_SSL_PROTO_DTLS */
2422
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002423int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2424{
2425 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2426
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002427#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2428 !defined(MBEDTLS_SSL_PROTO_DTLS)
2429 (void) ssl;
2430#endif
2431
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002432#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002433 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002434
2435 if( max_len > mfl )
2436 max_len = mfl;
2437#endif
2438
2439#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002440 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002441 {
Hanno Becker89490712020-02-05 10:50:12 +00002442 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002443 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2444 const size_t overhead = (size_t) ret;
2445
2446 if( ret < 0 )
2447 return( ret );
2448
2449 if( mtu <= overhead )
2450 {
2451 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2452 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2453 }
2454
2455 if( max_len > mtu - overhead )
2456 max_len = mtu - overhead;
2457 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002458#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002459
Hanno Becker0defedb2018-08-10 12:35:02 +01002460#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2461 !defined(MBEDTLS_SSL_PROTO_DTLS)
2462 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002463#endif
2464
2465 return( (int) max_len );
2466}
2467
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002468int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2469{
2470 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2471
2472#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2473 (void) ssl;
2474#endif
2475
2476#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2477 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2478
2479 if( max_len > mfl )
2480 max_len = mfl;
2481#endif
2482
2483 return( (int) max_len );
2484}
2485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#if defined(MBEDTLS_X509_CRT_PARSE_C)
2487const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002488{
2489 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002490 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002491
Hanno Beckere6824572019-02-07 13:18:46 +00002492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002493 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002494#else
2495 return( NULL );
2496#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002497}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002501int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2502 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002503{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002504 int ret;
2505
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002506 if( ssl == NULL ||
2507 dst == NULL ||
2508 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002509 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002512 }
2513
Hanno Beckere810bbc2021-05-14 16:01:05 +01002514 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2515 * idempotent: Each session can only be exported once.
2516 *
2517 * (This is in preparation for TLS 1.3 support where we will
2518 * need the ability to export multiple sessions (aka tickets),
2519 * which will be achieved by calling mbedtls_ssl_get_session()
2520 * multiple times until it fails.)
2521 *
2522 * Check whether we have already exported the current session,
2523 * and fail if so.
2524 */
2525 if( ssl->session->exported == 1 )
2526 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2527
2528 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2529 if( ret != 0 )
2530 return( ret );
2531
2532 /* Remember that we've exported the session. */
2533 ssl->session->exported = 1;
2534 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002535}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002537
Paul Bakker5121ce52009-01-03 21:22:43 +00002538/*
Hanno Beckera835da52019-05-16 12:39:07 +01002539 * Define ticket header determining Mbed TLS version
2540 * and structure of the ticket.
2541 */
2542
Hanno Becker94ef3b32019-05-16 12:50:45 +01002543/*
Hanno Becker50b59662019-05-28 14:30:45 +01002544 * Define bitflag determining compile-time settings influencing
2545 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002546 */
2547
Hanno Becker50b59662019-05-28 14:30:45 +01002548#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002549#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002550#else
Hanno Becker3e088662019-05-29 11:10:18 +01002551#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002552#endif /* MBEDTLS_HAVE_TIME */
2553
2554#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002555#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002556#else
Hanno Becker3e088662019-05-29 11:10:18 +01002557#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002558#endif /* MBEDTLS_X509_CRT_PARSE_C */
2559
2560#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002561#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002562#else
Hanno Becker3e088662019-05-29 11:10:18 +01002563#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002564#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2565
2566#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002567#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002568#else
Hanno Becker3e088662019-05-29 11:10:18 +01002569#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002570#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2571
Hanno Becker94ef3b32019-05-16 12:50:45 +01002572#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002573#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002574#else
Hanno Becker3e088662019-05-29 11:10:18 +01002575#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002576#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2577
Hanno Becker94ef3b32019-05-16 12:50:45 +01002578#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2579#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2580#else
2581#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2582#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2583
Hanno Becker3e088662019-05-29 11:10:18 +01002584#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2585#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2586#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2587#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002588#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2589#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002590
Hanno Becker50b59662019-05-28 14:30:45 +01002591#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002592 ( (uint16_t) ( \
2593 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2594 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2595 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2596 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002597 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002598 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002599
Hanno Beckerf8787072019-05-16 12:41:07 +01002600static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002601 MBEDTLS_VERSION_MAJOR,
2602 MBEDTLS_VERSION_MINOR,
2603 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002604 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2605 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002606};
Hanno Beckera835da52019-05-16 12:39:07 +01002607
2608/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002609 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002610 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002611 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002612 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002613 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002614 * opaque mbedtls_version[3]; // library version: major, minor, patch
2615 * opaque session_format[2]; // library-version specific 16-bit field
2616 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002617 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002618 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002619 * Note: When updating the format, remember to keep
2620 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002621 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002622 * // In this version, `session_format` determines
2623 * // the setting of those compile-time
2624 * // configuration options which influence
2625 * // the structure of mbedtls_ssl_session.
2626 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002627 * uint8_t minor_ver; // Protocol minor version. Possible values:
2628 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002629 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002630 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002631 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002632 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002633 * serialized_session_tls12 data;
2634 *
2635 * };
2636 *
2637 * } serialized_session;
2638 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002639 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002640
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002641static int ssl_session_save( const mbedtls_ssl_session *session,
2642 unsigned char omit_header,
2643 unsigned char *buf,
2644 size_t buf_len,
2645 size_t *olen )
2646{
2647 unsigned char *p = buf;
2648 size_t used = 0;
2649
2650 if( !omit_header )
2651 {
2652 /*
2653 * Add Mbed TLS version identifier
2654 */
2655
2656 used += sizeof( ssl_serialized_session_header );
2657
2658 if( used <= buf_len )
2659 {
2660 memcpy( p, ssl_serialized_session_header,
2661 sizeof( ssl_serialized_session_header ) );
2662 p += sizeof( ssl_serialized_session_header );
2663 }
2664 }
2665
2666 /*
2667 * TLS version identifier
2668 */
2669 used += 1;
2670 if( used <= buf_len )
2671 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002672 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002673 }
2674
2675 /* Forward to version-specific serialization routine. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002676 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002677 {
2678#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002679 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002680 {
2681 size_t remaining_len = used <= buf_len ? buf_len - used : 0;
2682 used += ssl_session_save_tls12( session, p, remaining_len );
2683 break;
2684 }
2685#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2686
2687 default:
2688 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2689 }
2690
2691 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002692 if( used > buf_len )
2693 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002694
2695 return( 0 );
2696}
2697
2698/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002699 * Public wrapper for ssl_session_save()
2700 */
2701int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2702 unsigned char *buf,
2703 size_t buf_len,
2704 size_t *olen )
2705{
2706 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2707}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002708
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002709/*
2710 * Deserialize session, see mbedtls_ssl_session_save() for format.
2711 *
2712 * This internal version is wrapped by a public function that cleans up in
2713 * case of error, and has an extra option omit_header.
2714 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002715static int ssl_session_load( mbedtls_ssl_session *session,
2716 unsigned char omit_header,
2717 const unsigned char *buf,
2718 size_t len )
2719{
2720 const unsigned char *p = buf;
2721 const unsigned char * const end = buf + len;
2722
2723 if( !omit_header )
2724 {
2725 /*
2726 * Check Mbed TLS version identifier
2727 */
2728
2729 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2730 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2731
2732 if( memcmp( p, ssl_serialized_session_header,
2733 sizeof( ssl_serialized_session_header ) ) != 0 )
2734 {
2735 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2736 }
2737 p += sizeof( ssl_serialized_session_header );
2738 }
2739
2740 /*
2741 * TLS version identifier
2742 */
2743 if( 1 > (size_t)( end - p ) )
2744 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002745 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002746
2747 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002748 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002749 {
2750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002751 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002752 {
2753 size_t remaining_len = ( end - p );
2754 return( ssl_session_load_tls12( session, p, remaining_len ) );
2755 }
2756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2757
2758 default:
2759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2760 }
2761}
2762
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002763/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002764 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002765 */
2766int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2767 const unsigned char *buf,
2768 size_t len )
2769{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002770 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002771
2772 if( ret != 0 )
2773 mbedtls_ssl_session_free( session );
2774
2775 return( ret );
2776}
2777
2778/*
Paul Bakker1961b702013-01-25 14:49:24 +01002779 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002780 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002781static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2782{
2783 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2784
Ronald Cron66dbf912022-02-02 15:33:46 +01002785 /*
2786 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002787 * that were written into the output buffer by the previous handshake step,
2788 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002789 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2790 * We proceed to the next handshake step only when all data from the
2791 * previous one have been sent to the peer, thus we make sure that this is
2792 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2793 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2794 * we have to wait before to go ahead.
2795 * In the case of TLS 1.3, handshake step handlers do not send data to the
2796 * peer. Data are only sent here and through
2797 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
2798 * alert occured.
2799 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002800 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2801 return( ret );
2802
2803#if defined(MBEDTLS_SSL_PROTO_DTLS)
2804 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2805 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
2806 {
2807 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
2808 return( ret );
2809 }
2810#endif /* MBEDTLS_SSL_PROTO_DTLS */
2811
2812 return( ret );
2813}
2814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002816{
Hanno Becker41934dd2021-08-07 19:13:43 +01002817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00002818
Hanno Becker41934dd2021-08-07 19:13:43 +01002819 if( ssl == NULL ||
2820 ssl->conf == NULL ||
2821 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00002822 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01002823 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002824 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01002825 }
2826
2827 ret = ssl_prepare_handshake_step( ssl );
2828 if( ret != 0 )
2829 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002830
Jerry Yue7047812021-09-13 19:26:39 +08002831 ret = mbedtls_ssl_handle_pending_alert( ssl );
2832 if( ret != 0 )
2833 goto cleanup;
2834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002836 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08002837 {
Ronald Cron27c85e72022-03-08 11:37:55 +01002838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
2839 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08002840
Ronald Cron9f0fba32022-02-10 16:45:15 +01002841 switch( ssl->state )
2842 {
2843 case MBEDTLS_SSL_HELLO_REQUEST:
2844 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
2845 break;
Jerry Yub9930e72021-08-06 17:11:51 +08002846
Ronald Cron9f0fba32022-02-10 16:45:15 +01002847 case MBEDTLS_SSL_CLIENT_HELLO:
2848 ret = mbedtls_ssl_write_client_hello( ssl );
2849 break;
2850
2851 default:
2852#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002853 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01002854 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2855 else
2856 ret = mbedtls_ssl_handshake_client_step( ssl );
2857#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
2858 ret = mbedtls_ssl_handshake_client_step( ssl );
2859#else
2860 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
2861#endif
2862 }
Jerry Yub9930e72021-08-06 17:11:51 +08002863 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002864#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002866 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08002867 {
Ronald Cron6f135e12021-12-08 16:57:54 +01002868#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08002869 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08002870 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01002871#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08002872
2873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2874 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
2875 ret = mbedtls_ssl_handshake_server_step( ssl );
2876#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2877 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002878#endif
2879
Jerry Yue7047812021-09-13 19:26:39 +08002880 if( ret != 0 )
2881 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08002882 /* handshake_step return error. And it is same
2883 * with alert_reason.
2884 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08002885 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08002886 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08002887 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08002888 goto cleanup;
2889 }
2890 }
2891
2892cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01002893 return( ret );
2894}
2895
2896/*
2897 * Perform the SSL handshake
2898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01002900{
2901 int ret = 0;
2902
Hanno Beckera817ea42020-10-20 15:20:23 +01002903 /* Sanity checks */
2904
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02002905 if( ssl == NULL || ssl->conf == NULL )
2906 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2907
Hanno Beckera817ea42020-10-20 15:20:23 +01002908#if defined(MBEDTLS_SSL_PROTO_DTLS)
2909 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2910 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
2911 {
2912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
2913 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
2914 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2915 }
2916#endif /* MBEDTLS_SSL_PROTO_DTLS */
2917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01002919
Hanno Beckera817ea42020-10-20 15:20:23 +01002920 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00002921 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01002922 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002924
2925 if( ret != 0 )
2926 break;
2927 }
2928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002930
2931 return( ret );
2932}
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_RENEGOTIATION)
2935#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002936/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002937 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00002938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002940{
Janos Follath865b3eb2019-12-16 11:46:15 +00002941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002942
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 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2947 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002948
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002949 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002950 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002951 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002952 return( ret );
2953 }
2954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002956
2957 return( 0 );
2958}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002960
2961/*
2962 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 * - any side: calling mbedtls_ssl_renegotiate(),
2964 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
2965 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02002966 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002967 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01002969 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00002970int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00002971{
Janos Follath865b3eb2019-12-16 11:46:15 +00002972 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00002973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00002975
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002976 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
2977 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002978
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002979 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
2980 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002982 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002984 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002985 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002986 ssl->handshake->out_msg_seq = 1;
2987 else
2988 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02002989 }
2990#endif
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
2993 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00002994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00002996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00002998 return( ret );
2999 }
3000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003002
3003 return( 0 );
3004}
3005
3006/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003007 * Renegotiate current connection on client,
3008 * or request renegotiation on server
3009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003011{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003013
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003014 if( ssl == NULL || ssl->conf == NULL )
3015 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3016
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003018 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003019 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003020 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003021 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003025
3026 /* Did we already try/start sending HelloRequest? */
3027 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003029
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003030 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003031 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003035 /*
3036 * On client, either start the renegotiation process or,
3037 * if already in progress, continue the handshake
3038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003040 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003041 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003043
Hanno Becker40cdaa12020-02-05 10:48:27 +00003044 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003045 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003046 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003047 return( ret );
3048 }
3049 }
3050 else
3051 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003053 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003055 return( ret );
3056 }
3057 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003058#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003059
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003060 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003061}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003063
Gilles Peskine9b562d52018-04-25 20:32:43 +02003064void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003065{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003066 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3067
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003068 if( handshake == NULL )
3069 return;
3070
Brett Warrene0edc842021-08-17 09:53:13 +01003071#if defined(MBEDTLS_ECP_C)
3072#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3073 if ( ssl->handshake->group_list_heap_allocated )
3074 mbedtls_free( (void*) handshake->group_list );
3075 handshake->group_list = NULL;
3076#endif /* MBEDTLS_DEPRECATED_REMOVED */
3077#endif /* MBEDTLS_ECP_C */
3078
Jerry Yuf017ee42022-01-12 15:49:48 +08003079#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3080#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3081 if ( ssl->handshake->sig_algs_heap_allocated )
3082 mbedtls_free( (void*) handshake->sig_algs );
3083 handshake->sig_algs = NULL;
3084#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003085#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3086 if( ssl->handshake->certificate_request_context )
3087 {
3088 mbedtls_free( (void*) handshake->certificate_request_context );
3089 }
3090#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003091#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3092
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003093#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3094 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3095 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003096 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003097 handshake->async_in_progress = 0;
3098 }
3099#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3100
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003101#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003102#if defined(MBEDTLS_USE_PSA_CRYPTO)
3103 psa_hash_abort( &handshake->fin_sha256_psa );
3104#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003105 mbedtls_sha256_free( &handshake->fin_sha256 );
3106#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003107#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003108#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003109#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003110 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003111#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003112 mbedtls_sha512_free( &handshake->fin_sha512 );
3113#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003114#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116#if defined(MBEDTLS_DHM_C)
3117 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003118#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119#if defined(MBEDTLS_ECDH_C)
3120 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003121#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003122#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003123 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003124#if defined(MBEDTLS_SSL_CLI_C)
3125 mbedtls_free( handshake->ecjpake_cache );
3126 handshake->ecjpake_cache = NULL;
3127 handshake->ecjpake_cache_len = 0;
3128#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003129#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003130
Janos Follath4ae5c292016-02-10 11:27:43 +00003131#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3132 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003133 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003135#endif
3136
Gilles Peskineeccd8882020-03-10 12:19:08 +01003137#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003138 if( handshake->psk != NULL )
3139 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003140 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003141 mbedtls_free( handshake->psk );
3142 }
3143#endif
3144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3146 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003147 /*
3148 * Free only the linked list wrapper, not the keys themselves
3149 * since the belong to the SNI callback
3150 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003151 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003153
Gilles Peskineeccd8882020-03-10 12:19:08 +01003154#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003155 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003156 if( handshake->ecrs_peer_cert != NULL )
3157 {
3158 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3159 mbedtls_free( handshake->ecrs_peer_cert );
3160 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003161#endif
3162
Hanno Becker75173122019-02-06 16:18:31 +00003163#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3164 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3165 mbedtls_pk_free( &handshake->peer_pubkey );
3166#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3167
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003168#if defined(MBEDTLS_SSL_CLI_C) && \
3169 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3170 mbedtls_free( handshake->cookie );
3171#endif /* MBEDTLS_SSL_CLI_C &&
3172 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003173
3174#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003175 mbedtls_ssl_flight_free( handshake->flight );
3176 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003177#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003178
Ronald Cronf12b81d2022-03-15 10:42:41 +01003179#if defined(MBEDTLS_ECDH_C) && \
3180 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003181 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003182 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003183#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3184
Ronald Cron6f135e12021-12-08 16:57:54 +01003185#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003186 mbedtls_ssl_transform_free( handshake->transform_handshake );
3187 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003188 mbedtls_free( handshake->transform_earlydata );
3189 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003190#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003191
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003192
3193#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3194 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3195 * processes datagrams and the fact that a datagram is allowed to have
3196 * several records in it, it is possible that the I/O buffers are not
3197 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003198 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3199 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003200#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003201
Jerry Yuba9c7272021-10-30 11:54:10 +08003202 /* mbedtls_platform_zeroize MUST be last one in this function */
3203 mbedtls_platform_zeroize( handshake,
3204 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003205}
3206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003208{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003209 if( session == NULL )
3210 return;
3211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003213 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003214#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003215
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003216#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003218#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003219
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003220 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003221}
3222
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003223#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003224
3225#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3226#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3227#else
3228#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3229#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3230
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003231#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003232
3233#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3234#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3235#else
3236#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3237#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3238
3239#if defined(MBEDTLS_SSL_ALPN)
3240#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3241#else
3242#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3243#endif /* MBEDTLS_SSL_ALPN */
3244
3245#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3246#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3247#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3248#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3249
3250#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3251 ( (uint32_t) ( \
3252 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3253 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3254 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3255 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3256 0u ) )
3257
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003258static unsigned char ssl_serialized_context_header[] = {
3259 MBEDTLS_VERSION_MAJOR,
3260 MBEDTLS_VERSION_MINOR,
3261 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003262 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3263 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3264 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3265 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3266 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003267};
3268
Paul Bakker5121ce52009-01-03 21:22:43 +00003269/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003270 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003271 *
3272 * The format of the serialized data is:
3273 * (in the presentation language of TLS, RFC 8446 section 3)
3274 *
3275 * // header
3276 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003277 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003278 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003279 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003280 * Note: When updating the format, remember to keep these
3281 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003282 *
3283 * // session sub-structure
3284 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3285 * // transform sub-structure
3286 * uint8 random[64]; // ServerHello.random+ClientHello.random
3287 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3288 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3289 * // fields from ssl_context
3290 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3291 * uint64 in_window_top; // DTLS: last validated record seq_num
3292 * uint64 in_window; // DTLS: bitmask for replay protection
3293 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3294 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3295 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3296 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3297 *
3298 * Note that many fields of the ssl_context or sub-structures are not
3299 * serialized, as they fall in one of the following categories:
3300 *
3301 * 1. forced value (eg in_left must be 0)
3302 * 2. pointer to dynamically-allocated memory (eg session, transform)
3303 * 3. value can be re-derived from other data (eg session keys from MS)
3304 * 4. value was temporary (eg content of input buffer)
3305 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003306 */
3307int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3308 unsigned char *buf,
3309 size_t buf_len,
3310 size_t *olen )
3311{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003312 unsigned char *p = buf;
3313 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003314 size_t session_len;
3315 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003316
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003317 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003318 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3319 * this function's documentation.
3320 *
3321 * These are due to assumptions/limitations in the implementation. Some of
3322 * them are likely to stay (no handshake in progress) some might go away
3323 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003324 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003325 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003326 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003327 {
3328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003329 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003330 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003331 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003332 {
3333 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
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 /* Double-check that sub-structures are indeed ready */
3337 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003338 {
3339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003340 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003341 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003342 /* There must be no pending incoming or outgoing data */
3343 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003344 {
3345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003346 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003347 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003348 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003349 {
3350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
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 /* Protocol must be DLTS, not TLS */
3354 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003355 {
3356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is 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 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003360 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003361 {
3362 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003363 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003364 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003365 /* We must be using an AEAD ciphersuite */
3366 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003367 {
3368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003369 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003370 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003371 /* Renegotiation must not be enabled */
3372#if defined(MBEDTLS_SSL_RENEGOTIATION)
3373 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003374 {
3375 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003376 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003377 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003378#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003379
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003380 /*
3381 * Version and format identifier
3382 */
3383 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003384
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003385 if( used <= buf_len )
3386 {
3387 memcpy( p, ssl_serialized_context_header,
3388 sizeof( ssl_serialized_context_header ) );
3389 p += sizeof( ssl_serialized_context_header );
3390 }
3391
3392 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003393 * Session (length + data)
3394 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003395 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003396 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3397 return( ret );
3398
3399 used += 4 + session_len;
3400 if( used <= buf_len )
3401 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003402 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3403 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003404
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003405 ret = ssl_session_save( ssl->session, 1,
3406 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003407 if( ret != 0 )
3408 return( ret );
3409
3410 p += session_len;
3411 }
3412
3413 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003414 * Transform
3415 */
3416 used += sizeof( ssl->transform->randbytes );
3417 if( used <= buf_len )
3418 {
3419 memcpy( p, ssl->transform->randbytes,
3420 sizeof( ssl->transform->randbytes ) );
3421 p += sizeof( ssl->transform->randbytes );
3422 }
3423
3424#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3425 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3426 if( used <= buf_len )
3427 {
3428 *p++ = ssl->transform->in_cid_len;
3429 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3430 p += ssl->transform->in_cid_len;
3431
3432 *p++ = ssl->transform->out_cid_len;
3433 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3434 p += ssl->transform->out_cid_len;
3435 }
3436#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3437
3438 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003439 * Saved fields from top-level ssl_context structure
3440 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003441 used += 4;
3442 if( used <= buf_len )
3443 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003444 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3445 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003446 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003447
3448#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3449 used += 16;
3450 if( used <= buf_len )
3451 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003452 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3453 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003454
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003455 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3456 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003457 }
3458#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3459
3460#if defined(MBEDTLS_SSL_PROTO_DTLS)
3461 used += 1;
3462 if( used <= buf_len )
3463 {
3464 *p++ = ssl->disable_datagram_packing;
3465 }
3466#endif /* MBEDTLS_SSL_PROTO_DTLS */
3467
Jerry Yuae0b2e22021-10-08 15:21:19 +08003468 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003469 if( used <= buf_len )
3470 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003471 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3472 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003473 }
3474
3475#if defined(MBEDTLS_SSL_PROTO_DTLS)
3476 used += 2;
3477 if( used <= buf_len )
3478 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003479 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3480 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003481 }
3482#endif /* MBEDTLS_SSL_PROTO_DTLS */
3483
3484#if defined(MBEDTLS_SSL_ALPN)
3485 {
3486 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003487 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003488 : 0;
3489
3490 used += 1 + alpn_len;
3491 if( used <= buf_len )
3492 {
3493 *p++ = alpn_len;
3494
3495 if( ssl->alpn_chosen != NULL )
3496 {
3497 memcpy( p, ssl->alpn_chosen, alpn_len );
3498 p += alpn_len;
3499 }
3500 }
3501 }
3502#endif /* MBEDTLS_SSL_ALPN */
3503
3504 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003505 * Done
3506 */
3507 *olen = used;
3508
3509 if( used > buf_len )
3510 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003511
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003512 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3513
Hanno Becker43aefe22020-02-05 10:44:56 +00003514 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003515}
3516
3517/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003518 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003519 *
3520 * This internal version is wrapped by a public function that cleans up in
3521 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003522 */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003523static int ssl_context_load( mbedtls_ssl_context *ssl,
3524 const unsigned char *buf,
3525 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003526{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003527 const unsigned char *p = buf;
3528 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003529 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003530 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003531
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003532 /*
3533 * The context should have been freshly setup or reset.
3534 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003535 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003536 * renegotiating, or if the user mistakenly loaded a session first.)
3537 */
3538 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3539 ssl->session != NULL )
3540 {
3541 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3542 }
3543
3544 /*
3545 * We can't check that the config matches the initial one, but we can at
3546 * least check it matches the requirements for serializing.
3547 */
3548 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003549 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3550 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003551#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003552 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003553#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003554 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003555 {
3556 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3557 }
3558
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003559 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3560
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003561 /*
3562 * Check version identifier
3563 */
3564 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3565 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3566
3567 if( memcmp( p, ssl_serialized_context_header,
3568 sizeof( ssl_serialized_context_header ) ) != 0 )
3569 {
3570 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3571 }
3572 p += sizeof( ssl_serialized_context_header );
3573
3574 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003575 * Session
3576 */
3577 if( (size_t)( end - p ) < 4 )
3578 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3579
3580 session_len = ( (size_t) p[0] << 24 ) |
3581 ( (size_t) p[1] << 16 ) |
3582 ( (size_t) p[2] << 8 ) |
3583 ( (size_t) p[3] );
3584 p += 4;
3585
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003586 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003587 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003588 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003589 ssl->session_in = ssl->session;
3590 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003591 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003592
3593 if( (size_t)( end - p ) < session_len )
3594 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3595
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003596 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003597 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003598 {
3599 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003600 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003601 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003602
3603 p += session_len;
3604
3605 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003606 * Transform
3607 */
3608
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003609 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003610 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003611 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003612 ssl->transform_in = ssl->transform;
3613 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003614 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003615
3616 /* Read random bytes and populate structure */
3617 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3618 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003619#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003620 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003621 ssl->session->ciphersuite,
3622 ssl->session->master,
Hanno Beckerbd257552021-03-22 06:59:27 +00003623#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
3624 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003625 ssl->session->encrypt_then_mac,
Hanno Beckerbd257552021-03-22 06:59:27 +00003626#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
3627 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003628 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3629 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003630 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003631 ssl->conf->endpoint,
3632 ssl );
3633 if( ret != 0 )
3634 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003635#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003636 p += sizeof( ssl->transform->randbytes );
3637
3638#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3639 /* Read connection IDs and store them */
3640 if( (size_t)( end - p ) < 1 )
3641 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3642
3643 ssl->transform->in_cid_len = *p++;
3644
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003645 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3647
3648 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3649 p += ssl->transform->in_cid_len;
3650
3651 ssl->transform->out_cid_len = *p++;
3652
3653 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3654 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3655
3656 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3657 p += ssl->transform->out_cid_len;
3658#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3659
3660 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003661 * Saved fields from top-level ssl_context structure
3662 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003663 if( (size_t)( end - p ) < 4 )
3664 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3665
3666 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3667 ( (uint32_t) p[1] << 16 ) |
3668 ( (uint32_t) p[2] << 8 ) |
3669 ( (uint32_t) p[3] );
3670 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003671
3672#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3673 if( (size_t)( end - p ) < 16 )
3674 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3675
3676 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3677 ( (uint64_t) p[1] << 48 ) |
3678 ( (uint64_t) p[2] << 40 ) |
3679 ( (uint64_t) p[3] << 32 ) |
3680 ( (uint64_t) p[4] << 24 ) |
3681 ( (uint64_t) p[5] << 16 ) |
3682 ( (uint64_t) p[6] << 8 ) |
3683 ( (uint64_t) p[7] );
3684 p += 8;
3685
3686 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3687 ( (uint64_t) p[1] << 48 ) |
3688 ( (uint64_t) p[2] << 40 ) |
3689 ( (uint64_t) p[3] << 32 ) |
3690 ( (uint64_t) p[4] << 24 ) |
3691 ( (uint64_t) p[5] << 16 ) |
3692 ( (uint64_t) p[6] << 8 ) |
3693 ( (uint64_t) p[7] );
3694 p += 8;
3695#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3696
3697#if defined(MBEDTLS_SSL_PROTO_DTLS)
3698 if( (size_t)( end - p ) < 1 )
3699 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3700
3701 ssl->disable_datagram_packing = *p++;
3702#endif /* MBEDTLS_SSL_PROTO_DTLS */
3703
Jerry Yud9a94fe2021-09-28 18:58:59 +08003704 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003705 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003706 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3707 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003708
3709#if defined(MBEDTLS_SSL_PROTO_DTLS)
3710 if( (size_t)( end - p ) < 2 )
3711 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3712
3713 ssl->mtu = ( p[0] << 8 ) | p[1];
3714 p += 2;
3715#endif /* MBEDTLS_SSL_PROTO_DTLS */
3716
3717#if defined(MBEDTLS_SSL_ALPN)
3718 {
3719 uint8_t alpn_len;
3720 const char **cur;
3721
3722 if( (size_t)( end - p ) < 1 )
3723 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3724
3725 alpn_len = *p++;
3726
3727 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3728 {
3729 /* alpn_chosen should point to an item in the configured list */
3730 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3731 {
3732 if( strlen( *cur ) == alpn_len &&
3733 memcmp( p, cur, alpn_len ) == 0 )
3734 {
3735 ssl->alpn_chosen = *cur;
3736 break;
3737 }
3738 }
3739 }
3740
3741 /* can only happen on conf mismatch */
3742 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3743 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3744
3745 p += alpn_len;
3746 }
3747#endif /* MBEDTLS_SSL_ALPN */
3748
3749 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003750 * Forced fields from top-level ssl_context structure
3751 *
3752 * Most of them already set to the correct value by mbedtls_ssl_init() and
3753 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3754 */
3755 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003756 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003757
Hanno Becker361b10d2019-08-30 10:42:49 +01003758 /* Adjust pointers for header fields of outgoing records to
3759 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003760 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003761
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003762#if defined(MBEDTLS_SSL_PROTO_DTLS)
3763 ssl->in_epoch = 1;
3764#endif
3765
3766 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3767 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003768 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3769 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003770 if( ssl->handshake != NULL )
3771 {
3772 mbedtls_ssl_handshake_free( ssl );
3773 mbedtls_free( ssl->handshake );
3774 ssl->handshake = NULL;
3775 }
3776
3777 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003778 * Done - should have consumed entire buffer
3779 */
3780 if( p != end )
3781 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003782
3783 return( 0 );
3784}
3785
3786/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003787 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003788 */
3789int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3790 const unsigned char *buf,
3791 size_t len )
3792{
3793 int ret = ssl_context_load( context, buf, len );
3794
3795 if( ret != 0 )
3796 mbedtls_ssl_free( context );
3797
3798 return( ret );
3799}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003800#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003801
3802/*
Paul Bakker5121ce52009-01-03 21:22:43 +00003803 * Free an SSL context
3804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003806{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003807 if( ssl == NULL )
3808 return;
3809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003811
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003812 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003813 {
sander-visserb8aa2072020-05-06 22:05:13 +02003814#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3815 size_t out_buf_len = ssl->out_buf_len;
3816#else
3817 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
3818#endif
3819
Darryl Greenb33cc762019-11-28 14:29:44 +00003820 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003822 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003823 }
3824
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01003825 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003826 {
sander-visserb8aa2072020-05-06 22:05:13 +02003827#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3828 size_t in_buf_len = ssl->in_buf_len;
3829#else
3830 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3831#endif
3832
Darryl Greenb33cc762019-11-28 14:29:44 +00003833 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003834 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003835 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00003836 }
3837
Paul Bakker48916f92012-09-16 19:57:18 +00003838 if( ssl->transform )
3839 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840 mbedtls_ssl_transform_free( ssl->transform );
3841 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00003842 }
3843
3844 if( ssl->handshake )
3845 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02003846 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003847 mbedtls_ssl_transform_free( ssl->transform_negotiate );
3848 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003850 mbedtls_free( ssl->handshake );
3851 mbedtls_free( ssl->transform_negotiate );
3852 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00003853 }
3854
Ronald Cron6f135e12021-12-08 16:57:54 +01003855#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01003856 mbedtls_ssl_transform_free( ssl->transform_application );
3857 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01003858#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01003859
Paul Bakkerc0463502013-02-14 11:19:38 +01003860 if( ssl->session )
3861 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003862 mbedtls_ssl_session_free( ssl->session );
3863 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01003864 }
3865
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02003866#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02003867 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003868 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003869 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00003871 }
Paul Bakker0be444a2013-08-27 21:55:01 +02003872#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00003873
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003874#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003875 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003876#endif
3877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00003879
Paul Bakker86f04f42013-02-14 11:20:09 +01003880 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003881 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003882}
3883
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003884/*
3885 * Initialze mbedtls_ssl_config
3886 */
3887void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
3888{
3889 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
3890}
3891
Gilles Peskineeccd8882020-03-10 12:19:08 +01003892#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003893#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskineae270bf2021-06-02 00:05:29 +02003894/* The selection should be the same as mbedtls_x509_crt_profile_default in
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003895 * x509_crt.c. Here, the order matters. Currently we favor stronger hashes,
3896 * for no fundamental reason.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003897 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
3898 * about this list. */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003899static int ssl_preset_default_hashes[] = {
3900#if defined(MBEDTLS_SHA512_C)
3901 MBEDTLS_MD_SHA512,
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003902#endif
3903#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003904 MBEDTLS_MD_SHA384,
3905#endif
3906#if defined(MBEDTLS_SHA256_C)
3907 MBEDTLS_MD_SHA256,
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003908#endif
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003909 MBEDTLS_MD_NONE
3910};
Jerry Yuf017ee42022-01-12 15:49:48 +08003911#endif /* !MBEDTLS_DEPRECATED_REMOVED */
3912#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01003913
Gilles Peskineae270bf2021-06-02 00:05:29 +02003914/* The selection should be the same as mbedtls_x509_crt_profile_default in
3915 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02003916 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003917 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02003918 * about this list.
3919 */
Brett Warrene0edc842021-08-17 09:53:13 +01003920static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02003921#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003922 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003923#endif
3924#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003925 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003926#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003927#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003928 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003929#endif
3930#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003931 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003932#endif
3933#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003934 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003935#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02003936#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003937 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02003938#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02003939#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003940 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003941#endif
3942#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01003943 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02003944#endif
Brett Warrene0edc842021-08-17 09:53:13 +01003945 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02003946};
Gilles Peskineae270bf2021-06-02 00:05:29 +02003947
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003948static int ssl_preset_suiteb_ciphersuites[] = {
3949 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
3950 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
3951 0
3952};
3953
Gilles Peskineeccd8882020-03-10 12:19:08 +01003954#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003955#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003956static int ssl_preset_suiteb_hashes[] = {
Jerry Yuf017ee42022-01-12 15:49:48 +08003957#if defined(MBEDTLS_SHA256_C)
3958 MBEDTLS_MD_SHA256,
3959#endif
Jerry Yu713013f2022-01-17 18:16:35 +08003960#if defined(MBEDTLS_SHA384_C)
3961 MBEDTLS_MD_SHA384,
3962#endif
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003963 MBEDTLS_MD_NONE
3964};
Jerry Yuf017ee42022-01-12 15:49:48 +08003965#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003966
Jerry Yu909df7b2022-01-22 11:56:27 +08003967/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08003968 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08003969 * rules SHOULD be upheld.
3970 * - No duplicate entries.
3971 * - But if there is a good reason, do not change the order of the algorithms.
3972 * - ssl_tls12_present* is for TLS 1.2 use only.
3973 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08003974 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01003975static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08003976
Jerry Yued5e9f42022-01-26 11:21:34 +08003977#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
3978 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
3979 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
3980#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
3981 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003982
Jerry Yu909df7b2022-01-22 11:56:27 +08003983#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
3984 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
3985 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
3986#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3987 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
3988
Jerry Yued5e9f42022-01-26 11:21:34 +08003989#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
3990 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
3991 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
3992#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
3993 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08003994
Jerry Yu909df7b2022-01-22 11:56:27 +08003995#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
3996 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
3997#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
3998
Ronald Cron8540cf62022-03-16 08:01:09 +01003999#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4000 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4001#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4002
4003#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4004 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4005#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4006
Jerry Yu53037892022-01-25 11:02:06 +08004007#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4008 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4009#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4010
Jerry Yu909df7b2022-01-22 11:56:27 +08004011 MBEDTLS_TLS1_3_SIG_NONE
4012};
4013
4014/* NOTICE: see above */
4015#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4016static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004017#if defined(MBEDTLS_SHA512_C)
4018 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA512 )
4019#endif
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004020#if defined(MBEDTLS_SHA384_C)
4021 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4022#endif
4023#if defined(MBEDTLS_SHA256_C)
4024 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4025#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004026 MBEDTLS_TLS1_3_SIG_NONE
4027};
4028#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4029/* NOTICE: see above */
4030static uint16_t ssl_preset_suiteb_sig_algs[] = {
4031
Jerry Yu909df7b2022-01-22 11:56:27 +08004032#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4033 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4034 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4035#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4036 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4037
Jerry Yu53037892022-01-25 11:02:06 +08004038#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4039 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4040 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4041#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4042 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004043
4044#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4045 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4046#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004047
Jerry Yu53037892022-01-25 11:02:06 +08004048#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4049 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4050#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4051
Jerry Yu713013f2022-01-17 18:16:35 +08004052 MBEDTLS_TLS1_3_SIG_NONE
4053};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004054
Jerry Yu909df7b2022-01-22 11:56:27 +08004055/* NOTICE: see above */
4056#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4057static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004058#if defined(MBEDTLS_SHA256_C)
4059 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA256 )
4060#endif
Jerry Yu18c833e2022-01-25 10:55:47 +08004061#if defined(MBEDTLS_SHA384_C)
4062 MBEDTLS_SSL_SIG_ALG( MBEDTLS_SSL_HASH_SHA384 )
4063#endif
Xiaofei Bai95395012021-11-25 08:51:30 +00004064 MBEDTLS_TLS1_3_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004065};
Jerry Yu909df7b2022-01-22 11:56:27 +08004066#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4067
Jerry Yu1a8b4812022-01-20 17:56:50 +08004068#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004069
Brett Warrene0edc842021-08-17 09:53:13 +01004070static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004071#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004072 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004073#endif
4074#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004075 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004076#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004077 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004078};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004079
Jerry Yu1a8b4812022-01-20 17:56:50 +08004080#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004081/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004082 * to make sure there are no duplicated signature algorithm entries. */
Jerry Yuf377d642022-01-25 10:43:59 +08004083static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004084{
4085 size_t i, j;
4086 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004087
Jerry Yuf377d642022-01-25 10:43:59 +08004088 for( i = 0; sig_algs[i] != MBEDTLS_TLS1_3_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004089 {
Jerry Yuf377d642022-01-25 10:43:59 +08004090 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004091 {
Jerry Yuf377d642022-01-25 10:43:59 +08004092 if( sig_algs[i] != sig_algs[j] )
4093 continue;
4094 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4095 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4096 sig_algs[i], j, i );
4097 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004098 }
4099 }
4100 return( ret );
4101}
4102
4103#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4104
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004105/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004106 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004107 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004108int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004109 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004110{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004111#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004113#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004114
Jerry Yu1a8b4812022-01-20 17:56:50 +08004115#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004116 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004117 {
4118 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4119 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4120 }
4121
Jerry Yuf377d642022-01-25 10:43:59 +08004122 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004123 {
4124 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4125 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4126 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004127
4128#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004129 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004130 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004131 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004132 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4133 }
4134
Jerry Yuf377d642022-01-25 10:43:59 +08004135 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004136 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004137 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004138 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4139 }
4140#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004141#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4142
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004143 /* Use the functions here so that they are covered in tests,
4144 * but otherwise access member directly for efficiency */
4145 mbedtls_ssl_conf_endpoint( conf, endpoint );
4146 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004147
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004148 /*
4149 * Things that are common to all presets
4150 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004151#if defined(MBEDTLS_SSL_CLI_C)
4152 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4153 {
4154 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4155#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4156 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4157#endif
4158 }
4159#endif
4160
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004161#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4162 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4163#endif
4164
4165#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4166 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4167#endif
4168
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004169#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004170 conf->f_cookie_write = ssl_cookie_write_dummy;
4171 conf->f_cookie_check = ssl_cookie_check_dummy;
4172#endif
4173
4174#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4175 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4176#endif
4177
Janos Follath088ce432017-04-10 12:42:31 +01004178#if defined(MBEDTLS_SSL_SRV_C)
4179 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004180 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004181#endif
4182
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004183#if defined(MBEDTLS_SSL_PROTO_DTLS)
4184 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4185 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4186#endif
4187
4188#if defined(MBEDTLS_SSL_RENEGOTIATION)
4189 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004190 memset( conf->renego_period, 0x00, 2 );
4191 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004192#endif
4193
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004194#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004195 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4196 {
4197 const unsigned char dhm_p[] =
4198 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4199 const unsigned char dhm_g[] =
4200 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004201
Hanno Beckere2defad2021-07-24 05:59:17 +01004202 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4203 dhm_p, sizeof( dhm_p ),
4204 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4205 {
4206 return( ret );
4207 }
4208 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004209#endif
4210
Ronald Cron6f135e12021-12-08 16:57:54 +01004211#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004212 /*
4213 * Allow all TLS 1.3 key exchange modes by default.
4214 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004215 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004216#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004217
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004218 if( ( endpoint == MBEDTLS_SSL_IS_SERVER ) ||
4219 ( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM ) )
4220 {
4221#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4222 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4223 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4224#else
4225 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4226#endif
4227 }
4228 else
4229 {
4230#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4231 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4232 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4233#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4234 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4235 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4236#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4237 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4238 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4239#else
4240 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4241#endif
4242 }
4243
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004244 /*
4245 * Preset-specific defaults
4246 */
4247 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004248 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004249 /*
4250 * NSA Suite B
4251 */
4252 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004253
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004254 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004255
4256#if defined(MBEDTLS_X509_CRT_PARSE_C)
4257 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004258#endif
4259
Gilles Peskineeccd8882020-03-10 12:19:08 +01004260#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004261#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004262 conf->sig_hashes = ssl_preset_suiteb_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004263#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004264#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4265 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4266 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4267 else
4268#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4269 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004270#endif
4271
Brett Warrene0edc842021-08-17 09:53:13 +01004272#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4273 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004274#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004275 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004276 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004277
4278 /*
4279 * Default
4280 */
4281 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004282
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004283 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004284
4285#if defined(MBEDTLS_X509_CRT_PARSE_C)
4286 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4287#endif
4288
Gilles Peskineeccd8882020-03-10 12:19:08 +01004289#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004290#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01004291 conf->sig_hashes = ssl_preset_default_hashes;
Jerry Yuf017ee42022-01-12 15:49:48 +08004292#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004293#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4294 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4295 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4296 else
4297#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4298 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004299#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004300
Brett Warrene0edc842021-08-17 09:53:13 +01004301#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4302 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004303#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004304 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004305
4306#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4307 conf->dhm_min_bitlen = 1024;
4308#endif
4309 }
4310
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004311 return( 0 );
4312}
4313
4314/*
4315 * Free mbedtls_ssl_config
4316 */
4317void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4318{
4319#if defined(MBEDTLS_DHM_C)
4320 mbedtls_mpi_free( &conf->dhm_P );
4321 mbedtls_mpi_free( &conf->dhm_G );
4322#endif
4323
Gilles Peskineeccd8882020-03-10 12:19:08 +01004324#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004325 if( conf->psk != NULL )
4326 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004327 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004328 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004329 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004330 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004331 }
4332
4333 if( conf->psk_identity != NULL )
4334 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004335 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004336 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004337 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004338 conf->psk_identity_len = 0;
4339 }
4340#endif
4341
4342#if defined(MBEDTLS_X509_CRT_PARSE_C)
4343 ssl_key_cert_free( conf->key_cert );
4344#endif
4345
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004346 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004347}
4348
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004349#if defined(MBEDTLS_PK_C) && \
4350 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004351/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004354unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004355{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356#if defined(MBEDTLS_RSA_C)
4357 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4358 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004359#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360#if defined(MBEDTLS_ECDSA_C)
4361 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4362 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004363#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004364 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004365}
4366
Hanno Becker7e5437a2017-04-28 17:15:26 +01004367unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4368{
4369 switch( type ) {
4370 case MBEDTLS_PK_RSA:
4371 return( MBEDTLS_SSL_SIG_RSA );
4372 case MBEDTLS_PK_ECDSA:
4373 case MBEDTLS_PK_ECKEY:
4374 return( MBEDTLS_SSL_SIG_ECDSA );
4375 default:
4376 return( MBEDTLS_SSL_SIG_ANON );
4377 }
4378}
4379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004380mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004381{
4382 switch( sig )
4383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384#if defined(MBEDTLS_RSA_C)
4385 case MBEDTLS_SSL_SIG_RSA:
4386 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004387#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004388#if defined(MBEDTLS_ECDSA_C)
4389 case MBEDTLS_SSL_SIG_ECDSA:
4390 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004391#endif
4392 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004393 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004394 }
4395}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004396#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004397
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004398/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004399 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004401mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004402{
4403 switch( hash )
4404 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004405#if defined(MBEDTLS_MD5_C)
4406 case MBEDTLS_SSL_HASH_MD5:
4407 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004408#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409#if defined(MBEDTLS_SHA1_C)
4410 case MBEDTLS_SSL_HASH_SHA1:
4411 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004412#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004413#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004414 case MBEDTLS_SSL_HASH_SHA224:
4415 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004416#endif
4417#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004418 case MBEDTLS_SSL_HASH_SHA256:
4419 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004420#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004421#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004422 case MBEDTLS_SSL_HASH_SHA384:
4423 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004424#endif
4425#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004426 case MBEDTLS_SSL_HASH_SHA512:
4427 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004428#endif
4429 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004430 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004431 }
4432}
4433
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004434/*
4435 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4436 */
4437unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4438{
4439 switch( md )
4440 {
4441#if defined(MBEDTLS_MD5_C)
4442 case MBEDTLS_MD_MD5:
4443 return( MBEDTLS_SSL_HASH_MD5 );
4444#endif
4445#if defined(MBEDTLS_SHA1_C)
4446 case MBEDTLS_MD_SHA1:
4447 return( MBEDTLS_SSL_HASH_SHA1 );
4448#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004449#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004450 case MBEDTLS_MD_SHA224:
4451 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004452#endif
4453#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004454 case MBEDTLS_MD_SHA256:
4455 return( MBEDTLS_SSL_HASH_SHA256 );
4456#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004457#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004458 case MBEDTLS_MD_SHA384:
4459 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004460#endif
4461#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004462 case MBEDTLS_MD_SHA512:
4463 return( MBEDTLS_SSL_HASH_SHA512 );
4464#endif
4465 default:
4466 return( MBEDTLS_SSL_HASH_NONE );
4467 }
4468}
4469
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004470/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004471 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004472 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004473 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004474int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004475{
Brett Warrene0edc842021-08-17 09:53:13 +01004476 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004477
Brett Warrene0edc842021-08-17 09:53:13 +01004478 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004479 return( -1 );
4480
Brett Warrene0edc842021-08-17 09:53:13 +01004481 for( ; *group_list != 0; group_list++ )
4482 {
4483 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004484 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004485 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004486
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004487 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004488}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004489
4490#if defined(MBEDTLS_ECP_C)
4491/*
4492 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4493 */
4494int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4495{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004496 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004497 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4498}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004499#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004501#if defined(MBEDTLS_X509_CRT_PARSE_C)
4502int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4503 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004504 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004505 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004506{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004507 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004508 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004509 const char *ext_oid;
4510 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004512 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004513 {
4514 /* Server part of the key exchange */
4515 switch( ciphersuite->key_exchange )
4516 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517 case MBEDTLS_KEY_EXCHANGE_RSA:
4518 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004519 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004520 break;
4521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004522 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4523 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4524 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4525 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004526 break;
4527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4529 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004530 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004531 break;
4532
4533 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004534 case MBEDTLS_KEY_EXCHANGE_NONE:
4535 case MBEDTLS_KEY_EXCHANGE_PSK:
4536 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4537 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004538 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004539 usage = 0;
4540 }
4541 }
4542 else
4543 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004544 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4545 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004546 }
4547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004548 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004549 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004550 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004551 ret = -1;
4552 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004554 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004555 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004556 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4557 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004558 }
4559 else
4560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4562 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004563 }
4564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004565 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004566 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004567 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004568 ret = -1;
4569 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004570
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004571 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004572}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004573#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004574
Jerry Yu148165c2021-09-24 23:20:59 +08004575#if defined(MBEDTLS_USE_PSA_CRYPTO)
4576int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4577 const mbedtls_md_type_t md,
4578 unsigned char *dst,
4579 size_t dst_len,
4580 size_t *olen )
4581{
Ronald Cronf6893e12022-01-07 22:09:01 +01004582 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4583 psa_hash_operation_t *hash_operation_to_clone;
4584 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4585
Jerry Yu148165c2021-09-24 23:20:59 +08004586 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004587
4588 switch( md )
4589 {
4590#if defined(MBEDTLS_SHA384_C)
4591 case MBEDTLS_MD_SHA384:
4592 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4593 break;
4594#endif
4595
4596#if defined(MBEDTLS_SHA256_C)
4597 case MBEDTLS_MD_SHA256:
4598 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4599 break;
4600#endif
4601
4602 default:
4603 goto exit;
4604 }
4605
4606 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4607 if( status != PSA_SUCCESS )
4608 goto exit;
4609
4610 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4611 if( status != PSA_SUCCESS )
4612 goto exit;
4613
4614exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004615 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004616}
4617#else /* MBEDTLS_USE_PSA_CRYPTO */
4618
Jerry Yu24c0ec32021-09-09 14:21:07 +08004619#if defined(MBEDTLS_SHA384_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004620static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4621 unsigned char *dst,
4622 size_t dst_len,
4623 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004624{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004625 int ret;
4626 mbedtls_sha512_context sha512;
4627
4628 if( dst_len < 48 )
4629 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4630
4631 mbedtls_sha512_init( &sha512 );
4632 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4633
4634 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4635 {
4636 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4637 goto exit;
4638 }
4639
4640 *olen = 48;
4641
4642exit:
4643
4644 mbedtls_sha512_free( &sha512 );
4645 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004646}
4647#endif /* MBEDTLS_SHA384_C */
4648
4649#if defined(MBEDTLS_SHA256_C)
Jerry Yu000f9762021-09-14 11:12:51 +08004650static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4651 unsigned char *dst,
4652 size_t dst_len,
4653 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004654{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004655 int ret;
4656 mbedtls_sha256_context sha256;
4657
4658 if( dst_len < 32 )
4659 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4660
4661 mbedtls_sha256_init( &sha256 );
4662 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004663
Jerry Yu24c0ec32021-09-09 14:21:07 +08004664 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4665 {
4666 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4667 goto exit;
4668 }
4669
4670 *olen = 32;
4671
4672exit:
4673
4674 mbedtls_sha256_free( &sha256 );
4675 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004676}
4677#endif /* MBEDTLS_SHA256_C */
4678
Jerry Yu000f9762021-09-14 11:12:51 +08004679int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4680 const mbedtls_md_type_t md,
4681 unsigned char *dst,
4682 size_t dst_len,
4683 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004684{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004685 switch( md )
4686 {
4687
Jerry Yu24c0ec32021-09-09 14:21:07 +08004688#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004689 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004690 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004691#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004692
Jerry Yu24c0ec32021-09-09 14:21:07 +08004693#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004694 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004695 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004696#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004697
4698 default:
4699 break;
4700 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004701 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004702}
XiaokangQian647719a2021-12-07 09:16:29 +00004703
Jerry Yu148165c2021-09-24 23:20:59 +08004704#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004705
Jerry Yudc7bd172022-02-17 13:44:15 +08004706#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4707
4708#if defined(MBEDTLS_USE_PSA_CRYPTO)
4709
4710static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
4711 mbedtls_svc_key_id_t key,
4712 psa_algorithm_t alg,
4713 const unsigned char* seed, size_t seed_length,
4714 const unsigned char* label, size_t label_length,
4715 size_t capacity )
4716{
4717 psa_status_t status;
4718
4719 status = psa_key_derivation_setup( derivation, alg );
4720 if( status != PSA_SUCCESS )
4721 return( status );
4722
4723 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
4724 {
4725 status = psa_key_derivation_input_bytes( derivation,
4726 PSA_KEY_DERIVATION_INPUT_SEED,
4727 seed, seed_length );
4728 if( status != PSA_SUCCESS )
4729 return( status );
4730
4731 if( mbedtls_svc_key_id_is_null( key ) )
4732 {
4733 status = psa_key_derivation_input_bytes(
4734 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
4735 NULL, 0 );
4736 }
4737 else
4738 {
4739 status = psa_key_derivation_input_key(
4740 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
4741 }
4742 if( status != PSA_SUCCESS )
4743 return( status );
4744
4745 status = psa_key_derivation_input_bytes( derivation,
4746 PSA_KEY_DERIVATION_INPUT_LABEL,
4747 label, label_length );
4748 if( status != PSA_SUCCESS )
4749 return( status );
4750 }
4751 else
4752 {
4753 return( PSA_ERROR_NOT_SUPPORTED );
4754 }
4755
4756 status = psa_key_derivation_set_capacity( derivation, capacity );
4757 if( status != PSA_SUCCESS )
4758 return( status );
4759
4760 return( PSA_SUCCESS );
4761}
4762
4763static int tls_prf_generic( mbedtls_md_type_t md_type,
4764 const unsigned char *secret, size_t slen,
4765 const char *label,
4766 const unsigned char *random, size_t rlen,
4767 unsigned char *dstbuf, size_t dlen )
4768{
4769 psa_status_t status;
4770 psa_algorithm_t alg;
4771 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
4772 psa_key_derivation_operation_t derivation =
4773 PSA_KEY_DERIVATION_OPERATION_INIT;
4774
4775 if( md_type == MBEDTLS_MD_SHA384 )
4776 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
4777 else
4778 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
4779
4780 /* Normally a "secret" should be long enough to be impossible to
4781 * find by brute force, and in particular should not be empty. But
4782 * this PRF is also used to derive an IV, in particular in EAP-TLS,
4783 * and for this use case it makes sense to have a 0-length "secret".
4784 * Since the key API doesn't allow importing a key of length 0,
4785 * keep master_key=0, which setup_psa_key_derivation() understands
4786 * to mean a 0-length "secret" input. */
4787 if( slen != 0 )
4788 {
4789 psa_key_attributes_t key_attributes = psa_key_attributes_init();
4790 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
4791 psa_set_key_algorithm( &key_attributes, alg );
4792 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
4793
4794 status = psa_import_key( &key_attributes, secret, slen, &master_key );
4795 if( status != PSA_SUCCESS )
4796 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4797 }
4798
4799 status = setup_psa_key_derivation( &derivation,
4800 master_key, alg,
4801 random, rlen,
4802 (unsigned char const *) label,
4803 (size_t) strlen( label ),
4804 dlen );
4805 if( status != PSA_SUCCESS )
4806 {
4807 psa_key_derivation_abort( &derivation );
4808 psa_destroy_key( master_key );
4809 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4810 }
4811
4812 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
4813 if( status != PSA_SUCCESS )
4814 {
4815 psa_key_derivation_abort( &derivation );
4816 psa_destroy_key( master_key );
4817 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4818 }
4819
4820 status = psa_key_derivation_abort( &derivation );
4821 if( status != PSA_SUCCESS )
4822 {
4823 psa_destroy_key( master_key );
4824 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4825 }
4826
4827 if( ! mbedtls_svc_key_id_is_null( master_key ) )
4828 status = psa_destroy_key( master_key );
4829 if( status != PSA_SUCCESS )
4830 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
4831
4832 return( 0 );
4833}
4834
4835#else /* MBEDTLS_USE_PSA_CRYPTO */
4836
4837static int tls_prf_generic( mbedtls_md_type_t md_type,
4838 const unsigned char *secret, size_t slen,
4839 const char *label,
4840 const unsigned char *random, size_t rlen,
4841 unsigned char *dstbuf, size_t dlen )
4842{
4843 size_t nb;
4844 size_t i, j, k, md_len;
4845 unsigned char *tmp;
4846 size_t tmp_len = 0;
4847 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
4848 const mbedtls_md_info_t *md_info;
4849 mbedtls_md_context_t md_ctx;
4850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4851
4852 mbedtls_md_init( &md_ctx );
4853
4854 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
4855 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4856
4857 md_len = mbedtls_md_get_size( md_info );
4858
4859 tmp_len = md_len + strlen( label ) + rlen;
4860 tmp = mbedtls_calloc( 1, tmp_len );
4861 if( tmp == NULL )
4862 {
4863 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
4864 goto exit;
4865 }
4866
4867 nb = strlen( label );
4868 memcpy( tmp + md_len, label, nb );
4869 memcpy( tmp + md_len + nb, random, rlen );
4870 nb += rlen;
4871
4872 /*
4873 * Compute P_<hash>(secret, label + random)[0..dlen]
4874 */
4875 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
4876 goto exit;
4877
4878 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
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, tmp );
4885 if( ret != 0 )
4886 goto exit;
4887
4888 for( i = 0; i < dlen; i += md_len )
4889 {
4890 ret = mbedtls_md_hmac_reset ( &md_ctx );
4891 if( ret != 0 )
4892 goto exit;
4893 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
4894 if( ret != 0 )
4895 goto exit;
4896 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
4897 if( ret != 0 )
4898 goto exit;
4899
4900 ret = mbedtls_md_hmac_reset ( &md_ctx );
4901 if( ret != 0 )
4902 goto exit;
4903 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
4904 if( ret != 0 )
4905 goto exit;
4906 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
4907 if( ret != 0 )
4908 goto exit;
4909
4910 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
4911
4912 for( j = 0; j < k; j++ )
4913 dstbuf[i + j] = h_i[j];
4914 }
4915
4916exit:
4917 mbedtls_md_free( &md_ctx );
4918
4919 mbedtls_platform_zeroize( tmp, tmp_len );
4920 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
4921
4922 mbedtls_free( tmp );
4923
4924 return( ret );
4925}
4926#endif /* MBEDTLS_USE_PSA_CRYPTO */
4927
4928#if defined(MBEDTLS_SHA256_C)
4929static int tls_prf_sha256( const unsigned char *secret, size_t slen,
4930 const char *label,
4931 const unsigned char *random, size_t rlen,
4932 unsigned char *dstbuf, size_t dlen )
4933{
4934 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
4935 label, random, rlen, dstbuf, dlen ) );
4936}
4937#endif /* MBEDTLS_SHA256_C */
4938
4939#if defined(MBEDTLS_SHA384_C)
4940static int tls_prf_sha384( const unsigned char *secret, size_t slen,
4941 const char *label,
4942 const unsigned char *random, size_t rlen,
4943 unsigned char *dstbuf, size_t dlen )
4944{
4945 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
4946 label, random, rlen, dstbuf, dlen ) );
4947}
4948#endif /* MBEDTLS_SHA384_C */
4949
Jerry Yuf009d862022-02-17 14:01:37 +08004950/*
4951 * Set appropriate PRF function and other SSL / TLS1.2 functions
4952 *
4953 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08004954 * - hash associated with the ciphersuite (only used by TLS 1.2)
4955 *
4956 * Outputs:
4957 * - the tls_prf, calc_verify and calc_finished members of handshake structure
4958 */
4959static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08004960 mbedtls_md_type_t hash )
4961{
Jerry Yuf009d862022-02-17 14:01:37 +08004962#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01004963 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08004964 {
4965 handshake->tls_prf = tls_prf_sha384;
4966 handshake->calc_verify = ssl_calc_verify_tls_sha384;
4967 handshake->calc_finished = ssl_calc_finished_tls_sha384;
4968 }
4969 else
4970#endif
4971#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08004972 {
Ronald Cron81591aa2022-03-07 09:05:51 +01004973 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004974 handshake->tls_prf = tls_prf_sha256;
4975 handshake->calc_verify = ssl_calc_verify_tls_sha256;
4976 handshake->calc_finished = ssl_calc_finished_tls_sha256;
4977 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004978#else
Jerry Yuf009d862022-02-17 14:01:37 +08004979 {
Jerry Yuf009d862022-02-17 14:01:37 +08004980 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01004981 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08004982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4983 }
Ronald Cron81591aa2022-03-07 09:05:51 +01004984#endif
Jerry Yuf009d862022-02-17 14:01:37 +08004985
4986 return( 0 );
4987}
Jerry Yud6ab2352022-02-17 14:03:43 +08004988
4989#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) && \
4990 defined(MBEDTLS_USE_PSA_CRYPTO)
4991static int ssl_use_opaque_psk( mbedtls_ssl_context const *ssl )
4992{
4993 if( ssl->conf->f_psk != NULL )
4994 {
4995 /* If we've used a callback to select the PSK,
4996 * the static configuration is irrelevant. */
4997 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
4998 return( 1 );
4999
5000 return( 0 );
5001 }
5002
5003 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
5004 return( 1 );
5005
5006 return( 0 );
5007}
5008#endif /* MBEDTLS_USE_PSA_CRYPTO &&
5009 MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5010
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005011/*
5012 * Compute master secret if needed
5013 *
5014 * Parameters:
5015 * [in/out] handshake
5016 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5017 * (PSA-PSK) ciphersuite_info, psk_opaque
5018 * [out] premaster (cleared)
5019 * [out] master
5020 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5021 * debug: conf->f_dbg, conf->p_dbg
5022 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005023 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005024 */
5025static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5026 unsigned char *master,
5027 const mbedtls_ssl_context *ssl )
5028{
5029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5030
5031 /* cf. RFC 5246, Section 8.1:
5032 * "The master secret is always exactly 48 bytes in length." */
5033 size_t const master_secret_len = 48;
5034
5035#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5036 unsigned char session_hash[48];
5037#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5038
5039 /* The label for the KDF used for key expansion.
5040 * This is either "master secret" or "extended master secret"
5041 * depending on whether the Extended Master Secret extension
5042 * is used. */
5043 char const *lbl = "master secret";
5044
5045 /* The salt for the KDF used for key expansion.
5046 * - If the Extended Master Secret extension is not used,
5047 * this is ClientHello.Random + ServerHello.Random
5048 * (see Sect. 8.1 in RFC 5246).
5049 * - If the Extended Master Secret extension is used,
5050 * this is the transcript of the handshake so far.
5051 * (see Sect. 4 in RFC 7627). */
5052 unsigned char const *salt = handshake->randbytes;
5053 size_t salt_len = 64;
5054
5055#if !defined(MBEDTLS_DEBUG_C) && \
5056 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5057 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5058 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5059 ssl = NULL; /* make sure we don't use it except for those cases */
5060 (void) ssl;
5061#endif
5062
5063 if( handshake->resume != 0 )
5064 {
5065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5066 return( 0 );
5067 }
5068
5069#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5070 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5071 {
5072 lbl = "extended master secret";
5073 salt = session_hash;
5074 handshake->calc_verify( ssl, session_hash, &salt_len );
5075
5076 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
5077 session_hash, salt_len );
5078 }
5079#endif /* MBEDTLS_SSL_EXTENDED_MS_ENABLED */
5080
5081#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
5082 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5083 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_PSK &&
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005084 ssl_use_opaque_psk( ssl ) == 1 )
5085 {
5086 /* Perform PSK-to-MS expansion in a single step. */
5087 psa_status_t status;
5088 psa_algorithm_t alg;
5089 mbedtls_svc_key_id_t psk;
5090 psa_key_derivation_operation_t derivation =
5091 PSA_KEY_DERIVATION_OPERATION_INIT;
5092 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5093
5094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5095
5096 psk = mbedtls_ssl_get_opaque_psk( ssl );
5097
5098 if( hash_alg == MBEDTLS_MD_SHA384 )
5099 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5100 else
5101 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5102
5103 status = setup_psa_key_derivation( &derivation, psk, alg,
5104 salt, salt_len,
5105 (unsigned char const *) lbl,
5106 (size_t) strlen( lbl ),
5107 master_secret_len );
5108 if( status != PSA_SUCCESS )
5109 {
5110 psa_key_derivation_abort( &derivation );
5111 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5112 }
5113
5114 status = psa_key_derivation_output_bytes( &derivation,
5115 master,
5116 master_secret_len );
5117 if( status != PSA_SUCCESS )
5118 {
5119 psa_key_derivation_abort( &derivation );
5120 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5121 }
5122
5123 status = psa_key_derivation_abort( &derivation );
5124 if( status != PSA_SUCCESS )
5125 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5126 }
5127 else
5128#endif
5129 {
5130 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
5131 lbl, salt, salt_len,
5132 master,
5133 master_secret_len );
5134 if( ret != 0 )
5135 {
5136 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5137 return( ret );
5138 }
5139
5140 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5141 handshake->premaster,
5142 handshake->pmslen );
5143
5144 mbedtls_platform_zeroize( handshake->premaster,
5145 sizeof(handshake->premaster) );
5146 }
5147
5148 return( 0 );
5149}
5150
Jerry Yud62f87e2022-02-17 14:09:02 +08005151int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5152{
5153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5154 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5155 ssl->handshake->ciphersuite_info;
5156
5157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5158
5159 /* Set PRF, calc_verify and calc_finished function pointers */
5160 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005161 ciphersuite_info->mac );
5162 if( ret != 0 )
5163 {
5164 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5165 return( ret );
5166 }
5167
5168 /* Compute master secret if needed */
5169 ret = ssl_compute_master( ssl->handshake,
5170 ssl->session_negotiate->master,
5171 ssl );
5172 if( ret != 0 )
5173 {
5174 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5175 return( ret );
5176 }
5177
5178 /* Swap the client and server random values:
5179 * - MS derivation wanted client+server (RFC 5246 8.1)
5180 * - key derivation wants server+client (RFC 5246 6.3) */
5181 {
5182 unsigned char tmp[64];
5183 memcpy( tmp, ssl->handshake->randbytes, 64 );
5184 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5185 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5186 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5187 }
5188
5189 /* Populate transform structure */
5190 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5191 ssl->session_negotiate->ciphersuite,
5192 ssl->session_negotiate->master,
5193#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
5194 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5195 ssl->session_negotiate->encrypt_then_mac,
5196#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
5197 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
5198 ssl->handshake->tls_prf,
5199 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005200 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005201 ssl->conf->endpoint,
5202 ssl );
5203 if( ret != 0 )
5204 {
5205 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5206 return( ret );
5207 }
5208
5209 /* We no longer need Server/ClientHello.random values */
5210 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5211 sizeof( ssl->handshake->randbytes ) );
5212
5213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5214
5215 return( 0 );
5216}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005217
Ronald Cron4dcbca92022-03-07 10:21:40 +01005218int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5219{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005220 switch( md )
5221 {
5222#if defined(MBEDTLS_SHA384_C)
5223 case MBEDTLS_SSL_HASH_SHA384:
5224 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5225 break;
5226#endif
5227#if defined(MBEDTLS_SHA256_C)
5228 case MBEDTLS_SSL_HASH_SHA256:
5229 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5230 break;
5231#endif
5232 default:
5233 return( -1 );
5234 }
5235
Ronald Cronc2f13a02022-03-07 10:25:24 +01005236 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005237}
5238
Jerry Yu8392e0d2022-02-17 14:10:24 +08005239#if defined(MBEDTLS_SHA256_C)
5240void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5241 unsigned char *hash,
5242 size_t *hlen )
5243{
5244#if defined(MBEDTLS_USE_PSA_CRYPTO)
5245 size_t hash_size;
5246 psa_status_t status;
5247 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5248
5249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5250 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5251 if( status != PSA_SUCCESS )
5252 {
5253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5254 return;
5255 }
5256
5257 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5258 if( status != PSA_SUCCESS )
5259 {
5260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5261 return;
5262 }
5263
5264 *hlen = 32;
5265 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5267#else
5268 mbedtls_sha256_context sha256;
5269
5270 mbedtls_sha256_init( &sha256 );
5271
5272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5273
5274 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5275 mbedtls_sha256_finish( &sha256, hash );
5276
5277 *hlen = 32;
5278
5279 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5280 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5281
5282 mbedtls_sha256_free( &sha256 );
5283#endif /* MBEDTLS_USE_PSA_CRYPTO */
5284 return;
5285}
5286#endif /* MBEDTLS_SHA256_C */
5287
Jerry Yuc1cb3842022-02-17 14:13:48 +08005288#if defined(MBEDTLS_SHA384_C)
5289void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5290 unsigned char *hash,
5291 size_t *hlen )
5292{
5293#if defined(MBEDTLS_USE_PSA_CRYPTO)
5294 size_t hash_size;
5295 psa_status_t status;
5296 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5297
5298 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5299 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5300 if( status != PSA_SUCCESS )
5301 {
5302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5303 return;
5304 }
5305
5306 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5307 if( status != PSA_SUCCESS )
5308 {
5309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5310 return;
5311 }
5312
5313 *hlen = 48;
5314 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5315 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5316#else
5317 mbedtls_sha512_context sha512;
5318
5319 mbedtls_sha512_init( &sha512 );
5320
5321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5322
5323 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5324 mbedtls_sha512_finish( &sha512, hash );
5325
5326 *hlen = 48;
5327
5328 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5330
5331 mbedtls_sha512_free( &sha512 );
5332#endif /* MBEDTLS_USE_PSA_CRYPTO */
5333 return;
5334}
5335#endif /* MBEDTLS_SHA384_C */
5336
Jerry Yuce3dca42022-02-17 14:16:37 +08005337#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
5338int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5339{
5340 unsigned char *p = ssl->handshake->premaster;
5341 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5342 const unsigned char *psk = NULL;
5343 size_t psk_len = 0;
5344
5345 if( mbedtls_ssl_get_psk( ssl, &psk, &psk_len )
5346 == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
5347 {
5348 /*
5349 * This should never happen because the existence of a PSK is always
5350 * checked before calling this function
5351 */
5352 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5353 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5354 }
5355
5356 /*
5357 * PMS = struct {
5358 * opaque other_secret<0..2^16-1>;
5359 * opaque psk<0..2^16-1>;
5360 * };
5361 * with "other_secret" depending on the particular key exchange
5362 */
5363#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5364 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5365 {
5366 if( end - p < 2 )
5367 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5368
5369 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5370 p += 2;
5371
5372 if( end < p || (size_t)( end - p ) < psk_len )
5373 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5374
5375 memset( p, 0, psk_len );
5376 p += psk_len;
5377 }
5378 else
5379#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5380#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5381 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5382 {
5383 /*
5384 * other_secret already set by the ClientKeyExchange message,
5385 * and is 48 bytes long
5386 */
5387 if( end - p < 2 )
5388 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5389
5390 *p++ = 0;
5391 *p++ = 48;
5392 p += 48;
5393 }
5394 else
5395#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5396#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5397 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5398 {
5399 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5400 size_t len;
5401
5402 /* Write length only when we know the actual value */
5403 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5404 p + 2, end - ( p + 2 ), &len,
5405 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5406 {
5407 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5408 return( ret );
5409 }
5410 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5411 p += 2 + len;
5412
5413 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5414 }
5415 else
5416#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
5417#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
5418 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5419 {
5420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5421 size_t zlen;
5422
5423 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5424 p + 2, end - ( p + 2 ),
5425 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5426 {
5427 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5428 return( ret );
5429 }
5430
5431 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5432 p += 2 + zlen;
5433
5434 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5435 MBEDTLS_DEBUG_ECDH_Z );
5436 }
5437 else
5438#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
5439 {
5440 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5441 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5442 }
5443
5444 /* opaque psk<0..2^16-1>; */
5445 if( end - p < 2 )
5446 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5447
5448 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5449 p += 2;
5450
5451 if( end < p || (size_t)( end - p ) < psk_len )
5452 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5453
5454 memcpy( p, psk, psk_len );
5455 p += psk_len;
5456
5457 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5458
5459 return( 0 );
5460}
5461#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005462
5463#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
5464static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5465
5466#if defined(MBEDTLS_SSL_PROTO_DTLS)
5467int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5468{
5469 /* If renegotiation is not enforced, retransmit until we would reach max
5470 * timeout if we were using the usual handshake doubling scheme */
5471 if( ssl->conf->renego_max_records < 0 )
5472 {
5473 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5474 unsigned char doublings = 1;
5475
5476 while( ratio != 0 )
5477 {
5478 ++doublings;
5479 ratio >>= 1;
5480 }
5481
5482 if( ++ssl->renego_records_seen > doublings )
5483 {
5484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5485 return( 0 );
5486 }
5487 }
5488
5489 return( ssl_write_hello_request( ssl ) );
5490}
5491#endif
5492#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005493
Jerry Yud9526692022-02-17 14:23:47 +08005494/*
5495 * Handshake functions
5496 */
5497#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5498/* No certificate support -> dummy functions */
5499int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5500{
5501 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5502 ssl->handshake->ciphersuite_info;
5503
5504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5505
5506 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5507 {
5508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5509 ssl->state++;
5510 return( 0 );
5511 }
5512
5513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5515}
5516
5517int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5518{
5519 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5520 ssl->handshake->ciphersuite_info;
5521
5522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5523
5524 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5525 {
5526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5527 ssl->state++;
5528 return( 0 );
5529 }
5530
5531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5532 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5533}
5534
5535#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5536/* Some certificate support -> implement write and parse */
5537
5538int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5539{
5540 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5541 size_t i, n;
5542 const mbedtls_x509_crt *crt;
5543 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5544 ssl->handshake->ciphersuite_info;
5545
5546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5547
5548 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5549 {
5550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5551 ssl->state++;
5552 return( 0 );
5553 }
5554
5555#if defined(MBEDTLS_SSL_CLI_C)
5556 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5557 {
5558 if( ssl->handshake->client_auth == 0 )
5559 {
5560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5561 ssl->state++;
5562 return( 0 );
5563 }
5564 }
5565#endif /* MBEDTLS_SSL_CLI_C */
5566#if defined(MBEDTLS_SSL_SRV_C)
5567 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5568 {
5569 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5570 {
5571 /* Should never happen because we shouldn't have picked the
5572 * ciphersuite if we don't have a certificate. */
5573 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5574 }
5575 }
5576#endif
5577
5578 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5579
5580 /*
5581 * 0 . 0 handshake type
5582 * 1 . 3 handshake length
5583 * 4 . 6 length of all certs
5584 * 7 . 9 length of cert. 1
5585 * 10 . n-1 peer certificate
5586 * n . n+2 length of cert. 2
5587 * n+3 . ... upper level cert, etc.
5588 */
5589 i = 7;
5590 crt = mbedtls_ssl_own_cert( ssl );
5591
5592 while( crt != NULL )
5593 {
5594 n = crt->raw.len;
5595 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5596 {
5597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5598 " > %" MBEDTLS_PRINTF_SIZET,
5599 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5600 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5601 }
5602
5603 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5604 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5605 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5606
5607 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5608 i += n; crt = crt->next;
5609 }
5610
5611 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5612 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5613 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5614
5615 ssl->out_msglen = i;
5616 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5617 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5618
5619 ssl->state++;
5620
5621 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5622 {
5623 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5624 return( ret );
5625 }
5626
5627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5628
5629 return( ret );
5630}
5631
5632#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5633
5634#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5635static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5636 unsigned char *crt_buf,
5637 size_t crt_buf_len )
5638{
5639 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
5640
5641 if( peer_crt == NULL )
5642 return( -1 );
5643
5644 if( peer_crt->raw.len != crt_buf_len )
5645 return( -1 );
5646
5647 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
5648}
5649#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5650static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
5651 unsigned char *crt_buf,
5652 size_t crt_buf_len )
5653{
5654 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5655 unsigned char const * const peer_cert_digest =
5656 ssl->session->peer_cert_digest;
5657 mbedtls_md_type_t const peer_cert_digest_type =
5658 ssl->session->peer_cert_digest_type;
5659 mbedtls_md_info_t const * const digest_info =
5660 mbedtls_md_info_from_type( peer_cert_digest_type );
5661 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
5662 size_t digest_len;
5663
5664 if( peer_cert_digest == NULL || digest_info == NULL )
5665 return( -1 );
5666
5667 digest_len = mbedtls_md_get_size( digest_info );
5668 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
5669 return( -1 );
5670
5671 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
5672 if( ret != 0 )
5673 return( -1 );
5674
5675 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
5676}
5677#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5678#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5679
5680/*
5681 * Once the certificate message is read, parse it into a cert chain and
5682 * perform basic checks, but leave actual verification to the caller
5683 */
5684static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
5685 mbedtls_x509_crt *chain )
5686{
5687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5688#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5689 int crt_cnt=0;
5690#endif
5691 size_t i, n;
5692 uint8_t alert;
5693
5694 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
5695 {
5696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5697 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5698 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5699 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5700 }
5701
5702 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
5703 {
5704 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5705 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5706 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5707 }
5708
5709 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
5710 {
5711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5712 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5713 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5714 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5715 }
5716
5717 i = mbedtls_ssl_hs_hdr_len( ssl );
5718
5719 /*
5720 * Same message structure as in mbedtls_ssl_write_certificate()
5721 */
5722 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
5723
5724 if( ssl->in_msg[i] != 0 ||
5725 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
5726 {
5727 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5728 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5729 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5730 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5731 }
5732
5733 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
5734 i += 3;
5735
5736 /* Iterate through and parse the CRTs in the provided chain. */
5737 while( i < ssl->in_hslen )
5738 {
5739 /* Check that there's room for the next CRT's length fields. */
5740 if ( i + 3 > ssl->in_hslen ) {
5741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5742 mbedtls_ssl_send_alert_message( ssl,
5743 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5744 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5745 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5746 }
5747 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
5748 * anything beyond 2**16 ~ 64K. */
5749 if( ssl->in_msg[i] != 0 )
5750 {
5751 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5752 mbedtls_ssl_send_alert_message( ssl,
5753 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5754 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
5755 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5756 }
5757
5758 /* Read length of the next CRT in the chain. */
5759 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
5760 | (unsigned int) ssl->in_msg[i + 2];
5761 i += 3;
5762
5763 if( n < 128 || i + n > ssl->in_hslen )
5764 {
5765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
5766 mbedtls_ssl_send_alert_message( ssl,
5767 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5768 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
5769 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5770 }
5771
5772 /* Check if we're handling the first CRT in the chain. */
5773#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5774 if( crt_cnt++ == 0 &&
5775 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5776 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
5777 {
5778 /* During client-side renegotiation, check that the server's
5779 * end-CRTs hasn't changed compared to the initial handshake,
5780 * mitigating the triple handshake attack. On success, reuse
5781 * the original end-CRT instead of parsing it again. */
5782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
5783 if( ssl_check_peer_crt_unchanged( ssl,
5784 &ssl->in_msg[i],
5785 n ) != 0 )
5786 {
5787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
5788 mbedtls_ssl_send_alert_message( ssl,
5789 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5790 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
5791 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
5792 }
5793
5794 /* Now we can safely free the original chain. */
5795 ssl_clear_peer_cert( ssl->session );
5796 }
5797#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
5798
5799 /* Parse the next certificate in the chain. */
5800#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
5801 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
5802#else
5803 /* If we don't need to store the CRT chain permanently, parse
5804 * it in-place from the input buffer instead of making a copy. */
5805 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
5806#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
5807 switch( ret )
5808 {
5809 case 0: /*ok*/
5810 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
5811 /* Ignore certificate with an unknown algorithm: maybe a
5812 prior certificate was already trusted. */
5813 break;
5814
5815 case MBEDTLS_ERR_X509_ALLOC_FAILED:
5816 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
5817 goto crt_parse_der_failed;
5818
5819 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
5820 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
5821 goto crt_parse_der_failed;
5822
5823 default:
5824 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
5825 crt_parse_der_failed:
5826 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
5827 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
5828 return( ret );
5829 }
5830
5831 i += n;
5832 }
5833
5834 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
5835 return( 0 );
5836}
5837
5838#if defined(MBEDTLS_SSL_SRV_C)
5839static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
5840{
5841 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5842 return( -1 );
5843
5844 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
5845 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
5846 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
5847 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
5848 {
5849 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLSv1 client has no certificate" ) );
5850 return( 0 );
5851 }
5852 return( -1 );
5853}
5854#endif /* MBEDTLS_SSL_SRV_C */
5855
5856/* Check if a certificate message is expected.
5857 * Return either
5858 * - SSL_CERTIFICATE_EXPECTED, or
5859 * - SSL_CERTIFICATE_SKIP
5860 * indicating whether a Certificate message is expected or not.
5861 */
5862#define SSL_CERTIFICATE_EXPECTED 0
5863#define SSL_CERTIFICATE_SKIP 1
5864static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
5865 int authmode )
5866{
5867 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5868 ssl->handshake->ciphersuite_info;
5869
5870 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5871 return( SSL_CERTIFICATE_SKIP );
5872
5873#if defined(MBEDTLS_SSL_SRV_C)
5874 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5875 {
5876 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5877 return( SSL_CERTIFICATE_SKIP );
5878
5879 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5880 {
5881 ssl->session_negotiate->verify_result =
5882 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
5883 return( SSL_CERTIFICATE_SKIP );
5884 }
5885 }
5886#else
5887 ((void) authmode);
5888#endif /* MBEDTLS_SSL_SRV_C */
5889
5890 return( SSL_CERTIFICATE_EXPECTED );
5891}
5892
5893static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
5894 int authmode,
5895 mbedtls_x509_crt *chain,
5896 void *rs_ctx )
5897{
5898 int ret = 0;
5899 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5900 ssl->handshake->ciphersuite_info;
5901 int have_ca_chain = 0;
5902
5903 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
5904 void *p_vrfy;
5905
5906 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
5907 return( 0 );
5908
5909 if( ssl->f_vrfy != NULL )
5910 {
5911 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
5912 f_vrfy = ssl->f_vrfy;
5913 p_vrfy = ssl->p_vrfy;
5914 }
5915 else
5916 {
5917 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
5918 f_vrfy = ssl->conf->f_vrfy;
5919 p_vrfy = ssl->conf->p_vrfy;
5920 }
5921
5922 /*
5923 * Main check: verify certificate
5924 */
5925#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
5926 if( ssl->conf->f_ca_cb != NULL )
5927 {
5928 ((void) rs_ctx);
5929 have_ca_chain = 1;
5930
5931 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
5932 ret = mbedtls_x509_crt_verify_with_ca_cb(
5933 chain,
5934 ssl->conf->f_ca_cb,
5935 ssl->conf->p_ca_cb,
5936 ssl->conf->cert_profile,
5937 ssl->hostname,
5938 &ssl->session_negotiate->verify_result,
5939 f_vrfy, p_vrfy );
5940 }
5941 else
5942#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
5943 {
5944 mbedtls_x509_crt *ca_chain;
5945 mbedtls_x509_crl *ca_crl;
5946
5947#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
5948 if( ssl->handshake->sni_ca_chain != NULL )
5949 {
5950 ca_chain = ssl->handshake->sni_ca_chain;
5951 ca_crl = ssl->handshake->sni_ca_crl;
5952 }
5953 else
5954#endif
5955 {
5956 ca_chain = ssl->conf->ca_chain;
5957 ca_crl = ssl->conf->ca_crl;
5958 }
5959
5960 if( ca_chain != NULL )
5961 have_ca_chain = 1;
5962
5963 ret = mbedtls_x509_crt_verify_restartable(
5964 chain,
5965 ca_chain, ca_crl,
5966 ssl->conf->cert_profile,
5967 ssl->hostname,
5968 &ssl->session_negotiate->verify_result,
5969 f_vrfy, p_vrfy, rs_ctx );
5970 }
5971
5972 if( ret != 0 )
5973 {
5974 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
5975 }
5976
5977#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
5978 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
5979 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
5980#endif
5981
5982 /*
5983 * Secondary checks: always done, but change 'ret' only if it was 0
5984 */
5985
5986#if defined(MBEDTLS_ECP_C)
5987 {
5988 const mbedtls_pk_context *pk = &chain->pk;
5989
5990 /* If certificate uses an EC key, make sure the curve is OK */
5991 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
5992 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
5993 {
5994 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
5995
5996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
5997 if( ret == 0 )
5998 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
5999 }
6000 }
6001#endif /* MBEDTLS_ECP_C */
6002
6003 if( mbedtls_ssl_check_cert_usage( chain,
6004 ciphersuite_info,
6005 ! ssl->conf->endpoint,
6006 &ssl->session_negotiate->verify_result ) != 0 )
6007 {
6008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6009 if( ret == 0 )
6010 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6011 }
6012
6013 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6014 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6015 * with details encoded in the verification flags. All other kinds
6016 * of error codes, including those from the user provided f_vrfy
6017 * functions, are treated as fatal and lead to a failure of
6018 * ssl_parse_certificate even if verification was optional. */
6019 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6020 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6021 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6022 {
6023 ret = 0;
6024 }
6025
6026 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6027 {
6028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6029 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6030 }
6031
6032 if( ret != 0 )
6033 {
6034 uint8_t alert;
6035
6036 /* The certificate may have been rejected for several reasons.
6037 Pick one and send the corresponding alert. Which alert to send
6038 may be a subject of debate in some cases. */
6039 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6040 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6041 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6042 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6043 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6044 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6045 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6046 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6047 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6048 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6049 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6050 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6051 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6052 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6053 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6054 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6055 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6056 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6057 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6058 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6059 else
6060 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6061 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6062 alert );
6063 }
6064
6065#if defined(MBEDTLS_DEBUG_C)
6066 if( ssl->session_negotiate->verify_result != 0 )
6067 {
6068 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6069 (unsigned int) ssl->session_negotiate->verify_result ) );
6070 }
6071 else
6072 {
6073 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6074 }
6075#endif /* MBEDTLS_DEBUG_C */
6076
6077 return( ret );
6078}
6079
6080#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6081static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6082 unsigned char *start, size_t len )
6083{
6084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6085 /* Remember digest of the peer's end-CRT. */
6086 ssl->session_negotiate->peer_cert_digest =
6087 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6088 if( ssl->session_negotiate->peer_cert_digest == NULL )
6089 {
6090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6091 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6092 mbedtls_ssl_send_alert_message( ssl,
6093 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6094 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6095
6096 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6097 }
6098
6099 ret = mbedtls_md( mbedtls_md_info_from_type(
6100 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6101 start, len,
6102 ssl->session_negotiate->peer_cert_digest );
6103
6104 ssl->session_negotiate->peer_cert_digest_type =
6105 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6106 ssl->session_negotiate->peer_cert_digest_len =
6107 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6108
6109 return( ret );
6110}
6111
6112static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6113 unsigned char *start, size_t len )
6114{
6115 unsigned char *end = start + len;
6116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6117
6118 /* Make a copy of the peer's raw public key. */
6119 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6120 ret = mbedtls_pk_parse_subpubkey( &start, end,
6121 &ssl->handshake->peer_pubkey );
6122 if( ret != 0 )
6123 {
6124 /* We should have parsed the public key before. */
6125 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6126 }
6127
6128 return( 0 );
6129}
6130#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6131
6132int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6133{
6134 int ret = 0;
6135 int crt_expected;
6136#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6137 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6138 ? ssl->handshake->sni_authmode
6139 : ssl->conf->authmode;
6140#else
6141 const int authmode = ssl->conf->authmode;
6142#endif
6143 void *rs_ctx = NULL;
6144 mbedtls_x509_crt *chain = NULL;
6145
6146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6147
6148 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6149 if( crt_expected == SSL_CERTIFICATE_SKIP )
6150 {
6151 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6152 goto exit;
6153 }
6154
6155#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6156 if( ssl->handshake->ecrs_enabled &&
6157 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6158 {
6159 chain = ssl->handshake->ecrs_peer_cert;
6160 ssl->handshake->ecrs_peer_cert = NULL;
6161 goto crt_verify;
6162 }
6163#endif
6164
6165 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6166 {
6167 /* mbedtls_ssl_read_record may have sent an alert already. We
6168 let it decide whether to alert. */
6169 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6170 goto exit;
6171 }
6172
6173#if defined(MBEDTLS_SSL_SRV_C)
6174 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6175 {
6176 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6177
6178 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6179 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6180
6181 goto exit;
6182 }
6183#endif /* MBEDTLS_SSL_SRV_C */
6184
6185 /* Clear existing peer CRT structure in case we tried to
6186 * reuse a session but it failed, and allocate a new one. */
6187 ssl_clear_peer_cert( ssl->session_negotiate );
6188
6189 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6190 if( chain == NULL )
6191 {
6192 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6193 sizeof( mbedtls_x509_crt ) ) );
6194 mbedtls_ssl_send_alert_message( ssl,
6195 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6196 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6197
6198 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6199 goto exit;
6200 }
6201 mbedtls_x509_crt_init( chain );
6202
6203 ret = ssl_parse_certificate_chain( ssl, chain );
6204 if( ret != 0 )
6205 goto exit;
6206
6207#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6208 if( ssl->handshake->ecrs_enabled)
6209 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6210
6211crt_verify:
6212 if( ssl->handshake->ecrs_enabled)
6213 rs_ctx = &ssl->handshake->ecrs_ctx;
6214#endif
6215
6216 ret = ssl_parse_certificate_verify( ssl, authmode,
6217 chain, rs_ctx );
6218 if( ret != 0 )
6219 goto exit;
6220
6221#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6222 {
6223 unsigned char *crt_start, *pk_start;
6224 size_t crt_len, pk_len;
6225
6226 /* We parse the CRT chain without copying, so
6227 * these pointers point into the input buffer,
6228 * and are hence still valid after freeing the
6229 * CRT chain. */
6230
6231 crt_start = chain->raw.p;
6232 crt_len = chain->raw.len;
6233
6234 pk_start = chain->pk_raw.p;
6235 pk_len = chain->pk_raw.len;
6236
6237 /* Free the CRT structures before computing
6238 * digest and copying the peer's public key. */
6239 mbedtls_x509_crt_free( chain );
6240 mbedtls_free( chain );
6241 chain = NULL;
6242
6243 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6244 if( ret != 0 )
6245 goto exit;
6246
6247 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6248 if( ret != 0 )
6249 goto exit;
6250 }
6251#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6252 /* Pass ownership to session structure. */
6253 ssl->session_negotiate->peer_cert = chain;
6254 chain = NULL;
6255#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6256
6257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6258
6259exit:
6260
6261 if( ret == 0 )
6262 ssl->state++;
6263
6264#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6265 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6266 {
6267 ssl->handshake->ecrs_peer_cert = chain;
6268 chain = NULL;
6269 }
6270#endif
6271
6272 if( chain != NULL )
6273 {
6274 mbedtls_x509_crt_free( chain );
6275 mbedtls_free( chain );
6276 }
6277
6278 return( ret );
6279}
6280#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6281
Jerry Yu615bd6f2022-02-17 14:25:15 +08006282#if defined(MBEDTLS_SHA256_C)
6283static void ssl_calc_finished_tls_sha256(
6284 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6285{
6286 int len = 12;
6287 const char *sender;
6288 unsigned char padbuf[32];
6289#if defined(MBEDTLS_USE_PSA_CRYPTO)
6290 size_t hash_size;
6291 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6292 psa_status_t status;
6293#else
6294 mbedtls_sha256_context sha256;
6295#endif
6296
6297 mbedtls_ssl_session *session = ssl->session_negotiate;
6298 if( !session )
6299 session = ssl->session;
6300
6301 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6302 ? "client finished"
6303 : "server finished";
6304
6305#if defined(MBEDTLS_USE_PSA_CRYPTO)
6306 sha256_psa = psa_hash_operation_init();
6307
6308 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6309
6310 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6311 if( status != PSA_SUCCESS )
6312 {
6313 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6314 return;
6315 }
6316
6317 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6318 if( status != PSA_SUCCESS )
6319 {
6320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6321 return;
6322 }
6323 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6324#else
6325
6326 mbedtls_sha256_init( &sha256 );
6327
6328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6329
6330 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6331
6332 /*
6333 * TLSv1.2:
6334 * hash = PRF( master, finished_label,
6335 * Hash( handshake ) )[0.11]
6336 */
6337
6338#if !defined(MBEDTLS_SHA256_ALT)
6339 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6340 sha256.state, sizeof( sha256.state ) );
6341#endif
6342
6343 mbedtls_sha256_finish( &sha256, padbuf );
6344 mbedtls_sha256_free( &sha256 );
6345#endif /* MBEDTLS_USE_PSA_CRYPTO */
6346
6347 ssl->handshake->tls_prf( session->master, 48, sender,
6348 padbuf, 32, buf, len );
6349
6350 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6351
6352 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6353
6354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6355}
6356#endif /* MBEDTLS_SHA256_C */
6357
Jerry Yub7ba49e2022-02-17 14:25:53 +08006358
6359#if defined(MBEDTLS_SHA384_C)
6360
6361static void ssl_calc_finished_tls_sha384(
6362 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6363{
6364 int len = 12;
6365 const char *sender;
6366 unsigned char padbuf[48];
6367#if defined(MBEDTLS_USE_PSA_CRYPTO)
6368 size_t hash_size;
6369 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6370 psa_status_t status;
6371#else
6372 mbedtls_sha512_context sha512;
6373#endif
6374
6375 mbedtls_ssl_session *session = ssl->session_negotiate;
6376 if( !session )
6377 session = ssl->session;
6378
6379 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6380 ? "client finished"
6381 : "server finished";
6382
6383#if defined(MBEDTLS_USE_PSA_CRYPTO)
6384 sha384_psa = psa_hash_operation_init();
6385
6386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6387
6388 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6389 if( status != PSA_SUCCESS )
6390 {
6391 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6392 return;
6393 }
6394
6395 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6396 if( status != PSA_SUCCESS )
6397 {
6398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6399 return;
6400 }
6401 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6402#else
6403 mbedtls_sha512_init( &sha512 );
6404
6405 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6406
6407 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6408
6409 /*
6410 * TLSv1.2:
6411 * hash = PRF( master, finished_label,
6412 * Hash( handshake ) )[0.11]
6413 */
6414
6415#if !defined(MBEDTLS_SHA512_ALT)
6416 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6417 sha512.state, sizeof( sha512.state ) );
6418#endif
6419 mbedtls_sha512_finish( &sha512, padbuf );
6420
6421 mbedtls_sha512_free( &sha512 );
6422#endif
6423
6424 ssl->handshake->tls_prf( session->master, 48, sender,
6425 padbuf, 48, buf, len );
6426
6427 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6428
6429 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6430
6431 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6432}
6433#endif /* MBEDTLS_SHA384_C */
6434
Jerry Yuaef00152022-02-17 14:27:31 +08006435void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6436{
6437 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6438
6439 /*
6440 * Free our handshake params
6441 */
6442 mbedtls_ssl_handshake_free( ssl );
6443 mbedtls_free( ssl->handshake );
6444 ssl->handshake = NULL;
6445
6446 /*
6447 * Free the previous transform and swith in the current one
6448 */
6449 if( ssl->transform )
6450 {
6451 mbedtls_ssl_transform_free( ssl->transform );
6452 mbedtls_free( ssl->transform );
6453 }
6454 ssl->transform = ssl->transform_negotiate;
6455 ssl->transform_negotiate = NULL;
6456
6457 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6458}
6459
Jerry Yu2a9fff52022-02-17 14:28:51 +08006460void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6461{
6462 int resume = ssl->handshake->resume;
6463
6464 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6465
6466#if defined(MBEDTLS_SSL_RENEGOTIATION)
6467 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6468 {
6469 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6470 ssl->renego_records_seen = 0;
6471 }
6472#endif
6473
6474 /*
6475 * Free the previous session and switch in the current one
6476 */
6477 if( ssl->session )
6478 {
6479#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6480 /* RFC 7366 3.1: keep the EtM state */
6481 ssl->session_negotiate->encrypt_then_mac =
6482 ssl->session->encrypt_then_mac;
6483#endif
6484
6485 mbedtls_ssl_session_free( ssl->session );
6486 mbedtls_free( ssl->session );
6487 }
6488 ssl->session = ssl->session_negotiate;
6489 ssl->session_negotiate = NULL;
6490
6491 /*
6492 * Add cache entry
6493 */
6494 if( ssl->conf->f_set_cache != NULL &&
6495 ssl->session->id_len != 0 &&
6496 resume == 0 )
6497 {
6498 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6499 ssl->session->id,
6500 ssl->session->id_len,
6501 ssl->session ) != 0 )
6502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6503 }
6504
6505#if defined(MBEDTLS_SSL_PROTO_DTLS)
6506 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6507 ssl->handshake->flight != NULL )
6508 {
6509 /* Cancel handshake timer */
6510 mbedtls_ssl_set_timer( ssl, 0 );
6511
6512 /* Keep last flight around in case we need to resend it:
6513 * we need the handshake and transform structures for that */
6514 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6515 }
6516 else
6517#endif
6518 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6519
6520 ssl->state++;
6521
6522 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6523}
6524
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006525int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6526{
6527 int ret, hash_len;
6528
6529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6530
6531 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6532
6533 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6534
6535 /*
6536 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6537 * may define some other value. Currently (early 2016), no defined
6538 * ciphersuite does this (and this is unlikely to change as activity has
6539 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6540 */
6541 hash_len = 12;
6542
6543#if defined(MBEDTLS_SSL_RENEGOTIATION)
6544 ssl->verify_data_len = hash_len;
6545 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6546#endif
6547
6548 ssl->out_msglen = 4 + hash_len;
6549 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6550 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6551
6552 /*
6553 * In case of session resuming, invert the client and server
6554 * ChangeCipherSpec messages order.
6555 */
6556 if( ssl->handshake->resume != 0 )
6557 {
6558#if defined(MBEDTLS_SSL_CLI_C)
6559 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6560 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6561#endif
6562#if defined(MBEDTLS_SSL_SRV_C)
6563 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6564 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6565#endif
6566 }
6567 else
6568 ssl->state++;
6569
6570 /*
6571 * Switch to our negotiated transform and session parameters for outbound
6572 * data.
6573 */
6574 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6575
6576#if defined(MBEDTLS_SSL_PROTO_DTLS)
6577 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6578 {
6579 unsigned char i;
6580
6581 /* Remember current epoch settings for resending */
6582 ssl->handshake->alt_transform_out = ssl->transform_out;
6583 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6584 sizeof( ssl->handshake->alt_out_ctr ) );
6585
6586 /* Set sequence_number to zero */
6587 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6588
6589
6590 /* Increment epoch */
6591 for( i = 2; i > 0; i-- )
6592 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6593 break;
6594
6595 /* The loop goes to its end iff the counter is wrapping */
6596 if( i == 0 )
6597 {
6598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6599 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6600 }
6601 }
6602 else
6603#endif /* MBEDTLS_SSL_PROTO_DTLS */
6604 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6605
6606 ssl->transform_out = ssl->transform_negotiate;
6607 ssl->session_out = ssl->session_negotiate;
6608
6609#if defined(MBEDTLS_SSL_PROTO_DTLS)
6610 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6611 mbedtls_ssl_send_flight_completed( ssl );
6612#endif
6613
6614 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6615 {
6616 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6617 return( ret );
6618 }
6619
6620#if defined(MBEDTLS_SSL_PROTO_DTLS)
6621 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6622 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6623 {
6624 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
6625 return( ret );
6626 }
6627#endif
6628
6629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
6630
6631 return( 0 );
6632}
6633
Jerry Yu0b3d7c12022-02-17 14:30:51 +08006634#define SSL_MAX_HASH_LEN 12
6635
6636int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
6637{
6638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6639 unsigned int hash_len = 12;
6640 unsigned char buf[SSL_MAX_HASH_LEN];
6641
6642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
6643
6644 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
6645
6646 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6647 {
6648 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6649 goto exit;
6650 }
6651
6652 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6653 {
6654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6655 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6656 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6657 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6658 goto exit;
6659 }
6660
6661 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
6662 {
6663 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6664 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6665 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
6666 goto exit;
6667 }
6668
6669 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
6670 {
6671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6672 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6673 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6674 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
6675 goto exit;
6676 }
6677
6678 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
6679 buf, hash_len ) != 0 )
6680 {
6681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
6682 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6683 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
6684 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
6685 goto exit;
6686 }
6687
6688#if defined(MBEDTLS_SSL_RENEGOTIATION)
6689 ssl->verify_data_len = hash_len;
6690 memcpy( ssl->peer_verify_data, buf, hash_len );
6691#endif
6692
6693 if( ssl->handshake->resume != 0 )
6694 {
6695#if defined(MBEDTLS_SSL_CLI_C)
6696 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6697 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6698#endif
6699#if defined(MBEDTLS_SSL_SRV_C)
6700 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6701 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6702#endif
6703 }
6704 else
6705 ssl->state++;
6706
6707#if defined(MBEDTLS_SSL_PROTO_DTLS)
6708 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6709 mbedtls_ssl_recv_flight_completed( ssl );
6710#endif
6711
6712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
6713
6714exit:
6715 mbedtls_platform_zeroize( buf, hash_len );
6716 return( ret );
6717}
6718
Jerry Yu392112c2022-02-17 14:34:10 +08006719#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6720/*
6721 * Helper to get TLS 1.2 PRF from ciphersuite
6722 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
6723 */
6724static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
6725{
6726#if defined(MBEDTLS_SHA384_C)
6727 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6728 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
6729
6730 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
6731 return( tls_prf_sha384 );
6732#else
6733 (void) ciphersuite_id;
6734#endif
6735 return( tls_prf_sha256 );
6736}
6737#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08006738
6739static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
6740{
6741 ((void) tls_prf);
6742#if defined(MBEDTLS_SHA384_C)
6743 if( tls_prf == tls_prf_sha384 )
6744 {
6745 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
6746 }
6747 else
6748#endif
6749#if defined(MBEDTLS_SHA256_C)
6750 if( tls_prf == tls_prf_sha256 )
6751 {
6752 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
6753 }
6754 else
6755#endif
6756 return( MBEDTLS_SSL_TLS_PRF_NONE );
6757}
6758
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006759/*
6760 * Populate a transform structure with session keys and all the other
6761 * necessary information.
6762 *
6763 * Parameters:
6764 * - [in/out]: transform: structure to populate
6765 * [in] must be just initialised with mbedtls_ssl_transform_init()
6766 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
6767 * - [in] ciphersuite
6768 * - [in] master
6769 * - [in] encrypt_then_mac
6770 * - [in] compression
6771 * - [in] tls_prf: pointer to PRF to use for key derivation
6772 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04006773 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006774 * - [in] endpoint: client or server
6775 * - [in] ssl: used for:
6776 * - ssl->conf->{f,p}_export_keys
6777 * [in] optionally used for:
6778 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
6779 */
6780static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
6781 int ciphersuite,
6782 const unsigned char master[48],
6783#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC) && \
6784 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6785 int encrypt_then_mac,
6786#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC &&
6787 MBEDTLS_SSL_SOME_SUITES_USE_MAC */
6788 ssl_tls_prf_t tls_prf,
6789 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04006790 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006791 unsigned endpoint,
6792 const mbedtls_ssl_context *ssl )
6793{
6794 int ret = 0;
6795 unsigned char keyblk[256];
6796 unsigned char *key1;
6797 unsigned char *key2;
6798 unsigned char *mac_enc;
6799 unsigned char *mac_dec;
6800 size_t mac_key_len = 0;
6801 size_t iv_copy_len;
6802 size_t keylen;
6803 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
6804 const mbedtls_cipher_info_t *cipher_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006805#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006806 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01006807#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006808
6809#if defined(MBEDTLS_USE_PSA_CRYPTO)
6810 psa_key_type_t key_type;
6811 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6812 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01006813 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006814 size_t key_bits;
6815 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6816#endif
6817
6818#if !defined(MBEDTLS_DEBUG_C) && \
6819 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6820 if( ssl->f_export_keys == NULL )
6821 {
6822 ssl = NULL; /* make sure we don't use it except for these cases */
6823 (void) ssl;
6824 }
6825#endif
6826
6827 /*
6828 * Some data just needs copying into the structure
6829 */
6830#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) && \
6831 defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6832 transform->encrypt_then_mac = encrypt_then_mac;
6833#endif
Glenn Strauss07c64162022-03-14 12:34:51 -04006834 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006835
6836#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
6837 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
6838#endif
6839
6840#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04006841 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006842 {
6843 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
6844 * generation separate. This should never happen. */
6845 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6846 }
6847#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
6848
6849 /*
6850 * Get various info structures
6851 */
6852 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
6853 if( ciphersuite_info == NULL )
6854 {
6855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
6856 ciphersuite ) );
6857 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6858 }
6859
6860 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
6861 if( cipher_info == NULL )
6862 {
6863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
6864 ciphersuite_info->cipher ) );
6865 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6866 }
6867
Neil Armstronge4512952022-03-08 09:08:22 +01006868#if defined(MBEDTLS_USE_PSA_CRYPTO)
6869 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
6870 if( mac_alg == 0 )
6871 {
6872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
6873 (unsigned) ciphersuite_info->mac ) );
6874 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6875 }
6876#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006877 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
6878 if( md_info == NULL )
6879 {
6880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
6881 (unsigned) ciphersuite_info->mac ) );
6882 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6883 }
Neil Armstronge4512952022-03-08 09:08:22 +01006884#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006885
6886#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
6887 /* Copy own and peer's CID if the use of the CID
6888 * extension has been negotiated. */
6889 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
6890 {
6891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
6892
6893 transform->in_cid_len = ssl->own_cid_len;
6894 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
6895 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
6896 transform->in_cid_len );
6897
6898 transform->out_cid_len = ssl->handshake->peer_cid_len;
6899 memcpy( transform->out_cid, ssl->handshake->peer_cid,
6900 ssl->handshake->peer_cid_len );
6901 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
6902 transform->out_cid_len );
6903 }
6904#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
6905
6906 /*
6907 * Compute key block using the PRF
6908 */
6909 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
6910 if( ret != 0 )
6911 {
6912 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6913 return( ret );
6914 }
6915
6916 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
6917 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
6918 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
6919 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
6920 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
6921
6922 /*
6923 * Determine the appropriate key, IV and MAC length.
6924 */
6925
6926 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
6927
6928#if defined(MBEDTLS_GCM_C) || \
6929 defined(MBEDTLS_CCM_C) || \
6930 defined(MBEDTLS_CHACHAPOLY_C)
6931 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_GCM ||
6932 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CCM ||
6933 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6934 {
6935 size_t explicit_ivlen;
6936
6937 transform->maclen = 0;
6938 mac_key_len = 0;
6939 transform->taglen =
6940 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
6941
6942 /* All modes haves 96-bit IVs, but the length of the static parts vary
6943 * with mode and version:
6944 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
6945 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
6946 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
6947 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
6948 * sequence number).
6949 */
6950 transform->ivlen = 12;
6951 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
6952 transform->fixed_ivlen = 12;
6953 else
6954 transform->fixed_ivlen = 4;
6955
6956 /* Minimum length of encrypted record */
6957 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
6958 transform->minlen = explicit_ivlen + transform->taglen;
6959 }
6960 else
6961#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
6962#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
6963 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM ||
6964 mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
6965 {
Neil Armstronge4512952022-03-08 09:08:22 +01006966#if defined(MBEDTLS_USE_PSA_CRYPTO)
6967 /* Get MAC length */
6968 mac_key_len = PSA_HASH_LENGTH(mac_alg);
6969#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006970 /* Initialize HMAC contexts */
6971 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
6972 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
6973 {
6974 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
6975 goto end;
6976 }
6977
6978 /* Get MAC length */
6979 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01006980#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08006981 transform->maclen = mac_key_len;
6982
6983 /* IV length */
6984 transform->ivlen = cipher_info->iv_size;
6985
6986 /* Minimum length */
6987 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_STREAM )
6988 transform->minlen = transform->maclen;
6989 else
6990 {
6991 /*
6992 * GenericBlockCipher:
6993 * 1. if EtM is in use: one block plus MAC
6994 * otherwise: * first multiple of blocklen greater than maclen
6995 * 2. IV
6996 */
6997#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6998 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
6999 {
7000 transform->minlen = transform->maclen
7001 + cipher_info->block_size;
7002 }
7003 else
7004#endif
7005 {
7006 transform->minlen = transform->maclen
7007 + cipher_info->block_size
7008 - transform->maclen % cipher_info->block_size;
7009 }
7010
Glenn Strauss07c64162022-03-14 12:34:51 -04007011 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007012 {
7013 transform->minlen += transform->ivlen;
7014 }
7015 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007016 {
7017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7018 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7019 goto end;
7020 }
7021 }
7022 }
7023 else
7024#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7025 {
7026 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7027 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7028 }
7029
7030 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7031 (unsigned) keylen,
7032 (unsigned) transform->minlen,
7033 (unsigned) transform->ivlen,
7034 (unsigned) transform->maclen ) );
7035
7036 /*
7037 * Finally setup the cipher contexts, IVs and MAC secrets.
7038 */
7039#if defined(MBEDTLS_SSL_CLI_C)
7040 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7041 {
7042 key1 = keyblk + mac_key_len * 2;
7043 key2 = keyblk + mac_key_len * 2 + keylen;
7044
7045 mac_enc = keyblk;
7046 mac_dec = keyblk + mac_key_len;
7047
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007048 iv_copy_len = ( transform->fixed_ivlen ) ?
7049 transform->fixed_ivlen : transform->ivlen;
7050 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7051 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7052 iv_copy_len );
7053 }
7054 else
7055#endif /* MBEDTLS_SSL_CLI_C */
7056#if defined(MBEDTLS_SSL_SRV_C)
7057 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7058 {
7059 key1 = keyblk + mac_key_len * 2 + keylen;
7060 key2 = keyblk + mac_key_len * 2;
7061
7062 mac_enc = keyblk + mac_key_len;
7063 mac_dec = keyblk;
7064
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007065 iv_copy_len = ( transform->fixed_ivlen ) ?
7066 transform->fixed_ivlen : transform->ivlen;
7067 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7068 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7069 iv_copy_len );
7070 }
7071 else
7072#endif /* MBEDTLS_SSL_SRV_C */
7073 {
7074 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7075 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7076 goto end;
7077 }
7078
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007079 if( ssl != NULL && ssl->f_export_keys != NULL )
7080 {
7081 ssl->f_export_keys( ssl->p_export_keys,
7082 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7083 master, 48,
7084 randbytes + 32,
7085 randbytes,
7086 tls_prf_get_type( tls_prf ) );
7087 }
7088
7089#if defined(MBEDTLS_USE_PSA_CRYPTO)
7090 if( ( status = mbedtls_ssl_cipher_to_psa( cipher_info->type,
7091 transform->taglen,
7092 &alg,
7093 &key_type,
7094 &key_bits ) ) != PSA_SUCCESS )
7095 {
7096 ret = psa_ssl_status_to_mbedtls( status );
7097 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7098 goto end;
7099 }
7100
7101 transform->psa_alg = alg;
7102
7103 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7104 {
7105 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7106 psa_set_key_algorithm( &attributes, alg );
7107 psa_set_key_type( &attributes, key_type );
7108
7109 if( ( status = psa_import_key( &attributes,
7110 key1,
7111 PSA_BITS_TO_BYTES( key_bits ),
7112 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7113 {
7114 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7115 ret = psa_ssl_status_to_mbedtls( status );
7116 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7117 goto end;
7118 }
7119
7120 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7121
7122 if( ( status = psa_import_key( &attributes,
7123 key2,
7124 PSA_BITS_TO_BYTES( key_bits ),
7125 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7126 {
7127 ret = psa_ssl_status_to_mbedtls( status );
7128 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7129 goto end;
7130 }
7131 }
7132#else
7133 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7134 cipher_info ) ) != 0 )
7135 {
7136 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7137 goto end;
7138 }
7139
7140 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7141 cipher_info ) ) != 0 )
7142 {
7143 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7144 goto end;
7145 }
7146
7147 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7148 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7149 MBEDTLS_ENCRYPT ) ) != 0 )
7150 {
7151 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7152 goto end;
7153 }
7154
7155 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7156 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7157 MBEDTLS_DECRYPT ) ) != 0 )
7158 {
7159 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7160 goto end;
7161 }
7162
7163#if defined(MBEDTLS_CIPHER_MODE_CBC)
7164 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7165 {
7166 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7167 MBEDTLS_PADDING_NONE ) ) != 0 )
7168 {
7169 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7170 goto end;
7171 }
7172
7173 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7174 MBEDTLS_PADDING_NONE ) ) != 0 )
7175 {
7176 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7177 goto end;
7178 }
7179 }
7180#endif /* MBEDTLS_CIPHER_MODE_CBC */
7181#endif /* MBEDTLS_USE_PSA_CRYPTO */
7182
Neil Armstrong29c0c042022-03-17 17:47:28 +01007183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7184 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7185 For AEAD-based ciphersuites, there is nothing to do here. */
7186 if( mac_key_len != 0 )
7187 {
7188#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007189 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007190
7191 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007192 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007193 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7194
7195 if( ( status = psa_import_key( &attributes,
7196 mac_enc, mac_key_len,
7197 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7198 {
7199 ret = psa_ssl_status_to_mbedtls( status );
7200 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7201 goto end;
7202 }
7203
Ronald Cronfb39f152022-03-25 14:36:28 +01007204 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7205 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7206 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007207 /* mbedtls_ct_hmac() requires the key to be exportable */
7208 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7209 PSA_KEY_USAGE_VERIFY_HASH );
7210 else
7211 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7212
7213 if( ( status = psa_import_key( &attributes,
7214 mac_dec, mac_key_len,
7215 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7216 {
7217 ret = psa_ssl_status_to_mbedtls( status );
7218 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7219 goto end;
7220 }
7221#else
7222 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7223 if( ret != 0 )
7224 goto end;
7225 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7226 if( ret != 0 )
7227 goto end;
7228#endif /* MBEDTLS_USE_PSA_CRYPTO */
7229 }
7230#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7231
7232 ((void) mac_dec);
7233 ((void) mac_enc);
7234
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007235end:
7236 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7237 return( ret );
7238}
7239
Jerry Yuee40f9d2022-02-17 14:55:16 +08007240#if defined(MBEDTLS_USE_PSA_CRYPTO)
7241int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7242 unsigned char *hash, size_t *hashlen,
7243 unsigned char *data, size_t data_len,
7244 mbedtls_md_type_t md_alg )
7245{
7246 psa_status_t status;
7247 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7248 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7249
7250 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7251
7252 if( ( status = psa_hash_setup( &hash_operation,
7253 hash_alg ) ) != PSA_SUCCESS )
7254 {
7255 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7256 goto exit;
7257 }
7258
7259 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7260 64 ) ) != PSA_SUCCESS )
7261 {
7262 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7263 goto exit;
7264 }
7265
7266 if( ( status = psa_hash_update( &hash_operation,
7267 data, data_len ) ) != PSA_SUCCESS )
7268 {
7269 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7270 goto exit;
7271 }
7272
7273 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7274 hashlen ) ) != PSA_SUCCESS )
7275 {
7276 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7277 goto exit;
7278 }
7279
7280exit:
7281 if( status != PSA_SUCCESS )
7282 {
7283 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7284 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7285 switch( status )
7286 {
7287 case PSA_ERROR_NOT_SUPPORTED:
7288 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7289 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7290 case PSA_ERROR_BUFFER_TOO_SMALL:
7291 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7292 case PSA_ERROR_INSUFFICIENT_MEMORY:
7293 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7294 default:
7295 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7296 }
7297 }
7298 return( 0 );
7299}
7300
7301#else
7302
7303int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7304 unsigned char *hash, size_t *hashlen,
7305 unsigned char *data, size_t data_len,
7306 mbedtls_md_type_t md_alg )
7307{
7308 int ret = 0;
7309 mbedtls_md_context_t ctx;
7310 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7311 *hashlen = mbedtls_md_get_size( md_info );
7312
7313 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7314
7315 mbedtls_md_init( &ctx );
7316
7317 /*
7318 * digitally-signed struct {
7319 * opaque client_random[32];
7320 * opaque server_random[32];
7321 * ServerDHParams params;
7322 * };
7323 */
7324 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7325 {
7326 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7327 goto exit;
7328 }
7329 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7330 {
7331 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7332 goto exit;
7333 }
7334 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7335 {
7336 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7337 goto exit;
7338 }
7339 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7340 {
7341 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7342 goto exit;
7343 }
7344 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7345 {
7346 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7347 goto exit;
7348 }
7349
7350exit:
7351 mbedtls_md_free( &ctx );
7352
7353 if( ret != 0 )
7354 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7355 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7356
7357 return( ret );
7358}
7359#endif /* MBEDTLS_USE_PSA_CRYPTO */
7360
Jerry Yud9d91da2022-02-17 14:57:06 +08007361#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7362
7363/* Find an entry in a signature-hash set matching a given hash algorithm. */
7364mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
7365 mbedtls_pk_type_t sig_alg )
7366{
7367 switch( sig_alg )
7368 {
7369 case MBEDTLS_PK_RSA:
7370 return( set->rsa );
7371 case MBEDTLS_PK_ECDSA:
7372 return( set->ecdsa );
7373 default:
7374 return( MBEDTLS_MD_NONE );
7375 }
7376}
7377
7378/* Add a signature-hash-pair to a signature-hash set */
7379void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
7380 mbedtls_pk_type_t sig_alg,
7381 mbedtls_md_type_t md_alg )
7382{
7383 switch( sig_alg )
7384 {
7385 case MBEDTLS_PK_RSA:
7386 if( set->rsa == MBEDTLS_MD_NONE )
7387 set->rsa = md_alg;
7388 break;
7389
7390 case MBEDTLS_PK_ECDSA:
7391 if( set->ecdsa == MBEDTLS_MD_NONE )
7392 set->ecdsa = md_alg;
7393 break;
7394
7395 default:
7396 break;
7397 }
7398}
7399
7400/* Allow exactly one hash algorithm for each signature. */
7401void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
7402 mbedtls_md_type_t md_alg )
7403{
7404 set->rsa = md_alg;
7405 set->ecdsa = md_alg;
7406}
7407
7408#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7409
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007410/* Serialization of TLS 1.2 sessions:
7411 *
7412 * struct {
7413 * uint64 start_time;
7414 * uint8 ciphersuite[2]; // defined by the standard
7415 * uint8 compression; // 0 or 1
7416 * uint8 session_id_len; // at most 32
7417 * opaque session_id[32];
7418 * opaque master[48]; // fixed length in the standard
7419 * uint32 verify_result;
7420 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7421 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7422 * uint32 ticket_lifetime;
7423 * uint8 mfl_code; // up to 255 according to standard
7424 * uint8 encrypt_then_mac; // 0 or 1
7425 * } serialized_session_tls12;
7426 *
7427 */
7428static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7429 unsigned char *buf,
7430 size_t buf_len )
7431{
7432 unsigned char *p = buf;
7433 size_t used = 0;
7434
7435#if defined(MBEDTLS_HAVE_TIME)
7436 uint64_t start;
7437#endif
7438#if defined(MBEDTLS_X509_CRT_PARSE_C)
7439#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7440 size_t cert_len;
7441#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7442#endif /* MBEDTLS_X509_CRT_PARSE_C */
7443
7444 /*
7445 * Time
7446 */
7447#if defined(MBEDTLS_HAVE_TIME)
7448 used += 8;
7449
7450 if( used <= buf_len )
7451 {
7452 start = (uint64_t) session->start;
7453
7454 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7455 p += 8;
7456 }
7457#endif /* MBEDTLS_HAVE_TIME */
7458
7459 /*
7460 * Basic mandatory fields
7461 */
7462 used += 2 /* ciphersuite */
7463 + 1 /* compression */
7464 + 1 /* id_len */
7465 + sizeof( session->id )
7466 + sizeof( session->master )
7467 + 4; /* verify_result */
7468
7469 if( used <= buf_len )
7470 {
7471 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7472 p += 2;
7473
7474 *p++ = MBEDTLS_BYTE_0( session->compression );
7475
7476 *p++ = MBEDTLS_BYTE_0( session->id_len );
7477 memcpy( p, session->id, 32 );
7478 p += 32;
7479
7480 memcpy( p, session->master, 48 );
7481 p += 48;
7482
7483 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7484 p += 4;
7485 }
7486
7487 /*
7488 * Peer's end-entity certificate
7489 */
7490#if defined(MBEDTLS_X509_CRT_PARSE_C)
7491#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7492 if( session->peer_cert == NULL )
7493 cert_len = 0;
7494 else
7495 cert_len = session->peer_cert->raw.len;
7496
7497 used += 3 + cert_len;
7498
7499 if( used <= buf_len )
7500 {
7501 *p++ = MBEDTLS_BYTE_2( cert_len );
7502 *p++ = MBEDTLS_BYTE_1( cert_len );
7503 *p++ = MBEDTLS_BYTE_0( cert_len );
7504
7505 if( session->peer_cert != NULL )
7506 {
7507 memcpy( p, session->peer_cert->raw.p, cert_len );
7508 p += cert_len;
7509 }
7510 }
7511#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7512 if( session->peer_cert_digest != NULL )
7513 {
7514 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7515 if( used <= buf_len )
7516 {
7517 *p++ = (unsigned char) session->peer_cert_digest_type;
7518 *p++ = (unsigned char) session->peer_cert_digest_len;
7519 memcpy( p, session->peer_cert_digest,
7520 session->peer_cert_digest_len );
7521 p += session->peer_cert_digest_len;
7522 }
7523 }
7524 else
7525 {
7526 used += 2;
7527 if( used <= buf_len )
7528 {
7529 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7530 *p++ = 0;
7531 }
7532 }
7533#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7534#endif /* MBEDTLS_X509_CRT_PARSE_C */
7535
7536 /*
7537 * Session ticket if any, plus associated data
7538 */
7539#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7540 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7541
7542 if( used <= buf_len )
7543 {
7544 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7545 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7546 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7547
7548 if( session->ticket != NULL )
7549 {
7550 memcpy( p, session->ticket, session->ticket_len );
7551 p += session->ticket_len;
7552 }
7553
7554 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7555 p += 4;
7556 }
7557#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7558
7559 /*
7560 * Misc extension-related info
7561 */
7562#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7563 used += 1;
7564
7565 if( used <= buf_len )
7566 *p++ = session->mfl_code;
7567#endif
7568
7569#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7570 used += 1;
7571
7572 if( used <= buf_len )
7573 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7574#endif
7575
7576 return( used );
7577}
7578
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007579static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7580 const unsigned char *buf,
7581 size_t len )
7582{
7583#if defined(MBEDTLS_HAVE_TIME)
7584 uint64_t start;
7585#endif
7586#if defined(MBEDTLS_X509_CRT_PARSE_C)
7587#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7588 size_t cert_len;
7589#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7590#endif /* MBEDTLS_X509_CRT_PARSE_C */
7591
7592 const unsigned char *p = buf;
7593 const unsigned char * const end = buf + len;
7594
7595 /*
7596 * Time
7597 */
7598#if defined(MBEDTLS_HAVE_TIME)
7599 if( 8 > (size_t)( end - p ) )
7600 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7601
7602 start = ( (uint64_t) p[0] << 56 ) |
7603 ( (uint64_t) p[1] << 48 ) |
7604 ( (uint64_t) p[2] << 40 ) |
7605 ( (uint64_t) p[3] << 32 ) |
7606 ( (uint64_t) p[4] << 24 ) |
7607 ( (uint64_t) p[5] << 16 ) |
7608 ( (uint64_t) p[6] << 8 ) |
7609 ( (uint64_t) p[7] );
7610 p += 8;
7611
7612 session->start = (time_t) start;
7613#endif /* MBEDTLS_HAVE_TIME */
7614
7615 /*
7616 * Basic mandatory fields
7617 */
7618 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
7619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7620
7621 session->ciphersuite = ( p[0] << 8 ) | p[1];
7622 p += 2;
7623
7624 session->compression = *p++;
7625
7626 session->id_len = *p++;
7627 memcpy( session->id, p, 32 );
7628 p += 32;
7629
7630 memcpy( session->master, p, 48 );
7631 p += 48;
7632
7633 session->verify_result = ( (uint32_t) p[0] << 24 ) |
7634 ( (uint32_t) p[1] << 16 ) |
7635 ( (uint32_t) p[2] << 8 ) |
7636 ( (uint32_t) p[3] );
7637 p += 4;
7638
7639 /* Immediately clear invalid pointer values that have been read, in case
7640 * we exit early before we replaced them with valid ones. */
7641#if defined(MBEDTLS_X509_CRT_PARSE_C)
7642#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7643 session->peer_cert = NULL;
7644#else
7645 session->peer_cert_digest = NULL;
7646#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7647#endif /* MBEDTLS_X509_CRT_PARSE_C */
7648#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7649 session->ticket = NULL;
7650#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7651
7652 /*
7653 * Peer certificate
7654 */
7655#if defined(MBEDTLS_X509_CRT_PARSE_C)
7656#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7657 /* Deserialize CRT from the end of the ticket. */
7658 if( 3 > (size_t)( end - p ) )
7659 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7660
7661 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7662 p += 3;
7663
7664 if( cert_len != 0 )
7665 {
7666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7667
7668 if( cert_len > (size_t)( end - p ) )
7669 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7670
7671 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7672
7673 if( session->peer_cert == NULL )
7674 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7675
7676 mbedtls_x509_crt_init( session->peer_cert );
7677
7678 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
7679 p, cert_len ) ) != 0 )
7680 {
7681 mbedtls_x509_crt_free( session->peer_cert );
7682 mbedtls_free( session->peer_cert );
7683 session->peer_cert = NULL;
7684 return( ret );
7685 }
7686
7687 p += cert_len;
7688 }
7689#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7690 /* Deserialize CRT digest from the end of the ticket. */
7691 if( 2 > (size_t)( end - p ) )
7692 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7693
7694 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
7695 session->peer_cert_digest_len = (size_t) *p++;
7696
7697 if( session->peer_cert_digest_len != 0 )
7698 {
7699 const mbedtls_md_info_t *md_info =
7700 mbedtls_md_info_from_type( session->peer_cert_digest_type );
7701 if( md_info == NULL )
7702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7703 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
7704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7705
7706 if( session->peer_cert_digest_len > (size_t)( end - p ) )
7707 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7708
7709 session->peer_cert_digest =
7710 mbedtls_calloc( 1, session->peer_cert_digest_len );
7711 if( session->peer_cert_digest == NULL )
7712 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7713
7714 memcpy( session->peer_cert_digest, p,
7715 session->peer_cert_digest_len );
7716 p += session->peer_cert_digest_len;
7717 }
7718#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7719#endif /* MBEDTLS_X509_CRT_PARSE_C */
7720
7721 /*
7722 * Session ticket and associated data
7723 */
7724#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7725 if( 3 > (size_t)( end - p ) )
7726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7727
7728 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
7729 p += 3;
7730
7731 if( session->ticket_len != 0 )
7732 {
7733 if( session->ticket_len > (size_t)( end - p ) )
7734 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7735
7736 session->ticket = mbedtls_calloc( 1, session->ticket_len );
7737 if( session->ticket == NULL )
7738 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7739
7740 memcpy( session->ticket, p, session->ticket_len );
7741 p += session->ticket_len;
7742 }
7743
7744 if( 4 > (size_t)( end - p ) )
7745 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7746
7747 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
7748 ( (uint32_t) p[1] << 16 ) |
7749 ( (uint32_t) p[2] << 8 ) |
7750 ( (uint32_t) p[3] );
7751 p += 4;
7752#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7753
7754 /*
7755 * Misc extension-related info
7756 */
7757#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7758 if( 1 > (size_t)( end - p ) )
7759 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7760
7761 session->mfl_code = *p++;
7762#endif
7763
7764#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7765 if( 1 > (size_t)( end - p ) )
7766 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7767
7768 session->encrypt_then_mac = *p++;
7769#endif
7770
7771 /* Done, should have consumed entire buffer */
7772 if( p != end )
7773 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7774
7775 return( 0 );
7776}
Jerry Yudc7bd172022-02-17 13:44:15 +08007777#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
7778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007779#endif /* MBEDTLS_SSL_TLS_C */