blob: eba5e3ba982e7fb98da0b9319e018181f5bcac33 [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 */
Jerry Yu2e199812022-12-01 18:57:19 +0800968#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +0000969 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Jerry Yu2e199812022-12-01 18:57:19 +0800971#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200972 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200975 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976
Jerry Yu2e199812022-12-01 18:57:19 +0800977#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978 /*
979 * Either the pointers are now NULL or cleared properly and can be freed.
980 * Now allocate missing structures.
981 */
982 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200983 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200984 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Jerry Yu2e199812022-12-01 18:57:19 +0800986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000987
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200989 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200990 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200991 }
Paul Bakker48916f92012-09-16 19:57:18 +0000992
Paul Bakker82788fb2014-10-20 13:59:19 +0200993 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200994 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200995 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200996 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500997#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
998 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400999
Andrzej Kurek4a063792020-10-21 15:08:44 +02001000 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1001 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001002#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001003
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001004 /* All pointers should exist and can be directly freed without issue */
Jerry Yu2e199812022-12-01 18:57:19 +08001005 if( ssl->handshake == NULL ||
1006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001007 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001008#endif
1009 ssl->session_negotiate == NULL )
Paul Bakker48916f92012-09-16 19:57:18 +00001010 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02001011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 mbedtls_free( ssl->handshake );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001014 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001015
1016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1017 mbedtls_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001019#endif
1020
1021 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001022 ssl->session_negotiate = NULL;
1023
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001024 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +00001025 }
1026
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001027 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 mbedtls_ssl_session_init( ssl->session_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +02001029 ssl_handshake_params_init( ssl->handshake );
1030
Jerry Yu2e199812022-12-01 18:57:19 +08001031#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1032 mbedtls_ssl_transform_init( ssl->transform_negotiate );
1033#endif
1034
Jerry Yud0766ec2022-09-22 10:46:57 +08001035#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1036 defined(MBEDTLS_SSL_SRV_C) && \
1037 defined(MBEDTLS_SSL_SESSION_TICKETS)
1038 ssl->handshake->new_session_tickets_count =
1039 ssl->conf->new_session_tickets_count ;
1040#endif
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001043 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1044 {
1045 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001046
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001047 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
1048 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
1049 else
1050 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001051
Hanno Becker0f57a652020-02-05 10:37:26 +00001052 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001053 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001054#endif
1055
Brett Warrene0edc842021-08-17 09:53:13 +01001056/*
1057 * curve_list is translated to IANA TLS group identifiers here because
1058 * mbedtls_ssl_conf_curves returns void and so can't return
1059 * any error codes.
1060 */
1061#if defined(MBEDTLS_ECP_C)
1062#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1063 /* Heap allocate and translate curve_list from internal to IANA group ids */
1064 if ( ssl->conf->curve_list != NULL )
1065 {
1066 size_t length;
1067 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1068
1069 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
1070 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
1071
1072 /* Leave room for zero termination */
1073 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
1074 if ( group_list == NULL )
1075 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1076
1077 for( size_t i = 0; i < length; i++ )
1078 {
1079 const mbedtls_ecp_curve_info *info =
1080 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
1081 if ( info == NULL )
1082 {
1083 mbedtls_free( group_list );
1084 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1085 }
1086 group_list[i] = info->tls_id;
1087 }
1088
1089 group_list[length] = 0;
1090
1091 ssl->handshake->group_list = group_list;
1092 ssl->handshake->group_list_heap_allocated = 1;
1093 }
1094 else
1095 {
1096 ssl->handshake->group_list = ssl->conf->group_list;
1097 ssl->handshake->group_list_heap_allocated = 0;
1098 }
1099#endif /* MBEDTLS_DEPRECATED_REMOVED */
1100#endif /* MBEDTLS_ECP_C */
1101
Ronald Crone68ab4f2022-10-05 12:46:29 +02001102#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001103#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001105 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1106 signature algorithms IANA identifiers. */
1107 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +08001108 ssl->conf->sig_hashes != NULL )
1109 {
1110 const int *md;
1111 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001112 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001113 uint16_t *p;
1114
Jerry Yub476a442022-01-21 18:14:45 +08001115#if defined(static_assert)
1116 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1117 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
1118 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +08001119#endif
1120
Jerry Yuf017ee42022-01-12 15:49:48 +08001121 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1122 {
1123 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
1124 continue;
Jerry Yub476a442022-01-21 18:14:45 +08001125#if defined(MBEDTLS_ECDSA_C)
1126 sig_algs_len += sizeof( uint16_t );
1127#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001128
Jerry Yub476a442022-01-21 18:14:45 +08001129#if defined(MBEDTLS_RSA_C)
1130 sig_algs_len += sizeof( uint16_t );
1131#endif
1132 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
1133 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +08001134 }
1135
Jerry Yub476a442022-01-21 18:14:45 +08001136 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +08001137 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1138
Jerry Yub476a442022-01-21 18:14:45 +08001139 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
1140 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +08001141 if( ssl->handshake->sig_algs == NULL )
1142 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1143
1144 p = (uint16_t *)ssl->handshake->sig_algs;
1145 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
1146 {
1147 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
1148 if( hash == MBEDTLS_SSL_HASH_NONE )
1149 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001150#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001151 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
1152 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001153#endif
1154#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +08001155 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
1156 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001157#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001158 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001159 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001160 ssl->handshake->sig_algs_heap_allocated = 1;
1161 }
1162 else
Jerry Yua69269a2022-01-17 21:06:01 +08001163#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001164 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001165 ssl->handshake->sig_algs_heap_allocated = 0;
1166 }
Jerry Yucc539102022-06-27 16:27:35 +08001167#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001168#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +00001169 return( 0 );
1170}
1171
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001172#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001173/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001174MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001175static int ssl_cookie_write_dummy( void *ctx,
1176 unsigned char **p, unsigned char *end,
1177 const unsigned char *cli_id, size_t cli_id_len )
1178{
1179 ((void) ctx);
1180 ((void) p);
1181 ((void) end);
1182 ((void) cli_id);
1183 ((void) cli_id_len);
1184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001186}
1187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001188MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001189static int ssl_cookie_check_dummy( void *ctx,
1190 const unsigned char *cookie, size_t cookie_len,
1191 const unsigned char *cli_id, size_t cli_id_len )
1192{
1193 ((void) ctx);
1194 ((void) cookie);
1195 ((void) cookie_len);
1196 ((void) cli_id);
1197 ((void) cli_id_len);
1198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001200}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001201#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001202
Paul Bakker5121ce52009-01-03 21:22:43 +00001203/*
1204 * Initialize an SSL context
1205 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001206void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
1207{
1208 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
1209}
1210
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001211MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001212static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
1213{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001214 const mbedtls_ssl_config *conf = ssl->conf;
1215
Ronald Cron6f135e12021-12-08 16:57:54 +01001216#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001217 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
1218 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001219 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1220 {
1221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
1222 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1223 }
1224
Jerry Yu60835a82021-08-04 10:13:52 +08001225 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
1226 return( 0 );
1227 }
1228#endif
1229
1230#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001231 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +08001232 {
1233 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
1234 return( 0 );
1235 }
1236#endif
1237
Ronald Cron6f135e12021-12-08 16:57:54 +01001238#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +01001239 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +08001240 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001241 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1242 {
1243 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
1244 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1245 }
1246
XiaokangQian8f9dfe42022-04-15 02:52:39 +00001247 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1248 {
1249 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
1250 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1251 }
1252
1253
Ronald Crone1d3f062022-02-10 14:50:54 +01001254 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
1255 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +08001256 }
1257#endif
1258
1259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
1260 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001264static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1265{
1266 int ret;
1267 ret = ssl_conf_version_check( ssl );
1268 if( ret != 0 )
1269 return( ret );
1270
Jerry Yudef7ae42022-10-30 14:13:19 +08001271#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1272 /* RFC 8446 section 4.4.3
1273 *
1274 * If the verification fails, the receiver MUST terminate the handshake with
1275 * a "decrypt_error" alert.
1276 *
1277 * If the client is configured as TLS 1.3 only with optional verify, return
1278 * bad config.
1279 *
1280 */
1281 if( mbedtls_ssl_conf_tls13_ephemeral_enabled(
1282 (mbedtls_ssl_context *)ssl ) &&
1283 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1284 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1285 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1286 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL )
1287 {
1288 MBEDTLS_SSL_DEBUG_MSG(
Dave Rodgmane8734d82022-10-31 14:30:24 +00001289 1, ( "Optional verify auth mode "
Jerry Yudef7ae42022-10-30 14:13:19 +08001290 "is not available for TLS 1.3 client" ) );
1291 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
1292 }
1293#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1294
Jerry Yu60835a82021-08-04 10:13:52 +08001295 /* Space for further checks */
1296
1297 return( 0 );
1298}
1299
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001300/*
1301 * Setup an SSL context
1302 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001303
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001304int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001305 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001306{
Janos Follath865b3eb2019-12-16 11:46:15 +00001307 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001308 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1309 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001310
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001311 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001312
Jerry Yu60835a82021-08-04 10:13:52 +08001313 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1314 return( ret );
1315
Paul Bakker62f2dee2012-09-28 07:31:51 +00001316 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001317 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001318 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001319
1320 /* Set to NULL in case of an error condition */
1321 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001322
Darryl Greenb33cc762019-11-28 14:29:44 +00001323#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1324 ssl->in_buf_len = in_buf_len;
1325#endif
1326 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001327 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001328 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001330 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001331 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001332 }
1333
Darryl Greenb33cc762019-11-28 14:29:44 +00001334#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1335 ssl->out_buf_len = out_buf_len;
1336#endif
1337 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001338 if( ssl->out_buf == NULL )
1339 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001341 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001342 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001343 }
1344
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001345 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001346
Johan Pascalb62bb512015-12-03 21:56:45 +01001347#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001348 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001349#endif
1350
Paul Bakker48916f92012-09-16 19:57:18 +00001351 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001352 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001353
1354 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001355
1356error:
1357 mbedtls_free( ssl->in_buf );
1358 mbedtls_free( ssl->out_buf );
1359
1360 ssl->conf = NULL;
1361
Darryl Greenb33cc762019-11-28 14:29:44 +00001362#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1363 ssl->in_buf_len = 0;
1364 ssl->out_buf_len = 0;
1365#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001366 ssl->in_buf = NULL;
1367 ssl->out_buf = NULL;
1368
1369 ssl->in_hdr = NULL;
1370 ssl->in_ctr = NULL;
1371 ssl->in_len = NULL;
1372 ssl->in_iv = NULL;
1373 ssl->in_msg = NULL;
1374
1375 ssl->out_hdr = NULL;
1376 ssl->out_ctr = NULL;
1377 ssl->out_len = NULL;
1378 ssl->out_iv = NULL;
1379 ssl->out_msg = NULL;
1380
k-stachowiak9f7798e2018-07-31 16:52:32 +02001381 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001382}
1383
1384/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001385 * Reset an initialized and used SSL context for re-use while retaining
1386 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001387 *
1388 * If partial is non-zero, keep data in the input buffer and client ID.
1389 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001390 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001391void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1392 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001393{
Darryl Greenb33cc762019-11-28 14:29:44 +00001394#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1395 size_t in_buf_len = ssl->in_buf_len;
1396 size_t out_buf_len = ssl->out_buf_len;
1397#else
1398 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1399 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1400#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001401
Hanno Beckerb0302c42021-08-03 09:39:42 +01001402#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1403 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001404#endif
1405
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001406 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001407 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001408
Hanno Beckerb0302c42021-08-03 09:39:42 +01001409 mbedtls_ssl_reset_in_out_pointers( ssl );
1410
1411 /* Reset incoming message parsing */
1412 ssl->in_offt = NULL;
1413 ssl->nb_zero = 0;
1414 ssl->in_msgtype = 0;
1415 ssl->in_msglen = 0;
1416 ssl->in_hslen = 0;
1417 ssl->keep_current_message = 0;
1418 ssl->transform_in = NULL;
1419
1420#if defined(MBEDTLS_SSL_PROTO_DTLS)
1421 ssl->next_record_offset = 0;
1422 ssl->in_epoch = 0;
1423#endif
1424
1425 /* Keep current datagram if partial == 1 */
1426 if( partial == 0 )
1427 {
1428 ssl->in_left = 0;
1429 memset( ssl->in_buf, 0, in_buf_len );
1430 }
1431
Ronald Cronad8c17b2022-06-10 17:18:09 +02001432 ssl->send_alert = 0;
1433
Hanno Beckerb0302c42021-08-03 09:39:42 +01001434 /* Reset outgoing message writing */
1435 ssl->out_msgtype = 0;
1436 ssl->out_msglen = 0;
1437 ssl->out_left = 0;
1438 memset( ssl->out_buf, 0, out_buf_len );
1439 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1440 ssl->transform_out = NULL;
1441
1442#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1443 mbedtls_ssl_dtls_replay_reset( ssl );
1444#endif
1445
XiaokangQian2b01dc32022-01-21 02:53:13 +00001446#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001447 if( ssl->transform )
1448 {
1449 mbedtls_ssl_transform_free( ssl->transform );
1450 mbedtls_free( ssl->transform );
1451 ssl->transform = NULL;
1452 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1454
XiaokangQian2b01dc32022-01-21 02:53:13 +00001455#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1456 mbedtls_ssl_transform_free( ssl->transform_application );
1457 mbedtls_free( ssl->transform_application );
1458 ssl->transform_application = NULL;
1459
1460 if( ssl->handshake != NULL )
1461 {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001462#if defined(MBEDTLS_SSL_EARLY_DATA)
XiaokangQian2b01dc32022-01-21 02:53:13 +00001463 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1464 mbedtls_free( ssl->handshake->transform_earlydata );
1465 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001466#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001467
1468 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1469 mbedtls_free( ssl->handshake->transform_handshake );
1470 ssl->handshake->transform_handshake = NULL;
1471 }
1472
XiaokangQian2b01dc32022-01-21 02:53:13 +00001473#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474}
1475
1476int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1477{
1478 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1479
1480 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1481
XiaokangQian78b1fa72022-01-19 06:56:30 +00001482 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001483
1484 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#if defined(MBEDTLS_SSL_RENEGOTIATION)
1486 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001487 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001488
1489 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1491 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001492#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001494
Hanno Beckerb0302c42021-08-03 09:39:42 +01001495 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001496 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001497 if( ssl->session )
1498 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 mbedtls_ssl_session_free( ssl->session );
1500 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001501 ssl->session = NULL;
1502 }
1503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001505 ssl->alpn_chosen = NULL;
1506#endif
1507
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001508#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001509 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001510#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
David Horstmann3b2276a2022-10-06 14:49:08 +01001511 free_cli_id = ( partial == 0 );
Hanno Becker4ccbf062018-08-10 11:20:38 +01001512#endif
David Horstmann3b2276a2022-10-06 14:49:08 +01001513 if( free_cli_id )
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001514 {
1515 mbedtls_free( ssl->cli_id );
1516 ssl->cli_id = NULL;
1517 ssl->cli_id_len = 0;
1518 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001519#endif
1520
Paul Bakker48916f92012-09-16 19:57:18 +00001521 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1522 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001523
1524 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001525}
1526
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001527/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001528 * Reset an initialized and used SSL context for re-use while retaining
1529 * all application-set variables, function pointers and data.
1530 */
1531int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1532{
Hanno Becker43aefe22020-02-05 10:44:56 +00001533 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001534}
1535
1536/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001537 * SSL set accessors
1538 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001539void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001540{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001541 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001542}
1543
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001544void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001545{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001546 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001547}
1548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001550void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001551{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001552 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001553}
1554#endif
1555
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001556void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001557{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001558 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001559}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001562
Hanno Becker1841b0a2018-08-24 11:13:57 +01001563void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1564 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001565{
1566 ssl->disable_datagram_packing = !allow_packing;
1567}
1568
1569void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1570 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001571{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001572 conf->hs_timeout_min = min;
1573 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001574}
1575#endif
1576
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001577void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001578{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001579 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001580}
1581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001583void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001584 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001585 void *p_vrfy )
1586{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001587 conf->f_vrfy = f_vrfy;
1588 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001589}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001591
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001592void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001593 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001594 void *p_rng )
1595{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001596 conf->f_rng = f_rng;
1597 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001598}
1599
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001600void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001601 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 void *p_dbg )
1603{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001604 conf->f_dbg = f_dbg;
1605 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001606}
1607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001609 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001610 mbedtls_ssl_send_t *f_send,
1611 mbedtls_ssl_recv_t *f_recv,
1612 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001613{
1614 ssl->p_bio = p_bio;
1615 ssl->f_send = f_send;
1616 ssl->f_recv = f_recv;
1617 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001618}
1619
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001620#if defined(MBEDTLS_SSL_PROTO_DTLS)
1621void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1622{
1623 ssl->mtu = mtu;
1624}
1625#endif
1626
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001627void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001628{
1629 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001630}
1631
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001632void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1633 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001634 mbedtls_ssl_set_timer_t *f_set_timer,
1635 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001636{
1637 ssl->p_timer = p_timer;
1638 ssl->f_set_timer = f_set_timer;
1639 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001640
1641 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001642 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001643}
1644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001646void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001647 void *p_cache,
1648 mbedtls_ssl_cache_get_t *f_get_cache,
1649 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001651 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001653 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#if defined(MBEDTLS_SSL_CLI_C)
1658int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001659{
Janos Follath865b3eb2019-12-16 11:46:15 +00001660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001661
1662 if( ssl == NULL ||
1663 session == NULL ||
1664 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001665 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001666 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001668 }
1669
Hanno Beckere810bbc2021-05-14 16:01:05 +01001670 if( ssl->handshake->resume == 1 )
1671 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1672
Jerry Yu21092062022-10-10 21:21:31 +08001673#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1674 if( session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu40afab62022-10-08 10:42:13 +08001675 {
Jerry Yu21092062022-10-10 21:21:31 +08001676 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1677 mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
1678
1679 if( mbedtls_ssl_validate_ciphersuite(
1680 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
1681 MBEDTLS_SSL_VERSION_TLS1_3 ) != 0 )
1682 {
1683 MBEDTLS_SSL_DEBUG_MSG( 4, ( "%d is not a valid TLS 1.3 ciphersuite.",
1684 session->ciphersuite ) );
1685 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1686 }
Jerry Yu40afab62022-10-08 10:42:13 +08001687 }
Jerry Yu21092062022-10-10 21:21:31 +08001688#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001689
Hanno Becker52055ae2019-02-06 14:30:46 +00001690 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1691 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001692 return( ret );
1693
Paul Bakker0a597072012-09-25 21:55:46 +00001694 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001695
1696 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001697}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001700void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1701 const int *ciphersuites )
1702{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001703 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001704}
1705
Ronald Cron6f135e12021-12-08 16:57:54 +01001706#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001707void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001708 const int kex_modes )
1709{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001710 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001711}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001712
1713#if defined(MBEDTLS_SSL_EARLY_DATA)
1714void mbedtls_ssl_tls13_conf_early_data( mbedtls_ssl_config *conf,
Xiaokang Qian72dbfef2022-10-26 06:33:57 +00001715 int early_data_enabled )
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001716{
1717 conf->early_data_enabled = early_data_enabled;
1718}
Jerry Yucc4e0072022-11-22 17:22:22 +08001719
1720#if defined(MBEDTLS_SSL_SRV_C)
1721void mbedtls_ssl_tls13_conf_max_early_data_size(
1722 mbedtls_ssl_config *conf, uint32_t max_early_data_size )
1723{
Jerry Yu39da9852022-12-06 16:58:36 +08001724 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001725}
1726#endif /* MBEDTLS_SSL_SRV_C */
1727
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001728#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001729#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001732void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001733 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001734{
1735 conf->cert_profile = profile;
1736}
1737
Glenn Strauss36872db2022-01-22 05:06:31 -05001738static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1739{
1740 mbedtls_ssl_key_cert *cur = key_cert, *next;
1741
1742 while( cur != NULL )
1743 {
1744 next = cur->next;
1745 mbedtls_free( cur );
1746 cur = next;
1747 }
1748}
1749
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001750/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001751MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001752static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1753 mbedtls_x509_crt *cert,
1754 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001755{
niisato8ee24222018-06-25 19:05:48 +09001756 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001757
Glenn Strauss36872db2022-01-22 05:06:31 -05001758 if( cert == NULL )
1759 {
1760 /* Free list if cert is null */
1761 ssl_key_cert_free( *head );
1762 *head = NULL;
1763 return( 0 );
1764 }
1765
niisato8ee24222018-06-25 19:05:48 +09001766 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1767 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001768 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001769
niisato8ee24222018-06-25 19:05:48 +09001770 new_cert->cert = cert;
1771 new_cert->key = key;
1772 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001773
Glenn Strauss36872db2022-01-22 05:06:31 -05001774 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001775 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001776 {
niisato8ee24222018-06-25 19:05:48 +09001777 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001778 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001779 else
1780 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001781 mbedtls_ssl_key_cert *cur = *head;
1782 while( cur->next != NULL )
1783 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001784 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001785 }
1786
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001787 return( 0 );
1788}
1789
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001790int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001791 mbedtls_x509_crt *own_cert,
1792 mbedtls_pk_context *pk_key )
1793{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001794 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001795}
1796
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001797void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001798 mbedtls_x509_crt *ca_chain,
1799 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001800{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001801 conf->ca_chain = ca_chain;
1802 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001803
1804#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1805 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1806 * cannot be used together. */
1807 conf->f_ca_cb = NULL;
1808 conf->p_ca_cb = NULL;
1809#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001810}
Hanno Becker5adaad92019-03-27 16:54:37 +00001811
1812#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1813void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001814 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001815 void *p_ca_cb )
1816{
1817 conf->f_ca_cb = f_ca_cb;
1818 conf->p_ca_cb = p_ca_cb;
1819
1820 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1821 * cannot be used together. */
1822 conf->ca_chain = NULL;
1823 conf->ca_crl = NULL;
1824}
1825#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001827
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001828#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001829const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1830 size_t *name_len )
1831{
1832 *name_len = ssl->handshake->sni_name_len;
1833 return( ssl->handshake->sni_name );
1834}
1835
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001836int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1837 mbedtls_x509_crt *own_cert,
1838 mbedtls_pk_context *pk_key )
1839{
1840 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1841 own_cert, pk_key ) );
1842}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001843
1844void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1845 mbedtls_x509_crt *ca_chain,
1846 mbedtls_x509_crl *ca_crl )
1847{
1848 ssl->handshake->sni_ca_chain = ca_chain;
1849 ssl->handshake->sni_ca_crl = ca_crl;
1850}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001851
Glenn Strauss999ef702022-03-11 01:37:23 -05001852#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1853void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1854 const mbedtls_x509_crt *crt)
1855{
1856 ssl->handshake->dn_hints = crt;
1857}
1858#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1859
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001860void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1861 int authmode )
1862{
1863 ssl->handshake->sni_authmode = authmode;
1864}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001865#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1866
Hanno Becker8927c832019-04-03 12:52:50 +01001867#if defined(MBEDTLS_X509_CRT_PARSE_C)
1868void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1869 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1870 void *p_vrfy )
1871{
1872 ssl->f_vrfy = f_vrfy;
1873 ssl->p_vrfy = p_vrfy;
1874}
1875#endif
1876
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001877#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001878/*
1879 * Set EC J-PAKE password for current handshake
1880 */
Valerio Setti02c25b52022-11-15 14:08:42 +01001881#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001882int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1883 const unsigned char *pw,
1884 size_t pw_len )
1885{
Neil Armstrongca7d5062022-05-31 14:43:23 +02001886 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
1887 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1888 psa_pake_role_t psa_role;
1889 psa_status_t status;
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001890
Janos Follath8eb64132016-06-03 15:40:57 +01001891 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001892 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1893
Neil Armstrongca7d5062022-05-31 14:43:23 +02001894 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1895 psa_role = PSA_PAKE_ROLE_SERVER;
1896 else
1897 psa_role = PSA_PAKE_ROLE_CLIENT;
1898
Valerio Settiaca21b72022-11-17 18:17:01 +01001899 /* Empty password is not valid */
1900 if( ( pw == NULL) || ( pw_len == 0 ) )
1901 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001902
Valerio Settiaca21b72022-11-17 18:17:01 +01001903 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DERIVE );
1904 psa_set_key_algorithm( &attributes, PSA_ALG_JPAKE );
1905 psa_set_key_type( &attributes, PSA_KEY_TYPE_PASSWORD );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001906
Valerio Settiaca21b72022-11-17 18:17:01 +01001907 status = psa_import_key( &attributes, pw, pw_len,
1908 &ssl->handshake->psa_pake_password );
1909 if( status != PSA_SUCCESS )
1910 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001911
1912 psa_pake_cs_set_algorithm( &cipher_suite, PSA_ALG_JPAKE );
1913 psa_pake_cs_set_primitive( &cipher_suite,
1914 PSA_PAKE_PRIMITIVE( PSA_PAKE_PRIMITIVE_TYPE_ECC,
1915 PSA_ECC_FAMILY_SECP_R1,
1916 256) );
1917 psa_pake_cs_set_hash( &cipher_suite, PSA_ALG_SHA_256 );
1918
1919 status = psa_pake_setup( &ssl->handshake->psa_pake_ctx, &cipher_suite );
1920 if( status != PSA_SUCCESS )
1921 {
1922 psa_destroy_key( ssl->handshake->psa_pake_password );
1923 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1924 }
1925
1926 status = psa_pake_set_role( &ssl->handshake->psa_pake_ctx, psa_role );
1927 if( status != PSA_SUCCESS )
1928 {
1929 psa_destroy_key( ssl->handshake->psa_pake_password );
1930 psa_pake_abort( &ssl->handshake->psa_pake_ctx );
1931 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1932 }
1933
Valerio Settiaca21b72022-11-17 18:17:01 +01001934 psa_pake_set_password_key( &ssl->handshake->psa_pake_ctx,
1935 ssl->handshake->psa_pake_password );
1936 if( status != PSA_SUCCESS )
Neil Armstrongca7d5062022-05-31 14:43:23 +02001937 {
Valerio Settiaca21b72022-11-17 18:17:01 +01001938 psa_destroy_key( ssl->handshake->psa_pake_password );
1939 psa_pake_abort( &ssl->handshake->psa_pake_ctx );
1940 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Neil Armstrongca7d5062022-05-31 14:43:23 +02001941 }
1942
1943 ssl->handshake->psa_pake_ctx_is_ok = 1;
1944
1945 return( 0 );
Valerio Setti02c25b52022-11-15 14:08:42 +01001946}
1947#else /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001948int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1949 const unsigned char *pw,
1950 size_t pw_len )
1951{
1952 mbedtls_ecjpake_role role;
1953
1954 if( ssl->handshake == NULL || ssl->conf == NULL )
1955 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1956
1957 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1958 role = MBEDTLS_ECJPAKE_SERVER;
1959 else
1960 role = MBEDTLS_ECJPAKE_CLIENT;
1961
1962 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1963 role,
1964 MBEDTLS_MD_SHA256,
1965 MBEDTLS_ECP_DP_SECP256R1,
1966 pw, pw_len ) );
1967}
Valerio Setti02c25b52022-11-15 14:08:42 +01001968#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001969#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001970
Ronald Cron73fe8df2022-10-05 14:31:43 +02001971#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001972int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001973{
Ronald Crond29e13e2022-10-19 10:33:48 +02001974 if( conf->psk_identity == NULL ||
1975 conf->psk_identity_len == 0 )
1976 {
1977 return( 0 );
1978 }
1979
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001980#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Crond29e13e2022-10-19 10:33:48 +02001981 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001982 return( 1 );
1983#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02001984
1985 if( conf->psk != NULL && conf->psk_len != 0 )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001986 return( 1 );
1987
1988 return( 0 );
1989}
1990
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001991static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1992{
1993 /* Remove reference to existing PSK, if any. */
1994#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001995 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001996 {
1997 /* The maintenance of the PSK key slot is the
1998 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001999 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002000 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002001#endif /* MBEDTLS_USE_PSA_CRYPTO */
2002 if( conf->psk != NULL )
2003 {
2004 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
2005
2006 mbedtls_free( conf->psk );
2007 conf->psk = NULL;
2008 conf->psk_len = 0;
2009 }
2010
2011 /* Remove reference to PSK identity, if any. */
2012 if( conf->psk_identity != NULL )
2013 {
2014 mbedtls_free( conf->psk_identity );
2015 conf->psk_identity = NULL;
2016 conf->psk_identity_len = 0;
2017 }
2018}
2019
Hanno Becker7390c712018-11-15 13:33:04 +00002020/* This function assumes that PSK identity in the SSL config is unset.
2021 * It checks that the provided identity is well-formed and attempts
2022 * to make a copy of it in the SSL config.
2023 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002024MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00002025static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
2026 unsigned char const *psk_identity,
2027 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002028{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002029 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00002030 if( psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002031 psk_identity_len == 0 ||
Hanno Becker7390c712018-11-15 13:33:04 +00002032 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10002033 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002034 {
2035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2036 }
2037
Hanno Becker7390c712018-11-15 13:33:04 +00002038 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
2039 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002040 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02002041
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002042 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002043 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02002044
2045 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02002046}
2047
Hanno Becker7390c712018-11-15 13:33:04 +00002048int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
2049 const unsigned char *psk, size_t psk_len,
2050 const unsigned char *psk_identity, size_t psk_identity_len )
2051{
Janos Follath865b3eb2019-12-16 11:46:15 +00002052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002053
2054 /* We currently only support one PSK, raw or opaque. */
Ronald Crond29e13e2022-10-19 10:33:48 +02002055 if( mbedtls_ssl_conf_has_static_psk( conf ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002056 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00002057
2058 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002059 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00002060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002061 if( psk_len == 0 )
2062 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2063 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2064 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2065
Hanno Becker7390c712018-11-15 13:33:04 +00002066 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
2067 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2068 conf->psk_len = psk_len;
2069 memcpy( conf->psk, psk, conf->psk_len );
2070
2071 /* Check and set PSK Identity */
2072 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
2073 if( ret != 0 )
2074 ssl_conf_remove_psk( conf );
2075
2076 return( ret );
2077}
2078
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002079static void ssl_remove_psk( mbedtls_ssl_context *ssl )
2080{
2081#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02002082 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002083 {
Neil Armstrong501c9322022-05-03 09:35:09 +02002084 /* The maintenance of the external PSK key slot is the
2085 * user's responsibility. */
2086 if( ssl->handshake->psk_opaque_is_internal )
2087 {
2088 psa_destroy_key( ssl->handshake->psk_opaque );
2089 ssl->handshake->psk_opaque_is_internal = 0;
2090 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002091 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002092 }
Neil Armstronge952a302022-05-03 10:22:14 +02002093#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002094 if( ssl->handshake->psk != NULL )
2095 {
2096 mbedtls_platform_zeroize( ssl->handshake->psk,
2097 ssl->handshake->psk_len );
2098 mbedtls_free( ssl->handshake->psk );
2099 ssl->handshake->psk_len = 0;
2100 }
Neil Armstronge952a302022-05-03 10:22:14 +02002101#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002102}
2103
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002104int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2105 const unsigned char *psk, size_t psk_len )
2106{
Neil Armstrong501c9322022-05-03 09:35:09 +02002107#if defined(MBEDTLS_USE_PSA_CRYPTO)
2108 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002110 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002111 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
2113
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002114 if( psk == NULL || ssl->handshake == NULL )
2115 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2116
2117 if( psk_len > MBEDTLS_PSK_MAX_LEN )
2118 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2119
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002121
Neil Armstrong501c9322022-05-03 09:35:09 +02002122#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002123#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2124 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
2125 {
Jerry Yu6cf6b472022-08-16 14:50:28 +08002126 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yuccc68a42022-07-26 16:39:20 +08002127 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_384 );
2128 else
2129 alg = PSA_ALG_TLS12_PSK_TO_MS( PSA_ALG_SHA_256 );
2130 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
2131 }
2132#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002133
Jerry Yu568ec252022-07-22 21:27:34 +08002134#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuccc68a42022-07-26 16:39:20 +08002135 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
2136 {
2137 alg = PSA_ALG_HKDF_EXTRACT( PSA_ALG_ANY_HASH );
2138 psa_set_key_usage_flags( &key_attributes,
2139 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
2140 }
2141#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2142
Neil Armstrong501c9322022-05-03 09:35:09 +02002143 psa_set_key_algorithm( &key_attributes, alg );
2144 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
2145
2146 status = psa_import_key( &key_attributes, psk, psk_len, &key );
2147 if( status != PSA_SUCCESS )
2148 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
2149
2150 /* Allow calling psa_destroy_key() on psk remove */
2151 ssl->handshake->psk_opaque_is_internal = 1;
2152 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
2153#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002154 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002155 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002156
2157 ssl->handshake->psk_len = psk_len;
2158 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
2159
2160 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02002161#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002162}
2163
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002164#if defined(MBEDTLS_USE_PSA_CRYPTO)
2165int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01002166 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002167 const unsigned char *psk_identity,
2168 size_t psk_identity_len )
2169{
Janos Follath865b3eb2019-12-16 11:46:15 +00002170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002171
2172 /* We currently only support one PSK, raw or opaque. */
Ronald Crond29e13e2022-10-19 10:33:48 +02002173 if( mbedtls_ssl_conf_has_static_psk( conf ) )
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002174 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002175
Hanno Becker7390c712018-11-15 13:33:04 +00002176 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002177 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00002178 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02002179 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002180
2181 /* Check and set PSK Identity */
2182 ret = ssl_conf_set_psk_identity( conf, psk_identity,
2183 psk_identity_len );
2184 if( ret != 0 )
2185 ssl_conf_remove_psk( conf );
2186
2187 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002188}
2189
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002190int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
2191 mbedtls_svc_key_id_t psk )
2192{
2193 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
2194 ( ssl->handshake == NULL ) )
2195 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2196
2197 ssl_remove_psk( ssl );
2198 ssl->handshake->psk_opaque = psk;
2199 return( 0 );
2200}
2201#endif /* MBEDTLS_USE_PSA_CRYPTO */
2202
Jerry Yu8897c072022-08-12 13:56:53 +08002203#if defined(MBEDTLS_SSL_SRV_C)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002204void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
2205 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2206 size_t),
2207 void *p_psk )
2208{
2209 conf->f_psk = f_psk;
2210 conf->p_psk = p_psk;
2211}
Jerry Yu8897c072022-08-12 13:56:53 +08002212#endif /* MBEDTLS_SSL_SRV_C */
2213
Ronald Cron73fe8df2022-10-05 14:31:43 +02002214#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002215
2216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002217static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
2218 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002219{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002220#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002221 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002222 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002223#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002224 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002225 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02002226 return( MBEDTLS_SSL_MODE_STREAM );
2227}
2228
2229#else /* MBEDTLS_USE_PSA_CRYPTO */
2230
2231static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
2232 mbedtls_cipher_mode_t mode )
2233{
2234#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
2235 if( mode == MBEDTLS_MODE_CBC )
2236 return( MBEDTLS_SSL_MODE_CBC );
2237#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2238
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002239#if defined(MBEDTLS_GCM_C) || \
2240 defined(MBEDTLS_CCM_C) || \
2241 defined(MBEDTLS_CHACHAPOLY_C)
2242 if( mode == MBEDTLS_MODE_GCM ||
2243 mode == MBEDTLS_MODE_CCM ||
2244 mode == MBEDTLS_MODE_CHACHAPOLY )
2245 return( MBEDTLS_SSL_MODE_AEAD );
2246#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002247
2248 return( MBEDTLS_SSL_MODE_STREAM );
2249}
Gilles Peskine301711e2022-04-26 16:57:05 +02002250#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002251
Gilles Peskinee108d982022-04-26 16:50:40 +02002252static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2253 mbedtls_ssl_mode_t base_mode,
2254 int encrypt_then_mac )
2255{
2256#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2257 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2258 base_mode == MBEDTLS_SSL_MODE_CBC )
2259 {
2260 return( MBEDTLS_SSL_MODE_CBC_ETM );
2261 }
2262#else
2263 (void) encrypt_then_mac;
2264#endif
2265 return( base_mode );
2266}
2267
Neil Armstrongab555e02022-04-04 11:07:59 +02002268mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002269 const mbedtls_ssl_transform *transform )
2270{
Gilles Peskinee108d982022-04-26 16:50:40 +02002271 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002272#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02002273 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002274#else
Gilles Peskinee108d982022-04-26 16:50:40 +02002275 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
2276#endif
2277 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002278
Gilles Peskinee108d982022-04-26 16:50:40 +02002279 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002280#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002281 encrypt_then_mac = transform->encrypt_then_mac;
2282#endif
2283 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002284}
2285
Neil Armstrongab555e02022-04-04 11:07:59 +02002286mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002287#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002288 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002289#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002290 const mbedtls_ssl_ciphersuite_t *suite )
2291{
Gilles Peskinee108d982022-04-26 16:50:40 +02002292 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2293
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002294#if defined(MBEDTLS_USE_PSA_CRYPTO)
2295 psa_status_t status;
2296 psa_algorithm_t alg;
2297 psa_key_type_t type;
2298 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002299 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
2300 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02002301 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002302#else
2303 const mbedtls_cipher_info_t *cipher =
2304 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002305 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02002306 {
2307 base_mode =
2308 mbedtls_ssl_get_base_mode(
2309 mbedtls_cipher_info_get_mode( cipher ) );
2310 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002311#endif /* MBEDTLS_USE_PSA_CRYPTO */
2312
Gilles Peskinee108d982022-04-26 16:50:40 +02002313#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2314 int encrypt_then_mac = 0;
2315#endif
2316 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002317}
2318
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002319#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002320
2321#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002322/* Serialization of TLS 1.3 sessions:
2323 *
2324 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002325 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002326 * uint64 ticket_received;
2327 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002328 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002329 * } ClientOnlyData;
2330 *
2331 * struct {
2332 * uint8 endpoint;
2333 * uint8 ciphersuite[2];
2334 * uint32 ticket_age_add;
2335 * uint8 ticket_flags;
2336 * opaque resumption_key<0..255>;
2337 * select ( endpoint ) {
2338 * case client: ClientOnlyData;
2339 * case server: uint64 start_time;
2340 * };
2341 * } serialized_session_tls13;
2342 *
2343 */
2344#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002345MBEDTLS_CHECK_RETURN_CRITICAL
2346static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2347 unsigned char *buf,
2348 size_t buf_len,
2349 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00002350{
2351 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002352#if defined(MBEDTLS_SSL_CLI_C) && \
2353 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2354 size_t hostname_len = ( session->hostname == NULL ) ?
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002355 0 : strlen( session->hostname ) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002356#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002357 size_t needed = 1 /* endpoint */
2358 + 2 /* ciphersuite */
2359 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002360 + 1 /* ticket_flags */
2361 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002362 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002363
2364 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
2365 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2366 needed += session->resumption_key_len; /* resumption_key */
2367
Jerry Yu438ddd82022-07-07 06:55:50 +00002368#if defined(MBEDTLS_HAVE_TIME)
2369 needed += 8; /* start_time or ticket_received */
2370#endif
2371
2372#if defined(MBEDTLS_SSL_CLI_C)
2373 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2374 {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002375#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002376 needed += 2 /* hostname_len */
Xiaokang Qian2f9efd32022-10-10 11:24:08 +00002377 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002378#endif
2379
Jerry Yu438ddd82022-07-07 06:55:50 +00002380 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002381 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002382
2383 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08002384 if( session->ticket_len > SIZE_MAX - needed )
2385 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08002386
Jerry Yue28d9742022-08-18 15:44:03 +08002387 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002388 }
2389#endif /* MBEDTLS_SSL_CLI_C */
2390
Jerry Yue36fdd62022-08-17 21:31:36 +08002391 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00002392 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08002393 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Jerry Yu438ddd82022-07-07 06:55:50 +00002394
2395 p[0] = session->endpoint;
2396 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
2397 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
2398 p[7] = session->ticket_flags;
2399
2400 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002401 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002402 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08002403 memcpy( p, session->resumption_key, session->resumption_key_len );
2404 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002405
2406#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2407 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2408 {
2409 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
2410 p += 8;
2411 }
2412#endif /* MBEDTLS_HAVE_TIME */
2413
2414#if defined(MBEDTLS_SSL_CLI_C)
2415 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2416 {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002417#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2418 MBEDTLS_PUT_UINT16_BE( hostname_len, p, 0 );
2419 p += 2;
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002420 if( hostname_len > 0 )
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002421 {
2422 /* save host name */
2423 memcpy( p, session->hostname, hostname_len );
2424 p += hostname_len;
2425 }
2426#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2427
Jerry Yu438ddd82022-07-07 06:55:50 +00002428#if defined(MBEDTLS_HAVE_TIME)
2429 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
2430 p += 8;
2431#endif
2432 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
2433 p += 4;
2434
2435 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
2436 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002437
2438 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00002439 {
2440 memcpy( p, session->ticket, session->ticket_len );
2441 p += session->ticket_len;
2442 }
2443 }
2444#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08002445 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00002446}
2447
2448MBEDTLS_CHECK_RETURN_CRITICAL
2449static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2450 const unsigned char *buf,
2451 size_t len )
2452{
2453 const unsigned char *p = buf;
2454 const unsigned char *end = buf + len;
2455
2456 if( end - p < 9 )
2457 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2458 session->endpoint = p[0];
2459 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2460 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2461 session->ticket_flags = p[7];
2462
2463 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002464 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002465 p += 9;
2466
Jerry Yubc7c1a42022-07-21 22:57:37 +08002467 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002468 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2469
Jerry Yubc7c1a42022-07-21 22:57:37 +08002470 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002471 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002472 memcpy( session->resumption_key, p, session->resumption_key_len );
2473 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002474
2475#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2476 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2477 {
2478 if( end - p < 8 )
2479 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2480 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2481 p += 8;
2482 }
2483#endif /* MBEDTLS_HAVE_TIME */
2484
2485#if defined(MBEDTLS_SSL_CLI_C)
2486 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2487 {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
2489 defined(MBEDTLS_SSL_SESSION_TICKETS)
2490 size_t hostname_len;
2491 /* load host name */
2492 if( end - p < 2 )
2493 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2494 hostname_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2495 p += 2;
2496
2497 if( end - p < ( long int )hostname_len )
2498 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2499 if( hostname_len > 0 )
2500 {
2501 session->hostname = mbedtls_calloc( 1, hostname_len );
2502 if( session->hostname == NULL )
2503 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2504 memcpy( session->hostname, p, hostname_len );
2505 p += hostname_len;
2506 }
2507#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2508 MBEDTLS_SSL_SESSION_TICKETS */
2509
Jerry Yu438ddd82022-07-07 06:55:50 +00002510#if defined(MBEDTLS_HAVE_TIME)
2511 if( end - p < 8 )
2512 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2513 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2514 p += 8;
2515#endif
2516 if( end - p < 4 )
2517 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2518 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2519 p += 4;
2520
2521 if( end - p < 2 )
2522 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2523 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2524 p += 2;
2525
2526 if( end - p < ( long int )session->ticket_len )
2527 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2528 if( session->ticket_len > 0 )
2529 {
2530 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2531 if( session->ticket == NULL )
2532 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2533 memcpy( session->ticket, p, session->ticket_len );
2534 p += session->ticket_len;
2535 }
2536 }
2537#endif /* MBEDTLS_SSL_CLI_C */
2538
2539 return( 0 );
2540
2541}
2542#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002543MBEDTLS_CHECK_RETURN_CRITICAL
2544static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2545 unsigned char *buf,
2546 size_t buf_len,
2547 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002548{
2549 ((void) session);
2550 ((void) buf);
2551 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002552 *olen = 0;
2553 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002554}
Jerry Yu438ddd82022-07-07 06:55:50 +00002555
2556static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2557 unsigned char *buf,
2558 size_t buf_len )
2559{
2560 ((void) session);
2561 ((void) buf);
2562 ((void) buf_len);
2563 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2564}
2565#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002566#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2567
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002568psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 size_t taglen,
2570 psa_algorithm_t *alg,
2571 psa_key_type_t *key_type,
2572 size_t *key_size )
2573{
2574 switch ( mbedtls_cipher_type )
2575 {
2576 case MBEDTLS_CIPHER_AES_128_CBC:
2577 *alg = PSA_ALG_CBC_NO_PADDING;
2578 *key_type = PSA_KEY_TYPE_AES;
2579 *key_size = 128;
2580 break;
2581 case MBEDTLS_CIPHER_AES_128_CCM:
2582 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2583 *key_type = PSA_KEY_TYPE_AES;
2584 *key_size = 128;
2585 break;
2586 case MBEDTLS_CIPHER_AES_128_GCM:
2587 *alg = PSA_ALG_GCM;
2588 *key_type = PSA_KEY_TYPE_AES;
2589 *key_size = 128;
2590 break;
2591 case MBEDTLS_CIPHER_AES_192_CCM:
2592 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2593 *key_type = PSA_KEY_TYPE_AES;
2594 *key_size = 192;
2595 break;
2596 case MBEDTLS_CIPHER_AES_192_GCM:
2597 *alg = PSA_ALG_GCM;
2598 *key_type = PSA_KEY_TYPE_AES;
2599 *key_size = 192;
2600 break;
2601 case MBEDTLS_CIPHER_AES_256_CBC:
2602 *alg = PSA_ALG_CBC_NO_PADDING;
2603 *key_type = PSA_KEY_TYPE_AES;
2604 *key_size = 256;
2605 break;
2606 case MBEDTLS_CIPHER_AES_256_CCM:
2607 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2608 *key_type = PSA_KEY_TYPE_AES;
2609 *key_size = 256;
2610 break;
2611 case MBEDTLS_CIPHER_AES_256_GCM:
2612 *alg = PSA_ALG_GCM;
2613 *key_type = PSA_KEY_TYPE_AES;
2614 *key_size = 256;
2615 break;
2616 case MBEDTLS_CIPHER_ARIA_128_CBC:
2617 *alg = PSA_ALG_CBC_NO_PADDING;
2618 *key_type = PSA_KEY_TYPE_ARIA;
2619 *key_size = 128;
2620 break;
2621 case MBEDTLS_CIPHER_ARIA_128_CCM:
2622 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2623 *key_type = PSA_KEY_TYPE_ARIA;
2624 *key_size = 128;
2625 break;
2626 case MBEDTLS_CIPHER_ARIA_128_GCM:
2627 *alg = PSA_ALG_GCM;
2628 *key_type = PSA_KEY_TYPE_ARIA;
2629 *key_size = 128;
2630 break;
2631 case MBEDTLS_CIPHER_ARIA_192_CCM:
2632 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2633 *key_type = PSA_KEY_TYPE_ARIA;
2634 *key_size = 192;
2635 break;
2636 case MBEDTLS_CIPHER_ARIA_192_GCM:
2637 *alg = PSA_ALG_GCM;
2638 *key_type = PSA_KEY_TYPE_ARIA;
2639 *key_size = 192;
2640 break;
2641 case MBEDTLS_CIPHER_ARIA_256_CBC:
2642 *alg = PSA_ALG_CBC_NO_PADDING;
2643 *key_type = PSA_KEY_TYPE_ARIA;
2644 *key_size = 256;
2645 break;
2646 case MBEDTLS_CIPHER_ARIA_256_CCM:
2647 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2648 *key_type = PSA_KEY_TYPE_ARIA;
2649 *key_size = 256;
2650 break;
2651 case MBEDTLS_CIPHER_ARIA_256_GCM:
2652 *alg = PSA_ALG_GCM;
2653 *key_type = PSA_KEY_TYPE_ARIA;
2654 *key_size = 256;
2655 break;
2656 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2657 *alg = PSA_ALG_CBC_NO_PADDING;
2658 *key_type = PSA_KEY_TYPE_CAMELLIA;
2659 *key_size = 128;
2660 break;
2661 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2662 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2663 *key_type = PSA_KEY_TYPE_CAMELLIA;
2664 *key_size = 128;
2665 break;
2666 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2667 *alg = PSA_ALG_GCM;
2668 *key_type = PSA_KEY_TYPE_CAMELLIA;
2669 *key_size = 128;
2670 break;
2671 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2672 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2673 *key_type = PSA_KEY_TYPE_CAMELLIA;
2674 *key_size = 192;
2675 break;
2676 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2677 *alg = PSA_ALG_GCM;
2678 *key_type = PSA_KEY_TYPE_CAMELLIA;
2679 *key_size = 192;
2680 break;
2681 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2682 *alg = PSA_ALG_CBC_NO_PADDING;
2683 *key_type = PSA_KEY_TYPE_CAMELLIA;
2684 *key_size = 256;
2685 break;
2686 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2687 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2688 *key_type = PSA_KEY_TYPE_CAMELLIA;
2689 *key_size = 256;
2690 break;
2691 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2692 *alg = PSA_ALG_GCM;
2693 *key_type = PSA_KEY_TYPE_CAMELLIA;
2694 *key_size = 256;
2695 break;
2696 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2697 *alg = PSA_ALG_CHACHA20_POLY1305;
2698 *key_type = PSA_KEY_TYPE_CHACHA20;
2699 *key_size = 256;
2700 break;
2701 case MBEDTLS_CIPHER_NULL:
2702 *alg = MBEDTLS_SSL_NULL_CIPHER;
2703 *key_type = 0;
2704 *key_size = 0;
2705 break;
2706 default:
2707 return PSA_ERROR_NOT_SUPPORTED;
2708 }
2709
2710 return PSA_SUCCESS;
2711}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002712#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002713
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002714#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002715int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2716 const unsigned char *dhm_P, size_t P_len,
2717 const unsigned char *dhm_G, size_t G_len )
2718{
Janos Follath865b3eb2019-12-16 11:46:15 +00002719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002720
Glenn Strausscee11292021-12-20 01:43:17 -05002721 mbedtls_mpi_free( &conf->dhm_P );
2722 mbedtls_mpi_free( &conf->dhm_G );
2723
Hanno Beckera90658f2017-10-04 15:29:08 +01002724 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2725 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2726 {
2727 mbedtls_mpi_free( &conf->dhm_P );
2728 mbedtls_mpi_free( &conf->dhm_G );
2729 return( ret );
2730 }
2731
2732 return( 0 );
2733}
Paul Bakker5121ce52009-01-03 21:22:43 +00002734
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002735int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002736{
Janos Follath865b3eb2019-12-16 11:46:15 +00002737 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002738
Glenn Strausscee11292021-12-20 01:43:17 -05002739 mbedtls_mpi_free( &conf->dhm_P );
2740 mbedtls_mpi_free( &conf->dhm_G );
2741
Gilles Peskinee5702482021-06-11 21:59:08 +02002742 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2743 &conf->dhm_P ) ) != 0 ||
2744 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2745 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002746 {
2747 mbedtls_mpi_free( &conf->dhm_P );
2748 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002749 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002750 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002751
2752 return( 0 );
2753}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002754#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002755
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002756#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2757/*
2758 * Set the minimum length for Diffie-Hellman parameters
2759 */
2760void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2761 unsigned int bitlen )
2762{
2763 conf->dhm_min_bitlen = bitlen;
2764}
2765#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2766
Ronald Crone68ab4f2022-10-05 12:46:29 +02002767#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002768#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002769/*
2770 * Set allowed/preferred hashes for handshake signatures
2771 */
2772void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2773 const int *hashes )
2774{
2775 conf->sig_hashes = hashes;
2776}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002777#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002778
Jerry Yuf017ee42022-01-12 15:49:48 +08002779/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002780void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2781 const uint16_t* sig_algs )
2782{
Jerry Yuf017ee42022-01-12 15:49:48 +08002783#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2784 conf->sig_hashes = NULL;
2785#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2786 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002787}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002788#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002789
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002790#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002791#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002792/*
2793 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002794 *
2795 * mbedtls_ssl_setup() takes the provided list
2796 * and translates it to a list of IANA TLS group identifiers,
2797 * stored in ssl->handshake->group_list.
2798 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002799 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002800void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002801 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002802{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002803 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002804 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002805}
Brett Warrene0edc842021-08-17 09:53:13 +01002806#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002807#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002808
Brett Warrene0edc842021-08-17 09:53:13 +01002809/*
2810 * Set the allowed groups
2811 */
2812void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2813 const uint16_t *group_list )
2814{
2815#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2816 conf->curve_list = NULL;
2817#endif
2818 conf->group_list = group_list;
2819}
2820
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002821#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002823{
Hanno Becker947194e2017-04-07 13:25:49 +01002824 /* Initialize to suppress unnecessary compiler warning */
2825 size_t hostname_len = 0;
2826
2827 /* Check if new hostname is valid before
2828 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002829 if( hostname != NULL )
2830 {
2831 hostname_len = strlen( hostname );
2832
2833 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2834 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2835 }
2836
2837 /* Now it's clear that we will overwrite the old hostname,
2838 * so we can free it safely */
2839
2840 if( ssl->hostname != NULL )
2841 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002842 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002843 mbedtls_free( ssl->hostname );
2844 }
2845
2846 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002847
Paul Bakker5121ce52009-01-03 21:22:43 +00002848 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002849 {
2850 ssl->hostname = NULL;
2851 }
2852 else
2853 {
2854 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002855 if( ssl->hostname == NULL )
2856 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002857
Hanno Becker947194e2017-04-07 13:25:49 +01002858 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002859
Hanno Becker947194e2017-04-07 13:25:49 +01002860 ssl->hostname[hostname_len] = '\0';
2861 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002862
2863 return( 0 );
2864}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002865#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002866
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002867#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002868void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002870 const unsigned char *, size_t),
2871 void *p_sni )
2872{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002873 conf->f_sni = f_sni;
2874 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002875}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002879int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002880{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002881 size_t cur_len, tot_len;
2882 const char **p;
2883
2884 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002885 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2886 * MUST NOT be truncated."
2887 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002888 */
2889 tot_len = 0;
2890 for( p = protos; *p != NULL; p++ )
2891 {
2892 cur_len = strlen( *p );
2893 tot_len += cur_len;
2894
Ronald Cron8216dd32020-04-23 16:41:44 +02002895 if( ( cur_len == 0 ) ||
2896 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2897 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002899 }
2900
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002901 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002902
2903 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002904}
2905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002907{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002908 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002909}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002911
Johan Pascalb62bb512015-12-03 21:56:45 +01002912#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002913void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2914 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002915{
2916 conf->dtls_srtp_mki_support = support_mki_value;
2917}
2918
Ron Eldoref72faf2018-07-12 11:54:20 +03002919int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2920 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002921 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002922{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002923 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002924 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002925 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002926 }
Ron Eldor591f1622018-01-22 12:30:04 +02002927
2928 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002929 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002930 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002931 }
Ron Eldor591f1622018-01-22 12:30:04 +02002932
2933 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2934 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002935 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002936}
2937
Ron Eldoref72faf2018-07-12 11:54:20 +03002938int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002939 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002940{
Johan Pascal253d0262020-09-22 13:04:45 +02002941 const mbedtls_ssl_srtp_profile *p;
2942 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002943
Johan Pascal253d0262020-09-22 13:04:45 +02002944 /* check the profiles list: all entry must be valid,
2945 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002946 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2947 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2948 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002949 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002950 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002951 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002952 list_size++;
2953 }
2954 else
2955 {
2956 /* unsupported value, stop parsing and set the size to an error value */
2957 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002958 }
2959 }
2960
Johan Pascal5ef72d22020-10-28 17:05:47 +01002961 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002962 {
Johan Pascal253d0262020-09-22 13:04:45 +02002963 conf->dtls_srtp_profile_list = NULL;
2964 conf->dtls_srtp_profile_list_len = 0;
2965 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2966 }
2967
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002968 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002969 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002970
2971 return( 0 );
2972}
2973
Johan Pascal5ef72d22020-10-28 17:05:47 +01002974void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2975 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002976{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002977 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2978 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002979 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002980 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002981 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002982 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002983 else
2984 {
2985 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002986 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2987 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002988 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002989}
Johan Pascalb62bb512015-12-03 21:56:45 +01002990#endif /* MBEDTLS_SSL_DTLS_SRTP */
2991
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302992#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002993void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002994{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002995 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002996}
2997
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002998void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002999{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003000 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00003001}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303002#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003003
Janos Follath088ce432017-04-10 12:42:31 +01003004#if defined(MBEDTLS_SSL_SRV_C)
3005void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3006 char cert_req_ca_list )
3007{
3008 conf->cert_req_ca_list = cert_req_ca_list;
3009}
3010#endif
3011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003013void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003014{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003015 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003016}
3017#endif
3018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003019#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003020void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003021{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003022 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003023}
3024#endif
3025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003027int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003028{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10003030 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003031 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003033 }
3034
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003035 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003036
3037 return( 0 );
3038}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003040
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003041void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00003042{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003043 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003044}
3045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003047void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003048{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003049 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003050}
3051
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003052void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003053{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003054 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003055}
3056
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003057void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003058 const unsigned char period[8] )
3059{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003060 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003061}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003065#if defined(MBEDTLS_SSL_CLI_C)
3066void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003067{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003068 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003069}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003070#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003071
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003072#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003073
Jerry Yud0766ec2022-09-22 10:46:57 +08003074#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003075void mbedtls_ssl_conf_new_session_tickets( mbedtls_ssl_config *conf,
3076 uint16_t num_tickets )
3077{
Jerry Yud0766ec2022-09-22 10:46:57 +08003078 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003079}
3080#endif
3081
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003082void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
3083 mbedtls_ssl_ticket_write_t *f_ticket_write,
3084 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3085 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02003086{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003087 conf->f_ticket_write = f_ticket_write;
3088 conf->f_ticket_parse = f_ticket_parse;
3089 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003090}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003091#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003093
Hanno Becker7e6c1782021-06-08 09:24:55 +01003094void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
3095 mbedtls_ssl_export_keys_t *f_export_keys,
3096 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003097{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003098 ssl->f_export_keys = f_export_keys;
3099 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003100}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003101
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003102#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003103void mbedtls_ssl_conf_async_private_cb(
3104 mbedtls_ssl_config *conf,
3105 mbedtls_ssl_async_sign_t *f_async_sign,
3106 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3107 mbedtls_ssl_async_resume_t *f_async_resume,
3108 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003109 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003110{
3111 conf->f_async_sign_start = f_async_sign;
3112 conf->f_async_decrypt_start = f_async_decrypt;
3113 conf->f_async_resume = f_async_resume;
3114 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003115 conf->p_async_config_data = async_config_data;
3116}
3117
Gilles Peskine8f97af72018-04-26 11:46:10 +02003118void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
3119{
3120 return( conf->p_async_config_data );
3121}
3122
Gilles Peskine1febfef2018-04-30 11:54:39 +02003123void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003124{
3125 if( ssl->handshake == NULL )
3126 return( NULL );
3127 else
3128 return( ssl->handshake->user_async_ctx );
3129}
3130
Gilles Peskine1febfef2018-04-30 11:54:39 +02003131void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003132 void *ctx )
3133{
3134 if( ssl->handshake != NULL )
3135 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003136}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003137#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003138
Paul Bakker5121ce52009-01-03 21:22:43 +00003139/*
3140 * SSL get accessors
3141 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003142uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003143{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003144 if( ssl->session != NULL )
3145 return( ssl->session->verify_result );
3146
3147 if( ssl->session_negotiate != NULL )
3148 return( ssl->session_negotiate->verify_result );
3149
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02003150 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00003151}
3152
Glenn Strauss8f526902022-01-13 00:04:49 -05003153int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
3154{
3155 if( ssl == NULL || ssl->session == NULL )
3156 return( 0 );
3157
3158 return( ssl->session->ciphersuite );
3159}
3160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00003162{
Paul Bakker926c8e42013-03-06 10:23:34 +01003163 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003164 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01003165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00003167}
3168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003169const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00003170{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003172 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003173 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003174 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003175 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003176 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003177 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003178 default:
3179 return( "unknown (DTLS)" );
3180 }
3181 }
3182#endif
3183
Glenn Strauss60bfe602022-03-14 19:04:24 -04003184 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00003185 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003186 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00003187 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04003188 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01003189 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003190 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003191 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003192 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003193}
3194
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003196size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
3197{
David Horstmann95d516f2021-05-04 18:36:56 +01003198 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003199 size_t read_mfl;
3200
3201 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
3202 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3203 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
3204 {
3205 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
3206 }
3207
3208 /* Check if a smaller max length was negotiated */
3209 if( ssl->session_out != NULL )
3210 {
3211 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
3212 if( read_mfl < max_len )
3213 {
3214 max_len = read_mfl;
3215 }
3216 }
3217
3218 // During a handshake, use the value being negotiated
3219 if( ssl->session_negotiate != NULL )
3220 {
3221 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3222 if( read_mfl < max_len )
3223 {
3224 max_len = read_mfl;
3225 }
3226 }
3227
3228 return( max_len );
3229}
3230
3231size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003232{
3233 size_t max_len;
3234
3235 /*
3236 * Assume mfl_code is correct since it was checked when set
3237 */
Angus Grattond8213d02016-05-25 20:56:48 +10003238 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003239
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003240 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003241 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10003242 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003243 {
Angus Grattond8213d02016-05-25 20:56:48 +10003244 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003245 }
3246
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003247 /* During a handshake, use the value being negotiated */
3248 if( ssl->session_negotiate != NULL &&
3249 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
3250 {
3251 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
3252 }
3253
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003254 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003255}
3256#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3257
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003258#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003259size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003260{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003261 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
3262 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3263 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3264 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
3265 return ( 0 );
3266
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003267 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
3268 return( ssl->mtu );
3269
3270 if( ssl->mtu == 0 )
3271 return( ssl->handshake->mtu );
3272
3273 return( ssl->mtu < ssl->handshake->mtu ?
3274 ssl->mtu : ssl->handshake->mtu );
3275}
3276#endif /* MBEDTLS_SSL_PROTO_DTLS */
3277
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003278int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
3279{
3280 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3281
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003282#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3283 !defined(MBEDTLS_SSL_PROTO_DTLS)
3284 (void) ssl;
3285#endif
3286
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003288 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289
3290 if( max_len > mfl )
3291 max_len = mfl;
3292#endif
3293
3294#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00003295 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003296 {
Hanno Becker89490712020-02-05 10:50:12 +00003297 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003298 const int ret = mbedtls_ssl_get_record_expansion( ssl );
3299 const size_t overhead = (size_t) ret;
3300
3301 if( ret < 0 )
3302 return( ret );
3303
3304 if( mtu <= overhead )
3305 {
3306 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
3307 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3308 }
3309
3310 if( max_len > mtu - overhead )
3311 max_len = mtu - overhead;
3312 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003313#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003314
Hanno Becker0defedb2018-08-10 12:35:02 +01003315#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3316 !defined(MBEDTLS_SSL_PROTO_DTLS)
3317 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003318#endif
3319
3320 return( (int) max_len );
3321}
3322
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003323int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
3324{
3325 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3326
3327#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3328 (void) ssl;
3329#endif
3330
3331#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3332 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
3333
3334 if( max_len > mfl )
3335 max_len = mfl;
3336#endif
3337
3338 return( (int) max_len );
3339}
3340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#if defined(MBEDTLS_X509_CRT_PARSE_C)
3342const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00003343{
3344 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003345 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00003346
Hanno Beckere6824572019-02-07 13:18:46 +00003347#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02003348 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00003349#else
3350 return( NULL );
3351#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003352}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00003356int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3357 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003358{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003359 int ret;
3360
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003361 if( ssl == NULL ||
3362 dst == NULL ||
3363 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003364 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003365 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367 }
3368
Hanno Beckere810bbc2021-05-14 16:01:05 +01003369 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3370 * idempotent: Each session can only be exported once.
3371 *
3372 * (This is in preparation for TLS 1.3 support where we will
3373 * need the ability to export multiple sessions (aka tickets),
3374 * which will be achieved by calling mbedtls_ssl_get_session()
3375 * multiple times until it fails.)
3376 *
3377 * Check whether we have already exported the current session,
3378 * and fail if so.
3379 */
3380 if( ssl->session->exported == 1 )
3381 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3382
3383 ret = mbedtls_ssl_session_copy( dst, ssl->session );
3384 if( ret != 0 )
3385 return( ret );
3386
3387 /* Remember that we've exported the session. */
3388 ssl->session->exported = 1;
3389 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003390}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003392
Paul Bakker5121ce52009-01-03 21:22:43 +00003393/*
Hanno Beckera835da52019-05-16 12:39:07 +01003394 * Define ticket header determining Mbed TLS version
3395 * and structure of the ticket.
3396 */
3397
Hanno Becker94ef3b32019-05-16 12:50:45 +01003398/*
Hanno Becker50b59662019-05-28 14:30:45 +01003399 * Define bitflag determining compile-time settings influencing
3400 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003401 */
3402
Hanno Becker50b59662019-05-28 14:30:45 +01003403#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003404#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003405#else
Hanno Becker3e088662019-05-29 11:10:18 +01003406#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003407#endif /* MBEDTLS_HAVE_TIME */
3408
3409#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003410#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003411#else
Hanno Becker3e088662019-05-29 11:10:18 +01003412#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003413#endif /* MBEDTLS_X509_CRT_PARSE_C */
3414
3415#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003416#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003417#else
Hanno Becker3e088662019-05-29 11:10:18 +01003418#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003419#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3420
3421#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003422#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003423#else
Hanno Becker3e088662019-05-29 11:10:18 +01003424#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003425#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3426
Hanno Becker94ef3b32019-05-16 12:50:45 +01003427#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003428#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003429#else
Hanno Becker3e088662019-05-29 11:10:18 +01003430#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003431#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3432
Hanno Becker94ef3b32019-05-16 12:50:45 +01003433#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3434#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3435#else
3436#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3437#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3438
Hanno Becker3e088662019-05-29 11:10:18 +01003439#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3440#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3441#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3442#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003443#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3444#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003445
Hanno Becker50b59662019-05-28 14:30:45 +01003446#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01003447 ( (uint16_t) ( \
3448 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
3449 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
3450 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
3451 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01003452 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01003453 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01003454
Hanno Beckerf8787072019-05-16 12:41:07 +01003455static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003456 MBEDTLS_VERSION_MAJOR,
3457 MBEDTLS_VERSION_MINOR,
3458 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003459 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3460 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01003461};
Hanno Beckera835da52019-05-16 12:39:07 +01003462
3463/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003464 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003465 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003466 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003467 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003468 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003469 * opaque mbedtls_version[3]; // library version: major, minor, patch
3470 * opaque session_format[2]; // library-version specific 16-bit field
3471 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003472 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003473 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003474 * Note: When updating the format, remember to keep
3475 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003476 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003477 * // In this version, `session_format` determines
3478 * // the setting of those compile-time
3479 * // configuration options which influence
3480 * // the structure of mbedtls_ssl_session.
3481 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003482 * uint8_t minor_ver; // Protocol minor version. Possible values:
3483 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003484 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003485 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003486 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003487 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003488 * serialized_session_tls12 data;
3489 *
3490 * };
3491 *
3492 * } serialized_session;
3493 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003494 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003495
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003496MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003497static int ssl_session_save( const mbedtls_ssl_session *session,
3498 unsigned char omit_header,
3499 unsigned char *buf,
3500 size_t buf_len,
3501 size_t *olen )
3502{
3503 unsigned char *p = buf;
3504 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003505 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003506#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3507 size_t out_len;
3508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3509#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003510 if( session == NULL )
3511 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3512
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003513 if( !omit_header )
3514 {
3515 /*
3516 * Add Mbed TLS version identifier
3517 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003518 used += sizeof( ssl_serialized_session_header );
3519
3520 if( used <= buf_len )
3521 {
3522 memcpy( p, ssl_serialized_session_header,
3523 sizeof( ssl_serialized_session_header ) );
3524 p += sizeof( ssl_serialized_session_header );
3525 }
3526 }
3527
3528 /*
3529 * TLS version identifier
3530 */
3531 used += 1;
3532 if( used <= buf_len )
3533 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003534 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003535 }
3536
3537 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003538 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003539 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003540 {
3541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003542 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003543 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003544 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003545#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3546
Jerry Yu251a12e2022-07-13 15:15:48 +08003547#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3548 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003549 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3550 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
Jerry Yue36fdd62022-08-17 21:31:36 +08003551 return( ret );
Jerry Yue36fdd62022-08-17 21:31:36 +08003552 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003553 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003554#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3555
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003556 default:
3557 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3558 }
3559
3560 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003561 if( used > buf_len )
3562 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003563
3564 return( 0 );
3565}
3566
3567/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003568 * Public wrapper for ssl_session_save()
3569 */
3570int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3571 unsigned char *buf,
3572 size_t buf_len,
3573 size_t *olen )
3574{
3575 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3576}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003577
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003578/*
3579 * Deserialize session, see mbedtls_ssl_session_save() for format.
3580 *
3581 * This internal version is wrapped by a public function that cleans up in
3582 * case of error, and has an extra option omit_header.
3583 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003584MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003585static int ssl_session_load( mbedtls_ssl_session *session,
3586 unsigned char omit_header,
3587 const unsigned char *buf,
3588 size_t len )
3589{
3590 const unsigned char *p = buf;
3591 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003592 size_t remaining_len;
3593
3594
3595 if( session == NULL )
3596 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003597
3598 if( !omit_header )
3599 {
3600 /*
3601 * Check Mbed TLS version identifier
3602 */
3603
3604 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3605 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3606
3607 if( memcmp( p, ssl_serialized_session_header,
3608 sizeof( ssl_serialized_session_header ) ) != 0 )
3609 {
3610 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3611 }
3612 p += sizeof( ssl_serialized_session_header );
3613 }
3614
3615 /*
3616 * TLS version identifier
3617 */
3618 if( 1 > (size_t)( end - p ) )
3619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003620 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003621
3622 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003623 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003624 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003625 {
3626#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003627 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003628 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003629#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3630
Jerry Yu438ddd82022-07-07 06:55:50 +00003631#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3632 case MBEDTLS_SSL_VERSION_TLS1_3:
3633 return( ssl_tls13_session_load( session, p, remaining_len ) );
3634#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3635
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003636 default:
3637 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3638 }
3639}
3640
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003641/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003642 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003643 */
3644int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3645 const unsigned char *buf,
3646 size_t len )
3647{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003648 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003649
3650 if( ret != 0 )
3651 mbedtls_ssl_session_free( session );
3652
3653 return( ret );
3654}
3655
3656/*
Paul Bakker1961b702013-01-25 14:49:24 +01003657 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003658 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003659MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003660static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3661{
3662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3663
Ronald Cron66dbf912022-02-02 15:33:46 +01003664 /*
3665 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003666 * that were written into the output buffer by the previous handshake step,
3667 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003668 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3669 * We proceed to the next handshake step only when all data from the
3670 * previous one have been sent to the peer, thus we make sure that this is
3671 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3672 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3673 * we have to wait before to go ahead.
3674 * In the case of TLS 1.3, handshake step handlers do not send data to the
3675 * peer. Data are only sent here and through
3676 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003677 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003678 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003679 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3680 return( ret );
3681
3682#if defined(MBEDTLS_SSL_PROTO_DTLS)
3683 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3684 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3685 {
3686 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3687 return( ret );
3688 }
3689#endif /* MBEDTLS_SSL_PROTO_DTLS */
3690
3691 return( ret );
3692}
3693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003695{
Hanno Becker41934dd2021-08-07 19:13:43 +01003696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003697
Hanno Becker41934dd2021-08-07 19:13:43 +01003698 if( ssl == NULL ||
3699 ssl->conf == NULL ||
3700 ssl->handshake == NULL ||
Jerry Yu1fb32992022-10-27 13:18:19 +08003701 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker41934dd2021-08-07 19:13:43 +01003702 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003703 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003704 }
3705
3706 ret = ssl_prepare_handshake_step( ssl );
3707 if( ret != 0 )
3708 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003709
Jerry Yue7047812021-09-13 19:26:39 +08003710 ret = mbedtls_ssl_handle_pending_alert( ssl );
3711 if( ret != 0 )
3712 goto cleanup;
3713
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003714 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3715 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3716 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003719 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003720 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003721 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3722 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003723
Ronald Cron9f0fba32022-02-10 16:45:15 +01003724 switch( ssl->state )
3725 {
3726 case MBEDTLS_SSL_HELLO_REQUEST:
3727 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003728 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003729 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003730
Ronald Cron9f0fba32022-02-10 16:45:15 +01003731 case MBEDTLS_SSL_CLIENT_HELLO:
3732 ret = mbedtls_ssl_write_client_hello( ssl );
3733 break;
3734
3735 default:
3736#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003737 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003738 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3739 else
3740 ret = mbedtls_ssl_handshake_client_step( ssl );
3741#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3742 ret = mbedtls_ssl_handshake_client_step( ssl );
3743#else
3744 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3745#endif
3746 }
Jerry Yub9930e72021-08-06 17:11:51 +08003747 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003748#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003750 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003751 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003752#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003753 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003754 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003755#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003756
3757#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3758 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3759 ret = mbedtls_ssl_handshake_server_step( ssl );
3760#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3761 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003762#endif
3763
Jerry Yue7047812021-09-13 19:26:39 +08003764 if( ret != 0 )
3765 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003766 /* handshake_step return error. And it is same
3767 * with alert_reason.
3768 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003769 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003770 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003771 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003772 goto cleanup;
3773 }
3774 }
3775
3776cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003777 return( ret );
3778}
3779
3780/*
3781 * Perform the SSL handshake
3782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003783int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003784{
3785 int ret = 0;
3786
Hanno Beckera817ea42020-10-20 15:20:23 +01003787 /* Sanity checks */
3788
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003789 if( ssl == NULL || ssl->conf == NULL )
3790 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3791
Hanno Beckera817ea42020-10-20 15:20:23 +01003792#if defined(MBEDTLS_SSL_PROTO_DTLS)
3793 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3794 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3795 {
3796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3797 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3799 }
3800#endif /* MBEDTLS_SSL_PROTO_DTLS */
3801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003803
Hanno Beckera817ea42020-10-20 15:20:23 +01003804 /* Main handshake loop */
Jerry Yu1fb32992022-10-27 13:18:19 +08003805 while( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker1961b702013-01-25 14:49:24 +01003806 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003807 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003808
3809 if( ret != 0 )
3810 break;
3811 }
3812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003814
3815 return( ret );
3816}
3817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003818#if defined(MBEDTLS_SSL_RENEGOTIATION)
3819#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003820/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003821 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003822 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003823MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003824static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003825{
Janos Follath865b3eb2019-12-16 11:46:15 +00003826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003829
3830 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3832 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003833
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003834 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003835 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003836 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003837 return( ret );
3838 }
3839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003841
3842 return( 0 );
3843}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003844#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003845
3846/*
3847 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848 * - any side: calling mbedtls_ssl_renegotiate(),
3849 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3850 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003851 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003852 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003854 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003855int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003856{
Janos Follath865b3eb2019-12-16 11:46:15 +00003857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003860
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003861 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3862 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003863
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003864 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3865 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003867 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003868 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003869 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003870 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003871 ssl->handshake->out_msg_seq = 1;
3872 else
3873 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003874 }
3875#endif
3876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003877 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3878 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003880 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003883 return( ret );
3884 }
3885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003887
3888 return( 0 );
3889}
3890
3891/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003892 * Renegotiate current connection on client,
3893 * or request renegotiation on server
3894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003895int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003896{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003897 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003898
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003899 if( ssl == NULL || ssl->conf == NULL )
3900 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003902#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003903 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003904 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003905 {
Jerry Yu6848a612022-10-27 13:03:26 +08003906 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003907 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003910
3911 /* Did we already try/start sending HelloRequest? */
3912 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003913 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003914
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003915 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003916 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003917#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003919#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003920 /*
3921 * On client, either start the renegotiation process or,
3922 * if already in progress, continue the handshake
3923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003924 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003925 {
Jerry Yu6848a612022-10-27 13:03:26 +08003926 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003928
Hanno Becker40cdaa12020-02-05 10:48:27 +00003929 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003930 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003931 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003932 return( ret );
3933 }
3934 }
3935 else
3936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003937 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003938 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003940 return( ret );
3941 }
3942 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003944
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003945 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003946}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003948
Gilles Peskine9b562d52018-04-25 20:32:43 +02003949void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003950{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003951 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3952
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003953 if( handshake == NULL )
3954 return;
3955
Brett Warrene0edc842021-08-17 09:53:13 +01003956#if defined(MBEDTLS_ECP_C)
3957#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3958 if ( ssl->handshake->group_list_heap_allocated )
3959 mbedtls_free( (void*) handshake->group_list );
3960 handshake->group_list = NULL;
3961#endif /* MBEDTLS_DEPRECATED_REMOVED */
3962#endif /* MBEDTLS_ECP_C */
3963
Ronald Crone68ab4f2022-10-05 12:46:29 +02003964#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08003965#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3966 if ( ssl->handshake->sig_algs_heap_allocated )
3967 mbedtls_free( (void*) handshake->sig_algs );
3968 handshake->sig_algs = NULL;
3969#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003970#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3971 if( ssl->handshake->certificate_request_context )
3972 {
3973 mbedtls_free( (void*) handshake->certificate_request_context );
3974 }
3975#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02003976#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08003977
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003978#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3979 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3980 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003981 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003982 handshake->async_in_progress = 0;
3983 }
3984#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3985
Andrzej Kurek25f27152022-08-17 16:09:31 -04003986#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003987#if defined(MBEDTLS_USE_PSA_CRYPTO)
3988 psa_hash_abort( &handshake->fin_sha256_psa );
3989#else
Jerry Yu2e199812022-12-01 18:57:19 +08003990 mbedtls_sha256_free( &handshake->fin_sha256 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003991#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003992#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04003993#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003994#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003995 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003996#else
Andrzej Kureka242e832022-08-11 10:03:14 -04003997 mbedtls_sha512_free( &handshake->fin_sha384 );
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003998#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003999#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004001#if defined(MBEDTLS_DHM_C)
4002 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00004003#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02004004#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02004006#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004007
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004008#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004009#if defined(MBEDTLS_USE_PSA_CRYPTO)
4010 psa_pake_abort( &handshake->psa_pake_ctx );
4011 psa_destroy_key( handshake->psa_pake_password );
4012 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4013#else
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004014 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Neil Armstrongca7d5062022-05-31 14:43:23 +02004015#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004016#if defined(MBEDTLS_SSL_CLI_C)
4017 mbedtls_free( handshake->ecjpake_cache );
4018 handshake->ecjpake_cache = NULL;
4019 handshake->ecjpake_cache_len = 0;
4020#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004021#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004022
Janos Follath4ae5c292016-02-10 11:27:43 +00004023#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
4024 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004025 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004026 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004027#endif
4028
Ronald Cron73fe8df2022-10-05 14:31:43 +02004029#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004030#if defined(MBEDTLS_USE_PSA_CRYPTO)
4031 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
4032 {
4033 /* The maintenance of the external PSK key slot is the
4034 * user's responsibility. */
4035 if( ssl->handshake->psk_opaque_is_internal )
4036 {
4037 psa_destroy_key( ssl->handshake->psk_opaque );
4038 ssl->handshake->psk_opaque_is_internal = 0;
4039 }
4040 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4041 }
Neil Armstronge952a302022-05-03 10:22:14 +02004042#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004043 if( handshake->psk != NULL )
4044 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004045 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004046 mbedtls_free( handshake->psk );
4047 }
Neil Armstronge952a302022-05-03 10:22:14 +02004048#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004049#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004051#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4052 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004053 /*
4054 * Free only the linked list wrapper, not the keys themselves
4055 * since the belong to the SNI callback
4056 */
Glenn Strauss36872db2022-01-22 05:06:31 -05004057 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004058#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004059
Gilles Peskineeccd8882020-03-10 12:19:08 +01004060#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02004061 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00004062 if( handshake->ecrs_peer_cert != NULL )
4063 {
4064 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
4065 mbedtls_free( handshake->ecrs_peer_cert );
4066 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004067#endif
4068
Hanno Becker75173122019-02-06 16:18:31 +00004069#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4070 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
4071 mbedtls_pk_free( &handshake->peer_pubkey );
4072#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4073
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004074#if defined(MBEDTLS_SSL_CLI_C) && \
4075 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
4076 mbedtls_free( handshake->cookie );
4077#endif /* MBEDTLS_SSL_CLI_C &&
4078 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004079
4080#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00004081 mbedtls_ssl_flight_free( handshake->flight );
4082 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00004083#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004084
Ronald Cronf12b81d2022-03-15 10:42:41 +01004085#if defined(MBEDTLS_ECDH_C) && \
4086 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02004087 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01004088 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00004089#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
4090
Ronald Cron6f135e12021-12-08 16:57:54 +01004091#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08004092 mbedtls_ssl_transform_free( handshake->transform_handshake );
Jerry Yu3d9b5902022-11-04 14:07:25 +08004093 mbedtls_free( handshake->transform_handshake );
4094#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yua1a568c2021-11-09 10:17:21 +08004095 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08004096 mbedtls_free( handshake->transform_earlydata );
Jerry Yu3d9b5902022-11-04 14:07:25 +08004097#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004098#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004099
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004100
4101#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4102 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4103 * processes datagrams and the fact that a datagram is allowed to have
4104 * several records in it, it is possible that the I/O buffers are not
4105 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02004106 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
4107 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004108#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004109
Jerry Yuba9c7272021-10-30 11:54:10 +08004110 /* mbedtls_platform_zeroize MUST be last one in this function */
4111 mbedtls_platform_zeroize( handshake,
4112 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004113}
4114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004115void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00004116{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004117 if( session == NULL )
4118 return;
4119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004120#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00004121 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02004122#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004123
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004124#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004125#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4126 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004127 mbedtls_free( session->hostname );
4128#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004129 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02004130#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004131
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004132 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00004133}
4134
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004135#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004136
4137#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4138#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4139#else
4140#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4141#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4142
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004143#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004144
4145#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4146#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4147#else
4148#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4149#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4150
4151#if defined(MBEDTLS_SSL_ALPN)
4152#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4153#else
4154#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4155#endif /* MBEDTLS_SSL_ALPN */
4156
4157#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4158#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4159#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4160#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4161
4162#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
4163 ( (uint32_t) ( \
4164 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
4165 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
4166 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
4167 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
4168 0u ) )
4169
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004170static unsigned char ssl_serialized_context_header[] = {
4171 MBEDTLS_VERSION_MAJOR,
4172 MBEDTLS_VERSION_MINOR,
4173 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01004174 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4175 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
4176 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4177 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
4178 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004179};
4180
Paul Bakker5121ce52009-01-03 21:22:43 +00004181/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004182 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004183 *
4184 * The format of the serialized data is:
4185 * (in the presentation language of TLS, RFC 8446 section 3)
4186 *
4187 * // header
4188 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004189 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004190 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004191 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004192 * Note: When updating the format, remember to keep these
4193 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004194 *
4195 * // session sub-structure
4196 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4197 * // transform sub-structure
4198 * uint8 random[64]; // ServerHello.random+ClientHello.random
4199 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4200 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4201 * // fields from ssl_context
4202 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4203 * uint64 in_window_top; // DTLS: last validated record seq_num
4204 * uint64 in_window; // DTLS: bitmask for replay protection
4205 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4206 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4207 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4208 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4209 *
4210 * Note that many fields of the ssl_context or sub-structures are not
4211 * serialized, as they fall in one of the following categories:
4212 *
4213 * 1. forced value (eg in_left must be 0)
4214 * 2. pointer to dynamically-allocated memory (eg session, transform)
4215 * 3. value can be re-derived from other data (eg session keys from MS)
4216 * 4. value was temporary (eg content of input buffer)
4217 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004218 */
4219int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4220 unsigned char *buf,
4221 size_t buf_len,
4222 size_t *olen )
4223{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004224 unsigned char *p = buf;
4225 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004226 size_t session_len;
4227 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004228
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004229 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004230 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4231 * this function's documentation.
4232 *
4233 * These are due to assumptions/limitations in the implementation. Some of
4234 * them are likely to stay (no handshake in progress) some might go away
4235 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004236 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004237 /* The initial handshake must be over */
Jerry Yu6848a612022-10-27 13:03:26 +08004238 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004239 {
4240 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004241 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004242 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004243 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004244 {
4245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004246 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004247 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004248 /* Double-check that sub-structures are indeed ready */
4249 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004250 {
4251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004252 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004253 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004254 /* There must be no pending incoming or outgoing data */
4255 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004256 {
4257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004258 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004259 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004260 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004261 {
4262 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
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 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004265 /* Protocol must be DTLS, not TLS */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004266 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004267 {
4268 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004269 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004270 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004271 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004272 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004273 {
4274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004275 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004276 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004277 /* We must be using an AEAD ciphersuite */
4278 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004279 {
4280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004281 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004282 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004283 /* Renegotiation must not be enabled */
4284#if defined(MBEDTLS_SSL_RENEGOTIATION)
4285 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004286 {
4287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004288 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004289 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004290#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004291
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004292 /*
4293 * Version and format identifier
4294 */
4295 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004296
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004297 if( used <= buf_len )
4298 {
4299 memcpy( p, ssl_serialized_context_header,
4300 sizeof( ssl_serialized_context_header ) );
4301 p += sizeof( ssl_serialized_context_header );
4302 }
4303
4304 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004305 * Session (length + data)
4306 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004307 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004308 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
4309 return( ret );
4310
4311 used += 4 + session_len;
4312 if( used <= buf_len )
4313 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004314 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
4315 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004316
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004317 ret = ssl_session_save( ssl->session, 1,
4318 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004319 if( ret != 0 )
4320 return( ret );
4321
4322 p += session_len;
4323 }
4324
4325 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004326 * Transform
4327 */
4328 used += sizeof( ssl->transform->randbytes );
4329 if( used <= buf_len )
4330 {
4331 memcpy( p, ssl->transform->randbytes,
4332 sizeof( ssl->transform->randbytes ) );
4333 p += sizeof( ssl->transform->randbytes );
4334 }
4335
4336#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4337 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
4338 if( used <= buf_len )
4339 {
4340 *p++ = ssl->transform->in_cid_len;
4341 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
4342 p += ssl->transform->in_cid_len;
4343
4344 *p++ = ssl->transform->out_cid_len;
4345 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
4346 p += ssl->transform->out_cid_len;
4347 }
4348#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4349
4350 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004351 * Saved fields from top-level ssl_context structure
4352 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004353 used += 4;
4354 if( used <= buf_len )
4355 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004356 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
4357 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004358 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004359
4360#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4361 used += 16;
4362 if( used <= buf_len )
4363 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004364 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
4365 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004366
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004367 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
4368 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004369 }
4370#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4371
4372#if defined(MBEDTLS_SSL_PROTO_DTLS)
4373 used += 1;
4374 if( used <= buf_len )
4375 {
4376 *p++ = ssl->disable_datagram_packing;
4377 }
4378#endif /* MBEDTLS_SSL_PROTO_DTLS */
4379
Jerry Yuae0b2e22021-10-08 15:21:19 +08004380 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004381 if( used <= buf_len )
4382 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004383 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
4384 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004385 }
4386
4387#if defined(MBEDTLS_SSL_PROTO_DTLS)
4388 used += 2;
4389 if( used <= buf_len )
4390 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004391 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
4392 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004393 }
4394#endif /* MBEDTLS_SSL_PROTO_DTLS */
4395
4396#if defined(MBEDTLS_SSL_ALPN)
4397 {
4398 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02004399 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004400 : 0;
4401
4402 used += 1 + alpn_len;
4403 if( used <= buf_len )
4404 {
4405 *p++ = alpn_len;
4406
4407 if( ssl->alpn_chosen != NULL )
4408 {
4409 memcpy( p, ssl->alpn_chosen, alpn_len );
4410 p += alpn_len;
4411 }
4412 }
4413 }
4414#endif /* MBEDTLS_SSL_ALPN */
4415
4416 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004417 * Done
4418 */
4419 *olen = used;
4420
4421 if( used > buf_len )
4422 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004423
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004424 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
4425
Hanno Becker43aefe22020-02-05 10:44:56 +00004426 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004427}
4428
4429/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004430 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004431 *
4432 * This internal version is wrapped by a public function that cleans up in
4433 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004434 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004435MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004436static int ssl_context_load( mbedtls_ssl_context *ssl,
4437 const unsigned char *buf,
4438 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004439{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004440 const unsigned char *p = buf;
4441 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004442 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004443 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004444#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004445 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004446#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004447
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004448 /*
4449 * The context should have been freshly setup or reset.
4450 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004451 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004452 * renegotiating, or if the user mistakenly loaded a session first.)
4453 */
4454 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4455 ssl->session != NULL )
4456 {
4457 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4458 }
4459
4460 /*
4461 * We can't check that the config matches the initial one, but we can at
4462 * least check it matches the requirements for serializing.
4463 */
4464 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004465 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4466 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004467#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004468 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004469#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004470 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004471 {
4472 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4473 }
4474
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004475 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
4476
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004477 /*
4478 * Check version identifier
4479 */
4480 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
4481 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4482
4483 if( memcmp( p, ssl_serialized_context_header,
4484 sizeof( ssl_serialized_context_header ) ) != 0 )
4485 {
4486 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
4487 }
4488 p += sizeof( ssl_serialized_context_header );
4489
4490 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004491 * Session
4492 */
4493 if( (size_t)( end - p ) < 4 )
4494 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4495
4496 session_len = ( (size_t) p[0] << 24 ) |
4497 ( (size_t) p[1] << 16 ) |
4498 ( (size_t) p[2] << 8 ) |
4499 ( (size_t) p[3] );
4500 p += 4;
4501
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004502 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004503 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004504 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004505 ssl->session_in = ssl->session;
4506 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004507 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004508
4509 if( (size_t)( end - p ) < session_len )
4510 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4511
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004512 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004513 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004514 {
4515 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004516 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004517 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004518
4519 p += session_len;
4520
4521 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004522 * Transform
4523 */
4524
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004525 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004526 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004527#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4528 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004529 ssl->transform_in = ssl->transform;
4530 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004531 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004532#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004533
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004534#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004535 prf_func = ssl_tls12prf_from_cs( ssl->session->ciphersuite );
4536 if( prf_func == NULL )
4537 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4538
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004539 /* Read random bytes and populate structure */
4540 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4541 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004542
Hanno Beckerbd257552021-03-22 06:59:27 +00004543 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004544 ssl->session->ciphersuite,
4545 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004546#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004547 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004548#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Andrzej Kurek894edde2022-09-29 06:31:14 -04004549 prf_func,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004550 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004551 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004552 ssl->conf->endpoint,
4553 ssl );
4554 if( ret != 0 )
4555 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004556#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004557 p += sizeof( ssl->transform->randbytes );
4558
4559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4560 /* Read connection IDs and store them */
4561 if( (size_t)( end - p ) < 1 )
4562 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4563
4564 ssl->transform->in_cid_len = *p++;
4565
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004566 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004567 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4568
4569 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4570 p += ssl->transform->in_cid_len;
4571
4572 ssl->transform->out_cid_len = *p++;
4573
4574 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4575 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4576
4577 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4578 p += ssl->transform->out_cid_len;
4579#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4580
4581 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004582 * Saved fields from top-level ssl_context structure
4583 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004584 if( (size_t)( end - p ) < 4 )
4585 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4586
4587 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4588 ( (uint32_t) p[1] << 16 ) |
4589 ( (uint32_t) p[2] << 8 ) |
4590 ( (uint32_t) p[3] );
4591 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004592
4593#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4594 if( (size_t)( end - p ) < 16 )
4595 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4596
4597 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4598 ( (uint64_t) p[1] << 48 ) |
4599 ( (uint64_t) p[2] << 40 ) |
4600 ( (uint64_t) p[3] << 32 ) |
4601 ( (uint64_t) p[4] << 24 ) |
4602 ( (uint64_t) p[5] << 16 ) |
4603 ( (uint64_t) p[6] << 8 ) |
4604 ( (uint64_t) p[7] );
4605 p += 8;
4606
4607 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4608 ( (uint64_t) p[1] << 48 ) |
4609 ( (uint64_t) p[2] << 40 ) |
4610 ( (uint64_t) p[3] << 32 ) |
4611 ( (uint64_t) p[4] << 24 ) |
4612 ( (uint64_t) p[5] << 16 ) |
4613 ( (uint64_t) p[6] << 8 ) |
4614 ( (uint64_t) p[7] );
4615 p += 8;
4616#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4617
4618#if defined(MBEDTLS_SSL_PROTO_DTLS)
4619 if( (size_t)( end - p ) < 1 )
4620 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4621
4622 ssl->disable_datagram_packing = *p++;
4623#endif /* MBEDTLS_SSL_PROTO_DTLS */
4624
Jerry Yud9a94fe2021-09-28 18:58:59 +08004625 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004626 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004627 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4628 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004629
4630#if defined(MBEDTLS_SSL_PROTO_DTLS)
4631 if( (size_t)( end - p ) < 2 )
4632 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4633
4634 ssl->mtu = ( p[0] << 8 ) | p[1];
4635 p += 2;
4636#endif /* MBEDTLS_SSL_PROTO_DTLS */
4637
4638#if defined(MBEDTLS_SSL_ALPN)
4639 {
4640 uint8_t alpn_len;
4641 const char **cur;
4642
4643 if( (size_t)( end - p ) < 1 )
4644 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4645
4646 alpn_len = *p++;
4647
4648 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4649 {
4650 /* alpn_chosen should point to an item in the configured list */
4651 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4652 {
4653 if( strlen( *cur ) == alpn_len &&
4654 memcmp( p, cur, alpn_len ) == 0 )
4655 {
4656 ssl->alpn_chosen = *cur;
4657 break;
4658 }
4659 }
4660 }
4661
4662 /* can only happen on conf mismatch */
4663 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4664 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4665
4666 p += alpn_len;
4667 }
4668#endif /* MBEDTLS_SSL_ALPN */
4669
4670 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004671 * Forced fields from top-level ssl_context structure
4672 *
4673 * Most of them already set to the correct value by mbedtls_ssl_init() and
4674 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4675 */
4676 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004677 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004678
Hanno Becker361b10d2019-08-30 10:42:49 +01004679 /* Adjust pointers for header fields of outgoing records to
4680 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004681 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004682
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004683#if defined(MBEDTLS_SSL_PROTO_DTLS)
4684 ssl->in_epoch = 1;
4685#endif
4686
4687 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4688 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004689 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4690 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004691 if( ssl->handshake != NULL )
4692 {
4693 mbedtls_ssl_handshake_free( ssl );
4694 mbedtls_free( ssl->handshake );
4695 ssl->handshake = NULL;
4696 }
4697
4698 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004699 * Done - should have consumed entire buffer
4700 */
4701 if( p != end )
4702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004703
4704 return( 0 );
4705}
4706
4707/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004708 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004709 */
4710int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4711 const unsigned char *buf,
4712 size_t len )
4713{
4714 int ret = ssl_context_load( context, buf, len );
4715
4716 if( ret != 0 )
4717 mbedtls_ssl_free( context );
4718
4719 return( ret );
4720}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004721#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004722
4723/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004724 * Free an SSL context
4725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004727{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004728 if( ssl == NULL )
4729 return;
4730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004731 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004732
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004733 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004734 {
sander-visserb8aa2072020-05-06 22:05:13 +02004735#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4736 size_t out_buf_len = ssl->out_buf_len;
4737#else
4738 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4739#endif
4740
Darryl Greenb33cc762019-11-28 14:29:44 +00004741 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004743 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004744 }
4745
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004746 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004747 {
sander-visserb8aa2072020-05-06 22:05:13 +02004748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4749 size_t in_buf_len = ssl->in_buf_len;
4750#else
4751 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4752#endif
4753
Darryl Greenb33cc762019-11-28 14:29:44 +00004754 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004756 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004757 }
4758
Paul Bakker48916f92012-09-16 19:57:18 +00004759 if( ssl->transform )
4760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 mbedtls_ssl_transform_free( ssl->transform );
4762 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004763 }
4764
Jerry Yu2e199812022-12-01 18:57:19 +08004765
Paul Bakker48916f92012-09-16 19:57:18 +00004766 if( ssl->handshake )
4767 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004768 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769 mbedtls_free( ssl->handshake );
Jerry Yu2e199812022-12-01 18:57:19 +08004770
4771#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4772 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004773 mbedtls_free( ssl->transform_negotiate );
Jerry Yu2e199812022-12-01 18:57:19 +08004774#endif
4775
4776 mbedtls_ssl_session_free( ssl->session_negotiate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004777 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004778 }
4779
Ronald Cron6f135e12021-12-08 16:57:54 +01004780#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004781 mbedtls_ssl_transform_free( ssl->transform_application );
4782 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004784
Paul Bakkerc0463502013-02-14 11:19:38 +01004785 if( ssl->session )
4786 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787 mbedtls_ssl_session_free( ssl->session );
4788 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004789 }
4790
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004791#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004792 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004793 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004794 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004796 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004797#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004798
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004799#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004801#endif
4802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004804
Paul Bakker86f04f42013-02-14 11:20:09 +01004805 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004806 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004807}
4808
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004809/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004810 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004811 */
4812void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4813{
4814 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4815}
4816
Gilles Peskineae270bf2021-06-02 00:05:29 +02004817/* The selection should be the same as mbedtls_x509_crt_profile_default in
4818 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004819 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004820 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004821 * about this list.
4822 */
Brett Warrene0edc842021-08-17 09:53:13 +01004823static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004824#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004825 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004826#endif
4827#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004828 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004829#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004830#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004831 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004832#endif
4833#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004834 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004835#endif
4836#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004837 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004838#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004839#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004840 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004841#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004842#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004843 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004844#endif
4845#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004846 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004847#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004848 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004849};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004850
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004851static int ssl_preset_suiteb_ciphersuites[] = {
4852 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4853 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4854 0
4855};
4856
Ronald Crone68ab4f2022-10-05 12:46:29 +02004857#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004858
Jerry Yu909df7b2022-01-22 11:56:27 +08004859/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004860 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004861 * rules SHOULD be upheld.
4862 * - No duplicate entries.
4863 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004864 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004865 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004866 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004867static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004868
Andrzej Kurek25f27152022-08-17 16:09:31 -04004869#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 +08004870 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4871 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004872#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA &&
Jerry Yued5e9f42022-01-26 11:21:34 +08004873 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004874
Andrzej Kurek25f27152022-08-17 16:09:31 -04004875#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 +08004876 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4877 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004878#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004879 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4880
Andrzej Kurek25f27152022-08-17 16:09:31 -04004881#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 +08004882 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4883 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004884#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yued5e9f42022-01-26 11:21:34 +08004885 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004886
Andrzej Kurek25f27152022-08-17 16:09:31 -04004887#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 +08004888 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004889#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 +08004890
Andrzej Kurek25f27152022-08-17 16:09:31 -04004891#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 +08004892 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004893#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 +08004894
Andrzej Kurek25f27152022-08-17 16:09:31 -04004895#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 +08004896 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurek25f27152022-08-17 16:09:31 -04004897#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 +08004898
Andrzej Kurek25f27152022-08-17 16:09:31 -04004899#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 +08004900 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4901#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4902
Andrzej Kurek25f27152022-08-17 16:09:31 -04004903#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 +08004904 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4905#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4906
Andrzej Kurek25f27152022-08-17 16:09:31 -04004907#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 +08004908 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4909#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4910
Gabor Mezei15b95a62022-05-09 16:37:58 +02004911 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004912};
4913
4914/* NOTICE: see above */
4915#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4916static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004917#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004918#if defined(MBEDTLS_ECDSA_C)
4919 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004920#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004921#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4922 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4923#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004924#if defined(MBEDTLS_RSA_C)
4925 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4926#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004927#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004928#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004929#if defined(MBEDTLS_ECDSA_C)
4930 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004931#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004932#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4933 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4934#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004935#if defined(MBEDTLS_RSA_C)
4936 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4937#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004938#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004939#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004940#if defined(MBEDTLS_ECDSA_C)
4941 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004942#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004943#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4944 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4945#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004946#if defined(MBEDTLS_RSA_C)
4947 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4948#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004949#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004950 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004951};
4952#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4953/* NOTICE: see above */
4954static uint16_t ssl_preset_suiteb_sig_algs[] = {
4955
Andrzej Kurek25f27152022-08-17 16:09:31 -04004956#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 +08004957 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4958 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004959#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu909df7b2022-01-22 11:56:27 +08004960 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4961
Andrzej Kurek25f27152022-08-17 16:09:31 -04004962#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 +08004963 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4964 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004965#endif /* MBEDTLS_ECDSA_C && MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA&&
Jerry Yu53037892022-01-25 11:02:06 +08004966 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004967
Andrzej Kurek25f27152022-08-17 16:09:31 -04004968#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 +08004969 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004970#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 +08004971
Andrzej Kurek25f27152022-08-17 16:09:31 -04004972#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 +08004973 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004974#endif /* MBEDTLS_RSA_C && MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu53037892022-01-25 11:02:06 +08004975
Gabor Mezei15b95a62022-05-09 16:37:58 +02004976 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004977};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004978
Jerry Yu909df7b2022-01-22 11:56:27 +08004979/* NOTICE: see above */
4980#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4981static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Andrzej Kurek25f27152022-08-17 16:09:31 -04004982#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004983#if defined(MBEDTLS_ECDSA_C)
4984 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004985#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004986#if defined(MBEDTLS_RSA_C)
4987 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4988#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004989#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Andrzej Kurek25f27152022-08-17 16:09:31 -04004990#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004991#if defined(MBEDTLS_ECDSA_C)
4992 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004993#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004994#if defined(MBEDTLS_RSA_C)
4995 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4996#endif
Andrzej Kurekcccb0442022-08-19 03:42:11 -04004997#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02004998 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004999};
Jerry Yu909df7b2022-01-22 11:56:27 +08005000#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5001
Ronald Crone68ab4f2022-10-05 12:46:29 +02005002#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005003
Brett Warrene0edc842021-08-17 09:53:13 +01005004static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01005005#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005006 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005007#endif
5008#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01005009 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005010#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005011 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005012};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005013
Ronald Crone68ab4f2022-10-05 12:46:29 +02005014#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005015/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005016 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005017MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08005018static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005019{
5020 size_t i, j;
5021 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005022
Gabor Mezei15b95a62022-05-09 16:37:58 +02005023 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005024 {
Jerry Yuf377d642022-01-25 10:43:59 +08005025 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005026 {
Jerry Yuf377d642022-01-25 10:43:59 +08005027 if( sig_algs[i] != sig_algs[j] )
5028 continue;
5029 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
5030 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5031 sig_algs[i], j, i );
5032 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005033 }
5034 }
5035 return( ret );
5036}
5037
Ronald Crone68ab4f2022-10-05 12:46:29 +02005038#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005039
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005040/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005041 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005042 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005043int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005044 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005045{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005046#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005048#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005049
Ronald Crone68ab4f2022-10-05 12:46:29 +02005050#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08005051 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005052 {
5053 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
5054 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5055 }
5056
Jerry Yuf377d642022-01-25 10:43:59 +08005057 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08005058 {
5059 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
5060 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5061 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005062
5063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08005064 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005065 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005066 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005067 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5068 }
5069
Jerry Yuf377d642022-01-25 10:43:59 +08005070 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08005071 {
Jerry Yu909df7b2022-01-22 11:56:27 +08005072 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08005073 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
5074 }
5075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005076#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005077
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005078 /* Use the functions here so that they are covered in tests,
5079 * but otherwise access member directly for efficiency */
5080 mbedtls_ssl_conf_endpoint( conf, endpoint );
5081 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005082
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005083 /*
5084 * Things that are common to all presets
5085 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005086#if defined(MBEDTLS_SSL_CLI_C)
5087 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
5088 {
5089 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5090#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5091 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5092#endif
5093 }
5094#endif
5095
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005096#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5097 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5098#endif
5099
5100#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5101 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5102#endif
5103
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005104#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005105 conf->f_cookie_write = ssl_cookie_write_dummy;
5106 conf->f_cookie_check = ssl_cookie_check_dummy;
5107#endif
5108
5109#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5110 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5111#endif
5112
Janos Follath088ce432017-04-10 12:42:31 +01005113#if defined(MBEDTLS_SSL_SRV_C)
5114 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005115 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005116#endif
5117
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005118#if defined(MBEDTLS_SSL_PROTO_DTLS)
5119 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5120 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5121#endif
5122
5123#if defined(MBEDTLS_SSL_RENEGOTIATION)
5124 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00005125 memset( conf->renego_period, 0x00, 2 );
5126 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005127#endif
5128
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005129#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01005130 if( endpoint == MBEDTLS_SSL_IS_SERVER )
5131 {
5132 const unsigned char dhm_p[] =
5133 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5134 const unsigned char dhm_g[] =
5135 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005136
Hanno Beckere2defad2021-07-24 05:59:17 +01005137 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
5138 dhm_p, sizeof( dhm_p ),
5139 dhm_g, sizeof( dhm_g ) ) ) != 0 )
5140 {
5141 return( ret );
5142 }
5143 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005144#endif
5145
Ronald Cron6f135e12021-12-08 16:57:54 +01005146#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005147
5148#if defined(MBEDTLS_SSL_EARLY_DATA)
5149 mbedtls_ssl_tls13_conf_early_data( conf, MBEDTLS_SSL_EARLY_DATA_DISABLED );
5150#if defined(MBEDTLS_SSL_SRV_C)
5151 mbedtls_ssl_tls13_conf_max_early_data_size(
5152 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE );
5153#endif
5154#endif /* MBEDTLS_SSL_EARLY_DATA */
5155
Jerry Yud0766ec2022-09-22 10:46:57 +08005156#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005157 mbedtls_ssl_conf_new_session_tickets(
5158 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS );
5159#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005160 /*
5161 * Allow all TLS 1.3 key exchange modes by default.
5162 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005163 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005164#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005165
XiaokangQian4d3a6042022-04-21 13:46:17 +00005166 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5167 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005168#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005169 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005170 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005171#else
XiaokangQian060d8672022-04-21 09:24:56 +00005172 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00005173#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00005174 }
5175 else
5176 {
5177#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
5178 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
5179 {
5180 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5181 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5182 }
5183 else
5184 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
5185 {
5186 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5187 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5188 }
5189#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5190 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5191 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5192#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5193 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5194 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5195#else
5196 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
5197#endif
5198 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005199
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005200 /*
5201 * Preset-specific defaults
5202 */
5203 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005204 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005205 /*
5206 * NSA Suite B
5207 */
5208 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005209
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005210 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005211
5212#if defined(MBEDTLS_X509_CRT_PARSE_C)
5213 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005214#endif
5215
Ronald Crone68ab4f2022-10-05 12:46:29 +02005216#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005217#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5218 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5219 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
5220 else
5221#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5222 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005223#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005224
Brett Warrene0edc842021-08-17 09:53:13 +01005225#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5226 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005227#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005228 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005229 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005230
5231 /*
5232 * Default
5233 */
5234 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005235
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005236 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005237
5238#if defined(MBEDTLS_X509_CRT_PARSE_C)
5239 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5240#endif
5241
Ronald Crone68ab4f2022-10-05 12:46:29 +02005242#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005243#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5244 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
5245 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
5246 else
5247#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5248 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005249#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005250
Brett Warrene0edc842021-08-17 09:53:13 +01005251#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
5252 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005253#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005254 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005255
5256#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5257 conf->dhm_min_bitlen = 1024;
5258#endif
5259 }
5260
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261 return( 0 );
5262}
5263
5264/*
5265 * Free mbedtls_ssl_config
5266 */
5267void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
5268{
5269#if defined(MBEDTLS_DHM_C)
5270 mbedtls_mpi_free( &conf->dhm_P );
5271 mbedtls_mpi_free( &conf->dhm_G );
5272#endif
5273
Ronald Cron73fe8df2022-10-05 14:31:43 +02005274#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005275#if defined(MBEDTLS_USE_PSA_CRYPTO)
5276 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
5277 {
Neil Armstrong501c9322022-05-03 09:35:09 +02005278 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5279 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005280#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005281 if( conf->psk != NULL )
5282 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005283 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005284 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00005285 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005286 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005287 }
5288
5289 if( conf->psk_identity != NULL )
5290 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005291 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09005292 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00005293 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005294 conf->psk_identity_len = 0;
5295 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005296#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005297
5298#if defined(MBEDTLS_X509_CRT_PARSE_C)
5299 ssl_key_cert_free( conf->key_cert );
5300#endif
5301
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005302 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005303}
5304
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005305#if defined(MBEDTLS_PK_C) && \
5306 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005307/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005310unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005311{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005312#if defined(MBEDTLS_RSA_C)
5313 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
5314 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005315#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005316#if defined(MBEDTLS_ECDSA_C)
5317 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
5318 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005319#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005320 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005321}
5322
Hanno Becker7e5437a2017-04-28 17:15:26 +01005323unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
5324{
5325 switch( type ) {
5326 case MBEDTLS_PK_RSA:
5327 return( MBEDTLS_SSL_SIG_RSA );
5328 case MBEDTLS_PK_ECDSA:
5329 case MBEDTLS_PK_ECKEY:
5330 return( MBEDTLS_SSL_SIG_ECDSA );
5331 default:
5332 return( MBEDTLS_SSL_SIG_ANON );
5333 }
5334}
5335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005337{
5338 switch( sig )
5339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005340#if defined(MBEDTLS_RSA_C)
5341 case MBEDTLS_SSL_SIG_RSA:
5342 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005343#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344#if defined(MBEDTLS_ECDSA_C)
5345 case MBEDTLS_SSL_SIG_ECDSA:
5346 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005347#endif
5348 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005349 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005350 }
5351}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005352#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005353
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005354/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005355 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005358{
5359 switch( hash )
5360 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005361#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362 case MBEDTLS_SSL_HASH_MD5:
5363 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005364#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005365#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366 case MBEDTLS_SSL_HASH_SHA1:
5367 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005368#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005369#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 case MBEDTLS_SSL_HASH_SHA224:
5371 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005372#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005373#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005374 case MBEDTLS_SSL_HASH_SHA256:
5375 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005376#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005377#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378 case MBEDTLS_SSL_HASH_SHA384:
5379 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005380#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005381#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005382 case MBEDTLS_SSL_HASH_SHA512:
5383 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005384#endif
5385 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005387 }
5388}
5389
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005390/*
5391 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5392 */
5393unsigned char mbedtls_ssl_hash_from_md_alg( int md )
5394{
5395 switch( md )
5396 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005397#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005398 case MBEDTLS_MD_MD5:
5399 return( MBEDTLS_SSL_HASH_MD5 );
5400#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005401#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005402 case MBEDTLS_MD_SHA1:
5403 return( MBEDTLS_SSL_HASH_SHA1 );
5404#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005405#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005406 case MBEDTLS_MD_SHA224:
5407 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005408#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005409#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005410 case MBEDTLS_MD_SHA256:
5411 return( MBEDTLS_SSL_HASH_SHA256 );
5412#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005413#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005414 case MBEDTLS_MD_SHA384:
5415 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005416#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04005417#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005418 case MBEDTLS_MD_SHA512:
5419 return( MBEDTLS_SSL_HASH_SHA512 );
5420#endif
5421 default:
5422 return( MBEDTLS_SSL_HASH_NONE );
5423 }
5424}
5425
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005426/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005427 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005428 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005429 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005430int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005431{
Brett Warrene0edc842021-08-17 09:53:13 +01005432 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005433
Brett Warrene0edc842021-08-17 09:53:13 +01005434 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005435 return( -1 );
5436
Brett Warrene0edc842021-08-17 09:53:13 +01005437 for( ; *group_list != 0; group_list++ )
5438 {
5439 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005440 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01005441 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005442
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005443 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005444}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005445
5446#if defined(MBEDTLS_ECP_C)
5447/*
5448 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5449 */
5450int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
5451{
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005452 const mbedtls_ecp_curve_info *grp_info =
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01005453 mbedtls_ecp_curve_info_from_grp_id( grp_id );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005454
Tom Cosgrovebcc13c92022-08-24 15:08:16 +01005455 if ( grp_info == NULL )
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005456 return -1;
5457
5458 uint16_t tls_id = grp_info->tls_id;
5459
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005460 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
5461}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02005462#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464#if defined(MBEDTLS_X509_CRT_PARSE_C)
5465int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
5466 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005467 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02005468 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005469{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005470 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005471 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005472 const char *ext_oid;
5473 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005476 {
5477 /* Server part of the key exchange */
5478 switch( ciphersuite->key_exchange )
5479 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 case MBEDTLS_KEY_EXCHANGE_RSA:
5481 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005482 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005483 break;
5484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5486 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5487 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5488 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005489 break;
5490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5492 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005493 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005494 break;
5495
5496 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497 case MBEDTLS_KEY_EXCHANGE_NONE:
5498 case MBEDTLS_KEY_EXCHANGE_PSK:
5499 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5500 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005501 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005502 usage = 0;
5503 }
5504 }
5505 else
5506 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005507 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5508 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005509 }
5510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005512 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005513 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005514 ret = -1;
5515 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005518 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519 ext_oid = MBEDTLS_OID_SERVER_AUTH;
5520 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005521 }
5522 else
5523 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5525 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005526 }
5527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005529 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005530 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005531 ret = -1;
5532 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005533
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005534 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005535}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005536#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005537
Jerry Yu148165c2021-09-24 23:20:59 +08005538#if defined(MBEDTLS_USE_PSA_CRYPTO)
5539int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5540 const mbedtls_md_type_t md,
5541 unsigned char *dst,
5542 size_t dst_len,
5543 size_t *olen )
5544{
Ronald Cronf6893e12022-01-07 22:09:01 +01005545 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5546 psa_hash_operation_t *hash_operation_to_clone;
5547 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5548
Jerry Yu148165c2021-09-24 23:20:59 +08005549 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005550
5551 switch( md )
5552 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04005553#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005554 case MBEDTLS_MD_SHA384:
5555 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5556 break;
5557#endif
5558
Andrzej Kurek25f27152022-08-17 16:09:31 -04005559#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cronf6893e12022-01-07 22:09:01 +01005560 case MBEDTLS_MD_SHA256:
5561 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5562 break;
5563#endif
5564
5565 default:
5566 goto exit;
5567 }
5568
5569 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5570 if( status != PSA_SUCCESS )
5571 goto exit;
5572
5573 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5574 if( status != PSA_SUCCESS )
5575 goto exit;
5576
5577exit:
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005578#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5579 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5580 (void) ssl;
5581#endif
Ronald Cronb788c042022-02-15 09:14:15 +01005582 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005583}
5584#else /* MBEDTLS_USE_PSA_CRYPTO */
5585
Andrzej Kurek25f27152022-08-17 16:09:31 -04005586#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005587MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005588static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5589 unsigned char *dst,
5590 size_t dst_len,
5591 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005592{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005593 int ret;
5594 mbedtls_sha512_context sha512;
5595
5596 if( dst_len < 48 )
5597 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5598
5599 mbedtls_sha512_init( &sha512 );
Andrzej Kureka242e832022-08-11 10:03:14 -04005600 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005601
5602 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5603 {
5604 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5605 goto exit;
5606 }
5607
5608 *olen = 48;
5609
5610exit:
5611
5612 mbedtls_sha512_free( &sha512 );
5613 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005614}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005615#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005616
Andrzej Kurek25f27152022-08-17 16:09:31 -04005617#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005618MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005619static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5620 unsigned char *dst,
5621 size_t dst_len,
5622 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005623{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005624 int ret;
5625 mbedtls_sha256_context sha256;
5626
5627 if( dst_len < 32 )
5628 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5629
5630 mbedtls_sha256_init( &sha256 );
5631 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005632
Jerry Yu24c0ec32021-09-09 14:21:07 +08005633 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5634 {
5635 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5636 goto exit;
5637 }
5638
5639 *olen = 32;
5640
5641exit:
5642
5643 mbedtls_sha256_free( &sha256 );
5644 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005645}
Andrzej Kurek25f27152022-08-17 16:09:31 -04005646#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005647
Jerry Yu000f9762021-09-14 11:12:51 +08005648int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5649 const mbedtls_md_type_t md,
5650 unsigned char *dst,
5651 size_t dst_len,
5652 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005653{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005654 switch( md )
5655 {
5656
Andrzej Kurek25f27152022-08-17 16:09:31 -04005657#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005658 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005659 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005660#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005661
Andrzej Kurek25f27152022-08-17 16:09:31 -04005662#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005663 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005664 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Andrzej Kurekcccb0442022-08-19 03:42:11 -04005665#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005666
5667 default:
Andrzej Kurek409248a2022-10-24 10:33:21 -04005668#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
5669 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
5670 (void) ssl;
5671 (void) dst;
5672 (void) dst_len;
5673 (void) olen;
5674#endif
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005675 break;
5676 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005677 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005678}
XiaokangQian647719a2021-12-07 09:16:29 +00005679
Jerry Yu148165c2021-09-24 23:20:59 +08005680#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005681
Ronald Crone68ab4f2022-10-05 12:46:29 +02005682#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005683/* mbedtls_ssl_parse_sig_alg_ext()
5684 *
5685 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5686 * value (TLS 1.3 RFC8446):
5687 * enum {
5688 * ....
5689 * ecdsa_secp256r1_sha256( 0x0403 ),
5690 * ecdsa_secp384r1_sha384( 0x0503 ),
5691 * ecdsa_secp521r1_sha512( 0x0603 ),
5692 * ....
5693 * } SignatureScheme;
5694 *
5695 * struct {
5696 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5697 * } SignatureSchemeList;
5698 *
5699 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5700 * value (TLS 1.2 RFC5246):
5701 * enum {
5702 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5703 * sha512(6), (255)
5704 * } HashAlgorithm;
5705 *
5706 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5707 * SignatureAlgorithm;
5708 *
5709 * struct {
5710 * HashAlgorithm hash;
5711 * SignatureAlgorithm signature;
5712 * } SignatureAndHashAlgorithm;
5713 *
5714 * SignatureAndHashAlgorithm
5715 * supported_signature_algorithms<2..2^16-2>;
5716 *
5717 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5718 * generalization of the TLS 1.2 signature algorithm extension.
5719 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5720 * `SignatureScheme` field of TLS 1.3
5721 *
5722 */
5723int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5724 const unsigned char *buf,
5725 const unsigned char *end )
5726{
5727 const unsigned char *p = buf;
5728 size_t supported_sig_algs_len = 0;
5729 const unsigned char *supported_sig_algs_end;
5730 uint16_t sig_alg;
5731 uint32_t common_idx = 0;
5732
5733 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5734 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5735 p += 2;
5736
5737 memset( ssl->handshake->received_sig_algs, 0,
5738 sizeof(ssl->handshake->received_sig_algs) );
5739
5740 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5741 supported_sig_algs_end = p + supported_sig_algs_len;
5742 while( p < supported_sig_algs_end )
5743 {
5744 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5745 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5746 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005747 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5748 sig_alg,
5749 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005750#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005751 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005752 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5753 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5754 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005755 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005756 }
5757#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005758
Jerry Yuf3b46b52022-06-19 16:52:27 +08005759 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5760 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005761
5762 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5763 {
5764 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5765 common_idx += 1;
5766 }
5767 }
5768 /* Check that we consumed all the message. */
5769 if( p != end )
5770 {
5771 MBEDTLS_SSL_DEBUG_MSG( 1,
5772 ( "Signature algorithms extension length misaligned" ) );
5773 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5774 MBEDTLS_ERR_SSL_DECODE_ERROR );
5775 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5776 }
5777
5778 if( common_idx == 0 )
5779 {
5780 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5781 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5782 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5783 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5784 }
5785
Gabor Mezei15b95a62022-05-09 16:37:58 +02005786 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005787 return( 0 );
5788}
5789
Ronald Crone68ab4f2022-10-05 12:46:29 +02005790#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02005791
Jerry Yudc7bd172022-02-17 13:44:15 +08005792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5793
5794#if defined(MBEDTLS_USE_PSA_CRYPTO)
5795
5796static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5797 mbedtls_svc_key_id_t key,
5798 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005799 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005800 const unsigned char* seed, size_t seed_length,
5801 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005802 const unsigned char* other_secret,
5803 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005804 size_t capacity )
5805{
5806 psa_status_t status;
5807
5808 status = psa_key_derivation_setup( derivation, alg );
5809 if( status != PSA_SUCCESS )
5810 return( status );
5811
5812 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5813 {
5814 status = psa_key_derivation_input_bytes( derivation,
5815 PSA_KEY_DERIVATION_INPUT_SEED,
5816 seed, seed_length );
5817 if( status != PSA_SUCCESS )
5818 return( status );
5819
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005820 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005821 {
5822 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005823 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5824 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005825 if( status != PSA_SUCCESS )
5826 return( status );
5827 }
5828
Jerry Yudc7bd172022-02-17 13:44:15 +08005829 if( mbedtls_svc_key_id_is_null( key ) )
5830 {
5831 status = psa_key_derivation_input_bytes(
5832 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005833 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005834 }
5835 else
5836 {
5837 status = psa_key_derivation_input_key(
5838 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5839 }
5840 if( status != PSA_SUCCESS )
5841 return( status );
5842
5843 status = psa_key_derivation_input_bytes( derivation,
5844 PSA_KEY_DERIVATION_INPUT_LABEL,
5845 label, label_length );
5846 if( status != PSA_SUCCESS )
5847 return( status );
5848 }
5849 else
5850 {
5851 return( PSA_ERROR_NOT_SUPPORTED );
5852 }
5853
5854 status = psa_key_derivation_set_capacity( derivation, capacity );
5855 if( status != PSA_SUCCESS )
5856 return( status );
5857
5858 return( PSA_SUCCESS );
5859}
5860
Andrzej Kurek57d10632022-10-24 10:32:01 -04005861#if defined(PSA_WANT_ALG_SHA_384) || \
5862 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005863MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005864static int tls_prf_generic( mbedtls_md_type_t md_type,
5865 const unsigned char *secret, size_t slen,
5866 const char *label,
5867 const unsigned char *random, size_t rlen,
5868 unsigned char *dstbuf, size_t dlen )
5869{
5870 psa_status_t status;
5871 psa_algorithm_t alg;
5872 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5873 psa_key_derivation_operation_t derivation =
5874 PSA_KEY_DERIVATION_OPERATION_INIT;
5875
5876 if( md_type == MBEDTLS_MD_SHA384 )
5877 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5878 else
5879 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5880
5881 /* Normally a "secret" should be long enough to be impossible to
5882 * find by brute force, and in particular should not be empty. But
5883 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5884 * and for this use case it makes sense to have a 0-length "secret".
5885 * Since the key API doesn't allow importing a key of length 0,
5886 * keep master_key=0, which setup_psa_key_derivation() understands
5887 * to mean a 0-length "secret" input. */
5888 if( slen != 0 )
5889 {
5890 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5891 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5892 psa_set_key_algorithm( &key_attributes, alg );
5893 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5894
5895 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5896 if( status != PSA_SUCCESS )
5897 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5898 }
5899
5900 status = setup_psa_key_derivation( &derivation,
5901 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005902 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005903 random, rlen,
5904 (unsigned char const *) label,
5905 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005906 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005907 dlen );
5908 if( status != PSA_SUCCESS )
5909 {
5910 psa_key_derivation_abort( &derivation );
5911 psa_destroy_key( master_key );
5912 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5913 }
5914
5915 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5916 if( status != PSA_SUCCESS )
5917 {
5918 psa_key_derivation_abort( &derivation );
5919 psa_destroy_key( master_key );
5920 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5921 }
5922
5923 status = psa_key_derivation_abort( &derivation );
5924 if( status != PSA_SUCCESS )
5925 {
5926 psa_destroy_key( master_key );
5927 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5928 }
5929
5930 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5931 status = psa_destroy_key( master_key );
5932 if( status != PSA_SUCCESS )
5933 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5934
5935 return( 0 );
5936}
Andrzej Kurek57d10632022-10-24 10:32:01 -04005937#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08005938#else /* MBEDTLS_USE_PSA_CRYPTO */
5939
Andrzej Kurek57d10632022-10-24 10:32:01 -04005940#if defined(MBEDTLS_MD_C) && \
5941 ( defined(MBEDTLS_SHA256_C) || \
5942 defined(MBEDTLS_SHA384_C) )
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005943MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005944static int tls_prf_generic( mbedtls_md_type_t md_type,
5945 const unsigned char *secret, size_t slen,
5946 const char *label,
5947 const unsigned char *random, size_t rlen,
5948 unsigned char *dstbuf, size_t dlen )
5949{
5950 size_t nb;
5951 size_t i, j, k, md_len;
5952 unsigned char *tmp;
5953 size_t tmp_len = 0;
5954 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5955 const mbedtls_md_info_t *md_info;
5956 mbedtls_md_context_t md_ctx;
5957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5958
5959 mbedtls_md_init( &md_ctx );
5960
5961 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5962 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5963
5964 md_len = mbedtls_md_get_size( md_info );
5965
5966 tmp_len = md_len + strlen( label ) + rlen;
5967 tmp = mbedtls_calloc( 1, tmp_len );
5968 if( tmp == NULL )
5969 {
5970 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5971 goto exit;
5972 }
5973
5974 nb = strlen( label );
5975 memcpy( tmp + md_len, label, nb );
5976 memcpy( tmp + md_len + nb, random, rlen );
5977 nb += rlen;
5978
5979 /*
5980 * Compute P_<hash>(secret, label + random)[0..dlen]
5981 */
5982 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5983 goto exit;
5984
5985 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5986 if( ret != 0 )
5987 goto exit;
5988 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5989 if( ret != 0 )
5990 goto exit;
5991 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5992 if( ret != 0 )
5993 goto exit;
5994
5995 for( i = 0; i < dlen; i += md_len )
5996 {
5997 ret = mbedtls_md_hmac_reset ( &md_ctx );
5998 if( ret != 0 )
5999 goto exit;
6000 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
6001 if( ret != 0 )
6002 goto exit;
6003 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
6004 if( ret != 0 )
6005 goto exit;
6006
6007 ret = mbedtls_md_hmac_reset ( &md_ctx );
6008 if( ret != 0 )
6009 goto exit;
6010 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
6011 if( ret != 0 )
6012 goto exit;
6013 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
6014 if( ret != 0 )
6015 goto exit;
6016
6017 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
6018
6019 for( j = 0; j < k; j++ )
6020 dstbuf[i + j] = h_i[j];
6021 }
6022
6023exit:
6024 mbedtls_md_free( &md_ctx );
6025
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006026 if ( tmp != NULL )
6027 mbedtls_platform_zeroize( tmp, tmp_len );
6028
Jerry Yudc7bd172022-02-17 13:44:15 +08006029 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
6030
6031 mbedtls_free( tmp );
6032
6033 return( ret );
6034}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006035#endif /* MBEDTLS_MD_C && ( MBEDTLS_SHA256_C || MBEDTLS_SHA384_C ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006036#endif /* MBEDTLS_USE_PSA_CRYPTO */
6037
Andrzej Kurek25f27152022-08-17 16:09:31 -04006038#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006039MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08006040static int tls_prf_sha256( const unsigned char *secret, size_t slen,
6041 const char *label,
6042 const unsigned char *random, size_t rlen,
6043 unsigned char *dstbuf, size_t dlen )
6044{
6045 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
6046 label, random, rlen, dstbuf, dlen ) );
6047}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006048#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006049
Andrzej Kurek25f27152022-08-17 16:09:31 -04006050#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006051MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08006052static int tls_prf_sha384( const unsigned char *secret, size_t slen,
6053 const char *label,
6054 const unsigned char *random, size_t rlen,
6055 unsigned char *dstbuf, size_t dlen )
6056{
6057 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
6058 label, random, rlen, dstbuf, dlen ) );
6059}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04006060#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006061
Jerry Yuf009d862022-02-17 14:01:37 +08006062/*
6063 * Set appropriate PRF function and other SSL / TLS1.2 functions
6064 *
6065 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006066 * - hash associated with the ciphersuite (only used by TLS 1.2)
6067 *
6068 * Outputs:
6069 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6070 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006071MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08006072static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08006073 mbedtls_md_type_t hash )
6074{
Andrzej Kurek25f27152022-08-17 16:09:31 -04006075#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron81591aa2022-03-07 09:05:51 +01006076 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08006077 {
6078 handshake->tls_prf = tls_prf_sha384;
6079 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6080 handshake->calc_finished = ssl_calc_finished_tls_sha384;
6081 }
6082 else
6083#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006084#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuf009d862022-02-17 14:01:37 +08006085 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006086 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006087 handshake->tls_prf = tls_prf_sha256;
6088 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6089 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6090 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006091#else
Jerry Yuf009d862022-02-17 14:01:37 +08006092 {
Jerry Yuf009d862022-02-17 14:01:37 +08006093 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006094 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006095 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6096 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006097#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006098
6099 return( 0 );
6100}
Jerry Yud6ab2352022-02-17 14:03:43 +08006101
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006102/*
6103 * Compute master secret if needed
6104 *
6105 * Parameters:
6106 * [in/out] handshake
6107 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6108 * (PSA-PSK) ciphersuite_info, psk_opaque
6109 * [out] premaster (cleared)
6110 * [out] master
6111 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6112 * debug: conf->f_dbg, conf->p_dbg
6113 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006114 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006115 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006116MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006117static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
6118 unsigned char *master,
6119 const mbedtls_ssl_context *ssl )
6120{
6121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6122
6123 /* cf. RFC 5246, Section 8.1:
6124 * "The master secret is always exactly 48 bytes in length." */
6125 size_t const master_secret_len = 48;
6126
6127#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6128 unsigned char session_hash[48];
6129#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6130
6131 /* The label for the KDF used for key expansion.
6132 * This is either "master secret" or "extended master secret"
6133 * depending on whether the Extended Master Secret extension
6134 * is used. */
6135 char const *lbl = "master secret";
6136
Przemek Stekielae4ed302022-04-05 17:15:55 +02006137 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006138 * - If the Extended Master Secret extension is not used,
6139 * this is ClientHello.Random + ServerHello.Random
6140 * (see Sect. 8.1 in RFC 5246).
6141 * - If the Extended Master Secret extension is used,
6142 * this is the transcript of the handshake so far.
6143 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006144 unsigned char const *seed = handshake->randbytes;
6145 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006146
6147#if !defined(MBEDTLS_DEBUG_C) && \
6148 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6149 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
6150 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
6151 ssl = NULL; /* make sure we don't use it except for those cases */
6152 (void) ssl;
6153#endif
6154
6155 if( handshake->resume != 0 )
6156 {
6157 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
6158 return( 0 );
6159 }
6160
6161#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6162 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
6163 {
6164 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006165 seed = session_hash;
6166 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006167
6168 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02006169 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006170 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006171#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006172
Przemek Stekiel99114f32022-04-22 11:20:09 +02006173#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006174 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02006175 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006176 {
6177 /* Perform PSK-to-MS expansion in a single step. */
6178 psa_status_t status;
6179 psa_algorithm_t alg;
6180 mbedtls_svc_key_id_t psk;
6181 psa_key_derivation_operation_t derivation =
6182 PSA_KEY_DERIVATION_OPERATION_INIT;
6183 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
6184
6185 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
6186
6187 psk = mbedtls_ssl_get_opaque_psk( ssl );
6188
6189 if( hash_alg == MBEDTLS_MD_SHA384 )
6190 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
6191 else
6192 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
6193
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006194 size_t other_secret_len = 0;
6195 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006196
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006197 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02006198 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006199 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006200 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006201 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006202 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006203 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006204 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006205 other_secret_len = 48;
6206 other_secret = handshake->premaster + 2;
6207 break;
6208 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006209 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006210 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6211 other_secret = handshake->premaster + 2;
6212 break;
6213 default:
6214 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006215 }
6216
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006217 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006218 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02006219 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006220 (unsigned char const *) lbl,
6221 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006222 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006223 master_secret_len );
6224 if( status != PSA_SUCCESS )
6225 {
6226 psa_key_derivation_abort( &derivation );
6227 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6228 }
6229
6230 status = psa_key_derivation_output_bytes( &derivation,
6231 master,
6232 master_secret_len );
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_abort( &derivation );
6240 if( status != PSA_SUCCESS )
6241 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6242 }
6243 else
6244#endif
6245 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006246#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
6247 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6248 if( handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE )
6249 {
6250 psa_status_t status;
6251 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6252 psa_key_derivation_operation_t derivation =
6253 PSA_KEY_DERIVATION_OPERATION_INIT;
6254
6255 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PMS KDF for ECJPAKE" ) );
6256
6257 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6258
6259 status = psa_key_derivation_setup( &derivation, alg );
6260 if( status != PSA_SUCCESS )
6261 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6262
6263 status = psa_key_derivation_set_capacity( &derivation,
6264 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE );
6265 if( status != PSA_SUCCESS )
6266 {
6267 psa_key_derivation_abort( &derivation );
6268 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6269 }
6270
6271 status = psa_pake_get_implicit_key( &handshake->psa_pake_ctx,
6272 &derivation );
6273 if( status != PSA_SUCCESS )
6274 {
6275 psa_key_derivation_abort( &derivation );
6276 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6277 }
6278
6279 status = psa_key_derivation_output_bytes( &derivation,
6280 handshake->premaster,
6281 handshake->pmslen );
6282 if( status != PSA_SUCCESS )
6283 {
6284 psa_key_derivation_abort( &derivation );
6285 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6286 }
6287
6288 status = psa_key_derivation_abort( &derivation );
6289 if( status != PSA_SUCCESS )
6290 {
6291 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
6292 }
6293 }
6294#endif
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006295 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02006296 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006297 master,
6298 master_secret_len );
6299 if( ret != 0 )
6300 {
6301 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
6302 return( ret );
6303 }
6304
6305 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
6306 handshake->premaster,
6307 handshake->pmslen );
6308
6309 mbedtls_platform_zeroize( handshake->premaster,
6310 sizeof(handshake->premaster) );
6311 }
6312
6313 return( 0 );
6314}
6315
Jerry Yud62f87e2022-02-17 14:09:02 +08006316int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
6317{
6318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6319 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6320 ssl->handshake->ciphersuite_info;
6321
6322 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
6323
6324 /* Set PRF, calc_verify and calc_finished function pointers */
6325 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08006326 ciphersuite_info->mac );
6327 if( ret != 0 )
6328 {
6329 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
6330 return( ret );
6331 }
6332
6333 /* Compute master secret if needed */
6334 ret = ssl_compute_master( ssl->handshake,
6335 ssl->session_negotiate->master,
6336 ssl );
6337 if( ret != 0 )
6338 {
6339 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
6340 return( ret );
6341 }
6342
6343 /* Swap the client and server random values:
6344 * - MS derivation wanted client+server (RFC 5246 8.1)
6345 * - key derivation wants server+client (RFC 5246 6.3) */
6346 {
6347 unsigned char tmp[64];
6348 memcpy( tmp, ssl->handshake->randbytes, 64 );
6349 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
6350 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
6351 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
6352 }
6353
6354 /* Populate transform structure */
6355 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
6356 ssl->session_negotiate->ciphersuite,
6357 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006358#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08006359 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006360#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08006361 ssl->handshake->tls_prf,
6362 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04006363 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08006364 ssl->conf->endpoint,
6365 ssl );
6366 if( ret != 0 )
6367 {
6368 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
6369 return( ret );
6370 }
6371
6372 /* We no longer need Server/ClientHello.random values */
6373 mbedtls_platform_zeroize( ssl->handshake->randbytes,
6374 sizeof( ssl->handshake->randbytes ) );
6375
6376 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
6377
6378 return( 0 );
6379}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006380
Ronald Cron4dcbca92022-03-07 10:21:40 +01006381int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
6382{
Ronald Cron4dcbca92022-03-07 10:21:40 +01006383 switch( md )
6384 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04006385#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006386 case MBEDTLS_SSL_HASH_SHA384:
6387 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6388 break;
6389#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04006390#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006391 case MBEDTLS_SSL_HASH_SHA256:
6392 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6393 break;
6394#endif
6395 default:
6396 return( -1 );
6397 }
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006398#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
6399 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
6400 (void) ssl;
6401#endif
Ronald Cronc2f13a02022-03-07 10:25:24 +01006402 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01006403}
6404
Andrzej Kurek25f27152022-08-17 16:09:31 -04006405#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006406void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
6407 unsigned char *hash,
6408 size_t *hlen )
6409{
6410#if defined(MBEDTLS_USE_PSA_CRYPTO)
6411 size_t hash_size;
6412 psa_status_t status;
6413 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
6414
6415 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
6416 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6417 if( status != PSA_SUCCESS )
6418 {
6419 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6420 return;
6421 }
6422
6423 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
6424 if( status != PSA_SUCCESS )
6425 {
6426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6427 return;
6428 }
6429
6430 *hlen = 32;
6431 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
6432 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
6433#else
6434 mbedtls_sha256_context sha256;
6435
6436 mbedtls_sha256_init( &sha256 );
6437
6438 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
6439
6440 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6441 mbedtls_sha256_finish( &sha256, hash );
6442
6443 *hlen = 32;
6444
6445 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
6446 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
6447
6448 mbedtls_sha256_free( &sha256 );
6449#endif /* MBEDTLS_USE_PSA_CRYPTO */
6450 return;
6451}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006452#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006453
Andrzej Kurek25f27152022-08-17 16:09:31 -04006454#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006455void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
6456 unsigned char *hash,
6457 size_t *hlen )
6458{
6459#if defined(MBEDTLS_USE_PSA_CRYPTO)
6460 size_t hash_size;
6461 psa_status_t status;
6462 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
6463
6464 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
6465 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6466 if( status != PSA_SUCCESS )
6467 {
6468 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6469 return;
6470 }
6471
6472 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
6473 if( status != PSA_SUCCESS )
6474 {
6475 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6476 return;
6477 }
6478
6479 *hlen = 48;
6480 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
6481 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
6482#else
6483 mbedtls_sha512_context sha512;
6484
6485 mbedtls_sha512_init( &sha512 );
6486
6487 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
6488
Andrzej Kureka242e832022-08-11 10:03:14 -04006489 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yuc1cb3842022-02-17 14:13:48 +08006490 mbedtls_sha512_finish( &sha512, hash );
6491
6492 *hlen = 48;
6493
6494 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
6495 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
6496
6497 mbedtls_sha512_free( &sha512 );
6498#endif /* MBEDTLS_USE_PSA_CRYPTO */
6499 return;
6500}
Andrzej Kurek25f27152022-08-17 16:09:31 -04006501#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006502
Neil Armstrong80f6f322022-05-03 17:56:38 +02006503#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6504 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006505int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
6506{
6507 unsigned char *p = ssl->handshake->premaster;
6508 unsigned char *end = p + sizeof( ssl->handshake->premaster );
6509 const unsigned char *psk = NULL;
6510 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006511 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08006512
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006513 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08006514 {
6515 /*
6516 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006517 * checked before calling this function.
6518 *
6519 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006520 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006521 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006522 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
6523 {
6524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6525 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6526 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006527 }
6528
6529 /*
6530 * PMS = struct {
6531 * opaque other_secret<0..2^16-1>;
6532 * opaque psk<0..2^16-1>;
6533 * };
6534 * with "other_secret" depending on the particular key exchange
6535 */
6536#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
6537 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
6538 {
6539 if( end - p < 2 )
6540 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6541
6542 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6543 p += 2;
6544
6545 if( end < p || (size_t)( end - p ) < psk_len )
6546 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6547
6548 memset( p, 0, psk_len );
6549 p += psk_len;
6550 }
6551 else
6552#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6553#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
6554 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6555 {
6556 /*
6557 * other_secret already set by the ClientKeyExchange message,
6558 * and is 48 bytes long
6559 */
6560 if( end - p < 2 )
6561 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6562
6563 *p++ = 0;
6564 *p++ = 48;
6565 p += 48;
6566 }
6567 else
6568#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6569#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
6570 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
6571 {
6572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6573 size_t len;
6574
6575 /* Write length only when we know the actual value */
6576 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
6577 p + 2, end - ( p + 2 ), &len,
6578 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6579 {
6580 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
6581 return( ret );
6582 }
6583 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
6584 p += 2 + len;
6585
6586 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
6587 }
6588 else
6589#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006590#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08006591 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
6592 {
6593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6594 size_t zlen;
6595
6596 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6597 p + 2, end - ( p + 2 ),
6598 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6599 {
6600 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6601 return( ret );
6602 }
6603
6604 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6605 p += 2 + zlen;
6606
6607 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6608 MBEDTLS_DEBUG_ECDH_Z );
6609 }
6610 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006611#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006612 {
6613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6615 }
6616
6617 /* opaque psk<0..2^16-1>; */
6618 if( end - p < 2 )
6619 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6620
6621 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6622 p += 2;
6623
6624 if( end < p || (size_t)( end - p ) < psk_len )
6625 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6626
6627 memcpy( p, psk, psk_len );
6628 p += psk_len;
6629
6630 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6631
6632 return( 0 );
6633}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006634#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006635
6636#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006637MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006638static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6639
6640#if defined(MBEDTLS_SSL_PROTO_DTLS)
6641int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6642{
6643 /* If renegotiation is not enforced, retransmit until we would reach max
6644 * timeout if we were using the usual handshake doubling scheme */
6645 if( ssl->conf->renego_max_records < 0 )
6646 {
6647 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6648 unsigned char doublings = 1;
6649
6650 while( ratio != 0 )
6651 {
6652 ++doublings;
6653 ratio >>= 1;
6654 }
6655
6656 if( ++ssl->renego_records_seen > doublings )
6657 {
6658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6659 return( 0 );
6660 }
6661 }
6662
6663 return( ssl_write_hello_request( ssl ) );
6664}
6665#endif
6666#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006667
Jerry Yud9526692022-02-17 14:23:47 +08006668/*
6669 * Handshake functions
6670 */
6671#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6672/* No certificate support -> dummy functions */
6673int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6674{
6675 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6676 ssl->handshake->ciphersuite_info;
6677
6678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6679
6680 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6681 {
6682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6683 ssl->state++;
6684 return( 0 );
6685 }
6686
6687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6688 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6689}
6690
6691int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6692{
6693 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6694 ssl->handshake->ciphersuite_info;
6695
6696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6697
6698 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6699 {
6700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6701 ssl->state++;
6702 return( 0 );
6703 }
6704
6705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6707}
6708
6709#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6710/* Some certificate support -> implement write and parse */
6711
6712int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6713{
6714 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6715 size_t i, n;
6716 const mbedtls_x509_crt *crt;
6717 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6718 ssl->handshake->ciphersuite_info;
6719
6720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6721
6722 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6723 {
6724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6725 ssl->state++;
6726 return( 0 );
6727 }
6728
6729#if defined(MBEDTLS_SSL_CLI_C)
6730 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6731 {
6732 if( ssl->handshake->client_auth == 0 )
6733 {
6734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6735 ssl->state++;
6736 return( 0 );
6737 }
6738 }
6739#endif /* MBEDTLS_SSL_CLI_C */
6740#if defined(MBEDTLS_SSL_SRV_C)
6741 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6742 {
6743 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6744 {
6745 /* Should never happen because we shouldn't have picked the
6746 * ciphersuite if we don't have a certificate. */
6747 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6748 }
6749 }
6750#endif
6751
6752 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6753
6754 /*
6755 * 0 . 0 handshake type
6756 * 1 . 3 handshake length
6757 * 4 . 6 length of all certs
6758 * 7 . 9 length of cert. 1
6759 * 10 . n-1 peer certificate
6760 * n . n+2 length of cert. 2
6761 * n+3 . ... upper level cert, etc.
6762 */
6763 i = 7;
6764 crt = mbedtls_ssl_own_cert( ssl );
6765
6766 while( crt != NULL )
6767 {
6768 n = crt->raw.len;
6769 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6770 {
6771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6772 " > %" MBEDTLS_PRINTF_SIZET,
6773 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6774 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6775 }
6776
6777 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6778 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6779 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6780
6781 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6782 i += n; crt = crt->next;
6783 }
6784
6785 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6786 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6787 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6788
6789 ssl->out_msglen = i;
6790 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6791 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6792
6793 ssl->state++;
6794
6795 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6796 {
6797 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6798 return( ret );
6799 }
6800
6801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6802
6803 return( ret );
6804}
6805
6806#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6807
6808#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006809MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006810static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6811 unsigned char *crt_buf,
6812 size_t crt_buf_len )
6813{
6814 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6815
6816 if( peer_crt == NULL )
6817 return( -1 );
6818
6819 if( peer_crt->raw.len != crt_buf_len )
6820 return( -1 );
6821
6822 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6823}
6824#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006825MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006826static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6827 unsigned char *crt_buf,
6828 size_t crt_buf_len )
6829{
6830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6831 unsigned char const * const peer_cert_digest =
6832 ssl->session->peer_cert_digest;
6833 mbedtls_md_type_t const peer_cert_digest_type =
6834 ssl->session->peer_cert_digest_type;
6835 mbedtls_md_info_t const * const digest_info =
6836 mbedtls_md_info_from_type( peer_cert_digest_type );
6837 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6838 size_t digest_len;
6839
6840 if( peer_cert_digest == NULL || digest_info == NULL )
6841 return( -1 );
6842
6843 digest_len = mbedtls_md_get_size( digest_info );
6844 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6845 return( -1 );
6846
6847 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6848 if( ret != 0 )
6849 return( -1 );
6850
6851 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6852}
6853#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6854#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6855
6856/*
6857 * Once the certificate message is read, parse it into a cert chain and
6858 * perform basic checks, but leave actual verification to the caller
6859 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006860MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006861static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6862 mbedtls_x509_crt *chain )
6863{
6864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6865#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6866 int crt_cnt=0;
6867#endif
6868 size_t i, n;
6869 uint8_t alert;
6870
6871 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6872 {
6873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6874 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6875 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6876 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6877 }
6878
6879 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6880 {
6881 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6882 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6883 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6884 }
6885
6886 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6887 {
6888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6889 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6890 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6891 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6892 }
6893
6894 i = mbedtls_ssl_hs_hdr_len( ssl );
6895
6896 /*
6897 * Same message structure as in mbedtls_ssl_write_certificate()
6898 */
6899 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6900
6901 if( ssl->in_msg[i] != 0 ||
6902 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6903 {
6904 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6905 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6906 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6907 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6908 }
6909
6910 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6911 i += 3;
6912
6913 /* Iterate through and parse the CRTs in the provided chain. */
6914 while( i < ssl->in_hslen )
6915 {
6916 /* Check that there's room for the next CRT's length fields. */
6917 if ( i + 3 > ssl->in_hslen ) {
6918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6919 mbedtls_ssl_send_alert_message( ssl,
6920 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6921 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6922 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6923 }
6924 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6925 * anything beyond 2**16 ~ 64K. */
6926 if( ssl->in_msg[i] != 0 )
6927 {
6928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6929 mbedtls_ssl_send_alert_message( ssl,
6930 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6931 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6932 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6933 }
6934
6935 /* Read length of the next CRT in the chain. */
6936 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6937 | (unsigned int) ssl->in_msg[i + 2];
6938 i += 3;
6939
6940 if( n < 128 || i + n > ssl->in_hslen )
6941 {
6942 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6943 mbedtls_ssl_send_alert_message( ssl,
6944 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6945 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6946 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6947 }
6948
6949 /* Check if we're handling the first CRT in the chain. */
6950#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6951 if( crt_cnt++ == 0 &&
6952 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6953 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6954 {
6955 /* During client-side renegotiation, check that the server's
6956 * end-CRTs hasn't changed compared to the initial handshake,
6957 * mitigating the triple handshake attack. On success, reuse
6958 * the original end-CRT instead of parsing it again. */
6959 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6960 if( ssl_check_peer_crt_unchanged( ssl,
6961 &ssl->in_msg[i],
6962 n ) != 0 )
6963 {
6964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6965 mbedtls_ssl_send_alert_message( ssl,
6966 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6967 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6968 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6969 }
6970
6971 /* Now we can safely free the original chain. */
6972 ssl_clear_peer_cert( ssl->session );
6973 }
6974#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6975
6976 /* Parse the next certificate in the chain. */
6977#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6978 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6979#else
6980 /* If we don't need to store the CRT chain permanently, parse
6981 * it in-place from the input buffer instead of making a copy. */
6982 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6983#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6984 switch( ret )
6985 {
6986 case 0: /*ok*/
6987 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6988 /* Ignore certificate with an unknown algorithm: maybe a
6989 prior certificate was already trusted. */
6990 break;
6991
6992 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6993 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6994 goto crt_parse_der_failed;
6995
6996 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6997 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6998 goto crt_parse_der_failed;
6999
7000 default:
7001 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
7002 crt_parse_der_failed:
7003 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
7004 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
7005 return( ret );
7006 }
7007
7008 i += n;
7009 }
7010
7011 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
7012 return( 0 );
7013}
7014
7015#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007016MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007017static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
7018{
7019 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7020 return( -1 );
7021
7022 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
7023 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7024 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
7025 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
7026 {
Ronald Cron19385882022-06-15 16:26:13 +02007027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08007028 return( 0 );
7029 }
7030 return( -1 );
7031}
7032#endif /* MBEDTLS_SSL_SRV_C */
7033
7034/* Check if a certificate message is expected.
7035 * Return either
7036 * - SSL_CERTIFICATE_EXPECTED, or
7037 * - SSL_CERTIFICATE_SKIP
7038 * indicating whether a Certificate message is expected or not.
7039 */
7040#define SSL_CERTIFICATE_EXPECTED 0
7041#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007042MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007043static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
7044 int authmode )
7045{
7046 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7047 ssl->handshake->ciphersuite_info;
7048
7049 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
7050 return( SSL_CERTIFICATE_SKIP );
7051
7052#if defined(MBEDTLS_SSL_SRV_C)
7053 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7054 {
7055 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
7056 return( SSL_CERTIFICATE_SKIP );
7057
7058 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7059 {
7060 ssl->session_negotiate->verify_result =
7061 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
7062 return( SSL_CERTIFICATE_SKIP );
7063 }
7064 }
7065#else
7066 ((void) authmode);
7067#endif /* MBEDTLS_SSL_SRV_C */
7068
7069 return( SSL_CERTIFICATE_EXPECTED );
7070}
7071
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007072MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007073static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
7074 int authmode,
7075 mbedtls_x509_crt *chain,
7076 void *rs_ctx )
7077{
7078 int ret = 0;
7079 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7080 ssl->handshake->ciphersuite_info;
7081 int have_ca_chain = 0;
7082
7083 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7084 void *p_vrfy;
7085
7086 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
7087 return( 0 );
7088
7089 if( ssl->f_vrfy != NULL )
7090 {
7091 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
7092 f_vrfy = ssl->f_vrfy;
7093 p_vrfy = ssl->p_vrfy;
7094 }
7095 else
7096 {
7097 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
7098 f_vrfy = ssl->conf->f_vrfy;
7099 p_vrfy = ssl->conf->p_vrfy;
7100 }
7101
7102 /*
7103 * Main check: verify certificate
7104 */
7105#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
7106 if( ssl->conf->f_ca_cb != NULL )
7107 {
7108 ((void) rs_ctx);
7109 have_ca_chain = 1;
7110
7111 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
7112 ret = mbedtls_x509_crt_verify_with_ca_cb(
7113 chain,
7114 ssl->conf->f_ca_cb,
7115 ssl->conf->p_ca_cb,
7116 ssl->conf->cert_profile,
7117 ssl->hostname,
7118 &ssl->session_negotiate->verify_result,
7119 f_vrfy, p_vrfy );
7120 }
7121 else
7122#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7123 {
7124 mbedtls_x509_crt *ca_chain;
7125 mbedtls_x509_crl *ca_crl;
7126
7127#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7128 if( ssl->handshake->sni_ca_chain != NULL )
7129 {
7130 ca_chain = ssl->handshake->sni_ca_chain;
7131 ca_crl = ssl->handshake->sni_ca_crl;
7132 }
7133 else
7134#endif
7135 {
7136 ca_chain = ssl->conf->ca_chain;
7137 ca_crl = ssl->conf->ca_crl;
7138 }
7139
7140 if( ca_chain != NULL )
7141 have_ca_chain = 1;
7142
7143 ret = mbedtls_x509_crt_verify_restartable(
7144 chain,
7145 ca_chain, ca_crl,
7146 ssl->conf->cert_profile,
7147 ssl->hostname,
7148 &ssl->session_negotiate->verify_result,
7149 f_vrfy, p_vrfy, rs_ctx );
7150 }
7151
7152 if( ret != 0 )
7153 {
7154 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
7155 }
7156
7157#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7158 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
7159 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
7160#endif
7161
7162 /*
7163 * Secondary checks: always done, but change 'ret' only if it was 0
7164 */
7165
7166#if defined(MBEDTLS_ECP_C)
7167 {
7168 const mbedtls_pk_context *pk = &chain->pk;
7169
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007170 /* If certificate uses an EC key, make sure the curve is OK.
7171 * This is a public key, so it can't be opaque, so can_do() is a good
7172 * enough check to ensure pk_ec() is safe to use here. */
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007173 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) )
Jerry Yud9526692022-02-17 14:23:47 +08007174 {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007175 /* and in the unlikely case the above assumption no longer holds
7176 * we are making sure that pk_ec() here does not return a NULL
7177 */
7178 const mbedtls_ecp_keypair *ec = mbedtls_pk_ec( *pk );
7179 if( ec == NULL )
7180 {
Tom Cosgrove20c11372022-08-24 15:06:13 +01007181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_pk_ec() returned NULL" ) );
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007182 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7183 }
Jerry Yud9526692022-02-17 14:23:47 +08007184
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007185 if( mbedtls_ssl_check_curve( ssl, ec->grp.id ) != 0 )
7186 {
7187 ssl->session_negotiate->verify_result |=
7188 MBEDTLS_X509_BADCERT_BAD_KEY;
7189
7190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
7191 if( ret == 0 )
7192 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7193 }
Jerry Yud9526692022-02-17 14:23:47 +08007194 }
7195 }
7196#endif /* MBEDTLS_ECP_C */
7197
7198 if( mbedtls_ssl_check_cert_usage( chain,
7199 ciphersuite_info,
7200 ! ssl->conf->endpoint,
7201 &ssl->session_negotiate->verify_result ) != 0 )
7202 {
7203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
7204 if( ret == 0 )
7205 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
7206 }
7207
7208 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7209 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7210 * with details encoded in the verification flags. All other kinds
7211 * of error codes, including those from the user provided f_vrfy
7212 * functions, are treated as fatal and lead to a failure of
7213 * ssl_parse_certificate even if verification was optional. */
7214 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7215 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7216 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
7217 {
7218 ret = 0;
7219 }
7220
7221 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
7222 {
7223 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
7224 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7225 }
7226
7227 if( ret != 0 )
7228 {
7229 uint8_t alert;
7230
7231 /* The certificate may have been rejected for several reasons.
7232 Pick one and send the corresponding alert. Which alert to send
7233 may be a subject of debate in some cases. */
7234 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
7235 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
7236 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
7237 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
7238 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
7239 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7240 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
7241 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7242 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
7243 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7244 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
7245 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7246 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
7247 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7248 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
7249 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
7250 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
7251 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
7252 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
7253 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
7254 else
7255 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
7256 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7257 alert );
7258 }
7259
7260#if defined(MBEDTLS_DEBUG_C)
7261 if( ssl->session_negotiate->verify_result != 0 )
7262 {
7263 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
7264 (unsigned int) ssl->session_negotiate->verify_result ) );
7265 }
7266 else
7267 {
7268 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
7269 }
7270#endif /* MBEDTLS_DEBUG_C */
7271
7272 return( ret );
7273}
7274
7275#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007276MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007277static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
7278 unsigned char *start, size_t len )
7279{
7280 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7281 /* Remember digest of the peer's end-CRT. */
7282 ssl->session_negotiate->peer_cert_digest =
7283 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
7284 if( ssl->session_negotiate->peer_cert_digest == NULL )
7285 {
7286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
7287 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
7288 mbedtls_ssl_send_alert_message( ssl,
7289 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7290 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7291
7292 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
7293 }
7294
7295 ret = mbedtls_md( mbedtls_md_info_from_type(
7296 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
7297 start, len,
7298 ssl->session_negotiate->peer_cert_digest );
7299
7300 ssl->session_negotiate->peer_cert_digest_type =
7301 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7302 ssl->session_negotiate->peer_cert_digest_len =
7303 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7304
7305 return( ret );
7306}
7307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007308MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08007309static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
7310 unsigned char *start, size_t len )
7311{
7312 unsigned char *end = start + len;
7313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7314
7315 /* Make a copy of the peer's raw public key. */
7316 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
7317 ret = mbedtls_pk_parse_subpubkey( &start, end,
7318 &ssl->handshake->peer_pubkey );
7319 if( ret != 0 )
7320 {
7321 /* We should have parsed the public key before. */
7322 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7323 }
7324
7325 return( 0 );
7326}
7327#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7328
7329int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
7330{
7331 int ret = 0;
7332 int crt_expected;
7333#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7334 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7335 ? ssl->handshake->sni_authmode
7336 : ssl->conf->authmode;
7337#else
7338 const int authmode = ssl->conf->authmode;
7339#endif
7340 void *rs_ctx = NULL;
7341 mbedtls_x509_crt *chain = NULL;
7342
7343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
7344
7345 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
7346 if( crt_expected == SSL_CERTIFICATE_SKIP )
7347 {
7348 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
7349 goto exit;
7350 }
7351
7352#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7353 if( ssl->handshake->ecrs_enabled &&
7354 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
7355 {
7356 chain = ssl->handshake->ecrs_peer_cert;
7357 ssl->handshake->ecrs_peer_cert = NULL;
7358 goto crt_verify;
7359 }
7360#endif
7361
7362 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7363 {
7364 /* mbedtls_ssl_read_record may have sent an alert already. We
7365 let it decide whether to alert. */
7366 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7367 goto exit;
7368 }
7369
7370#if defined(MBEDTLS_SSL_SRV_C)
7371 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
7372 {
7373 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7374
7375 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
7376 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
7377
7378 goto exit;
7379 }
7380#endif /* MBEDTLS_SSL_SRV_C */
7381
7382 /* Clear existing peer CRT structure in case we tried to
7383 * reuse a session but it failed, and allocate a new one. */
7384 ssl_clear_peer_cert( ssl->session_negotiate );
7385
7386 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
7387 if( chain == NULL )
7388 {
7389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7390 sizeof( mbedtls_x509_crt ) ) );
7391 mbedtls_ssl_send_alert_message( ssl,
7392 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7393 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7394
7395 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7396 goto exit;
7397 }
7398 mbedtls_x509_crt_init( chain );
7399
7400 ret = ssl_parse_certificate_chain( ssl, chain );
7401 if( ret != 0 )
7402 goto exit;
7403
7404#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7405 if( ssl->handshake->ecrs_enabled)
7406 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
7407
7408crt_verify:
7409 if( ssl->handshake->ecrs_enabled)
7410 rs_ctx = &ssl->handshake->ecrs_ctx;
7411#endif
7412
7413 ret = ssl_parse_certificate_verify( ssl, authmode,
7414 chain, rs_ctx );
7415 if( ret != 0 )
7416 goto exit;
7417
7418#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7419 {
7420 unsigned char *crt_start, *pk_start;
7421 size_t crt_len, pk_len;
7422
7423 /* We parse the CRT chain without copying, so
7424 * these pointers point into the input buffer,
7425 * and are hence still valid after freeing the
7426 * CRT chain. */
7427
7428 crt_start = chain->raw.p;
7429 crt_len = chain->raw.len;
7430
7431 pk_start = chain->pk_raw.p;
7432 pk_len = chain->pk_raw.len;
7433
7434 /* Free the CRT structures before computing
7435 * digest and copying the peer's public key. */
7436 mbedtls_x509_crt_free( chain );
7437 mbedtls_free( chain );
7438 chain = NULL;
7439
7440 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
7441 if( ret != 0 )
7442 goto exit;
7443
7444 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
7445 if( ret != 0 )
7446 goto exit;
7447 }
7448#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7449 /* Pass ownership to session structure. */
7450 ssl->session_negotiate->peer_cert = chain;
7451 chain = NULL;
7452#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7453
7454 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
7455
7456exit:
7457
7458 if( ret == 0 )
7459 ssl->state++;
7460
7461#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
7462 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
7463 {
7464 ssl->handshake->ecrs_peer_cert = chain;
7465 chain = NULL;
7466 }
7467#endif
7468
7469 if( chain != NULL )
7470 {
7471 mbedtls_x509_crt_free( chain );
7472 mbedtls_free( chain );
7473 }
7474
7475 return( ret );
7476}
7477#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7478
Andrzej Kurek25f27152022-08-17 16:09:31 -04007479#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007480static void ssl_calc_finished_tls_sha256(
7481 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
7482{
7483 int len = 12;
7484 const char *sender;
7485 unsigned char padbuf[32];
7486#if defined(MBEDTLS_USE_PSA_CRYPTO)
7487 size_t hash_size;
7488 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
7489 psa_status_t status;
7490#else
7491 mbedtls_sha256_context sha256;
7492#endif
7493
7494 mbedtls_ssl_session *session = ssl->session_negotiate;
7495 if( !session )
7496 session = ssl->session;
7497
7498 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
7499 ? "client finished"
7500 : "server finished";
7501
7502#if defined(MBEDTLS_USE_PSA_CRYPTO)
7503 sha256_psa = psa_hash_operation_init();
7504
7505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
7506
7507 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
7508 if( status != PSA_SUCCESS )
7509 {
7510 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7511 return;
7512 }
7513
7514 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
7515 if( status != PSA_SUCCESS )
7516 {
7517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7518 return;
7519 }
7520 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
7521#else
7522
7523 mbedtls_sha256_init( &sha256 );
7524
7525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
7526
7527 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
7528
7529 /*
7530 * TLSv1.2:
7531 * hash = PRF( master, finished_label,
7532 * Hash( handshake ) )[0.11]
7533 */
7534
7535#if !defined(MBEDTLS_SHA256_ALT)
7536 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
7537 sha256.state, sizeof( sha256.state ) );
7538#endif
7539
7540 mbedtls_sha256_finish( &sha256, padbuf );
7541 mbedtls_sha256_free( &sha256 );
7542#endif /* MBEDTLS_USE_PSA_CRYPTO */
7543
7544 ssl->handshake->tls_prf( session->master, 48, sender,
7545 padbuf, 32, buf, len );
7546
7547 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7548
7549 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7550
7551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7552}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007553#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007554
Jerry Yub7ba49e2022-02-17 14:25:53 +08007555
Andrzej Kurek25f27152022-08-17 16:09:31 -04007556#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007557static void ssl_calc_finished_tls_sha384(
7558 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
7559{
7560 int len = 12;
7561 const char *sender;
7562 unsigned char padbuf[48];
7563#if defined(MBEDTLS_USE_PSA_CRYPTO)
7564 size_t hash_size;
7565 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
7566 psa_status_t status;
7567#else
7568 mbedtls_sha512_context sha512;
7569#endif
7570
7571 mbedtls_ssl_session *session = ssl->session_negotiate;
7572 if( !session )
7573 session = ssl->session;
7574
7575 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
7576 ? "client finished"
7577 : "server finished";
7578
7579#if defined(MBEDTLS_USE_PSA_CRYPTO)
7580 sha384_psa = psa_hash_operation_init();
7581
7582 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
7583
7584 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
7585 if( status != PSA_SUCCESS )
7586 {
7587 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
7588 return;
7589 }
7590
7591 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
7592 if( status != PSA_SUCCESS )
7593 {
7594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
7595 return;
7596 }
7597 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
7598#else
7599 mbedtls_sha512_init( &sha512 );
7600
7601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
7602
Andrzej Kureka242e832022-08-11 10:03:14 -04007603 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha384 );
Jerry Yub7ba49e2022-02-17 14:25:53 +08007604
7605 /*
7606 * TLSv1.2:
7607 * hash = PRF( master, finished_label,
7608 * Hash( handshake ) )[0.11]
7609 */
7610
7611#if !defined(MBEDTLS_SHA512_ALT)
7612 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7613 sha512.state, sizeof( sha512.state ) );
7614#endif
7615 mbedtls_sha512_finish( &sha512, padbuf );
7616
7617 mbedtls_sha512_free( &sha512 );
7618#endif
7619
7620 ssl->handshake->tls_prf( session->master, 48, sender,
7621 padbuf, 48, buf, len );
7622
7623 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7624
7625 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7626
7627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7628}
Andrzej Kurekcccb0442022-08-19 03:42:11 -04007629#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007630
Jerry Yuaef00152022-02-17 14:27:31 +08007631void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7632{
7633 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7634
7635 /*
7636 * Free our handshake params
7637 */
7638 mbedtls_ssl_handshake_free( ssl );
7639 mbedtls_free( ssl->handshake );
7640 ssl->handshake = NULL;
7641
7642 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007643 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007644 */
7645 if( ssl->transform )
7646 {
7647 mbedtls_ssl_transform_free( ssl->transform );
7648 mbedtls_free( ssl->transform );
7649 }
7650 ssl->transform = ssl->transform_negotiate;
7651 ssl->transform_negotiate = NULL;
7652
7653 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7654}
7655
Jerry Yu2a9fff52022-02-17 14:28:51 +08007656void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7657{
7658 int resume = ssl->handshake->resume;
7659
7660 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7661
7662#if defined(MBEDTLS_SSL_RENEGOTIATION)
7663 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7664 {
7665 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7666 ssl->renego_records_seen = 0;
7667 }
7668#endif
7669
7670 /*
7671 * Free the previous session and switch in the current one
7672 */
7673 if( ssl->session )
7674 {
7675#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7676 /* RFC 7366 3.1: keep the EtM state */
7677 ssl->session_negotiate->encrypt_then_mac =
7678 ssl->session->encrypt_then_mac;
7679#endif
7680
7681 mbedtls_ssl_session_free( ssl->session );
7682 mbedtls_free( ssl->session );
7683 }
7684 ssl->session = ssl->session_negotiate;
7685 ssl->session_negotiate = NULL;
7686
7687 /*
7688 * Add cache entry
7689 */
7690 if( ssl->conf->f_set_cache != NULL &&
7691 ssl->session->id_len != 0 &&
7692 resume == 0 )
7693 {
7694 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7695 ssl->session->id,
7696 ssl->session->id_len,
7697 ssl->session ) != 0 )
7698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7699 }
7700
7701#if defined(MBEDTLS_SSL_PROTO_DTLS)
7702 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7703 ssl->handshake->flight != NULL )
7704 {
7705 /* Cancel handshake timer */
7706 mbedtls_ssl_set_timer( ssl, 0 );
7707
7708 /* Keep last flight around in case we need to resend it:
7709 * we need the handshake and transform structures for that */
7710 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7711 }
7712 else
7713#endif
7714 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7715
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007716 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007717
7718 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7719}
7720
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007721int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7722{
7723 int ret, hash_len;
7724
7725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7726
7727 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7728
7729 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7730
7731 /*
7732 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7733 * may define some other value. Currently (early 2016), no defined
7734 * ciphersuite does this (and this is unlikely to change as activity has
7735 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7736 */
7737 hash_len = 12;
7738
7739#if defined(MBEDTLS_SSL_RENEGOTIATION)
7740 ssl->verify_data_len = hash_len;
7741 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7742#endif
7743
7744 ssl->out_msglen = 4 + hash_len;
7745 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7746 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7747
7748 /*
7749 * In case of session resuming, invert the client and server
7750 * ChangeCipherSpec messages order.
7751 */
7752 if( ssl->handshake->resume != 0 )
7753 {
7754#if defined(MBEDTLS_SSL_CLI_C)
7755 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7756 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7757#endif
7758#if defined(MBEDTLS_SSL_SRV_C)
7759 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7760 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7761#endif
7762 }
7763 else
7764 ssl->state++;
7765
7766 /*
7767 * Switch to our negotiated transform and session parameters for outbound
7768 * data.
7769 */
7770 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7771
7772#if defined(MBEDTLS_SSL_PROTO_DTLS)
7773 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7774 {
7775 unsigned char i;
7776
7777 /* Remember current epoch settings for resending */
7778 ssl->handshake->alt_transform_out = ssl->transform_out;
7779 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7780 sizeof( ssl->handshake->alt_out_ctr ) );
7781
7782 /* Set sequence_number to zero */
7783 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7784
7785
7786 /* Increment epoch */
7787 for( i = 2; i > 0; i-- )
7788 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7789 break;
7790
7791 /* The loop goes to its end iff the counter is wrapping */
7792 if( i == 0 )
7793 {
7794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7795 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7796 }
7797 }
7798 else
7799#endif /* MBEDTLS_SSL_PROTO_DTLS */
7800 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7801
7802 ssl->transform_out = ssl->transform_negotiate;
7803 ssl->session_out = ssl->session_negotiate;
7804
7805#if defined(MBEDTLS_SSL_PROTO_DTLS)
7806 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7807 mbedtls_ssl_send_flight_completed( ssl );
7808#endif
7809
7810 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7811 {
7812 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7813 return( ret );
7814 }
7815
7816#if defined(MBEDTLS_SSL_PROTO_DTLS)
7817 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7818 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7819 {
7820 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7821 return( ret );
7822 }
7823#endif
7824
7825 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7826
7827 return( 0 );
7828}
7829
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007830#define SSL_MAX_HASH_LEN 12
7831
7832int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7833{
7834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7835 unsigned int hash_len = 12;
7836 unsigned char buf[SSL_MAX_HASH_LEN];
7837
7838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7839
7840 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7841
7842 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7843 {
7844 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7845 goto exit;
7846 }
7847
7848 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7849 {
7850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7851 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7852 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7853 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7854 goto exit;
7855 }
7856
7857 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7858 {
7859 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7860 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7861 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7862 goto exit;
7863 }
7864
7865 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7866 {
7867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7868 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7869 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7870 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7871 goto exit;
7872 }
7873
7874 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7875 buf, hash_len ) != 0 )
7876 {
7877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7878 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7879 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7880 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7881 goto exit;
7882 }
7883
7884#if defined(MBEDTLS_SSL_RENEGOTIATION)
7885 ssl->verify_data_len = hash_len;
7886 memcpy( ssl->peer_verify_data, buf, hash_len );
7887#endif
7888
7889 if( ssl->handshake->resume != 0 )
7890 {
7891#if defined(MBEDTLS_SSL_CLI_C)
7892 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7893 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7894#endif
7895#if defined(MBEDTLS_SSL_SRV_C)
7896 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7897 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7898#endif
7899 }
7900 else
7901 ssl->state++;
7902
7903#if defined(MBEDTLS_SSL_PROTO_DTLS)
7904 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7905 mbedtls_ssl_recv_flight_completed( ssl );
7906#endif
7907
7908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7909
7910exit:
7911 mbedtls_platform_zeroize( buf, hash_len );
7912 return( ret );
7913}
7914
Jerry Yu392112c2022-02-17 14:34:10 +08007915#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7916/*
7917 * Helper to get TLS 1.2 PRF from ciphersuite
7918 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7919 */
7920static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7921{
Jerry Yu392112c2022-02-17 14:34:10 +08007922 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Andrzej Kurek68327742022-10-03 06:18:18 -04007923 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7924#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007925 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007926 return( tls_prf_sha384 );
Andrzej Kurek894edde2022-09-29 06:31:14 -04007927 else
Jerry Yu392112c2022-02-17 14:34:10 +08007928#endif
Andrzej Kurek894edde2022-09-29 06:31:14 -04007929#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
7930 {
7931 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256 )
7932 return( tls_prf_sha256 );
7933 }
7934#endif
7935#if !defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA) && \
7936 !defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
7937 (void) ciphersuite_info;
7938#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007939
Andrzej Kurek894edde2022-09-29 06:31:14 -04007940 return( NULL );
Jerry Yu392112c2022-02-17 14:34:10 +08007941}
7942#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007943
7944static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7945{
7946 ((void) tls_prf);
Andrzej Kurek25f27152022-08-17 16:09:31 -04007947#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007948 if( tls_prf == tls_prf_sha384 )
7949 {
7950 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7951 }
7952 else
7953#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -04007954#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007955 if( tls_prf == tls_prf_sha256 )
7956 {
7957 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7958 }
7959 else
7960#endif
7961 return( MBEDTLS_SSL_TLS_PRF_NONE );
7962}
7963
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007964/*
7965 * Populate a transform structure with session keys and all the other
7966 * necessary information.
7967 *
7968 * Parameters:
7969 * - [in/out]: transform: structure to populate
7970 * [in] must be just initialised with mbedtls_ssl_transform_init()
7971 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7972 * - [in] ciphersuite
7973 * - [in] master
7974 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007975 * - [in] tls_prf: pointer to PRF to use for key derivation
7976 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007977 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007978 * - [in] endpoint: client or server
7979 * - [in] ssl: used for:
7980 * - ssl->conf->{f,p}_export_keys
7981 * [in] optionally used for:
7982 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7983 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007984MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007985static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7986 int ciphersuite,
7987 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007988#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007989 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007990#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007991 ssl_tls_prf_t tls_prf,
7992 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007993 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007994 unsigned endpoint,
7995 const mbedtls_ssl_context *ssl )
7996{
7997 int ret = 0;
7998 unsigned char keyblk[256];
7999 unsigned char *key1;
8000 unsigned char *key2;
8001 unsigned char *mac_enc;
8002 unsigned char *mac_dec;
8003 size_t mac_key_len = 0;
8004 size_t iv_copy_len;
8005 size_t keylen;
8006 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008007 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008008#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008009 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008010 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008011#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008012
8013#if defined(MBEDTLS_USE_PSA_CRYPTO)
8014 psa_key_type_t key_type;
8015 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8016 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008017 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008018 size_t key_bits;
8019 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8020#endif
8021
8022#if !defined(MBEDTLS_DEBUG_C) && \
8023 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8024 if( ssl->f_export_keys == NULL )
8025 {
8026 ssl = NULL; /* make sure we don't use it except for these cases */
8027 (void) ssl;
8028 }
8029#endif
8030
8031 /*
8032 * Some data just needs copying into the structure
8033 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008034#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008035 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008036#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008037 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008038
8039#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8040 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
8041#endif
8042
8043#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04008044 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008045 {
8046 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8047 * generation separate. This should never happen. */
8048 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8049 }
8050#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8051
8052 /*
8053 * Get various info structures
8054 */
8055 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
8056 if( ciphersuite_info == NULL )
8057 {
8058 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
8059 ciphersuite ) );
8060 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8061 }
8062
Neil Armstrongab555e02022-04-04 11:07:59 +02008063 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008064#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008065 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008066#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008067 ciphersuite_info );
8068
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008069 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
8070 transform->taglen =
8071 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
8072
8073#if defined(MBEDTLS_USE_PSA_CRYPTO)
8074 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
8075 transform->taglen,
8076 &alg,
8077 &key_type,
8078 &key_bits ) ) != PSA_SUCCESS )
8079 {
8080 ret = psa_ssl_status_to_mbedtls( status );
8081 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
8082 goto end;
8083 }
8084#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008085 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
8086 if( cipher_info == NULL )
8087 {
8088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
8089 ciphersuite_info->cipher ) );
8090 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8091 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008092#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008093
Neil Armstronge4512952022-03-08 09:08:22 +01008094#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008095 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01008096 if( mac_alg == 0 )
8097 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01008099 (unsigned) ciphersuite_info->mac ) );
8100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8101 }
8102#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008103 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
8104 if( md_info == NULL )
8105 {
8106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
8107 (unsigned) ciphersuite_info->mac ) );
8108 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8109 }
Neil Armstronge4512952022-03-08 09:08:22 +01008110#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008111
8112#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8113 /* Copy own and peer's CID if the use of the CID
8114 * extension has been negotiated. */
8115 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
8116 {
8117 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
8118
8119 transform->in_cid_len = ssl->own_cid_len;
8120 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
8121 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
8122 transform->in_cid_len );
8123
8124 transform->out_cid_len = ssl->handshake->peer_cid_len;
8125 memcpy( transform->out_cid, ssl->handshake->peer_cid,
8126 ssl->handshake->peer_cid_len );
8127 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
8128 transform->out_cid_len );
8129 }
8130#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8131
8132 /*
8133 * Compute key block using the PRF
8134 */
8135 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
8136 if( ret != 0 )
8137 {
8138 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
8139 return( ret );
8140 }
8141
8142 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
8143 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
8144 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
8145 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
8146 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
8147
8148 /*
8149 * Determine the appropriate key, IV and MAC length.
8150 */
8151
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008152#if defined(MBEDTLS_USE_PSA_CRYPTO)
8153 keylen = PSA_BITS_TO_BYTES(key_bits);
8154#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008155 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008156#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008157
8158#if defined(MBEDTLS_GCM_C) || \
8159 defined(MBEDTLS_CCM_C) || \
8160 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008161 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008162 {
8163 size_t explicit_ivlen;
8164
8165 transform->maclen = 0;
8166 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008167
8168 /* All modes haves 96-bit IVs, but the length of the static parts vary
8169 * with mode and version:
8170 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8171 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8172 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8173 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8174 * sequence number).
8175 */
8176 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008177
8178 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008179#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann3b2276a2022-10-06 14:49:08 +01008180 is_chachapoly = ( key_type == PSA_KEY_TYPE_CHACHA20 );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008181#else
David Horstmann3b2276a2022-10-06 14:49:08 +01008182 is_chachapoly = ( mbedtls_cipher_info_get_mode( cipher_info )
8183 == MBEDTLS_MODE_CHACHAPOLY );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008184#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008185
8186 if( is_chachapoly )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008187 transform->fixed_ivlen = 12;
8188 else
8189 transform->fixed_ivlen = 4;
8190
8191 /* Minimum length of encrypted record */
8192 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8193 transform->minlen = explicit_ivlen + transform->taglen;
8194 }
8195 else
8196#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
8197#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008198 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
8199 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
8200 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008201 {
Neil Armstronge4512952022-03-08 09:08:22 +01008202#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02008203 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008204#else
8205 size_t block_size = cipher_info->block_size;
8206#endif /* MBEDTLS_USE_PSA_CRYPTO */
8207
8208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008209 /* Get MAC length */
8210 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8211#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008212 /* Initialize HMAC contexts */
8213 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
8214 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
8215 {
8216 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
8217 goto end;
8218 }
8219
8220 /* Get MAC length */
8221 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01008222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008223 transform->maclen = mac_key_len;
8224
8225 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008226#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02008227 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008228#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008229 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008230#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008231
8232 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008233 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008234 transform->minlen = transform->maclen;
8235 else
8236 {
8237 /*
8238 * GenericBlockCipher:
8239 * 1. if EtM is in use: one block plus MAC
8240 * otherwise: * first multiple of blocklen greater than maclen
8241 * 2. IV
8242 */
8243#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008244 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245 {
8246 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008247 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248 }
8249 else
8250#endif
8251 {
8252 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008253 + block_size
8254 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008255 }
8256
Glenn Strauss07c64162022-03-14 12:34:51 -04008257 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008258 {
8259 transform->minlen += transform->ivlen;
8260 }
8261 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008262 {
8263 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8264 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8265 goto end;
8266 }
8267 }
8268 }
8269 else
8270#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8271 {
8272 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8273 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8274 }
8275
8276 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8277 (unsigned) keylen,
8278 (unsigned) transform->minlen,
8279 (unsigned) transform->ivlen,
8280 (unsigned) transform->maclen ) );
8281
8282 /*
8283 * Finally setup the cipher contexts, IVs and MAC secrets.
8284 */
8285#if defined(MBEDTLS_SSL_CLI_C)
8286 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
8287 {
8288 key1 = keyblk + mac_key_len * 2;
8289 key2 = keyblk + mac_key_len * 2 + keylen;
8290
8291 mac_enc = keyblk;
8292 mac_dec = keyblk + mac_key_len;
8293
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008294 iv_copy_len = ( transform->fixed_ivlen ) ?
8295 transform->fixed_ivlen : transform->ivlen;
8296 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
8297 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
8298 iv_copy_len );
8299 }
8300 else
8301#endif /* MBEDTLS_SSL_CLI_C */
8302#if defined(MBEDTLS_SSL_SRV_C)
8303 if( endpoint == MBEDTLS_SSL_IS_SERVER )
8304 {
8305 key1 = keyblk + mac_key_len * 2 + keylen;
8306 key2 = keyblk + mac_key_len * 2;
8307
8308 mac_enc = keyblk + mac_key_len;
8309 mac_dec = keyblk;
8310
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008311 iv_copy_len = ( transform->fixed_ivlen ) ?
8312 transform->fixed_ivlen : transform->ivlen;
8313 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
8314 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
8315 iv_copy_len );
8316 }
8317 else
8318#endif /* MBEDTLS_SSL_SRV_C */
8319 {
8320 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
8321 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8322 goto end;
8323 }
8324
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325 if( ssl != NULL && ssl->f_export_keys != NULL )
8326 {
8327 ssl->f_export_keys( ssl->p_export_keys,
8328 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8329 master, 48,
8330 randbytes + 32,
8331 randbytes,
8332 tls_prf_get_type( tls_prf ) );
8333 }
8334
8335#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336 transform->psa_alg = alg;
8337
8338 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
8339 {
8340 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
8341 psa_set_key_algorithm( &attributes, alg );
8342 psa_set_key_type( &attributes, key_type );
8343
8344 if( ( status = psa_import_key( &attributes,
8345 key1,
8346 PSA_BITS_TO_BYTES( key_bits ),
8347 &transform->psa_key_enc ) ) != PSA_SUCCESS )
8348 {
8349 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
8350 ret = psa_ssl_status_to_mbedtls( status );
8351 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
8352 goto end;
8353 }
8354
8355 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
8356
8357 if( ( status = psa_import_key( &attributes,
8358 key2,
8359 PSA_BITS_TO_BYTES( key_bits ),
8360 &transform->psa_key_dec ) ) != PSA_SUCCESS )
8361 {
8362 ret = psa_ssl_status_to_mbedtls( status );
8363 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
8364 goto end;
8365 }
8366 }
8367#else
8368 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
8369 cipher_info ) ) != 0 )
8370 {
8371 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
8372 goto end;
8373 }
8374
8375 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
8376 cipher_info ) ) != 0 )
8377 {
8378 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
8379 goto end;
8380 }
8381
8382 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
8383 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
8384 MBEDTLS_ENCRYPT ) ) != 0 )
8385 {
8386 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
8387 goto end;
8388 }
8389
8390 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
8391 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
8392 MBEDTLS_DECRYPT ) ) != 0 )
8393 {
8394 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
8395 goto end;
8396 }
8397
8398#if defined(MBEDTLS_CIPHER_MODE_CBC)
8399 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
8400 {
8401 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
8402 MBEDTLS_PADDING_NONE ) ) != 0 )
8403 {
8404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
8405 goto end;
8406 }
8407
8408 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
8409 MBEDTLS_PADDING_NONE ) ) != 0 )
8410 {
8411 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
8412 goto end;
8413 }
8414 }
8415#endif /* MBEDTLS_CIPHER_MODE_CBC */
8416#endif /* MBEDTLS_USE_PSA_CRYPTO */
8417
Neil Armstrong29c0c042022-03-17 17:47:28 +01008418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8419 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8420 For AEAD-based ciphersuites, there is nothing to do here. */
8421 if( mac_key_len != 0 )
8422 {
8423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008424 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01008425
8426 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01008427 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01008428 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
8429
8430 if( ( status = psa_import_key( &attributes,
8431 mac_enc, mac_key_len,
8432 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
8433 {
8434 ret = psa_ssl_status_to_mbedtls( status );
8435 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
8436 goto end;
8437 }
8438
Ronald Cronfb39f152022-03-25 14:36:28 +01008439 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008440 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
8441#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
8442 && ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED )
8443#endif
8444 ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01008445 /* mbedtls_ct_hmac() requires the key to be exportable */
8446 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
8447 PSA_KEY_USAGE_VERIFY_HASH );
8448 else
8449 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
8450
8451 if( ( status = psa_import_key( &attributes,
8452 mac_dec, mac_key_len,
8453 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
8454 {
8455 ret = psa_ssl_status_to_mbedtls( status );
8456 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
8457 goto end;
8458 }
8459#else
8460 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
8461 if( ret != 0 )
8462 goto end;
8463 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
8464 if( ret != 0 )
8465 goto end;
8466#endif /* MBEDTLS_USE_PSA_CRYPTO */
8467 }
8468#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8469
8470 ((void) mac_dec);
8471 ((void) mac_enc);
8472
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008473end:
8474 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
8475 return( ret );
8476}
8477
Valerio Settia08b1a42022-11-17 15:10:02 +01008478#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8479 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008480int mbedtls_psa_ecjpake_read_round(
Valerio Settia08b1a42022-11-17 15:10:02 +01008481 psa_pake_operation_t *pake_ctx,
8482 const unsigned char *buf,
Valerio Setti6b3dab02022-11-17 17:14:54 +01008483 size_t len, mbedtls_ecjpake_rounds_t round )
Valerio Settia08b1a42022-11-17 15:10:02 +01008484{
8485 psa_status_t status;
8486 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008487 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008488 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8489 * At round two perform a single cycle
8490 */
8491 unsigned int remaining_steps = ( round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008492
Valerio Setti6b3dab02022-11-17 17:14:54 +01008493 for( ; remaining_steps > 0; remaining_steps-- )
Valerio Settia08b1a42022-11-17 15:10:02 +01008494 {
8495 for( psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8496 step <= PSA_PAKE_STEP_ZK_PROOF;
8497 ++step )
8498 {
8499 /* Length is stored at the first byte */
8500 size_t length = buf[input_offset];
8501 input_offset += 1;
8502
8503 if( input_offset + length > len )
8504 {
8505 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8506 }
8507
8508 status = psa_pake_input( pake_ctx, step,
8509 buf + input_offset, length );
8510 if( status != PSA_SUCCESS)
8511 {
8512 return psa_ssl_status_to_mbedtls( status );
8513 }
8514
8515 input_offset += length;
8516 }
8517 }
8518
Valerio Setti819de862022-11-17 18:05:19 +01008519 if( input_offset != len )
Valerio Setti61ea17d2022-11-18 12:11:00 +01008520 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Valerio Setti30ebe112022-11-17 16:23:34 +01008521
Valerio Settia08b1a42022-11-17 15:10:02 +01008522 return( 0 );
8523}
8524
Valerio Setti6b3dab02022-11-17 17:14:54 +01008525int mbedtls_psa_ecjpake_write_round(
Valerio Settia08b1a42022-11-17 15:10:02 +01008526 psa_pake_operation_t *pake_ctx,
8527 unsigned char *buf,
Valerio Setti6b3dab02022-11-17 17:14:54 +01008528 size_t len, size_t *olen,
8529 mbedtls_ecjpake_rounds_t round )
Valerio Settia08b1a42022-11-17 15:10:02 +01008530{
8531 psa_status_t status;
8532 size_t output_offset = 0;
8533 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008534 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008535 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8536 * At round two perform a single cycle
8537 */
8538 unsigned int remaining_steps = ( round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008539
Valerio Setti6b3dab02022-11-17 17:14:54 +01008540 for( ; remaining_steps > 0; remaining_steps-- )
Valerio Settia08b1a42022-11-17 15:10:02 +01008541 {
Valerio Setti6b3dab02022-11-17 17:14:54 +01008542 for( psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8543 step <= PSA_PAKE_STEP_ZK_PROOF;
Valerio Settia08b1a42022-11-17 15:10:02 +01008544 ++step )
8545 {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008546 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008547 * For each step, prepend 1 byte with the length of the data as
8548 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008549 */
Valerio Settia08b1a42022-11-17 15:10:02 +01008550 status = psa_pake_output( pake_ctx, step,
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008551 buf + output_offset + 1,
8552 len - output_offset - 1,
Valerio Settia08b1a42022-11-17 15:10:02 +01008553 &output_len );
8554 if( status != PSA_SUCCESS )
8555 {
8556 return( psa_ssl_status_to_mbedtls( status ) );
8557 }
8558
Valerio Setti99d88c12022-11-22 16:03:43 +01008559 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008560
8561 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008562 }
8563 }
8564
8565 *olen = output_offset;
8566
8567 return( 0 );
8568}
Valerio Settia08b1a42022-11-17 15:10:02 +01008569#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8570
Jerry Yuee40f9d2022-02-17 14:55:16 +08008571#if defined(MBEDTLS_USE_PSA_CRYPTO)
8572int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
8573 unsigned char *hash, size_t *hashlen,
8574 unsigned char *data, size_t data_len,
8575 mbedtls_md_type_t md_alg )
8576{
8577 psa_status_t status;
8578 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008579 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08008580
8581 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
8582
8583 if( ( status = psa_hash_setup( &hash_operation,
8584 hash_alg ) ) != PSA_SUCCESS )
8585 {
8586 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
8587 goto exit;
8588 }
8589
8590 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
8591 64 ) ) != PSA_SUCCESS )
8592 {
8593 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
8594 goto exit;
8595 }
8596
8597 if( ( status = psa_hash_update( &hash_operation,
8598 data, data_len ) ) != PSA_SUCCESS )
8599 {
8600 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
8601 goto exit;
8602 }
8603
8604 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
8605 hashlen ) ) != PSA_SUCCESS )
8606 {
8607 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
8608 goto exit;
8609 }
8610
8611exit:
8612 if( status != PSA_SUCCESS )
8613 {
8614 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8615 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
8616 switch( status )
8617 {
8618 case PSA_ERROR_NOT_SUPPORTED:
8619 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
8620 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8621 case PSA_ERROR_BUFFER_TOO_SMALL:
8622 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
8623 case PSA_ERROR_INSUFFICIENT_MEMORY:
8624 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
8625 default:
8626 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
8627 }
8628 }
8629 return( 0 );
8630}
8631
8632#else
8633
8634int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
8635 unsigned char *hash, size_t *hashlen,
8636 unsigned char *data, size_t data_len,
8637 mbedtls_md_type_t md_alg )
8638{
8639 int ret = 0;
8640 mbedtls_md_context_t ctx;
8641 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
8642 *hashlen = mbedtls_md_get_size( md_info );
8643
8644 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
8645
8646 mbedtls_md_init( &ctx );
8647
8648 /*
8649 * digitally-signed struct {
8650 * opaque client_random[32];
8651 * opaque server_random[32];
8652 * ServerDHParams params;
8653 * };
8654 */
8655 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
8656 {
8657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
8658 goto exit;
8659 }
8660 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
8661 {
8662 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
8663 goto exit;
8664 }
8665 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
8666 {
8667 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
8668 goto exit;
8669 }
8670 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
8671 {
8672 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
8673 goto exit;
8674 }
8675 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
8676 {
8677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
8678 goto exit;
8679 }
8680
8681exit:
8682 mbedtls_md_free( &ctx );
8683
8684 if( ret != 0 )
8685 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8686 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
8687
8688 return( ret );
8689}
8690#endif /* MBEDTLS_USE_PSA_CRYPTO */
8691
Jerry Yud9d91da2022-02-17 14:57:06 +08008692#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8693
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008694/* Find the preferred hash for a given signature algorithm. */
8695unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
8696 mbedtls_ssl_context *ssl,
8697 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08008698{
Gabor Mezei078e8032022-04-27 21:17:56 +02008699 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008700 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008701
8702 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008703 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02008704
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008705 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08008706 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008707 unsigned int hash_alg_received =
8708 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8709 received_sig_algs[i] );
8710 unsigned int sig_alg_received =
8711 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8712 received_sig_algs[i] );
8713
8714 if( sig_alg == sig_alg_received )
8715 {
8716#if defined(MBEDTLS_USE_PSA_CRYPTO)
8717 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8718 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008719 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008720 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008721
Neil Armstrong96eceb82022-06-30 18:05:05 +02008722 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8723 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8724 PSA_ALG_ECDSA( psa_hash_alg ),
8725 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008726 continue;
8727
Neil Armstrong96eceb82022-06-30 18:05:05 +02008728 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008729 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8730 PSA_ALG_RSA_PKCS1V15_SIGN(
8731 psa_hash_alg ),
8732 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008733 continue;
8734 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008735#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008736
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008737 return( hash_alg_received );
8738 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008739 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008740
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008741 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008742}
8743
8744#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8745
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008746/* Serialization of TLS 1.2 sessions:
8747 *
8748 * struct {
8749 * uint64 start_time;
8750 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008751 * uint8 session_id_len; // at most 32
8752 * opaque session_id[32];
8753 * opaque master[48]; // fixed length in the standard
8754 * uint32 verify_result;
8755 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8756 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8757 * uint32 ticket_lifetime;
8758 * uint8 mfl_code; // up to 255 according to standard
8759 * uint8 encrypt_then_mac; // 0 or 1
8760 * } serialized_session_tls12;
8761 *
8762 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008763static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008764 unsigned char *buf,
8765 size_t buf_len )
8766{
8767 unsigned char *p = buf;
8768 size_t used = 0;
8769
8770#if defined(MBEDTLS_HAVE_TIME)
8771 uint64_t start;
8772#endif
8773#if defined(MBEDTLS_X509_CRT_PARSE_C)
8774#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8775 size_t cert_len;
8776#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8777#endif /* MBEDTLS_X509_CRT_PARSE_C */
8778
8779 /*
8780 * Time
8781 */
8782#if defined(MBEDTLS_HAVE_TIME)
8783 used += 8;
8784
8785 if( used <= buf_len )
8786 {
8787 start = (uint64_t) session->start;
8788
8789 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8790 p += 8;
8791 }
8792#endif /* MBEDTLS_HAVE_TIME */
8793
8794 /*
8795 * Basic mandatory fields
8796 */
8797 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008798 + 1 /* id_len */
8799 + sizeof( session->id )
8800 + sizeof( session->master )
8801 + 4; /* verify_result */
8802
8803 if( used <= buf_len )
8804 {
8805 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8806 p += 2;
8807
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008808 *p++ = MBEDTLS_BYTE_0( session->id_len );
8809 memcpy( p, session->id, 32 );
8810 p += 32;
8811
8812 memcpy( p, session->master, 48 );
8813 p += 48;
8814
8815 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8816 p += 4;
8817 }
8818
8819 /*
8820 * Peer's end-entity certificate
8821 */
8822#if defined(MBEDTLS_X509_CRT_PARSE_C)
8823#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8824 if( session->peer_cert == NULL )
8825 cert_len = 0;
8826 else
8827 cert_len = session->peer_cert->raw.len;
8828
8829 used += 3 + cert_len;
8830
8831 if( used <= buf_len )
8832 {
8833 *p++ = MBEDTLS_BYTE_2( cert_len );
8834 *p++ = MBEDTLS_BYTE_1( cert_len );
8835 *p++ = MBEDTLS_BYTE_0( cert_len );
8836
8837 if( session->peer_cert != NULL )
8838 {
8839 memcpy( p, session->peer_cert->raw.p, cert_len );
8840 p += cert_len;
8841 }
8842 }
8843#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8844 if( session->peer_cert_digest != NULL )
8845 {
8846 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8847 if( used <= buf_len )
8848 {
8849 *p++ = (unsigned char) session->peer_cert_digest_type;
8850 *p++ = (unsigned char) session->peer_cert_digest_len;
8851 memcpy( p, session->peer_cert_digest,
8852 session->peer_cert_digest_len );
8853 p += session->peer_cert_digest_len;
8854 }
8855 }
8856 else
8857 {
8858 used += 2;
8859 if( used <= buf_len )
8860 {
8861 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8862 *p++ = 0;
8863 }
8864 }
8865#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8866#endif /* MBEDTLS_X509_CRT_PARSE_C */
8867
8868 /*
8869 * Session ticket if any, plus associated data
8870 */
8871#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8872 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8873
8874 if( used <= buf_len )
8875 {
8876 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8877 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8878 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8879
8880 if( session->ticket != NULL )
8881 {
8882 memcpy( p, session->ticket, session->ticket_len );
8883 p += session->ticket_len;
8884 }
8885
8886 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8887 p += 4;
8888 }
8889#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8890
8891 /*
8892 * Misc extension-related info
8893 */
8894#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8895 used += 1;
8896
8897 if( used <= buf_len )
8898 *p++ = session->mfl_code;
8899#endif
8900
8901#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8902 used += 1;
8903
8904 if( used <= buf_len )
8905 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8906#endif
8907
8908 return( used );
8909}
8910
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008911MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008912static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008913 const unsigned char *buf,
8914 size_t len )
8915{
8916#if defined(MBEDTLS_HAVE_TIME)
8917 uint64_t start;
8918#endif
8919#if defined(MBEDTLS_X509_CRT_PARSE_C)
8920#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8921 size_t cert_len;
8922#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8923#endif /* MBEDTLS_X509_CRT_PARSE_C */
8924
8925 const unsigned char *p = buf;
8926 const unsigned char * const end = buf + len;
8927
8928 /*
8929 * Time
8930 */
8931#if defined(MBEDTLS_HAVE_TIME)
8932 if( 8 > (size_t)( end - p ) )
8933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8934
8935 start = ( (uint64_t) p[0] << 56 ) |
8936 ( (uint64_t) p[1] << 48 ) |
8937 ( (uint64_t) p[2] << 40 ) |
8938 ( (uint64_t) p[3] << 32 ) |
8939 ( (uint64_t) p[4] << 24 ) |
8940 ( (uint64_t) p[5] << 16 ) |
8941 ( (uint64_t) p[6] << 8 ) |
8942 ( (uint64_t) p[7] );
8943 p += 8;
8944
8945 session->start = (time_t) start;
8946#endif /* MBEDTLS_HAVE_TIME */
8947
8948 /*
8949 * Basic mandatory fields
8950 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008951 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008952 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8953
8954 session->ciphersuite = ( p[0] << 8 ) | p[1];
8955 p += 2;
8956
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957 session->id_len = *p++;
8958 memcpy( session->id, p, 32 );
8959 p += 32;
8960
8961 memcpy( session->master, p, 48 );
8962 p += 48;
8963
8964 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8965 ( (uint32_t) p[1] << 16 ) |
8966 ( (uint32_t) p[2] << 8 ) |
8967 ( (uint32_t) p[3] );
8968 p += 4;
8969
8970 /* Immediately clear invalid pointer values that have been read, in case
8971 * we exit early before we replaced them with valid ones. */
8972#if defined(MBEDTLS_X509_CRT_PARSE_C)
8973#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8974 session->peer_cert = NULL;
8975#else
8976 session->peer_cert_digest = NULL;
8977#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8978#endif /* MBEDTLS_X509_CRT_PARSE_C */
8979#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8980 session->ticket = NULL;
8981#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8982
8983 /*
8984 * Peer certificate
8985 */
8986#if defined(MBEDTLS_X509_CRT_PARSE_C)
8987#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8988 /* Deserialize CRT from the end of the ticket. */
8989 if( 3 > (size_t)( end - p ) )
8990 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8991
8992 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8993 p += 3;
8994
8995 if( cert_len != 0 )
8996 {
8997 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8998
8999 if( cert_len > (size_t)( end - p ) )
9000 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9001
9002 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
9003
9004 if( session->peer_cert == NULL )
9005 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9006
9007 mbedtls_x509_crt_init( session->peer_cert );
9008
9009 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
9010 p, cert_len ) ) != 0 )
9011 {
9012 mbedtls_x509_crt_free( session->peer_cert );
9013 mbedtls_free( session->peer_cert );
9014 session->peer_cert = NULL;
9015 return( ret );
9016 }
9017
9018 p += cert_len;
9019 }
9020#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9021 /* Deserialize CRT digest from the end of the ticket. */
9022 if( 2 > (size_t)( end - p ) )
9023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9024
9025 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9026 session->peer_cert_digest_len = (size_t) *p++;
9027
9028 if( session->peer_cert_digest_len != 0 )
9029 {
9030 const mbedtls_md_info_t *md_info =
9031 mbedtls_md_info_from_type( session->peer_cert_digest_type );
9032 if( md_info == NULL )
9033 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9034 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
9035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9036
9037 if( session->peer_cert_digest_len > (size_t)( end - p ) )
9038 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9039
9040 session->peer_cert_digest =
9041 mbedtls_calloc( 1, session->peer_cert_digest_len );
9042 if( session->peer_cert_digest == NULL )
9043 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9044
9045 memcpy( session->peer_cert_digest, p,
9046 session->peer_cert_digest_len );
9047 p += session->peer_cert_digest_len;
9048 }
9049#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9050#endif /* MBEDTLS_X509_CRT_PARSE_C */
9051
9052 /*
9053 * Session ticket and associated data
9054 */
9055#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9056 if( 3 > (size_t)( end - p ) )
9057 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9058
9059 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
9060 p += 3;
9061
9062 if( session->ticket_len != 0 )
9063 {
9064 if( session->ticket_len > (size_t)( end - p ) )
9065 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9066
9067 session->ticket = mbedtls_calloc( 1, session->ticket_len );
9068 if( session->ticket == NULL )
9069 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9070
9071 memcpy( session->ticket, p, session->ticket_len );
9072 p += session->ticket_len;
9073 }
9074
9075 if( 4 > (size_t)( end - p ) )
9076 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9077
9078 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
9079 ( (uint32_t) p[1] << 16 ) |
9080 ( (uint32_t) p[2] << 8 ) |
9081 ( (uint32_t) p[3] );
9082 p += 4;
9083#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9084
9085 /*
9086 * Misc extension-related info
9087 */
9088#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9089 if( 1 > (size_t)( end - p ) )
9090 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9091
9092 session->mfl_code = *p++;
9093#endif
9094
9095#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9096 if( 1 > (size_t)( end - p ) )
9097 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9098
9099 session->encrypt_then_mac = *p++;
9100#endif
9101
9102 /* Done, should have consumed entire buffer */
9103 if( p != end )
9104 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9105
9106 return( 0 );
9107}
Jerry Yudc7bd172022-02-17 13:44:15 +08009108#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9109
XiaokangQian75d40ef2022-04-20 11:05:24 +00009110int mbedtls_ssl_validate_ciphersuite(
9111 const mbedtls_ssl_context *ssl,
9112 const mbedtls_ssl_ciphersuite_t *suite_info,
9113 mbedtls_ssl_protocol_version min_tls_version,
9114 mbedtls_ssl_protocol_version max_tls_version )
9115{
9116 (void) ssl;
9117
9118 if( suite_info == NULL )
9119 return( -1 );
9120
9121 if( ( suite_info->min_tls_version > max_tls_version ) ||
9122 ( suite_info->max_tls_version < min_tls_version ) )
9123 {
9124 return( -1 );
9125 }
9126
XiaokangQian060d8672022-04-21 09:24:56 +00009127#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009128#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009129#if defined(MBEDTLS_USE_PSA_CRYPTO)
9130 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9131 ssl->handshake->psa_pake_ctx_is_ok != 1 )
9132#else
XiaokangQian75d40ef2022-04-20 11:05:24 +00009133 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9134 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
Neil Armstrongca7d5062022-05-31 14:43:23 +02009135#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009136 {
9137 return( -1 );
9138 }
9139#endif
9140
9141 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9142#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
9143 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
9144 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
9145 {
9146 return( -1 );
9147 }
9148#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9149#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9150
9151 return( 0 );
9152}
9153
Ronald Crone68ab4f2022-10-05 12:46:29 +02009154#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009155/*
9156 * Function for writing a signature algorithm extension.
9157 *
9158 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9159 * value (TLS 1.3 RFC8446):
9160 * enum {
9161 * ....
9162 * ecdsa_secp256r1_sha256( 0x0403 ),
9163 * ecdsa_secp384r1_sha384( 0x0503 ),
9164 * ecdsa_secp521r1_sha512( 0x0603 ),
9165 * ....
9166 * } SignatureScheme;
9167 *
9168 * struct {
9169 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9170 * } SignatureSchemeList;
9171 *
9172 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9173 * value (TLS 1.2 RFC5246):
9174 * enum {
9175 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9176 * sha512(6), (255)
9177 * } HashAlgorithm;
9178 *
9179 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9180 * SignatureAlgorithm;
9181 *
9182 * struct {
9183 * HashAlgorithm hash;
9184 * SignatureAlgorithm signature;
9185 * } SignatureAndHashAlgorithm;
9186 *
9187 * SignatureAndHashAlgorithm
9188 * supported_signature_algorithms<2..2^16-2>;
9189 *
9190 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9191 * generalization of the TLS 1.2 signature algorithm extension.
9192 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9193 * `SignatureScheme` field of TLS 1.3
9194 *
9195 */
9196int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
9197 const unsigned char *end, size_t *out_len )
9198{
9199 unsigned char *p = buf;
9200 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9201 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9202
9203 *out_len = 0;
9204
9205 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
9206
9207 /* Check if we have space for header and length field:
9208 * - extension_type (2 bytes)
9209 * - extension_data_length (2 bytes)
9210 * - supported_signature_algorithms_length (2 bytes)
9211 */
9212 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
9213 p += 6;
9214
9215 /*
9216 * Write supported_signature_algorithms
9217 */
9218 supported_sig_alg = p;
9219 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
9220 if( sig_alg == NULL )
9221 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
9222
9223 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
9224 {
Jerry Yu53f5c152022-06-22 20:24:38 +08009225 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
9226 *sig_alg,
9227 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00009228 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
9229 continue;
9230 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
9231 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
9232 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08009233 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08009234 *sig_alg,
9235 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00009236 }
9237
9238 /* Length of supported_signature_algorithms */
9239 supported_sig_alg_len = p - supported_sig_alg;
9240 if( supported_sig_alg_len == 0 )
9241 {
9242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
9243 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
9244 }
9245
XiaokangQianeaf36512022-04-24 09:07:44 +00009246 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00009247 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00009248 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
9249
XiaokangQianeaf36512022-04-24 09:07:44 +00009250 *out_len = p - buf;
9251
9252#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yuc4bf5d62022-10-29 09:08:47 +08009253 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_SIG_ALG );
XiaokangQianeaf36512022-04-24 09:07:44 +00009254#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009255
XiaokangQianeaf36512022-04-24 09:07:44 +00009256 return( 0 );
9257}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009258#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009259
XiaokangQian40a35232022-05-07 09:02:40 +00009260#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009261/*
9262 * mbedtls_ssl_parse_server_name_ext
9263 *
9264 * Structure of server_name extension:
9265 *
9266 * enum {
9267 * host_name(0), (255)
9268 * } NameType;
9269 * opaque HostName<1..2^16-1>;
9270 *
9271 * struct {
9272 * NameType name_type;
9273 * select (name_type) {
9274 * case host_name: HostName;
9275 * } name;
9276 * } ServerName;
9277 * struct {
9278 * ServerName server_name_list<1..2^16-1>
9279 * } ServerNameList;
9280 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009281MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00009282int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
9283 const unsigned char *buf,
9284 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00009285{
9286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9287 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009288 size_t server_name_list_len, hostname_len;
9289 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009290
XiaokangQianf2a94202022-05-20 06:44:24 +00009291 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00009292
9293 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00009294 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00009295 p += 2;
9296
XiaokangQian9b2b7712022-05-17 02:57:00 +00009297 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
9298 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00009299 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00009300 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00009301 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00009302 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00009303 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
9304 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00009305
9306 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
9307 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009308 /* sni_name is intended to be used only during the parsing of the
9309 * ClientHello message (it is reset to NULL before the end of
9310 * the message parsing). Thus it is ok to just point to the
9311 * reception buffer and not make a copy of it.
9312 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009313 ssl->handshake->sni_name = p + 3;
9314 ssl->handshake->sni_name_len = hostname_len;
9315 if( ssl->conf->f_sni == NULL )
9316 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00009317 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00009318 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00009319 if( ret != 0 )
9320 {
XiaokangQianf2a94202022-05-20 06:44:24 +00009321 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00009322 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9323 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00009324 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
9325 }
9326 return( 0 );
9327 }
9328
9329 p += hostname_len + 3;
9330 }
9331
9332 return( 0 );
9333}
9334#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9335
XiaokangQianacb39922022-06-17 10:18:48 +00009336#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009337MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00009338int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
9339 const unsigned char *buf,
9340 const unsigned char *end )
9341{
9342 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009343 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009344 const unsigned char *protocol_name_list;
9345 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009346 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009347
9348 /* If ALPN not configured, just ignore the extension */
9349 if( ssl->conf->alpn_list == NULL )
9350 return( 0 );
9351
9352 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009353 * RFC7301, section 3.1
9354 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009355 *
XiaokangQianc7403452022-06-23 03:24:12 +00009356 * struct {
9357 * ProtocolName protocol_name_list<2..2^16-1>
9358 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009359 */
9360
XiaokangQianc7403452022-06-23 03:24:12 +00009361 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009362 * protocol_name_list_len 2 bytes
9363 * protocol_name_len 1 bytes
9364 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009365 */
XiaokangQianacb39922022-06-17 10:18:48 +00009366 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
9367
XiaokangQianc7403452022-06-23 03:24:12 +00009368 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00009369 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00009370 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00009371 protocol_name_list = p;
9372 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009373
9374 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00009375 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00009376 {
XiaokangQian95d5f542022-06-24 02:29:26 +00009377 protocol_name_len = *p++;
9378 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
9379 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00009380 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00009381 {
9382 MBEDTLS_SSL_PEND_FATAL_ALERT(
9383 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
9384 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00009385 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00009386 }
9387
9388 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009389 }
9390
9391 /* Use our order of preference */
9392 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
9393 {
9394 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00009395 p = protocol_name_list;
9396 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00009397 {
XiaokangQian95d5f542022-06-24 02:29:26 +00009398 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00009399 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00009400 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00009401 {
9402 ssl->alpn_chosen = *alpn;
9403 return( 0 );
9404 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009405
9406 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009407 }
9408 }
9409
XiaokangQian95d5f542022-06-24 02:29:26 +00009410 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009411 MBEDTLS_SSL_PEND_FATAL_ALERT(
9412 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9413 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
9414 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
9415}
9416
9417int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
9418 unsigned char *buf,
9419 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00009420 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00009421{
9422 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009423 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009424 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009425
9426 if( ssl->alpn_chosen == NULL )
9427 {
9428 return( 0 );
9429 }
9430
XiaokangQian95d5f542022-06-24 02:29:26 +00009431 protocol_name_len = strlen( ssl->alpn_chosen );
9432 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00009433
9434 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
9435 /*
9436 * 0 . 1 ext identifier
9437 * 2 . 3 ext length
9438 * 4 . 5 protocol list length
9439 * 6 . 6 protocol name length
9440 * 7 . 7+n protocol name
9441 */
9442 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
9443
XiaokangQian95d5f542022-06-24 02:29:26 +00009444 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009445
XiaokangQian95d5f542022-06-24 02:29:26 +00009446 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
9447 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00009448 /* Note: the length of the chosen protocol has been checked to be less
9449 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9450 */
XiaokangQian95d5f542022-06-24 02:29:26 +00009451 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00009452
XiaokangQian95d5f542022-06-24 02:29:26 +00009453 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
Jerry Yub95dd362022-11-08 21:19:34 +08009454
9455#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
9456 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_ALPN );
9457#endif
9458
XiaokangQianacb39922022-06-17 10:18:48 +00009459 return ( 0 );
9460}
9461#endif /* MBEDTLS_SSL_ALPN */
9462
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009463#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009464 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009465 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009466 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009467int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session,
9468 const char *hostname )
9469{
9470 /* Initialize to suppress unnecessary compiler warning */
9471 size_t hostname_len = 0;
9472
9473 /* Check if new hostname is valid before
9474 * making any change to current one */
9475 if( hostname != NULL )
9476 {
9477 hostname_len = strlen( hostname );
9478
9479 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
9480 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
9481 }
9482
9483 /* Now it's clear that we will overwrite the old hostname,
9484 * so we can free it safely */
9485 if( session->hostname != NULL )
9486 {
9487 mbedtls_platform_zeroize( session->hostname,
9488 strlen( session->hostname ) );
9489 mbedtls_free( session->hostname );
9490 }
9491
9492 /* Passing NULL as hostname shall clear the old one */
9493 if( hostname == NULL )
9494 {
9495 session->hostname = NULL;
9496 }
9497 else
9498 {
9499 session->hostname = mbedtls_calloc( 1, hostname_len + 1 );
9500 if( session->hostname == NULL )
9501 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
9502
9503 memcpy( session->hostname, hostname, hostname_len );
9504 }
9505
9506 return( 0 );
9507}
Xiaokang Qian03409292022-10-12 02:49:52 +00009508#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9509 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009510 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009511 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009512
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009513#endif /* MBEDTLS_SSL_TLS_C */