blob: 3d3491bc6c2063b4410e832a57bfa18b89f3bf17 [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#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010031
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000032#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010033#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010034#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000035#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040036
Janos Follath73c616b2019-12-18 15:07:04 +000037#include "mbedtls/debug.h"
38#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050039#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010040#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020041#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020042
Rich Evans00ab4702015-02-06 13:43:58 +000043#include <string.h>
44
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050045#if defined(MBEDTLS_USE_PSA_CRYPTO)
46#include "mbedtls/psa_util.h"
47#include "psa/crypto.h"
48#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020049#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050050
Janos Follath23bdca02016-10-07 14:47:14 +010051#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000052#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020053#endif
54
Ronald Cronad8c17b2022-06-10 17:18:09 +020055#if defined(MBEDTLS_TEST_HOOKS)
56static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
57
58void mbedtls_ssl_set_chk_buf_ptr_fail_args(
59 const uint8_t *cur, const uint8_t *end, size_t need )
60{
61 chk_buf_ptr_fail_args.cur = cur;
62 chk_buf_ptr_fail_args.end = end;
63 chk_buf_ptr_fail_args.need = need;
64}
65
66void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
67{
68 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
69}
70
71int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
72{
73 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
74 ( chk_buf_ptr_fail_args.end != args->end ) ||
75 ( chk_buf_ptr_fail_args.need != args->need ) );
76}
77#endif /* MBEDTLS_TEST_HOOKS */
78
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020079#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010080
Hanno Beckera0e20d02019-05-15 14:03:01 +010081#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010082/* Top-level Connection ID API */
83
Hanno Becker8367ccc2019-05-14 11:30:10 +010084int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
85 size_t len,
86 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010087{
88 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
89 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
90
Hanno Becker611ac772019-05-14 11:45:26 +010091 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
93 {
94 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
95 }
96
97 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098 conf->cid_len = len;
99 return( 0 );
100}
101
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100102int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
103 int enable,
104 unsigned char const *own_cid,
105 size_t own_cid_len )
106{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100107 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
108 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
111 if( enable == MBEDTLS_SSL_CID_DISABLED )
112 {
113 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
114 return( 0 );
115 }
116 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100117 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100118
Hanno Beckerad4a1372019-05-03 13:06:44 +0100119 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100120 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100121 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
122 (unsigned) own_cid_len,
123 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100124 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
125 }
126
127 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100128 /* Truncation is not an issue here because
129 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
130 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100131
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100132 return( 0 );
133}
134
Paul Elliott0113cf12022-03-11 20:26:47 +0000135int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
136 int *enabled,
137 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
138 size_t *own_cid_len )
139{
140 *enabled = MBEDTLS_SSL_CID_DISABLED;
141
142 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
143 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
144
145 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
146 * zero as this is indistinguishable from not requesting to use
147 * the CID extension. */
148 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
149 return( 0 );
150
151 if( own_cid_len != NULL )
152 {
153 *own_cid_len = ssl->own_cid_len;
154 if( own_cid != NULL )
155 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
160 return( 0 );
161}
162
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
166 size_t *peer_cid_len )
167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Becker76a79ab2019-05-03 14:38:32 +0100170 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Jerry Yu6848a612022-10-27 13:03:26 +0800171 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100174 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100175
Hanno Beckerc5f24222019-05-03 12:54:52 +0100176 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
177 * were used, but client and server requested the empty CID.
178 * This is indistinguishable from not using the CID extension
179 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100180 if( ssl->transform_in->in_cid_len == 0 &&
181 ssl->transform_in->out_cid_len == 0 )
182 {
183 return( 0 );
184 }
185
Hanno Becker615ef172019-05-22 16:50:35 +0100186 if( peer_cid_len != NULL )
187 {
188 *peer_cid_len = ssl->transform_in->out_cid_len;
189 if( peer_cid != NULL )
190 {
191 memcpy( peer_cid, ssl->transform_in->out_cid,
192 ssl->transform_in->out_cid_len );
193 }
194 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100195
196 *enabled = MBEDTLS_SSL_CID_ENABLED;
197
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100198 return( 0 );
199}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100200#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205/*
206 * Convert max_fragment_length codes to length.
207 * RFC 6066 says:
208 * enum{
209 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
210 * } MaxFragmentLength;
211 * and we add 0 -> extension unused
212 */
Angus Grattond8213d02016-05-25 20:56:48 +1000213static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200214{
Angus Grattond8213d02016-05-25 20:56:48 +1000215 switch( mfl )
216 {
217 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
218 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
219 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
220 return 512;
221 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
222 return 1024;
223 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
224 return 2048;
225 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
226 return 4096;
227 default:
228 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
229 }
230}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200232
Hanno Becker52055ae2019-02-06 14:30:46 +0000233int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
234 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200235{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236 mbedtls_ssl_session_free( dst );
237 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
吴敬辉0b716112021-11-29 10:46:35 +0800238#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
239 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000240#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
241 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000242 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800243#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000244#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200249 if( src->peer_cert != NULL )
250 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200252
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200253 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200254 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200255 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200260 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200263 dst->peer_cert = NULL;
264 return( ret );
265 }
266 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000267#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 if( src->peer_cert_digest != NULL )
269 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 if( dst->peer_cert_digest == NULL )
273 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
274
275 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
276 src->peer_cert_digest_len );
277 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000278 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000279 }
280#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
281
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200282#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200284#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 if( src->ticket != NULL )
286 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200287 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200288 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200289 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200290
291 memcpy( dst->ticket, src->ticket, src->ticket_len );
292 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000293
294#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
295 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
296 if( src->endpoint == MBEDTLS_SSL_IS_CLIENT )
297 {
298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
299 ret = mbedtls_ssl_session_set_hostname( dst, src->hostname );
300 if( ret != 0 )
301 return ( ret );
302 }
303#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
304 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200305#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200306
307 return( 0 );
308}
309
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500310#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200311MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
313{
314 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
315 if( resized_buffer == NULL )
316 return -1;
317
318 /* We want to copy len_new bytes when downsizing the buffer, and
319 * len_old bytes when upsizing, so we choose the smaller of two sizes,
320 * to fit one buffer into another. Size checks, ensuring that no data is
321 * lost, are done outside of this function. */
322 memcpy( resized_buffer, *buffer,
323 ( len_new < *len_old ) ? len_new : *len_old );
324 mbedtls_platform_zeroize( *buffer, *len_old );
325 mbedtls_free( *buffer );
326
327 *buffer = resized_buffer;
328 *len_old = len_new;
329
330 return 0;
331}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200332
333static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500334 size_t in_buf_new_len,
335 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336{
337 int modified = 0;
338 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
339 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
340 if( ssl->in_buf != NULL )
341 {
342 written_in = ssl->in_msg - ssl->in_buf;
343 iv_offset_in = ssl->in_iv - ssl->in_buf;
344 len_offset_in = ssl->in_len - ssl->in_buf;
345 if( downsizing ?
346 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
347 ssl->in_buf_len < in_buf_new_len )
348 {
349 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
350 {
351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
352 }
353 else
354 {
Paul Elliottb7449902021-03-10 18:14:58 +0000355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
362 if( ssl->out_buf != NULL )
363 {
364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
367 if( downsizing ?
368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
369 ssl->out_buf_len < out_buf_new_len )
370 {
371 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
372 {
373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
374 }
375 else
376 {
Paul Elliottb7449902021-03-10 18:14:58 +0000377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
378 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 modified = 1;
380 }
381 }
382 }
383 if( modified )
384 {
385 /* Update pointers here to avoid doing it twice. */
386 mbedtls_ssl_reset_in_out_pointers( ssl );
387 /* Fields below might not be properly updated with record
388 * splitting or with CID, so they are manually updated here. */
389 ssl->out_msg = ssl->out_buf + written_out;
390 ssl->out_len = ssl->out_buf + len_offset_out;
391 ssl->out_iv = ssl->out_buf + iv_offset_out;
392
393 ssl->in_msg = ssl->in_buf + written_in;
394 ssl->in_len = ssl->in_buf + len_offset_in;
395 ssl->in_iv = ssl->in_buf + iv_offset_in;
396 }
397}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500398#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
399
Jerry Yudb8c48a2022-01-27 14:54:54 +0800400#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800401
402#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
403typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
404 const char *label,
405 const unsigned char *random, size_t rlen,
406 unsigned char *dstbuf, size_t dlen );
407
408static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
409
410#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
411
412/* Type for the TLS PRF */
413typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
414 const unsigned char *, size_t,
415 unsigned char *, size_t);
416
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200417MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800418static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
419 int ciphersuite,
420 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800422 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200423#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800424 ssl_tls_prf_t tls_prf,
425 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400426 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800427 unsigned endpoint,
428 const mbedtls_ssl_context *ssl );
429
Andrzej Kurek25f27152022-08-17 16:09:31 -0400430#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200431MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800432static int tls_prf_sha256( const unsigned char *secret, size_t slen,
433 const char *label,
434 const unsigned char *random, size_t rlen,
435 unsigned char *dstbuf, size_t dlen );
436static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
437static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
438
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400439#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yued14c932022-02-17 13:40:45 +0800440
Andrzej Kurek25f27152022-08-17 16:09:31 -0400441#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200442MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800443static int tls_prf_sha384( const unsigned char *secret, size_t slen,
444 const char *label,
445 const unsigned char *random, size_t rlen,
446 unsigned char *dstbuf, size_t dlen );
447
448static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
449static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400450#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yued14c932022-02-17 13:40:45 +0800451
Jerry Yu438ddd82022-07-07 06:55:50 +0000452static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800453 unsigned char *buf,
454 size_t buf_len );
Jerry Yu251a12e2022-07-13 15:15:48 +0800455
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200456MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +0000457static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800458 const unsigned char *buf,
459 size_t len );
460#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
461
Jerry Yu53d23e22022-02-09 16:25:09 +0800462static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
463
Andrzej Kurek25f27152022-08-17 16:09:31 -0400464#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yudb8c48a2022-01-27 14:54:54 +0800465static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400466#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudb8c48a2022-01-27 14:54:54 +0800467
Andrzej Kurek25f27152022-08-17 16:09:31 -0400468#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yudb8c48a2022-01-27 14:54:54 +0800469static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400470#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Paul Bakker1ef83d62012-04-11 12:09:53 +0000471
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
473 const unsigned char *secret, size_t slen,
474 const char *label,
475 const unsigned char *random, size_t rlen,
476 unsigned char *dstbuf, size_t dlen )
477{
478 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
479
480 switch( prf )
481 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300482#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek25f27152022-08-17 16:09:31 -0400483#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 case MBEDTLS_SSL_TLS_PRF_SHA384:
485 tls_prf = tls_prf_sha384;
486 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400487#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -0400488#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 case MBEDTLS_SSL_TLS_PRF_SHA256:
490 tls_prf = tls_prf_sha256;
491 break;
Andrzej Kurekcccb0442022-08-19 03:42:11 -0400492#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300493#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300494 default:
495 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
496 }
497
498 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
499}
500
Jerry Yuc73c6182022-02-08 20:29:25 +0800501#if defined(MBEDTLS_X509_CRT_PARSE_C)
502static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
503{
504#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
505 if( session->peer_cert != NULL )
506 {
507 mbedtls_x509_crt_free( session->peer_cert );
508 mbedtls_free( session->peer_cert );
509 session->peer_cert = NULL;
510 }
511#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512 if( session->peer_cert_digest != NULL )
513 {
514 /* Zeroization is not necessary. */
515 mbedtls_free( session->peer_cert_digest );
516 session->peer_cert_digest = NULL;
517 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
518 session->peer_cert_digest_len = 0;
519 }
520#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
521}
522#endif /* MBEDTLS_X509_CRT_PARSE_C */
523
Jerry Yu7a485c12022-10-31 13:08:18 +0800524uint32_t mbedtls_ssl_get_extension_id( unsigned int extension_type )
525{
526 switch( extension_type )
527 {
528 case MBEDTLS_TLS_EXT_SERVERNAME:
529 return( MBEDTLS_SSL_EXT_ID_SERVERNAME );
530
531 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
532 return( MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH );
533
534 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
535 return( MBEDTLS_SSL_EXT_ID_STATUS_REQUEST );
536
537 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
538 return( MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS );
539
540 case MBEDTLS_TLS_EXT_SIG_ALG:
541 return( MBEDTLS_SSL_EXT_ID_SIG_ALG );
542
543 case MBEDTLS_TLS_EXT_USE_SRTP:
544 return( MBEDTLS_SSL_EXT_ID_USE_SRTP );
545
546 case MBEDTLS_TLS_EXT_HEARTBEAT:
547 return( MBEDTLS_SSL_EXT_ID_HEARTBEAT );
548
549 case MBEDTLS_TLS_EXT_ALPN:
550 return( MBEDTLS_SSL_EXT_ID_ALPN );
551
552 case MBEDTLS_TLS_EXT_SCT:
553 return( MBEDTLS_SSL_EXT_ID_SCT );
554
555 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
556 return( MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE );
557
558 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
559 return( MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE );
560
561 case MBEDTLS_TLS_EXT_PADDING:
562 return( MBEDTLS_SSL_EXT_ID_PADDING );
563
564 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
565 return( MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY );
566
567 case MBEDTLS_TLS_EXT_EARLY_DATA:
568 return( MBEDTLS_SSL_EXT_ID_EARLY_DATA );
569
570 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
571 return( MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS );
572
573 case MBEDTLS_TLS_EXT_COOKIE:
574 return( MBEDTLS_SSL_EXT_ID_COOKIE );
575
576 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
577 return( MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES );
578
579 case MBEDTLS_TLS_EXT_CERT_AUTH:
580 return( MBEDTLS_SSL_EXT_ID_CERT_AUTH );
581
582 case MBEDTLS_TLS_EXT_OID_FILTERS:
583 return( MBEDTLS_SSL_EXT_ID_OID_FILTERS );
584
585 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
586 return( MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH );
587
588 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
589 return( MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT );
590
591 case MBEDTLS_TLS_EXT_KEY_SHARE:
592 return( MBEDTLS_SSL_EXT_ID_KEY_SHARE );
593
594 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
595 return( MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC );
596
597 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
598 return( MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS );
599
600 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
601 return( MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC );
602
603 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
604 return( MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET );
605
606 case MBEDTLS_TLS_EXT_SESSION_TICKET:
607 return( MBEDTLS_SSL_EXT_ID_SESSION_TICKET );
608
609 }
610
611 return( MBEDTLS_SSL_EXT_ID_UNRECOGNIZED );
612}
613
614uint32_t mbedtls_ssl_get_extension_mask( unsigned int extension_type )
615{
616 return( 1 << mbedtls_ssl_get_extension_id( extension_type ) );
617}
618
Jerry Yud25cab02022-10-31 12:48:30 +0800619#if defined(MBEDTLS_DEBUG_C)
620static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800621 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800622 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
623 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
624 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
625 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
626 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
627 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
628 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
629 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
630 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
631 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
632 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
633 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
634 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
635 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
636 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
637 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
638 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
639 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
640 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
641 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
642 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
643 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
644 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
645 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
646 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
647 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
648 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket"
649};
650
Jerry Yuea52ed92022-11-08 21:01:17 +0800651static unsigned int extension_type_table[]={
Jerry Yud25cab02022-10-31 12:48:30 +0800652 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
653 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
654 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
655 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
656 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
657 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
658 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
659 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
660 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
661 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
662 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
663 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
664 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
665 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
666 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
667 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
668 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
669 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
670 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
671 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
672 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
673 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
674 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
675 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
676 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
677 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
678 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
679 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET
680};
681
682const char *mbedtls_ssl_get_extension_name( unsigned int extension_type )
683{
684 return( extension_name_table[
685 mbedtls_ssl_get_extension_id( extension_type ) ] );
686}
687
688static const char *ssl_tls13_get_hs_msg_name( int hs_msg_type )
689{
690 switch( hs_msg_type )
691 {
692 case MBEDTLS_SSL_HS_CLIENT_HELLO:
693 return( "ClientHello" );
694 case MBEDTLS_SSL_HS_SERVER_HELLO:
695 return( "ServerHello" );
696 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
697 return( "HelloRetryRequest" );
698 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
699 return( "NewSessionTicket" );
700 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
701 return( "EncryptedExtensions" );
702 case MBEDTLS_SSL_HS_CERTIFICATE:
703 return( "Certificate" );
704 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
705 return( "CertificateRequest" );
706 }
Jerry Yu79aa7212022-11-08 21:30:21 +0800707 return( "Unknown" );
Jerry Yud25cab02022-10-31 12:48:30 +0800708}
709
Jerry Yu79aa7212022-11-08 21:30:21 +0800710void mbedtls_ssl_print_extension( const mbedtls_ssl_context *ssl,
711 int level, const char *file, int line,
712 int hs_msg_type, unsigned int extension_type,
713 const char *extra_msg0, const char *extra_msg1 )
Jerry Yud25cab02022-10-31 12:48:30 +0800714{
715 const char *extra_msg;
716 if( extra_msg0 && extra_msg1 )
717 {
718 mbedtls_debug_print_msg(
719 ssl, level, file, line,
720 "%s: %s(%u) extension %s %s.",
721 ssl_tls13_get_hs_msg_name( hs_msg_type ),
722 mbedtls_ssl_get_extension_name( extension_type ),
723 extension_type,
724 extra_msg0, extra_msg1 );
725 return;
726 }
727
728 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
729 if( extra_msg )
730 {
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
733 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name( hs_msg_type ),
734 mbedtls_ssl_get_extension_name( extension_type ), extension_type,
735 extra_msg );
736 return;
737 }
738
739 mbedtls_debug_print_msg(
740 ssl, level, file, line,
741 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name( hs_msg_type ),
742 mbedtls_ssl_get_extension_name( extension_type ), extension_type );
743}
744
745void mbedtls_ssl_print_extensions( const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 int hs_msg_type, uint32_t extensions_mask,
748 const char *extra )
749{
750
751 for( unsigned i = 0;
752 i < sizeof( extension_name_table ) / sizeof( extension_name_table[0] );
753 i++ )
754 {
Jerry Yu79aa7212022-11-08 21:30:21 +0800755 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800756 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Jerry Yu97be6a92022-11-09 22:43:31 +0800757 extensions_mask & ( 1 << i ) ? "exists" : "does not exist", extra );
Jerry Yud25cab02022-10-31 12:48:30 +0800758 }
759}
760
761#endif /* MBEDTLS_DEBUG_C */
762
Jerry Yuc73c6182022-02-08 20:29:25 +0800763void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
765{
766 ((void) ciphersuite_info);
767
Andrzej Kurek25f27152022-08-17 16:09:31 -0400768#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
770 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
771 else
772#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400773#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
775 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
776 else
777#endif
778 {
779 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
780 return;
781 }
782}
783
XiaokangQianadab9a62022-07-18 07:41:26 +0000784void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
785 unsigned hs_type,
786 size_t total_hs_len )
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100787{
788 unsigned char hs_hdr[4];
789
790 /* Build HS header for checksum update. */
791 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
792 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
793 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
794 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
795
796 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
797}
798
799void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
800 unsigned hs_type,
801 unsigned char const *msg,
802 size_t msg_len )
803{
804 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
805 ssl->handshake->update_checksum( ssl, msg, msg_len );
806}
807
Jerry Yuc73c6182022-02-08 20:29:25 +0800808void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
809{
810 ((void) ssl);
Andrzej Kurek25f27152022-08-17 16:09:31 -0400811#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800812#if defined(MBEDTLS_USE_PSA_CRYPTO)
813 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
814 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
815#else
816 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
817#endif
818#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400819#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
822 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
823#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400824 mbedtls_sha512_starts( &ssl->handshake->fin_sha384, 1 );
Jerry Yuc73c6182022-02-08 20:29:25 +0800825#endif
826#endif
827}
828
829static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
830 const unsigned char *buf, size_t len )
831{
Andrzej Kurek25f27152022-08-17 16:09:31 -0400832#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800833#if defined(MBEDTLS_USE_PSA_CRYPTO)
834 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
835#else
836 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
837#endif
838#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400839#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800840#if defined(MBEDTLS_USE_PSA_CRYPTO)
841 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
842#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400843 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#endif
845#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -0400846#if !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
847 !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
848 (void) ssl;
849 (void) buf;
850 (void) len;
851#endif
Jerry Yuc73c6182022-02-08 20:29:25 +0800852}
853
Andrzej Kurek25f27152022-08-17 16:09:31 -0400854#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800855static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
856 const unsigned char *buf, size_t len )
857{
858#if defined(MBEDTLS_USE_PSA_CRYPTO)
859 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
860#else
861 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
862#endif
863}
864#endif
865
Andrzej Kurek25f27152022-08-17 16:09:31 -0400866#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc73c6182022-02-08 20:29:25 +0800867static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
868 const unsigned char *buf, size_t len )
869{
870#if defined(MBEDTLS_USE_PSA_CRYPTO)
871 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
872#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400873 mbedtls_sha512_update( &ssl->handshake->fin_sha384, buf, len );
Jerry Yuc73c6182022-02-08 20:29:25 +0800874#endif
875}
876#endif
877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200878static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200879{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200881
Andrzej Kurek25f27152022-08-17 16:09:31 -0400882#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500883#if defined(MBEDTLS_USE_PSA_CRYPTO)
884 handshake->fin_sha256_psa = psa_hash_operation_init();
885 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
886#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200888 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200889#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500890#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400891#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500892#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500893 handshake->fin_sha384_psa = psa_hash_operation_init();
894 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500895#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400896 mbedtls_sha512_init( &handshake->fin_sha384 );
897 mbedtls_sha512_starts( &handshake->fin_sha384, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200898#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500899#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200900
901 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903#if defined(MBEDTLS_DHM_C)
904 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200905#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200906#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200908#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200909#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200910#if defined(MBEDTLS_USE_PSA_CRYPTO)
911 handshake->psa_pake_ctx = psa_pake_operation_init();
912 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
913#else
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200914 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Neil Armstrongca7d5062022-05-31 14:43:23 +0200915#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200916#if defined(MBEDTLS_SSL_CLI_C)
917 handshake->ecjpake_cache = NULL;
918 handshake->ecjpake_cache_len = 0;
919#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200920#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200921
Gilles Peskineeccd8882020-03-10 12:19:08 +0100922#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200923 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200924#endif
925
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200926#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
927 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
928#endif
Hanno Becker75173122019-02-06 16:18:31 +0000929
930#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
931 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
932 mbedtls_pk_init( &handshake->peer_pubkey );
933#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200934}
935
Hanno Beckera18d1322018-01-03 14:27:32 +0000936void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200937{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200939
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100940#if defined(MBEDTLS_USE_PSA_CRYPTO)
941 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
942 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100943#else
944 mbedtls_cipher_init( &transform->cipher_ctx_enc );
945 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946#endif
947
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000948#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100949#if defined(MBEDTLS_USE_PSA_CRYPTO)
950 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
951 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100952#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 mbedtls_md_init( &transform->md_ctx_enc );
954 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000955#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100956#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200957}
958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200960{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962}
963
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200964MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000966{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000968 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200970 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200972 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200973 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974
975 /*
976 * Either the pointers are now NULL or cleared properly and can be freed.
977 * Now allocate missing structures.
978 */
979 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200980 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200981 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200982 }
Paul Bakker48916f92012-09-16 19:57:18 +0000983
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200984 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200986 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200987 }
Paul Bakker48916f92012-09-16 19:57:18 +0000988
Paul Bakker82788fb2014-10-20 13:59:19 +0200989 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200990 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200991 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200992 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500993#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
994 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400995
Andrzej Kurek4a063792020-10-21 15:08:44 +0200996 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
997 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500998#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000999
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001000 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +00001001 if( ssl->handshake == NULL ||
1002 ssl->transform_negotiate == NULL ||
1003 ssl->session_negotiate == NULL )
1004 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02001005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 mbedtls_free( ssl->handshake );
1008 mbedtls_free( ssl->transform_negotiate );
1009 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001010
1011 ssl->handshake = NULL;
1012 ssl->transform_negotiate = NULL;
1013 ssl->session_negotiate = NULL;
1014
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001015 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +00001016 }
1017
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +00001020 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +02001021 ssl_handshake_params_init( ssl->handshake );
1022
Jerry Yud0766ec2022-09-22 10:46:57 +08001023#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1024 defined(MBEDTLS_SSL_SRV_C) && \
1025 defined(MBEDTLS_SSL_SESSION_TICKETS)
1026 ssl->handshake->new_session_tickets_count =
1027 ssl->conf->new_session_tickets_count ;
1028#endif
1029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001031 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1032 {
1033 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001034
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001035 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
1036 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
1037 else
1038 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001039
Hanno Becker0f57a652020-02-05 10:37:26 +00001040 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001041 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001042#endif
1043
Brett Warrene0edc842021-08-17 09:53:13 +01001044/*
1045 * curve_list is translated to IANA TLS group identifiers here because
1046 * mbedtls_ssl_conf_curves returns void and so can't return
1047 * any error codes.
1048 */
1049#if defined(MBEDTLS_ECP_C)
1050#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1051 /* Heap allocate and translate curve_list from internal to IANA group ids */
1052 if ( ssl->conf->curve_list != NULL )
1053 {
1054 size_t length;
1055 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1056
1057 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
1058 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
1059
1060 /* Leave room for zero termination */
1061 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
1062 if ( group_list == NULL )
1063 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1064
1065 for( size_t i = 0; i < length; i++ )
1066 {
1067 const mbedtls_ecp_curve_info *info =
1068 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
1069 if ( info == NULL )
1070 {
1071 mbedtls_free( group_list );
1072 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1073 }
1074 group_list[i] = info->tls_id;
1075 }
1076
1077 group_list[length] = 0;
1078
1079 ssl->handshake->group_list = group_list;
1080 ssl->handshake->group_list_heap_allocated = 1;
1081 }
1082 else
1083 {
1084 ssl->handshake->group_list = ssl->conf->group_list;
1085 ssl->handshake->group_list_heap_allocated = 0;
1086 }
1087#endif /* MBEDTLS_DEPRECATED_REMOVED */
1088#endif /* MBEDTLS_ECP_C */
1089
Ronald Crone68ab4f2022-10-05 12:46:29 +02001090#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001091#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001093 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1094 signature algorithms IANA identifiers. */
1095 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +08001096 ssl->conf->sig_hashes != NULL )
1097 {
1098 const int *md;
1099 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001100 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001101 uint16_t *p;
1102
Jerry Yub476a442022-01-21 18:14:45 +08001103#if defined(static_assert)
1104 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1105 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
1106 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +08001107#endif
1108
Jerry Yuf017ee42022-01-12 15:49:48 +08001109 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1110 {
1111 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
1112 continue;
Jerry Yub476a442022-01-21 18:14:45 +08001113#if defined(MBEDTLS_ECDSA_C)
1114 sig_algs_len += sizeof( uint16_t );
1115#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001116
Jerry Yub476a442022-01-21 18:14:45 +08001117#if defined(MBEDTLS_RSA_C)
1118 sig_algs_len += sizeof( uint16_t );
1119#endif
1120 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
1121 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +08001122 }
1123
Jerry Yub476a442022-01-21 18:14:45 +08001124 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +08001125 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1126
Jerry Yub476a442022-01-21 18:14:45 +08001127 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
1128 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +08001129 if( ssl->handshake->sig_algs == NULL )
1130 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1131
1132 p = (uint16_t *)ssl->handshake->sig_algs;
1133 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1134 {
1135 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
1136 if( hash == MBEDTLS_SSL_HASH_NONE )
1137 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001138#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001139 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
1140 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001141#endif
1142#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001143 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
1144 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001145#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001146 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001147 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001148 ssl->handshake->sig_algs_heap_allocated = 1;
1149 }
1150 else
Jerry Yua69269a2022-01-17 21:06:01 +08001151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001152 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001153 ssl->handshake->sig_algs_heap_allocated = 0;
1154 }
Jerry Yucc539102022-06-27 16:27:35 +08001155#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001156#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +00001157 return( 0 );
1158}
1159
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001160#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001161/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001162MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001163static int ssl_cookie_write_dummy( void *ctx,
1164 unsigned char **p, unsigned char *end,
1165 const unsigned char *cli_id, size_t cli_id_len )
1166{
1167 ((void) ctx);
1168 ((void) p);
1169 ((void) end);
1170 ((void) cli_id);
1171 ((void) cli_id_len);
1172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001174}
1175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001176MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001177static int ssl_cookie_check_dummy( void *ctx,
1178 const unsigned char *cookie, size_t cookie_len,
1179 const unsigned char *cli_id, size_t cli_id_len )
1180{
1181 ((void) ctx);
1182 ((void) cookie);
1183 ((void) cookie_len);
1184 ((void) cli_id);
1185 ((void) cli_id_len);
1186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001188}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001189#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001190
Paul Bakker5121ce52009-01-03 21:22:43 +00001191/*
1192 * Initialize an SSL context
1193 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001194void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
1195{
1196 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
1197}
1198
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001199MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001200static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
1201{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001202 const mbedtls_ssl_config *conf = ssl->conf;
1203
Ronald Cron6f135e12021-12-08 16:57:54 +01001204#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001205 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
1206 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1208 {
1209 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
1210 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1211 }
1212
Jerry Yu60835a82021-08-04 10:13:52 +08001213 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
1214 return( 0 );
1215 }
1216#endif
1217
1218#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001219 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +08001220 {
1221 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
1222 return( 0 );
1223 }
1224#endif
1225
Ronald Cron6f135e12021-12-08 16:57:54 +01001226#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001227 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +08001228 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001229 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1230 {
1231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
1232 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1233 }
1234
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001235 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1236 {
1237 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
1238 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1239 }
1240
1241
Ronald Crone1d3f062022-02-10 14:50:54 +01001242 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
1243 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +08001244 }
1245#endif
1246
1247 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
1248 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1249}
1250
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001251MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001252static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1253{
1254 int ret;
1255 ret = ssl_conf_version_check( ssl );
1256 if( ret != 0 )
1257 return( ret );
1258
Jerry Yudef7ae42022-10-30 14:13:19 +08001259#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1260 /* RFC 8446 section 4.4.3
1261 *
1262 * If the verification fails, the receiver MUST terminate the handshake with
1263 * a "decrypt_error" alert.
1264 *
1265 * If the client is configured as TLS 1.3 only with optional verify, return
1266 * bad config.
1267 *
1268 */
1269 if( mbedtls_ssl_conf_tls13_ephemeral_enabled(
1270 (mbedtls_ssl_context *)ssl ) &&
1271 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1272 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1273 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1274 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL )
1275 {
1276 MBEDTLS_SSL_DEBUG_MSG(
Dave Rodgmane8734d82022-10-31 14:30:24 +00001277 1, ( "Optional verify auth mode "
Jerry Yudef7ae42022-10-30 14:13:19 +08001278 "is not available for TLS 1.3 client" ) );
1279 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1280 }
1281#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1282
Jerry Yu60835a82021-08-04 10:13:52 +08001283 /* Space for further checks */
1284
1285 return( 0 );
1286}
1287
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001288/*
1289 * Setup an SSL context
1290 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001291
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001292int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001293 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001294{
Janos Follath865b3eb2019-12-16 11:46:15 +00001295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001296 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1297 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001298
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001299 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001300
Jerry Yu60835a82021-08-04 10:13:52 +08001301 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1302 return( ret );
1303
Paul Bakker62f2dee2012-09-28 07:31:51 +00001304 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001305 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001306 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001307
1308 /* Set to NULL in case of an error condition */
1309 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001310
Darryl Greenb33cc762019-11-28 14:29:44 +00001311#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1312 ssl->in_buf_len = in_buf_len;
1313#endif
1314 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001315 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001316 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001318 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001319 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001320 }
1321
Darryl Greenb33cc762019-11-28 14:29:44 +00001322#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1323 ssl->out_buf_len = out_buf_len;
1324#endif
1325 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001326 if( ssl->out_buf == NULL )
1327 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001329 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001330 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001331 }
1332
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001333 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001334
Johan Pascalb62bb512015-12-03 21:56:45 +01001335#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001336 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001337#endif
1338
Paul Bakker48916f92012-09-16 19:57:18 +00001339 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001340 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001341
1342 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001343
1344error:
1345 mbedtls_free( ssl->in_buf );
1346 mbedtls_free( ssl->out_buf );
1347
1348 ssl->conf = NULL;
1349
Darryl Greenb33cc762019-11-28 14:29:44 +00001350#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1351 ssl->in_buf_len = 0;
1352 ssl->out_buf_len = 0;
1353#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001354 ssl->in_buf = NULL;
1355 ssl->out_buf = NULL;
1356
1357 ssl->in_hdr = NULL;
1358 ssl->in_ctr = NULL;
1359 ssl->in_len = NULL;
1360 ssl->in_iv = NULL;
1361 ssl->in_msg = NULL;
1362
1363 ssl->out_hdr = NULL;
1364 ssl->out_ctr = NULL;
1365 ssl->out_len = NULL;
1366 ssl->out_iv = NULL;
1367 ssl->out_msg = NULL;
1368
k-stachowiak9f7798e2018-07-31 16:52:32 +02001369 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001370}
1371
1372/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001373 * Reset an initialized and used SSL context for re-use while retaining
1374 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001375 *
1376 * If partial is non-zero, keep data in the input buffer and client ID.
1377 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001378 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001379void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1380 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001381{
Darryl Greenb33cc762019-11-28 14:29:44 +00001382#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1383 size_t in_buf_len = ssl->in_buf_len;
1384 size_t out_buf_len = ssl->out_buf_len;
1385#else
1386 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1387 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1388#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001389
Hanno Beckerb0302c42021-08-03 09:39:42 +01001390#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1391 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001392#endif
1393
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001394 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001395 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001396
Hanno Beckerb0302c42021-08-03 09:39:42 +01001397 mbedtls_ssl_reset_in_out_pointers( ssl );
1398
1399 /* Reset incoming message parsing */
1400 ssl->in_offt = NULL;
1401 ssl->nb_zero = 0;
1402 ssl->in_msgtype = 0;
1403 ssl->in_msglen = 0;
1404 ssl->in_hslen = 0;
1405 ssl->keep_current_message = 0;
1406 ssl->transform_in = NULL;
1407
1408#if defined(MBEDTLS_SSL_PROTO_DTLS)
1409 ssl->next_record_offset = 0;
1410 ssl->in_epoch = 0;
1411#endif
1412
1413 /* Keep current datagram if partial == 1 */
1414 if( partial == 0 )
1415 {
1416 ssl->in_left = 0;
1417 memset( ssl->in_buf, 0, in_buf_len );
1418 }
1419
Ronald Cronad8c17b2022-06-10 17:18:09 +02001420 ssl->send_alert = 0;
1421
Hanno Beckerb0302c42021-08-03 09:39:42 +01001422 /* Reset outgoing message writing */
1423 ssl->out_msgtype = 0;
1424 ssl->out_msglen = 0;
1425 ssl->out_left = 0;
1426 memset( ssl->out_buf, 0, out_buf_len );
1427 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1428 ssl->transform_out = NULL;
1429
1430#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1431 mbedtls_ssl_dtls_replay_reset( ssl );
1432#endif
1433
XiaokangQian2b01dc32022-01-21 02:53:13 +00001434#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001435 if( ssl->transform )
1436 {
1437 mbedtls_ssl_transform_free( ssl->transform );
1438 mbedtls_free( ssl->transform );
1439 ssl->transform = NULL;
1440 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1442
XiaokangQian2b01dc32022-01-21 02:53:13 +00001443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1444 mbedtls_ssl_transform_free( ssl->transform_application );
1445 mbedtls_free( ssl->transform_application );
1446 ssl->transform_application = NULL;
1447
1448 if( ssl->handshake != NULL )
1449 {
1450 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1451 mbedtls_free( ssl->handshake->transform_earlydata );
1452 ssl->handshake->transform_earlydata = NULL;
1453
1454 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1455 mbedtls_free( ssl->handshake->transform_handshake );
1456 ssl->handshake->transform_handshake = NULL;
1457 }
1458
XiaokangQian2b01dc32022-01-21 02:53:13 +00001459#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001460}
1461
1462int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1463{
1464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1465
1466 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1467
XiaokangQian78b1fa72022-01-19 06:56:30 +00001468 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001469
1470 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471#if defined(MBEDTLS_SSL_RENEGOTIATION)
1472 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001473 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001474
1475 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1477 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001478#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001480
Hanno Beckerb0302c42021-08-03 09:39:42 +01001481 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001482 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001483 if( ssl->session )
1484 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485 mbedtls_ssl_session_free( ssl->session );
1486 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001487 ssl->session = NULL;
1488 }
1489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001491 ssl->alpn_chosen = NULL;
1492#endif
1493
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001494#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001495 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001496#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
David Horstmann3b2276a2022-10-06 14:49:08 +01001497 free_cli_id = ( partial == 0 );
Hanno Becker4ccbf062018-08-10 11:20:38 +01001498#endif
David Horstmann3b2276a2022-10-06 14:49:08 +01001499 if( free_cli_id )
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001500 {
1501 mbedtls_free( ssl->cli_id );
1502 ssl->cli_id = NULL;
1503 ssl->cli_id_len = 0;
1504 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001505#endif
1506
Paul Bakker48916f92012-09-16 19:57:18 +00001507 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1508 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001509
1510 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001511}
1512
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001513/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001514 * Reset an initialized and used SSL context for re-use while retaining
1515 * all application-set variables, function pointers and data.
1516 */
1517int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1518{
Hanno Becker43aefe22020-02-05 10:44:56 +00001519 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001520}
1521
1522/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001523 * SSL set accessors
1524 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001525void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001526{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001527 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001528}
1529
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001530void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001531{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001532 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001533}
1534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001536void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001537{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001538 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001539}
1540#endif
1541
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001542void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001543{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001544 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001545}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001548
Hanno Becker1841b0a2018-08-24 11:13:57 +01001549void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1550 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001551{
1552 ssl->disable_datagram_packing = !allow_packing;
1553}
1554
1555void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1556 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001557{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001558 conf->hs_timeout_min = min;
1559 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001560}
1561#endif
1562
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001563void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001564{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001565 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001566}
1567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001569void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001570 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001571 void *p_vrfy )
1572{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001573 conf->f_vrfy = f_vrfy;
1574 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001575}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001577
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001578void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001579 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001580 void *p_rng )
1581{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001582 conf->f_rng = f_rng;
1583 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001584}
1585
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001586void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001587 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001588 void *p_dbg )
1589{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001590 conf->f_dbg = f_dbg;
1591 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001592}
1593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001595 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001596 mbedtls_ssl_send_t *f_send,
1597 mbedtls_ssl_recv_t *f_recv,
1598 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001599{
1600 ssl->p_bio = p_bio;
1601 ssl->f_send = f_send;
1602 ssl->f_recv = f_recv;
1603 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001604}
1605
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001606#if defined(MBEDTLS_SSL_PROTO_DTLS)
1607void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1608{
1609 ssl->mtu = mtu;
1610}
1611#endif
1612
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001613void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001614{
1615 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001616}
1617
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001618void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1619 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001620 mbedtls_ssl_set_timer_t *f_set_timer,
1621 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001622{
1623 ssl->p_timer = p_timer;
1624 ssl->f_set_timer = f_set_timer;
1625 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001626
1627 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001628 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001629}
1630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001632void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001633 void *p_cache,
1634 mbedtls_ssl_cache_get_t *f_get_cache,
1635 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001636{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001637 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001638 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643#if defined(MBEDTLS_SSL_CLI_C)
1644int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001645{
Janos Follath865b3eb2019-12-16 11:46:15 +00001646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001647
1648 if( ssl == NULL ||
1649 session == NULL ||
1650 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001651 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001654 }
1655
Hanno Beckere810bbc2021-05-14 16:01:05 +01001656 if( ssl->handshake->resume == 1 )
1657 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1658
Jerry Yu21092062022-10-10 21:21:31 +08001659#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1660 if( session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu40afab62022-10-08 10:42:13 +08001661 {
Jerry Yu21092062022-10-10 21:21:31 +08001662 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1663 mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
1664
1665 if( mbedtls_ssl_validate_ciphersuite(
1666 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
1667 MBEDTLS_SSL_VERSION_TLS1_3 ) != 0 )
1668 {
1669 MBEDTLS_SSL_DEBUG_MSG( 4, ( "%d is not a valid TLS 1.3 ciphersuite.",
1670 session->ciphersuite ) );
1671 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1672 }
Jerry Yu40afab62022-10-08 10:42:13 +08001673 }
Jerry Yu21092062022-10-10 21:21:31 +08001674#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001675
Hanno Becker52055ae2019-02-06 14:30:46 +00001676 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1677 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001678 return( ret );
1679
Paul Bakker0a597072012-09-25 21:55:46 +00001680 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001681
1682 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001683}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001685
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001686void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1687 const int *ciphersuites )
1688{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001689 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001690}
1691
Ronald Cron6f135e12021-12-08 16:57:54 +01001692#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001693void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001694 const int kex_modes )
1695{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001696 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001697}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001698
1699#if defined(MBEDTLS_SSL_EARLY_DATA)
1700void mbedtls_ssl_tls13_conf_early_data( mbedtls_ssl_config *conf,
Xiaokang Qian72dbfef2022-10-26 06:33:57 +00001701 int early_data_enabled )
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001702{
1703 conf->early_data_enabled = early_data_enabled;
1704}
1705#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001706#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001709void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001710 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001711{
1712 conf->cert_profile = profile;
1713}
1714
Glenn Strauss36872db2022-01-22 05:06:31 -05001715static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1716{
1717 mbedtls_ssl_key_cert *cur = key_cert, *next;
1718
1719 while( cur != NULL )
1720 {
1721 next = cur->next;
1722 mbedtls_free( cur );
1723 cur = next;
1724 }
1725}
1726
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001727/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001728MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001729static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1730 mbedtls_x509_crt *cert,
1731 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001732{
niisato8ee24222018-06-25 19:05:48 +09001733 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001734
Glenn Strauss36872db2022-01-22 05:06:31 -05001735 if( cert == NULL )
1736 {
1737 /* Free list if cert is null */
1738 ssl_key_cert_free( *head );
1739 *head = NULL;
1740 return( 0 );
1741 }
1742
niisato8ee24222018-06-25 19:05:48 +09001743 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1744 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001745 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001746
niisato8ee24222018-06-25 19:05:48 +09001747 new_cert->cert = cert;
1748 new_cert->key = key;
1749 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001750
Glenn Strauss36872db2022-01-22 05:06:31 -05001751 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001752 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001753 {
niisato8ee24222018-06-25 19:05:48 +09001754 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001755 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001756 else
1757 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001758 mbedtls_ssl_key_cert *cur = *head;
1759 while( cur->next != NULL )
1760 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001761 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001762 }
1763
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001764 return( 0 );
1765}
1766
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001767int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001768 mbedtls_x509_crt *own_cert,
1769 mbedtls_pk_context *pk_key )
1770{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001771 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001772}
1773
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001774void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001775 mbedtls_x509_crt *ca_chain,
1776 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001777{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001778 conf->ca_chain = ca_chain;
1779 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001780
1781#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1782 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1783 * cannot be used together. */
1784 conf->f_ca_cb = NULL;
1785 conf->p_ca_cb = NULL;
1786#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001787}
Hanno Becker5adaad92019-03-27 16:54:37 +00001788
1789#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1790void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001791 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001792 void *p_ca_cb )
1793{
1794 conf->f_ca_cb = f_ca_cb;
1795 conf->p_ca_cb = p_ca_cb;
1796
1797 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1798 * cannot be used together. */
1799 conf->ca_chain = NULL;
1800 conf->ca_crl = NULL;
1801}
1802#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001804
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001805#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001806const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1807 size_t *name_len )
1808{
1809 *name_len = ssl->handshake->sni_name_len;
1810 return( ssl->handshake->sni_name );
1811}
1812
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001813int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1814 mbedtls_x509_crt *own_cert,
1815 mbedtls_pk_context *pk_key )
1816{
1817 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1818 own_cert, pk_key ) );
1819}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001820
1821void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1822 mbedtls_x509_crt *ca_chain,
1823 mbedtls_x509_crl *ca_crl )
1824{
1825 ssl->handshake->sni_ca_chain = ca_chain;
1826 ssl->handshake->sni_ca_crl = ca_crl;
1827}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001828
Glenn Strauss999ef702022-03-11 01:37:23 -05001829#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1830void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1831 const mbedtls_x509_crt *crt)
1832{
1833 ssl->handshake->dn_hints = crt;
1834}
1835#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1836
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001837void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1838 int authmode )
1839{
1840 ssl->handshake->sni_authmode = authmode;
1841}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001842#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1843
Hanno Becker8927c832019-04-03 12:52:50 +01001844#if defined(MBEDTLS_X509_CRT_PARSE_C)
1845void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1846 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1847 void *p_vrfy )
1848{
1849 ssl->f_vrfy = f_vrfy;
1850 ssl->p_vrfy = p_vrfy;
1851}
1852#endif
1853
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001854#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001855/*
1856 * Set EC J-PAKE password for current handshake
1857 */
Valerio Setti02c25b52022-11-15 14:08:42 +01001858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001859int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1860 const unsigned char *pw,
1861 size_t pw_len )
1862{
Neil Armstrongca7d5062022-05-31 14:43:23 +02001863 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
1864 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1865 psa_pake_role_t psa_role;
1866 psa_status_t status;
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001867
Janos Follath8eb64132016-06-03 15:40:57 +01001868 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001869 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1870
Neil Armstrongca7d5062022-05-31 14:43:23 +02001871 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1872 psa_role = PSA_PAKE_ROLE_SERVER;
1873 else
1874 psa_role = PSA_PAKE_ROLE_CLIENT;
1875
Valerio Settiaca21b72022-11-17 18:17:01 +01001876 /* Empty password is not valid */
1877 if( ( pw == NULL) || ( pw_len == 0 ) )
1878 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001879
Valerio Settiaca21b72022-11-17 18:17:01 +01001880 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
1881 psa_set_key_algorithm( &attributes, PSA_ALG_JPAKE );
1882 psa_set_key_type( &attributes, PSA_KEY_TYPE_PASSWORD );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001883
Valerio Settiaca21b72022-11-17 18:17:01 +01001884 status = psa_import_key( &attributes, pw, pw_len,
1885 &ssl->handshake->psa_pake_password );
1886 if( status != PSA_SUCCESS )
1887 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001888
1889 psa_pake_cs_set_algorithm( &cipher_suite, PSA_ALG_JPAKE );
1890 psa_pake_cs_set_primitive( &cipher_suite,
1891 PSA_PAKE_PRIMITIVE( PSA_PAKE_PRIMITIVE_TYPE_ECC,
1892 PSA_ECC_FAMILY_SECP_R1,
1893 256) );
1894 psa_pake_cs_set_hash( &cipher_suite, PSA_ALG_SHA_256 );
1895
1896 status = psa_pake_setup( &ssl->handshake->psa_pake_ctx, &cipher_suite );
1897 if( status != PSA_SUCCESS )
1898 {
1899 psa_destroy_key( ssl->handshake->psa_pake_password );
1900 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1901 }
1902
1903 status = psa_pake_set_role( &ssl->handshake->psa_pake_ctx, psa_role );
1904 if( status != PSA_SUCCESS )
1905 {
1906 psa_destroy_key( ssl->handshake->psa_pake_password );
1907 psa_pake_abort( &ssl->handshake->psa_pake_ctx );
1908 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1909 }
1910
Valerio Settiaca21b72022-11-17 18:17:01 +01001911 psa_pake_set_password_key( &ssl->handshake->psa_pake_ctx,
1912 ssl->handshake->psa_pake_password );
1913 if( status != PSA_SUCCESS )
Neil Armstrongca7d5062022-05-31 14:43:23 +02001914 {
Valerio Settiaca21b72022-11-17 18:17:01 +01001915 psa_destroy_key( ssl->handshake->psa_pake_password );
1916 psa_pake_abort( &ssl->handshake->psa_pake_ctx );
1917 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001918 }
1919
1920 ssl->handshake->psa_pake_ctx_is_ok = 1;
1921
1922 return( 0 );
Valerio Setti02c25b52022-11-15 14:08:42 +01001923}
1924#else /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001925int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1926 const unsigned char *pw,
1927 size_t pw_len )
1928{
1929 mbedtls_ecjpake_role role;
1930
1931 if( ssl->handshake == NULL || ssl->conf == NULL )
1932 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1933
1934 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1935 role = MBEDTLS_ECJPAKE_SERVER;
1936 else
1937 role = MBEDTLS_ECJPAKE_CLIENT;
1938
1939 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1940 role,
1941 MBEDTLS_MD_SHA256,
1942 MBEDTLS_ECP_DP_SECP256R1,
1943 pw, pw_len ) );
1944}
Valerio Setti02c25b52022-11-15 14:08:42 +01001945#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001946#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001947
Ronald Cron73fe8df2022-10-05 14:31:43 +02001948#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001949int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001950{
Ronald Crond29e13e2022-10-19 10:33:48 +02001951 if( conf->psk_identity == NULL ||
1952 conf->psk_identity_len == 0 )
1953 {
1954 return( 0 );
1955 }
1956
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001957#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Crond29e13e2022-10-19 10:33:48 +02001958 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001959 return( 1 );
1960#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02001961
1962 if( conf->psk != NULL && conf->psk_len != 0 )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001963 return( 1 );
1964
1965 return( 0 );
1966}
1967
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001968static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1969{
1970 /* Remove reference to existing PSK, if any. */
1971#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001972 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001973 {
1974 /* The maintenance of the PSK key slot is the
1975 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001976 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001977 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001978#endif /* MBEDTLS_USE_PSA_CRYPTO */
1979 if( conf->psk != NULL )
1980 {
1981 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1982
1983 mbedtls_free( conf->psk );
1984 conf->psk = NULL;
1985 conf->psk_len = 0;
1986 }
1987
1988 /* Remove reference to PSK identity, if any. */
1989 if( conf->psk_identity != NULL )
1990 {
1991 mbedtls_free( conf->psk_identity );
1992 conf->psk_identity = NULL;
1993 conf->psk_identity_len = 0;
1994 }
1995}
1996
Hanno Becker7390c712018-11-15 13:33:04 +00001997/* This function assumes that PSK identity in the SSL config is unset.
1998 * It checks that the provided identity is well-formed and attempts
1999 * to make a copy of it in the SSL config.
2000 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002001MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00002002static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
2003 unsigned char const *psk_identity,
2004 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002005{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002006 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00002007 if( psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002008 psk_identity_len == 0 ||
Hanno Becker7390c712018-11-15 13:33:04 +00002009 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10002010 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002011 {
2012 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2013 }
2014
Hanno Becker7390c712018-11-15 13:33:04 +00002015 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
2016 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002017 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02002018
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002019 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002020 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02002021
2022 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02002023}
2024
Hanno Becker7390c712018-11-15 13:33:04 +00002025int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
2026 const unsigned char *psk, size_t psk_len,
2027 const unsigned char *psk_identity, size_t psk_identity_len )
2028{
Janos Follath865b3eb2019-12-16 11:46:15 +00002029 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002030
2031 /* We currently only support one PSK, raw or opaque. */
Ronald Crond29e13e2022-10-19 10:33:48 +02002032 if( mbedtls_ssl_conf_has_static_psk( conf ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002033 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00002034
2035 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002036 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00002037 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002038 if( psk_len == 0 )
2039 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2040 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2041 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2042
Hanno Becker7390c712018-11-15 13:33:04 +00002043 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
2044 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2045 conf->psk_len = psk_len;
2046 memcpy( conf->psk, psk, conf->psk_len );
2047
2048 /* Check and set PSK Identity */
2049 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
2050 if( ret != 0 )
2051 ssl_conf_remove_psk( conf );
2052
2053 return( ret );
2054}
2055
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002056static void ssl_remove_psk( mbedtls_ssl_context *ssl )
2057{
2058#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02002059 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002060 {
Neil Armstrong501c9322022-05-03 09:35:09 +02002061 /* The maintenance of the external PSK key slot is the
2062 * user's responsibility. */
2063 if( ssl->handshake->psk_opaque_is_internal )
2064 {
2065 psa_destroy_key( ssl->handshake->psk_opaque );
2066 ssl->handshake->psk_opaque_is_internal = 0;
2067 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002068 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002069 }
Neil Armstronge952a302022-05-03 10:22:14 +02002070#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002071 if( ssl->handshake->psk != NULL )
2072 {
2073 mbedtls_platform_zeroize( ssl->handshake->psk,
2074 ssl->handshake->psk_len );
2075 mbedtls_free( ssl->handshake->psk );
2076 ssl->handshake->psk_len = 0;
2077 }
Neil Armstronge952a302022-05-03 10:22:14 +02002078#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002079}
2080
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002081int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2082 const unsigned char *psk, size_t psk_len )
2083{
Neil Armstrong501c9322022-05-03 09:35:09 +02002084#if defined(MBEDTLS_USE_PSA_CRYPTO)
2085 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002087 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002088 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002089#endif /* MBEDTLS_USE_PSA_CRYPTO */
2090
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002091 if( psk == NULL || ssl->handshake == NULL )
2092 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2093
2094 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2095 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2096
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002097 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002098
Neil Armstrong501c9322022-05-03 09:35:09 +02002099#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2101 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
2102 {
Jerry Yu6cf6b472022-08-16 14:50:28 +08002103 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yuccc68a42022-07-26 16:39:20 +08002104 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_384 );
2105 else
2106 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_256 );
2107 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
2108 }
2109#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002110
Jerry Yu568ec252022-07-22 21:27:34 +08002111#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuccc68a42022-07-26 16:39:20 +08002112 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
2113 {
2114 alg = PSA_ALG_HKDF_EXTRACT( PSA_ALG_ANY_HASH );
2115 psa_set_key_usage_flags( &key_attributes,
2116 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
2117 }
2118#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2119
Neil Armstrong501c9322022-05-03 09:35:09 +02002120 psa_set_key_algorithm( &key_attributes, alg );
2121 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
2122
2123 status = psa_import_key( &key_attributes, psk, psk_len, &key );
2124 if( status != PSA_SUCCESS )
2125 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
2126
2127 /* Allow calling psa_destroy_key() on psk remove */
2128 ssl->handshake->psk_opaque_is_internal = 1;
2129 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
2130#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002131 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002132 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002133
2134 ssl->handshake->psk_len = psk_len;
2135 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
2136
2137 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02002138#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002139}
2140
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141#if defined(MBEDTLS_USE_PSA_CRYPTO)
2142int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01002143 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002144 const unsigned char *psk_identity,
2145 size_t psk_identity_len )
2146{
Janos Follath865b3eb2019-12-16 11:46:15 +00002147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002148
2149 /* We currently only support one PSK, raw or opaque. */
Ronald Crond29e13e2022-10-19 10:33:48 +02002150 if( mbedtls_ssl_conf_has_static_psk( conf ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002151 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002152
Hanno Becker7390c712018-11-15 13:33:04 +00002153 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002154 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00002155 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002156 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002157
2158 /* Check and set PSK Identity */
2159 ret = ssl_conf_set_psk_identity( conf, psk_identity,
2160 psk_identity_len );
2161 if( ret != 0 )
2162 ssl_conf_remove_psk( conf );
2163
2164 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002165}
2166
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002167int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
2168 mbedtls_svc_key_id_t psk )
2169{
2170 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
2171 ( ssl->handshake == NULL ) )
2172 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2173
2174 ssl_remove_psk( ssl );
2175 ssl->handshake->psk_opaque = psk;
2176 return( 0 );
2177}
2178#endif /* MBEDTLS_USE_PSA_CRYPTO */
2179
Jerry Yu8897c072022-08-12 13:56:53 +08002180#if defined(MBEDTLS_SSL_SRV_C)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002181void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
2182 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2183 size_t),
2184 void *p_psk )
2185{
2186 conf->f_psk = f_psk;
2187 conf->p_psk = p_psk;
2188}
Jerry Yu8897c072022-08-12 13:56:53 +08002189#endif /* MBEDTLS_SSL_SRV_C */
2190
Ronald Cron73fe8df2022-10-05 14:31:43 +02002191#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002192
2193#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002194static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
2195 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002196{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002197#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002198 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002199 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002200#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002201 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002202 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02002203 return( MBEDTLS_SSL_MODE_STREAM );
2204}
2205
2206#else /* MBEDTLS_USE_PSA_CRYPTO */
2207
2208static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
2209 mbedtls_cipher_mode_t mode )
2210{
2211#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
2212 if( mode == MBEDTLS_MODE_CBC )
2213 return( MBEDTLS_SSL_MODE_CBC );
2214#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2215
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002216#if defined(MBEDTLS_GCM_C) || \
2217 defined(MBEDTLS_CCM_C) || \
2218 defined(MBEDTLS_CHACHAPOLY_C)
2219 if( mode == MBEDTLS_MODE_GCM ||
2220 mode == MBEDTLS_MODE_CCM ||
2221 mode == MBEDTLS_MODE_CHACHAPOLY )
2222 return( MBEDTLS_SSL_MODE_AEAD );
2223#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002224
2225 return( MBEDTLS_SSL_MODE_STREAM );
2226}
Gilles Peskine301711e2022-04-26 16:57:05 +02002227#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002228
Gilles Peskinee108d982022-04-26 16:50:40 +02002229static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2230 mbedtls_ssl_mode_t base_mode,
2231 int encrypt_then_mac )
2232{
2233#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2234 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2235 base_mode == MBEDTLS_SSL_MODE_CBC )
2236 {
2237 return( MBEDTLS_SSL_MODE_CBC_ETM );
2238 }
2239#else
2240 (void) encrypt_then_mac;
2241#endif
2242 return( base_mode );
2243}
2244
Neil Armstrongab555e02022-04-04 11:07:59 +02002245mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002246 const mbedtls_ssl_transform *transform )
2247{
Gilles Peskinee108d982022-04-26 16:50:40 +02002248 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002249#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02002250 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002251#else
Gilles Peskinee108d982022-04-26 16:50:40 +02002252 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
2253#endif
2254 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002255
Gilles Peskinee108d982022-04-26 16:50:40 +02002256 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002257#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002258 encrypt_then_mac = transform->encrypt_then_mac;
2259#endif
2260 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002261}
2262
Neil Armstrongab555e02022-04-04 11:07:59 +02002263mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002264#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002265 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002266#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002267 const mbedtls_ssl_ciphersuite_t *suite )
2268{
Gilles Peskinee108d982022-04-26 16:50:40 +02002269 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2270
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002271#if defined(MBEDTLS_USE_PSA_CRYPTO)
2272 psa_status_t status;
2273 psa_algorithm_t alg;
2274 psa_key_type_t type;
2275 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002276 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
2277 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02002278 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002279#else
2280 const mbedtls_cipher_info_t *cipher =
2281 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002282 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02002283 {
2284 base_mode =
2285 mbedtls_ssl_get_base_mode(
2286 mbedtls_cipher_info_get_mode( cipher ) );
2287 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002288#endif /* MBEDTLS_USE_PSA_CRYPTO */
2289
Gilles Peskinee108d982022-04-26 16:50:40 +02002290#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2291 int encrypt_then_mac = 0;
2292#endif
2293 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002294}
2295
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002296#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002297
2298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002299/* Serialization of TLS 1.3 sessions:
2300 *
2301 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002302 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002303 * uint64 ticket_received;
2304 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002305 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002306 * } ClientOnlyData;
2307 *
2308 * struct {
2309 * uint8 endpoint;
2310 * uint8 ciphersuite[2];
2311 * uint32 ticket_age_add;
2312 * uint8 ticket_flags;
2313 * opaque resumption_key<0..255>;
2314 * select ( endpoint ) {
2315 * case client: ClientOnlyData;
2316 * case server: uint64 start_time;
2317 * };
2318 * } serialized_session_tls13;
2319 *
2320 */
2321#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002322MBEDTLS_CHECK_RETURN_CRITICAL
2323static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2324 unsigned char *buf,
2325 size_t buf_len,
2326 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00002327{
2328 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002329#if defined(MBEDTLS_SSL_CLI_C) && \
2330 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2331 size_t hostname_len = ( session->hostname == NULL ) ?
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002332 0 : strlen( session->hostname ) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002333#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002334 size_t needed = 1 /* endpoint */
2335 + 2 /* ciphersuite */
2336 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002337 + 1 /* ticket_flags */
2338 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002339 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002340
2341 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
2342 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2343 needed += session->resumption_key_len; /* resumption_key */
2344
Jerry Yu438ddd82022-07-07 06:55:50 +00002345#if defined(MBEDTLS_HAVE_TIME)
2346 needed += 8; /* start_time or ticket_received */
2347#endif
2348
2349#if defined(MBEDTLS_SSL_CLI_C)
2350 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2351 {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002352#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002353 needed += 2 /* hostname_len */
Xiaokang Qian2f9efd32022-10-10 11:24:08 +00002354 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002355#endif
2356
Jerry Yu438ddd82022-07-07 06:55:50 +00002357 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002358 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002359
2360 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08002361 if( session->ticket_len > SIZE_MAX - needed )
2362 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08002363
Jerry Yue28d9742022-08-18 15:44:03 +08002364 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002365 }
2366#endif /* MBEDTLS_SSL_CLI_C */
2367
Jerry Yue36fdd62022-08-17 21:31:36 +08002368 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00002369 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08002370 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Jerry Yu438ddd82022-07-07 06:55:50 +00002371
2372 p[0] = session->endpoint;
2373 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
2374 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
2375 p[7] = session->ticket_flags;
2376
2377 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002378 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002379 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08002380 memcpy( p, session->resumption_key, session->resumption_key_len );
2381 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002382
2383#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2384 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2385 {
2386 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
2387 p += 8;
2388 }
2389#endif /* MBEDTLS_HAVE_TIME */
2390
2391#if defined(MBEDTLS_SSL_CLI_C)
2392 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2393 {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002394#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2395 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
2396 p += 2;
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002397 if( hostname_len > 0 )
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002398 {
2399 /* save host name */
2400 memcpy( p, session->hostname, hostname_len );
2401 p += hostname_len;
2402 }
2403#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2404
Jerry Yu438ddd82022-07-07 06:55:50 +00002405#if defined(MBEDTLS_HAVE_TIME)
2406 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
2407 p += 8;
2408#endif
2409 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
2410 p += 4;
2411
2412 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
2413 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002414
2415 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00002416 {
2417 memcpy( p, session->ticket, session->ticket_len );
2418 p += session->ticket_len;
2419 }
2420 }
2421#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08002422 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00002423}
2424
2425MBEDTLS_CHECK_RETURN_CRITICAL
2426static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2427 const unsigned char *buf,
2428 size_t len )
2429{
2430 const unsigned char *p = buf;
2431 const unsigned char *end = buf + len;
2432
2433 if( end - p < 9 )
2434 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2435 session->endpoint = p[0];
2436 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2437 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2438 session->ticket_flags = p[7];
2439
2440 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002441 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002442 p += 9;
2443
Jerry Yubc7c1a42022-07-21 22:57:37 +08002444 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002445 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2446
Jerry Yubc7c1a42022-07-21 22:57:37 +08002447 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002448 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002449 memcpy( session->resumption_key, p, session->resumption_key_len );
2450 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002451
2452#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2453 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2454 {
2455 if( end - p < 8 )
2456 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2457 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2458 p += 8;
2459 }
2460#endif /* MBEDTLS_HAVE_TIME */
2461
2462#if defined(MBEDTLS_SSL_CLI_C)
2463 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2464 {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002465#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
2466 defined(MBEDTLS_SSL_SESSION_TICKETS)
2467 size_t hostname_len;
2468 /* load host name */
2469 if( end - p < 2 )
2470 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2471 hostname_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2472 p += 2;
2473
2474 if( end - p < ( long int )hostname_len )
2475 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2476 if( hostname_len > 0 )
2477 {
2478 session->hostname = mbedtls_calloc( 1, hostname_len );
2479 if( session->hostname == NULL )
2480 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2481 memcpy( session->hostname, p, hostname_len );
2482 p += hostname_len;
2483 }
2484#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2485 MBEDTLS_SSL_SESSION_TICKETS */
2486
Jerry Yu438ddd82022-07-07 06:55:50 +00002487#if defined(MBEDTLS_HAVE_TIME)
2488 if( end - p < 8 )
2489 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2490 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2491 p += 8;
2492#endif
2493 if( end - p < 4 )
2494 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2495 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2496 p += 4;
2497
2498 if( end - p < 2 )
2499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2500 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2501 p += 2;
2502
2503 if( end - p < ( long int )session->ticket_len )
2504 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2505 if( session->ticket_len > 0 )
2506 {
2507 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2508 if( session->ticket == NULL )
2509 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2510 memcpy( session->ticket, p, session->ticket_len );
2511 p += session->ticket_len;
2512 }
2513 }
2514#endif /* MBEDTLS_SSL_CLI_C */
2515
2516 return( 0 );
2517
2518}
2519#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002520MBEDTLS_CHECK_RETURN_CRITICAL
2521static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2522 unsigned char *buf,
2523 size_t buf_len,
2524 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002525{
2526 ((void) session);
2527 ((void) buf);
2528 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002529 *olen = 0;
2530 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002531}
Jerry Yu438ddd82022-07-07 06:55:50 +00002532
2533static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2534 unsigned char *buf,
2535 size_t buf_len )
2536{
2537 ((void) session);
2538 ((void) buf);
2539 ((void) buf_len);
2540 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2541}
2542#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002543#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2544
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002545psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 size_t taglen,
2547 psa_algorithm_t *alg,
2548 psa_key_type_t *key_type,
2549 size_t *key_size )
2550{
2551 switch ( mbedtls_cipher_type )
2552 {
2553 case MBEDTLS_CIPHER_AES_128_CBC:
2554 *alg = PSA_ALG_CBC_NO_PADDING;
2555 *key_type = PSA_KEY_TYPE_AES;
2556 *key_size = 128;
2557 break;
2558 case MBEDTLS_CIPHER_AES_128_CCM:
2559 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2560 *key_type = PSA_KEY_TYPE_AES;
2561 *key_size = 128;
2562 break;
2563 case MBEDTLS_CIPHER_AES_128_GCM:
2564 *alg = PSA_ALG_GCM;
2565 *key_type = PSA_KEY_TYPE_AES;
2566 *key_size = 128;
2567 break;
2568 case MBEDTLS_CIPHER_AES_192_CCM:
2569 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2570 *key_type = PSA_KEY_TYPE_AES;
2571 *key_size = 192;
2572 break;
2573 case MBEDTLS_CIPHER_AES_192_GCM:
2574 *alg = PSA_ALG_GCM;
2575 *key_type = PSA_KEY_TYPE_AES;
2576 *key_size = 192;
2577 break;
2578 case MBEDTLS_CIPHER_AES_256_CBC:
2579 *alg = PSA_ALG_CBC_NO_PADDING;
2580 *key_type = PSA_KEY_TYPE_AES;
2581 *key_size = 256;
2582 break;
2583 case MBEDTLS_CIPHER_AES_256_CCM:
2584 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2585 *key_type = PSA_KEY_TYPE_AES;
2586 *key_size = 256;
2587 break;
2588 case MBEDTLS_CIPHER_AES_256_GCM:
2589 *alg = PSA_ALG_GCM;
2590 *key_type = PSA_KEY_TYPE_AES;
2591 *key_size = 256;
2592 break;
2593 case MBEDTLS_CIPHER_ARIA_128_CBC:
2594 *alg = PSA_ALG_CBC_NO_PADDING;
2595 *key_type = PSA_KEY_TYPE_ARIA;
2596 *key_size = 128;
2597 break;
2598 case MBEDTLS_CIPHER_ARIA_128_CCM:
2599 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2600 *key_type = PSA_KEY_TYPE_ARIA;
2601 *key_size = 128;
2602 break;
2603 case MBEDTLS_CIPHER_ARIA_128_GCM:
2604 *alg = PSA_ALG_GCM;
2605 *key_type = PSA_KEY_TYPE_ARIA;
2606 *key_size = 128;
2607 break;
2608 case MBEDTLS_CIPHER_ARIA_192_CCM:
2609 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2610 *key_type = PSA_KEY_TYPE_ARIA;
2611 *key_size = 192;
2612 break;
2613 case MBEDTLS_CIPHER_ARIA_192_GCM:
2614 *alg = PSA_ALG_GCM;
2615 *key_type = PSA_KEY_TYPE_ARIA;
2616 *key_size = 192;
2617 break;
2618 case MBEDTLS_CIPHER_ARIA_256_CBC:
2619 *alg = PSA_ALG_CBC_NO_PADDING;
2620 *key_type = PSA_KEY_TYPE_ARIA;
2621 *key_size = 256;
2622 break;
2623 case MBEDTLS_CIPHER_ARIA_256_CCM:
2624 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2625 *key_type = PSA_KEY_TYPE_ARIA;
2626 *key_size = 256;
2627 break;
2628 case MBEDTLS_CIPHER_ARIA_256_GCM:
2629 *alg = PSA_ALG_GCM;
2630 *key_type = PSA_KEY_TYPE_ARIA;
2631 *key_size = 256;
2632 break;
2633 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2634 *alg = PSA_ALG_CBC_NO_PADDING;
2635 *key_type = PSA_KEY_TYPE_CAMELLIA;
2636 *key_size = 128;
2637 break;
2638 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2639 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2640 *key_type = PSA_KEY_TYPE_CAMELLIA;
2641 *key_size = 128;
2642 break;
2643 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2644 *alg = PSA_ALG_GCM;
2645 *key_type = PSA_KEY_TYPE_CAMELLIA;
2646 *key_size = 128;
2647 break;
2648 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2649 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2650 *key_type = PSA_KEY_TYPE_CAMELLIA;
2651 *key_size = 192;
2652 break;
2653 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2654 *alg = PSA_ALG_GCM;
2655 *key_type = PSA_KEY_TYPE_CAMELLIA;
2656 *key_size = 192;
2657 break;
2658 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2659 *alg = PSA_ALG_CBC_NO_PADDING;
2660 *key_type = PSA_KEY_TYPE_CAMELLIA;
2661 *key_size = 256;
2662 break;
2663 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2664 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2665 *key_type = PSA_KEY_TYPE_CAMELLIA;
2666 *key_size = 256;
2667 break;
2668 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2669 *alg = PSA_ALG_GCM;
2670 *key_type = PSA_KEY_TYPE_CAMELLIA;
2671 *key_size = 256;
2672 break;
2673 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2674 *alg = PSA_ALG_CHACHA20_POLY1305;
2675 *key_type = PSA_KEY_TYPE_CHACHA20;
2676 *key_size = 256;
2677 break;
2678 case MBEDTLS_CIPHER_NULL:
2679 *alg = MBEDTLS_SSL_NULL_CIPHER;
2680 *key_type = 0;
2681 *key_size = 0;
2682 break;
2683 default:
2684 return PSA_ERROR_NOT_SUPPORTED;
2685 }
2686
2687 return PSA_SUCCESS;
2688}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002689#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002690
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002691#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002692int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2693 const unsigned char *dhm_P, size_t P_len,
2694 const unsigned char *dhm_G, size_t G_len )
2695{
Janos Follath865b3eb2019-12-16 11:46:15 +00002696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002697
Glenn Strausscee11292021-12-20 01:43:17 -05002698 mbedtls_mpi_free( &conf->dhm_P );
2699 mbedtls_mpi_free( &conf->dhm_G );
2700
Hanno Beckera90658f2017-10-04 15:29:08 +01002701 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2702 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2703 {
2704 mbedtls_mpi_free( &conf->dhm_P );
2705 mbedtls_mpi_free( &conf->dhm_G );
2706 return( ret );
2707 }
2708
2709 return( 0 );
2710}
Paul Bakker5121ce52009-01-03 21:22:43 +00002711
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002712int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002713{
Janos Follath865b3eb2019-12-16 11:46:15 +00002714 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002715
Glenn Strausscee11292021-12-20 01:43:17 -05002716 mbedtls_mpi_free( &conf->dhm_P );
2717 mbedtls_mpi_free( &conf->dhm_G );
2718
Gilles Peskinee5702482021-06-11 21:59:08 +02002719 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2720 &conf->dhm_P ) ) != 0 ||
2721 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2722 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002723 {
2724 mbedtls_mpi_free( &conf->dhm_P );
2725 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002726 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002727 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002728
2729 return( 0 );
2730}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002731#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002732
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002733#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2734/*
2735 * Set the minimum length for Diffie-Hellman parameters
2736 */
2737void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2738 unsigned int bitlen )
2739{
2740 conf->dhm_min_bitlen = bitlen;
2741}
2742#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2743
Ronald Crone68ab4f2022-10-05 12:46:29 +02002744#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002745#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002746/*
2747 * Set allowed/preferred hashes for handshake signatures
2748 */
2749void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2750 const int *hashes )
2751{
2752 conf->sig_hashes = hashes;
2753}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002754#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002755
Jerry Yuf017ee42022-01-12 15:49:48 +08002756/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002757void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2758 const uint16_t* sig_algs )
2759{
Jerry Yuf017ee42022-01-12 15:49:48 +08002760#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2761 conf->sig_hashes = NULL;
2762#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2763 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002764}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002765#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002766
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002767#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002768#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002769/*
2770 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002771 *
2772 * mbedtls_ssl_setup() takes the provided list
2773 * and translates it to a list of IANA TLS group identifiers,
2774 * stored in ssl->handshake->group_list.
2775 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002776 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002777void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002778 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002779{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002780 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002781 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002782}
Brett Warrene0edc842021-08-17 09:53:13 +01002783#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002784#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002785
Brett Warrene0edc842021-08-17 09:53:13 +01002786/*
2787 * Set the allowed groups
2788 */
2789void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2790 const uint16_t *group_list )
2791{
2792#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2793 conf->curve_list = NULL;
2794#endif
2795 conf->group_list = group_list;
2796}
2797
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002798#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002800{
Hanno Becker947194e2017-04-07 13:25:49 +01002801 /* Initialize to suppress unnecessary compiler warning */
2802 size_t hostname_len = 0;
2803
2804 /* Check if new hostname is valid before
2805 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002806 if( hostname != NULL )
2807 {
2808 hostname_len = strlen( hostname );
2809
2810 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2811 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2812 }
2813
2814 /* Now it's clear that we will overwrite the old hostname,
2815 * so we can free it safely */
2816
2817 if( ssl->hostname != NULL )
2818 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002819 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002820 mbedtls_free( ssl->hostname );
2821 }
2822
2823 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002824
Paul Bakker5121ce52009-01-03 21:22:43 +00002825 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002826 {
2827 ssl->hostname = NULL;
2828 }
2829 else
2830 {
2831 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002832 if( ssl->hostname == NULL )
2833 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002834
Hanno Becker947194e2017-04-07 13:25:49 +01002835 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002836
Hanno Becker947194e2017-04-07 13:25:49 +01002837 ssl->hostname[hostname_len] = '\0';
2838 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002839
2840 return( 0 );
2841}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002842#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002843
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002844#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002845void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002847 const unsigned char *, size_t),
2848 void *p_sni )
2849{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002850 conf->f_sni = f_sni;
2851 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002852}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002856int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002857{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002858 size_t cur_len, tot_len;
2859 const char **p;
2860
2861 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002862 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2863 * MUST NOT be truncated."
2864 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002865 */
2866 tot_len = 0;
2867 for( p = protos; *p != NULL; p++ )
2868 {
2869 cur_len = strlen( *p );
2870 tot_len += cur_len;
2871
Ronald Cron8216dd32020-04-23 16:41:44 +02002872 if( ( cur_len == 0 ) ||
2873 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2874 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002876 }
2877
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002878 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002879
2880 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002881}
2882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002884{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002885 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002886}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002888
Johan Pascalb62bb512015-12-03 21:56:45 +01002889#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002890void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2891 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002892{
2893 conf->dtls_srtp_mki_support = support_mki_value;
2894}
2895
Ron Eldoref72faf2018-07-12 11:54:20 +03002896int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2897 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002898 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002899{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002900 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002901 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002902 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002903 }
Ron Eldor591f1622018-01-22 12:30:04 +02002904
2905 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002906 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002907 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002908 }
Ron Eldor591f1622018-01-22 12:30:04 +02002909
2910 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2911 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002912 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002913}
2914
Ron Eldoref72faf2018-07-12 11:54:20 +03002915int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002916 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002917{
Johan Pascal253d0262020-09-22 13:04:45 +02002918 const mbedtls_ssl_srtp_profile *p;
2919 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920
Johan Pascal253d0262020-09-22 13:04:45 +02002921 /* check the profiles list: all entry must be valid,
2922 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002923 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2924 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2925 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002926 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002927 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002928 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002929 list_size++;
2930 }
2931 else
2932 {
2933 /* unsupported value, stop parsing and set the size to an error value */
2934 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002935 }
2936 }
2937
Johan Pascal5ef72d22020-10-28 17:05:47 +01002938 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002939 {
Johan Pascal253d0262020-09-22 13:04:45 +02002940 conf->dtls_srtp_profile_list = NULL;
2941 conf->dtls_srtp_profile_list_len = 0;
2942 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2943 }
2944
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002945 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002946 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002947
2948 return( 0 );
2949}
2950
Johan Pascal5ef72d22020-10-28 17:05:47 +01002951void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2952 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002953{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002954 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2955 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002956 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002957 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002958 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002959 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002960 else
2961 {
2962 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002963 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2964 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002965 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002966}
Johan Pascalb62bb512015-12-03 21:56:45 +01002967#endif /* MBEDTLS_SSL_DTLS_SRTP */
2968
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302969#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002970void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002971{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002972 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002973}
2974
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002975void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002976{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002977 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002978}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302979#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002980
Janos Follath088ce432017-04-10 12:42:31 +01002981#if defined(MBEDTLS_SSL_SRV_C)
2982void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2983 char cert_req_ca_list )
2984{
2985 conf->cert_req_ca_list = cert_req_ca_list;
2986}
2987#endif
2988
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002990void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002991{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002992 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002993}
2994#endif
2995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002997void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002998{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002999 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003000}
3001#endif
3002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003004int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003005{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10003007 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003008 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003010 }
3011
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003012 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003013
3014 return( 0 );
3015}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003017
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003018void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00003019{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003020 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003021}
3022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003024void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003025{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003026 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003027}
3028
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003029void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003030{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003031 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003032}
3033
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003034void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003035 const unsigned char period[8] )
3036{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003037 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003038}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003042#if defined(MBEDTLS_SSL_CLI_C)
3043void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003044{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003045 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003046}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003047#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003048
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003049#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003050
Jerry Yud0766ec2022-09-22 10:46:57 +08003051#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003052void mbedtls_ssl_conf_new_session_tickets( mbedtls_ssl_config *conf,
3053 uint16_t num_tickets )
3054{
Jerry Yud0766ec2022-09-22 10:46:57 +08003055 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003056}
3057#endif
3058
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003059void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
3060 mbedtls_ssl_ticket_write_t *f_ticket_write,
3061 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3062 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02003063{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003064 conf->f_ticket_write = f_ticket_write;
3065 conf->f_ticket_parse = f_ticket_parse;
3066 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003067}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003068#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003070
Hanno Becker7e6c1782021-06-08 09:24:55 +01003071void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
3072 mbedtls_ssl_export_keys_t *f_export_keys,
3073 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003074{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003075 ssl->f_export_keys = f_export_keys;
3076 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003077}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003078
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003079#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003080void mbedtls_ssl_conf_async_private_cb(
3081 mbedtls_ssl_config *conf,
3082 mbedtls_ssl_async_sign_t *f_async_sign,
3083 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3084 mbedtls_ssl_async_resume_t *f_async_resume,
3085 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003086 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003087{
3088 conf->f_async_sign_start = f_async_sign;
3089 conf->f_async_decrypt_start = f_async_decrypt;
3090 conf->f_async_resume = f_async_resume;
3091 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003092 conf->p_async_config_data = async_config_data;
3093}
3094
Gilles Peskine8f97af72018-04-26 11:46:10 +02003095void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
3096{
3097 return( conf->p_async_config_data );
3098}
3099
Gilles Peskine1febfef2018-04-30 11:54:39 +02003100void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003101{
3102 if( ssl->handshake == NULL )
3103 return( NULL );
3104 else
3105 return( ssl->handshake->user_async_ctx );
3106}
3107
Gilles Peskine1febfef2018-04-30 11:54:39 +02003108void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003109 void *ctx )
3110{
3111 if( ssl->handshake != NULL )
3112 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003113}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003114#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003115
Paul Bakker5121ce52009-01-03 21:22:43 +00003116/*
3117 * SSL get accessors
3118 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003119uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003120{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003121 if( ssl->session != NULL )
3122 return( ssl->session->verify_result );
3123
3124 if( ssl->session_negotiate != NULL )
3125 return( ssl->session_negotiate->verify_result );
3126
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02003127 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00003128}
3129
Glenn Strauss8f526902022-01-13 00:04:49 -05003130int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
3131{
3132 if( ssl == NULL || ssl->session == NULL )
3133 return( 0 );
3134
3135 return( ssl->session->ciphersuite );
3136}
3137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00003139{
Paul Bakker926c8e42013-03-06 10:23:34 +01003140 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003141 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01003142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00003144}
3145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00003147{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003149 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003150 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003151 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003152 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003153 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003154 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003155 default:
3156 return( "unknown (DTLS)" );
3157 }
3158 }
3159#endif
3160
Glenn Strauss60bfe602022-03-14 19:04:24 -04003161 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00003162 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003163 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00003164 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04003165 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01003166 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003167 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003168 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003169 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003170}
3171
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003172#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003173size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
3174{
David Horstmann95d516f2021-05-04 18:36:56 +01003175 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003176 size_t read_mfl;
3177
3178 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
3179 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3180 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
3181 {
3182 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
3183 }
3184
3185 /* Check if a smaller max length was negotiated */
3186 if( ssl->session_out != NULL )
3187 {
3188 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
3189 if( read_mfl < max_len )
3190 {
3191 max_len = read_mfl;
3192 }
3193 }
3194
3195 // During a handshake, use the value being negotiated
3196 if( ssl->session_negotiate != NULL )
3197 {
3198 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3199 if( read_mfl < max_len )
3200 {
3201 max_len = read_mfl;
3202 }
3203 }
3204
3205 return( max_len );
3206}
3207
3208size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003209{
3210 size_t max_len;
3211
3212 /*
3213 * Assume mfl_code is correct since it was checked when set
3214 */
Angus Grattond8213d02016-05-25 20:56:48 +10003215 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003216
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003217 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003218 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10003219 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003220 {
Angus Grattond8213d02016-05-25 20:56:48 +10003221 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003222 }
3223
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003224 /* During a handshake, use the value being negotiated */
3225 if( ssl->session_negotiate != NULL &&
3226 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
3227 {
3228 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3229 }
3230
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003231 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003232}
3233#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3234
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003235#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003236size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003237{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003238 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
3239 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3240 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3241 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
3242 return ( 0 );
3243
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003244 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
3245 return( ssl->mtu );
3246
3247 if( ssl->mtu == 0 )
3248 return( ssl->handshake->mtu );
3249
3250 return( ssl->mtu < ssl->handshake->mtu ?
3251 ssl->mtu : ssl->handshake->mtu );
3252}
3253#endif /* MBEDTLS_SSL_PROTO_DTLS */
3254
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003255int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
3256{
3257 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3258
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003259#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3260 !defined(MBEDTLS_SSL_PROTO_DTLS)
3261 (void) ssl;
3262#endif
3263
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003265 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266
3267 if( max_len > mfl )
3268 max_len = mfl;
3269#endif
3270
3271#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003272 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003273 {
Hanno Becker89490712020-02-05 10:50:12 +00003274 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003275 const int ret = mbedtls_ssl_get_record_expansion( ssl );
3276 const size_t overhead = (size_t) ret;
3277
3278 if( ret < 0 )
3279 return( ret );
3280
3281 if( mtu <= overhead )
3282 {
3283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
3284 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3285 }
3286
3287 if( max_len > mtu - overhead )
3288 max_len = mtu - overhead;
3289 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003291
Hanno Becker0defedb2018-08-10 12:35:02 +01003292#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3293 !defined(MBEDTLS_SSL_PROTO_DTLS)
3294 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295#endif
3296
3297 return( (int) max_len );
3298}
3299
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003300int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
3301{
3302 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3303
3304#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3305 (void) ssl;
3306#endif
3307
3308#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3309 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
3310
3311 if( max_len > mfl )
3312 max_len = mfl;
3313#endif
3314
3315 return( (int) max_len );
3316}
3317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318#if defined(MBEDTLS_X509_CRT_PARSE_C)
3319const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00003320{
3321 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003322 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00003323
Hanno Beckere6824572019-02-07 13:18:46 +00003324#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003325 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00003326#else
3327 return( NULL );
3328#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003329}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00003333int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3334 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003335{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003336 int ret;
3337
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003338 if( ssl == NULL ||
3339 dst == NULL ||
3340 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003341 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003342 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003344 }
3345
Hanno Beckere810bbc2021-05-14 16:01:05 +01003346 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3347 * idempotent: Each session can only be exported once.
3348 *
3349 * (This is in preparation for TLS 1.3 support where we will
3350 * need the ability to export multiple sessions (aka tickets),
3351 * which will be achieved by calling mbedtls_ssl_get_session()
3352 * multiple times until it fails.)
3353 *
3354 * Check whether we have already exported the current session,
3355 * and fail if so.
3356 */
3357 if( ssl->session->exported == 1 )
3358 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3359
3360 ret = mbedtls_ssl_session_copy( dst, ssl->session );
3361 if( ret != 0 )
3362 return( ret );
3363
3364 /* Remember that we've exported the session. */
3365 ssl->session->exported = 1;
3366 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003369
Paul Bakker5121ce52009-01-03 21:22:43 +00003370/*
Hanno Beckera835da52019-05-16 12:39:07 +01003371 * Define ticket header determining Mbed TLS version
3372 * and structure of the ticket.
3373 */
3374
Hanno Becker94ef3b32019-05-16 12:50:45 +01003375/*
Hanno Becker50b59662019-05-28 14:30:45 +01003376 * Define bitflag determining compile-time settings influencing
3377 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003378 */
3379
Hanno Becker50b59662019-05-28 14:30:45 +01003380#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003381#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003382#else
Hanno Becker3e088662019-05-29 11:10:18 +01003383#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003384#endif /* MBEDTLS_HAVE_TIME */
3385
3386#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003387#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003388#else
Hanno Becker3e088662019-05-29 11:10:18 +01003389#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003390#endif /* MBEDTLS_X509_CRT_PARSE_C */
3391
3392#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003393#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003394#else
Hanno Becker3e088662019-05-29 11:10:18 +01003395#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003396#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3397
3398#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003399#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003400#else
Hanno Becker3e088662019-05-29 11:10:18 +01003401#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003402#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3403
Hanno Becker94ef3b32019-05-16 12:50:45 +01003404#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003405#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003406#else
Hanno Becker3e088662019-05-29 11:10:18 +01003407#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003408#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3409
Hanno Becker94ef3b32019-05-16 12:50:45 +01003410#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3411#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3412#else
3413#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3414#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3415
Hanno Becker3e088662019-05-29 11:10:18 +01003416#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3417#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3418#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3419#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003420#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3421#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003422
Hanno Becker50b59662019-05-28 14:30:45 +01003423#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01003424 ( (uint16_t) ( \
3425 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
3426 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
3427 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
3428 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01003429 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01003430 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01003431
Hanno Beckerf8787072019-05-16 12:41:07 +01003432static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003433 MBEDTLS_VERSION_MAJOR,
3434 MBEDTLS_VERSION_MINOR,
3435 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003436 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3437 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01003438};
Hanno Beckera835da52019-05-16 12:39:07 +01003439
3440/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003441 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003442 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003443 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003444 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003445 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003446 * opaque mbedtls_version[3]; // library version: major, minor, patch
3447 * opaque session_format[2]; // library-version specific 16-bit field
3448 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003449 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003450 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003451 * Note: When updating the format, remember to keep
3452 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003453 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003454 * // In this version, `session_format` determines
3455 * // the setting of those compile-time
3456 * // configuration options which influence
3457 * // the structure of mbedtls_ssl_session.
3458 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003459 * uint8_t minor_ver; // Protocol minor version. Possible values:
3460 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003461 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003462 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003463 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003464 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003465 * serialized_session_tls12 data;
3466 *
3467 * };
3468 *
3469 * } serialized_session;
3470 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003471 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003472
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003473MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003474static int ssl_session_save( const mbedtls_ssl_session *session,
3475 unsigned char omit_header,
3476 unsigned char *buf,
3477 size_t buf_len,
3478 size_t *olen )
3479{
3480 unsigned char *p = buf;
3481 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003482 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003483#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3484 size_t out_len;
3485 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3486#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003487 if( session == NULL )
3488 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3489
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003490 if( !omit_header )
3491 {
3492 /*
3493 * Add Mbed TLS version identifier
3494 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003495 used += sizeof( ssl_serialized_session_header );
3496
3497 if( used <= buf_len )
3498 {
3499 memcpy( p, ssl_serialized_session_header,
3500 sizeof( ssl_serialized_session_header ) );
3501 p += sizeof( ssl_serialized_session_header );
3502 }
3503 }
3504
3505 /*
3506 * TLS version identifier
3507 */
3508 used += 1;
3509 if( used <= buf_len )
3510 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003511 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003512 }
3513
3514 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003515 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003516 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003517 {
3518#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003519 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003520 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003521 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003522#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3523
Jerry Yu251a12e2022-07-13 15:15:48 +08003524#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3525 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003526 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3527 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
Jerry Yue36fdd62022-08-17 21:31:36 +08003528 return( ret );
Jerry Yue36fdd62022-08-17 21:31:36 +08003529 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003530 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003531#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3532
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003533 default:
3534 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3535 }
3536
3537 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003538 if( used > buf_len )
3539 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003540
3541 return( 0 );
3542}
3543
3544/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003545 * Public wrapper for ssl_session_save()
3546 */
3547int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3548 unsigned char *buf,
3549 size_t buf_len,
3550 size_t *olen )
3551{
3552 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3553}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003554
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003555/*
3556 * Deserialize session, see mbedtls_ssl_session_save() for format.
3557 *
3558 * This internal version is wrapped by a public function that cleans up in
3559 * case of error, and has an extra option omit_header.
3560 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003561MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003562static int ssl_session_load( mbedtls_ssl_session *session,
3563 unsigned char omit_header,
3564 const unsigned char *buf,
3565 size_t len )
3566{
3567 const unsigned char *p = buf;
3568 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003569 size_t remaining_len;
3570
3571
3572 if( session == NULL )
3573 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003574
3575 if( !omit_header )
3576 {
3577 /*
3578 * Check Mbed TLS version identifier
3579 */
3580
3581 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3582 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3583
3584 if( memcmp( p, ssl_serialized_session_header,
3585 sizeof( ssl_serialized_session_header ) ) != 0 )
3586 {
3587 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3588 }
3589 p += sizeof( ssl_serialized_session_header );
3590 }
3591
3592 /*
3593 * TLS version identifier
3594 */
3595 if( 1 > (size_t)( end - p ) )
3596 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003597 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003598
3599 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003600 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003601 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003602 {
3603#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003604 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003605 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003606#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3607
Jerry Yu438ddd82022-07-07 06:55:50 +00003608#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3609 case MBEDTLS_SSL_VERSION_TLS1_3:
3610 return( ssl_tls13_session_load( session, p, remaining_len ) );
3611#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3612
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003613 default:
3614 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3615 }
3616}
3617
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003618/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003619 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003620 */
3621int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3622 const unsigned char *buf,
3623 size_t len )
3624{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003625 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003626
3627 if( ret != 0 )
3628 mbedtls_ssl_session_free( session );
3629
3630 return( ret );
3631}
3632
3633/*
Paul Bakker1961b702013-01-25 14:49:24 +01003634 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003635 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003636MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003637static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3638{
3639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3640
Ronald Cron66dbf912022-02-02 15:33:46 +01003641 /*
3642 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003643 * that were written into the output buffer by the previous handshake step,
3644 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003645 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3646 * We proceed to the next handshake step only when all data from the
3647 * previous one have been sent to the peer, thus we make sure that this is
3648 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3649 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3650 * we have to wait before to go ahead.
3651 * In the case of TLS 1.3, handshake step handlers do not send data to the
3652 * peer. Data are only sent here and through
3653 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003654 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003655 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003656 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3657 return( ret );
3658
3659#if defined(MBEDTLS_SSL_PROTO_DTLS)
3660 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3661 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3662 {
3663 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3664 return( ret );
3665 }
3666#endif /* MBEDTLS_SSL_PROTO_DTLS */
3667
3668 return( ret );
3669}
3670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003672{
Hanno Becker41934dd2021-08-07 19:13:43 +01003673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003674
Hanno Becker41934dd2021-08-07 19:13:43 +01003675 if( ssl == NULL ||
3676 ssl->conf == NULL ||
3677 ssl->handshake == NULL ||
Jerry Yu1fb32992022-10-27 13:18:19 +08003678 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker41934dd2021-08-07 19:13:43 +01003679 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003680 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003681 }
3682
3683 ret = ssl_prepare_handshake_step( ssl );
3684 if( ret != 0 )
3685 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003686
Jerry Yue7047812021-09-13 19:26:39 +08003687 ret = mbedtls_ssl_handle_pending_alert( ssl );
3688 if( ret != 0 )
3689 goto cleanup;
3690
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003691 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3692 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3693 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003695#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003696 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003697 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003698 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3699 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003700
Ronald Cron9f0fba32022-02-10 16:45:15 +01003701 switch( ssl->state )
3702 {
3703 case MBEDTLS_SSL_HELLO_REQUEST:
3704 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003705 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003706 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003707
Ronald Cron9f0fba32022-02-10 16:45:15 +01003708 case MBEDTLS_SSL_CLIENT_HELLO:
3709 ret = mbedtls_ssl_write_client_hello( ssl );
3710 break;
3711
3712 default:
3713#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003714 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003715 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3716 else
3717 ret = mbedtls_ssl_handshake_client_step( ssl );
3718#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3719 ret = mbedtls_ssl_handshake_client_step( ssl );
3720#else
3721 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3722#endif
3723 }
Jerry Yub9930e72021-08-06 17:11:51 +08003724 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003725#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003727 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003728 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003729#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003730 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003731 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003732#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003733
3734#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3735 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3736 ret = mbedtls_ssl_handshake_server_step( ssl );
3737#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3738 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003739#endif
3740
Jerry Yue7047812021-09-13 19:26:39 +08003741 if( ret != 0 )
3742 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003743 /* handshake_step return error. And it is same
3744 * with alert_reason.
3745 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003746 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003747 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003748 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003749 goto cleanup;
3750 }
3751 }
3752
3753cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003754 return( ret );
3755}
3756
3757/*
3758 * Perform the SSL handshake
3759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003760int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003761{
3762 int ret = 0;
3763
Hanno Beckera817ea42020-10-20 15:20:23 +01003764 /* Sanity checks */
3765
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003766 if( ssl == NULL || ssl->conf == NULL )
3767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3768
Hanno Beckera817ea42020-10-20 15:20:23 +01003769#if defined(MBEDTLS_SSL_PROTO_DTLS)
3770 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3771 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3772 {
3773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3774 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3775 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3776 }
3777#endif /* MBEDTLS_SSL_PROTO_DTLS */
3778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003780
Hanno Beckera817ea42020-10-20 15:20:23 +01003781 /* Main handshake loop */
Jerry Yu1fb32992022-10-27 13:18:19 +08003782 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01003783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003785
3786 if( ret != 0 )
3787 break;
3788 }
3789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003790 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003791
3792 return( ret );
3793}
3794
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003795#if defined(MBEDTLS_SSL_RENEGOTIATION)
3796#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003797/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003798 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003799 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003800MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003801static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003802{
Janos Follath865b3eb2019-12-16 11:46:15 +00003803 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003806
3807 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3809 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003810
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003811 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003812 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003813 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003814 return( ret );
3815 }
3816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003818
3819 return( 0 );
3820}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003821#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003822
3823/*
3824 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003825 * - any side: calling mbedtls_ssl_renegotiate(),
3826 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3827 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003828 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003829 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003831 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003832int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003833{
Janos Follath865b3eb2019-12-16 11:46:15 +00003834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003837
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003838 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3839 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003840
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003841 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3842 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003843#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003844 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003846 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003847 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003848 ssl->handshake->out_msg_seq = 1;
3849 else
3850 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003851 }
3852#endif
3853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003854 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3855 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003857 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003858 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003859 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003860 return( ret );
3861 }
3862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003864
3865 return( 0 );
3866}
3867
3868/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003869 * Renegotiate current connection on client,
3870 * or request renegotiation on server
3871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003872int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003873{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003874 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003875
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003876 if( ssl == NULL || ssl->conf == NULL )
3877 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003880 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003881 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003882 {
Jerry Yu6848a612022-10-27 13:03:26 +08003883 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003884 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003887
3888 /* Did we already try/start sending HelloRequest? */
3889 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003890 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003891
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003892 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003893 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003894#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003896#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003897 /*
3898 * On client, either start the renegotiation process or,
3899 * if already in progress, continue the handshake
3900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003901 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003902 {
Jerry Yu6848a612022-10-27 13:03:26 +08003903 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003904 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003905
Hanno Becker40cdaa12020-02-05 10:48:27 +00003906 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003907 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003908 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003909 return( ret );
3910 }
3911 }
3912 else
3913 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003914 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003915 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003916 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003917 return( ret );
3918 }
3919 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003920#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003921
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003922 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003923}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003924#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003925
Gilles Peskine9b562d52018-04-25 20:32:43 +02003926void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003927{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003928 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3929
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003930 if( handshake == NULL )
3931 return;
3932
Brett Warrene0edc842021-08-17 09:53:13 +01003933#if defined(MBEDTLS_ECP_C)
3934#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3935 if ( ssl->handshake->group_list_heap_allocated )
3936 mbedtls_free( (void*) handshake->group_list );
3937 handshake->group_list = NULL;
3938#endif /* MBEDTLS_DEPRECATED_REMOVED */
3939#endif /* MBEDTLS_ECP_C */
3940
Ronald Crone68ab4f2022-10-05 12:46:29 +02003941#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003942#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3943 if ( ssl->handshake->sig_algs_heap_allocated )
3944 mbedtls_free( (void*) handshake->sig_algs );
3945 handshake->sig_algs = NULL;
3946#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003947#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3948 if( ssl->handshake->certificate_request_context )
3949 {
3950 mbedtls_free( (void*) handshake->certificate_request_context );
3951 }
3952#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02003953#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08003954
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003955#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3956 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3957 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003958 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003959 handshake->async_in_progress = 0;
3960 }
3961#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3962
Andrzej Kurek25f27152022-08-17 16:09:31 -04003963#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003964#if defined(MBEDTLS_USE_PSA_CRYPTO)
3965 psa_hash_abort( &handshake->fin_sha256_psa );
3966#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003967 mbedtls_sha256_free( &handshake->fin_sha256 );
3968#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003969#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04003970#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003971#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003972 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003973#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003974 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003975#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003976#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978#if defined(MBEDTLS_DHM_C)
3979 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003980#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003981#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003983#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01003984
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003985#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02003986#if defined(MBEDTLS_USE_PSA_CRYPTO)
3987 psa_pake_abort( &handshake->psa_pake_ctx );
3988 psa_destroy_key( handshake->psa_pake_password );
3989 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
3990#else
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003991 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Neil Armstrongca7d5062022-05-31 14:43:23 +02003992#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003993#if defined(MBEDTLS_SSL_CLI_C)
3994 mbedtls_free( handshake->ecjpake_cache );
3995 handshake->ecjpake_cache = NULL;
3996 handshake->ecjpake_cache_len = 0;
3997#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003998#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003999
Janos Follath4ae5c292016-02-10 11:27:43 +00004000#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4001 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004002 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004003 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004004#endif
4005
Ronald Cron73fe8df2022-10-05 14:31:43 +02004006#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004007#if defined(MBEDTLS_USE_PSA_CRYPTO)
4008 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
4009 {
4010 /* The maintenance of the external PSK key slot is the
4011 * user's responsibility. */
4012 if( ssl->handshake->psk_opaque_is_internal )
4013 {
4014 psa_destroy_key( ssl->handshake->psk_opaque );
4015 ssl->handshake->psk_opaque_is_internal = 0;
4016 }
4017 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4018 }
Neil Armstronge952a302022-05-03 10:22:14 +02004019#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004020 if( handshake->psk != NULL )
4021 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004022 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004023 mbedtls_free( handshake->psk );
4024 }
Neil Armstronge952a302022-05-03 10:22:14 +02004025#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004026#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004028#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4029 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004030 /*
4031 * Free only the linked list wrapper, not the keys themselves
4032 * since the belong to the SNI callback
4033 */
Glenn Strauss36872db2022-01-22 05:06:31 -05004034 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004035#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004036
Gilles Peskineeccd8882020-03-10 12:19:08 +01004037#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02004038 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00004039 if( handshake->ecrs_peer_cert != NULL )
4040 {
4041 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
4042 mbedtls_free( handshake->ecrs_peer_cert );
4043 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004044#endif
4045
Hanno Becker75173122019-02-06 16:18:31 +00004046#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4047 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4048 mbedtls_pk_free( &handshake->peer_pubkey );
4049#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4050
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004051#if defined(MBEDTLS_SSL_CLI_C) && \
4052 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
4053 mbedtls_free( handshake->cookie );
4054#endif /* MBEDTLS_SSL_CLI_C &&
4055 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004056
4057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00004058 mbedtls_ssl_flight_free( handshake->flight );
4059 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00004060#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004061
Ronald Cronf12b81d2022-03-15 10:42:41 +01004062#if defined(MBEDTLS_ECDH_C) && \
4063 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02004064 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01004065 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00004066#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4067
Ronald Cron6f135e12021-12-08 16:57:54 +01004068#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08004069 mbedtls_ssl_transform_free( handshake->transform_handshake );
4070 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08004071 mbedtls_free( handshake->transform_earlydata );
4072 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01004073#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004074
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004075
4076#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4077 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4078 * processes datagrams and the fact that a datagram is allowed to have
4079 * several records in it, it is possible that the I/O buffers are not
4080 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02004081 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
4082 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004083#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004084
Jerry Yuba9c7272021-10-30 11:54:10 +08004085 /* mbedtls_platform_zeroize MUST be last one in this function */
4086 mbedtls_platform_zeroize( handshake,
4087 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004088}
4089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004090void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00004091{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004092 if( session == NULL )
4093 return;
4094
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004095#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00004096 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02004097#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004098
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004099#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004100#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4101 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004102 mbedtls_free( session->hostname );
4103#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004104 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02004105#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004106
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004107 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004108}
4109
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004110#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004111
4112#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4113#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4114#else
4115#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4116#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4117
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004118#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004119
4120#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4121#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4122#else
4123#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4124#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4125
4126#if defined(MBEDTLS_SSL_ALPN)
4127#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4128#else
4129#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4130#endif /* MBEDTLS_SSL_ALPN */
4131
4132#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4133#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4134#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4135#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4136
4137#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
4138 ( (uint32_t) ( \
4139 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
4140 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
4141 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
4142 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
4143 0u ) )
4144
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004145static unsigned char ssl_serialized_context_header[] = {
4146 MBEDTLS_VERSION_MAJOR,
4147 MBEDTLS_VERSION_MINOR,
4148 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01004149 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4150 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4151 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4152 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4153 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004154};
4155
Paul Bakker5121ce52009-01-03 21:22:43 +00004156/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004157 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004158 *
4159 * The format of the serialized data is:
4160 * (in the presentation language of TLS, RFC 8446 section 3)
4161 *
4162 * // header
4163 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004164 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004165 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004166 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004167 * Note: When updating the format, remember to keep these
4168 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004169 *
4170 * // session sub-structure
4171 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4172 * // transform sub-structure
4173 * uint8 random[64]; // ServerHello.random+ClientHello.random
4174 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4175 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4176 * // fields from ssl_context
4177 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4178 * uint64 in_window_top; // DTLS: last validated record seq_num
4179 * uint64 in_window; // DTLS: bitmask for replay protection
4180 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4181 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4182 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4183 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4184 *
4185 * Note that many fields of the ssl_context or sub-structures are not
4186 * serialized, as they fall in one of the following categories:
4187 *
4188 * 1. forced value (eg in_left must be 0)
4189 * 2. pointer to dynamically-allocated memory (eg session, transform)
4190 * 3. value can be re-derived from other data (eg session keys from MS)
4191 * 4. value was temporary (eg content of input buffer)
4192 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004193 */
4194int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4195 unsigned char *buf,
4196 size_t buf_len,
4197 size_t *olen )
4198{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004199 unsigned char *p = buf;
4200 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004201 size_t session_len;
4202 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004203
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004204 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004205 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4206 * this function's documentation.
4207 *
4208 * These are due to assumptions/limitations in the implementation. Some of
4209 * them are likely to stay (no handshake in progress) some might go away
4210 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004211 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004212 /* The initial handshake must be over */
Jerry Yu6848a612022-10-27 13:03:26 +08004213 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004214 {
4215 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004216 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004217 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004218 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004219 {
4220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004221 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004222 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004223 /* Double-check that sub-structures are indeed ready */
4224 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004225 {
4226 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004227 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004228 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004229 /* There must be no pending incoming or outgoing data */
4230 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004231 {
4232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004233 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004234 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004235 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004236 {
4237 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004238 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004239 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004240 /* Protocol must be DLTS, not TLS */
4241 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004242 {
4243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004244 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004245 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004246 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004247 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004248 {
4249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004250 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004251 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004252 /* We must be using an AEAD ciphersuite */
4253 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004254 {
4255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004256 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004257 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004258 /* Renegotiation must not be enabled */
4259#if defined(MBEDTLS_SSL_RENEGOTIATION)
4260 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004261 {
4262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004263 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004264 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004265#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004266
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004267 /*
4268 * Version and format identifier
4269 */
4270 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004271
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004272 if( used <= buf_len )
4273 {
4274 memcpy( p, ssl_serialized_context_header,
4275 sizeof( ssl_serialized_context_header ) );
4276 p += sizeof( ssl_serialized_context_header );
4277 }
4278
4279 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004280 * Session (length + data)
4281 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004282 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004283 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
4284 return( ret );
4285
4286 used += 4 + session_len;
4287 if( used <= buf_len )
4288 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004289 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
4290 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004291
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004292 ret = ssl_session_save( ssl->session, 1,
4293 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004294 if( ret != 0 )
4295 return( ret );
4296
4297 p += session_len;
4298 }
4299
4300 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004301 * Transform
4302 */
4303 used += sizeof( ssl->transform->randbytes );
4304 if( used <= buf_len )
4305 {
4306 memcpy( p, ssl->transform->randbytes,
4307 sizeof( ssl->transform->randbytes ) );
4308 p += sizeof( ssl->transform->randbytes );
4309 }
4310
4311#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4312 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
4313 if( used <= buf_len )
4314 {
4315 *p++ = ssl->transform->in_cid_len;
4316 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
4317 p += ssl->transform->in_cid_len;
4318
4319 *p++ = ssl->transform->out_cid_len;
4320 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
4321 p += ssl->transform->out_cid_len;
4322 }
4323#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4324
4325 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004326 * Saved fields from top-level ssl_context structure
4327 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004328 used += 4;
4329 if( used <= buf_len )
4330 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004331 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
4332 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004333 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004334
4335#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4336 used += 16;
4337 if( used <= buf_len )
4338 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004339 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
4340 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004341
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004342 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
4343 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004344 }
4345#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4346
4347#if defined(MBEDTLS_SSL_PROTO_DTLS)
4348 used += 1;
4349 if( used <= buf_len )
4350 {
4351 *p++ = ssl->disable_datagram_packing;
4352 }
4353#endif /* MBEDTLS_SSL_PROTO_DTLS */
4354
Jerry Yuae0b2e22021-10-08 15:21:19 +08004355 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004356 if( used <= buf_len )
4357 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004358 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
4359 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004360 }
4361
4362#if defined(MBEDTLS_SSL_PROTO_DTLS)
4363 used += 2;
4364 if( used <= buf_len )
4365 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004366 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
4367 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004368 }
4369#endif /* MBEDTLS_SSL_PROTO_DTLS */
4370
4371#if defined(MBEDTLS_SSL_ALPN)
4372 {
4373 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02004374 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004375 : 0;
4376
4377 used += 1 + alpn_len;
4378 if( used <= buf_len )
4379 {
4380 *p++ = alpn_len;
4381
4382 if( ssl->alpn_chosen != NULL )
4383 {
4384 memcpy( p, ssl->alpn_chosen, alpn_len );
4385 p += alpn_len;
4386 }
4387 }
4388 }
4389#endif /* MBEDTLS_SSL_ALPN */
4390
4391 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004392 * Done
4393 */
4394 *olen = used;
4395
4396 if( used > buf_len )
4397 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004398
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004399 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
4400
Hanno Becker43aefe22020-02-05 10:44:56 +00004401 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004402}
4403
4404/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004405 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004406 *
4407 * This internal version is wrapped by a public function that cleans up in
4408 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004409 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004410MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004411static int ssl_context_load( mbedtls_ssl_context *ssl,
4412 const unsigned char *buf,
4413 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004414{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004415 const unsigned char *p = buf;
4416 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004417 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004418 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004419#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004420 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004421#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004422
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004423 /*
4424 * The context should have been freshly setup or reset.
4425 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004426 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004427 * renegotiating, or if the user mistakenly loaded a session first.)
4428 */
4429 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4430 ssl->session != NULL )
4431 {
4432 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4433 }
4434
4435 /*
4436 * We can't check that the config matches the initial one, but we can at
4437 * least check it matches the requirements for serializing.
4438 */
4439 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004440 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4441 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004442#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004443 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004444#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004445 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004446 {
4447 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4448 }
4449
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004450 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
4451
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004452 /*
4453 * Check version identifier
4454 */
4455 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
4456 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4457
4458 if( memcmp( p, ssl_serialized_context_header,
4459 sizeof( ssl_serialized_context_header ) ) != 0 )
4460 {
4461 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
4462 }
4463 p += sizeof( ssl_serialized_context_header );
4464
4465 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004466 * Session
4467 */
4468 if( (size_t)( end - p ) < 4 )
4469 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4470
4471 session_len = ( (size_t) p[0] << 24 ) |
4472 ( (size_t) p[1] << 16 ) |
4473 ( (size_t) p[2] << 8 ) |
4474 ( (size_t) p[3] );
4475 p += 4;
4476
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004477 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004478 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004479 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004480 ssl->session_in = ssl->session;
4481 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004482 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004483
4484 if( (size_t)( end - p ) < session_len )
4485 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4486
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004487 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004488 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004489 {
4490 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004491 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004492 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004493
4494 p += session_len;
4495
4496 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004497 * Transform
4498 */
4499
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004500 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004501 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004502 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004503 ssl->transform_in = ssl->transform;
4504 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004505 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004506
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004507#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004508 prf_func = ssl_tls12prf_from_cs( ssl->session->ciphersuite );
4509 if( prf_func == NULL )
4510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4511
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004512 /* Read random bytes and populate structure */
4513 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4514 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004515
Hanno Beckerbd257552021-03-22 06:59:27 +00004516 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004517 ssl->session->ciphersuite,
4518 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004519#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004520 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004521#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Andrzej Kurek894edde2022-09-29 06:31:14 -04004522 prf_func,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004523 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004524 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004525 ssl->conf->endpoint,
4526 ssl );
4527 if( ret != 0 )
4528 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004529#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004530 p += sizeof( ssl->transform->randbytes );
4531
4532#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4533 /* Read connection IDs and store them */
4534 if( (size_t)( end - p ) < 1 )
4535 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4536
4537 ssl->transform->in_cid_len = *p++;
4538
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004539 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004540 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4541
4542 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4543 p += ssl->transform->in_cid_len;
4544
4545 ssl->transform->out_cid_len = *p++;
4546
4547 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4548 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4549
4550 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4551 p += ssl->transform->out_cid_len;
4552#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4553
4554 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004555 * Saved fields from top-level ssl_context structure
4556 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004557 if( (size_t)( end - p ) < 4 )
4558 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4559
4560 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4561 ( (uint32_t) p[1] << 16 ) |
4562 ( (uint32_t) p[2] << 8 ) |
4563 ( (uint32_t) p[3] );
4564 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004565
4566#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4567 if( (size_t)( end - p ) < 16 )
4568 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4569
4570 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4571 ( (uint64_t) p[1] << 48 ) |
4572 ( (uint64_t) p[2] << 40 ) |
4573 ( (uint64_t) p[3] << 32 ) |
4574 ( (uint64_t) p[4] << 24 ) |
4575 ( (uint64_t) p[5] << 16 ) |
4576 ( (uint64_t) p[6] << 8 ) |
4577 ( (uint64_t) p[7] );
4578 p += 8;
4579
4580 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4581 ( (uint64_t) p[1] << 48 ) |
4582 ( (uint64_t) p[2] << 40 ) |
4583 ( (uint64_t) p[3] << 32 ) |
4584 ( (uint64_t) p[4] << 24 ) |
4585 ( (uint64_t) p[5] << 16 ) |
4586 ( (uint64_t) p[6] << 8 ) |
4587 ( (uint64_t) p[7] );
4588 p += 8;
4589#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4590
4591#if defined(MBEDTLS_SSL_PROTO_DTLS)
4592 if( (size_t)( end - p ) < 1 )
4593 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4594
4595 ssl->disable_datagram_packing = *p++;
4596#endif /* MBEDTLS_SSL_PROTO_DTLS */
4597
Jerry Yud9a94fe2021-09-28 18:58:59 +08004598 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004599 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004600 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4601 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004602
4603#if defined(MBEDTLS_SSL_PROTO_DTLS)
4604 if( (size_t)( end - p ) < 2 )
4605 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4606
4607 ssl->mtu = ( p[0] << 8 ) | p[1];
4608 p += 2;
4609#endif /* MBEDTLS_SSL_PROTO_DTLS */
4610
4611#if defined(MBEDTLS_SSL_ALPN)
4612 {
4613 uint8_t alpn_len;
4614 const char **cur;
4615
4616 if( (size_t)( end - p ) < 1 )
4617 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4618
4619 alpn_len = *p++;
4620
4621 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4622 {
4623 /* alpn_chosen should point to an item in the configured list */
4624 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4625 {
4626 if( strlen( *cur ) == alpn_len &&
4627 memcmp( p, cur, alpn_len ) == 0 )
4628 {
4629 ssl->alpn_chosen = *cur;
4630 break;
4631 }
4632 }
4633 }
4634
4635 /* can only happen on conf mismatch */
4636 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4637 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4638
4639 p += alpn_len;
4640 }
4641#endif /* MBEDTLS_SSL_ALPN */
4642
4643 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004644 * Forced fields from top-level ssl_context structure
4645 *
4646 * Most of them already set to the correct value by mbedtls_ssl_init() and
4647 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4648 */
4649 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004650 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004651
Hanno Becker361b10d2019-08-30 10:42:49 +01004652 /* Adjust pointers for header fields of outgoing records to
4653 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004654 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004655
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004656#if defined(MBEDTLS_SSL_PROTO_DTLS)
4657 ssl->in_epoch = 1;
4658#endif
4659
4660 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4661 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004662 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4663 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004664 if( ssl->handshake != NULL )
4665 {
4666 mbedtls_ssl_handshake_free( ssl );
4667 mbedtls_free( ssl->handshake );
4668 ssl->handshake = NULL;
4669 }
4670
4671 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004672 * Done - should have consumed entire buffer
4673 */
4674 if( p != end )
4675 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004676
4677 return( 0 );
4678}
4679
4680/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004681 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004682 */
4683int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4684 const unsigned char *buf,
4685 size_t len )
4686{
4687 int ret = ssl_context_load( context, buf, len );
4688
4689 if( ret != 0 )
4690 mbedtls_ssl_free( context );
4691
4692 return( ret );
4693}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004694#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004695
4696/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004697 * Free an SSL context
4698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004700{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004701 if( ssl == NULL )
4702 return;
4703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004705
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004706 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004707 {
sander-visserb8aa2072020-05-06 22:05:13 +02004708#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4709 size_t out_buf_len = ssl->out_buf_len;
4710#else
4711 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4712#endif
4713
Darryl Greenb33cc762019-11-28 14:29:44 +00004714 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004716 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004717 }
4718
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004719 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004720 {
sander-visserb8aa2072020-05-06 22:05:13 +02004721#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4722 size_t in_buf_len = ssl->in_buf_len;
4723#else
4724 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4725#endif
4726
Darryl Greenb33cc762019-11-28 14:29:44 +00004727 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004729 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004730 }
4731
Paul Bakker48916f92012-09-16 19:57:18 +00004732 if( ssl->transform )
4733 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734 mbedtls_ssl_transform_free( ssl->transform );
4735 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004736 }
4737
4738 if( ssl->handshake )
4739 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004740 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4742 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004743
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004744 mbedtls_free( ssl->handshake );
4745 mbedtls_free( ssl->transform_negotiate );
4746 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004747 }
4748
Ronald Cron6f135e12021-12-08 16:57:54 +01004749#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004750 mbedtls_ssl_transform_free( ssl->transform_application );
4751 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004752#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004753
Paul Bakkerc0463502013-02-14 11:19:38 +01004754 if( ssl->session )
4755 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004756 mbedtls_ssl_session_free( ssl->session );
4757 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004758 }
4759
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004760#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004761 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004762 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004763 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004765 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004766#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004767
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004768#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004770#endif
4771
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004773
Paul Bakker86f04f42013-02-14 11:20:09 +01004774 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004775 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004776}
4777
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004778/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004779 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004780 */
4781void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4782{
4783 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4784}
4785
Gilles Peskineae270bf2021-06-02 00:05:29 +02004786/* The selection should be the same as mbedtls_x509_crt_profile_default in
4787 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004788 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004789 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004790 * about this list.
4791 */
Brett Warrene0edc842021-08-17 09:53:13 +01004792static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004793#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004794 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004795#endif
4796#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004797 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004798#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004799#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004800 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004801#endif
4802#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004803 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004804#endif
4805#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004806 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004807#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004808#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004809 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004810#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004811#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004812 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004813#endif
4814#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004815 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004816#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004817 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004818};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004819
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004820static int ssl_preset_suiteb_ciphersuites[] = {
4821 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4822 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4823 0
4824};
4825
Ronald Crone68ab4f2022-10-05 12:46:29 +02004826#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004827
Jerry Yu909df7b2022-01-22 11:56:27 +08004828/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004829 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004830 * rules SHOULD be upheld.
4831 * - No duplicate entries.
4832 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004833 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004834 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004835 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004836static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004837
Andrzej Kurek25f27152022-08-17 16:09:31 -04004838#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004839 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4840 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004841#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004842 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004843
Andrzej Kurek25f27152022-08-17 16:09:31 -04004844#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004845 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4846 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004847#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004848 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4849
Andrzej Kurek25f27152022-08-17 16:09:31 -04004850#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yued5e9f42022-01-26 11:21:34 +08004851 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4852 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004853#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004854 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004855
Andrzej Kurek25f27152022-08-17 16:09:31 -04004856#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004857 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004858#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004859
Andrzej Kurek25f27152022-08-17 16:09:31 -04004860#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004861 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004862#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004863
Andrzej Kurek25f27152022-08-17 16:09:31 -04004864#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004865 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004866#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004867
Andrzej Kurek25f27152022-08-17 16:09:31 -04004868#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004869 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4870#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4871
Andrzej Kurek25f27152022-08-17 16:09:31 -04004872#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004873 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4874#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4875
Andrzej Kurek25f27152022-08-17 16:09:31 -04004876#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu693a47a2022-06-23 14:02:28 +08004877 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4878#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4879
Gabor Mezei15b95a62022-05-09 16:37:58 +02004880 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004881};
4882
4883/* NOTICE: see above */
4884#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4885static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004886#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004887#if defined(MBEDTLS_ECDSA_C)
4888 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004889#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004890#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4891 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4892#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004893#if defined(MBEDTLS_RSA_C)
4894 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4895#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004896#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004897#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004898#if defined(MBEDTLS_ECDSA_C)
4899 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004900#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004901#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4902 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4903#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004904#if defined(MBEDTLS_RSA_C)
4905 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4906#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004907#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004908#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004909#if defined(MBEDTLS_ECDSA_C)
4910 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004911#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004912#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4913 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4914#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004915#if defined(MBEDTLS_RSA_C)
4916 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4917#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004918#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004919 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004920};
4921#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4922/* NOTICE: see above */
4923static uint16_t ssl_preset_suiteb_sig_algs[] = {
4924
Andrzej Kurek25f27152022-08-17 16:09:31 -04004925#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu909df7b2022-01-22 11:56:27 +08004926 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4927 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004928#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004929 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4930
Andrzej Kurek25f27152022-08-17 16:09:31 -04004931#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
Jerry Yu53037892022-01-25 11:02:06 +08004932 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4933 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004934#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08004935 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004936
Andrzej Kurek25f27152022-08-17 16:09:31 -04004937#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu909df7b2022-01-22 11:56:27 +08004938 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004939#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08004940
Andrzej Kurek25f27152022-08-17 16:09:31 -04004941#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu53037892022-01-25 11:02:06 +08004942 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004943#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08004944
Gabor Mezei15b95a62022-05-09 16:37:58 +02004945 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004946};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004947
Jerry Yu909df7b2022-01-22 11:56:27 +08004948/* NOTICE: see above */
4949#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4950static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004951#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004952#if defined(MBEDTLS_ECDSA_C)
4953 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004954#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004955#if defined(MBEDTLS_RSA_C)
4956 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4957#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004958#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004959#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004960#if defined(MBEDTLS_ECDSA_C)
4961 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004962#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004963#if defined(MBEDTLS_RSA_C)
4964 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4965#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004966#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004967 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004968};
Jerry Yu909df7b2022-01-22 11:56:27 +08004969#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4970
Ronald Crone68ab4f2022-10-05 12:46:29 +02004971#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004972
Brett Warrene0edc842021-08-17 09:53:13 +01004973static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004974#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004975 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004976#endif
4977#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004978 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004979#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004980 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004981};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004982
Ronald Crone68ab4f2022-10-05 12:46:29 +02004983#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004984/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004985 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004986MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004987static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004988{
4989 size_t i, j;
4990 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004991
Gabor Mezei15b95a62022-05-09 16:37:58 +02004992 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004993 {
Jerry Yuf377d642022-01-25 10:43:59 +08004994 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004995 {
Jerry Yuf377d642022-01-25 10:43:59 +08004996 if( sig_algs[i] != sig_algs[j] )
4997 continue;
4998 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4999 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5000 sig_algs[i], j, i );
5001 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005002 }
5003 }
5004 return( ret );
5005}
5006
Ronald Crone68ab4f2022-10-05 12:46:29 +02005007#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005008
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005009/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005010 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005011 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005012int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005013 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005014{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005015#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005017#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005018
Ronald Crone68ab4f2022-10-05 12:46:29 +02005019#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08005020 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005021 {
5022 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
5023 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5024 }
5025
Jerry Yuf377d642022-01-25 10:43:59 +08005026 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005027 {
5028 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
5029 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5030 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005031
5032#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08005033 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005034 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005035 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005036 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5037 }
5038
Jerry Yuf377d642022-01-25 10:43:59 +08005039 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005040 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005041 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005042 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5043 }
5044#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005045#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005046
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005047 /* Use the functions here so that they are covered in tests,
5048 * but otherwise access member directly for efficiency */
5049 mbedtls_ssl_conf_endpoint( conf, endpoint );
5050 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005051
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005052 /*
5053 * Things that are common to all presets
5054 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005055#if defined(MBEDTLS_SSL_CLI_C)
5056 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
5057 {
5058 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5059#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5060 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5061#endif
5062 }
5063#endif
5064
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005065#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5066 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5067#endif
5068
5069#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5070 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5071#endif
5072
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005073#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005074 conf->f_cookie_write = ssl_cookie_write_dummy;
5075 conf->f_cookie_check = ssl_cookie_check_dummy;
5076#endif
5077
5078#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5079 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5080#endif
5081
Janos Follath088ce432017-04-10 12:42:31 +01005082#if defined(MBEDTLS_SSL_SRV_C)
5083 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005084 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005085#endif
5086
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005087#if defined(MBEDTLS_SSL_PROTO_DTLS)
5088 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5089 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5090#endif
5091
5092#if defined(MBEDTLS_SSL_RENEGOTIATION)
5093 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00005094 memset( conf->renego_period, 0x00, 2 );
5095 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005096#endif
5097
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005098#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01005099 if( endpoint == MBEDTLS_SSL_IS_SERVER )
5100 {
5101 const unsigned char dhm_p[] =
5102 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5103 const unsigned char dhm_g[] =
5104 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005105
Hanno Beckere2defad2021-07-24 05:59:17 +01005106 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
5107 dhm_p, sizeof( dhm_p ),
5108 dhm_g, sizeof( dhm_g ) ) ) != 0 )
5109 {
5110 return( ret );
5111 }
5112 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005113#endif
5114
Ronald Cron6f135e12021-12-08 16:57:54 +01005115#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yud0766ec2022-09-22 10:46:57 +08005116#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005117 mbedtls_ssl_conf_new_session_tickets(
5118 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS );
5119#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005120 /*
5121 * Allow all TLS 1.3 key exchange modes by default.
5122 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005123 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005124#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005125
XiaokangQian4d3a6042022-04-21 13:46:17 +00005126 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5127 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005128#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005129 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005130 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005131#else
XiaokangQian060d8672022-04-21 09:24:56 +00005132 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00005133#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00005134 }
5135 else
5136 {
5137#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
5138 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
5139 {
5140 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5141 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5142 }
5143 else
5144 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
5145 {
5146 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5147 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5148 }
5149#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5150 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5151 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5152#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5153 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5154 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5155#else
5156 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
5157#endif
5158 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005159
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005160 /*
5161 * Preset-specific defaults
5162 */
5163 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005165 /*
5166 * NSA Suite B
5167 */
5168 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005169
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005170 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005171
5172#if defined(MBEDTLS_X509_CRT_PARSE_C)
5173 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005174#endif
5175
Ronald Crone68ab4f2022-10-05 12:46:29 +02005176#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005177#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5178 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5179 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
5180 else
5181#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5182 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005183#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005184
Brett Warrene0edc842021-08-17 09:53:13 +01005185#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5186 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005187#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005188 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005189 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005190
5191 /*
5192 * Default
5193 */
5194 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005195
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005196 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005197
5198#if defined(MBEDTLS_X509_CRT_PARSE_C)
5199 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5200#endif
5201
Ronald Crone68ab4f2022-10-05 12:46:29 +02005202#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005203#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5204 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5205 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
5206 else
5207#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5208 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005209#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005210
Brett Warrene0edc842021-08-17 09:53:13 +01005211#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5212 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005213#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005214 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005215
5216#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5217 conf->dhm_min_bitlen = 1024;
5218#endif
5219 }
5220
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005221 return( 0 );
5222}
5223
5224/*
5225 * Free mbedtls_ssl_config
5226 */
5227void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
5228{
5229#if defined(MBEDTLS_DHM_C)
5230 mbedtls_mpi_free( &conf->dhm_P );
5231 mbedtls_mpi_free( &conf->dhm_G );
5232#endif
5233
Ronald Cron73fe8df2022-10-05 14:31:43 +02005234#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005235#if defined(MBEDTLS_USE_PSA_CRYPTO)
5236 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
5237 {
Neil Armstrong501c9322022-05-03 09:35:09 +02005238 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5239 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005240#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005241 if( conf->psk != NULL )
5242 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005243 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005244 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00005245 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005246 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005247 }
5248
5249 if( conf->psk_identity != NULL )
5250 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005251 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09005252 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00005253 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005254 conf->psk_identity_len = 0;
5255 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005256#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005257
5258#if defined(MBEDTLS_X509_CRT_PARSE_C)
5259 ssl_key_cert_free( conf->key_cert );
5260#endif
5261
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005262 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005263}
5264
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005265#if defined(MBEDTLS_PK_C) && \
5266 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005267/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005270unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005271{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005272#if defined(MBEDTLS_RSA_C)
5273 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
5274 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005275#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005276#if defined(MBEDTLS_ECDSA_C)
5277 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
5278 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005279#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005280 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005281}
5282
Hanno Becker7e5437a2017-04-28 17:15:26 +01005283unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
5284{
5285 switch( type ) {
5286 case MBEDTLS_PK_RSA:
5287 return( MBEDTLS_SSL_SIG_RSA );
5288 case MBEDTLS_PK_ECDSA:
5289 case MBEDTLS_PK_ECKEY:
5290 return( MBEDTLS_SSL_SIG_ECDSA );
5291 default:
5292 return( MBEDTLS_SSL_SIG_ANON );
5293 }
5294}
5295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005296mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005297{
5298 switch( sig )
5299 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005300#if defined(MBEDTLS_RSA_C)
5301 case MBEDTLS_SSL_SIG_RSA:
5302 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005303#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005304#if defined(MBEDTLS_ECDSA_C)
5305 case MBEDTLS_SSL_SIG_ECDSA:
5306 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005307#endif
5308 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005309 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005310 }
5311}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005312#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005313
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005314/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005315 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005318{
5319 switch( hash )
5320 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005321#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005322 case MBEDTLS_SSL_HASH_MD5:
5323 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005324#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005325#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005326 case MBEDTLS_SSL_HASH_SHA1:
5327 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005328#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005329#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 case MBEDTLS_SSL_HASH_SHA224:
5331 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005332#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005333#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334 case MBEDTLS_SSL_HASH_SHA256:
5335 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005336#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005337#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005338 case MBEDTLS_SSL_HASH_SHA384:
5339 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005340#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005341#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342 case MBEDTLS_SSL_HASH_SHA512:
5343 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005344#endif
5345 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005347 }
5348}
5349
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005350/*
5351 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5352 */
5353unsigned char mbedtls_ssl_hash_from_md_alg( int md )
5354{
5355 switch( md )
5356 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005357#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005358 case MBEDTLS_MD_MD5:
5359 return( MBEDTLS_SSL_HASH_MD5 );
5360#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005361#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005362 case MBEDTLS_MD_SHA1:
5363 return( MBEDTLS_SSL_HASH_SHA1 );
5364#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005365#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005366 case MBEDTLS_MD_SHA224:
5367 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005368#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005369#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005370 case MBEDTLS_MD_SHA256:
5371 return( MBEDTLS_SSL_HASH_SHA256 );
5372#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005373#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005374 case MBEDTLS_MD_SHA384:
5375 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005376#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005377#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005378 case MBEDTLS_MD_SHA512:
5379 return( MBEDTLS_SSL_HASH_SHA512 );
5380#endif
5381 default:
5382 return( MBEDTLS_SSL_HASH_NONE );
5383 }
5384}
5385
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005386/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005387 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005388 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005389 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005390int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005391{
Brett Warrene0edc842021-08-17 09:53:13 +01005392 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005393
Brett Warrene0edc842021-08-17 09:53:13 +01005394 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005395 return( -1 );
5396
Brett Warrene0edc842021-08-17 09:53:13 +01005397 for( ; *group_list != 0; group_list++ )
5398 {
5399 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005400 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01005401 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005402
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005403 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005404}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005405
5406#if defined(MBEDTLS_ECP_C)
5407/*
5408 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5409 */
5410int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
5411{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005412 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01005413 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005414
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01005415 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005416 return -1;
5417
5418 uint16_t tls_id = grp_info->tls_id;
5419
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005420 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
5421}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005422#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424#if defined(MBEDTLS_X509_CRT_PARSE_C)
5425int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
5426 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005427 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02005428 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005429{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005430 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005431 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005432 const char *ext_oid;
5433 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005436 {
5437 /* Server part of the key exchange */
5438 switch( ciphersuite->key_exchange )
5439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 case MBEDTLS_KEY_EXCHANGE_RSA:
5441 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005442 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005443 break;
5444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5446 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5447 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5448 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005449 break;
5450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5452 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005453 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005454 break;
5455
5456 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 case MBEDTLS_KEY_EXCHANGE_NONE:
5458 case MBEDTLS_KEY_EXCHANGE_PSK:
5459 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5460 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005461 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005462 usage = 0;
5463 }
5464 }
5465 else
5466 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5468 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005469 }
5470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005472 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005473 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005474 ret = -1;
5475 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 ext_oid = MBEDTLS_OID_SERVER_AUTH;
5480 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005481 }
5482 else
5483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5485 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005486 }
5487
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005489 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005490 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005491 ret = -1;
5492 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005493
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005494 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005495}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005497
Jerry Yu148165c2021-09-24 23:20:59 +08005498#if defined(MBEDTLS_USE_PSA_CRYPTO)
5499int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5500 const mbedtls_md_type_t md,
5501 unsigned char *dst,
5502 size_t dst_len,
5503 size_t *olen )
5504{
Ronald Cronf6893e12022-01-07 22:09:01 +01005505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5506 psa_hash_operation_t *hash_operation_to_clone;
5507 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5508
Jerry Yu148165c2021-09-24 23:20:59 +08005509 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005510
5511 switch( md )
5512 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005513#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005514 case MBEDTLS_MD_SHA384:
5515 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5516 break;
5517#endif
5518
Andrzej Kurek25f27152022-08-17 16:09:31 -04005519#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005520 case MBEDTLS_MD_SHA256:
5521 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5522 break;
5523#endif
5524
5525 default:
5526 goto exit;
5527 }
5528
5529 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5530 if( status != PSA_SUCCESS )
5531 goto exit;
5532
5533 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5534 if( status != PSA_SUCCESS )
5535 goto exit;
5536
5537exit:
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005538#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5539 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5540 (void) ssl;
5541#endif
Ronald Cronb788c042022-02-15 09:14:15 +01005542 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005543}
5544#else /* MBEDTLS_USE_PSA_CRYPTO */
5545
Andrzej Kurek25f27152022-08-17 16:09:31 -04005546#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005547MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005548static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5549 unsigned char *dst,
5550 size_t dst_len,
5551 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005552{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005553 int ret;
5554 mbedtls_sha512_context sha512;
5555
5556 if( dst_len < 48 )
5557 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5558
5559 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005560 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005561
5562 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5563 {
5564 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5565 goto exit;
5566 }
5567
5568 *olen = 48;
5569
5570exit:
5571
5572 mbedtls_sha512_free( &sha512 );
5573 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005574}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005575#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005576
Andrzej Kurek25f27152022-08-17 16:09:31 -04005577#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005578MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005579static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5580 unsigned char *dst,
5581 size_t dst_len,
5582 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005583{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005584 int ret;
5585 mbedtls_sha256_context sha256;
5586
5587 if( dst_len < 32 )
5588 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5589
5590 mbedtls_sha256_init( &sha256 );
5591 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005592
Jerry Yu24c0ec32021-09-09 14:21:07 +08005593 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5594 {
5595 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5596 goto exit;
5597 }
5598
5599 *olen = 32;
5600
5601exit:
5602
5603 mbedtls_sha256_free( &sha256 );
5604 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005605}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005606#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005607
Jerry Yu000f9762021-09-14 11:12:51 +08005608int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5609 const mbedtls_md_type_t md,
5610 unsigned char *dst,
5611 size_t dst_len,
5612 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005613{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005614 switch( md )
5615 {
5616
Andrzej Kurek25f27152022-08-17 16:09:31 -04005617#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005618 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005619 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005620#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005621
Andrzej Kurek25f27152022-08-17 16:09:31 -04005622#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005623 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005624 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005625#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005626
5627 default:
Andrzej Kurek409248a2022-10-24 10:33:21 -04005628#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5629 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5630 (void) ssl;
5631 (void) dst;
5632 (void) dst_len;
5633 (void) olen;
5634#endif
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005635 break;
5636 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005637 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005638}
XiaokangQian647719a2021-12-07 09:16:29 +00005639
Jerry Yu148165c2021-09-24 23:20:59 +08005640#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005641
Ronald Crone68ab4f2022-10-05 12:46:29 +02005642#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005643/* mbedtls_ssl_parse_sig_alg_ext()
5644 *
5645 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5646 * value (TLS 1.3 RFC8446):
5647 * enum {
5648 * ....
5649 * ecdsa_secp256r1_sha256( 0x0403 ),
5650 * ecdsa_secp384r1_sha384( 0x0503 ),
5651 * ecdsa_secp521r1_sha512( 0x0603 ),
5652 * ....
5653 * } SignatureScheme;
5654 *
5655 * struct {
5656 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5657 * } SignatureSchemeList;
5658 *
5659 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5660 * value (TLS 1.2 RFC5246):
5661 * enum {
5662 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5663 * sha512(6), (255)
5664 * } HashAlgorithm;
5665 *
5666 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5667 * SignatureAlgorithm;
5668 *
5669 * struct {
5670 * HashAlgorithm hash;
5671 * SignatureAlgorithm signature;
5672 * } SignatureAndHashAlgorithm;
5673 *
5674 * SignatureAndHashAlgorithm
5675 * supported_signature_algorithms<2..2^16-2>;
5676 *
5677 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5678 * generalization of the TLS 1.2 signature algorithm extension.
5679 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5680 * `SignatureScheme` field of TLS 1.3
5681 *
5682 */
5683int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5684 const unsigned char *buf,
5685 const unsigned char *end )
5686{
5687 const unsigned char *p = buf;
5688 size_t supported_sig_algs_len = 0;
5689 const unsigned char *supported_sig_algs_end;
5690 uint16_t sig_alg;
5691 uint32_t common_idx = 0;
5692
5693 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5694 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5695 p += 2;
5696
5697 memset( ssl->handshake->received_sig_algs, 0,
5698 sizeof(ssl->handshake->received_sig_algs) );
5699
5700 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5701 supported_sig_algs_end = p + supported_sig_algs_len;
5702 while( p < supported_sig_algs_end )
5703 {
5704 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5705 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5706 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005707 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5708 sig_alg,
5709 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005710#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005711 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005712 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5713 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5714 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005715 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005716 }
5717#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005718
Jerry Yuf3b46b52022-06-19 16:52:27 +08005719 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5720 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005721
5722 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5723 {
5724 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5725 common_idx += 1;
5726 }
5727 }
5728 /* Check that we consumed all the message. */
5729 if( p != end )
5730 {
5731 MBEDTLS_SSL_DEBUG_MSG( 1,
5732 ( "Signature algorithms extension length misaligned" ) );
5733 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5734 MBEDTLS_ERR_SSL_DECODE_ERROR );
5735 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5736 }
5737
5738 if( common_idx == 0 )
5739 {
5740 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5741 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5742 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5743 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5744 }
5745
Gabor Mezei15b95a62022-05-09 16:37:58 +02005746 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005747 return( 0 );
5748}
5749
Ronald Crone68ab4f2022-10-05 12:46:29 +02005750#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02005751
Jerry Yudc7bd172022-02-17 13:44:15 +08005752#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5753
5754#if defined(MBEDTLS_USE_PSA_CRYPTO)
5755
5756static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5757 mbedtls_svc_key_id_t key,
5758 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005759 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005760 const unsigned char* seed, size_t seed_length,
5761 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005762 const unsigned char* other_secret,
5763 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005764 size_t capacity )
5765{
5766 psa_status_t status;
5767
5768 status = psa_key_derivation_setup( derivation, alg );
5769 if( status != PSA_SUCCESS )
5770 return( status );
5771
5772 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5773 {
5774 status = psa_key_derivation_input_bytes( derivation,
5775 PSA_KEY_DERIVATION_INPUT_SEED,
5776 seed, seed_length );
5777 if( status != PSA_SUCCESS )
5778 return( status );
5779
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005780 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005781 {
5782 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005783 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5784 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005785 if( status != PSA_SUCCESS )
5786 return( status );
5787 }
5788
Jerry Yudc7bd172022-02-17 13:44:15 +08005789 if( mbedtls_svc_key_id_is_null( key ) )
5790 {
5791 status = psa_key_derivation_input_bytes(
5792 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005793 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005794 }
5795 else
5796 {
5797 status = psa_key_derivation_input_key(
5798 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5799 }
5800 if( status != PSA_SUCCESS )
5801 return( status );
5802
5803 status = psa_key_derivation_input_bytes( derivation,
5804 PSA_KEY_DERIVATION_INPUT_LABEL,
5805 label, label_length );
5806 if( status != PSA_SUCCESS )
5807 return( status );
5808 }
5809 else
5810 {
5811 return( PSA_ERROR_NOT_SUPPORTED );
5812 }
5813
5814 status = psa_key_derivation_set_capacity( derivation, capacity );
5815 if( status != PSA_SUCCESS )
5816 return( status );
5817
5818 return( PSA_SUCCESS );
5819}
5820
Andrzej Kurek57d10632022-10-24 10:32:01 -04005821#if defined(PSA_WANT_ALG_SHA_384) || \
5822 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005823MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005824static int tls_prf_generic( mbedtls_md_type_t md_type,
5825 const unsigned char *secret, size_t slen,
5826 const char *label,
5827 const unsigned char *random, size_t rlen,
5828 unsigned char *dstbuf, size_t dlen )
5829{
5830 psa_status_t status;
5831 psa_algorithm_t alg;
5832 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5833 psa_key_derivation_operation_t derivation =
5834 PSA_KEY_DERIVATION_OPERATION_INIT;
5835
5836 if( md_type == MBEDTLS_MD_SHA384 )
5837 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5838 else
5839 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5840
5841 /* Normally a "secret" should be long enough to be impossible to
5842 * find by brute force, and in particular should not be empty. But
5843 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5844 * and for this use case it makes sense to have a 0-length "secret".
5845 * Since the key API doesn't allow importing a key of length 0,
5846 * keep master_key=0, which setup_psa_key_derivation() understands
5847 * to mean a 0-length "secret" input. */
5848 if( slen != 0 )
5849 {
5850 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5851 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5852 psa_set_key_algorithm( &key_attributes, alg );
5853 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5854
5855 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5856 if( status != PSA_SUCCESS )
5857 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5858 }
5859
5860 status = setup_psa_key_derivation( &derivation,
5861 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005862 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005863 random, rlen,
5864 (unsigned char const *) label,
5865 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005866 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005867 dlen );
5868 if( status != PSA_SUCCESS )
5869 {
5870 psa_key_derivation_abort( &derivation );
5871 psa_destroy_key( master_key );
5872 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5873 }
5874
5875 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5876 if( status != PSA_SUCCESS )
5877 {
5878 psa_key_derivation_abort( &derivation );
5879 psa_destroy_key( master_key );
5880 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5881 }
5882
5883 status = psa_key_derivation_abort( &derivation );
5884 if( status != PSA_SUCCESS )
5885 {
5886 psa_destroy_key( master_key );
5887 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5888 }
5889
5890 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5891 status = psa_destroy_key( master_key );
5892 if( status != PSA_SUCCESS )
5893 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5894
5895 return( 0 );
5896}
Andrzej Kurek57d10632022-10-24 10:32:01 -04005897#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08005898#else /* MBEDTLS_USE_PSA_CRYPTO */
5899
Andrzej Kurek57d10632022-10-24 10:32:01 -04005900#if defined(MBEDTLS_MD_C) && \
5901 ( defined(MBEDTLS_SHA256_C) || \
5902 defined(MBEDTLS_SHA384_C) )
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005903MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005904static int tls_prf_generic( mbedtls_md_type_t md_type,
5905 const unsigned char *secret, size_t slen,
5906 const char *label,
5907 const unsigned char *random, size_t rlen,
5908 unsigned char *dstbuf, size_t dlen )
5909{
5910 size_t nb;
5911 size_t i, j, k, md_len;
5912 unsigned char *tmp;
5913 size_t tmp_len = 0;
5914 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5915 const mbedtls_md_info_t *md_info;
5916 mbedtls_md_context_t md_ctx;
5917 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5918
5919 mbedtls_md_init( &md_ctx );
5920
5921 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5922 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5923
5924 md_len = mbedtls_md_get_size( md_info );
5925
5926 tmp_len = md_len + strlen( label ) + rlen;
5927 tmp = mbedtls_calloc( 1, tmp_len );
5928 if( tmp == NULL )
5929 {
5930 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5931 goto exit;
5932 }
5933
5934 nb = strlen( label );
5935 memcpy( tmp + md_len, label, nb );
5936 memcpy( tmp + md_len + nb, random, rlen );
5937 nb += rlen;
5938
5939 /*
5940 * Compute P_<hash>(secret, label + random)[0..dlen]
5941 */
5942 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5943 goto exit;
5944
5945 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5946 if( ret != 0 )
5947 goto exit;
5948 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5949 if( ret != 0 )
5950 goto exit;
5951 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5952 if( ret != 0 )
5953 goto exit;
5954
5955 for( i = 0; i < dlen; i += md_len )
5956 {
5957 ret = mbedtls_md_hmac_reset ( &md_ctx );
5958 if( ret != 0 )
5959 goto exit;
5960 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5961 if( ret != 0 )
5962 goto exit;
5963 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5964 if( ret != 0 )
5965 goto exit;
5966
5967 ret = mbedtls_md_hmac_reset ( &md_ctx );
5968 if( ret != 0 )
5969 goto exit;
5970 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5971 if( ret != 0 )
5972 goto exit;
5973 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5974 if( ret != 0 )
5975 goto exit;
5976
5977 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5978
5979 for( j = 0; j < k; j++ )
5980 dstbuf[i + j] = h_i[j];
5981 }
5982
5983exit:
5984 mbedtls_md_free( &md_ctx );
5985
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00005986 if ( tmp != NULL )
5987 mbedtls_platform_zeroize( tmp, tmp_len );
5988
Jerry Yudc7bd172022-02-17 13:44:15 +08005989 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5990
5991 mbedtls_free( tmp );
5992
5993 return( ret );
5994}
Andrzej Kurek57d10632022-10-24 10:32:01 -04005995#endif /* MBEDTLS_MD_C && ( MBEDTLS_SHA256_C || MBEDTLS_SHA384_C ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08005996#endif /* MBEDTLS_USE_PSA_CRYPTO */
5997
Andrzej Kurek25f27152022-08-17 16:09:31 -04005998#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005999MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08006000static int tls_prf_sha256( const unsigned char *secret, size_t slen,
6001 const char *label,
6002 const unsigned char *random, size_t rlen,
6003 unsigned char *dstbuf, size_t dlen )
6004{
6005 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
6006 label, random, rlen, dstbuf, dlen ) );
6007}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006008#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006009
Andrzej Kurek25f27152022-08-17 16:09:31 -04006010#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006011MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08006012static int tls_prf_sha384( const unsigned char *secret, size_t slen,
6013 const char *label,
6014 const unsigned char *random, size_t rlen,
6015 unsigned char *dstbuf, size_t dlen )
6016{
6017 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
6018 label, random, rlen, dstbuf, dlen ) );
6019}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006020#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006021
Jerry Yuf009d862022-02-17 14:01:37 +08006022/*
6023 * Set appropriate PRF function and other SSL / TLS1.2 functions
6024 *
6025 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006026 * - hash associated with the ciphersuite (only used by TLS 1.2)
6027 *
6028 * Outputs:
6029 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6030 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006031MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08006032static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08006033 mbedtls_md_type_t hash )
6034{
Andrzej Kurek25f27152022-08-17 16:09:31 -04006035#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron81591aa2022-03-07 09:05:51 +01006036 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08006037 {
6038 handshake->tls_prf = tls_prf_sha384;
6039 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6040 handshake->calc_finished = ssl_calc_finished_tls_sha384;
6041 }
6042 else
6043#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006044#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08006045 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006046 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006047 handshake->tls_prf = tls_prf_sha256;
6048 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6049 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6050 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006051#else
Jerry Yuf009d862022-02-17 14:01:37 +08006052 {
Jerry Yuf009d862022-02-17 14:01:37 +08006053 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006054 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006055 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6056 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006057#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006058
6059 return( 0 );
6060}
Jerry Yud6ab2352022-02-17 14:03:43 +08006061
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006062/*
6063 * Compute master secret if needed
6064 *
6065 * Parameters:
6066 * [in/out] handshake
6067 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6068 * (PSA-PSK) ciphersuite_info, psk_opaque
6069 * [out] premaster (cleared)
6070 * [out] master
6071 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6072 * debug: conf->f_dbg, conf->p_dbg
6073 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006074 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006075 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006076MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006077static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
6078 unsigned char *master,
6079 const mbedtls_ssl_context *ssl )
6080{
6081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6082
6083 /* cf. RFC 5246, Section 8.1:
6084 * "The master secret is always exactly 48 bytes in length." */
6085 size_t const master_secret_len = 48;
6086
6087#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6088 unsigned char session_hash[48];
6089#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6090
6091 /* The label for the KDF used for key expansion.
6092 * This is either "master secret" or "extended master secret"
6093 * depending on whether the Extended Master Secret extension
6094 * is used. */
6095 char const *lbl = "master secret";
6096
Przemek Stekielae4ed302022-04-05 17:15:55 +02006097 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006098 * - If the Extended Master Secret extension is not used,
6099 * this is ClientHello.Random + ServerHello.Random
6100 * (see Sect. 8.1 in RFC 5246).
6101 * - If the Extended Master Secret extension is used,
6102 * this is the transcript of the handshake so far.
6103 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006104 unsigned char const *seed = handshake->randbytes;
6105 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006106
6107#if !defined(MBEDTLS_DEBUG_C) && \
6108 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6109 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
6110 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
6111 ssl = NULL; /* make sure we don't use it except for those cases */
6112 (void) ssl;
6113#endif
6114
6115 if( handshake->resume != 0 )
6116 {
6117 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
6118 return( 0 );
6119 }
6120
6121#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6122 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
6123 {
6124 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006125 seed = session_hash;
6126 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006127
6128 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02006129 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006130 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006131#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006132
Przemek Stekiel99114f32022-04-22 11:20:09 +02006133#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006134 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02006135 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006136 {
6137 /* Perform PSK-to-MS expansion in a single step. */
6138 psa_status_t status;
6139 psa_algorithm_t alg;
6140 mbedtls_svc_key_id_t psk;
6141 psa_key_derivation_operation_t derivation =
6142 PSA_KEY_DERIVATION_OPERATION_INIT;
6143 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6144
6145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
6146
6147 psk = mbedtls_ssl_get_opaque_psk( ssl );
6148
6149 if( hash_alg == MBEDTLS_MD_SHA384 )
6150 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
6151 else
6152 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
6153
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006154 size_t other_secret_len = 0;
6155 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006156
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006157 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02006158 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006159 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006160 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006161 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006162 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006163 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006164 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006165 other_secret_len = 48;
6166 other_secret = handshake->premaster + 2;
6167 break;
6168 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006169 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006170 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6171 other_secret = handshake->premaster + 2;
6172 break;
6173 default:
6174 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006175 }
6176
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006177 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006178 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02006179 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006180 (unsigned char const *) lbl,
6181 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006182 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006183 master_secret_len );
6184 if( status != PSA_SUCCESS )
6185 {
6186 psa_key_derivation_abort( &derivation );
6187 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6188 }
6189
6190 status = psa_key_derivation_output_bytes( &derivation,
6191 master,
6192 master_secret_len );
6193 if( status != PSA_SUCCESS )
6194 {
6195 psa_key_derivation_abort( &derivation );
6196 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6197 }
6198
6199 status = psa_key_derivation_abort( &derivation );
6200 if( status != PSA_SUCCESS )
6201 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6202 }
6203 else
6204#endif
6205 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006206#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
6207 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6208 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE )
6209 {
6210 psa_status_t status;
6211 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6212 psa_key_derivation_operation_t derivation =
6213 PSA_KEY_DERIVATION_OPERATION_INIT;
6214
6215 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PMS KDF for ECJPAKE" ) );
6216
6217 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6218
6219 status = psa_key_derivation_setup( &derivation, alg );
6220 if( status != PSA_SUCCESS )
6221 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6222
6223 status = psa_key_derivation_set_capacity( &derivation,
6224 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE );
6225 if( status != PSA_SUCCESS )
6226 {
6227 psa_key_derivation_abort( &derivation );
6228 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6229 }
6230
6231 status = psa_pake_get_implicit_key( &handshake->psa_pake_ctx,
6232 &derivation );
6233 if( status != PSA_SUCCESS )
6234 {
6235 psa_key_derivation_abort( &derivation );
6236 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6237 }
6238
6239 status = psa_key_derivation_output_bytes( &derivation,
6240 handshake->premaster,
6241 handshake->pmslen );
6242 if( status != PSA_SUCCESS )
6243 {
6244 psa_key_derivation_abort( &derivation );
6245 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6246 }
6247
6248 status = psa_key_derivation_abort( &derivation );
6249 if( status != PSA_SUCCESS )
6250 {
6251 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6252 }
6253 }
6254#endif
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006255 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02006256 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006257 master,
6258 master_secret_len );
6259 if( ret != 0 )
6260 {
6261 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6262 return( ret );
6263 }
6264
6265 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
6266 handshake->premaster,
6267 handshake->pmslen );
6268
6269 mbedtls_platform_zeroize( handshake->premaster,
6270 sizeof(handshake->premaster) );
6271 }
6272
6273 return( 0 );
6274}
6275
Jerry Yud62f87e2022-02-17 14:09:02 +08006276int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
6277{
6278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6279 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6280 ssl->handshake->ciphersuite_info;
6281
6282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
6283
6284 /* Set PRF, calc_verify and calc_finished function pointers */
6285 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08006286 ciphersuite_info->mac );
6287 if( ret != 0 )
6288 {
6289 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
6290 return( ret );
6291 }
6292
6293 /* Compute master secret if needed */
6294 ret = ssl_compute_master( ssl->handshake,
6295 ssl->session_negotiate->master,
6296 ssl );
6297 if( ret != 0 )
6298 {
6299 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
6300 return( ret );
6301 }
6302
6303 /* Swap the client and server random values:
6304 * - MS derivation wanted client+server (RFC 5246 8.1)
6305 * - key derivation wants server+client (RFC 5246 6.3) */
6306 {
6307 unsigned char tmp[64];
6308 memcpy( tmp, ssl->handshake->randbytes, 64 );
6309 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
6310 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
6311 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
6312 }
6313
6314 /* Populate transform structure */
6315 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
6316 ssl->session_negotiate->ciphersuite,
6317 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006318#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08006319 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006320#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08006321 ssl->handshake->tls_prf,
6322 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04006323 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08006324 ssl->conf->endpoint,
6325 ssl );
6326 if( ret != 0 )
6327 {
6328 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
6329 return( ret );
6330 }
6331
6332 /* We no longer need Server/ClientHello.random values */
6333 mbedtls_platform_zeroize( ssl->handshake->randbytes,
6334 sizeof( ssl->handshake->randbytes ) );
6335
6336 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
6337
6338 return( 0 );
6339}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006340
Ronald Cron4dcbca92022-03-07 10:21:40 +01006341int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
6342{
Ronald Cron4dcbca92022-03-07 10:21:40 +01006343 switch( md )
6344 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04006345#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006346 case MBEDTLS_SSL_HASH_SHA384:
6347 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6348 break;
6349#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006350#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006351 case MBEDTLS_SSL_HASH_SHA256:
6352 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6353 break;
6354#endif
6355 default:
6356 return( -1 );
6357 }
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006358#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
6359 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
6360 (void) ssl;
6361#endif
Ronald Cronc2f13a02022-03-07 10:25:24 +01006362 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01006363}
6364
Andrzej Kurek25f27152022-08-17 16:09:31 -04006365#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006366void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
6367 unsigned char *hash,
6368 size_t *hlen )
6369{
6370#if defined(MBEDTLS_USE_PSA_CRYPTO)
6371 size_t hash_size;
6372 psa_status_t status;
6373 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6374
6375 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
6376 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6377 if( status != PSA_SUCCESS )
6378 {
6379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6380 return;
6381 }
6382
6383 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
6384 if( status != PSA_SUCCESS )
6385 {
6386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6387 return;
6388 }
6389
6390 *hlen = 32;
6391 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
6392 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
6393#else
6394 mbedtls_sha256_context sha256;
6395
6396 mbedtls_sha256_init( &sha256 );
6397
6398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
6399
6400 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6401 mbedtls_sha256_finish( &sha256, hash );
6402
6403 *hlen = 32;
6404
6405 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
6406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
6407
6408 mbedtls_sha256_free( &sha256 );
6409#endif /* MBEDTLS_USE_PSA_CRYPTO */
6410 return;
6411}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006412#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006413
Andrzej Kurek25f27152022-08-17 16:09:31 -04006414#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006415void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
6416 unsigned char *hash,
6417 size_t *hlen )
6418{
6419#if defined(MBEDTLS_USE_PSA_CRYPTO)
6420 size_t hash_size;
6421 psa_status_t status;
6422 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6423
6424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
6425 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6426 if( status != PSA_SUCCESS )
6427 {
6428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6429 return;
6430 }
6431
6432 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
6433 if( status != PSA_SUCCESS )
6434 {
6435 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6436 return;
6437 }
6438
6439 *hlen = 48;
6440 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
6441 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
6442#else
6443 mbedtls_sha512_context sha512;
6444
6445 mbedtls_sha512_init( &sha512 );
6446
6447 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
6448
Andrzej Kureka242e832022-08-11 10:03:14 -04006449 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08006450 mbedtls_sha512_finish( &sha512, hash );
6451
6452 *hlen = 48;
6453
6454 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
6455 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
6456
6457 mbedtls_sha512_free( &sha512 );
6458#endif /* MBEDTLS_USE_PSA_CRYPTO */
6459 return;
6460}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006461#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006462
Neil Armstrong80f6f322022-05-03 17:56:38 +02006463#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6464 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006465int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
6466{
6467 unsigned char *p = ssl->handshake->premaster;
6468 unsigned char *end = p + sizeof( ssl->handshake->premaster );
6469 const unsigned char *psk = NULL;
6470 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006471 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08006472
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006473 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08006474 {
6475 /*
6476 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006477 * checked before calling this function.
6478 *
6479 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006480 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006481 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006482 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
6483 {
6484 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6485 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6486 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006487 }
6488
6489 /*
6490 * PMS = struct {
6491 * opaque other_secret<0..2^16-1>;
6492 * opaque psk<0..2^16-1>;
6493 * };
6494 * with "other_secret" depending on the particular key exchange
6495 */
6496#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
6497 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
6498 {
6499 if( end - p < 2 )
6500 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6501
6502 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6503 p += 2;
6504
6505 if( end < p || (size_t)( end - p ) < psk_len )
6506 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6507
6508 memset( p, 0, psk_len );
6509 p += psk_len;
6510 }
6511 else
6512#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6513#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
6514 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6515 {
6516 /*
6517 * other_secret already set by the ClientKeyExchange message,
6518 * and is 48 bytes long
6519 */
6520 if( end - p < 2 )
6521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6522
6523 *p++ = 0;
6524 *p++ = 48;
6525 p += 48;
6526 }
6527 else
6528#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6529#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
6530 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
6531 {
6532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6533 size_t len;
6534
6535 /* Write length only when we know the actual value */
6536 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
6537 p + 2, end - ( p + 2 ), &len,
6538 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6539 {
6540 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
6541 return( ret );
6542 }
6543 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
6544 p += 2 + len;
6545
6546 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
6547 }
6548 else
6549#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006550#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006551 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
6552 {
6553 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6554 size_t zlen;
6555
6556 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6557 p + 2, end - ( p + 2 ),
6558 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6559 {
6560 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6561 return( ret );
6562 }
6563
6564 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6565 p += 2 + zlen;
6566
6567 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6568 MBEDTLS_DEBUG_ECDH_Z );
6569 }
6570 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006571#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006572 {
6573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6574 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6575 }
6576
6577 /* opaque psk<0..2^16-1>; */
6578 if( end - p < 2 )
6579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6580
6581 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6582 p += 2;
6583
6584 if( end < p || (size_t)( end - p ) < psk_len )
6585 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6586
6587 memcpy( p, psk, psk_len );
6588 p += psk_len;
6589
6590 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6591
6592 return( 0 );
6593}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006594#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006595
6596#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006597MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006598static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6599
6600#if defined(MBEDTLS_SSL_PROTO_DTLS)
6601int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6602{
6603 /* If renegotiation is not enforced, retransmit until we would reach max
6604 * timeout if we were using the usual handshake doubling scheme */
6605 if( ssl->conf->renego_max_records < 0 )
6606 {
6607 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6608 unsigned char doublings = 1;
6609
6610 while( ratio != 0 )
6611 {
6612 ++doublings;
6613 ratio >>= 1;
6614 }
6615
6616 if( ++ssl->renego_records_seen > doublings )
6617 {
6618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6619 return( 0 );
6620 }
6621 }
6622
6623 return( ssl_write_hello_request( ssl ) );
6624}
6625#endif
6626#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006627
Jerry Yud9526692022-02-17 14:23:47 +08006628/*
6629 * Handshake functions
6630 */
6631#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6632/* No certificate support -> dummy functions */
6633int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6634{
6635 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6636 ssl->handshake->ciphersuite_info;
6637
6638 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6639
6640 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6641 {
6642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6643 ssl->state++;
6644 return( 0 );
6645 }
6646
6647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6648 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6649}
6650
6651int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6652{
6653 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6654 ssl->handshake->ciphersuite_info;
6655
6656 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6657
6658 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6659 {
6660 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6661 ssl->state++;
6662 return( 0 );
6663 }
6664
6665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6666 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6667}
6668
6669#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6670/* Some certificate support -> implement write and parse */
6671
6672int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6673{
6674 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6675 size_t i, n;
6676 const mbedtls_x509_crt *crt;
6677 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6678 ssl->handshake->ciphersuite_info;
6679
6680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6681
6682 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6683 {
6684 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6685 ssl->state++;
6686 return( 0 );
6687 }
6688
6689#if defined(MBEDTLS_SSL_CLI_C)
6690 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6691 {
6692 if( ssl->handshake->client_auth == 0 )
6693 {
6694 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6695 ssl->state++;
6696 return( 0 );
6697 }
6698 }
6699#endif /* MBEDTLS_SSL_CLI_C */
6700#if defined(MBEDTLS_SSL_SRV_C)
6701 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6702 {
6703 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6704 {
6705 /* Should never happen because we shouldn't have picked the
6706 * ciphersuite if we don't have a certificate. */
6707 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6708 }
6709 }
6710#endif
6711
6712 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6713
6714 /*
6715 * 0 . 0 handshake type
6716 * 1 . 3 handshake length
6717 * 4 . 6 length of all certs
6718 * 7 . 9 length of cert. 1
6719 * 10 . n-1 peer certificate
6720 * n . n+2 length of cert. 2
6721 * n+3 . ... upper level cert, etc.
6722 */
6723 i = 7;
6724 crt = mbedtls_ssl_own_cert( ssl );
6725
6726 while( crt != NULL )
6727 {
6728 n = crt->raw.len;
6729 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6730 {
6731 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6732 " > %" MBEDTLS_PRINTF_SIZET,
6733 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6734 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6735 }
6736
6737 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6738 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6739 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6740
6741 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6742 i += n; crt = crt->next;
6743 }
6744
6745 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6746 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6747 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6748
6749 ssl->out_msglen = i;
6750 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6751 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6752
6753 ssl->state++;
6754
6755 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6756 {
6757 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6758 return( ret );
6759 }
6760
6761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6762
6763 return( ret );
6764}
6765
6766#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6767
6768#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006769MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006770static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6771 unsigned char *crt_buf,
6772 size_t crt_buf_len )
6773{
6774 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6775
6776 if( peer_crt == NULL )
6777 return( -1 );
6778
6779 if( peer_crt->raw.len != crt_buf_len )
6780 return( -1 );
6781
6782 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6783}
6784#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006785MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006786static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6787 unsigned char *crt_buf,
6788 size_t crt_buf_len )
6789{
6790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6791 unsigned char const * const peer_cert_digest =
6792 ssl->session->peer_cert_digest;
6793 mbedtls_md_type_t const peer_cert_digest_type =
6794 ssl->session->peer_cert_digest_type;
6795 mbedtls_md_info_t const * const digest_info =
6796 mbedtls_md_info_from_type( peer_cert_digest_type );
6797 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6798 size_t digest_len;
6799
6800 if( peer_cert_digest == NULL || digest_info == NULL )
6801 return( -1 );
6802
6803 digest_len = mbedtls_md_get_size( digest_info );
6804 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6805 return( -1 );
6806
6807 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6808 if( ret != 0 )
6809 return( -1 );
6810
6811 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6812}
6813#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6814#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6815
6816/*
6817 * Once the certificate message is read, parse it into a cert chain and
6818 * perform basic checks, but leave actual verification to the caller
6819 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006820MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006821static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6822 mbedtls_x509_crt *chain )
6823{
6824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6825#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6826 int crt_cnt=0;
6827#endif
6828 size_t i, n;
6829 uint8_t alert;
6830
6831 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6832 {
6833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6834 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6835 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6836 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6837 }
6838
6839 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6840 {
6841 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6842 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6843 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6844 }
6845
6846 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6847 {
6848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6849 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6850 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6851 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6852 }
6853
6854 i = mbedtls_ssl_hs_hdr_len( ssl );
6855
6856 /*
6857 * Same message structure as in mbedtls_ssl_write_certificate()
6858 */
6859 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6860
6861 if( ssl->in_msg[i] != 0 ||
6862 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6863 {
6864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6865 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6866 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6867 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6868 }
6869
6870 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6871 i += 3;
6872
6873 /* Iterate through and parse the CRTs in the provided chain. */
6874 while( i < ssl->in_hslen )
6875 {
6876 /* Check that there's room for the next CRT's length fields. */
6877 if ( i + 3 > ssl->in_hslen ) {
6878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6879 mbedtls_ssl_send_alert_message( ssl,
6880 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6881 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6882 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6883 }
6884 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6885 * anything beyond 2**16 ~ 64K. */
6886 if( ssl->in_msg[i] != 0 )
6887 {
6888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6889 mbedtls_ssl_send_alert_message( ssl,
6890 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6891 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6892 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6893 }
6894
6895 /* Read length of the next CRT in the chain. */
6896 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6897 | (unsigned int) ssl->in_msg[i + 2];
6898 i += 3;
6899
6900 if( n < 128 || i + n > ssl->in_hslen )
6901 {
6902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6903 mbedtls_ssl_send_alert_message( ssl,
6904 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6905 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6906 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6907 }
6908
6909 /* Check if we're handling the first CRT in the chain. */
6910#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6911 if( crt_cnt++ == 0 &&
6912 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6913 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6914 {
6915 /* During client-side renegotiation, check that the server's
6916 * end-CRTs hasn't changed compared to the initial handshake,
6917 * mitigating the triple handshake attack. On success, reuse
6918 * the original end-CRT instead of parsing it again. */
6919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6920 if( ssl_check_peer_crt_unchanged( ssl,
6921 &ssl->in_msg[i],
6922 n ) != 0 )
6923 {
6924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6925 mbedtls_ssl_send_alert_message( ssl,
6926 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6927 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6928 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6929 }
6930
6931 /* Now we can safely free the original chain. */
6932 ssl_clear_peer_cert( ssl->session );
6933 }
6934#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6935
6936 /* Parse the next certificate in the chain. */
6937#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6938 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6939#else
6940 /* If we don't need to store the CRT chain permanently, parse
6941 * it in-place from the input buffer instead of making a copy. */
6942 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6943#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6944 switch( ret )
6945 {
6946 case 0: /*ok*/
6947 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6948 /* Ignore certificate with an unknown algorithm: maybe a
6949 prior certificate was already trusted. */
6950 break;
6951
6952 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6953 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6954 goto crt_parse_der_failed;
6955
6956 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6957 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6958 goto crt_parse_der_failed;
6959
6960 default:
6961 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6962 crt_parse_der_failed:
6963 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6964 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6965 return( ret );
6966 }
6967
6968 i += n;
6969 }
6970
6971 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6972 return( 0 );
6973}
6974
6975#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006976MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006977static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6978{
6979 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6980 return( -1 );
6981
6982 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6983 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6984 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6985 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6986 {
Ronald Cron19385882022-06-15 16:26:13 +02006987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006988 return( 0 );
6989 }
6990 return( -1 );
6991}
6992#endif /* MBEDTLS_SSL_SRV_C */
6993
6994/* Check if a certificate message is expected.
6995 * Return either
6996 * - SSL_CERTIFICATE_EXPECTED, or
6997 * - SSL_CERTIFICATE_SKIP
6998 * indicating whether a Certificate message is expected or not.
6999 */
7000#define SSL_CERTIFICATE_EXPECTED 0
7001#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007002MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007003static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
7004 int authmode )
7005{
7006 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7007 ssl->handshake->ciphersuite_info;
7008
7009 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7010 return( SSL_CERTIFICATE_SKIP );
7011
7012#if defined(MBEDTLS_SSL_SRV_C)
7013 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7014 {
7015 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
7016 return( SSL_CERTIFICATE_SKIP );
7017
7018 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7019 {
7020 ssl->session_negotiate->verify_result =
7021 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
7022 return( SSL_CERTIFICATE_SKIP );
7023 }
7024 }
7025#else
7026 ((void) authmode);
7027#endif /* MBEDTLS_SSL_SRV_C */
7028
7029 return( SSL_CERTIFICATE_EXPECTED );
7030}
7031
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007033static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
7034 int authmode,
7035 mbedtls_x509_crt *chain,
7036 void *rs_ctx )
7037{
7038 int ret = 0;
7039 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7040 ssl->handshake->ciphersuite_info;
7041 int have_ca_chain = 0;
7042
7043 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7044 void *p_vrfy;
7045
7046 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7047 return( 0 );
7048
7049 if( ssl->f_vrfy != NULL )
7050 {
7051 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
7052 f_vrfy = ssl->f_vrfy;
7053 p_vrfy = ssl->p_vrfy;
7054 }
7055 else
7056 {
7057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
7058 f_vrfy = ssl->conf->f_vrfy;
7059 p_vrfy = ssl->conf->p_vrfy;
7060 }
7061
7062 /*
7063 * Main check: verify certificate
7064 */
7065#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
7066 if( ssl->conf->f_ca_cb != NULL )
7067 {
7068 ((void) rs_ctx);
7069 have_ca_chain = 1;
7070
7071 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
7072 ret = mbedtls_x509_crt_verify_with_ca_cb(
7073 chain,
7074 ssl->conf->f_ca_cb,
7075 ssl->conf->p_ca_cb,
7076 ssl->conf->cert_profile,
7077 ssl->hostname,
7078 &ssl->session_negotiate->verify_result,
7079 f_vrfy, p_vrfy );
7080 }
7081 else
7082#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7083 {
7084 mbedtls_x509_crt *ca_chain;
7085 mbedtls_x509_crl *ca_crl;
7086
7087#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7088 if( ssl->handshake->sni_ca_chain != NULL )
7089 {
7090 ca_chain = ssl->handshake->sni_ca_chain;
7091 ca_crl = ssl->handshake->sni_ca_crl;
7092 }
7093 else
7094#endif
7095 {
7096 ca_chain = ssl->conf->ca_chain;
7097 ca_crl = ssl->conf->ca_crl;
7098 }
7099
7100 if( ca_chain != NULL )
7101 have_ca_chain = 1;
7102
7103 ret = mbedtls_x509_crt_verify_restartable(
7104 chain,
7105 ca_chain, ca_crl,
7106 ssl->conf->cert_profile,
7107 ssl->hostname,
7108 &ssl->session_negotiate->verify_result,
7109 f_vrfy, p_vrfy, rs_ctx );
7110 }
7111
7112 if( ret != 0 )
7113 {
7114 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
7115 }
7116
7117#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7118 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
7119 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
7120#endif
7121
7122 /*
7123 * Secondary checks: always done, but change 'ret' only if it was 0
7124 */
7125
7126#if defined(MBEDTLS_ECP_C)
7127 {
7128 const mbedtls_pk_context *pk = &chain->pk;
7129
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007130 /* If certificate uses an EC key, make sure the curve is OK.
7131 * This is a public key, so it can't be opaque, so can_do() is a good
7132 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007133 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08007134 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007135 /* and in the unlikely case the above assumption no longer holds
7136 * we are making sure that pk_ec() here does not return a NULL
7137 */
7138 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
7139 if( ec == NULL )
7140 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01007141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007142 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7143 }
Jerry Yud9526692022-02-17 14:23:47 +08007144
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007145 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
7146 {
7147 ssl->session_negotiate->verify_result |=
7148 MBEDTLS_X509_BADCERT_BAD_KEY;
7149
7150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
7151 if( ret == 0 )
7152 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7153 }
Jerry Yud9526692022-02-17 14:23:47 +08007154 }
7155 }
7156#endif /* MBEDTLS_ECP_C */
7157
7158 if( mbedtls_ssl_check_cert_usage( chain,
7159 ciphersuite_info,
7160 ! ssl->conf->endpoint,
7161 &ssl->session_negotiate->verify_result ) != 0 )
7162 {
7163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
7164 if( ret == 0 )
7165 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7166 }
7167
7168 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7169 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7170 * with details encoded in the verification flags. All other kinds
7171 * of error codes, including those from the user provided f_vrfy
7172 * functions, are treated as fatal and lead to a failure of
7173 * ssl_parse_certificate even if verification was optional. */
7174 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7175 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7176 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
7177 {
7178 ret = 0;
7179 }
7180
7181 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
7182 {
7183 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
7184 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7185 }
7186
7187 if( ret != 0 )
7188 {
7189 uint8_t alert;
7190
7191 /* The certificate may have been rejected for several reasons.
7192 Pick one and send the corresponding alert. Which alert to send
7193 may be a subject of debate in some cases. */
7194 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
7195 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
7196 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
7197 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
7198 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
7199 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7200 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
7201 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7202 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
7203 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7204 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
7205 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7206 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
7207 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7208 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
7209 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
7210 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
7211 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
7212 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
7213 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
7214 else
7215 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
7216 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7217 alert );
7218 }
7219
7220#if defined(MBEDTLS_DEBUG_C)
7221 if( ssl->session_negotiate->verify_result != 0 )
7222 {
7223 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
7224 (unsigned int) ssl->session_negotiate->verify_result ) );
7225 }
7226 else
7227 {
7228 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
7229 }
7230#endif /* MBEDTLS_DEBUG_C */
7231
7232 return( ret );
7233}
7234
7235#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007236MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007237static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
7238 unsigned char *start, size_t len )
7239{
7240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7241 /* Remember digest of the peer's end-CRT. */
7242 ssl->session_negotiate->peer_cert_digest =
7243 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
7244 if( ssl->session_negotiate->peer_cert_digest == NULL )
7245 {
7246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
7247 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
7248 mbedtls_ssl_send_alert_message( ssl,
7249 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7250 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7251
7252 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7253 }
7254
7255 ret = mbedtls_md( mbedtls_md_info_from_type(
7256 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
7257 start, len,
7258 ssl->session_negotiate->peer_cert_digest );
7259
7260 ssl->session_negotiate->peer_cert_digest_type =
7261 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7262 ssl->session_negotiate->peer_cert_digest_len =
7263 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7264
7265 return( ret );
7266}
7267
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007268MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007269static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
7270 unsigned char *start, size_t len )
7271{
7272 unsigned char *end = start + len;
7273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7274
7275 /* Make a copy of the peer's raw public key. */
7276 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
7277 ret = mbedtls_pk_parse_subpubkey( &start, end,
7278 &ssl->handshake->peer_pubkey );
7279 if( ret != 0 )
7280 {
7281 /* We should have parsed the public key before. */
7282 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7283 }
7284
7285 return( 0 );
7286}
7287#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7288
7289int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
7290{
7291 int ret = 0;
7292 int crt_expected;
7293#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7294 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7295 ? ssl->handshake->sni_authmode
7296 : ssl->conf->authmode;
7297#else
7298 const int authmode = ssl->conf->authmode;
7299#endif
7300 void *rs_ctx = NULL;
7301 mbedtls_x509_crt *chain = NULL;
7302
7303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
7304
7305 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
7306 if( crt_expected == SSL_CERTIFICATE_SKIP )
7307 {
7308 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
7309 goto exit;
7310 }
7311
7312#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7313 if( ssl->handshake->ecrs_enabled &&
7314 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
7315 {
7316 chain = ssl->handshake->ecrs_peer_cert;
7317 ssl->handshake->ecrs_peer_cert = NULL;
7318 goto crt_verify;
7319 }
7320#endif
7321
7322 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7323 {
7324 /* mbedtls_ssl_read_record may have sent an alert already. We
7325 let it decide whether to alert. */
7326 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7327 goto exit;
7328 }
7329
7330#if defined(MBEDTLS_SSL_SRV_C)
7331 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
7332 {
7333 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7334
7335 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
7336 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
7337
7338 goto exit;
7339 }
7340#endif /* MBEDTLS_SSL_SRV_C */
7341
7342 /* Clear existing peer CRT structure in case we tried to
7343 * reuse a session but it failed, and allocate a new one. */
7344 ssl_clear_peer_cert( ssl->session_negotiate );
7345
7346 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7347 if( chain == NULL )
7348 {
7349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7350 sizeof( mbedtls_x509_crt ) ) );
7351 mbedtls_ssl_send_alert_message( ssl,
7352 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7353 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7354
7355 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7356 goto exit;
7357 }
7358 mbedtls_x509_crt_init( chain );
7359
7360 ret = ssl_parse_certificate_chain( ssl, chain );
7361 if( ret != 0 )
7362 goto exit;
7363
7364#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7365 if( ssl->handshake->ecrs_enabled)
7366 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
7367
7368crt_verify:
7369 if( ssl->handshake->ecrs_enabled)
7370 rs_ctx = &ssl->handshake->ecrs_ctx;
7371#endif
7372
7373 ret = ssl_parse_certificate_verify( ssl, authmode,
7374 chain, rs_ctx );
7375 if( ret != 0 )
7376 goto exit;
7377
7378#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7379 {
7380 unsigned char *crt_start, *pk_start;
7381 size_t crt_len, pk_len;
7382
7383 /* We parse the CRT chain without copying, so
7384 * these pointers point into the input buffer,
7385 * and are hence still valid after freeing the
7386 * CRT chain. */
7387
7388 crt_start = chain->raw.p;
7389 crt_len = chain->raw.len;
7390
7391 pk_start = chain->pk_raw.p;
7392 pk_len = chain->pk_raw.len;
7393
7394 /* Free the CRT structures before computing
7395 * digest and copying the peer's public key. */
7396 mbedtls_x509_crt_free( chain );
7397 mbedtls_free( chain );
7398 chain = NULL;
7399
7400 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
7401 if( ret != 0 )
7402 goto exit;
7403
7404 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
7405 if( ret != 0 )
7406 goto exit;
7407 }
7408#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7409 /* Pass ownership to session structure. */
7410 ssl->session_negotiate->peer_cert = chain;
7411 chain = NULL;
7412#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7413
7414 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
7415
7416exit:
7417
7418 if( ret == 0 )
7419 ssl->state++;
7420
7421#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7422 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
7423 {
7424 ssl->handshake->ecrs_peer_cert = chain;
7425 chain = NULL;
7426 }
7427#endif
7428
7429 if( chain != NULL )
7430 {
7431 mbedtls_x509_crt_free( chain );
7432 mbedtls_free( chain );
7433 }
7434
7435 return( ret );
7436}
7437#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7438
Andrzej Kurek25f27152022-08-17 16:09:31 -04007439#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007440static void ssl_calc_finished_tls_sha256(
7441 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
7442{
7443 int len = 12;
7444 const char *sender;
7445 unsigned char padbuf[32];
7446#if defined(MBEDTLS_USE_PSA_CRYPTO)
7447 size_t hash_size;
7448 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7449 psa_status_t status;
7450#else
7451 mbedtls_sha256_context sha256;
7452#endif
7453
7454 mbedtls_ssl_session *session = ssl->session_negotiate;
7455 if( !session )
7456 session = ssl->session;
7457
7458 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
7459 ? "client finished"
7460 : "server finished";
7461
7462#if defined(MBEDTLS_USE_PSA_CRYPTO)
7463 sha256_psa = psa_hash_operation_init();
7464
7465 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
7466
7467 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
7468 if( status != PSA_SUCCESS )
7469 {
7470 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7471 return;
7472 }
7473
7474 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
7475 if( status != PSA_SUCCESS )
7476 {
7477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7478 return;
7479 }
7480 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
7481#else
7482
7483 mbedtls_sha256_init( &sha256 );
7484
7485 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
7486
7487 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
7488
7489 /*
7490 * TLSv1.2:
7491 * hash = PRF( master, finished_label,
7492 * Hash( handshake ) )[0.11]
7493 */
7494
7495#if !defined(MBEDTLS_SHA256_ALT)
7496 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
7497 sha256.state, sizeof( sha256.state ) );
7498#endif
7499
7500 mbedtls_sha256_finish( &sha256, padbuf );
7501 mbedtls_sha256_free( &sha256 );
7502#endif /* MBEDTLS_USE_PSA_CRYPTO */
7503
7504 ssl->handshake->tls_prf( session->master, 48, sender,
7505 padbuf, 32, buf, len );
7506
7507 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7508
7509 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7510
7511 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7512}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007513#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007514
Jerry Yub7ba49e2022-02-17 14:25:53 +08007515
Andrzej Kurek25f27152022-08-17 16:09:31 -04007516#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007517static void ssl_calc_finished_tls_sha384(
7518 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
7519{
7520 int len = 12;
7521 const char *sender;
7522 unsigned char padbuf[48];
7523#if defined(MBEDTLS_USE_PSA_CRYPTO)
7524 size_t hash_size;
7525 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7526 psa_status_t status;
7527#else
7528 mbedtls_sha512_context sha512;
7529#endif
7530
7531 mbedtls_ssl_session *session = ssl->session_negotiate;
7532 if( !session )
7533 session = ssl->session;
7534
7535 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
7536 ? "client finished"
7537 : "server finished";
7538
7539#if defined(MBEDTLS_USE_PSA_CRYPTO)
7540 sha384_psa = psa_hash_operation_init();
7541
7542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
7543
7544 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
7545 if( status != PSA_SUCCESS )
7546 {
7547 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7548 return;
7549 }
7550
7551 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
7552 if( status != PSA_SUCCESS )
7553 {
7554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7555 return;
7556 }
7557 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
7558#else
7559 mbedtls_sha512_init( &sha512 );
7560
7561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
7562
Andrzej Kureka242e832022-08-11 10:03:14 -04007563 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08007564
7565 /*
7566 * TLSv1.2:
7567 * hash = PRF( master, finished_label,
7568 * Hash( handshake ) )[0.11]
7569 */
7570
7571#if !defined(MBEDTLS_SHA512_ALT)
7572 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7573 sha512.state, sizeof( sha512.state ) );
7574#endif
7575 mbedtls_sha512_finish( &sha512, padbuf );
7576
7577 mbedtls_sha512_free( &sha512 );
7578#endif
7579
7580 ssl->handshake->tls_prf( session->master, 48, sender,
7581 padbuf, 48, buf, len );
7582
7583 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7584
7585 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7586
7587 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7588}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007589#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007590
Jerry Yuaef00152022-02-17 14:27:31 +08007591void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7592{
7593 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7594
7595 /*
7596 * Free our handshake params
7597 */
7598 mbedtls_ssl_handshake_free( ssl );
7599 mbedtls_free( ssl->handshake );
7600 ssl->handshake = NULL;
7601
7602 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007603 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007604 */
7605 if( ssl->transform )
7606 {
7607 mbedtls_ssl_transform_free( ssl->transform );
7608 mbedtls_free( ssl->transform );
7609 }
7610 ssl->transform = ssl->transform_negotiate;
7611 ssl->transform_negotiate = NULL;
7612
7613 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7614}
7615
Jerry Yu2a9fff52022-02-17 14:28:51 +08007616void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7617{
7618 int resume = ssl->handshake->resume;
7619
7620 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7621
7622#if defined(MBEDTLS_SSL_RENEGOTIATION)
7623 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7624 {
7625 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7626 ssl->renego_records_seen = 0;
7627 }
7628#endif
7629
7630 /*
7631 * Free the previous session and switch in the current one
7632 */
7633 if( ssl->session )
7634 {
7635#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7636 /* RFC 7366 3.1: keep the EtM state */
7637 ssl->session_negotiate->encrypt_then_mac =
7638 ssl->session->encrypt_then_mac;
7639#endif
7640
7641 mbedtls_ssl_session_free( ssl->session );
7642 mbedtls_free( ssl->session );
7643 }
7644 ssl->session = ssl->session_negotiate;
7645 ssl->session_negotiate = NULL;
7646
7647 /*
7648 * Add cache entry
7649 */
7650 if( ssl->conf->f_set_cache != NULL &&
7651 ssl->session->id_len != 0 &&
7652 resume == 0 )
7653 {
7654 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7655 ssl->session->id,
7656 ssl->session->id_len,
7657 ssl->session ) != 0 )
7658 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7659 }
7660
7661#if defined(MBEDTLS_SSL_PROTO_DTLS)
7662 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7663 ssl->handshake->flight != NULL )
7664 {
7665 /* Cancel handshake timer */
7666 mbedtls_ssl_set_timer( ssl, 0 );
7667
7668 /* Keep last flight around in case we need to resend it:
7669 * we need the handshake and transform structures for that */
7670 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7671 }
7672 else
7673#endif
7674 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7675
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007676 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007677
7678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7679}
7680
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007681int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7682{
7683 int ret, hash_len;
7684
7685 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7686
7687 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7688
7689 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7690
7691 /*
7692 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7693 * may define some other value. Currently (early 2016), no defined
7694 * ciphersuite does this (and this is unlikely to change as activity has
7695 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7696 */
7697 hash_len = 12;
7698
7699#if defined(MBEDTLS_SSL_RENEGOTIATION)
7700 ssl->verify_data_len = hash_len;
7701 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7702#endif
7703
7704 ssl->out_msglen = 4 + hash_len;
7705 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7706 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7707
7708 /*
7709 * In case of session resuming, invert the client and server
7710 * ChangeCipherSpec messages order.
7711 */
7712 if( ssl->handshake->resume != 0 )
7713 {
7714#if defined(MBEDTLS_SSL_CLI_C)
7715 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7716 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7717#endif
7718#if defined(MBEDTLS_SSL_SRV_C)
7719 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7720 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7721#endif
7722 }
7723 else
7724 ssl->state++;
7725
7726 /*
7727 * Switch to our negotiated transform and session parameters for outbound
7728 * data.
7729 */
7730 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7731
7732#if defined(MBEDTLS_SSL_PROTO_DTLS)
7733 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7734 {
7735 unsigned char i;
7736
7737 /* Remember current epoch settings for resending */
7738 ssl->handshake->alt_transform_out = ssl->transform_out;
7739 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7740 sizeof( ssl->handshake->alt_out_ctr ) );
7741
7742 /* Set sequence_number to zero */
7743 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7744
7745
7746 /* Increment epoch */
7747 for( i = 2; i > 0; i-- )
7748 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7749 break;
7750
7751 /* The loop goes to its end iff the counter is wrapping */
7752 if( i == 0 )
7753 {
7754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7755 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7756 }
7757 }
7758 else
7759#endif /* MBEDTLS_SSL_PROTO_DTLS */
7760 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7761
7762 ssl->transform_out = ssl->transform_negotiate;
7763 ssl->session_out = ssl->session_negotiate;
7764
7765#if defined(MBEDTLS_SSL_PROTO_DTLS)
7766 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7767 mbedtls_ssl_send_flight_completed( ssl );
7768#endif
7769
7770 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7771 {
7772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7773 return( ret );
7774 }
7775
7776#if defined(MBEDTLS_SSL_PROTO_DTLS)
7777 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7778 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7779 {
7780 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7781 return( ret );
7782 }
7783#endif
7784
7785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7786
7787 return( 0 );
7788}
7789
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007790#define SSL_MAX_HASH_LEN 12
7791
7792int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7793{
7794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7795 unsigned int hash_len = 12;
7796 unsigned char buf[SSL_MAX_HASH_LEN];
7797
7798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7799
7800 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7801
7802 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7803 {
7804 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7805 goto exit;
7806 }
7807
7808 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7809 {
7810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7811 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7812 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7813 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7814 goto exit;
7815 }
7816
7817 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7818 {
7819 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7820 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7821 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7822 goto exit;
7823 }
7824
7825 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7826 {
7827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7828 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7829 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7830 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7831 goto exit;
7832 }
7833
7834 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7835 buf, hash_len ) != 0 )
7836 {
7837 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7838 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7839 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7840 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7841 goto exit;
7842 }
7843
7844#if defined(MBEDTLS_SSL_RENEGOTIATION)
7845 ssl->verify_data_len = hash_len;
7846 memcpy( ssl->peer_verify_data, buf, hash_len );
7847#endif
7848
7849 if( ssl->handshake->resume != 0 )
7850 {
7851#if defined(MBEDTLS_SSL_CLI_C)
7852 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7853 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7854#endif
7855#if defined(MBEDTLS_SSL_SRV_C)
7856 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7857 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7858#endif
7859 }
7860 else
7861 ssl->state++;
7862
7863#if defined(MBEDTLS_SSL_PROTO_DTLS)
7864 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7865 mbedtls_ssl_recv_flight_completed( ssl );
7866#endif
7867
7868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7869
7870exit:
7871 mbedtls_platform_zeroize( buf, hash_len );
7872 return( ret );
7873}
7874
Jerry Yu392112c2022-02-17 14:34:10 +08007875#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7876/*
7877 * Helper to get TLS 1.2 PRF from ciphersuite
7878 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7879 */
7880static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7881{
Jerry Yu392112c2022-02-17 14:34:10 +08007882 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Andrzej Kurek68327742022-10-03 06:18:18 -04007883 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7884#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007885 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007886 return( tls_prf_sha384 );
Andrzej Kurek894edde2022-09-29 06:31:14 -04007887 else
Jerry Yu392112c2022-02-17 14:34:10 +08007888#endif
Andrzej Kurek894edde2022-09-29 06:31:14 -04007889#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
7890 {
7891 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256 )
7892 return( tls_prf_sha256 );
7893 }
7894#endif
7895#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
7896 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
7897 (void) ciphersuite_info;
7898#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007899
Andrzej Kurek894edde2022-09-29 06:31:14 -04007900 return( NULL );
Jerry Yu392112c2022-02-17 14:34:10 +08007901}
7902#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007903
7904static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7905{
7906 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04007907#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007908 if( tls_prf == tls_prf_sha384 )
7909 {
7910 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7911 }
7912 else
7913#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04007914#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007915 if( tls_prf == tls_prf_sha256 )
7916 {
7917 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7918 }
7919 else
7920#endif
7921 return( MBEDTLS_SSL_TLS_PRF_NONE );
7922}
7923
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924/*
7925 * Populate a transform structure with session keys and all the other
7926 * necessary information.
7927 *
7928 * Parameters:
7929 * - [in/out]: transform: structure to populate
7930 * [in] must be just initialised with mbedtls_ssl_transform_init()
7931 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7932 * - [in] ciphersuite
7933 * - [in] master
7934 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007935 * - [in] tls_prf: pointer to PRF to use for key derivation
7936 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007937 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007938 * - [in] endpoint: client or server
7939 * - [in] ssl: used for:
7940 * - ssl->conf->{f,p}_export_keys
7941 * [in] optionally used for:
7942 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7943 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007944MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007945static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7946 int ciphersuite,
7947 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007948#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007949 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007950#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007951 ssl_tls_prf_t tls_prf,
7952 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007953 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007954 unsigned endpoint,
7955 const mbedtls_ssl_context *ssl )
7956{
7957 int ret = 0;
7958 unsigned char keyblk[256];
7959 unsigned char *key1;
7960 unsigned char *key2;
7961 unsigned char *mac_enc;
7962 unsigned char *mac_dec;
7963 size_t mac_key_len = 0;
7964 size_t iv_copy_len;
7965 size_t keylen;
7966 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007967 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007968#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007969 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007970 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007971#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007972
7973#if defined(MBEDTLS_USE_PSA_CRYPTO)
7974 psa_key_type_t key_type;
7975 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7976 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007977 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007978 size_t key_bits;
7979 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7980#endif
7981
7982#if !defined(MBEDTLS_DEBUG_C) && \
7983 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7984 if( ssl->f_export_keys == NULL )
7985 {
7986 ssl = NULL; /* make sure we don't use it except for these cases */
7987 (void) ssl;
7988 }
7989#endif
7990
7991 /*
7992 * Some data just needs copying into the structure
7993 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007994#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007995 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007996#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007997 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998
7999#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8000 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
8001#endif
8002
8003#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04008004 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005 {
8006 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8007 * generation separate. This should never happen. */
8008 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8009 }
8010#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8011
8012 /*
8013 * Get various info structures
8014 */
8015 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
8016 if( ciphersuite_info == NULL )
8017 {
8018 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
8019 ciphersuite ) );
8020 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8021 }
8022
Neil Armstrongab555e02022-04-04 11:07:59 +02008023 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008024#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008025 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008026#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008027 ciphersuite_info );
8028
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008029 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
8030 transform->taglen =
8031 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
8032
8033#if defined(MBEDTLS_USE_PSA_CRYPTO)
8034 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
8035 transform->taglen,
8036 &alg,
8037 &key_type,
8038 &key_bits ) ) != PSA_SUCCESS )
8039 {
8040 ret = psa_ssl_status_to_mbedtls( status );
8041 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
8042 goto end;
8043 }
8044#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008045 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
8046 if( cipher_info == NULL )
8047 {
8048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
8049 ciphersuite_info->cipher ) );
8050 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8051 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008052#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008053
Neil Armstronge4512952022-03-08 09:08:22 +01008054#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008055 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01008056 if( mac_alg == 0 )
8057 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008058 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01008059 (unsigned) ciphersuite_info->mac ) );
8060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8061 }
8062#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008063 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
8064 if( md_info == NULL )
8065 {
8066 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
8067 (unsigned) ciphersuite_info->mac ) );
8068 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8069 }
Neil Armstronge4512952022-03-08 09:08:22 +01008070#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008071
8072#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8073 /* Copy own and peer's CID if the use of the CID
8074 * extension has been negotiated. */
8075 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
8076 {
8077 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
8078
8079 transform->in_cid_len = ssl->own_cid_len;
8080 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
8081 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
8082 transform->in_cid_len );
8083
8084 transform->out_cid_len = ssl->handshake->peer_cid_len;
8085 memcpy( transform->out_cid, ssl->handshake->peer_cid,
8086 ssl->handshake->peer_cid_len );
8087 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
8088 transform->out_cid_len );
8089 }
8090#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8091
8092 /*
8093 * Compute key block using the PRF
8094 */
8095 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
8096 if( ret != 0 )
8097 {
8098 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
8099 return( ret );
8100 }
8101
8102 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
8103 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
8104 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
8105 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
8106 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
8107
8108 /*
8109 * Determine the appropriate key, IV and MAC length.
8110 */
8111
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008112#if defined(MBEDTLS_USE_PSA_CRYPTO)
8113 keylen = PSA_BITS_TO_BYTES(key_bits);
8114#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008115 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008116#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008117
8118#if defined(MBEDTLS_GCM_C) || \
8119 defined(MBEDTLS_CCM_C) || \
8120 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008121 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008122 {
8123 size_t explicit_ivlen;
8124
8125 transform->maclen = 0;
8126 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008127
8128 /* All modes haves 96-bit IVs, but the length of the static parts vary
8129 * with mode and version:
8130 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8131 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8132 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8133 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8134 * sequence number).
8135 */
8136 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008137
8138 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008139#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann3b2276a2022-10-06 14:49:08 +01008140 is_chachapoly = ( key_type == PSA_KEY_TYPE_CHACHA20 );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008141#else
David Horstmann3b2276a2022-10-06 14:49:08 +01008142 is_chachapoly = ( mbedtls_cipher_info_get_mode( cipher_info )
8143 == MBEDTLS_MODE_CHACHAPOLY );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008144#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008145
8146 if( is_chachapoly )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008147 transform->fixed_ivlen = 12;
8148 else
8149 transform->fixed_ivlen = 4;
8150
8151 /* Minimum length of encrypted record */
8152 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8153 transform->minlen = explicit_ivlen + transform->taglen;
8154 }
8155 else
8156#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8157#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008158 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
8159 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
8160 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008161 {
Neil Armstronge4512952022-03-08 09:08:22 +01008162#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02008163 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008164#else
8165 size_t block_size = cipher_info->block_size;
8166#endif /* MBEDTLS_USE_PSA_CRYPTO */
8167
8168#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008169 /* Get MAC length */
8170 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8171#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008172 /* Initialize HMAC contexts */
8173 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
8174 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
8175 {
8176 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
8177 goto end;
8178 }
8179
8180 /* Get MAC length */
8181 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01008182#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008183 transform->maclen = mac_key_len;
8184
8185 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008186#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02008187 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008188#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008190#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008191
8192 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008193 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008194 transform->minlen = transform->maclen;
8195 else
8196 {
8197 /*
8198 * GenericBlockCipher:
8199 * 1. if EtM is in use: one block plus MAC
8200 * otherwise: * first multiple of blocklen greater than maclen
8201 * 2. IV
8202 */
8203#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008204 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008205 {
8206 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008207 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008208 }
8209 else
8210#endif
8211 {
8212 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008213 + block_size
8214 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008215 }
8216
Glenn Strauss07c64162022-03-14 12:34:51 -04008217 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008218 {
8219 transform->minlen += transform->ivlen;
8220 }
8221 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008222 {
8223 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8224 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8225 goto end;
8226 }
8227 }
8228 }
8229 else
8230#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8231 {
8232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8233 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8234 }
8235
8236 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8237 (unsigned) keylen,
8238 (unsigned) transform->minlen,
8239 (unsigned) transform->ivlen,
8240 (unsigned) transform->maclen ) );
8241
8242 /*
8243 * Finally setup the cipher contexts, IVs and MAC secrets.
8244 */
8245#if defined(MBEDTLS_SSL_CLI_C)
8246 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
8247 {
8248 key1 = keyblk + mac_key_len * 2;
8249 key2 = keyblk + mac_key_len * 2 + keylen;
8250
8251 mac_enc = keyblk;
8252 mac_dec = keyblk + mac_key_len;
8253
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254 iv_copy_len = ( transform->fixed_ivlen ) ?
8255 transform->fixed_ivlen : transform->ivlen;
8256 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
8257 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
8258 iv_copy_len );
8259 }
8260 else
8261#endif /* MBEDTLS_SSL_CLI_C */
8262#if defined(MBEDTLS_SSL_SRV_C)
8263 if( endpoint == MBEDTLS_SSL_IS_SERVER )
8264 {
8265 key1 = keyblk + mac_key_len * 2 + keylen;
8266 key2 = keyblk + mac_key_len * 2;
8267
8268 mac_enc = keyblk + mac_key_len;
8269 mac_dec = keyblk;
8270
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008271 iv_copy_len = ( transform->fixed_ivlen ) ?
8272 transform->fixed_ivlen : transform->ivlen;
8273 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
8274 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
8275 iv_copy_len );
8276 }
8277 else
8278#endif /* MBEDTLS_SSL_SRV_C */
8279 {
8280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8281 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8282 goto end;
8283 }
8284
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285 if( ssl != NULL && ssl->f_export_keys != NULL )
8286 {
8287 ssl->f_export_keys( ssl->p_export_keys,
8288 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8289 master, 48,
8290 randbytes + 32,
8291 randbytes,
8292 tls_prf_get_type( tls_prf ) );
8293 }
8294
8295#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008296 transform->psa_alg = alg;
8297
8298 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
8299 {
8300 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
8301 psa_set_key_algorithm( &attributes, alg );
8302 psa_set_key_type( &attributes, key_type );
8303
8304 if( ( status = psa_import_key( &attributes,
8305 key1,
8306 PSA_BITS_TO_BYTES( key_bits ),
8307 &transform->psa_key_enc ) ) != PSA_SUCCESS )
8308 {
8309 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
8310 ret = psa_ssl_status_to_mbedtls( status );
8311 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
8312 goto end;
8313 }
8314
8315 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
8316
8317 if( ( status = psa_import_key( &attributes,
8318 key2,
8319 PSA_BITS_TO_BYTES( key_bits ),
8320 &transform->psa_key_dec ) ) != PSA_SUCCESS )
8321 {
8322 ret = psa_ssl_status_to_mbedtls( status );
8323 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
8324 goto end;
8325 }
8326 }
8327#else
8328 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
8329 cipher_info ) ) != 0 )
8330 {
8331 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
8332 goto end;
8333 }
8334
8335 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
8336 cipher_info ) ) != 0 )
8337 {
8338 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
8339 goto end;
8340 }
8341
8342 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
8343 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
8344 MBEDTLS_ENCRYPT ) ) != 0 )
8345 {
8346 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
8347 goto end;
8348 }
8349
8350 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
8351 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
8352 MBEDTLS_DECRYPT ) ) != 0 )
8353 {
8354 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
8355 goto end;
8356 }
8357
8358#if defined(MBEDTLS_CIPHER_MODE_CBC)
8359 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
8360 {
8361 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
8362 MBEDTLS_PADDING_NONE ) ) != 0 )
8363 {
8364 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
8365 goto end;
8366 }
8367
8368 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
8369 MBEDTLS_PADDING_NONE ) ) != 0 )
8370 {
8371 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
8372 goto end;
8373 }
8374 }
8375#endif /* MBEDTLS_CIPHER_MODE_CBC */
8376#endif /* MBEDTLS_USE_PSA_CRYPTO */
8377
Neil Armstrong29c0c042022-03-17 17:47:28 +01008378#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8379 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8380 For AEAD-based ciphersuites, there is nothing to do here. */
8381 if( mac_key_len != 0 )
8382 {
8383#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008384 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01008385
8386 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01008387 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01008388 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
8389
8390 if( ( status = psa_import_key( &attributes,
8391 mac_enc, mac_key_len,
8392 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
8393 {
8394 ret = psa_ssl_status_to_mbedtls( status );
8395 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
8396 goto end;
8397 }
8398
Ronald Cronfb39f152022-03-25 14:36:28 +01008399 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008400 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
8401#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
8402 && ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED )
8403#endif
8404 ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01008405 /* mbedtls_ct_hmac() requires the key to be exportable */
8406 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
8407 PSA_KEY_USAGE_VERIFY_HASH );
8408 else
8409 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
8410
8411 if( ( status = psa_import_key( &attributes,
8412 mac_dec, mac_key_len,
8413 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
8414 {
8415 ret = psa_ssl_status_to_mbedtls( status );
8416 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
8417 goto end;
8418 }
8419#else
8420 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
8421 if( ret != 0 )
8422 goto end;
8423 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
8424 if( ret != 0 )
8425 goto end;
8426#endif /* MBEDTLS_USE_PSA_CRYPTO */
8427 }
8428#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8429
8430 ((void) mac_dec);
8431 ((void) mac_enc);
8432
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008433end:
8434 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
8435 return( ret );
8436}
8437
Valerio Settia08b1a42022-11-17 15:10:02 +01008438#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8439 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008440int mbedtls_psa_ecjpake_read_round(
Valerio Settia08b1a42022-11-17 15:10:02 +01008441 psa_pake_operation_t *pake_ctx,
8442 const unsigned char *buf,
Valerio Setti6b3dab02022-11-17 17:14:54 +01008443 size_t len, mbedtls_ecjpake_rounds_t round )
Valerio Settia08b1a42022-11-17 15:10:02 +01008444{
8445 psa_status_t status;
8446 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008447 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008448 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8449 * At round two perform a single cycle
8450 */
8451 unsigned int remaining_steps = ( round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008452
Valerio Setti6b3dab02022-11-17 17:14:54 +01008453 for( ; remaining_steps > 0; remaining_steps-- )
Valerio Settia08b1a42022-11-17 15:10:02 +01008454 {
8455 for( psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8456 step <= PSA_PAKE_STEP_ZK_PROOF;
8457 ++step )
8458 {
8459 /* Length is stored at the first byte */
8460 size_t length = buf[input_offset];
8461 input_offset += 1;
8462
8463 if( input_offset + length > len )
8464 {
8465 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8466 }
8467
8468 status = psa_pake_input( pake_ctx, step,
8469 buf + input_offset, length );
8470 if( status != PSA_SUCCESS)
8471 {
8472 return psa_ssl_status_to_mbedtls( status );
8473 }
8474
8475 input_offset += length;
8476 }
8477 }
8478
Valerio Setti819de862022-11-17 18:05:19 +01008479 if( input_offset != len )
Valerio Setti61ea17d2022-11-18 12:11:00 +01008480 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Valerio Setti30ebe112022-11-17 16:23:34 +01008481
Valerio Settia08b1a42022-11-17 15:10:02 +01008482 return( 0 );
8483}
8484
Valerio Setti6b3dab02022-11-17 17:14:54 +01008485int mbedtls_psa_ecjpake_write_round(
Valerio Settia08b1a42022-11-17 15:10:02 +01008486 psa_pake_operation_t *pake_ctx,
8487 unsigned char *buf,
Valerio Setti6b3dab02022-11-17 17:14:54 +01008488 size_t len, size_t *olen,
8489 mbedtls_ecjpake_rounds_t round )
Valerio Settia08b1a42022-11-17 15:10:02 +01008490{
8491 psa_status_t status;
8492 size_t output_offset = 0;
8493 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008494 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008495 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8496 * At round two perform a single cycle
8497 */
8498 unsigned int remaining_steps = ( round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008499
Valerio Setti6b3dab02022-11-17 17:14:54 +01008500 for( ; remaining_steps > 0; remaining_steps-- )
Valerio Settia08b1a42022-11-17 15:10:02 +01008501 {
Valerio Setti6b3dab02022-11-17 17:14:54 +01008502 for( psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8503 step <= PSA_PAKE_STEP_ZK_PROOF;
Valerio Settia08b1a42022-11-17 15:10:02 +01008504 ++step )
8505 {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008506 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008507 * For each step, prepend 1 byte with the length of the data as
8508 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008509 */
Valerio Settia08b1a42022-11-17 15:10:02 +01008510 status = psa_pake_output( pake_ctx, step,
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008511 buf + output_offset + 1,
8512 len - output_offset - 1,
Valerio Settia08b1a42022-11-17 15:10:02 +01008513 &output_len );
8514 if( status != PSA_SUCCESS )
8515 {
8516 return( psa_ssl_status_to_mbedtls( status ) );
8517 }
8518
Valerio Setti99d88c12022-11-22 16:03:43 +01008519 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008520
8521 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008522 }
8523 }
8524
8525 *olen = output_offset;
8526
8527 return( 0 );
8528}
Valerio Settia08b1a42022-11-17 15:10:02 +01008529#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8530
Jerry Yuee40f9d2022-02-17 14:55:16 +08008531#if defined(MBEDTLS_USE_PSA_CRYPTO)
8532int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
8533 unsigned char *hash, size_t *hashlen,
8534 unsigned char *data, size_t data_len,
8535 mbedtls_md_type_t md_alg )
8536{
8537 psa_status_t status;
8538 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008539 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08008540
8541 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
8542
8543 if( ( status = psa_hash_setup( &hash_operation,
8544 hash_alg ) ) != PSA_SUCCESS )
8545 {
8546 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
8547 goto exit;
8548 }
8549
8550 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
8551 64 ) ) != PSA_SUCCESS )
8552 {
8553 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
8554 goto exit;
8555 }
8556
8557 if( ( status = psa_hash_update( &hash_operation,
8558 data, data_len ) ) != PSA_SUCCESS )
8559 {
8560 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
8561 goto exit;
8562 }
8563
8564 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
8565 hashlen ) ) != PSA_SUCCESS )
8566 {
8567 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
8568 goto exit;
8569 }
8570
8571exit:
8572 if( status != PSA_SUCCESS )
8573 {
8574 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8575 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
8576 switch( status )
8577 {
8578 case PSA_ERROR_NOT_SUPPORTED:
8579 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
8580 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8581 case PSA_ERROR_BUFFER_TOO_SMALL:
8582 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
8583 case PSA_ERROR_INSUFFICIENT_MEMORY:
8584 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
8585 default:
8586 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
8587 }
8588 }
8589 return( 0 );
8590}
8591
8592#else
8593
8594int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
8595 unsigned char *hash, size_t *hashlen,
8596 unsigned char *data, size_t data_len,
8597 mbedtls_md_type_t md_alg )
8598{
8599 int ret = 0;
8600 mbedtls_md_context_t ctx;
8601 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
8602 *hashlen = mbedtls_md_get_size( md_info );
8603
8604 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
8605
8606 mbedtls_md_init( &ctx );
8607
8608 /*
8609 * digitally-signed struct {
8610 * opaque client_random[32];
8611 * opaque server_random[32];
8612 * ServerDHParams params;
8613 * };
8614 */
8615 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
8616 {
8617 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
8618 goto exit;
8619 }
8620 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
8621 {
8622 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
8623 goto exit;
8624 }
8625 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
8626 {
8627 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
8628 goto exit;
8629 }
8630 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
8631 {
8632 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
8633 goto exit;
8634 }
8635 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
8636 {
8637 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
8638 goto exit;
8639 }
8640
8641exit:
8642 mbedtls_md_free( &ctx );
8643
8644 if( ret != 0 )
8645 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8646 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
8647
8648 return( ret );
8649}
8650#endif /* MBEDTLS_USE_PSA_CRYPTO */
8651
Jerry Yud9d91da2022-02-17 14:57:06 +08008652#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8653
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008654/* Find the preferred hash for a given signature algorithm. */
8655unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
8656 mbedtls_ssl_context *ssl,
8657 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08008658{
Gabor Mezei078e8032022-04-27 21:17:56 +02008659 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008660 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008661
8662 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008663 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02008664
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008665 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08008666 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008667 unsigned int hash_alg_received =
8668 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8669 received_sig_algs[i] );
8670 unsigned int sig_alg_received =
8671 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8672 received_sig_algs[i] );
8673
8674 if( sig_alg == sig_alg_received )
8675 {
8676#if defined(MBEDTLS_USE_PSA_CRYPTO)
8677 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8678 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008679 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008680 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008681
Neil Armstrong96eceb82022-06-30 18:05:05 +02008682 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8683 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8684 PSA_ALG_ECDSA( psa_hash_alg ),
8685 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008686 continue;
8687
Neil Armstrong96eceb82022-06-30 18:05:05 +02008688 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008689 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8690 PSA_ALG_RSA_PKCS1V15_SIGN(
8691 psa_hash_alg ),
8692 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008693 continue;
8694 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008695#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008696
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008697 return( hash_alg_received );
8698 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008699 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008700
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008701 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008702}
8703
8704#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8705
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008706/* Serialization of TLS 1.2 sessions:
8707 *
8708 * struct {
8709 * uint64 start_time;
8710 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008711 * uint8 session_id_len; // at most 32
8712 * opaque session_id[32];
8713 * opaque master[48]; // fixed length in the standard
8714 * uint32 verify_result;
8715 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8716 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8717 * uint32 ticket_lifetime;
8718 * uint8 mfl_code; // up to 255 according to standard
8719 * uint8 encrypt_then_mac; // 0 or 1
8720 * } serialized_session_tls12;
8721 *
8722 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008723static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008724 unsigned char *buf,
8725 size_t buf_len )
8726{
8727 unsigned char *p = buf;
8728 size_t used = 0;
8729
8730#if defined(MBEDTLS_HAVE_TIME)
8731 uint64_t start;
8732#endif
8733#if defined(MBEDTLS_X509_CRT_PARSE_C)
8734#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8735 size_t cert_len;
8736#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8737#endif /* MBEDTLS_X509_CRT_PARSE_C */
8738
8739 /*
8740 * Time
8741 */
8742#if defined(MBEDTLS_HAVE_TIME)
8743 used += 8;
8744
8745 if( used <= buf_len )
8746 {
8747 start = (uint64_t) session->start;
8748
8749 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8750 p += 8;
8751 }
8752#endif /* MBEDTLS_HAVE_TIME */
8753
8754 /*
8755 * Basic mandatory fields
8756 */
8757 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008758 + 1 /* id_len */
8759 + sizeof( session->id )
8760 + sizeof( session->master )
8761 + 4; /* verify_result */
8762
8763 if( used <= buf_len )
8764 {
8765 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8766 p += 2;
8767
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008768 *p++ = MBEDTLS_BYTE_0( session->id_len );
8769 memcpy( p, session->id, 32 );
8770 p += 32;
8771
8772 memcpy( p, session->master, 48 );
8773 p += 48;
8774
8775 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8776 p += 4;
8777 }
8778
8779 /*
8780 * Peer's end-entity certificate
8781 */
8782#if defined(MBEDTLS_X509_CRT_PARSE_C)
8783#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8784 if( session->peer_cert == NULL )
8785 cert_len = 0;
8786 else
8787 cert_len = session->peer_cert->raw.len;
8788
8789 used += 3 + cert_len;
8790
8791 if( used <= buf_len )
8792 {
8793 *p++ = MBEDTLS_BYTE_2( cert_len );
8794 *p++ = MBEDTLS_BYTE_1( cert_len );
8795 *p++ = MBEDTLS_BYTE_0( cert_len );
8796
8797 if( session->peer_cert != NULL )
8798 {
8799 memcpy( p, session->peer_cert->raw.p, cert_len );
8800 p += cert_len;
8801 }
8802 }
8803#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8804 if( session->peer_cert_digest != NULL )
8805 {
8806 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8807 if( used <= buf_len )
8808 {
8809 *p++ = (unsigned char) session->peer_cert_digest_type;
8810 *p++ = (unsigned char) session->peer_cert_digest_len;
8811 memcpy( p, session->peer_cert_digest,
8812 session->peer_cert_digest_len );
8813 p += session->peer_cert_digest_len;
8814 }
8815 }
8816 else
8817 {
8818 used += 2;
8819 if( used <= buf_len )
8820 {
8821 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8822 *p++ = 0;
8823 }
8824 }
8825#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8826#endif /* MBEDTLS_X509_CRT_PARSE_C */
8827
8828 /*
8829 * Session ticket if any, plus associated data
8830 */
8831#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8832 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8833
8834 if( used <= buf_len )
8835 {
8836 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8837 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8838 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8839
8840 if( session->ticket != NULL )
8841 {
8842 memcpy( p, session->ticket, session->ticket_len );
8843 p += session->ticket_len;
8844 }
8845
8846 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8847 p += 4;
8848 }
8849#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8850
8851 /*
8852 * Misc extension-related info
8853 */
8854#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8855 used += 1;
8856
8857 if( used <= buf_len )
8858 *p++ = session->mfl_code;
8859#endif
8860
8861#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8862 used += 1;
8863
8864 if( used <= buf_len )
8865 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8866#endif
8867
8868 return( used );
8869}
8870
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008871MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008872static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008873 const unsigned char *buf,
8874 size_t len )
8875{
8876#if defined(MBEDTLS_HAVE_TIME)
8877 uint64_t start;
8878#endif
8879#if defined(MBEDTLS_X509_CRT_PARSE_C)
8880#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8881 size_t cert_len;
8882#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8883#endif /* MBEDTLS_X509_CRT_PARSE_C */
8884
8885 const unsigned char *p = buf;
8886 const unsigned char * const end = buf + len;
8887
8888 /*
8889 * Time
8890 */
8891#if defined(MBEDTLS_HAVE_TIME)
8892 if( 8 > (size_t)( end - p ) )
8893 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8894
8895 start = ( (uint64_t) p[0] << 56 ) |
8896 ( (uint64_t) p[1] << 48 ) |
8897 ( (uint64_t) p[2] << 40 ) |
8898 ( (uint64_t) p[3] << 32 ) |
8899 ( (uint64_t) p[4] << 24 ) |
8900 ( (uint64_t) p[5] << 16 ) |
8901 ( (uint64_t) p[6] << 8 ) |
8902 ( (uint64_t) p[7] );
8903 p += 8;
8904
8905 session->start = (time_t) start;
8906#endif /* MBEDTLS_HAVE_TIME */
8907
8908 /*
8909 * Basic mandatory fields
8910 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008911 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008912 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8913
8914 session->ciphersuite = ( p[0] << 8 ) | p[1];
8915 p += 2;
8916
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008917 session->id_len = *p++;
8918 memcpy( session->id, p, 32 );
8919 p += 32;
8920
8921 memcpy( session->master, p, 48 );
8922 p += 48;
8923
8924 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8925 ( (uint32_t) p[1] << 16 ) |
8926 ( (uint32_t) p[2] << 8 ) |
8927 ( (uint32_t) p[3] );
8928 p += 4;
8929
8930 /* Immediately clear invalid pointer values that have been read, in case
8931 * we exit early before we replaced them with valid ones. */
8932#if defined(MBEDTLS_X509_CRT_PARSE_C)
8933#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8934 session->peer_cert = NULL;
8935#else
8936 session->peer_cert_digest = NULL;
8937#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8938#endif /* MBEDTLS_X509_CRT_PARSE_C */
8939#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8940 session->ticket = NULL;
8941#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8942
8943 /*
8944 * Peer certificate
8945 */
8946#if defined(MBEDTLS_X509_CRT_PARSE_C)
8947#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8948 /* Deserialize CRT from the end of the ticket. */
8949 if( 3 > (size_t)( end - p ) )
8950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8951
8952 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8953 p += 3;
8954
8955 if( cert_len != 0 )
8956 {
8957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8958
8959 if( cert_len > (size_t)( end - p ) )
8960 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8961
8962 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8963
8964 if( session->peer_cert == NULL )
8965 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8966
8967 mbedtls_x509_crt_init( session->peer_cert );
8968
8969 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8970 p, cert_len ) ) != 0 )
8971 {
8972 mbedtls_x509_crt_free( session->peer_cert );
8973 mbedtls_free( session->peer_cert );
8974 session->peer_cert = NULL;
8975 return( ret );
8976 }
8977
8978 p += cert_len;
8979 }
8980#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8981 /* Deserialize CRT digest from the end of the ticket. */
8982 if( 2 > (size_t)( end - p ) )
8983 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8984
8985 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8986 session->peer_cert_digest_len = (size_t) *p++;
8987
8988 if( session->peer_cert_digest_len != 0 )
8989 {
8990 const mbedtls_md_info_t *md_info =
8991 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8992 if( md_info == NULL )
8993 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8994 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8995 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8996
8997 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8998 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8999
9000 session->peer_cert_digest =
9001 mbedtls_calloc( 1, session->peer_cert_digest_len );
9002 if( session->peer_cert_digest == NULL )
9003 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9004
9005 memcpy( session->peer_cert_digest, p,
9006 session->peer_cert_digest_len );
9007 p += session->peer_cert_digest_len;
9008 }
9009#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9010#endif /* MBEDTLS_X509_CRT_PARSE_C */
9011
9012 /*
9013 * Session ticket and associated data
9014 */
9015#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9016 if( 3 > (size_t)( end - p ) )
9017 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9018
9019 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
9020 p += 3;
9021
9022 if( session->ticket_len != 0 )
9023 {
9024 if( session->ticket_len > (size_t)( end - p ) )
9025 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9026
9027 session->ticket = mbedtls_calloc( 1, session->ticket_len );
9028 if( session->ticket == NULL )
9029 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9030
9031 memcpy( session->ticket, p, session->ticket_len );
9032 p += session->ticket_len;
9033 }
9034
9035 if( 4 > (size_t)( end - p ) )
9036 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9037
9038 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
9039 ( (uint32_t) p[1] << 16 ) |
9040 ( (uint32_t) p[2] << 8 ) |
9041 ( (uint32_t) p[3] );
9042 p += 4;
9043#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9044
9045 /*
9046 * Misc extension-related info
9047 */
9048#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9049 if( 1 > (size_t)( end - p ) )
9050 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9051
9052 session->mfl_code = *p++;
9053#endif
9054
9055#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9056 if( 1 > (size_t)( end - p ) )
9057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9058
9059 session->encrypt_then_mac = *p++;
9060#endif
9061
9062 /* Done, should have consumed entire buffer */
9063 if( p != end )
9064 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9065
9066 return( 0 );
9067}
Jerry Yudc7bd172022-02-17 13:44:15 +08009068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9069
XiaokangQian75d40ef2022-04-20 11:05:24 +00009070int mbedtls_ssl_validate_ciphersuite(
9071 const mbedtls_ssl_context *ssl,
9072 const mbedtls_ssl_ciphersuite_t *suite_info,
9073 mbedtls_ssl_protocol_version min_tls_version,
9074 mbedtls_ssl_protocol_version max_tls_version )
9075{
9076 (void) ssl;
9077
9078 if( suite_info == NULL )
9079 return( -1 );
9080
9081 if( ( suite_info->min_tls_version > max_tls_version ) ||
9082 ( suite_info->max_tls_version < min_tls_version ) )
9083 {
9084 return( -1 );
9085 }
9086
XiaokangQian060d8672022-04-21 09:24:56 +00009087#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009088#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009089#if defined(MBEDTLS_USE_PSA_CRYPTO)
9090 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9091 ssl->handshake->psa_pake_ctx_is_ok != 1 )
9092#else
XiaokangQian75d40ef2022-04-20 11:05:24 +00009093 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9094 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
Neil Armstrongca7d5062022-05-31 14:43:23 +02009095#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009096 {
9097 return( -1 );
9098 }
9099#endif
9100
9101 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9102#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
9103 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
9104 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
9105 {
9106 return( -1 );
9107 }
9108#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9109#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9110
9111 return( 0 );
9112}
9113
Ronald Crone68ab4f2022-10-05 12:46:29 +02009114#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009115/*
9116 * Function for writing a signature algorithm extension.
9117 *
9118 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9119 * value (TLS 1.3 RFC8446):
9120 * enum {
9121 * ....
9122 * ecdsa_secp256r1_sha256( 0x0403 ),
9123 * ecdsa_secp384r1_sha384( 0x0503 ),
9124 * ecdsa_secp521r1_sha512( 0x0603 ),
9125 * ....
9126 * } SignatureScheme;
9127 *
9128 * struct {
9129 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9130 * } SignatureSchemeList;
9131 *
9132 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9133 * value (TLS 1.2 RFC5246):
9134 * enum {
9135 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9136 * sha512(6), (255)
9137 * } HashAlgorithm;
9138 *
9139 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9140 * SignatureAlgorithm;
9141 *
9142 * struct {
9143 * HashAlgorithm hash;
9144 * SignatureAlgorithm signature;
9145 * } SignatureAndHashAlgorithm;
9146 *
9147 * SignatureAndHashAlgorithm
9148 * supported_signature_algorithms<2..2^16-2>;
9149 *
9150 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9151 * generalization of the TLS 1.2 signature algorithm extension.
9152 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9153 * `SignatureScheme` field of TLS 1.3
9154 *
9155 */
9156int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
9157 const unsigned char *end, size_t *out_len )
9158{
9159 unsigned char *p = buf;
9160 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9161 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9162
9163 *out_len = 0;
9164
9165 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
9166
9167 /* Check if we have space for header and length field:
9168 * - extension_type (2 bytes)
9169 * - extension_data_length (2 bytes)
9170 * - supported_signature_algorithms_length (2 bytes)
9171 */
9172 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
9173 p += 6;
9174
9175 /*
9176 * Write supported_signature_algorithms
9177 */
9178 supported_sig_alg = p;
9179 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
9180 if( sig_alg == NULL )
9181 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
9182
9183 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
9184 {
Jerry Yu53f5c152022-06-22 20:24:38 +08009185 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
9186 *sig_alg,
9187 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00009188 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
9189 continue;
9190 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
9191 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
9192 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08009193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08009194 *sig_alg,
9195 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00009196 }
9197
9198 /* Length of supported_signature_algorithms */
9199 supported_sig_alg_len = p - supported_sig_alg;
9200 if( supported_sig_alg_len == 0 )
9201 {
9202 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
9203 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
9204 }
9205
XiaokangQianeaf36512022-04-24 09:07:44 +00009206 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00009207 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00009208 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
9209
XiaokangQianeaf36512022-04-24 09:07:44 +00009210 *out_len = p - buf;
9211
9212#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuc4bf5d62022-10-29 09:08:47 +08009213 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_SIG_ALG );
XiaokangQianeaf36512022-04-24 09:07:44 +00009214#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009215
XiaokangQianeaf36512022-04-24 09:07:44 +00009216 return( 0 );
9217}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009218#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009219
XiaokangQian40a35232022-05-07 09:02:40 +00009220#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009221/*
9222 * mbedtls_ssl_parse_server_name_ext
9223 *
9224 * Structure of server_name extension:
9225 *
9226 * enum {
9227 * host_name(0), (255)
9228 * } NameType;
9229 * opaque HostName<1..2^16-1>;
9230 *
9231 * struct {
9232 * NameType name_type;
9233 * select (name_type) {
9234 * case host_name: HostName;
9235 * } name;
9236 * } ServerName;
9237 * struct {
9238 * ServerName server_name_list<1..2^16-1>
9239 * } ServerNameList;
9240 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009241MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00009242int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
9243 const unsigned char *buf,
9244 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00009245{
9246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9247 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009248 size_t server_name_list_len, hostname_len;
9249 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009250
XiaokangQianf2a94202022-05-20 06:44:24 +00009251 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00009252
9253 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00009254 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00009255 p += 2;
9256
XiaokangQian9b2b7712022-05-17 02:57:00 +00009257 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
9258 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00009259 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00009260 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00009261 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00009262 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00009263 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
9264 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00009265
9266 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
9267 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009268 /* sni_name is intended to be used only during the parsing of the
9269 * ClientHello message (it is reset to NULL before the end of
9270 * the message parsing). Thus it is ok to just point to the
9271 * reception buffer and not make a copy of it.
9272 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009273 ssl->handshake->sni_name = p + 3;
9274 ssl->handshake->sni_name_len = hostname_len;
9275 if( ssl->conf->f_sni == NULL )
9276 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00009277 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00009278 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00009279 if( ret != 0 )
9280 {
XiaokangQianf2a94202022-05-20 06:44:24 +00009281 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00009282 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9283 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00009284 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
9285 }
9286 return( 0 );
9287 }
9288
9289 p += hostname_len + 3;
9290 }
9291
9292 return( 0 );
9293}
9294#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9295
XiaokangQianacb39922022-06-17 10:18:48 +00009296#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009297MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00009298int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
9299 const unsigned char *buf,
9300 const unsigned char *end )
9301{
9302 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009303 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009304 const unsigned char *protocol_name_list;
9305 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009306 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009307
9308 /* If ALPN not configured, just ignore the extension */
9309 if( ssl->conf->alpn_list == NULL )
9310 return( 0 );
9311
9312 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009313 * RFC7301, section 3.1
9314 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009315 *
XiaokangQianc7403452022-06-23 03:24:12 +00009316 * struct {
9317 * ProtocolName protocol_name_list<2..2^16-1>
9318 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009319 */
9320
XiaokangQianc7403452022-06-23 03:24:12 +00009321 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009322 * protocol_name_list_len 2 bytes
9323 * protocol_name_len 1 bytes
9324 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009325 */
XiaokangQianacb39922022-06-17 10:18:48 +00009326 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
9327
XiaokangQianc7403452022-06-23 03:24:12 +00009328 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00009329 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00009330 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00009331 protocol_name_list = p;
9332 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009333
9334 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00009335 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00009336 {
XiaokangQian95d5f542022-06-24 02:29:26 +00009337 protocol_name_len = *p++;
9338 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
9339 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00009340 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00009341 {
9342 MBEDTLS_SSL_PEND_FATAL_ALERT(
9343 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
9344 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00009345 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00009346 }
9347
9348 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009349 }
9350
9351 /* Use our order of preference */
9352 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
9353 {
9354 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00009355 p = protocol_name_list;
9356 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00009357 {
XiaokangQian95d5f542022-06-24 02:29:26 +00009358 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00009359 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00009360 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00009361 {
9362 ssl->alpn_chosen = *alpn;
9363 return( 0 );
9364 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009365
9366 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009367 }
9368 }
9369
XiaokangQian95d5f542022-06-24 02:29:26 +00009370 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009371 MBEDTLS_SSL_PEND_FATAL_ALERT(
9372 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9373 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
9374 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
9375}
9376
9377int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
9378 unsigned char *buf,
9379 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00009380 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00009381{
9382 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009383 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009384 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009385
9386 if( ssl->alpn_chosen == NULL )
9387 {
9388 return( 0 );
9389 }
9390
XiaokangQian95d5f542022-06-24 02:29:26 +00009391 protocol_name_len = strlen( ssl->alpn_chosen );
9392 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00009393
9394 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
9395 /*
9396 * 0 . 1 ext identifier
9397 * 2 . 3 ext length
9398 * 4 . 5 protocol list length
9399 * 6 . 6 protocol name length
9400 * 7 . 7+n protocol name
9401 */
9402 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
9403
XiaokangQian95d5f542022-06-24 02:29:26 +00009404 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009405
XiaokangQian95d5f542022-06-24 02:29:26 +00009406 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
9407 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00009408 /* Note: the length of the chosen protocol has been checked to be less
9409 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9410 */
XiaokangQian95d5f542022-06-24 02:29:26 +00009411 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00009412
XiaokangQian95d5f542022-06-24 02:29:26 +00009413 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
Jerry Yub95dd362022-11-08 21:19:34 +08009414
9415#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
9416 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_ALPN );
9417#endif
9418
XiaokangQianacb39922022-06-17 10:18:48 +00009419 return ( 0 );
9420}
9421#endif /* MBEDTLS_SSL_ALPN */
9422
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009423#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009424 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009425 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009426 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009427int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session,
9428 const char *hostname )
9429{
9430 /* Initialize to suppress unnecessary compiler warning */
9431 size_t hostname_len = 0;
9432
9433 /* Check if new hostname is valid before
9434 * making any change to current one */
9435 if( hostname != NULL )
9436 {
9437 hostname_len = strlen( hostname );
9438
9439 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
9440 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9441 }
9442
9443 /* Now it's clear that we will overwrite the old hostname,
9444 * so we can free it safely */
9445 if( session->hostname != NULL )
9446 {
9447 mbedtls_platform_zeroize( session->hostname,
9448 strlen( session->hostname ) );
9449 mbedtls_free( session->hostname );
9450 }
9451
9452 /* Passing NULL as hostname shall clear the old one */
9453 if( hostname == NULL )
9454 {
9455 session->hostname = NULL;
9456 }
9457 else
9458 {
9459 session->hostname = mbedtls_calloc( 1, hostname_len + 1 );
9460 if( session->hostname == NULL )
9461 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9462
9463 memcpy( session->hostname, hostname, hostname_len );
9464 }
9465
9466 return( 0 );
9467}
Xiaokang Qian03409292022-10-12 02:49:52 +00009468#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9469 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009470 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009471 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009473#endif /* MBEDTLS_SSL_TLS_C */