blob: 266cf77b14dd75fe0cadce33b2570f8faedb09ab [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000018 */
19/*
Paul Bakker5121ce52009-01-03 21:22:43 +000020 * http://www.ietf.org/rfc/rfc2246.txt
21 * http://www.ietf.org/rfc/rfc4346.txt
22 */
23
Gilles Peskinedb09ef62020-06-03 01:43:33 +020024#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000027
Jerry Yub476a442022-01-21 18:14:45 +080028#include <assert.h>
29
SimonBd5800b72016-04-26 07:43:27 +010030#if defined(MBEDTLS_PLATFORM_C)
31#include "mbedtls/platform.h"
32#else
33#include <stdlib.h>
Jerry Yu6ade7432022-01-25 10:39:33 +080034#include <stdio.h>
SimonBd5800b72016-04-26 07:43:27 +010035#define mbedtls_calloc calloc
36#define mbedtls_free free
Jerry Yu6ade7432022-01-25 10:39:33 +080037#define mbedtls_printf printf
38#endif /* !MBEDTLS_PLATFORM_C */
SimonBd5800b72016-04-26 07:43:27 +010039
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000040#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010041#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010042#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000043#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000044#include "mbedtls/debug.h"
45#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050046#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010047#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Ronald Cronad8c17b2022-06-10 17:18:09 +020061#if defined(MBEDTLS_TEST_HOOKS)
62static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
63
64void mbedtls_ssl_set_chk_buf_ptr_fail_args(
65 const uint8_t *cur, const uint8_t *end, size_t need )
66{
67 chk_buf_ptr_fail_args.cur = cur;
68 chk_buf_ptr_fail_args.end = end;
69 chk_buf_ptr_fail_args.need = need;
70}
71
72void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void )
73{
74 memset( &chk_buf_ptr_fail_args, 0, sizeof( chk_buf_ptr_fail_args ) );
75}
76
77int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args )
78{
79 return( ( chk_buf_ptr_fail_args.cur != args->cur ) ||
80 ( chk_buf_ptr_fail_args.end != args->end ) ||
81 ( chk_buf_ptr_fail_args.need != args->need ) );
82}
83#endif /* MBEDTLS_TEST_HOOKS */
84
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010086
Hanno Beckera0e20d02019-05-15 14:03:01 +010087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010088/* Top-level Connection ID API */
89
Hanno Becker8367ccc2019-05-14 11:30:10 +010090int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf,
91 size_t len,
92 int ignore_other_cid )
Hanno Beckerad4a1372019-05-03 13:06:44 +010093{
94 if( len > MBEDTLS_SSL_CID_IN_LEN_MAX )
95 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
96
Hanno Becker611ac772019-05-14 11:45:26 +010097 if( ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
98 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
99 {
100 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
101 }
102
103 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +0100104 conf->cid_len = len;
105 return( 0 );
106}
107
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100108int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
109 int enable,
110 unsigned char const *own_cid,
111 size_t own_cid_len )
112{
Hanno Becker76a79ab2019-05-03 14:38:32 +0100113 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
115
Hanno Beckerca092242019-04-25 16:01:49 +0100116 ssl->negotiate_cid = enable;
117 if( enable == MBEDTLS_SSL_CID_DISABLED )
118 {
119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Disable use of CID extension." ) );
120 return( 0 );
121 }
122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Enable use of CID extension." ) );
Hanno Beckerad4a1372019-05-03 13:06:44 +0100123 MBEDTLS_SSL_DEBUG_BUF( 3, "Own CID", own_cid, own_cid_len );
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Hanno Beckerad4a1372019-05-03 13:06:44 +0100125 if( own_cid_len != ssl->conf->cid_len )
Hanno Beckerca092242019-04-25 16:01:49 +0100126 {
Hanno Beckerad4a1372019-05-03 13:06:44 +0100127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "CID length %u does not match CID length %u in config",
128 (unsigned) own_cid_len,
129 (unsigned) ssl->conf->cid_len ) );
Hanno Beckerca092242019-04-25 16:01:49 +0100130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
131 }
132
133 memcpy( ssl->own_cid, own_cid, own_cid_len );
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100134 /* Truncation is not an issue here because
135 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
136 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100137
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100138 return( 0 );
139}
140
Paul Elliott0113cf12022-03-11 20:26:47 +0000141int mbedtls_ssl_get_own_cid( mbedtls_ssl_context *ssl,
142 int *enabled,
143 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
144 size_t *own_cid_len )
145{
146 *enabled = MBEDTLS_SSL_CID_DISABLED;
147
148 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
149 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
150
151 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
152 * zero as this is indistinguishable from not requesting to use
153 * the CID extension. */
154 if( ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED )
155 return( 0 );
156
157 if( own_cid_len != NULL )
158 {
159 *own_cid_len = ssl->own_cid_len;
160 if( own_cid != NULL )
161 memcpy( own_cid, ssl->own_cid, ssl->own_cid_len );
162 }
163
164 *enabled = MBEDTLS_SSL_CID_ENABLED;
165
166 return( 0 );
167}
168
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100169int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
170 int *enabled,
171 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
172 size_t *peer_cid_len )
173{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100174 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100175
Hanno Becker76a79ab2019-05-03 14:38:32 +0100176 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Paul Elliott27b0d942022-03-18 21:55:32 +0000177 mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Hanno Becker76a79ab2019-05-03 14:38:32 +0100178 {
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100179 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker76a79ab2019-05-03 14:38:32 +0100180 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181
Hanno Beckerc5f24222019-05-03 12:54:52 +0100182 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
183 * were used, but client and server requested the empty CID.
184 * This is indistinguishable from not using the CID extension
185 * in the first place. */
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186 if( ssl->transform_in->in_cid_len == 0 &&
187 ssl->transform_in->out_cid_len == 0 )
188 {
189 return( 0 );
190 }
191
Hanno Becker615ef172019-05-22 16:50:35 +0100192 if( peer_cid_len != NULL )
193 {
194 *peer_cid_len = ssl->transform_in->out_cid_len;
195 if( peer_cid != NULL )
196 {
197 memcpy( peer_cid, ssl->transform_in->out_cid,
198 ssl->transform_in->out_cid_len );
199 }
200 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100201
202 *enabled = MBEDTLS_SSL_CID_ENABLED;
203
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100204 return( 0 );
205}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200211/*
212 * Convert max_fragment_length codes to length.
213 * RFC 6066 says:
214 * enum{
215 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
216 * } MaxFragmentLength;
217 * and we add 0 -> extension unused
218 */
Angus Grattond8213d02016-05-25 20:56:48 +1000219static unsigned int ssl_mfl_code_to_length( int mfl )
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200220{
Angus Grattond8213d02016-05-25 20:56:48 +1000221 switch( mfl )
222 {
223 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
224 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
225 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
226 return 512;
227 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
228 return 1024;
229 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
230 return 2048;
231 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
232 return 4096;
233 default:
234 return ( MBEDTLS_TLS_EXT_ADV_CONTENT_LEN );
235 }
236}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200238
Hanno Becker52055ae2019-02-06 14:30:46 +0000239int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
240 const mbedtls_ssl_session *src )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200241{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 mbedtls_ssl_session_free( dst );
243 memcpy( dst, src, sizeof( mbedtls_ssl_session ) );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200244
吴敬辉0b716112021-11-29 10:46:35 +0800245#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
246 dst->ticket = NULL;
247#endif
248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000250
251#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252 if( src->peer_cert != NULL )
253 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000254 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200255
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200256 dst->peer_cert = mbedtls_calloc( 1, sizeof(mbedtls_x509_crt) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200257 if( dst->peer_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200258 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260 mbedtls_x509_crt_init( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 if( ( ret = mbedtls_x509_crt_parse_der( dst->peer_cert, src->peer_cert->raw.p,
Manuel Pégourié-Gonnard4d2a8eb2014-06-13 20:33:27 +0200263 src->peer_cert->raw.len ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265 mbedtls_free( dst->peer_cert );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200266 dst->peer_cert = NULL;
267 return( ret );
268 }
269 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000270#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 if( src->peer_cert_digest != NULL )
272 {
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 dst->peer_cert_digest =
Hanno Beckeraccc5992019-02-25 10:06:59 +0000274 mbedtls_calloc( 1, src->peer_cert_digest_len );
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 if( dst->peer_cert_digest == NULL )
276 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
277
278 memcpy( dst->peer_cert_digest, src->peer_cert_digest,
279 src->peer_cert_digest_len );
280 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000281 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000282 }
283#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200287#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200288 if( src->ticket != NULL )
289 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200290 dst->ticket = mbedtls_calloc( 1, src->ticket_len );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200291 if( dst->ticket == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200292 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200293
294 memcpy( dst->ticket, src->ticket, src->ticket_len );
295 }
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200296#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297
298 return( 0 );
299}
300
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500301#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200302MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303static int resize_buffer( unsigned char **buffer, size_t len_new, size_t *len_old )
304{
305 unsigned char* resized_buffer = mbedtls_calloc( 1, len_new );
306 if( resized_buffer == NULL )
307 return -1;
308
309 /* We want to copy len_new bytes when downsizing the buffer, and
310 * len_old bytes when upsizing, so we choose the smaller of two sizes,
311 * to fit one buffer into another. Size checks, ensuring that no data is
312 * lost, are done outside of this function. */
313 memcpy( resized_buffer, *buffer,
314 ( len_new < *len_old ) ? len_new : *len_old );
315 mbedtls_platform_zeroize( *buffer, *len_old );
316 mbedtls_free( *buffer );
317
318 *buffer = resized_buffer;
319 *len_old = len_new;
320
321 return 0;
322}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200323
324static void handle_buffer_resizing( mbedtls_ssl_context *ssl, int downsizing,
Andrzej Kurek069fa962021-01-07 08:02:15 -0500325 size_t in_buf_new_len,
326 size_t out_buf_new_len )
Andrzej Kurek4a063792020-10-21 15:08:44 +0200327{
328 int modified = 0;
329 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
330 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
331 if( ssl->in_buf != NULL )
332 {
333 written_in = ssl->in_msg - ssl->in_buf;
334 iv_offset_in = ssl->in_iv - ssl->in_buf;
335 len_offset_in = ssl->in_len - ssl->in_buf;
336 if( downsizing ?
337 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
338 ssl->in_buf_len < in_buf_new_len )
339 {
340 if( resize_buffer( &ssl->in_buf, in_buf_new_len, &ssl->in_buf_len ) != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "input buffer resizing failed - out of memory" ) );
343 }
344 else
345 {
Paul Elliottb7449902021-03-10 18:14:58 +0000346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
347 in_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200348 modified = 1;
349 }
350 }
351 }
352
353 if( ssl->out_buf != NULL )
354 {
355 written_out = ssl->out_msg - ssl->out_buf;
356 iv_offset_out = ssl->out_iv - ssl->out_buf;
357 len_offset_out = ssl->out_len - ssl->out_buf;
358 if( downsizing ?
359 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
360 ssl->out_buf_len < out_buf_new_len )
361 {
362 if( resize_buffer( &ssl->out_buf, out_buf_new_len, &ssl->out_buf_len ) != 0 )
363 {
364 MBEDTLS_SSL_DEBUG_MSG( 1, ( "output buffer resizing failed - out of memory" ) );
365 }
366 else
367 {
Paul Elliottb7449902021-03-10 18:14:58 +0000368 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
369 out_buf_new_len ) );
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 modified = 1;
371 }
372 }
373 }
374 if( modified )
375 {
376 /* Update pointers here to avoid doing it twice. */
377 mbedtls_ssl_reset_in_out_pointers( ssl );
378 /* Fields below might not be properly updated with record
379 * splitting or with CID, so they are manually updated here. */
380 ssl->out_msg = ssl->out_buf + written_out;
381 ssl->out_len = ssl->out_buf + len_offset_out;
382 ssl->out_iv = ssl->out_buf + iv_offset_out;
383
384 ssl->in_msg = ssl->in_buf + written_in;
385 ssl->in_len = ssl->in_buf + len_offset_in;
386 ssl->in_iv = ssl->in_buf + iv_offset_in;
387 }
388}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500389#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
390
Jerry Yudb8c48a2022-01-27 14:54:54 +0800391#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
394typedef int (*tls_prf_fn)( const unsigned char *secret, size_t slen,
395 const char *label,
396 const unsigned char *random, size_t rlen,
397 unsigned char *dstbuf, size_t dlen );
398
399static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id );
400
401#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
402
403/* Type for the TLS PRF */
404typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
406 unsigned char *, size_t);
407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200408MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800409static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
410 int ciphersuite,
411 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yued14c932022-02-17 13:40:45 +0800413 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yued14c932022-02-17 13:40:45 +0800415 ssl_tls_prf_t tls_prf,
416 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -0400417 mbedtls_ssl_protocol_version tls_version,
Jerry Yued14c932022-02-17 13:40:45 +0800418 unsigned endpoint,
419 const mbedtls_ssl_context *ssl );
420
421#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200422MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800423static int tls_prf_sha256( const unsigned char *secret, size_t slen,
424 const char *label,
425 const unsigned char *random, size_t rlen,
426 unsigned char *dstbuf, size_t dlen );
427static void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *,unsigned char*, size_t * );
428static void ssl_calc_finished_tls_sha256( mbedtls_ssl_context *,unsigned char *, int );
429
430#endif /* MBEDTLS_SHA256_C */
431
432#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200433MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yued14c932022-02-17 13:40:45 +0800434static int tls_prf_sha384( const unsigned char *secret, size_t slen,
435 const char *label,
436 const unsigned char *random, size_t rlen,
437 unsigned char *dstbuf, size_t dlen );
438
439static void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *, unsigned char*, size_t * );
440static void ssl_calc_finished_tls_sha384( mbedtls_ssl_context *, unsigned char *, int );
441#endif /* MBEDTLS_SHA384_C */
442
Jerry Yu438ddd82022-07-07 06:55:50 +0000443static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800444 unsigned char *buf,
445 size_t buf_len );
Jerry Yu251a12e2022-07-13 15:15:48 +0800446
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200447MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +0000448static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yued14c932022-02-17 13:40:45 +0800449 const unsigned char *buf,
450 size_t len );
451#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
452
Jerry Yu53d23e22022-02-09 16:25:09 +0800453static void ssl_update_checksum_start( mbedtls_ssl_context *, const unsigned char *, size_t );
454
Jerry Yudb8c48a2022-01-27 14:54:54 +0800455#if defined(MBEDTLS_SHA256_C)
456static void ssl_update_checksum_sha256( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800457#endif /* MBEDTLS_SHA256_C */
Jerry Yudb8c48a2022-01-27 14:54:54 +0800458
459#if defined(MBEDTLS_SHA384_C)
460static void ssl_update_checksum_sha384( mbedtls_ssl_context *, const unsigned char *, size_t );
Jerry Yu53d23e22022-02-09 16:25:09 +0800461#endif /* MBEDTLS_SHA384_C */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000462
Ron Eldor51d3ab52019-05-12 14:54:30 +0300463int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
464 const unsigned char *secret, size_t slen,
465 const char *label,
466 const unsigned char *random, size_t rlen,
467 unsigned char *dstbuf, size_t dlen )
468{
469 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
470
471 switch( prf )
472 {
Ron Eldord2f25f72019-05-15 14:54:22 +0300473#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200474#if defined(MBEDTLS_SHA384_C)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300475 case MBEDTLS_SSL_TLS_PRF_SHA384:
476 tls_prf = tls_prf_sha384;
477 break;
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200478#endif /* MBEDTLS_SHA384_C */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300479#if defined(MBEDTLS_SHA256_C)
480 case MBEDTLS_SSL_TLS_PRF_SHA256:
481 tls_prf = tls_prf_sha256;
482 break;
Ron Eldord2f25f72019-05-15 14:54:22 +0300483#endif /* MBEDTLS_SHA256_C */
484#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ron Eldor51d3ab52019-05-12 14:54:30 +0300485 default:
486 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
487 }
488
489 return( tls_prf( secret, slen, label, random, rlen, dstbuf, dlen ) );
490}
491
Jerry Yuc73c6182022-02-08 20:29:25 +0800492#if defined(MBEDTLS_X509_CRT_PARSE_C)
493static void ssl_clear_peer_cert( mbedtls_ssl_session *session )
494{
495#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
496 if( session->peer_cert != NULL )
497 {
498 mbedtls_x509_crt_free( session->peer_cert );
499 mbedtls_free( session->peer_cert );
500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
503 if( session->peer_cert_digest != NULL )
504 {
505 /* Zeroization is not necessary. */
506 mbedtls_free( session->peer_cert_digest );
507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
515void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
516 const mbedtls_ssl_ciphersuite_t *ciphersuite_info )
517{
518 ((void) ciphersuite_info);
519
520#if defined(MBEDTLS_SHA384_C)
521 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
522 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
523 else
524#endif
525#if defined(MBEDTLS_SHA256_C)
526 if( ciphersuite_info->mac != MBEDTLS_MD_SHA384 )
527 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
528 else
529#endif
530 {
531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
532 return;
533 }
534}
535
XiaokangQianadab9a62022-07-18 07:41:26 +0000536void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
537 unsigned hs_type,
538 size_t total_hs_len )
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100539{
540 unsigned char hs_hdr[4];
541
542 /* Build HS header for checksum update. */
543 hs_hdr[0] = MBEDTLS_BYTE_0( hs_type );
544 hs_hdr[1] = MBEDTLS_BYTE_2( total_hs_len );
545 hs_hdr[2] = MBEDTLS_BYTE_1( total_hs_len );
546 hs_hdr[3] = MBEDTLS_BYTE_0( total_hs_len );
547
548 ssl->handshake->update_checksum( ssl, hs_hdr, sizeof( hs_hdr ) );
549}
550
551void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
552 unsigned hs_type,
553 unsigned char const *msg,
554 size_t msg_len )
555{
556 mbedtls_ssl_add_hs_hdr_to_checksum( ssl, hs_type, msg_len );
557 ssl->handshake->update_checksum( ssl, msg, msg_len );
558}
559
Jerry Yuc73c6182022-02-08 20:29:25 +0800560void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl )
561{
562 ((void) ssl);
563#if defined(MBEDTLS_SHA256_C)
564#if defined(MBEDTLS_USE_PSA_CRYPTO)
565 psa_hash_abort( &ssl->handshake->fin_sha256_psa );
566 psa_hash_setup( &ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
567#else
568 mbedtls_sha256_starts( &ssl->handshake->fin_sha256, 0 );
569#endif
570#endif
571#if defined(MBEDTLS_SHA384_C)
572#if defined(MBEDTLS_USE_PSA_CRYPTO)
573 psa_hash_abort( &ssl->handshake->fin_sha384_psa );
574 psa_hash_setup( &ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
575#else
576 mbedtls_sha512_starts( &ssl->handshake->fin_sha512, 1 );
577#endif
578#endif
579}
580
581static void ssl_update_checksum_start( mbedtls_ssl_context *ssl,
582 const unsigned char *buf, size_t len )
583{
584#if defined(MBEDTLS_SHA256_C)
585#if defined(MBEDTLS_USE_PSA_CRYPTO)
586 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
587#else
588 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
589#endif
590#endif
591#if defined(MBEDTLS_SHA384_C)
592#if defined(MBEDTLS_USE_PSA_CRYPTO)
593 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
594#else
595 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
596#endif
597#endif
598}
599
600#if defined(MBEDTLS_SHA256_C)
601static void ssl_update_checksum_sha256( mbedtls_ssl_context *ssl,
602 const unsigned char *buf, size_t len )
603{
604#if defined(MBEDTLS_USE_PSA_CRYPTO)
605 psa_hash_update( &ssl->handshake->fin_sha256_psa, buf, len );
606#else
607 mbedtls_sha256_update( &ssl->handshake->fin_sha256, buf, len );
608#endif
609}
610#endif
611
612#if defined(MBEDTLS_SHA384_C)
613static void ssl_update_checksum_sha384( mbedtls_ssl_context *ssl,
614 const unsigned char *buf, size_t len )
615{
616#if defined(MBEDTLS_USE_PSA_CRYPTO)
617 psa_hash_update( &ssl->handshake->fin_sha384_psa, buf, len );
618#else
619 mbedtls_sha512_update( &ssl->handshake->fin_sha512, buf, len );
620#endif
621}
622#endif
623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624static void ssl_handshake_params_init( mbedtls_ssl_handshake_params *handshake )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200625{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 memset( handshake, 0, sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500629#if defined(MBEDTLS_USE_PSA_CRYPTO)
630 handshake->fin_sha256_psa = psa_hash_operation_init();
631 psa_hash_setup( &handshake->fin_sha256_psa, PSA_ALG_SHA_256 );
632#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633 mbedtls_sha256_init( &handshake->fin_sha256 );
TRodziewicz26371e42021-06-08 16:45:41 +0200634 mbedtls_sha256_starts( &handshake->fin_sha256, 0 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200635#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500636#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200637#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500638#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500639 handshake->fin_sha384_psa = psa_hash_operation_init();
640 psa_hash_setup( &handshake->fin_sha384_psa, PSA_ALG_SHA_384 );
Andrzej Kurekeb342242019-01-29 09:14:33 -0500641#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642 mbedtls_sha512_init( &handshake->fin_sha512 );
TRodziewicz26371e42021-06-08 16:45:41 +0200643 mbedtls_sha512_starts( &handshake->fin_sha512, 1 );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200644#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500645#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200646
647 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#if defined(MBEDTLS_DHM_C)
650 mbedtls_dhm_init( &handshake->dhm_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200651#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +0200652#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653 mbedtls_ecdh_init( &handshake->ecdh_ctx );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200654#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200655#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200656 mbedtls_ecjpake_init( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200657#if defined(MBEDTLS_SSL_CLI_C)
658 handshake->ecjpake_cache = NULL;
659 handshake->ecjpake_cache_len = 0;
660#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200661#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200662
Gilles Peskineeccd8882020-03-10 12:19:08 +0100663#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200664 mbedtls_x509_crt_restart_init( &handshake->ecrs_ctx );
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200665#endif
666
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200667#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
668 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
669#endif
Hanno Becker75173122019-02-06 16:18:31 +0000670
671#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
672 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
673 mbedtls_pk_init( &handshake->peer_pubkey );
674#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200675}
676
Hanno Beckera18d1322018-01-03 14:27:32 +0000677void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 memset( transform, 0, sizeof(mbedtls_ssl_transform) );
Paul Bakker84bbeb52014-07-01 14:53:22 +0200680
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100681#if defined(MBEDTLS_USE_PSA_CRYPTO)
682 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
683 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100684#else
685 mbedtls_cipher_init( &transform->cipher_ctx_enc );
686 mbedtls_cipher_init( &transform->cipher_ctx_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100687#endif
688
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000689#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100690#if defined(MBEDTLS_USE_PSA_CRYPTO)
691 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
692 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100693#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200694 mbedtls_md_init( &transform->md_ctx_enc );
695 mbedtls_md_init( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +0000696#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100697#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200698}
699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700void mbedtls_ssl_session_init( mbedtls_ssl_session *session )
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200701{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 memset( session, 0, sizeof(mbedtls_ssl_session) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200703}
704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706static int ssl_handshake_init( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +0000707{
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200708 /* Clear old handshake information if present */
Paul Bakker48916f92012-09-16 19:57:18 +0000709 if( ssl->transform_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_ssl_transform_free( ssl->transform_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200711 if( ssl->session_negotiate )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200713 if( ssl->handshake )
Gilles Peskine9b562d52018-04-25 20:32:43 +0200714 mbedtls_ssl_handshake_free( ssl );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200715
716 /*
717 * Either the pointers are now NULL or cleared properly and can be freed.
718 * Now allocate missing structures.
719 */
720 if( ssl->transform_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200721 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200722 ssl->transform_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_transform) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200723 }
Paul Bakker48916f92012-09-16 19:57:18 +0000724
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200725 if( ssl->session_negotiate == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200726 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200727 ssl->session_negotiate = mbedtls_calloc( 1, sizeof(mbedtls_ssl_session) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200728 }
Paul Bakker48916f92012-09-16 19:57:18 +0000729
Paul Bakker82788fb2014-10-20 13:59:19 +0200730 if( ssl->handshake == NULL )
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200731 {
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200732 ssl->handshake = mbedtls_calloc( 1, sizeof(mbedtls_ssl_handshake_params) );
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200733 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500734#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
735 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400736
Andrzej Kurek4a063792020-10-21 15:08:44 +0200737 handle_buffer_resizing( ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
738 MBEDTLS_SSL_OUT_BUFFER_LEN );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500739#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000740
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200741 /* All pointers should exist and can be directly freed without issue */
Paul Bakker48916f92012-09-16 19:57:18 +0000742 if( ssl->handshake == NULL ||
743 ssl->transform_negotiate == NULL ||
744 ssl->session_negotiate == NULL )
745 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc() of ssl sub-contexts failed" ) );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748 mbedtls_free( ssl->handshake );
749 mbedtls_free( ssl->transform_negotiate );
750 mbedtls_free( ssl->session_negotiate );
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200751
752 ssl->handshake = NULL;
753 ssl->transform_negotiate = NULL;
754 ssl->session_negotiate = NULL;
755
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200756 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker48916f92012-09-16 19:57:18 +0000757 }
758
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200759 /* Initialize structures */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 mbedtls_ssl_session_init( ssl->session_negotiate );
Hanno Beckera18d1322018-01-03 14:27:32 +0000761 mbedtls_ssl_transform_init( ssl->transform_negotiate );
Paul Bakker968afaa2014-07-09 11:09:24 +0200762 ssl_handshake_params_init( ssl->handshake );
763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
766 {
767 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200768
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200769 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
770 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
771 else
772 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200773
Hanno Becker0f57a652020-02-05 10:37:26 +0000774 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200775 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +0200776#endif
777
Brett Warrene0edc842021-08-17 09:53:13 +0100778/*
779 * curve_list is translated to IANA TLS group identifiers here because
780 * mbedtls_ssl_conf_curves returns void and so can't return
781 * any error codes.
782 */
783#if defined(MBEDTLS_ECP_C)
784#if !defined(MBEDTLS_DEPRECATED_REMOVED)
785 /* Heap allocate and translate curve_list from internal to IANA group ids */
786 if ( ssl->conf->curve_list != NULL )
787 {
788 size_t length;
789 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
790
791 for( length = 0; ( curve_list[length] != MBEDTLS_ECP_DP_NONE ) &&
792 ( length < MBEDTLS_ECP_DP_MAX ); length++ ) {}
793
794 /* Leave room for zero termination */
795 uint16_t *group_list = mbedtls_calloc( length + 1, sizeof(uint16_t) );
796 if ( group_list == NULL )
797 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
798
799 for( size_t i = 0; i < length; i++ )
800 {
801 const mbedtls_ecp_curve_info *info =
802 mbedtls_ecp_curve_info_from_grp_id( curve_list[i] );
803 if ( info == NULL )
804 {
805 mbedtls_free( group_list );
806 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
807 }
808 group_list[i] = info->tls_id;
809 }
810
811 group_list[length] = 0;
812
813 ssl->handshake->group_list = group_list;
814 ssl->handshake->group_list_heap_allocated = 1;
815 }
816 else
817 {
818 ssl->handshake->group_list = ssl->conf->group_list;
819 ssl->handshake->group_list_heap_allocated = 0;
820 }
821#endif /* MBEDTLS_DEPRECATED_REMOVED */
822#endif /* MBEDTLS_ECP_C */
823
Jerry Yuf017ee42022-01-12 15:49:48 +0800824#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
825#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +0800826#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +0800827 /* Heap allocate and translate sig_hashes from internal hash identifiers to
828 signature algorithms IANA identifiers. */
829 if ( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) &&
Jerry Yuf017ee42022-01-12 15:49:48 +0800830 ssl->conf->sig_hashes != NULL )
831 {
832 const int *md;
833 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +0800834 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +0800835 uint16_t *p;
836
Jerry Yub476a442022-01-21 18:14:45 +0800837#if defined(static_assert)
838 static_assert( MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
839 <= ( SIZE_MAX - ( 2 * sizeof(uint16_t) ) ),
840 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big" );
Jerry Yua68dca22022-01-20 16:28:27 +0800841#endif
842
Jerry Yuf017ee42022-01-12 15:49:48 +0800843 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
844 {
845 if( mbedtls_ssl_hash_from_md_alg( *md ) == MBEDTLS_SSL_HASH_NONE )
846 continue;
Jerry Yub476a442022-01-21 18:14:45 +0800847#if defined(MBEDTLS_ECDSA_C)
848 sig_algs_len += sizeof( uint16_t );
849#endif
Jerry Yua68dca22022-01-20 16:28:27 +0800850
Jerry Yub476a442022-01-21 18:14:45 +0800851#if defined(MBEDTLS_RSA_C)
852 sig_algs_len += sizeof( uint16_t );
853#endif
854 if( sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN )
855 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
Jerry Yuf017ee42022-01-12 15:49:48 +0800856 }
857
Jerry Yub476a442022-01-21 18:14:45 +0800858 if( sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN )
Jerry Yuf017ee42022-01-12 15:49:48 +0800859 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
860
Jerry Yub476a442022-01-21 18:14:45 +0800861 ssl->handshake->sig_algs = mbedtls_calloc( 1, sig_algs_len +
862 sizeof( uint16_t ));
Jerry Yuf017ee42022-01-12 15:49:48 +0800863 if( ssl->handshake->sig_algs == NULL )
864 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
865
866 p = (uint16_t *)ssl->handshake->sig_algs;
867 for( md = sig_hashes; *md != MBEDTLS_MD_NONE; md++ )
868 {
869 unsigned char hash = mbedtls_ssl_hash_from_md_alg( *md );
870 if( hash == MBEDTLS_SSL_HASH_NONE )
871 continue;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800872#if defined(MBEDTLS_ECDSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800873 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA);
874 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800875#endif
876#if defined(MBEDTLS_RSA_C)
Jerry Yuf017ee42022-01-12 15:49:48 +0800877 *p = (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA);
878 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +0800879#endif
Jerry Yuf017ee42022-01-12 15:49:48 +0800880 }
Gabor Mezei15b95a62022-05-09 16:37:58 +0200881 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +0800882 ssl->handshake->sig_algs_heap_allocated = 1;
883 }
884 else
Jerry Yua69269a2022-01-17 21:06:01 +0800885#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +0800886 {
Jerry Yuf017ee42022-01-12 15:49:48 +0800887 ssl->handshake->sig_algs_heap_allocated = 0;
888 }
Jerry Yucc539102022-06-27 16:27:35 +0800889#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Jerry Yuf017ee42022-01-12 15:49:48 +0800890#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Paul Bakker48916f92012-09-16 19:57:18 +0000891 return( 0 );
892}
893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200895/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200896MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200897static int ssl_cookie_write_dummy( void *ctx,
898 unsigned char **p, unsigned char *end,
899 const unsigned char *cli_id, size_t cli_id_len )
900{
901 ((void) ctx);
902 ((void) p);
903 ((void) end);
904 ((void) cli_id);
905 ((void) cli_id_len);
906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200908}
909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200910MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200911static int ssl_cookie_check_dummy( void *ctx,
912 const unsigned char *cookie, size_t cookie_len,
913 const unsigned char *cli_id, size_t cli_id_len )
914{
915 ((void) ctx);
916 ((void) cookie);
917 ((void) cookie_len);
918 ((void) cli_id);
919 ((void) cli_id_len);
920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200922}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200923#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +0200924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925/*
926 * Initialize an SSL context
927 */
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200928void mbedtls_ssl_init( mbedtls_ssl_context *ssl )
929{
930 memset( ssl, 0, sizeof( mbedtls_ssl_context ) );
931}
932
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200933MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800934static int ssl_conf_version_check( const mbedtls_ssl_context *ssl )
935{
Ronald Cron086ee0b2022-03-15 15:18:51 +0100936 const mbedtls_ssl_config *conf = ssl->conf;
937
Ronald Cron6f135e12021-12-08 16:57:54 +0100938#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100939 if( mbedtls_ssl_conf_is_tls13_only( conf ) )
940 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000941 if( conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
942 {
943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS 1.3 is not yet supported." ) );
944 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
945 }
946
Jerry Yu60835a82021-08-04 10:13:52 +0800947 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls13 only." ) );
948 return( 0 );
949 }
950#endif
951
952#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100953 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800954 {
955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is tls12 only." ) );
956 return( 0 );
957 }
958#endif
959
Ronald Cron6f135e12021-12-08 16:57:54 +0100960#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron086ee0b2022-03-15 15:18:51 +0100961 if( mbedtls_ssl_conf_is_hybrid_tls12_tls13( conf ) )
Jerry Yu60835a82021-08-04 10:13:52 +0800962 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
964 {
965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2" ) );
966 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
967 }
968
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000969 if( conf->endpoint == MBEDTLS_SSL_IS_SERVER )
970 {
971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 server is not supported yet." ) );
972 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
973 }
974
975
Ronald Crone1d3f062022-02-10 14:50:54 +0100976 MBEDTLS_SSL_DEBUG_MSG( 4, ( "The SSL configuration is TLS 1.3 or TLS 1.2." ) );
977 return( 0 );
Jerry Yu60835a82021-08-04 10:13:52 +0800978 }
979#endif
980
981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "The SSL configuration is invalid." ) );
982 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
983}
984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +0800986static int ssl_conf_check(const mbedtls_ssl_context *ssl)
987{
988 int ret;
989 ret = ssl_conf_version_check( ssl );
990 if( ret != 0 )
991 return( ret );
992
993 /* Space for further checks */
994
995 return( 0 );
996}
997
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200998/*
999 * Setup an SSL context
1000 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001001
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001002int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001003 const mbedtls_ssl_config *conf )
Paul Bakker5121ce52009-01-03 21:22:43 +00001004{
Janos Follath865b3eb2019-12-16 11:46:15 +00001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001006 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1007 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001008
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001009 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001010
Jerry Yu60835a82021-08-04 10:13:52 +08001011 if( ( ret = ssl_conf_check( ssl ) ) != 0 )
1012 return( ret );
1013
Paul Bakker62f2dee2012-09-28 07:31:51 +00001014 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001015 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001016 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001017
1018 /* Set to NULL in case of an error condition */
1019 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001020
Darryl Greenb33cc762019-11-28 14:29:44 +00001021#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1022 ssl->in_buf_len = in_buf_len;
1023#endif
1024 ssl->in_buf = mbedtls_calloc( 1, in_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001025 if( ssl->in_buf == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001027 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001028 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001029 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001030 }
1031
Darryl Greenb33cc762019-11-28 14:29:44 +00001032#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1033 ssl->out_buf_len = out_buf_len;
1034#endif
1035 ssl->out_buf = mbedtls_calloc( 1, out_buf_len );
Angus Grattond8213d02016-05-25 20:56:48 +10001036 if( ssl->out_buf == NULL )
1037 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len ) );
k-stachowiak9f7798e2018-07-31 16:52:32 +02001039 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001040 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001041 }
1042
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001043 mbedtls_ssl_reset_in_out_pointers( ssl );
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001044
Johan Pascalb62bb512015-12-03 21:56:45 +01001045#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001046 memset( &ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info) );
Johan Pascalb62bb512015-12-03 21:56:45 +01001047#endif
1048
Paul Bakker48916f92012-09-16 19:57:18 +00001049 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
k-stachowiaka47911c2018-07-04 17:41:58 +02001050 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001051
1052 return( 0 );
k-stachowiaka47911c2018-07-04 17:41:58 +02001053
1054error:
1055 mbedtls_free( ssl->in_buf );
1056 mbedtls_free( ssl->out_buf );
1057
1058 ssl->conf = NULL;
1059
Darryl Greenb33cc762019-11-28 14:29:44 +00001060#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1061 ssl->in_buf_len = 0;
1062 ssl->out_buf_len = 0;
1063#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001064 ssl->in_buf = NULL;
1065 ssl->out_buf = NULL;
1066
1067 ssl->in_hdr = NULL;
1068 ssl->in_ctr = NULL;
1069 ssl->in_len = NULL;
1070 ssl->in_iv = NULL;
1071 ssl->in_msg = NULL;
1072
1073 ssl->out_hdr = NULL;
1074 ssl->out_ctr = NULL;
1075 ssl->out_len = NULL;
1076 ssl->out_iv = NULL;
1077 ssl->out_msg = NULL;
1078
k-stachowiak9f7798e2018-07-31 16:52:32 +02001079 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001080}
1081
1082/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001083 * Reset an initialized and used SSL context for re-use while retaining
1084 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001085 *
1086 * If partial is non-zero, keep data in the input buffer and client ID.
1087 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001088 */
XiaokangQian78b1fa72022-01-19 06:56:30 +00001089void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1090 int partial )
Paul Bakker7eb013f2011-10-06 12:37:39 +00001091{
Darryl Greenb33cc762019-11-28 14:29:44 +00001092#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1093 size_t in_buf_len = ssl->in_buf_len;
1094 size_t out_buf_len = ssl->out_buf_len;
1095#else
1096 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1097 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1098#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001099
Hanno Beckerb0302c42021-08-03 09:39:42 +01001100#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1101 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001102#endif
1103
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001104 /* Cancel any possibly running timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00001105 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001106
Hanno Beckerb0302c42021-08-03 09:39:42 +01001107 mbedtls_ssl_reset_in_out_pointers( ssl );
1108
1109 /* Reset incoming message parsing */
1110 ssl->in_offt = NULL;
1111 ssl->nb_zero = 0;
1112 ssl->in_msgtype = 0;
1113 ssl->in_msglen = 0;
1114 ssl->in_hslen = 0;
1115 ssl->keep_current_message = 0;
1116 ssl->transform_in = NULL;
1117
1118#if defined(MBEDTLS_SSL_PROTO_DTLS)
1119 ssl->next_record_offset = 0;
1120 ssl->in_epoch = 0;
1121#endif
1122
1123 /* Keep current datagram if partial == 1 */
1124 if( partial == 0 )
1125 {
1126 ssl->in_left = 0;
1127 memset( ssl->in_buf, 0, in_buf_len );
1128 }
1129
Ronald Cronad8c17b2022-06-10 17:18:09 +02001130 ssl->send_alert = 0;
1131
Hanno Beckerb0302c42021-08-03 09:39:42 +01001132 /* Reset outgoing message writing */
1133 ssl->out_msgtype = 0;
1134 ssl->out_msglen = 0;
1135 ssl->out_left = 0;
1136 memset( ssl->out_buf, 0, out_buf_len );
1137 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
1138 ssl->transform_out = NULL;
1139
1140#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1141 mbedtls_ssl_dtls_replay_reset( ssl );
1142#endif
1143
XiaokangQian2b01dc32022-01-21 02:53:13 +00001144#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001145 if( ssl->transform )
1146 {
1147 mbedtls_ssl_transform_free( ssl->transform );
1148 mbedtls_free( ssl->transform );
1149 ssl->transform = NULL;
1150 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001151#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1152
XiaokangQian2b01dc32022-01-21 02:53:13 +00001153#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1154 mbedtls_ssl_transform_free( ssl->transform_application );
1155 mbedtls_free( ssl->transform_application );
1156 ssl->transform_application = NULL;
1157
1158 if( ssl->handshake != NULL )
1159 {
1160 mbedtls_ssl_transform_free( ssl->handshake->transform_earlydata );
1161 mbedtls_free( ssl->handshake->transform_earlydata );
1162 ssl->handshake->transform_earlydata = NULL;
1163
1164 mbedtls_ssl_transform_free( ssl->handshake->transform_handshake );
1165 mbedtls_free( ssl->handshake->transform_handshake );
1166 ssl->handshake->transform_handshake = NULL;
1167 }
1168
XiaokangQian2b01dc32022-01-21 02:53:13 +00001169#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001170}
1171
1172int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial )
1173{
1174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1175
1176 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1177
XiaokangQian78b1fa72022-01-19 06:56:30 +00001178 mbedtls_ssl_session_reset_msg_layer( ssl, partial );
Hanno Beckerb0302c42021-08-03 09:39:42 +01001179
1180 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#if defined(MBEDTLS_SSL_RENEGOTIATION)
1182 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001183 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001184
1185 ssl->verify_data_len = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186 memset( ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
1187 memset( ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN );
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001188#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001190
Hanno Beckerb0302c42021-08-03 09:39:42 +01001191 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001192 ssl->session_out = NULL;
Paul Bakkerc0463502013-02-14 11:19:38 +01001193 if( ssl->session )
1194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001195 mbedtls_ssl_session_free( ssl->session );
1196 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01001197 ssl->session = NULL;
1198 }
1199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001201 ssl->alpn_chosen = NULL;
1202#endif
1203
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001204#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker4ccbf062018-08-10 11:20:38 +01001205#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001206 if( partial == 0 )
Hanno Becker4ccbf062018-08-10 11:20:38 +01001207#endif
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001208 {
1209 mbedtls_free( ssl->cli_id );
1210 ssl->cli_id = NULL;
1211 ssl->cli_id_len = 0;
1212 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001213#endif
1214
Paul Bakker48916f92012-09-16 19:57:18 +00001215 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
1216 return( ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001217
1218 return( 0 );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001219}
1220
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001221/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001222 * Reset an initialized and used SSL context for re-use while retaining
1223 * all application-set variables, function pointers and data.
1224 */
1225int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl )
1226{
Hanno Becker43aefe22020-02-05 10:44:56 +00001227 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001228}
1229
1230/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001231 * SSL set accessors
1232 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001233void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint )
Paul Bakker5121ce52009-01-03 21:22:43 +00001234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001235 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001236}
1237
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001238void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport )
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001239{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001240 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001241}
1242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001244void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001246 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001247}
1248#endif
1249
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001250void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001251{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001252 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001253}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001256
Hanno Becker1841b0a2018-08-24 11:13:57 +01001257void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1258 unsigned allow_packing )
Hanno Becker04da1892018-08-14 13:22:10 +01001259{
1260 ssl->disable_datagram_packing = !allow_packing;
1261}
1262
1263void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf,
1264 uint32_t min, uint32_t max )
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001265{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001266 conf->hs_timeout_min = min;
1267 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001268}
1269#endif
1270
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001271void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode )
Paul Bakker5121ce52009-01-03 21:22:43 +00001272{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001273 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001274}
1275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001277void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001278 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001279 void *p_vrfy )
1280{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001281 conf->f_vrfy = f_vrfy;
1282 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001283}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001285
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001286void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001287 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 void *p_rng )
1289{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001290 conf->f_rng = f_rng;
1291 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001292}
1293
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001294void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001295 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001296 void *p_dbg )
1297{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001298 conf->f_dbg = f_dbg;
1299 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001300}
1301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001303 void *p_bio,
Simon Butchere846b512016-03-01 17:31:49 +00001304 mbedtls_ssl_send_t *f_send,
1305 mbedtls_ssl_recv_t *f_recv,
1306 mbedtls_ssl_recv_timeout_t *f_recv_timeout )
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001307{
1308 ssl->p_bio = p_bio;
1309 ssl->f_send = f_send;
1310 ssl->f_recv = f_recv;
1311 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001312}
1313
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001314#if defined(MBEDTLS_SSL_PROTO_DTLS)
1315void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu )
1316{
1317 ssl->mtu = mtu;
1318}
1319#endif
1320
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001321void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout )
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001322{
1323 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001324}
1325
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001326void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1327 void *p_timer,
Simon Butchere846b512016-03-01 17:31:49 +00001328 mbedtls_ssl_set_timer_t *f_set_timer,
1329 mbedtls_ssl_get_timer_t *f_get_timer )
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001330{
1331 ssl->p_timer = p_timer;
1332 ssl->f_set_timer = f_set_timer;
1333 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001334
1335 /* Make sure we start with no timer running */
Hanno Becker0f57a652020-02-05 10:37:26 +00001336 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001337}
1338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001340void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01001341 void *p_cache,
1342 mbedtls_ssl_cache_get_t *f_get_cache,
1343 mbedtls_ssl_cache_set_t *f_set_cache )
Paul Bakker5121ce52009-01-03 21:22:43 +00001344{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001345 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001346 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001347 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001348}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#if defined(MBEDTLS_SSL_CLI_C)
1352int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session )
Paul Bakker5121ce52009-01-03 21:22:43 +00001353{
Janos Follath865b3eb2019-12-16 11:46:15 +00001354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001355
1356 if( ssl == NULL ||
1357 session == NULL ||
1358 ssl->session_negotiate == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001359 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001362 }
1363
Hanno Beckere810bbc2021-05-14 16:01:05 +01001364 if( ssl->handshake->resume == 1 )
1365 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
1366
Hanno Becker52055ae2019-02-06 14:30:46 +00001367 if( ( ret = mbedtls_ssl_session_copy( ssl->session_negotiate,
1368 session ) ) != 0 )
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001369 return( ret );
1370
Paul Bakker0a597072012-09-25 21:55:46 +00001371 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001372
1373 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001377void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1378 const int *ciphersuites )
1379{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001380 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001381}
1382
Ronald Cron6f135e12021-12-08 16:57:54 +01001383#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yucadebe52021-08-24 10:36:45 +08001384void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config *conf,
Hanno Becker71f1ed62021-07-24 06:01:47 +01001385 const int kex_modes )
1386{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001387 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001388}
Ronald Cron6f135e12021-12-08 16:57:54 +01001389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001392void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001393 const mbedtls_x509_crt_profile *profile )
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001394{
1395 conf->cert_profile = profile;
1396}
1397
Glenn Strauss36872db2022-01-22 05:06:31 -05001398static void ssl_key_cert_free( mbedtls_ssl_key_cert *key_cert )
1399{
1400 mbedtls_ssl_key_cert *cur = key_cert, *next;
1401
1402 while( cur != NULL )
1403 {
1404 next = cur->next;
1405 mbedtls_free( cur );
1406 cur = next;
1407 }
1408}
1409
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001410/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001411MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001412static int ssl_append_key_cert( mbedtls_ssl_key_cert **head,
1413 mbedtls_x509_crt *cert,
1414 mbedtls_pk_context *key )
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001415{
niisato8ee24222018-06-25 19:05:48 +09001416 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001417
Glenn Strauss36872db2022-01-22 05:06:31 -05001418 if( cert == NULL )
1419 {
1420 /* Free list if cert is null */
1421 ssl_key_cert_free( *head );
1422 *head = NULL;
1423 return( 0 );
1424 }
1425
niisato8ee24222018-06-25 19:05:48 +09001426 new_cert = mbedtls_calloc( 1, sizeof( mbedtls_ssl_key_cert ) );
1427 if( new_cert == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001428 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001429
niisato8ee24222018-06-25 19:05:48 +09001430 new_cert->cert = cert;
1431 new_cert->key = key;
1432 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001433
Glenn Strauss36872db2022-01-22 05:06:31 -05001434 /* Update head if the list was null, else add to the end */
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001435 if( *head == NULL )
Paul Bakker0333b972013-11-04 17:08:28 +01001436 {
niisato8ee24222018-06-25 19:05:48 +09001437 *head = new_cert;
Paul Bakker0333b972013-11-04 17:08:28 +01001438 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001439 else
1440 {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001441 mbedtls_ssl_key_cert *cur = *head;
1442 while( cur->next != NULL )
1443 cur = cur->next;
niisato8ee24222018-06-25 19:05:48 +09001444 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001445 }
1446
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001447 return( 0 );
1448}
1449
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001450int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001451 mbedtls_x509_crt *own_cert,
1452 mbedtls_pk_context *pk_key )
1453{
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001454 return( ssl_append_key_cert( &conf->key_cert, own_cert, pk_key ) );
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001455}
1456
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001457void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001458 mbedtls_x509_crt *ca_chain,
1459 mbedtls_x509_crl *ca_crl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001460{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001461 conf->ca_chain = ca_chain;
1462 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001463
1464#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1465 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1466 * cannot be used together. */
1467 conf->f_ca_cb = NULL;
1468 conf->p_ca_cb = NULL;
1469#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001470}
Hanno Becker5adaad92019-03-27 16:54:37 +00001471
1472#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1473void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
Hanno Beckerafd0b0a2019-03-27 16:55:01 +00001474 mbedtls_x509_crt_ca_cb_t f_ca_cb,
Hanno Becker5adaad92019-03-27 16:54:37 +00001475 void *p_ca_cb )
1476{
1477 conf->f_ca_cb = f_ca_cb;
1478 conf->p_ca_cb = p_ca_cb;
1479
1480 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1481 * cannot be used together. */
1482 conf->ca_chain = NULL;
1483 conf->ca_crl = NULL;
1484}
1485#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001487
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001488#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Glenn Strauss69894072022-01-24 12:58:00 -05001489const unsigned char *mbedtls_ssl_get_hs_sni( mbedtls_ssl_context *ssl,
1490 size_t *name_len )
1491{
1492 *name_len = ssl->handshake->sni_name_len;
1493 return( ssl->handshake->sni_name );
1494}
1495
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001496int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1497 mbedtls_x509_crt *own_cert,
1498 mbedtls_pk_context *pk_key )
1499{
1500 return( ssl_append_key_cert( &ssl->handshake->sni_key_cert,
1501 own_cert, pk_key ) );
1502}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001503
1504void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1505 mbedtls_x509_crt *ca_chain,
1506 mbedtls_x509_crl *ca_crl )
1507{
1508 ssl->handshake->sni_ca_chain = ca_chain;
1509 ssl->handshake->sni_ca_crl = ca_crl;
1510}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001511
Glenn Strauss999ef702022-03-11 01:37:23 -05001512#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1513void mbedtls_ssl_set_hs_dn_hints( mbedtls_ssl_context *ssl,
1514 const mbedtls_x509_crt *crt)
1515{
1516 ssl->handshake->dn_hints = crt;
1517}
1518#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1519
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001520void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1521 int authmode )
1522{
1523 ssl->handshake->sni_authmode = authmode;
1524}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001525#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1526
Hanno Becker8927c832019-04-03 12:52:50 +01001527#if defined(MBEDTLS_X509_CRT_PARSE_C)
1528void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1529 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1530 void *p_vrfy )
1531{
1532 ssl->f_vrfy = f_vrfy;
1533 ssl->p_vrfy = p_vrfy;
1534}
1535#endif
1536
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001537#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001538/*
1539 * Set EC J-PAKE password for current handshake
1540 */
1541int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1542 const unsigned char *pw,
1543 size_t pw_len )
1544{
1545 mbedtls_ecjpake_role role;
1546
Janos Follath8eb64132016-06-03 15:40:57 +01001547 if( ssl->handshake == NULL || ssl->conf == NULL )
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001548 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1549
1550 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
1551 role = MBEDTLS_ECJPAKE_SERVER;
1552 else
1553 role = MBEDTLS_ECJPAKE_CLIENT;
1554
1555 return( mbedtls_ecjpake_setup( &ssl->handshake->ecjpake_ctx,
1556 role,
1557 MBEDTLS_MD_SHA256,
1558 MBEDTLS_ECP_DP_SECP256R1,
1559 pw, pw_len ) );
1560}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001561#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001562
Gilles Peskineeccd8882020-03-10 12:19:08 +01001563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001564
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001565MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001566static int ssl_conf_psk_is_configured( mbedtls_ssl_config const *conf )
1567{
1568#if defined(MBEDTLS_USE_PSA_CRYPTO)
1569 if( !mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
1570 return( 1 );
1571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001572 if( conf->psk != NULL )
1573 return( 1 );
1574
1575 return( 0 );
1576}
1577
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001578static void ssl_conf_remove_psk( mbedtls_ssl_config *conf )
1579{
1580 /* Remove reference to existing PSK, if any. */
1581#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001582 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001583 {
1584 /* The maintenance of the PSK key slot is the
1585 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001586 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001587 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001588#endif /* MBEDTLS_USE_PSA_CRYPTO */
1589 if( conf->psk != NULL )
1590 {
1591 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
1592
1593 mbedtls_free( conf->psk );
1594 conf->psk = NULL;
1595 conf->psk_len = 0;
1596 }
1597
1598 /* Remove reference to PSK identity, if any. */
1599 if( conf->psk_identity != NULL )
1600 {
1601 mbedtls_free( conf->psk_identity );
1602 conf->psk_identity = NULL;
1603 conf->psk_identity_len = 0;
1604 }
1605}
1606
Hanno Becker7390c712018-11-15 13:33:04 +00001607/* This function assumes that PSK identity in the SSL config is unset.
1608 * It checks that the provided identity is well-formed and attempts
1609 * to make a copy of it in the SSL config.
1610 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001611MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7390c712018-11-15 13:33:04 +00001612static int ssl_conf_set_psk_identity( mbedtls_ssl_config *conf,
1613 unsigned char const *psk_identity,
1614 size_t psk_identity_len )
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001615{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001616 /* Identity len will be encoded on two bytes */
Hanno Becker7390c712018-11-15 13:33:04 +00001617 if( psk_identity == NULL ||
1618 ( psk_identity_len >> 16 ) != 0 ||
Angus Grattond8213d02016-05-25 20:56:48 +10001619 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001620 {
1621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1622 }
1623
Hanno Becker7390c712018-11-15 13:33:04 +00001624 conf->psk_identity = mbedtls_calloc( 1, psk_identity_len );
1625 if( conf->psk_identity == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001626 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker6db455e2013-09-18 17:29:31 +02001627
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001628 conf->psk_identity_len = psk_identity_len;
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001629 memcpy( conf->psk_identity, psk_identity, conf->psk_identity_len );
Paul Bakker5ad403f2013-09-18 21:21:30 +02001630
1631 return( 0 );
Paul Bakker6db455e2013-09-18 17:29:31 +02001632}
1633
Hanno Becker7390c712018-11-15 13:33:04 +00001634int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1635 const unsigned char *psk, size_t psk_len,
1636 const unsigned char *psk_identity, size_t psk_identity_len )
1637{
Janos Follath865b3eb2019-12-16 11:46:15 +00001638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001639
1640 /* We currently only support one PSK, raw or opaque. */
1641 if( ssl_conf_psk_is_configured( conf ) )
1642 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Becker7390c712018-11-15 13:33:04 +00001643
1644 /* Check and set raw PSK */
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001645 if( psk == NULL )
Hanno Becker7390c712018-11-15 13:33:04 +00001646 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001647 if( psk_len == 0 )
1648 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1649 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1651
Hanno Becker7390c712018-11-15 13:33:04 +00001652 if( ( conf->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
1653 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1654 conf->psk_len = psk_len;
1655 memcpy( conf->psk, psk, conf->psk_len );
1656
1657 /* Check and set PSK Identity */
1658 ret = ssl_conf_set_psk_identity( conf, psk_identity, psk_identity_len );
1659 if( ret != 0 )
1660 ssl_conf_remove_psk( conf );
1661
1662 return( ret );
1663}
1664
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001665static void ssl_remove_psk( mbedtls_ssl_context *ssl )
1666{
1667#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001668 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001669 {
Neil Armstrong501c9322022-05-03 09:35:09 +02001670 /* The maintenance of the external PSK key slot is the
1671 * user's responsibility. */
1672 if( ssl->handshake->psk_opaque_is_internal )
1673 {
1674 psa_destroy_key( ssl->handshake->psk_opaque );
1675 ssl->handshake->psk_opaque_is_internal = 0;
1676 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001677 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001678 }
Neil Armstronge952a302022-05-03 10:22:14 +02001679#else
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001680 if( ssl->handshake->psk != NULL )
1681 {
1682 mbedtls_platform_zeroize( ssl->handshake->psk,
1683 ssl->handshake->psk_len );
1684 mbedtls_free( ssl->handshake->psk );
1685 ssl->handshake->psk_len = 0;
1686 }
Neil Armstronge952a302022-05-03 10:22:14 +02001687#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001688}
1689
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001690int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1691 const unsigned char *psk, size_t psk_len )
1692{
Neil Armstrong501c9322022-05-03 09:35:09 +02001693#if defined(MBEDTLS_USE_PSA_CRYPTO)
1694 psa_key_attributes_t key_attributes = psa_key_attributes_init();
1695 psa_status_t status;
1696 psa_algorithm_t alg;
1697 mbedtls_svc_key_id_t key;
1698#endif /* MBEDTLS_USE_PSA_CRYPTO */
1699
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001700 if( psk == NULL || ssl->handshake == NULL )
1701 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1702
1703 if( psk_len > MBEDTLS_PSK_MAX_LEN )
1704 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1705
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001706 ssl_remove_psk( ssl );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001707
Neil Armstrong501c9322022-05-03 09:35:09 +02001708#if defined(MBEDTLS_USE_PSA_CRYPTO)
1709 if( ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384)
1710 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1711 else
1712 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1713
Jerry Yu568ec252022-07-22 21:27:34 +08001714#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1c105562022-07-10 06:32:38 +00001715 psa_set_key_usage_flags( &key_attributes,
1716 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT );
Jerry Yu568ec252022-07-22 21:27:34 +08001717#else
Neil Armstrong501c9322022-05-03 09:35:09 +02001718 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
Jerry Yu568ec252022-07-22 21:27:34 +08001719#endif
Neil Armstrong501c9322022-05-03 09:35:09 +02001720 psa_set_key_algorithm( &key_attributes, alg );
1721 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
1722
1723 status = psa_import_key( &key_attributes, psk, psk_len, &key );
1724 if( status != PSA_SUCCESS )
1725 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
1726
1727 /* Allow calling psa_destroy_key() on psk remove */
1728 ssl->handshake->psk_opaque_is_internal = 1;
1729 return mbedtls_ssl_set_hs_psk_opaque( ssl, key );
1730#else
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001731 if( ( ssl->handshake->psk = mbedtls_calloc( 1, psk_len ) ) == NULL )
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001732 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001733
1734 ssl->handshake->psk_len = psk_len;
1735 memcpy( ssl->handshake->psk, psk, ssl->handshake->psk_len );
1736
1737 return( 0 );
Neil Armstrong501c9322022-05-03 09:35:09 +02001738#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001739}
1740
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001741#if defined(MBEDTLS_USE_PSA_CRYPTO)
1742int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek03e01462022-01-03 12:53:24 +01001743 mbedtls_svc_key_id_t psk,
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001744 const unsigned char *psk_identity,
1745 size_t psk_identity_len )
1746{
Janos Follath865b3eb2019-12-16 11:46:15 +00001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001748
1749 /* We currently only support one PSK, raw or opaque. */
1750 if( ssl_conf_psk_is_configured( conf ) )
1751 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001752
Hanno Becker7390c712018-11-15 13:33:04 +00001753 /* Check and set opaque PSK */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001754 if( mbedtls_svc_key_id_is_null( psk ) )
Hanno Becker7390c712018-11-15 13:33:04 +00001755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ronald Croncf56a0a2020-08-04 09:51:30 +02001756 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00001757
1758 /* Check and set PSK Identity */
1759 ret = ssl_conf_set_psk_identity( conf, psk_identity,
1760 psk_identity_len );
1761 if( ret != 0 )
1762 ssl_conf_remove_psk( conf );
1763
1764 return( ret );
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001765}
1766
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01001767int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
1768 mbedtls_svc_key_id_t psk )
1769{
1770 if( ( mbedtls_svc_key_id_is_null( psk ) ) ||
1771 ( ssl->handshake == NULL ) )
1772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1773
1774 ssl_remove_psk( ssl );
1775 ssl->handshake->psk_opaque = psk;
1776 return( 0 );
1777}
1778#endif /* MBEDTLS_USE_PSA_CRYPTO */
1779
1780void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1781 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1782 size_t),
1783 void *p_psk )
1784{
1785 conf->f_psk = f_psk;
1786 conf->p_psk = p_psk;
1787}
1788#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1789
1790#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02001791static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1792 psa_algorithm_t alg )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001793{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001794#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001795 if( alg == PSA_ALG_CBC_NO_PADDING )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001796 return( MBEDTLS_SSL_MODE_CBC );
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001797#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001798 if( PSA_ALG_IS_AEAD( alg ) )
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001799 return( MBEDTLS_SSL_MODE_AEAD );
Gilles Peskine301711e2022-04-26 16:57:05 +02001800 return( MBEDTLS_SSL_MODE_STREAM );
1801}
1802
1803#else /* MBEDTLS_USE_PSA_CRYPTO */
1804
1805static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
1806 mbedtls_cipher_mode_t mode )
1807{
1808#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
1809 if( mode == MBEDTLS_MODE_CBC )
1810 return( MBEDTLS_SSL_MODE_CBC );
1811#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
1812
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001813#if defined(MBEDTLS_GCM_C) || \
1814 defined(MBEDTLS_CCM_C) || \
1815 defined(MBEDTLS_CHACHAPOLY_C)
1816 if( mode == MBEDTLS_MODE_GCM ||
1817 mode == MBEDTLS_MODE_CCM ||
1818 mode == MBEDTLS_MODE_CHACHAPOLY )
1819 return( MBEDTLS_SSL_MODE_AEAD );
1820#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001821
1822 return( MBEDTLS_SSL_MODE_STREAM );
1823}
Gilles Peskine301711e2022-04-26 16:57:05 +02001824#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02001825
Gilles Peskinee108d982022-04-26 16:50:40 +02001826static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
1827 mbedtls_ssl_mode_t base_mode,
1828 int encrypt_then_mac )
1829{
1830#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1831 if( encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
1832 base_mode == MBEDTLS_SSL_MODE_CBC )
1833 {
1834 return( MBEDTLS_SSL_MODE_CBC_ETM );
1835 }
1836#else
1837 (void) encrypt_then_mac;
1838#endif
1839 return( base_mode );
1840}
1841
Neil Armstrongab555e02022-04-04 11:07:59 +02001842mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001843 const mbedtls_ssl_transform *transform )
1844{
Gilles Peskinee108d982022-04-26 16:50:40 +02001845 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskinee108d982022-04-26 16:50:40 +02001847 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001848#else
Gilles Peskinee108d982022-04-26 16:50:40 +02001849 mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc )
1850#endif
1851 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001852
Gilles Peskinee108d982022-04-26 16:50:40 +02001853 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001854#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02001855 encrypt_then_mac = transform->encrypt_then_mac;
1856#endif
1857 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001858}
1859
Neil Armstrongab555e02022-04-04 11:07:59 +02001860mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001861#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001862 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02001863#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001864 const mbedtls_ssl_ciphersuite_t *suite )
1865{
Gilles Peskinee108d982022-04-26 16:50:40 +02001866 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
1867
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001868#if defined(MBEDTLS_USE_PSA_CRYPTO)
1869 psa_status_t status;
1870 psa_algorithm_t alg;
1871 psa_key_type_t type;
1872 size_t size;
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001873 status = mbedtls_ssl_cipher_to_psa( suite->cipher, 0, &alg, &type, &size );
1874 if( status == PSA_SUCCESS )
Gilles Peskinee108d982022-04-26 16:50:40 +02001875 base_mode = mbedtls_ssl_get_base_mode( alg );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001876#else
1877 const mbedtls_cipher_info_t *cipher =
1878 mbedtls_cipher_info_from_type( suite->cipher );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001879 if( cipher != NULL )
Gilles Peskinee108d982022-04-26 16:50:40 +02001880 {
1881 base_mode =
1882 mbedtls_ssl_get_base_mode(
1883 mbedtls_cipher_info_get_mode( cipher ) );
1884 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001885#endif /* MBEDTLS_USE_PSA_CRYPTO */
1886
Gilles Peskinee108d982022-04-26 16:50:40 +02001887#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
1888 int encrypt_then_mac = 0;
1889#endif
1890 return( mbedtls_ssl_get_actual_mode( base_mode, encrypt_then_mac ) );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02001891}
1892
Neil Armstrong8395d7a2022-05-18 11:44:56 +02001893#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08001894
1895#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00001896/* Serialization of TLS 1.3 sessions:
1897 *
1898 * struct {
1899 * uint64 ticket_received;
1900 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08001901 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00001902 * } ClientOnlyData;
1903 *
1904 * struct {
1905 * uint8 endpoint;
1906 * uint8 ciphersuite[2];
1907 * uint32 ticket_age_add;
1908 * uint8 ticket_flags;
1909 * opaque resumption_key<0..255>;
1910 * select ( endpoint ) {
1911 * case client: ClientOnlyData;
1912 * case server: uint64 start_time;
1913 * };
1914 * } serialized_session_tls13;
1915 *
1916 */
1917#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08001918MBEDTLS_CHECK_RETURN_CRITICAL
1919static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
1920 unsigned char *buf,
1921 size_t buf_len,
1922 size_t *olen )
Jerry Yu438ddd82022-07-07 06:55:50 +00001923{
1924 unsigned char *p = buf;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001925 size_t needed = 1 /* endpoint */
1926 + 2 /* ciphersuite */
1927 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08001928 + 1 /* ticket_flags */
1929 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08001930 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08001931
1932 if( session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN )
1933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1934 needed += session->resumption_key_len; /* resumption_key */
1935
Jerry Yu438ddd82022-07-07 06:55:50 +00001936#if defined(MBEDTLS_HAVE_TIME)
1937 needed += 8; /* start_time or ticket_received */
1938#endif
1939
1940#if defined(MBEDTLS_SSL_CLI_C)
1941 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1942 {
1943 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08001944 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08001945
1946 /* Check size_t overflow */
Jerry Yue36fdd62022-08-17 21:31:36 +08001947 if( session->ticket_len > SIZE_MAX - needed )
Jerry Yu34191072022-08-18 10:32:09 +08001948 {
Jerry Yue36fdd62022-08-17 21:31:36 +08001949 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu34191072022-08-18 10:32:09 +08001950 }
1951
Jerry Yue36fdd62022-08-17 21:31:36 +08001952 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00001953 }
1954#endif /* MBEDTLS_SSL_CLI_C */
1955
Jerry Yue36fdd62022-08-17 21:31:36 +08001956 *olen = needed;
Jerry Yu438ddd82022-07-07 06:55:50 +00001957 if( needed > buf_len )
Jerry Yue36fdd62022-08-17 21:31:36 +08001958 {
1959 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1960 }
Jerry Yu438ddd82022-07-07 06:55:50 +00001961
1962 p[0] = session->endpoint;
1963 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 1 );
1964 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 3 );
1965 p[7] = session->ticket_flags;
1966
1967 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08001968 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001969 p += 9;
Jerry Yubc7c1a42022-07-21 22:57:37 +08001970 memcpy( p, session->resumption_key, session->resumption_key_len );
1971 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00001972
1973#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
1974 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
1975 {
1976 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->start, p, 0 );
1977 p += 8;
1978 }
1979#endif /* MBEDTLS_HAVE_TIME */
1980
1981#if defined(MBEDTLS_SSL_CLI_C)
1982 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
1983 {
1984#if defined(MBEDTLS_HAVE_TIME)
1985 MBEDTLS_PUT_UINT64_BE( (uint64_t) session->ticket_received, p, 0 );
1986 p += 8;
1987#endif
1988 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
1989 p += 4;
1990
1991 MBEDTLS_PUT_UINT16_BE( session->ticket_len, p, 0 );
1992 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08001993
1994 if( session->ticket != NULL && session->ticket_len > 0 )
Jerry Yu438ddd82022-07-07 06:55:50 +00001995 {
1996 memcpy( p, session->ticket, session->ticket_len );
1997 p += session->ticket_len;
1998 }
1999 }
2000#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yue36fdd62022-08-17 21:31:36 +08002001 return( 0 );
Jerry Yu438ddd82022-07-07 06:55:50 +00002002}
2003
2004MBEDTLS_CHECK_RETURN_CRITICAL
2005static int ssl_tls13_session_load( mbedtls_ssl_session *session,
2006 const unsigned char *buf,
2007 size_t len )
2008{
2009 const unsigned char *p = buf;
2010 const unsigned char *end = buf + len;
2011
2012 if( end - p < 9 )
2013 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2014 session->endpoint = p[0];
2015 session->ciphersuite = MBEDTLS_GET_UINT16_BE( p, 1 );
2016 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 3 );
2017 session->ticket_flags = p[7];
2018
2019 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002020 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002021 p += 9;
2022
Jerry Yubc7c1a42022-07-21 22:57:37 +08002023 if( end - p < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002024 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2025
Jerry Yubc7c1a42022-07-21 22:57:37 +08002026 if( sizeof( session->resumption_key ) < session->resumption_key_len )
Jerry Yu438ddd82022-07-07 06:55:50 +00002027 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yubc7c1a42022-07-21 22:57:37 +08002028 memcpy( session->resumption_key, p, session->resumption_key_len );
2029 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002030
2031#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
2032 if( session->endpoint == MBEDTLS_SSL_IS_SERVER )
2033 {
2034 if( end - p < 8 )
2035 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2036 session->start = MBEDTLS_GET_UINT64_BE( p, 0 );
2037 p += 8;
2038 }
2039#endif /* MBEDTLS_HAVE_TIME */
2040
2041#if defined(MBEDTLS_SSL_CLI_C)
2042 if( session->endpoint == MBEDTLS_SSL_IS_CLIENT )
2043 {
2044#if defined(MBEDTLS_HAVE_TIME)
2045 if( end - p < 8 )
2046 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2047 session->ticket_received = MBEDTLS_GET_UINT64_BE( p, 0 );
2048 p += 8;
2049#endif
2050 if( end - p < 4 )
2051 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2052 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
2053 p += 4;
2054
2055 if( end - p < 2 )
2056 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2057 session->ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2058 p += 2;
2059
2060 if( end - p < ( long int )session->ticket_len )
2061 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2062 if( session->ticket_len > 0 )
2063 {
2064 session->ticket = mbedtls_calloc( 1, session->ticket_len );
2065 if( session->ticket == NULL )
2066 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2067 memcpy( session->ticket, p, session->ticket_len );
2068 p += session->ticket_len;
2069 }
2070 }
2071#endif /* MBEDTLS_SSL_CLI_C */
2072
2073 return( 0 );
2074
2075}
2076#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002077MBEDTLS_CHECK_RETURN_CRITICAL
2078static int ssl_tls13_session_save( const mbedtls_ssl_session *session,
2079 unsigned char *buf,
2080 size_t buf_len,
2081 size_t *olen )
Jerry Yu251a12e2022-07-13 15:15:48 +08002082{
2083 ((void) session);
2084 ((void) buf);
2085 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002086 *olen = 0;
2087 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu251a12e2022-07-13 15:15:48 +08002088}
Jerry Yu438ddd82022-07-07 06:55:50 +00002089
2090static int ssl_tls13_session_load( const mbedtls_ssl_session *session,
2091 unsigned char *buf,
2092 size_t buf_len )
2093{
2094 ((void) session);
2095 ((void) buf);
2096 ((void) buf_len);
2097 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2098}
2099#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002100#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2101
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01002102psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002103 size_t taglen,
2104 psa_algorithm_t *alg,
2105 psa_key_type_t *key_type,
2106 size_t *key_size )
2107{
2108 switch ( mbedtls_cipher_type )
2109 {
2110 case MBEDTLS_CIPHER_AES_128_CBC:
2111 *alg = PSA_ALG_CBC_NO_PADDING;
2112 *key_type = PSA_KEY_TYPE_AES;
2113 *key_size = 128;
2114 break;
2115 case MBEDTLS_CIPHER_AES_128_CCM:
2116 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2117 *key_type = PSA_KEY_TYPE_AES;
2118 *key_size = 128;
2119 break;
2120 case MBEDTLS_CIPHER_AES_128_GCM:
2121 *alg = PSA_ALG_GCM;
2122 *key_type = PSA_KEY_TYPE_AES;
2123 *key_size = 128;
2124 break;
2125 case MBEDTLS_CIPHER_AES_192_CCM:
2126 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2127 *key_type = PSA_KEY_TYPE_AES;
2128 *key_size = 192;
2129 break;
2130 case MBEDTLS_CIPHER_AES_192_GCM:
2131 *alg = PSA_ALG_GCM;
2132 *key_type = PSA_KEY_TYPE_AES;
2133 *key_size = 192;
2134 break;
2135 case MBEDTLS_CIPHER_AES_256_CBC:
2136 *alg = PSA_ALG_CBC_NO_PADDING;
2137 *key_type = PSA_KEY_TYPE_AES;
2138 *key_size = 256;
2139 break;
2140 case MBEDTLS_CIPHER_AES_256_CCM:
2141 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2142 *key_type = PSA_KEY_TYPE_AES;
2143 *key_size = 256;
2144 break;
2145 case MBEDTLS_CIPHER_AES_256_GCM:
2146 *alg = PSA_ALG_GCM;
2147 *key_type = PSA_KEY_TYPE_AES;
2148 *key_size = 256;
2149 break;
2150 case MBEDTLS_CIPHER_ARIA_128_CBC:
2151 *alg = PSA_ALG_CBC_NO_PADDING;
2152 *key_type = PSA_KEY_TYPE_ARIA;
2153 *key_size = 128;
2154 break;
2155 case MBEDTLS_CIPHER_ARIA_128_CCM:
2156 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2157 *key_type = PSA_KEY_TYPE_ARIA;
2158 *key_size = 128;
2159 break;
2160 case MBEDTLS_CIPHER_ARIA_128_GCM:
2161 *alg = PSA_ALG_GCM;
2162 *key_type = PSA_KEY_TYPE_ARIA;
2163 *key_size = 128;
2164 break;
2165 case MBEDTLS_CIPHER_ARIA_192_CCM:
2166 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2167 *key_type = PSA_KEY_TYPE_ARIA;
2168 *key_size = 192;
2169 break;
2170 case MBEDTLS_CIPHER_ARIA_192_GCM:
2171 *alg = PSA_ALG_GCM;
2172 *key_type = PSA_KEY_TYPE_ARIA;
2173 *key_size = 192;
2174 break;
2175 case MBEDTLS_CIPHER_ARIA_256_CBC:
2176 *alg = PSA_ALG_CBC_NO_PADDING;
2177 *key_type = PSA_KEY_TYPE_ARIA;
2178 *key_size = 256;
2179 break;
2180 case MBEDTLS_CIPHER_ARIA_256_CCM:
2181 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2182 *key_type = PSA_KEY_TYPE_ARIA;
2183 *key_size = 256;
2184 break;
2185 case MBEDTLS_CIPHER_ARIA_256_GCM:
2186 *alg = PSA_ALG_GCM;
2187 *key_type = PSA_KEY_TYPE_ARIA;
2188 *key_size = 256;
2189 break;
2190 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2191 *alg = PSA_ALG_CBC_NO_PADDING;
2192 *key_type = PSA_KEY_TYPE_CAMELLIA;
2193 *key_size = 128;
2194 break;
2195 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2196 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2197 *key_type = PSA_KEY_TYPE_CAMELLIA;
2198 *key_size = 128;
2199 break;
2200 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2201 *alg = PSA_ALG_GCM;
2202 *key_type = PSA_KEY_TYPE_CAMELLIA;
2203 *key_size = 128;
2204 break;
2205 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2206 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2207 *key_type = PSA_KEY_TYPE_CAMELLIA;
2208 *key_size = 192;
2209 break;
2210 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2211 *alg = PSA_ALG_GCM;
2212 *key_type = PSA_KEY_TYPE_CAMELLIA;
2213 *key_size = 192;
2214 break;
2215 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2216 *alg = PSA_ALG_CBC_NO_PADDING;
2217 *key_type = PSA_KEY_TYPE_CAMELLIA;
2218 *key_size = 256;
2219 break;
2220 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2221 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2222 *key_type = PSA_KEY_TYPE_CAMELLIA;
2223 *key_size = 256;
2224 break;
2225 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2226 *alg = PSA_ALG_GCM;
2227 *key_type = PSA_KEY_TYPE_CAMELLIA;
2228 *key_size = 256;
2229 break;
2230 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2231 *alg = PSA_ALG_CHACHA20_POLY1305;
2232 *key_type = PSA_KEY_TYPE_CHACHA20;
2233 *key_size = 256;
2234 break;
2235 case MBEDTLS_CIPHER_NULL:
2236 *alg = MBEDTLS_SSL_NULL_CIPHER;
2237 *key_type = 0;
2238 *key_size = 0;
2239 break;
2240 default:
2241 return PSA_ERROR_NOT_SUPPORTED;
2242 }
2243
2244 return PSA_SUCCESS;
2245}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002246#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002247
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002248#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002249int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2250 const unsigned char *dhm_P, size_t P_len,
2251 const unsigned char *dhm_G, size_t G_len )
2252{
Janos Follath865b3eb2019-12-16 11:46:15 +00002253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002254
Glenn Strausscee11292021-12-20 01:43:17 -05002255 mbedtls_mpi_free( &conf->dhm_P );
2256 mbedtls_mpi_free( &conf->dhm_G );
2257
Hanno Beckera90658f2017-10-04 15:29:08 +01002258 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2259 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2260 {
2261 mbedtls_mpi_free( &conf->dhm_P );
2262 mbedtls_mpi_free( &conf->dhm_G );
2263 return( ret );
2264 }
2265
2266 return( 0 );
2267}
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002269int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002270{
Janos Follath865b3eb2019-12-16 11:46:15 +00002271 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002272
Glenn Strausscee11292021-12-20 01:43:17 -05002273 mbedtls_mpi_free( &conf->dhm_P );
2274 mbedtls_mpi_free( &conf->dhm_G );
2275
Gilles Peskinee5702482021-06-11 21:59:08 +02002276 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2277 &conf->dhm_P ) ) != 0 ||
2278 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2279 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002280 {
2281 mbedtls_mpi_free( &conf->dhm_P );
2282 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002283 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002284 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002285
2286 return( 0 );
2287}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002288#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002289
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002290#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2291/*
2292 * Set the minimum length for Diffie-Hellman parameters
2293 */
2294void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2295 unsigned int bitlen )
2296{
2297 conf->dhm_min_bitlen = bitlen;
2298}
2299#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2300
Gilles Peskineeccd8882020-03-10 12:19:08 +01002301#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002302#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002303/*
2304 * Set allowed/preferred hashes for handshake signatures
2305 */
2306void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2307 const int *hashes )
2308{
2309 conf->sig_hashes = hashes;
2310}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002311#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002312
Jerry Yuf017ee42022-01-12 15:49:48 +08002313/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002314void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2315 const uint16_t* sig_algs )
2316{
Jerry Yuf017ee42022-01-12 15:49:48 +08002317#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2318 conf->sig_hashes = NULL;
2319#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2320 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002321}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002322#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002323
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002324#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002325#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002326/*
2327 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002328 *
2329 * mbedtls_ssl_setup() takes the provided list
2330 * and translates it to a list of IANA TLS group identifiers,
2331 * stored in ssl->handshake->group_list.
2332 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002333 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002334void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002335 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002336{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002337 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002338 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002339}
Brett Warrene0edc842021-08-17 09:53:13 +01002340#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002341#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002342
Brett Warrene0edc842021-08-17 09:53:13 +01002343/*
2344 * Set the allowed groups
2345 */
2346void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2347 const uint16_t *group_list )
2348{
2349#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2350 conf->curve_list = NULL;
2351#endif
2352 conf->group_list = group_list;
2353}
2354
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002355#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002357{
Hanno Becker947194e2017-04-07 13:25:49 +01002358 /* Initialize to suppress unnecessary compiler warning */
2359 size_t hostname_len = 0;
2360
2361 /* Check if new hostname is valid before
2362 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002363 if( hostname != NULL )
2364 {
2365 hostname_len = strlen( hostname );
2366
2367 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2368 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2369 }
2370
2371 /* Now it's clear that we will overwrite the old hostname,
2372 * so we can free it safely */
2373
2374 if( ssl->hostname != NULL )
2375 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002376 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002377 mbedtls_free( ssl->hostname );
2378 }
2379
2380 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002381
Paul Bakker5121ce52009-01-03 21:22:43 +00002382 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002383 {
2384 ssl->hostname = NULL;
2385 }
2386 else
2387 {
2388 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002389 if( ssl->hostname == NULL )
2390 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002391
Hanno Becker947194e2017-04-07 13:25:49 +01002392 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002393
Hanno Becker947194e2017-04-07 13:25:49 +01002394 ssl->hostname[hostname_len] = '\0';
2395 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
2397 return( 0 );
2398}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002399#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002400
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002401#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002402void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002404 const unsigned char *, size_t),
2405 void *p_sni )
2406{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002407 conf->f_sni = f_sni;
2408 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002409}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002413int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002414{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002415 size_t cur_len, tot_len;
2416 const char **p;
2417
2418 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002419 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2420 * MUST NOT be truncated."
2421 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002422 */
2423 tot_len = 0;
2424 for( p = protos; *p != NULL; p++ )
2425 {
2426 cur_len = strlen( *p );
2427 tot_len += cur_len;
2428
Ronald Cron8216dd32020-04-23 16:41:44 +02002429 if( ( cur_len == 0 ) ||
2430 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2431 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002433 }
2434
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002435 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002436
2437 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002438}
2439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002441{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002442 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002443}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002445
Johan Pascalb62bb512015-12-03 21:56:45 +01002446#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002447void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2448 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002449{
2450 conf->dtls_srtp_mki_support = support_mki_value;
2451}
2452
Ron Eldoref72faf2018-07-12 11:54:20 +03002453int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2454 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002455 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002456{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002457 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002458 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002459 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002460 }
Ron Eldor591f1622018-01-22 12:30:04 +02002461
2462 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002463 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002464 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002465 }
Ron Eldor591f1622018-01-22 12:30:04 +02002466
2467 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2468 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002469 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002470}
2471
Ron Eldoref72faf2018-07-12 11:54:20 +03002472int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002473 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002474{
Johan Pascal253d0262020-09-22 13:04:45 +02002475 const mbedtls_ssl_srtp_profile *p;
2476 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002477
Johan Pascal253d0262020-09-22 13:04:45 +02002478 /* check the profiles list: all entry must be valid,
2479 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002480 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2481 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2482 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002483 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002484 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002485 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002486 list_size++;
2487 }
2488 else
2489 {
2490 /* unsupported value, stop parsing and set the size to an error value */
2491 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002492 }
2493 }
2494
Johan Pascal5ef72d22020-10-28 17:05:47 +01002495 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002496 {
Johan Pascal253d0262020-09-22 13:04:45 +02002497 conf->dtls_srtp_profile_list = NULL;
2498 conf->dtls_srtp_profile_list_len = 0;
2499 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2500 }
2501
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002502 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002503 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002504
2505 return( 0 );
2506}
2507
Johan Pascal5ef72d22020-10-28 17:05:47 +01002508void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2509 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002510{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002511 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2512 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002513 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002514 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002515 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002516 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002517 else
2518 {
2519 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002520 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2521 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002522 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002523}
Johan Pascalb62bb512015-12-03 21:56:45 +01002524#endif /* MBEDTLS_SSL_DTLS_SRTP */
2525
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302526#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002527void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002528{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002529 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002530}
2531
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002532void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002533{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002534 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002535}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302536#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002537
Janos Follath088ce432017-04-10 12:42:31 +01002538#if defined(MBEDTLS_SSL_SRV_C)
2539void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2540 char cert_req_ca_list )
2541{
2542 conf->cert_req_ca_list = cert_req_ca_list;
2543}
2544#endif
2545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002547void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002548{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002549 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002550}
2551#endif
2552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002554void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002555{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002556 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002557}
2558#endif
2559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002561int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002562{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002564 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002565 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002567 }
2568
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002569 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002570
2571 return( 0 );
2572}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002574
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002575void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002576{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002577 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002578}
2579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002581void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002582{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002583 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002584}
2585
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002586void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002587{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002588 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002589}
2590
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002591void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002592 const unsigned char period[8] )
2593{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002594 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002595}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002599#if defined(MBEDTLS_SSL_CLI_C)
2600void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002601{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002602 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002603}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002604#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002605
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002606#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002607void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2608 mbedtls_ssl_ticket_write_t *f_ticket_write,
2609 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2610 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002611{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002612 conf->f_ticket_write = f_ticket_write;
2613 conf->f_ticket_parse = f_ticket_parse;
2614 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002615}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002616#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002618
Hanno Becker7e6c1782021-06-08 09:24:55 +01002619void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2620 mbedtls_ssl_export_keys_t *f_export_keys,
2621 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002622{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002623 ssl->f_export_keys = f_export_keys;
2624 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002625}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002626
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002627#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002628void mbedtls_ssl_conf_async_private_cb(
2629 mbedtls_ssl_config *conf,
2630 mbedtls_ssl_async_sign_t *f_async_sign,
2631 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2632 mbedtls_ssl_async_resume_t *f_async_resume,
2633 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002634 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002635{
2636 conf->f_async_sign_start = f_async_sign;
2637 conf->f_async_decrypt_start = f_async_decrypt;
2638 conf->f_async_resume = f_async_resume;
2639 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002640 conf->p_async_config_data = async_config_data;
2641}
2642
Gilles Peskine8f97af72018-04-26 11:46:10 +02002643void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2644{
2645 return( conf->p_async_config_data );
2646}
2647
Gilles Peskine1febfef2018-04-30 11:54:39 +02002648void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002649{
2650 if( ssl->handshake == NULL )
2651 return( NULL );
2652 else
2653 return( ssl->handshake->user_async_ctx );
2654}
2655
Gilles Peskine1febfef2018-04-30 11:54:39 +02002656void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002657 void *ctx )
2658{
2659 if( ssl->handshake != NULL )
2660 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002661}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002662#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002663
Paul Bakker5121ce52009-01-03 21:22:43 +00002664/*
2665 * SSL get accessors
2666 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002667uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002668{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002669 if( ssl->session != NULL )
2670 return( ssl->session->verify_result );
2671
2672 if( ssl->session_negotiate != NULL )
2673 return( ssl->session_negotiate->verify_result );
2674
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002675 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002676}
2677
Glenn Strauss8f526902022-01-13 00:04:49 -05002678int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2679{
2680 if( ssl == NULL || ssl->session == NULL )
2681 return( 0 );
2682
2683 return( ssl->session->ciphersuite );
2684}
2685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002687{
Paul Bakker926c8e42013-03-06 10:23:34 +01002688 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002689 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002692}
2693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002695{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002697 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002698 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002699 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002700 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002701 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002702 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002703 default:
2704 return( "unknown (DTLS)" );
2705 }
2706 }
2707#endif
2708
Glenn Strauss60bfe602022-03-14 19:04:24 -04002709 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002710 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002711 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002712 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002713 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002714 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002715 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002716 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002717 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002718}
2719
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002720#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002721size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2722{
David Horstmann95d516f2021-05-04 18:36:56 +01002723 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002724 size_t read_mfl;
2725
2726 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2727 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2728 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2729 {
2730 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2731 }
2732
2733 /* Check if a smaller max length was negotiated */
2734 if( ssl->session_out != NULL )
2735 {
2736 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2737 if( read_mfl < max_len )
2738 {
2739 max_len = read_mfl;
2740 }
2741 }
2742
2743 // During a handshake, use the value being negotiated
2744 if( ssl->session_negotiate != NULL )
2745 {
2746 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2747 if( read_mfl < max_len )
2748 {
2749 max_len = read_mfl;
2750 }
2751 }
2752
2753 return( max_len );
2754}
2755
2756size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002757{
2758 size_t max_len;
2759
2760 /*
2761 * Assume mfl_code is correct since it was checked when set
2762 */
Angus Grattond8213d02016-05-25 20:56:48 +10002763 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002764
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002765 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002766 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002767 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002768 {
Angus Grattond8213d02016-05-25 20:56:48 +10002769 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002770 }
2771
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002772 /* During a handshake, use the value being negotiated */
2773 if( ssl->session_negotiate != NULL &&
2774 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2775 {
2776 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2777 }
2778
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002779 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002780}
2781#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2782
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002783#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002784size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002785{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002786 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2787 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2788 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2789 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2790 return ( 0 );
2791
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002792 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2793 return( ssl->mtu );
2794
2795 if( ssl->mtu == 0 )
2796 return( ssl->handshake->mtu );
2797
2798 return( ssl->mtu < ssl->handshake->mtu ?
2799 ssl->mtu : ssl->handshake->mtu );
2800}
2801#endif /* MBEDTLS_SSL_PROTO_DTLS */
2802
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002803int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2804{
2805 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2806
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002807#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2808 !defined(MBEDTLS_SSL_PROTO_DTLS)
2809 (void) ssl;
2810#endif
2811
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002812#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002813 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002814
2815 if( max_len > mfl )
2816 max_len = mfl;
2817#endif
2818
2819#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002820 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002821 {
Hanno Becker89490712020-02-05 10:50:12 +00002822 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002823 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2824 const size_t overhead = (size_t) ret;
2825
2826 if( ret < 0 )
2827 return( ret );
2828
2829 if( mtu <= overhead )
2830 {
2831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2832 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2833 }
2834
2835 if( max_len > mtu - overhead )
2836 max_len = mtu - overhead;
2837 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002838#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002839
Hanno Becker0defedb2018-08-10 12:35:02 +01002840#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2841 !defined(MBEDTLS_SSL_PROTO_DTLS)
2842 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002843#endif
2844
2845 return( (int) max_len );
2846}
2847
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002848int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2849{
2850 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2851
2852#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2853 (void) ssl;
2854#endif
2855
2856#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2857 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2858
2859 if( max_len > mfl )
2860 max_len = mfl;
2861#endif
2862
2863 return( (int) max_len );
2864}
2865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866#if defined(MBEDTLS_X509_CRT_PARSE_C)
2867const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002868{
2869 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002870 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002871
Hanno Beckere6824572019-02-07 13:18:46 +00002872#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002873 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002874#else
2875 return( NULL );
2876#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002877}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002881int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2882 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002883{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002884 int ret;
2885
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002886 if( ssl == NULL ||
2887 dst == NULL ||
2888 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002889 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002890 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002892 }
2893
Hanno Beckere810bbc2021-05-14 16:01:05 +01002894 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2895 * idempotent: Each session can only be exported once.
2896 *
2897 * (This is in preparation for TLS 1.3 support where we will
2898 * need the ability to export multiple sessions (aka tickets),
2899 * which will be achieved by calling mbedtls_ssl_get_session()
2900 * multiple times until it fails.)
2901 *
2902 * Check whether we have already exported the current session,
2903 * and fail if so.
2904 */
2905 if( ssl->session->exported == 1 )
2906 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2907
2908 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2909 if( ret != 0 )
2910 return( ret );
2911
2912 /* Remember that we've exported the session. */
2913 ssl->session->exported = 1;
2914 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002915}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002916#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002917
Paul Bakker5121ce52009-01-03 21:22:43 +00002918/*
Hanno Beckera835da52019-05-16 12:39:07 +01002919 * Define ticket header determining Mbed TLS version
2920 * and structure of the ticket.
2921 */
2922
Hanno Becker94ef3b32019-05-16 12:50:45 +01002923/*
Hanno Becker50b59662019-05-28 14:30:45 +01002924 * Define bitflag determining compile-time settings influencing
2925 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002926 */
2927
Hanno Becker50b59662019-05-28 14:30:45 +01002928#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002929#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002930#else
Hanno Becker3e088662019-05-29 11:10:18 +01002931#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002932#endif /* MBEDTLS_HAVE_TIME */
2933
2934#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002935#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002936#else
Hanno Becker3e088662019-05-29 11:10:18 +01002937#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002938#endif /* MBEDTLS_X509_CRT_PARSE_C */
2939
2940#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002941#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002942#else
Hanno Becker3e088662019-05-29 11:10:18 +01002943#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002944#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2945
2946#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002947#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002948#else
Hanno Becker3e088662019-05-29 11:10:18 +01002949#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002950#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2951
Hanno Becker94ef3b32019-05-16 12:50:45 +01002952#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002953#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002954#else
Hanno Becker3e088662019-05-29 11:10:18 +01002955#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002956#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2957
Hanno Becker94ef3b32019-05-16 12:50:45 +01002958#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2959#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2960#else
2961#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2962#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2963
Hanno Becker3e088662019-05-29 11:10:18 +01002964#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2965#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2966#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2967#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002968#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2969#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002970
Hanno Becker50b59662019-05-28 14:30:45 +01002971#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002972 ( (uint16_t) ( \
2973 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2974 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2975 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2976 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002977 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002978 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002979
Hanno Beckerf8787072019-05-16 12:41:07 +01002980static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002981 MBEDTLS_VERSION_MAJOR,
2982 MBEDTLS_VERSION_MINOR,
2983 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002984 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2985 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002986};
Hanno Beckera835da52019-05-16 12:39:07 +01002987
2988/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002989 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002990 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002991 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002992 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002993 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002994 * opaque mbedtls_version[3]; // library version: major, minor, patch
2995 * opaque session_format[2]; // library-version specific 16-bit field
2996 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002997 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002998 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002999 * Note: When updating the format, remember to keep
3000 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003001 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003002 * // In this version, `session_format` determines
3003 * // the setting of those compile-time
3004 * // configuration options which influence
3005 * // the structure of mbedtls_ssl_session.
3006 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003007 * uint8_t minor_ver; // Protocol minor version. Possible values:
3008 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003009 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003010 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003011 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003012 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003013 * serialized_session_tls12 data;
3014 *
3015 * };
3016 *
3017 * } serialized_session;
3018 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003019 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003020
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003021MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003022static int ssl_session_save( const mbedtls_ssl_session *session,
3023 unsigned char omit_header,
3024 unsigned char *buf,
3025 size_t buf_len,
3026 size_t *olen )
3027{
3028 unsigned char *p = buf;
3029 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003030 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003031#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3032 size_t out_len;
3033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3034#endif
Jerry Yu438ddd82022-07-07 06:55:50 +00003035 if( session == NULL )
3036 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3037
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003038 if( !omit_header )
3039 {
3040 /*
3041 * Add Mbed TLS version identifier
3042 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003043 used += sizeof( ssl_serialized_session_header );
3044
3045 if( used <= buf_len )
3046 {
3047 memcpy( p, ssl_serialized_session_header,
3048 sizeof( ssl_serialized_session_header ) );
3049 p += sizeof( ssl_serialized_session_header );
3050 }
3051 }
3052
3053 /*
3054 * TLS version identifier
3055 */
3056 used += 1;
3057 if( used <= buf_len )
3058 {
Glenn Straussda7851c2022-03-14 13:29:48 -04003059 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003060 }
3061
3062 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003063 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04003064 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003065 {
3066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003067 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003068 used += ssl_tls12_session_save( session, p, remaining_len );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003069 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003070#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3071
Jerry Yu251a12e2022-07-13 15:15:48 +08003072#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3073 case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yue36fdd62022-08-17 21:31:36 +08003074 ret = ssl_tls13_session_save( session, p, remaining_len, &out_len );
3075 if( ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3076 {
3077 return( ret );
3078 }
3079 used += out_len;
Jerry Yu251a12e2022-07-13 15:15:48 +08003080 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003081#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3082
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003083 default:
3084 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
3085 }
3086
3087 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003088 if( used > buf_len )
3089 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003090
3091 return( 0 );
3092}
3093
3094/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003095 * Public wrapper for ssl_session_save()
3096 */
3097int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
3098 unsigned char *buf,
3099 size_t buf_len,
3100 size_t *olen )
3101{
3102 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
3103}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003104
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003105/*
3106 * Deserialize session, see mbedtls_ssl_session_save() for format.
3107 *
3108 * This internal version is wrapped by a public function that cleans up in
3109 * case of error, and has an extra option omit_header.
3110 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003111MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003112static int ssl_session_load( mbedtls_ssl_session *session,
3113 unsigned char omit_header,
3114 const unsigned char *buf,
3115 size_t len )
3116{
3117 const unsigned char *p = buf;
3118 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003119 size_t remaining_len;
3120
3121
3122 if( session == NULL )
3123 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003124
3125 if( !omit_header )
3126 {
3127 /*
3128 * Check Mbed TLS version identifier
3129 */
3130
3131 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
3132 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3133
3134 if( memcmp( p, ssl_serialized_session_header,
3135 sizeof( ssl_serialized_session_header ) ) != 0 )
3136 {
3137 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3138 }
3139 p += sizeof( ssl_serialized_session_header );
3140 }
3141
3142 /*
3143 * TLS version identifier
3144 */
3145 if( 1 > (size_t)( end - p ) )
3146 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04003147 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003148
3149 /* Dispatch according to TLS version. */
Jerry Yu438ddd82022-07-07 06:55:50 +00003150 remaining_len = ( end - p );
Glenn Straussda7851c2022-03-14 13:29:48 -04003151 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003152 {
3153#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04003154 case MBEDTLS_SSL_VERSION_TLS1_2:
Jerry Yu438ddd82022-07-07 06:55:50 +00003155 return( ssl_tls12_session_load( session, p, remaining_len ) );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003156#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3157
Jerry Yu438ddd82022-07-07 06:55:50 +00003158#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3159 case MBEDTLS_SSL_VERSION_TLS1_3:
3160 return( ssl_tls13_session_load( session, p, remaining_len ) );
3161#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3162
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003163 default:
3164 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3165 }
3166}
3167
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003168/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003169 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003170 */
3171int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
3172 const unsigned char *buf,
3173 size_t len )
3174{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003175 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003176
3177 if( ret != 0 )
3178 mbedtls_ssl_session_free( session );
3179
3180 return( ret );
3181}
3182
3183/*
Paul Bakker1961b702013-01-25 14:49:24 +01003184 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003186MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01003187static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
3188{
3189 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3190
Ronald Cron66dbf912022-02-02 15:33:46 +01003191 /*
3192 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003193 * that were written into the output buffer by the previous handshake step,
3194 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003195 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3196 * We proceed to the next handshake step only when all data from the
3197 * previous one have been sent to the peer, thus we make sure that this is
3198 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3199 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3200 * we have to wait before to go ahead.
3201 * In the case of TLS 1.3, handshake step handlers do not send data to the
3202 * peer. Data are only sent here and through
3203 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003204 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003205 */
Hanno Becker41934dd2021-08-07 19:13:43 +01003206 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
3207 return( ret );
3208
3209#if defined(MBEDTLS_SSL_PROTO_DTLS)
3210 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3211 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3212 {
3213 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3214 return( ret );
3215 }
3216#endif /* MBEDTLS_SSL_PROTO_DTLS */
3217
3218 return( ret );
3219}
3220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003222{
Hanno Becker41934dd2021-08-07 19:13:43 +01003223 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003224
Hanno Becker41934dd2021-08-07 19:13:43 +01003225 if( ssl == NULL ||
3226 ssl->conf == NULL ||
3227 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003228 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003229 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003230 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003231 }
3232
3233 ret = ssl_prepare_handshake_step( ssl );
3234 if( ret != 0 )
3235 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003236
Jerry Yue7047812021-09-13 19:26:39 +08003237 ret = mbedtls_ssl_handle_pending_alert( ssl );
3238 if( ret != 0 )
3239 goto cleanup;
3240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003242 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003243 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003244 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3245 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003246
Ronald Cron9f0fba32022-02-10 16:45:15 +01003247 switch( ssl->state )
3248 {
3249 case MBEDTLS_SSL_HELLO_REQUEST:
3250 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3251 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003252
Ronald Cron9f0fba32022-02-10 16:45:15 +01003253 case MBEDTLS_SSL_CLIENT_HELLO:
3254 ret = mbedtls_ssl_write_client_hello( ssl );
3255 break;
3256
3257 default:
3258#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003259 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003260 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3261 else
3262 ret = mbedtls_ssl_handshake_client_step( ssl );
3263#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3264 ret = mbedtls_ssl_handshake_client_step( ssl );
3265#else
3266 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3267#endif
3268 }
Jerry Yub9930e72021-08-06 17:11:51 +08003269 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003270#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003272 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003273 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003274#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003275 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003276 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003277#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003278
3279#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3280 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3281 ret = mbedtls_ssl_handshake_server_step( ssl );
3282#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3283 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003284#endif
3285
Jerry Yue7047812021-09-13 19:26:39 +08003286 if( ret != 0 )
3287 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003288 /* handshake_step return error. And it is same
3289 * with alert_reason.
3290 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003291 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003292 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003293 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003294 goto cleanup;
3295 }
3296 }
3297
3298cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003299 return( ret );
3300}
3301
3302/*
3303 * Perform the SSL handshake
3304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003306{
3307 int ret = 0;
3308
Hanno Beckera817ea42020-10-20 15:20:23 +01003309 /* Sanity checks */
3310
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003311 if( ssl == NULL || ssl->conf == NULL )
3312 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3313
Hanno Beckera817ea42020-10-20 15:20:23 +01003314#if defined(MBEDTLS_SSL_PROTO_DTLS)
3315 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3316 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3317 {
3318 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3319 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3320 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3321 }
3322#endif /* MBEDTLS_SSL_PROTO_DTLS */
3323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003325
Hanno Beckera817ea42020-10-20 15:20:23 +01003326 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003327 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003328 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003330
3331 if( ret != 0 )
3332 break;
3333 }
3334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003336
3337 return( ret );
3338}
3339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#if defined(MBEDTLS_SSL_RENEGOTIATION)
3341#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003342/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003343 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003344 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003345MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003347{
Janos Follath865b3eb2019-12-16 11:46:15 +00003348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003351
3352 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3354 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003355
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003356 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003357 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003358 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003359 return( ret );
3360 }
3361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003363
3364 return( 0 );
3365}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003367
3368/*
3369 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * - any side: calling mbedtls_ssl_renegotiate(),
3371 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3372 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003373 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003374 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003376 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003377int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003378{
Janos Follath865b3eb2019-12-16 11:46:15 +00003379 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003382
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003383 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3384 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003385
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003386 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3387 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003389 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003391 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003392 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003393 ssl->handshake->out_msg_seq = 1;
3394 else
3395 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003396 }
3397#endif
3398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3400 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003403 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003405 return( ret );
3406 }
3407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003409
3410 return( 0 );
3411}
3412
3413/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003414 * Renegotiate current connection on client,
3415 * or request renegotiation on server
3416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003418{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003420
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003421 if( ssl == NULL || ssl->conf == NULL )
3422 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3423
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003425 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003426 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003427 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003428 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003432
3433 /* Did we already try/start sending HelloRequest? */
3434 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003436
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003437 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003438 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003442 /*
3443 * On client, either start the renegotiation process or,
3444 * if already in progress, continue the handshake
3445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003447 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003448 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003450
Hanno Becker40cdaa12020-02-05 10:48:27 +00003451 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003452 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003453 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003454 return( ret );
3455 }
3456 }
3457 else
3458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003460 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003462 return( ret );
3463 }
3464 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003466
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003467 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003468}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003470
Gilles Peskine9b562d52018-04-25 20:32:43 +02003471void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003472{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003473 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3474
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003475 if( handshake == NULL )
3476 return;
3477
Brett Warrene0edc842021-08-17 09:53:13 +01003478#if defined(MBEDTLS_ECP_C)
3479#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3480 if ( ssl->handshake->group_list_heap_allocated )
3481 mbedtls_free( (void*) handshake->group_list );
3482 handshake->group_list = NULL;
3483#endif /* MBEDTLS_DEPRECATED_REMOVED */
3484#endif /* MBEDTLS_ECP_C */
3485
Jerry Yuf017ee42022-01-12 15:49:48 +08003486#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3487#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3488 if ( ssl->handshake->sig_algs_heap_allocated )
3489 mbedtls_free( (void*) handshake->sig_algs );
3490 handshake->sig_algs = NULL;
3491#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003492#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3493 if( ssl->handshake->certificate_request_context )
3494 {
3495 mbedtls_free( (void*) handshake->certificate_request_context );
3496 }
3497#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003498#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3499
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003500#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3501 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3502 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003503 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003504 handshake->async_in_progress = 0;
3505 }
3506#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3507
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003508#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003509#if defined(MBEDTLS_USE_PSA_CRYPTO)
3510 psa_hash_abort( &handshake->fin_sha256_psa );
3511#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003512 mbedtls_sha256_free( &handshake->fin_sha256 );
3513#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003514#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003515#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003516#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003517 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003518#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003519 mbedtls_sha512_free( &handshake->fin_sha512 );
3520#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003521#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#if defined(MBEDTLS_DHM_C)
3524 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003525#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003526#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003528#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003529#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003530 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003531#if defined(MBEDTLS_SSL_CLI_C)
3532 mbedtls_free( handshake->ecjpake_cache );
3533 handshake->ecjpake_cache = NULL;
3534 handshake->ecjpake_cache_len = 0;
3535#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003536#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003537
Janos Follath4ae5c292016-02-10 11:27:43 +00003538#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3539 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003540 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003542#endif
3543
Gilles Peskineeccd8882020-03-10 12:19:08 +01003544#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003545#if defined(MBEDTLS_USE_PSA_CRYPTO)
3546 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3547 {
3548 /* The maintenance of the external PSK key slot is the
3549 * user's responsibility. */
3550 if( ssl->handshake->psk_opaque_is_internal )
3551 {
3552 psa_destroy_key( ssl->handshake->psk_opaque );
3553 ssl->handshake->psk_opaque_is_internal = 0;
3554 }
3555 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3556 }
Neil Armstronge952a302022-05-03 10:22:14 +02003557#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003558 if( handshake->psk != NULL )
3559 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003560 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003561 mbedtls_free( handshake->psk );
3562 }
Neil Armstronge952a302022-05-03 10:22:14 +02003563#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003564#endif
3565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3567 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003568 /*
3569 * Free only the linked list wrapper, not the keys themselves
3570 * since the belong to the SNI callback
3571 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003572 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003574
Gilles Peskineeccd8882020-03-10 12:19:08 +01003575#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003576 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003577 if( handshake->ecrs_peer_cert != NULL )
3578 {
3579 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3580 mbedtls_free( handshake->ecrs_peer_cert );
3581 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003582#endif
3583
Hanno Becker75173122019-02-06 16:18:31 +00003584#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3585 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3586 mbedtls_pk_free( &handshake->peer_pubkey );
3587#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3588
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003589#if defined(MBEDTLS_SSL_CLI_C) && \
3590 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3591 mbedtls_free( handshake->cookie );
3592#endif /* MBEDTLS_SSL_CLI_C &&
3593 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003594
3595#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003596 mbedtls_ssl_flight_free( handshake->flight );
3597 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003598#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003599
Ronald Cronf12b81d2022-03-15 10:42:41 +01003600#if defined(MBEDTLS_ECDH_C) && \
3601 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003602 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003603 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003604#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3605
Ronald Cron6f135e12021-12-08 16:57:54 +01003606#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003607 mbedtls_ssl_transform_free( handshake->transform_handshake );
3608 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003609 mbedtls_free( handshake->transform_earlydata );
3610 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003611#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003612
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003613
3614#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3615 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3616 * processes datagrams and the fact that a datagram is allowed to have
3617 * several records in it, it is possible that the I/O buffers are not
3618 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003619 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3620 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003621#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003622
Jerry Yuba9c7272021-10-30 11:54:10 +08003623 /* mbedtls_platform_zeroize MUST be last one in this function */
3624 mbedtls_platform_zeroize( handshake,
3625 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003626}
3627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003629{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003630 if( session == NULL )
3631 return;
3632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003634 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003635#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003636
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003637#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003639#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003640
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003641 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003642}
3643
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003644#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003645
3646#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3647#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3648#else
3649#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3650#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3651
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003652#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003653
3654#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3655#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3656#else
3657#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3658#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3659
3660#if defined(MBEDTLS_SSL_ALPN)
3661#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3662#else
3663#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3664#endif /* MBEDTLS_SSL_ALPN */
3665
3666#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3667#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3668#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3669#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3670
3671#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3672 ( (uint32_t) ( \
3673 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3674 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3675 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3676 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3677 0u ) )
3678
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003679static unsigned char ssl_serialized_context_header[] = {
3680 MBEDTLS_VERSION_MAJOR,
3681 MBEDTLS_VERSION_MINOR,
3682 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003683 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3684 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3685 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3686 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3687 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003688};
3689
Paul Bakker5121ce52009-01-03 21:22:43 +00003690/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003691 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003692 *
3693 * The format of the serialized data is:
3694 * (in the presentation language of TLS, RFC 8446 section 3)
3695 *
3696 * // header
3697 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003698 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003699 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003700 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003701 * Note: When updating the format, remember to keep these
3702 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003703 *
3704 * // session sub-structure
3705 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3706 * // transform sub-structure
3707 * uint8 random[64]; // ServerHello.random+ClientHello.random
3708 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3709 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3710 * // fields from ssl_context
3711 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3712 * uint64 in_window_top; // DTLS: last validated record seq_num
3713 * uint64 in_window; // DTLS: bitmask for replay protection
3714 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3715 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3716 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3717 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3718 *
3719 * Note that many fields of the ssl_context or sub-structures are not
3720 * serialized, as they fall in one of the following categories:
3721 *
3722 * 1. forced value (eg in_left must be 0)
3723 * 2. pointer to dynamically-allocated memory (eg session, transform)
3724 * 3. value can be re-derived from other data (eg session keys from MS)
3725 * 4. value was temporary (eg content of input buffer)
3726 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003727 */
3728int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3729 unsigned char *buf,
3730 size_t buf_len,
3731 size_t *olen )
3732{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003733 unsigned char *p = buf;
3734 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003735 size_t session_len;
3736 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003737
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003738 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003739 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3740 * this function's documentation.
3741 *
3742 * These are due to assumptions/limitations in the implementation. Some of
3743 * them are likely to stay (no handshake in progress) some might go away
3744 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003745 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003746 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003747 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003748 {
3749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003750 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003751 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003752 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003753 {
3754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003756 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003757 /* Double-check that sub-structures are indeed ready */
3758 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003759 {
3760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003762 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003763 /* There must be no pending incoming or outgoing data */
3764 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003765 {
3766 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003768 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003769 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003770 {
3771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003772 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003773 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003774 /* Protocol must be DLTS, not TLS */
3775 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003776 {
3777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003778 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003779 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003780 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003781 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003782 {
3783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003784 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003785 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003786 /* We must be using an AEAD ciphersuite */
3787 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003788 {
3789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003790 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003791 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003792 /* Renegotiation must not be enabled */
3793#if defined(MBEDTLS_SSL_RENEGOTIATION)
3794 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003795 {
3796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003797 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003798 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003799#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003800
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003801 /*
3802 * Version and format identifier
3803 */
3804 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003805
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003806 if( used <= buf_len )
3807 {
3808 memcpy( p, ssl_serialized_context_header,
3809 sizeof( ssl_serialized_context_header ) );
3810 p += sizeof( ssl_serialized_context_header );
3811 }
3812
3813 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003814 * Session (length + data)
3815 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003816 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003817 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3818 return( ret );
3819
3820 used += 4 + session_len;
3821 if( used <= buf_len )
3822 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003823 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3824 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003825
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003826 ret = ssl_session_save( ssl->session, 1,
3827 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003828 if( ret != 0 )
3829 return( ret );
3830
3831 p += session_len;
3832 }
3833
3834 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003835 * Transform
3836 */
3837 used += sizeof( ssl->transform->randbytes );
3838 if( used <= buf_len )
3839 {
3840 memcpy( p, ssl->transform->randbytes,
3841 sizeof( ssl->transform->randbytes ) );
3842 p += sizeof( ssl->transform->randbytes );
3843 }
3844
3845#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3846 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3847 if( used <= buf_len )
3848 {
3849 *p++ = ssl->transform->in_cid_len;
3850 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3851 p += ssl->transform->in_cid_len;
3852
3853 *p++ = ssl->transform->out_cid_len;
3854 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3855 p += ssl->transform->out_cid_len;
3856 }
3857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3858
3859 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003860 * Saved fields from top-level ssl_context structure
3861 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003862 used += 4;
3863 if( used <= buf_len )
3864 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003865 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3866 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003867 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003868
3869#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3870 used += 16;
3871 if( used <= buf_len )
3872 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003873 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3874 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003875
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003876 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3877 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003878 }
3879#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3880
3881#if defined(MBEDTLS_SSL_PROTO_DTLS)
3882 used += 1;
3883 if( used <= buf_len )
3884 {
3885 *p++ = ssl->disable_datagram_packing;
3886 }
3887#endif /* MBEDTLS_SSL_PROTO_DTLS */
3888
Jerry Yuae0b2e22021-10-08 15:21:19 +08003889 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003890 if( used <= buf_len )
3891 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003892 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3893 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003894 }
3895
3896#if defined(MBEDTLS_SSL_PROTO_DTLS)
3897 used += 2;
3898 if( used <= buf_len )
3899 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003900 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3901 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003902 }
3903#endif /* MBEDTLS_SSL_PROTO_DTLS */
3904
3905#if defined(MBEDTLS_SSL_ALPN)
3906 {
3907 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003908 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003909 : 0;
3910
3911 used += 1 + alpn_len;
3912 if( used <= buf_len )
3913 {
3914 *p++ = alpn_len;
3915
3916 if( ssl->alpn_chosen != NULL )
3917 {
3918 memcpy( p, ssl->alpn_chosen, alpn_len );
3919 p += alpn_len;
3920 }
3921 }
3922 }
3923#endif /* MBEDTLS_SSL_ALPN */
3924
3925 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003926 * Done
3927 */
3928 *olen = used;
3929
3930 if( used > buf_len )
3931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003932
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003933 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3934
Hanno Becker43aefe22020-02-05 10:44:56 +00003935 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003936}
3937
3938/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003939 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003940 *
3941 * This internal version is wrapped by a public function that cleans up in
3942 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003943 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003944MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003945static int ssl_context_load( mbedtls_ssl_context *ssl,
3946 const unsigned char *buf,
3947 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003948{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003949 const unsigned char *p = buf;
3950 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003951 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003952 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003953
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003954 /*
3955 * The context should have been freshly setup or reset.
3956 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003957 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003958 * renegotiating, or if the user mistakenly loaded a session first.)
3959 */
3960 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3961 ssl->session != NULL )
3962 {
3963 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3964 }
3965
3966 /*
3967 * We can't check that the config matches the initial one, but we can at
3968 * least check it matches the requirements for serializing.
3969 */
3970 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003971 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3972 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003973#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003974 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003975#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003976 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003977 {
3978 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3979 }
3980
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003981 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3982
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003983 /*
3984 * Check version identifier
3985 */
3986 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3987 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3988
3989 if( memcmp( p, ssl_serialized_context_header,
3990 sizeof( ssl_serialized_context_header ) ) != 0 )
3991 {
3992 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3993 }
3994 p += sizeof( ssl_serialized_context_header );
3995
3996 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003997 * Session
3998 */
3999 if( (size_t)( end - p ) < 4 )
4000 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4001
4002 session_len = ( (size_t) p[0] << 24 ) |
4003 ( (size_t) p[1] << 16 ) |
4004 ( (size_t) p[2] << 8 ) |
4005 ( (size_t) p[3] );
4006 p += 4;
4007
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004008 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004009 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004010 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004011 ssl->session_in = ssl->session;
4012 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004013 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004014
4015 if( (size_t)( end - p ) < session_len )
4016 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4017
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004018 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004019 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004020 {
4021 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004022 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004023 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004024
4025 p += session_len;
4026
4027 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004028 * Transform
4029 */
4030
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004031 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004032 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004033 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004034 ssl->transform_in = ssl->transform;
4035 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004036 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004037
4038 /* Read random bytes and populate structure */
4039 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
4040 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08004041#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00004042 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004043 ssl->session->ciphersuite,
4044 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004045#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004046 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004047#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004048 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
4049 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04004050 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004051 ssl->conf->endpoint,
4052 ssl );
4053 if( ret != 0 )
4054 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08004055#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004056 p += sizeof( ssl->transform->randbytes );
4057
4058#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4059 /* Read connection IDs and store them */
4060 if( (size_t)( end - p ) < 1 )
4061 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4062
4063 ssl->transform->in_cid_len = *p++;
4064
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02004065 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4067
4068 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
4069 p += ssl->transform->in_cid_len;
4070
4071 ssl->transform->out_cid_len = *p++;
4072
4073 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
4074 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4075
4076 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
4077 p += ssl->transform->out_cid_len;
4078#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4079
4080 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004081 * Saved fields from top-level ssl_context structure
4082 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004083 if( (size_t)( end - p ) < 4 )
4084 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4085
4086 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
4087 ( (uint32_t) p[1] << 16 ) |
4088 ( (uint32_t) p[2] << 8 ) |
4089 ( (uint32_t) p[3] );
4090 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004091
4092#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4093 if( (size_t)( end - p ) < 16 )
4094 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4095
4096 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
4097 ( (uint64_t) p[1] << 48 ) |
4098 ( (uint64_t) p[2] << 40 ) |
4099 ( (uint64_t) p[3] << 32 ) |
4100 ( (uint64_t) p[4] << 24 ) |
4101 ( (uint64_t) p[5] << 16 ) |
4102 ( (uint64_t) p[6] << 8 ) |
4103 ( (uint64_t) p[7] );
4104 p += 8;
4105
4106 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
4107 ( (uint64_t) p[1] << 48 ) |
4108 ( (uint64_t) p[2] << 40 ) |
4109 ( (uint64_t) p[3] << 32 ) |
4110 ( (uint64_t) p[4] << 24 ) |
4111 ( (uint64_t) p[5] << 16 ) |
4112 ( (uint64_t) p[6] << 8 ) |
4113 ( (uint64_t) p[7] );
4114 p += 8;
4115#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4116
4117#if defined(MBEDTLS_SSL_PROTO_DTLS)
4118 if( (size_t)( end - p ) < 1 )
4119 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4120
4121 ssl->disable_datagram_packing = *p++;
4122#endif /* MBEDTLS_SSL_PROTO_DTLS */
4123
Jerry Yud9a94fe2021-09-28 18:58:59 +08004124 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004125 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004126 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
4127 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004128
4129#if defined(MBEDTLS_SSL_PROTO_DTLS)
4130 if( (size_t)( end - p ) < 2 )
4131 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4132
4133 ssl->mtu = ( p[0] << 8 ) | p[1];
4134 p += 2;
4135#endif /* MBEDTLS_SSL_PROTO_DTLS */
4136
4137#if defined(MBEDTLS_SSL_ALPN)
4138 {
4139 uint8_t alpn_len;
4140 const char **cur;
4141
4142 if( (size_t)( end - p ) < 1 )
4143 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4144
4145 alpn_len = *p++;
4146
4147 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
4148 {
4149 /* alpn_chosen should point to an item in the configured list */
4150 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
4151 {
4152 if( strlen( *cur ) == alpn_len &&
4153 memcmp( p, cur, alpn_len ) == 0 )
4154 {
4155 ssl->alpn_chosen = *cur;
4156 break;
4157 }
4158 }
4159 }
4160
4161 /* can only happen on conf mismatch */
4162 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
4163 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4164
4165 p += alpn_len;
4166 }
4167#endif /* MBEDTLS_SSL_ALPN */
4168
4169 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004170 * Forced fields from top-level ssl_context structure
4171 *
4172 * Most of them already set to the correct value by mbedtls_ssl_init() and
4173 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4174 */
4175 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004176 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004177
Hanno Becker361b10d2019-08-30 10:42:49 +01004178 /* Adjust pointers for header fields of outgoing records to
4179 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004180 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01004181
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004182#if defined(MBEDTLS_SSL_PROTO_DTLS)
4183 ssl->in_epoch = 1;
4184#endif
4185
4186 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4187 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004188 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4189 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004190 if( ssl->handshake != NULL )
4191 {
4192 mbedtls_ssl_handshake_free( ssl );
4193 mbedtls_free( ssl->handshake );
4194 ssl->handshake = NULL;
4195 }
4196
4197 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004198 * Done - should have consumed entire buffer
4199 */
4200 if( p != end )
4201 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004202
4203 return( 0 );
4204}
4205
4206/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004207 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004208 */
4209int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
4210 const unsigned char *buf,
4211 size_t len )
4212{
4213 int ret = ssl_context_load( context, buf, len );
4214
4215 if( ret != 0 )
4216 mbedtls_ssl_free( context );
4217
4218 return( ret );
4219}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004220#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004221
4222/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004223 * Free an SSL context
4224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004225void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004226{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004227 if( ssl == NULL )
4228 return;
4229
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004230 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004231
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004232 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004233 {
sander-visserb8aa2072020-05-06 22:05:13 +02004234#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4235 size_t out_buf_len = ssl->out_buf_len;
4236#else
4237 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4238#endif
4239
Darryl Greenb33cc762019-11-28 14:29:44 +00004240 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004241 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004242 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004243 }
4244
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004245 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004246 {
sander-visserb8aa2072020-05-06 22:05:13 +02004247#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4248 size_t in_buf_len = ssl->in_buf_len;
4249#else
4250 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4251#endif
4252
Darryl Greenb33cc762019-11-28 14:29:44 +00004253 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004254 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004255 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004256 }
4257
Paul Bakker48916f92012-09-16 19:57:18 +00004258 if( ssl->transform )
4259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004260 mbedtls_ssl_transform_free( ssl->transform );
4261 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004262 }
4263
4264 if( ssl->handshake )
4265 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004266 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004267 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4268 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004270 mbedtls_free( ssl->handshake );
4271 mbedtls_free( ssl->transform_negotiate );
4272 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004273 }
4274
Ronald Cron6f135e12021-12-08 16:57:54 +01004275#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004276 mbedtls_ssl_transform_free( ssl->transform_application );
4277 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004278#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004279
Paul Bakkerc0463502013-02-14 11:19:38 +01004280 if( ssl->session )
4281 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004282 mbedtls_ssl_session_free( ssl->session );
4283 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004284 }
4285
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004286#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004287 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004288 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004289 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004290 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004291 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004292#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004293
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004294#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004296#endif
4297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004298 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004299
Paul Bakker86f04f42013-02-14 11:20:09 +01004300 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004301 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004302}
4303
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004304/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004305 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004306 */
4307void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4308{
4309 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4310}
4311
Gilles Peskineae270bf2021-06-02 00:05:29 +02004312/* The selection should be the same as mbedtls_x509_crt_profile_default in
4313 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004314 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004315 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004316 * about this list.
4317 */
Brett Warrene0edc842021-08-17 09:53:13 +01004318static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004319#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004320 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004321#endif
4322#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004323 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004324#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004325#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004326 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004327#endif
4328#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004329 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004330#endif
4331#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004332 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004333#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004334#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004335 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004336#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004337#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004338 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004339#endif
4340#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004341 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004342#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004343 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004344};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004345
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004346static int ssl_preset_suiteb_ciphersuites[] = {
4347 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4348 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4349 0
4350};
4351
Gilles Peskineeccd8882020-03-10 12:19:08 +01004352#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004353
Jerry Yu909df7b2022-01-22 11:56:27 +08004354/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004355 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004356 * rules SHOULD be upheld.
4357 * - No duplicate entries.
4358 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004359 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004360 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004361 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004362static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004363
Jerry Yued5e9f42022-01-26 11:21:34 +08004364#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4365 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4366 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4367#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4368 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004369
Jerry Yu909df7b2022-01-22 11:56:27 +08004370#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4371 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4372 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4373#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4374 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4375
Jerry Yued5e9f42022-01-26 11:21:34 +08004376#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4377 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4378 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4379#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4380 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004381
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004382#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4383 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4384#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4385
4386#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4387 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4388#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4389
4390#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4391 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4392#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4393
Jerry Yu693a47a2022-06-23 14:02:28 +08004394#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4395 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4396#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4397
4398#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4399 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4400#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4401
4402#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4403 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4404#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4405
Gabor Mezei15b95a62022-05-09 16:37:58 +02004406 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004407};
4408
4409/* NOTICE: see above */
4410#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4411static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004412#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004413#if defined(MBEDTLS_ECDSA_C)
4414 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004415#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004416#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4417 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4418#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004419#if defined(MBEDTLS_RSA_C)
4420 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4421#endif
4422#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004423#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004424#if defined(MBEDTLS_ECDSA_C)
4425 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004426#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004427#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4428 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4429#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004430#if defined(MBEDTLS_RSA_C)
4431 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4432#endif
4433#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004434#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004435#if defined(MBEDTLS_ECDSA_C)
4436 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004437#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08004438#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
4439 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4440#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02004441#if defined(MBEDTLS_RSA_C)
4442 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4443#endif
4444#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004445 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004446};
4447#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4448/* NOTICE: see above */
4449static uint16_t ssl_preset_suiteb_sig_algs[] = {
4450
Jerry Yu909df7b2022-01-22 11:56:27 +08004451#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4452 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4453 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4454#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4455 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4456
Jerry Yu53037892022-01-25 11:02:06 +08004457#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4458 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4459 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4460#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4461 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004462
4463#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4464 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4465#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004466
Jerry Yu53037892022-01-25 11:02:06 +08004467#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4468 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4469#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4470
Gabor Mezei15b95a62022-05-09 16:37:58 +02004471 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004472};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004473
Jerry Yu909df7b2022-01-22 11:56:27 +08004474/* NOTICE: see above */
4475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4476static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004477#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004478#if defined(MBEDTLS_ECDSA_C)
4479 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004480#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004481#if defined(MBEDTLS_RSA_C)
4482 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4483#endif
4484#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004485#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004486#if defined(MBEDTLS_ECDSA_C)
4487 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004488#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004489#if defined(MBEDTLS_RSA_C)
4490 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4491#endif
4492#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004493 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004494};
Jerry Yu909df7b2022-01-22 11:56:27 +08004495#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4496
Jerry Yu1a8b4812022-01-20 17:56:50 +08004497#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004498
Brett Warrene0edc842021-08-17 09:53:13 +01004499static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004500#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004501 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004502#endif
4503#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004504 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004505#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004506 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004507};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004508
Jerry Yu1a8b4812022-01-20 17:56:50 +08004509#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004510/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004511 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004512MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004513static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004514{
4515 size_t i, j;
4516 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004517
Gabor Mezei15b95a62022-05-09 16:37:58 +02004518 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004519 {
Jerry Yuf377d642022-01-25 10:43:59 +08004520 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004521 {
Jerry Yuf377d642022-01-25 10:43:59 +08004522 if( sig_algs[i] != sig_algs[j] )
4523 continue;
4524 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4525 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4526 sig_algs[i], j, i );
4527 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004528 }
4529 }
4530 return( ret );
4531}
4532
4533#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4534
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004535/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004536 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004537 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004538int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004539 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004540{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004541#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004543#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004544
Jerry Yu1a8b4812022-01-20 17:56:50 +08004545#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004546 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004547 {
4548 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4549 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4550 }
4551
Jerry Yuf377d642022-01-25 10:43:59 +08004552 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004553 {
4554 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4555 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4556 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004557
4558#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004559 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004560 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004561 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004562 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4563 }
4564
Jerry Yuf377d642022-01-25 10:43:59 +08004565 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004566 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004567 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004568 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4569 }
4570#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004571#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4572
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004573 /* Use the functions here so that they are covered in tests,
4574 * but otherwise access member directly for efficiency */
4575 mbedtls_ssl_conf_endpoint( conf, endpoint );
4576 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004577
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004578 /*
4579 * Things that are common to all presets
4580 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004581#if defined(MBEDTLS_SSL_CLI_C)
4582 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4583 {
4584 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4585#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4586 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4587#endif
4588 }
4589#endif
4590
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004591#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4592 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4593#endif
4594
4595#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4596 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4597#endif
4598
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004599#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004600 conf->f_cookie_write = ssl_cookie_write_dummy;
4601 conf->f_cookie_check = ssl_cookie_check_dummy;
4602#endif
4603
4604#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4605 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4606#endif
4607
Janos Follath088ce432017-04-10 12:42:31 +01004608#if defined(MBEDTLS_SSL_SRV_C)
4609 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004610 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004611#endif
4612
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004613#if defined(MBEDTLS_SSL_PROTO_DTLS)
4614 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4615 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4616#endif
4617
4618#if defined(MBEDTLS_SSL_RENEGOTIATION)
4619 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004620 memset( conf->renego_period, 0x00, 2 );
4621 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004622#endif
4623
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004624#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004625 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4626 {
4627 const unsigned char dhm_p[] =
4628 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4629 const unsigned char dhm_g[] =
4630 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004631
Hanno Beckere2defad2021-07-24 05:59:17 +01004632 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4633 dhm_p, sizeof( dhm_p ),
4634 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4635 {
4636 return( ret );
4637 }
4638 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004639#endif
4640
Ronald Cron6f135e12021-12-08 16:57:54 +01004641#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004642 /*
4643 * Allow all TLS 1.3 key exchange modes by default.
4644 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004645 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004646#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004647
XiaokangQian4d3a6042022-04-21 13:46:17 +00004648 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4649 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004650#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004651 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004652 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004653#else
XiaokangQian060d8672022-04-21 09:24:56 +00004654 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004655#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004656 }
4657 else
4658 {
4659#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4660 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4661 {
4662 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4663 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4664 }
4665 else
4666 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4667 {
4668 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4669 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4670 }
4671#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4672 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4673 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4674#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4675 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4676 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4677#else
4678 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4679#endif
4680 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004681
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004682 /*
4683 * Preset-specific defaults
4684 */
4685 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004686 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004687 /*
4688 * NSA Suite B
4689 */
4690 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004691
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004692 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004693
4694#if defined(MBEDTLS_X509_CRT_PARSE_C)
4695 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004696#endif
4697
Gilles Peskineeccd8882020-03-10 12:19:08 +01004698#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004699#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4700 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4701 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4702 else
4703#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4704 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004705#endif
4706
Brett Warrene0edc842021-08-17 09:53:13 +01004707#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4708 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004709#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004710 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004711 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004712
4713 /*
4714 * Default
4715 */
4716 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004717
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004718 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004719
4720#if defined(MBEDTLS_X509_CRT_PARSE_C)
4721 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4722#endif
4723
Gilles Peskineeccd8882020-03-10 12:19:08 +01004724#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004725#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4726 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4727 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4728 else
4729#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4730 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004731#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004732
Brett Warrene0edc842021-08-17 09:53:13 +01004733#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4734 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004735#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004736 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004737
4738#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4739 conf->dhm_min_bitlen = 1024;
4740#endif
4741 }
4742
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004743 return( 0 );
4744}
4745
4746/*
4747 * Free mbedtls_ssl_config
4748 */
4749void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4750{
4751#if defined(MBEDTLS_DHM_C)
4752 mbedtls_mpi_free( &conf->dhm_P );
4753 mbedtls_mpi_free( &conf->dhm_G );
4754#endif
4755
Gilles Peskineeccd8882020-03-10 12:19:08 +01004756#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004757#if defined(MBEDTLS_USE_PSA_CRYPTO)
4758 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4759 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004760 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4761 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004762#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004763 if( conf->psk != NULL )
4764 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004765 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004766 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004767 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004768 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004769 }
4770
4771 if( conf->psk_identity != NULL )
4772 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004773 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004774 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004775 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004776 conf->psk_identity_len = 0;
4777 }
4778#endif
4779
4780#if defined(MBEDTLS_X509_CRT_PARSE_C)
4781 ssl_key_cert_free( conf->key_cert );
4782#endif
4783
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004784 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004785}
4786
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004787#if defined(MBEDTLS_PK_C) && \
4788 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004789/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004791 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004793{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794#if defined(MBEDTLS_RSA_C)
4795 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4796 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004797#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798#if defined(MBEDTLS_ECDSA_C)
4799 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4800 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004801#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004803}
4804
Hanno Becker7e5437a2017-04-28 17:15:26 +01004805unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4806{
4807 switch( type ) {
4808 case MBEDTLS_PK_RSA:
4809 return( MBEDTLS_SSL_SIG_RSA );
4810 case MBEDTLS_PK_ECDSA:
4811 case MBEDTLS_PK_ECKEY:
4812 return( MBEDTLS_SSL_SIG_ECDSA );
4813 default:
4814 return( MBEDTLS_SSL_SIG_ANON );
4815 }
4816}
4817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004819{
4820 switch( sig )
4821 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004822#if defined(MBEDTLS_RSA_C)
4823 case MBEDTLS_SSL_SIG_RSA:
4824 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004825#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004826#if defined(MBEDTLS_ECDSA_C)
4827 case MBEDTLS_SSL_SIG_ECDSA:
4828 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004829#endif
4830 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004832 }
4833}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004834#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004835
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004836/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004837 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004839mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004840{
4841 switch( hash )
4842 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004843#if defined(MBEDTLS_MD5_C)
4844 case MBEDTLS_SSL_HASH_MD5:
4845 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004846#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847#if defined(MBEDTLS_SHA1_C)
4848 case MBEDTLS_SSL_HASH_SHA1:
4849 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004850#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004851#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852 case MBEDTLS_SSL_HASH_SHA224:
4853 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004854#endif
4855#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004856 case MBEDTLS_SSL_HASH_SHA256:
4857 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004858#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004859#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 case MBEDTLS_SSL_HASH_SHA384:
4861 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004862#endif
4863#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864 case MBEDTLS_SSL_HASH_SHA512:
4865 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004866#endif
4867 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004869 }
4870}
4871
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004872/*
4873 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4874 */
4875unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4876{
4877 switch( md )
4878 {
4879#if defined(MBEDTLS_MD5_C)
4880 case MBEDTLS_MD_MD5:
4881 return( MBEDTLS_SSL_HASH_MD5 );
4882#endif
4883#if defined(MBEDTLS_SHA1_C)
4884 case MBEDTLS_MD_SHA1:
4885 return( MBEDTLS_SSL_HASH_SHA1 );
4886#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004887#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004888 case MBEDTLS_MD_SHA224:
4889 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004890#endif
4891#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004892 case MBEDTLS_MD_SHA256:
4893 return( MBEDTLS_SSL_HASH_SHA256 );
4894#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004895#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004896 case MBEDTLS_MD_SHA384:
4897 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004898#endif
4899#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004900 case MBEDTLS_MD_SHA512:
4901 return( MBEDTLS_SSL_HASH_SHA512 );
4902#endif
4903 default:
4904 return( MBEDTLS_SSL_HASH_NONE );
4905 }
4906}
4907
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004908/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004909 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004910 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004911 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004912int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004913{
Brett Warrene0edc842021-08-17 09:53:13 +01004914 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004915
Brett Warrene0edc842021-08-17 09:53:13 +01004916 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004917 return( -1 );
4918
Brett Warrene0edc842021-08-17 09:53:13 +01004919 for( ; *group_list != 0; group_list++ )
4920 {
4921 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004922 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004923 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004924
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004925 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004926}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004927
4928#if defined(MBEDTLS_ECP_C)
4929/*
4930 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4931 */
4932int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4933{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004934 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004935 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4936}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004937#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004939#if defined(MBEDTLS_X509_CRT_PARSE_C)
4940int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4941 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004942 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004943 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004944{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004945 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004946 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004947 const char *ext_oid;
4948 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004951 {
4952 /* Server part of the key exchange */
4953 switch( ciphersuite->key_exchange )
4954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955 case MBEDTLS_KEY_EXCHANGE_RSA:
4956 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004957 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004958 break;
4959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4961 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4962 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4963 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004964 break;
4965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4967 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004968 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004969 break;
4970
4971 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 case MBEDTLS_KEY_EXCHANGE_NONE:
4973 case MBEDTLS_KEY_EXCHANGE_PSK:
4974 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4975 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004976 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004977 usage = 0;
4978 }
4979 }
4980 else
4981 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4983 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004984 }
4985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004987 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004988 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004989 ret = -1;
4990 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004992 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004993 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004994 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4995 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004996 }
4997 else
4998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004999 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
5000 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005001 }
5002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005004 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005005 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005006 ret = -1;
5007 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005008
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005009 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005010}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005012
Jerry Yu148165c2021-09-24 23:20:59 +08005013#if defined(MBEDTLS_USE_PSA_CRYPTO)
5014int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5015 const mbedtls_md_type_t md,
5016 unsigned char *dst,
5017 size_t dst_len,
5018 size_t *olen )
5019{
Ronald Cronf6893e12022-01-07 22:09:01 +01005020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5021 psa_hash_operation_t *hash_operation_to_clone;
5022 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5023
Jerry Yu148165c2021-09-24 23:20:59 +08005024 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005025
5026 switch( md )
5027 {
5028#if defined(MBEDTLS_SHA384_C)
5029 case MBEDTLS_MD_SHA384:
5030 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5031 break;
5032#endif
5033
5034#if defined(MBEDTLS_SHA256_C)
5035 case MBEDTLS_MD_SHA256:
5036 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5037 break;
5038#endif
5039
5040 default:
5041 goto exit;
5042 }
5043
5044 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
5045 if( status != PSA_SUCCESS )
5046 goto exit;
5047
5048 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
5049 if( status != PSA_SUCCESS )
5050 goto exit;
5051
5052exit:
Ronald Cronb788c042022-02-15 09:14:15 +01005053 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08005054}
5055#else /* MBEDTLS_USE_PSA_CRYPTO */
5056
Jerry Yu24c0ec32021-09-09 14:21:07 +08005057#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005058MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005059static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
5060 unsigned char *dst,
5061 size_t dst_len,
5062 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005063{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005064 int ret;
5065 mbedtls_sha512_context sha512;
5066
5067 if( dst_len < 48 )
5068 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5069
5070 mbedtls_sha512_init( &sha512 );
5071 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5072
5073 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
5074 {
5075 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
5076 goto exit;
5077 }
5078
5079 *olen = 48;
5080
5081exit:
5082
5083 mbedtls_sha512_free( &sha512 );
5084 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005085}
5086#endif /* MBEDTLS_SHA384_C */
5087
5088#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005089MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08005090static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
5091 unsigned char *dst,
5092 size_t dst_len,
5093 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005094{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005095 int ret;
5096 mbedtls_sha256_context sha256;
5097
5098 if( dst_len < 32 )
5099 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5100
5101 mbedtls_sha256_init( &sha256 );
5102 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08005103
Jerry Yu24c0ec32021-09-09 14:21:07 +08005104 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
5105 {
5106 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
5107 goto exit;
5108 }
5109
5110 *olen = 32;
5111
5112exit:
5113
5114 mbedtls_sha256_free( &sha256 );
5115 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005116}
5117#endif /* MBEDTLS_SHA256_C */
5118
Jerry Yu000f9762021-09-14 11:12:51 +08005119int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
5120 const mbedtls_md_type_t md,
5121 unsigned char *dst,
5122 size_t dst_len,
5123 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08005124{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005125 switch( md )
5126 {
5127
Jerry Yu24c0ec32021-09-09 14:21:07 +08005128#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005129 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08005130 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005131#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005132
Jerry Yu24c0ec32021-09-09 14:21:07 +08005133#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005134 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08005135 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08005136#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005137
5138 default:
5139 break;
5140 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005141 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08005142}
XiaokangQian647719a2021-12-07 09:16:29 +00005143
Jerry Yu148165c2021-09-24 23:20:59 +08005144#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005145
Gabor Mezei078e8032022-04-27 21:17:56 +02005146#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5147/* mbedtls_ssl_parse_sig_alg_ext()
5148 *
5149 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5150 * value (TLS 1.3 RFC8446):
5151 * enum {
5152 * ....
5153 * ecdsa_secp256r1_sha256( 0x0403 ),
5154 * ecdsa_secp384r1_sha384( 0x0503 ),
5155 * ecdsa_secp521r1_sha512( 0x0603 ),
5156 * ....
5157 * } SignatureScheme;
5158 *
5159 * struct {
5160 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5161 * } SignatureSchemeList;
5162 *
5163 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5164 * value (TLS 1.2 RFC5246):
5165 * enum {
5166 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5167 * sha512(6), (255)
5168 * } HashAlgorithm;
5169 *
5170 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5171 * SignatureAlgorithm;
5172 *
5173 * struct {
5174 * HashAlgorithm hash;
5175 * SignatureAlgorithm signature;
5176 * } SignatureAndHashAlgorithm;
5177 *
5178 * SignatureAndHashAlgorithm
5179 * supported_signature_algorithms<2..2^16-2>;
5180 *
5181 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5182 * generalization of the TLS 1.2 signature algorithm extension.
5183 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5184 * `SignatureScheme` field of TLS 1.3
5185 *
5186 */
5187int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
5188 const unsigned char *buf,
5189 const unsigned char *end )
5190{
5191 const unsigned char *p = buf;
5192 size_t supported_sig_algs_len = 0;
5193 const unsigned char *supported_sig_algs_end;
5194 uint16_t sig_alg;
5195 uint32_t common_idx = 0;
5196
5197 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
5198 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
5199 p += 2;
5200
5201 memset( ssl->handshake->received_sig_algs, 0,
5202 sizeof(ssl->handshake->received_sig_algs) );
5203
5204 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
5205 supported_sig_algs_end = p + supported_sig_algs_len;
5206 while( p < supported_sig_algs_end )
5207 {
5208 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
5209 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
5210 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08005211 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
5212 sig_alg,
5213 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005214#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005215 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005216 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5217 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5218 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005219 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005220 }
5221#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005222
Jerry Yuf3b46b52022-06-19 16:52:27 +08005223 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5224 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005225
5226 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5227 {
5228 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5229 common_idx += 1;
5230 }
5231 }
5232 /* Check that we consumed all the message. */
5233 if( p != end )
5234 {
5235 MBEDTLS_SSL_DEBUG_MSG( 1,
5236 ( "Signature algorithms extension length misaligned" ) );
5237 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5238 MBEDTLS_ERR_SSL_DECODE_ERROR );
5239 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5240 }
5241
5242 if( common_idx == 0 )
5243 {
5244 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5245 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5246 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5247 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5248 }
5249
Gabor Mezei15b95a62022-05-09 16:37:58 +02005250 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005251 return( 0 );
5252}
5253
5254#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5255
Jerry Yudc7bd172022-02-17 13:44:15 +08005256#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5257
5258#if defined(MBEDTLS_USE_PSA_CRYPTO)
5259
5260static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5261 mbedtls_svc_key_id_t key,
5262 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005263 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005264 const unsigned char* seed, size_t seed_length,
5265 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005266 const unsigned char* other_secret,
5267 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005268 size_t capacity )
5269{
5270 psa_status_t status;
5271
5272 status = psa_key_derivation_setup( derivation, alg );
5273 if( status != PSA_SUCCESS )
5274 return( status );
5275
5276 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5277 {
5278 status = psa_key_derivation_input_bytes( derivation,
5279 PSA_KEY_DERIVATION_INPUT_SEED,
5280 seed, seed_length );
5281 if( status != PSA_SUCCESS )
5282 return( status );
5283
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005284 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005285 {
5286 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005287 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5288 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005289 if( status != PSA_SUCCESS )
5290 return( status );
5291 }
5292
Jerry Yudc7bd172022-02-17 13:44:15 +08005293 if( mbedtls_svc_key_id_is_null( key ) )
5294 {
5295 status = psa_key_derivation_input_bytes(
5296 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005297 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005298 }
5299 else
5300 {
5301 status = psa_key_derivation_input_key(
5302 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5303 }
5304 if( status != PSA_SUCCESS )
5305 return( status );
5306
5307 status = psa_key_derivation_input_bytes( derivation,
5308 PSA_KEY_DERIVATION_INPUT_LABEL,
5309 label, label_length );
5310 if( status != PSA_SUCCESS )
5311 return( status );
5312 }
5313 else
5314 {
5315 return( PSA_ERROR_NOT_SUPPORTED );
5316 }
5317
5318 status = psa_key_derivation_set_capacity( derivation, capacity );
5319 if( status != PSA_SUCCESS )
5320 return( status );
5321
5322 return( PSA_SUCCESS );
5323}
5324
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005325MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005326static int tls_prf_generic( mbedtls_md_type_t md_type,
5327 const unsigned char *secret, size_t slen,
5328 const char *label,
5329 const unsigned char *random, size_t rlen,
5330 unsigned char *dstbuf, size_t dlen )
5331{
5332 psa_status_t status;
5333 psa_algorithm_t alg;
5334 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5335 psa_key_derivation_operation_t derivation =
5336 PSA_KEY_DERIVATION_OPERATION_INIT;
5337
5338 if( md_type == MBEDTLS_MD_SHA384 )
5339 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5340 else
5341 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5342
5343 /* Normally a "secret" should be long enough to be impossible to
5344 * find by brute force, and in particular should not be empty. But
5345 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5346 * and for this use case it makes sense to have a 0-length "secret".
5347 * Since the key API doesn't allow importing a key of length 0,
5348 * keep master_key=0, which setup_psa_key_derivation() understands
5349 * to mean a 0-length "secret" input. */
5350 if( slen != 0 )
5351 {
5352 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5353 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5354 psa_set_key_algorithm( &key_attributes, alg );
5355 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5356
5357 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5358 if( status != PSA_SUCCESS )
5359 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5360 }
5361
5362 status = setup_psa_key_derivation( &derivation,
5363 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005364 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005365 random, rlen,
5366 (unsigned char const *) label,
5367 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005368 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005369 dlen );
5370 if( status != PSA_SUCCESS )
5371 {
5372 psa_key_derivation_abort( &derivation );
5373 psa_destroy_key( master_key );
5374 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5375 }
5376
5377 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5378 if( status != PSA_SUCCESS )
5379 {
5380 psa_key_derivation_abort( &derivation );
5381 psa_destroy_key( master_key );
5382 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5383 }
5384
5385 status = psa_key_derivation_abort( &derivation );
5386 if( status != PSA_SUCCESS )
5387 {
5388 psa_destroy_key( master_key );
5389 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5390 }
5391
5392 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5393 status = psa_destroy_key( master_key );
5394 if( status != PSA_SUCCESS )
5395 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5396
5397 return( 0 );
5398}
5399
5400#else /* MBEDTLS_USE_PSA_CRYPTO */
5401
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005402MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005403static int tls_prf_generic( mbedtls_md_type_t md_type,
5404 const unsigned char *secret, size_t slen,
5405 const char *label,
5406 const unsigned char *random, size_t rlen,
5407 unsigned char *dstbuf, size_t dlen )
5408{
5409 size_t nb;
5410 size_t i, j, k, md_len;
5411 unsigned char *tmp;
5412 size_t tmp_len = 0;
5413 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5414 const mbedtls_md_info_t *md_info;
5415 mbedtls_md_context_t md_ctx;
5416 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5417
5418 mbedtls_md_init( &md_ctx );
5419
5420 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5421 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5422
5423 md_len = mbedtls_md_get_size( md_info );
5424
5425 tmp_len = md_len + strlen( label ) + rlen;
5426 tmp = mbedtls_calloc( 1, tmp_len );
5427 if( tmp == NULL )
5428 {
5429 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5430 goto exit;
5431 }
5432
5433 nb = strlen( label );
5434 memcpy( tmp + md_len, label, nb );
5435 memcpy( tmp + md_len + nb, random, rlen );
5436 nb += rlen;
5437
5438 /*
5439 * Compute P_<hash>(secret, label + random)[0..dlen]
5440 */
5441 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5442 goto exit;
5443
5444 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5445 if( ret != 0 )
5446 goto exit;
5447 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5448 if( ret != 0 )
5449 goto exit;
5450 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5451 if( ret != 0 )
5452 goto exit;
5453
5454 for( i = 0; i < dlen; i += md_len )
5455 {
5456 ret = mbedtls_md_hmac_reset ( &md_ctx );
5457 if( ret != 0 )
5458 goto exit;
5459 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5460 if( ret != 0 )
5461 goto exit;
5462 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5463 if( ret != 0 )
5464 goto exit;
5465
5466 ret = mbedtls_md_hmac_reset ( &md_ctx );
5467 if( ret != 0 )
5468 goto exit;
5469 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5470 if( ret != 0 )
5471 goto exit;
5472 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5473 if( ret != 0 )
5474 goto exit;
5475
5476 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5477
5478 for( j = 0; j < k; j++ )
5479 dstbuf[i + j] = h_i[j];
5480 }
5481
5482exit:
5483 mbedtls_md_free( &md_ctx );
5484
5485 mbedtls_platform_zeroize( tmp, tmp_len );
5486 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5487
5488 mbedtls_free( tmp );
5489
5490 return( ret );
5491}
5492#endif /* MBEDTLS_USE_PSA_CRYPTO */
5493
5494#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005495MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005496static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5497 const char *label,
5498 const unsigned char *random, size_t rlen,
5499 unsigned char *dstbuf, size_t dlen )
5500{
5501 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5502 label, random, rlen, dstbuf, dlen ) );
5503}
5504#endif /* MBEDTLS_SHA256_C */
5505
5506#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005507MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005508static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5509 const char *label,
5510 const unsigned char *random, size_t rlen,
5511 unsigned char *dstbuf, size_t dlen )
5512{
5513 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5514 label, random, rlen, dstbuf, dlen ) );
5515}
5516#endif /* MBEDTLS_SHA384_C */
5517
Jerry Yuf009d862022-02-17 14:01:37 +08005518/*
5519 * Set appropriate PRF function and other SSL / TLS1.2 functions
5520 *
5521 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005522 * - hash associated with the ciphersuite (only used by TLS 1.2)
5523 *
5524 * Outputs:
5525 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5526 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005527MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005528static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005529 mbedtls_md_type_t hash )
5530{
Jerry Yuf009d862022-02-17 14:01:37 +08005531#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005532 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005533 {
5534 handshake->tls_prf = tls_prf_sha384;
5535 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5536 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5537 }
5538 else
5539#endif
5540#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005541 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005542 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005543 handshake->tls_prf = tls_prf_sha256;
5544 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5545 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5546 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005547#else
Jerry Yuf009d862022-02-17 14:01:37 +08005548 {
Jerry Yuf009d862022-02-17 14:01:37 +08005549 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005550 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5552 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005553#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005554
5555 return( 0 );
5556}
Jerry Yud6ab2352022-02-17 14:03:43 +08005557
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005558/*
5559 * Compute master secret if needed
5560 *
5561 * Parameters:
5562 * [in/out] handshake
5563 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5564 * (PSA-PSK) ciphersuite_info, psk_opaque
5565 * [out] premaster (cleared)
5566 * [out] master
5567 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5568 * debug: conf->f_dbg, conf->p_dbg
5569 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005570 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005571 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005572MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005573static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5574 unsigned char *master,
5575 const mbedtls_ssl_context *ssl )
5576{
5577 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5578
5579 /* cf. RFC 5246, Section 8.1:
5580 * "The master secret is always exactly 48 bytes in length." */
5581 size_t const master_secret_len = 48;
5582
5583#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5584 unsigned char session_hash[48];
5585#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5586
5587 /* The label for the KDF used for key expansion.
5588 * This is either "master secret" or "extended master secret"
5589 * depending on whether the Extended Master Secret extension
5590 * is used. */
5591 char const *lbl = "master secret";
5592
Przemek Stekielae4ed302022-04-05 17:15:55 +02005593 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005594 * - If the Extended Master Secret extension is not used,
5595 * this is ClientHello.Random + ServerHello.Random
5596 * (see Sect. 8.1 in RFC 5246).
5597 * - If the Extended Master Secret extension is used,
5598 * this is the transcript of the handshake so far.
5599 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005600 unsigned char const *seed = handshake->randbytes;
5601 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005602
5603#if !defined(MBEDTLS_DEBUG_C) && \
5604 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5605 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5606 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5607 ssl = NULL; /* make sure we don't use it except for those cases */
5608 (void) ssl;
5609#endif
5610
5611 if( handshake->resume != 0 )
5612 {
5613 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5614 return( 0 );
5615 }
5616
5617#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5618 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5619 {
5620 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005621 seed = session_hash;
5622 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005623
5624 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005625 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005626 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005627#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005628
Przemek Stekiel99114f32022-04-22 11:20:09 +02005629#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005630 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005631 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005632 {
5633 /* Perform PSK-to-MS expansion in a single step. */
5634 psa_status_t status;
5635 psa_algorithm_t alg;
5636 mbedtls_svc_key_id_t psk;
5637 psa_key_derivation_operation_t derivation =
5638 PSA_KEY_DERIVATION_OPERATION_INIT;
5639 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5640
5641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5642
5643 psk = mbedtls_ssl_get_opaque_psk( ssl );
5644
5645 if( hash_alg == MBEDTLS_MD_SHA384 )
5646 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5647 else
5648 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5649
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005650 size_t other_secret_len = 0;
5651 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005652
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005653 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005654 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005655 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005656 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005657 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005658 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005659 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005660 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005661 other_secret_len = 48;
5662 other_secret = handshake->premaster + 2;
5663 break;
5664 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005665 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005666 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5667 other_secret = handshake->premaster + 2;
5668 break;
5669 default:
5670 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005671 }
5672
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005673 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005674 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005675 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005676 (unsigned char const *) lbl,
5677 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005678 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005679 master_secret_len );
5680 if( status != PSA_SUCCESS )
5681 {
5682 psa_key_derivation_abort( &derivation );
5683 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5684 }
5685
5686 status = psa_key_derivation_output_bytes( &derivation,
5687 master,
5688 master_secret_len );
5689 if( status != PSA_SUCCESS )
5690 {
5691 psa_key_derivation_abort( &derivation );
5692 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5693 }
5694
5695 status = psa_key_derivation_abort( &derivation );
5696 if( status != PSA_SUCCESS )
5697 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5698 }
5699 else
5700#endif
5701 {
5702 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005703 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005704 master,
5705 master_secret_len );
5706 if( ret != 0 )
5707 {
5708 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5709 return( ret );
5710 }
5711
5712 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5713 handshake->premaster,
5714 handshake->pmslen );
5715
5716 mbedtls_platform_zeroize( handshake->premaster,
5717 sizeof(handshake->premaster) );
5718 }
5719
5720 return( 0 );
5721}
5722
Jerry Yud62f87e2022-02-17 14:09:02 +08005723int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5724{
5725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5726 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5727 ssl->handshake->ciphersuite_info;
5728
5729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5730
5731 /* Set PRF, calc_verify and calc_finished function pointers */
5732 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005733 ciphersuite_info->mac );
5734 if( ret != 0 )
5735 {
5736 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5737 return( ret );
5738 }
5739
5740 /* Compute master secret if needed */
5741 ret = ssl_compute_master( ssl->handshake,
5742 ssl->session_negotiate->master,
5743 ssl );
5744 if( ret != 0 )
5745 {
5746 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5747 return( ret );
5748 }
5749
5750 /* Swap the client and server random values:
5751 * - MS derivation wanted client+server (RFC 5246 8.1)
5752 * - key derivation wants server+client (RFC 5246 6.3) */
5753 {
5754 unsigned char tmp[64];
5755 memcpy( tmp, ssl->handshake->randbytes, 64 );
5756 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5757 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5758 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5759 }
5760
5761 /* Populate transform structure */
5762 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5763 ssl->session_negotiate->ciphersuite,
5764 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005765#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005766 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005767#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005768 ssl->handshake->tls_prf,
5769 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005770 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005771 ssl->conf->endpoint,
5772 ssl );
5773 if( ret != 0 )
5774 {
5775 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5776 return( ret );
5777 }
5778
5779 /* We no longer need Server/ClientHello.random values */
5780 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5781 sizeof( ssl->handshake->randbytes ) );
5782
5783 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5784
5785 return( 0 );
5786}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005787
Ronald Cron4dcbca92022-03-07 10:21:40 +01005788int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5789{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005790 switch( md )
5791 {
5792#if defined(MBEDTLS_SHA384_C)
5793 case MBEDTLS_SSL_HASH_SHA384:
5794 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5795 break;
5796#endif
5797#if defined(MBEDTLS_SHA256_C)
5798 case MBEDTLS_SSL_HASH_SHA256:
5799 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5800 break;
5801#endif
5802 default:
5803 return( -1 );
5804 }
5805
Ronald Cronc2f13a02022-03-07 10:25:24 +01005806 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005807}
5808
Jerry Yu8392e0d2022-02-17 14:10:24 +08005809#if defined(MBEDTLS_SHA256_C)
5810void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5811 unsigned char *hash,
5812 size_t *hlen )
5813{
5814#if defined(MBEDTLS_USE_PSA_CRYPTO)
5815 size_t hash_size;
5816 psa_status_t status;
5817 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5818
5819 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5820 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5821 if( status != PSA_SUCCESS )
5822 {
5823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5824 return;
5825 }
5826
5827 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5828 if( status != PSA_SUCCESS )
5829 {
5830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5831 return;
5832 }
5833
5834 *hlen = 32;
5835 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5837#else
5838 mbedtls_sha256_context sha256;
5839
5840 mbedtls_sha256_init( &sha256 );
5841
5842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5843
5844 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5845 mbedtls_sha256_finish( &sha256, hash );
5846
5847 *hlen = 32;
5848
5849 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5850 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5851
5852 mbedtls_sha256_free( &sha256 );
5853#endif /* MBEDTLS_USE_PSA_CRYPTO */
5854 return;
5855}
5856#endif /* MBEDTLS_SHA256_C */
5857
Jerry Yuc1cb3842022-02-17 14:13:48 +08005858#if defined(MBEDTLS_SHA384_C)
5859void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5860 unsigned char *hash,
5861 size_t *hlen )
5862{
5863#if defined(MBEDTLS_USE_PSA_CRYPTO)
5864 size_t hash_size;
5865 psa_status_t status;
5866 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5867
5868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5869 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5870 if( status != PSA_SUCCESS )
5871 {
5872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5873 return;
5874 }
5875
5876 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5877 if( status != PSA_SUCCESS )
5878 {
5879 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5880 return;
5881 }
5882
5883 *hlen = 48;
5884 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5885 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5886#else
5887 mbedtls_sha512_context sha512;
5888
5889 mbedtls_sha512_init( &sha512 );
5890
5891 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5892
5893 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5894 mbedtls_sha512_finish( &sha512, hash );
5895
5896 *hlen = 48;
5897
5898 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5900
5901 mbedtls_sha512_free( &sha512 );
5902#endif /* MBEDTLS_USE_PSA_CRYPTO */
5903 return;
5904}
5905#endif /* MBEDTLS_SHA384_C */
5906
Neil Armstrong80f6f322022-05-03 17:56:38 +02005907#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5908 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005909int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5910{
5911 unsigned char *p = ssl->handshake->premaster;
5912 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5913 const unsigned char *psk = NULL;
5914 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005915 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005916
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005917 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005918 {
5919 /*
5920 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005921 * checked before calling this function.
5922 *
5923 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005924 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005925 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005926 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5927 {
5928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5929 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5930 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005931 }
5932
5933 /*
5934 * PMS = struct {
5935 * opaque other_secret<0..2^16-1>;
5936 * opaque psk<0..2^16-1>;
5937 * };
5938 * with "other_secret" depending on the particular key exchange
5939 */
5940#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5941 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5942 {
5943 if( end - p < 2 )
5944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5945
5946 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5947 p += 2;
5948
5949 if( end < p || (size_t)( end - p ) < psk_len )
5950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5951
5952 memset( p, 0, psk_len );
5953 p += psk_len;
5954 }
5955 else
5956#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5957#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5958 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5959 {
5960 /*
5961 * other_secret already set by the ClientKeyExchange message,
5962 * and is 48 bytes long
5963 */
5964 if( end - p < 2 )
5965 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5966
5967 *p++ = 0;
5968 *p++ = 48;
5969 p += 48;
5970 }
5971 else
5972#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5973#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5974 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5975 {
5976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5977 size_t len;
5978
5979 /* Write length only when we know the actual value */
5980 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5981 p + 2, end - ( p + 2 ), &len,
5982 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5983 {
5984 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5985 return( ret );
5986 }
5987 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5988 p += 2 + len;
5989
5990 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5991 }
5992 else
5993#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005994#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005995 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5996 {
5997 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5998 size_t zlen;
5999
6000 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
6001 p + 2, end - ( p + 2 ),
6002 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
6003 {
6004 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
6005 return( ret );
6006 }
6007
6008 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
6009 p += 2 + zlen;
6010
6011 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
6012 MBEDTLS_DEBUG_ECDH_Z );
6013 }
6014 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006015#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006016 {
6017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6018 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6019 }
6020
6021 /* opaque psk<0..2^16-1>; */
6022 if( end - p < 2 )
6023 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6024
6025 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
6026 p += 2;
6027
6028 if( end < p || (size_t)( end - p ) < psk_len )
6029 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
6030
6031 memcpy( p, psk, psk_len );
6032 p += psk_len;
6033
6034 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6035
6036 return( 0 );
6037}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006038#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006039
6040#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006041MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08006042static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
6043
6044#if defined(MBEDTLS_SSL_PROTO_DTLS)
6045int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
6046{
6047 /* If renegotiation is not enforced, retransmit until we would reach max
6048 * timeout if we were using the usual handshake doubling scheme */
6049 if( ssl->conf->renego_max_records < 0 )
6050 {
6051 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6052 unsigned char doublings = 1;
6053
6054 while( ratio != 0 )
6055 {
6056 ++doublings;
6057 ratio >>= 1;
6058 }
6059
6060 if( ++ssl->renego_records_seen > doublings )
6061 {
6062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
6063 return( 0 );
6064 }
6065 }
6066
6067 return( ssl_write_hello_request( ssl ) );
6068}
6069#endif
6070#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006071
Jerry Yud9526692022-02-17 14:23:47 +08006072/*
6073 * Handshake functions
6074 */
6075#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6076/* No certificate support -> dummy functions */
6077int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6078{
6079 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6080 ssl->handshake->ciphersuite_info;
6081
6082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6083
6084 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6085 {
6086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6087 ssl->state++;
6088 return( 0 );
6089 }
6090
6091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6092 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6093}
6094
6095int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6096{
6097 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6098 ssl->handshake->ciphersuite_info;
6099
6100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6101
6102 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6103 {
6104 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6105 ssl->state++;
6106 return( 0 );
6107 }
6108
6109 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
6110 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6111}
6112
6113#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6114/* Some certificate support -> implement write and parse */
6115
6116int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
6117{
6118 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6119 size_t i, n;
6120 const mbedtls_x509_crt *crt;
6121 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6122 ssl->handshake->ciphersuite_info;
6123
6124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
6125
6126 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6127 {
6128 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6129 ssl->state++;
6130 return( 0 );
6131 }
6132
6133#if defined(MBEDTLS_SSL_CLI_C)
6134 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6135 {
6136 if( ssl->handshake->client_auth == 0 )
6137 {
6138 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
6139 ssl->state++;
6140 return( 0 );
6141 }
6142 }
6143#endif /* MBEDTLS_SSL_CLI_C */
6144#if defined(MBEDTLS_SSL_SRV_C)
6145 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6146 {
6147 if( mbedtls_ssl_own_cert( ssl ) == NULL )
6148 {
6149 /* Should never happen because we shouldn't have picked the
6150 * ciphersuite if we don't have a certificate. */
6151 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6152 }
6153 }
6154#endif
6155
6156 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
6157
6158 /*
6159 * 0 . 0 handshake type
6160 * 1 . 3 handshake length
6161 * 4 . 6 length of all certs
6162 * 7 . 9 length of cert. 1
6163 * 10 . n-1 peer certificate
6164 * n . n+2 length of cert. 2
6165 * n+3 . ... upper level cert, etc.
6166 */
6167 i = 7;
6168 crt = mbedtls_ssl_own_cert( ssl );
6169
6170 while( crt != NULL )
6171 {
6172 n = crt->raw.len;
6173 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
6174 {
6175 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
6176 " > %" MBEDTLS_PRINTF_SIZET,
6177 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
6178 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
6179 }
6180
6181 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
6182 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
6183 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
6184
6185 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
6186 i += n; crt = crt->next;
6187 }
6188
6189 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
6190 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
6191 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
6192
6193 ssl->out_msglen = i;
6194 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6195 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6196
6197 ssl->state++;
6198
6199 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6200 {
6201 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6202 return( ret );
6203 }
6204
6205 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
6206
6207 return( ret );
6208}
6209
6210#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6211
6212#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006214static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6215 unsigned char *crt_buf,
6216 size_t crt_buf_len )
6217{
6218 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6219
6220 if( peer_crt == NULL )
6221 return( -1 );
6222
6223 if( peer_crt->raw.len != crt_buf_len )
6224 return( -1 );
6225
6226 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6227}
6228#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006229MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006230static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6231 unsigned char *crt_buf,
6232 size_t crt_buf_len )
6233{
6234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6235 unsigned char const * const peer_cert_digest =
6236 ssl->session->peer_cert_digest;
6237 mbedtls_md_type_t const peer_cert_digest_type =
6238 ssl->session->peer_cert_digest_type;
6239 mbedtls_md_info_t const * const digest_info =
6240 mbedtls_md_info_from_type( peer_cert_digest_type );
6241 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6242 size_t digest_len;
6243
6244 if( peer_cert_digest == NULL || digest_info == NULL )
6245 return( -1 );
6246
6247 digest_len = mbedtls_md_get_size( digest_info );
6248 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6249 return( -1 );
6250
6251 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6252 if( ret != 0 )
6253 return( -1 );
6254
6255 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6256}
6257#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6258#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6259
6260/*
6261 * Once the certificate message is read, parse it into a cert chain and
6262 * perform basic checks, but leave actual verification to the caller
6263 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006264MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006265static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6266 mbedtls_x509_crt *chain )
6267{
6268 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6269#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6270 int crt_cnt=0;
6271#endif
6272 size_t i, n;
6273 uint8_t alert;
6274
6275 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6276 {
6277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6278 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6279 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6280 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6281 }
6282
6283 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6284 {
6285 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6286 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6287 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6288 }
6289
6290 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6291 {
6292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6293 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6294 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6295 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6296 }
6297
6298 i = mbedtls_ssl_hs_hdr_len( ssl );
6299
6300 /*
6301 * Same message structure as in mbedtls_ssl_write_certificate()
6302 */
6303 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6304
6305 if( ssl->in_msg[i] != 0 ||
6306 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6307 {
6308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6309 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6310 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6311 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6312 }
6313
6314 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6315 i += 3;
6316
6317 /* Iterate through and parse the CRTs in the provided chain. */
6318 while( i < ssl->in_hslen )
6319 {
6320 /* Check that there's room for the next CRT's length fields. */
6321 if ( i + 3 > ssl->in_hslen ) {
6322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6323 mbedtls_ssl_send_alert_message( ssl,
6324 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6325 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6326 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6327 }
6328 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6329 * anything beyond 2**16 ~ 64K. */
6330 if( ssl->in_msg[i] != 0 )
6331 {
6332 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6333 mbedtls_ssl_send_alert_message( ssl,
6334 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6335 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6336 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6337 }
6338
6339 /* Read length of the next CRT in the chain. */
6340 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6341 | (unsigned int) ssl->in_msg[i + 2];
6342 i += 3;
6343
6344 if( n < 128 || i + n > ssl->in_hslen )
6345 {
6346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6347 mbedtls_ssl_send_alert_message( ssl,
6348 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6349 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6350 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6351 }
6352
6353 /* Check if we're handling the first CRT in the chain. */
6354#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6355 if( crt_cnt++ == 0 &&
6356 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6357 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6358 {
6359 /* During client-side renegotiation, check that the server's
6360 * end-CRTs hasn't changed compared to the initial handshake,
6361 * mitigating the triple handshake attack. On success, reuse
6362 * the original end-CRT instead of parsing it again. */
6363 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6364 if( ssl_check_peer_crt_unchanged( ssl,
6365 &ssl->in_msg[i],
6366 n ) != 0 )
6367 {
6368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6369 mbedtls_ssl_send_alert_message( ssl,
6370 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6371 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6372 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6373 }
6374
6375 /* Now we can safely free the original chain. */
6376 ssl_clear_peer_cert( ssl->session );
6377 }
6378#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6379
6380 /* Parse the next certificate in the chain. */
6381#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6382 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6383#else
6384 /* If we don't need to store the CRT chain permanently, parse
6385 * it in-place from the input buffer instead of making a copy. */
6386 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6387#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6388 switch( ret )
6389 {
6390 case 0: /*ok*/
6391 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6392 /* Ignore certificate with an unknown algorithm: maybe a
6393 prior certificate was already trusted. */
6394 break;
6395
6396 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6397 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6398 goto crt_parse_der_failed;
6399
6400 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6401 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6402 goto crt_parse_der_failed;
6403
6404 default:
6405 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6406 crt_parse_der_failed:
6407 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6408 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6409 return( ret );
6410 }
6411
6412 i += n;
6413 }
6414
6415 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6416 return( 0 );
6417}
6418
6419#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006420MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006421static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6422{
6423 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6424 return( -1 );
6425
6426 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6427 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6428 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6429 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6430 {
Ronald Cron19385882022-06-15 16:26:13 +02006431 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006432 return( 0 );
6433 }
6434 return( -1 );
6435}
6436#endif /* MBEDTLS_SSL_SRV_C */
6437
6438/* Check if a certificate message is expected.
6439 * Return either
6440 * - SSL_CERTIFICATE_EXPECTED, or
6441 * - SSL_CERTIFICATE_SKIP
6442 * indicating whether a Certificate message is expected or not.
6443 */
6444#define SSL_CERTIFICATE_EXPECTED 0
6445#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006446MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006447static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6448 int authmode )
6449{
6450 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6451 ssl->handshake->ciphersuite_info;
6452
6453 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6454 return( SSL_CERTIFICATE_SKIP );
6455
6456#if defined(MBEDTLS_SSL_SRV_C)
6457 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6458 {
6459 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6460 return( SSL_CERTIFICATE_SKIP );
6461
6462 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6463 {
6464 ssl->session_negotiate->verify_result =
6465 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6466 return( SSL_CERTIFICATE_SKIP );
6467 }
6468 }
6469#else
6470 ((void) authmode);
6471#endif /* MBEDTLS_SSL_SRV_C */
6472
6473 return( SSL_CERTIFICATE_EXPECTED );
6474}
6475
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006476MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006477static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6478 int authmode,
6479 mbedtls_x509_crt *chain,
6480 void *rs_ctx )
6481{
6482 int ret = 0;
6483 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6484 ssl->handshake->ciphersuite_info;
6485 int have_ca_chain = 0;
6486
6487 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6488 void *p_vrfy;
6489
6490 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6491 return( 0 );
6492
6493 if( ssl->f_vrfy != NULL )
6494 {
6495 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6496 f_vrfy = ssl->f_vrfy;
6497 p_vrfy = ssl->p_vrfy;
6498 }
6499 else
6500 {
6501 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6502 f_vrfy = ssl->conf->f_vrfy;
6503 p_vrfy = ssl->conf->p_vrfy;
6504 }
6505
6506 /*
6507 * Main check: verify certificate
6508 */
6509#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6510 if( ssl->conf->f_ca_cb != NULL )
6511 {
6512 ((void) rs_ctx);
6513 have_ca_chain = 1;
6514
6515 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6516 ret = mbedtls_x509_crt_verify_with_ca_cb(
6517 chain,
6518 ssl->conf->f_ca_cb,
6519 ssl->conf->p_ca_cb,
6520 ssl->conf->cert_profile,
6521 ssl->hostname,
6522 &ssl->session_negotiate->verify_result,
6523 f_vrfy, p_vrfy );
6524 }
6525 else
6526#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6527 {
6528 mbedtls_x509_crt *ca_chain;
6529 mbedtls_x509_crl *ca_crl;
6530
6531#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6532 if( ssl->handshake->sni_ca_chain != NULL )
6533 {
6534 ca_chain = ssl->handshake->sni_ca_chain;
6535 ca_crl = ssl->handshake->sni_ca_crl;
6536 }
6537 else
6538#endif
6539 {
6540 ca_chain = ssl->conf->ca_chain;
6541 ca_crl = ssl->conf->ca_crl;
6542 }
6543
6544 if( ca_chain != NULL )
6545 have_ca_chain = 1;
6546
6547 ret = mbedtls_x509_crt_verify_restartable(
6548 chain,
6549 ca_chain, ca_crl,
6550 ssl->conf->cert_profile,
6551 ssl->hostname,
6552 &ssl->session_negotiate->verify_result,
6553 f_vrfy, p_vrfy, rs_ctx );
6554 }
6555
6556 if( ret != 0 )
6557 {
6558 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6559 }
6560
6561#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6562 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6563 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6564#endif
6565
6566 /*
6567 * Secondary checks: always done, but change 'ret' only if it was 0
6568 */
6569
6570#if defined(MBEDTLS_ECP_C)
6571 {
6572 const mbedtls_pk_context *pk = &chain->pk;
6573
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006574 /* If certificate uses an EC key, make sure the curve is OK.
6575 * This is a public key, so it can't be opaque, so can_do() is a good
6576 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006577 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6578 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6579 {
6580 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6581
6582 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6583 if( ret == 0 )
6584 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6585 }
6586 }
6587#endif /* MBEDTLS_ECP_C */
6588
6589 if( mbedtls_ssl_check_cert_usage( chain,
6590 ciphersuite_info,
6591 ! ssl->conf->endpoint,
6592 &ssl->session_negotiate->verify_result ) != 0 )
6593 {
6594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6595 if( ret == 0 )
6596 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6597 }
6598
6599 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6600 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6601 * with details encoded in the verification flags. All other kinds
6602 * of error codes, including those from the user provided f_vrfy
6603 * functions, are treated as fatal and lead to a failure of
6604 * ssl_parse_certificate even if verification was optional. */
6605 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6606 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6607 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6608 {
6609 ret = 0;
6610 }
6611
6612 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6613 {
6614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6615 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6616 }
6617
6618 if( ret != 0 )
6619 {
6620 uint8_t alert;
6621
6622 /* The certificate may have been rejected for several reasons.
6623 Pick one and send the corresponding alert. Which alert to send
6624 may be a subject of debate in some cases. */
6625 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6626 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6627 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6628 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6629 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6630 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6631 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6632 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6633 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6634 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6635 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6636 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6637 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6638 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6639 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6640 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6641 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6642 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6643 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6644 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6645 else
6646 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6647 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6648 alert );
6649 }
6650
6651#if defined(MBEDTLS_DEBUG_C)
6652 if( ssl->session_negotiate->verify_result != 0 )
6653 {
6654 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6655 (unsigned int) ssl->session_negotiate->verify_result ) );
6656 }
6657 else
6658 {
6659 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6660 }
6661#endif /* MBEDTLS_DEBUG_C */
6662
6663 return( ret );
6664}
6665
6666#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006667MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006668static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6669 unsigned char *start, size_t len )
6670{
6671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6672 /* Remember digest of the peer's end-CRT. */
6673 ssl->session_negotiate->peer_cert_digest =
6674 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6675 if( ssl->session_negotiate->peer_cert_digest == NULL )
6676 {
6677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6678 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6679 mbedtls_ssl_send_alert_message( ssl,
6680 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6681 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6682
6683 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6684 }
6685
6686 ret = mbedtls_md( mbedtls_md_info_from_type(
6687 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6688 start, len,
6689 ssl->session_negotiate->peer_cert_digest );
6690
6691 ssl->session_negotiate->peer_cert_digest_type =
6692 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6693 ssl->session_negotiate->peer_cert_digest_len =
6694 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6695
6696 return( ret );
6697}
6698
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006699MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006700static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6701 unsigned char *start, size_t len )
6702{
6703 unsigned char *end = start + len;
6704 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6705
6706 /* Make a copy of the peer's raw public key. */
6707 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6708 ret = mbedtls_pk_parse_subpubkey( &start, end,
6709 &ssl->handshake->peer_pubkey );
6710 if( ret != 0 )
6711 {
6712 /* We should have parsed the public key before. */
6713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6714 }
6715
6716 return( 0 );
6717}
6718#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6719
6720int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6721{
6722 int ret = 0;
6723 int crt_expected;
6724#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6725 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6726 ? ssl->handshake->sni_authmode
6727 : ssl->conf->authmode;
6728#else
6729 const int authmode = ssl->conf->authmode;
6730#endif
6731 void *rs_ctx = NULL;
6732 mbedtls_x509_crt *chain = NULL;
6733
6734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6735
6736 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6737 if( crt_expected == SSL_CERTIFICATE_SKIP )
6738 {
6739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6740 goto exit;
6741 }
6742
6743#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6744 if( ssl->handshake->ecrs_enabled &&
6745 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6746 {
6747 chain = ssl->handshake->ecrs_peer_cert;
6748 ssl->handshake->ecrs_peer_cert = NULL;
6749 goto crt_verify;
6750 }
6751#endif
6752
6753 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6754 {
6755 /* mbedtls_ssl_read_record may have sent an alert already. We
6756 let it decide whether to alert. */
6757 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6758 goto exit;
6759 }
6760
6761#if defined(MBEDTLS_SSL_SRV_C)
6762 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6763 {
6764 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6765
6766 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6767 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6768
6769 goto exit;
6770 }
6771#endif /* MBEDTLS_SSL_SRV_C */
6772
6773 /* Clear existing peer CRT structure in case we tried to
6774 * reuse a session but it failed, and allocate a new one. */
6775 ssl_clear_peer_cert( ssl->session_negotiate );
6776
6777 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6778 if( chain == NULL )
6779 {
6780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6781 sizeof( mbedtls_x509_crt ) ) );
6782 mbedtls_ssl_send_alert_message( ssl,
6783 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6784 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6785
6786 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6787 goto exit;
6788 }
6789 mbedtls_x509_crt_init( chain );
6790
6791 ret = ssl_parse_certificate_chain( ssl, chain );
6792 if( ret != 0 )
6793 goto exit;
6794
6795#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6796 if( ssl->handshake->ecrs_enabled)
6797 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6798
6799crt_verify:
6800 if( ssl->handshake->ecrs_enabled)
6801 rs_ctx = &ssl->handshake->ecrs_ctx;
6802#endif
6803
6804 ret = ssl_parse_certificate_verify( ssl, authmode,
6805 chain, rs_ctx );
6806 if( ret != 0 )
6807 goto exit;
6808
6809#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6810 {
6811 unsigned char *crt_start, *pk_start;
6812 size_t crt_len, pk_len;
6813
6814 /* We parse the CRT chain without copying, so
6815 * these pointers point into the input buffer,
6816 * and are hence still valid after freeing the
6817 * CRT chain. */
6818
6819 crt_start = chain->raw.p;
6820 crt_len = chain->raw.len;
6821
6822 pk_start = chain->pk_raw.p;
6823 pk_len = chain->pk_raw.len;
6824
6825 /* Free the CRT structures before computing
6826 * digest and copying the peer's public key. */
6827 mbedtls_x509_crt_free( chain );
6828 mbedtls_free( chain );
6829 chain = NULL;
6830
6831 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6832 if( ret != 0 )
6833 goto exit;
6834
6835 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6836 if( ret != 0 )
6837 goto exit;
6838 }
6839#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6840 /* Pass ownership to session structure. */
6841 ssl->session_negotiate->peer_cert = chain;
6842 chain = NULL;
6843#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6844
6845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6846
6847exit:
6848
6849 if( ret == 0 )
6850 ssl->state++;
6851
6852#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6853 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6854 {
6855 ssl->handshake->ecrs_peer_cert = chain;
6856 chain = NULL;
6857 }
6858#endif
6859
6860 if( chain != NULL )
6861 {
6862 mbedtls_x509_crt_free( chain );
6863 mbedtls_free( chain );
6864 }
6865
6866 return( ret );
6867}
6868#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6869
Jerry Yu615bd6f2022-02-17 14:25:15 +08006870#if defined(MBEDTLS_SHA256_C)
6871static void ssl_calc_finished_tls_sha256(
6872 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6873{
6874 int len = 12;
6875 const char *sender;
6876 unsigned char padbuf[32];
6877#if defined(MBEDTLS_USE_PSA_CRYPTO)
6878 size_t hash_size;
6879 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6880 psa_status_t status;
6881#else
6882 mbedtls_sha256_context sha256;
6883#endif
6884
6885 mbedtls_ssl_session *session = ssl->session_negotiate;
6886 if( !session )
6887 session = ssl->session;
6888
6889 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6890 ? "client finished"
6891 : "server finished";
6892
6893#if defined(MBEDTLS_USE_PSA_CRYPTO)
6894 sha256_psa = psa_hash_operation_init();
6895
6896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6897
6898 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6899 if( status != PSA_SUCCESS )
6900 {
6901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6902 return;
6903 }
6904
6905 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6906 if( status != PSA_SUCCESS )
6907 {
6908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6909 return;
6910 }
6911 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6912#else
6913
6914 mbedtls_sha256_init( &sha256 );
6915
6916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6917
6918 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6919
6920 /*
6921 * TLSv1.2:
6922 * hash = PRF( master, finished_label,
6923 * Hash( handshake ) )[0.11]
6924 */
6925
6926#if !defined(MBEDTLS_SHA256_ALT)
6927 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6928 sha256.state, sizeof( sha256.state ) );
6929#endif
6930
6931 mbedtls_sha256_finish( &sha256, padbuf );
6932 mbedtls_sha256_free( &sha256 );
6933#endif /* MBEDTLS_USE_PSA_CRYPTO */
6934
6935 ssl->handshake->tls_prf( session->master, 48, sender,
6936 padbuf, 32, buf, len );
6937
6938 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6939
6940 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6941
6942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6943}
6944#endif /* MBEDTLS_SHA256_C */
6945
Jerry Yub7ba49e2022-02-17 14:25:53 +08006946
6947#if defined(MBEDTLS_SHA384_C)
6948
6949static void ssl_calc_finished_tls_sha384(
6950 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6951{
6952 int len = 12;
6953 const char *sender;
6954 unsigned char padbuf[48];
6955#if defined(MBEDTLS_USE_PSA_CRYPTO)
6956 size_t hash_size;
6957 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6958 psa_status_t status;
6959#else
6960 mbedtls_sha512_context sha512;
6961#endif
6962
6963 mbedtls_ssl_session *session = ssl->session_negotiate;
6964 if( !session )
6965 session = ssl->session;
6966
6967 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6968 ? "client finished"
6969 : "server finished";
6970
6971#if defined(MBEDTLS_USE_PSA_CRYPTO)
6972 sha384_psa = psa_hash_operation_init();
6973
6974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6975
6976 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6977 if( status != PSA_SUCCESS )
6978 {
6979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6980 return;
6981 }
6982
6983 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6984 if( status != PSA_SUCCESS )
6985 {
6986 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6987 return;
6988 }
6989 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6990#else
6991 mbedtls_sha512_init( &sha512 );
6992
6993 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6994
6995 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6996
6997 /*
6998 * TLSv1.2:
6999 * hash = PRF( master, finished_label,
7000 * Hash( handshake ) )[0.11]
7001 */
7002
7003#if !defined(MBEDTLS_SHA512_ALT)
7004 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
7005 sha512.state, sizeof( sha512.state ) );
7006#endif
7007 mbedtls_sha512_finish( &sha512, padbuf );
7008
7009 mbedtls_sha512_free( &sha512 );
7010#endif
7011
7012 ssl->handshake->tls_prf( session->master, 48, sender,
7013 padbuf, 48, buf, len );
7014
7015 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
7016
7017 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
7018
7019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
7020}
7021#endif /* MBEDTLS_SHA384_C */
7022
Jerry Yuaef00152022-02-17 14:27:31 +08007023void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
7024{
7025 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
7026
7027 /*
7028 * Free our handshake params
7029 */
7030 mbedtls_ssl_handshake_free( ssl );
7031 mbedtls_free( ssl->handshake );
7032 ssl->handshake = NULL;
7033
7034 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007035 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007036 */
7037 if( ssl->transform )
7038 {
7039 mbedtls_ssl_transform_free( ssl->transform );
7040 mbedtls_free( ssl->transform );
7041 }
7042 ssl->transform = ssl->transform_negotiate;
7043 ssl->transform_negotiate = NULL;
7044
7045 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
7046}
7047
Jerry Yu2a9fff52022-02-17 14:28:51 +08007048void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
7049{
7050 int resume = ssl->handshake->resume;
7051
7052 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
7053
7054#if defined(MBEDTLS_SSL_RENEGOTIATION)
7055 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
7056 {
7057 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7058 ssl->renego_records_seen = 0;
7059 }
7060#endif
7061
7062 /*
7063 * Free the previous session and switch in the current one
7064 */
7065 if( ssl->session )
7066 {
7067#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7068 /* RFC 7366 3.1: keep the EtM state */
7069 ssl->session_negotiate->encrypt_then_mac =
7070 ssl->session->encrypt_then_mac;
7071#endif
7072
7073 mbedtls_ssl_session_free( ssl->session );
7074 mbedtls_free( ssl->session );
7075 }
7076 ssl->session = ssl->session_negotiate;
7077 ssl->session_negotiate = NULL;
7078
7079 /*
7080 * Add cache entry
7081 */
7082 if( ssl->conf->f_set_cache != NULL &&
7083 ssl->session->id_len != 0 &&
7084 resume == 0 )
7085 {
7086 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
7087 ssl->session->id,
7088 ssl->session->id_len,
7089 ssl->session ) != 0 )
7090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
7091 }
7092
7093#if defined(MBEDTLS_SSL_PROTO_DTLS)
7094 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7095 ssl->handshake->flight != NULL )
7096 {
7097 /* Cancel handshake timer */
7098 mbedtls_ssl_set_timer( ssl, 0 );
7099
7100 /* Keep last flight around in case we need to resend it:
7101 * we need the handshake and transform structures for that */
7102 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
7103 }
7104 else
7105#endif
7106 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
7107
7108 ssl->state++;
7109
7110 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
7111}
7112
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007113int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
7114{
7115 int ret, hash_len;
7116
7117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
7118
7119 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
7120
7121 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
7122
7123 /*
7124 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7125 * may define some other value. Currently (early 2016), no defined
7126 * ciphersuite does this (and this is unlikely to change as activity has
7127 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7128 */
7129 hash_len = 12;
7130
7131#if defined(MBEDTLS_SSL_RENEGOTIATION)
7132 ssl->verify_data_len = hash_len;
7133 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
7134#endif
7135
7136 ssl->out_msglen = 4 + hash_len;
7137 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7138 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7139
7140 /*
7141 * In case of session resuming, invert the client and server
7142 * ChangeCipherSpec messages order.
7143 */
7144 if( ssl->handshake->resume != 0 )
7145 {
7146#if defined(MBEDTLS_SSL_CLI_C)
7147 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7148 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7149#endif
7150#if defined(MBEDTLS_SSL_SRV_C)
7151 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7152 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7153#endif
7154 }
7155 else
7156 ssl->state++;
7157
7158 /*
7159 * Switch to our negotiated transform and session parameters for outbound
7160 * data.
7161 */
7162 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
7163
7164#if defined(MBEDTLS_SSL_PROTO_DTLS)
7165 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7166 {
7167 unsigned char i;
7168
7169 /* Remember current epoch settings for resending */
7170 ssl->handshake->alt_transform_out = ssl->transform_out;
7171 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7172 sizeof( ssl->handshake->alt_out_ctr ) );
7173
7174 /* Set sequence_number to zero */
7175 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
7176
7177
7178 /* Increment epoch */
7179 for( i = 2; i > 0; i-- )
7180 if( ++ssl->cur_out_ctr[i - 1] != 0 )
7181 break;
7182
7183 /* The loop goes to its end iff the counter is wrapping */
7184 if( i == 0 )
7185 {
7186 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
7187 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
7188 }
7189 }
7190 else
7191#endif /* MBEDTLS_SSL_PROTO_DTLS */
7192 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
7193
7194 ssl->transform_out = ssl->transform_negotiate;
7195 ssl->session_out = ssl->session_negotiate;
7196
7197#if defined(MBEDTLS_SSL_PROTO_DTLS)
7198 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7199 mbedtls_ssl_send_flight_completed( ssl );
7200#endif
7201
7202 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
7203 {
7204 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
7205 return( ret );
7206 }
7207
7208#if defined(MBEDTLS_SSL_PROTO_DTLS)
7209 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7210 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
7211 {
7212 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7213 return( ret );
7214 }
7215#endif
7216
7217 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7218
7219 return( 0 );
7220}
7221
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007222#define SSL_MAX_HASH_LEN 12
7223
7224int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7225{
7226 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7227 unsigned int hash_len = 12;
7228 unsigned char buf[SSL_MAX_HASH_LEN];
7229
7230 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7231
7232 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7233
7234 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7235 {
7236 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7237 goto exit;
7238 }
7239
7240 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7241 {
7242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7243 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7244 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7245 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7246 goto exit;
7247 }
7248
7249 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7250 {
7251 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7252 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7253 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7254 goto exit;
7255 }
7256
7257 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7258 {
7259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7260 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7261 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7262 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7263 goto exit;
7264 }
7265
7266 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7267 buf, hash_len ) != 0 )
7268 {
7269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7270 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7271 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7272 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7273 goto exit;
7274 }
7275
7276#if defined(MBEDTLS_SSL_RENEGOTIATION)
7277 ssl->verify_data_len = hash_len;
7278 memcpy( ssl->peer_verify_data, buf, hash_len );
7279#endif
7280
7281 if( ssl->handshake->resume != 0 )
7282 {
7283#if defined(MBEDTLS_SSL_CLI_C)
7284 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7285 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7286#endif
7287#if defined(MBEDTLS_SSL_SRV_C)
7288 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7289 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7290#endif
7291 }
7292 else
7293 ssl->state++;
7294
7295#if defined(MBEDTLS_SSL_PROTO_DTLS)
7296 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7297 mbedtls_ssl_recv_flight_completed( ssl );
7298#endif
7299
7300 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7301
7302exit:
7303 mbedtls_platform_zeroize( buf, hash_len );
7304 return( ret );
7305}
7306
Jerry Yu392112c2022-02-17 14:34:10 +08007307#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7308/*
7309 * Helper to get TLS 1.2 PRF from ciphersuite
7310 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7311 */
7312static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7313{
7314#if defined(MBEDTLS_SHA384_C)
7315 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7316 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7317
Leonid Rozenboime9d8dcd2022-08-08 15:57:48 -07007318 if( ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
Jerry Yu392112c2022-02-17 14:34:10 +08007319 return( tls_prf_sha384 );
7320#else
7321 (void) ciphersuite_id;
7322#endif
7323 return( tls_prf_sha256 );
7324}
7325#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007326
7327static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7328{
7329 ((void) tls_prf);
7330#if defined(MBEDTLS_SHA384_C)
7331 if( tls_prf == tls_prf_sha384 )
7332 {
7333 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7334 }
7335 else
7336#endif
7337#if defined(MBEDTLS_SHA256_C)
7338 if( tls_prf == tls_prf_sha256 )
7339 {
7340 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7341 }
7342 else
7343#endif
7344 return( MBEDTLS_SSL_TLS_PRF_NONE );
7345}
7346
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007347/*
7348 * Populate a transform structure with session keys and all the other
7349 * necessary information.
7350 *
7351 * Parameters:
7352 * - [in/out]: transform: structure to populate
7353 * [in] must be just initialised with mbedtls_ssl_transform_init()
7354 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7355 * - [in] ciphersuite
7356 * - [in] master
7357 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007358 * - [in] tls_prf: pointer to PRF to use for key derivation
7359 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007360 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007361 * - [in] endpoint: client or server
7362 * - [in] ssl: used for:
7363 * - ssl->conf->{f,p}_export_keys
7364 * [in] optionally used for:
7365 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7366 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007367MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007368static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7369 int ciphersuite,
7370 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007371#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007372 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007373#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007374 ssl_tls_prf_t tls_prf,
7375 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007376 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007377 unsigned endpoint,
7378 const mbedtls_ssl_context *ssl )
7379{
7380 int ret = 0;
7381 unsigned char keyblk[256];
7382 unsigned char *key1;
7383 unsigned char *key2;
7384 unsigned char *mac_enc;
7385 unsigned char *mac_dec;
7386 size_t mac_key_len = 0;
7387 size_t iv_copy_len;
7388 size_t keylen;
7389 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007390 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007391#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007392 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007393 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007394#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007395
7396#if defined(MBEDTLS_USE_PSA_CRYPTO)
7397 psa_key_type_t key_type;
7398 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7399 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007400 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007401 size_t key_bits;
7402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7403#endif
7404
7405#if !defined(MBEDTLS_DEBUG_C) && \
7406 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7407 if( ssl->f_export_keys == NULL )
7408 {
7409 ssl = NULL; /* make sure we don't use it except for these cases */
7410 (void) ssl;
7411 }
7412#endif
7413
7414 /*
7415 * Some data just needs copying into the structure
7416 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007417#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007418 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007419#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007420 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007421
7422#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7423 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7424#endif
7425
7426#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007427 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007428 {
7429 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7430 * generation separate. This should never happen. */
7431 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7432 }
7433#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7434
7435 /*
7436 * Get various info structures
7437 */
7438 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7439 if( ciphersuite_info == NULL )
7440 {
7441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7442 ciphersuite ) );
7443 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7444 }
7445
Neil Armstrongab555e02022-04-04 11:07:59 +02007446 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007447#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007448 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007449#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007450 ciphersuite_info );
7451
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007452 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7453 transform->taglen =
7454 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7455
7456#if defined(MBEDTLS_USE_PSA_CRYPTO)
7457 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7458 transform->taglen,
7459 &alg,
7460 &key_type,
7461 &key_bits ) ) != PSA_SUCCESS )
7462 {
7463 ret = psa_ssl_status_to_mbedtls( status );
7464 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7465 goto end;
7466 }
7467#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007468 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7469 if( cipher_info == NULL )
7470 {
7471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7472 ciphersuite_info->cipher ) );
7473 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7474 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007475#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007476
Neil Armstronge4512952022-03-08 09:08:22 +01007477#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007478 mac_alg = mbedtls_hash_info_psa_from_md( ciphersuite_info->mac );
Neil Armstronge4512952022-03-08 09:08:22 +01007479 if( mac_alg == 0 )
7480 {
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_hash_info_psa_from_md for %u not found",
Neil Armstronge4512952022-03-08 09:08:22 +01007482 (unsigned) ciphersuite_info->mac ) );
7483 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7484 }
7485#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007486 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7487 if( md_info == NULL )
7488 {
7489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7490 (unsigned) ciphersuite_info->mac ) );
7491 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7492 }
Neil Armstronge4512952022-03-08 09:08:22 +01007493#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007494
7495#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7496 /* Copy own and peer's CID if the use of the CID
7497 * extension has been negotiated. */
7498 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7499 {
7500 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7501
7502 transform->in_cid_len = ssl->own_cid_len;
7503 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7504 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7505 transform->in_cid_len );
7506
7507 transform->out_cid_len = ssl->handshake->peer_cid_len;
7508 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7509 ssl->handshake->peer_cid_len );
7510 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7511 transform->out_cid_len );
7512 }
7513#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7514
7515 /*
7516 * Compute key block using the PRF
7517 */
7518 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7519 if( ret != 0 )
7520 {
7521 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7522 return( ret );
7523 }
7524
7525 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7526 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7527 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7528 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7529 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7530
7531 /*
7532 * Determine the appropriate key, IV and MAC length.
7533 */
7534
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007535#if defined(MBEDTLS_USE_PSA_CRYPTO)
7536 keylen = PSA_BITS_TO_BYTES(key_bits);
7537#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007538 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007539#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007540
7541#if defined(MBEDTLS_GCM_C) || \
7542 defined(MBEDTLS_CCM_C) || \
7543 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007544 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007545 {
7546 size_t explicit_ivlen;
7547
7548 transform->maclen = 0;
7549 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007550
7551 /* All modes haves 96-bit IVs, but the length of the static parts vary
7552 * with mode and version:
7553 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7554 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7555 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7556 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7557 * sequence number).
7558 */
7559 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007560#if defined(MBEDTLS_USE_PSA_CRYPTO)
7561 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7562#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007563 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007564#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007565 transform->fixed_ivlen = 12;
7566 else
7567 transform->fixed_ivlen = 4;
7568
7569 /* Minimum length of encrypted record */
7570 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7571 transform->minlen = explicit_ivlen + transform->taglen;
7572 }
7573 else
7574#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7575#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007576 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7577 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7578 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007579 {
Neil Armstronge4512952022-03-08 09:08:22 +01007580#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007581 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007582#else
7583 size_t block_size = cipher_info->block_size;
7584#endif /* MBEDTLS_USE_PSA_CRYPTO */
7585
7586#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007587 /* Get MAC length */
7588 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7589#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007590 /* Initialize HMAC contexts */
7591 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7592 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7593 {
7594 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7595 goto end;
7596 }
7597
7598 /* Get MAC length */
7599 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007600#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007601 transform->maclen = mac_key_len;
7602
7603 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007604#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007605 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007606#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007607 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007608#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007609
7610 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007611 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007612 transform->minlen = transform->maclen;
7613 else
7614 {
7615 /*
7616 * GenericBlockCipher:
7617 * 1. if EtM is in use: one block plus MAC
7618 * otherwise: * first multiple of blocklen greater than maclen
7619 * 2. IV
7620 */
7621#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007622 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007623 {
7624 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007625 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007626 }
7627 else
7628#endif
7629 {
7630 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007631 + block_size
7632 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007633 }
7634
Glenn Strauss07c64162022-03-14 12:34:51 -04007635 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007636 {
7637 transform->minlen += transform->ivlen;
7638 }
7639 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007640 {
7641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7642 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7643 goto end;
7644 }
7645 }
7646 }
7647 else
7648#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7649 {
7650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7651 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7652 }
7653
7654 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7655 (unsigned) keylen,
7656 (unsigned) transform->minlen,
7657 (unsigned) transform->ivlen,
7658 (unsigned) transform->maclen ) );
7659
7660 /*
7661 * Finally setup the cipher contexts, IVs and MAC secrets.
7662 */
7663#if defined(MBEDTLS_SSL_CLI_C)
7664 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7665 {
7666 key1 = keyblk + mac_key_len * 2;
7667 key2 = keyblk + mac_key_len * 2 + keylen;
7668
7669 mac_enc = keyblk;
7670 mac_dec = keyblk + mac_key_len;
7671
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007672 iv_copy_len = ( transform->fixed_ivlen ) ?
7673 transform->fixed_ivlen : transform->ivlen;
7674 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7675 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7676 iv_copy_len );
7677 }
7678 else
7679#endif /* MBEDTLS_SSL_CLI_C */
7680#if defined(MBEDTLS_SSL_SRV_C)
7681 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7682 {
7683 key1 = keyblk + mac_key_len * 2 + keylen;
7684 key2 = keyblk + mac_key_len * 2;
7685
7686 mac_enc = keyblk + mac_key_len;
7687 mac_dec = keyblk;
7688
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007689 iv_copy_len = ( transform->fixed_ivlen ) ?
7690 transform->fixed_ivlen : transform->ivlen;
7691 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7692 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7693 iv_copy_len );
7694 }
7695 else
7696#endif /* MBEDTLS_SSL_SRV_C */
7697 {
7698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7699 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7700 goto end;
7701 }
7702
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007703 if( ssl != NULL && ssl->f_export_keys != NULL )
7704 {
7705 ssl->f_export_keys( ssl->p_export_keys,
7706 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7707 master, 48,
7708 randbytes + 32,
7709 randbytes,
7710 tls_prf_get_type( tls_prf ) );
7711 }
7712
7713#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007714 transform->psa_alg = alg;
7715
7716 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7717 {
7718 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7719 psa_set_key_algorithm( &attributes, alg );
7720 psa_set_key_type( &attributes, key_type );
7721
7722 if( ( status = psa_import_key( &attributes,
7723 key1,
7724 PSA_BITS_TO_BYTES( key_bits ),
7725 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7726 {
7727 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7728 ret = psa_ssl_status_to_mbedtls( status );
7729 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7730 goto end;
7731 }
7732
7733 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7734
7735 if( ( status = psa_import_key( &attributes,
7736 key2,
7737 PSA_BITS_TO_BYTES( key_bits ),
7738 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7739 {
7740 ret = psa_ssl_status_to_mbedtls( status );
7741 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7742 goto end;
7743 }
7744 }
7745#else
7746 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7747 cipher_info ) ) != 0 )
7748 {
7749 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7750 goto end;
7751 }
7752
7753 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7754 cipher_info ) ) != 0 )
7755 {
7756 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7757 goto end;
7758 }
7759
7760 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7761 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7762 MBEDTLS_ENCRYPT ) ) != 0 )
7763 {
7764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7765 goto end;
7766 }
7767
7768 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7769 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7770 MBEDTLS_DECRYPT ) ) != 0 )
7771 {
7772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7773 goto end;
7774 }
7775
7776#if defined(MBEDTLS_CIPHER_MODE_CBC)
7777 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7778 {
7779 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7780 MBEDTLS_PADDING_NONE ) ) != 0 )
7781 {
7782 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7783 goto end;
7784 }
7785
7786 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7787 MBEDTLS_PADDING_NONE ) ) != 0 )
7788 {
7789 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7790 goto end;
7791 }
7792 }
7793#endif /* MBEDTLS_CIPHER_MODE_CBC */
7794#endif /* MBEDTLS_USE_PSA_CRYPTO */
7795
Neil Armstrong29c0c042022-03-17 17:47:28 +01007796#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7797 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7798 For AEAD-based ciphersuites, there is nothing to do here. */
7799 if( mac_key_len != 0 )
7800 {
7801#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007802 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007803
7804 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007805 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007806 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7807
7808 if( ( status = psa_import_key( &attributes,
7809 mac_enc, mac_key_len,
7810 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7811 {
7812 ret = psa_ssl_status_to_mbedtls( status );
7813 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7814 goto end;
7815 }
7816
Ronald Cronfb39f152022-03-25 14:36:28 +01007817 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7818 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7819 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007820 /* mbedtls_ct_hmac() requires the key to be exportable */
7821 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7822 PSA_KEY_USAGE_VERIFY_HASH );
7823 else
7824 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7825
7826 if( ( status = psa_import_key( &attributes,
7827 mac_dec, mac_key_len,
7828 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7829 {
7830 ret = psa_ssl_status_to_mbedtls( status );
7831 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7832 goto end;
7833 }
7834#else
7835 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7836 if( ret != 0 )
7837 goto end;
7838 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7839 if( ret != 0 )
7840 goto end;
7841#endif /* MBEDTLS_USE_PSA_CRYPTO */
7842 }
7843#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7844
7845 ((void) mac_dec);
7846 ((void) mac_enc);
7847
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007848end:
7849 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7850 return( ret );
7851}
7852
Jerry Yuee40f9d2022-02-17 14:55:16 +08007853#if defined(MBEDTLS_USE_PSA_CRYPTO)
7854int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7855 unsigned char *hash, size_t *hashlen,
7856 unsigned char *data, size_t data_len,
7857 mbedtls_md_type_t md_alg )
7858{
7859 psa_status_t status;
7860 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02007861 psa_algorithm_t hash_alg = mbedtls_hash_info_psa_from_md( md_alg );
Jerry Yuee40f9d2022-02-17 14:55:16 +08007862
7863 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7864
7865 if( ( status = psa_hash_setup( &hash_operation,
7866 hash_alg ) ) != PSA_SUCCESS )
7867 {
7868 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7869 goto exit;
7870 }
7871
7872 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7873 64 ) ) != PSA_SUCCESS )
7874 {
7875 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7876 goto exit;
7877 }
7878
7879 if( ( status = psa_hash_update( &hash_operation,
7880 data, data_len ) ) != PSA_SUCCESS )
7881 {
7882 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7883 goto exit;
7884 }
7885
7886 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7887 hashlen ) ) != PSA_SUCCESS )
7888 {
7889 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7890 goto exit;
7891 }
7892
7893exit:
7894 if( status != PSA_SUCCESS )
7895 {
7896 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7897 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7898 switch( status )
7899 {
7900 case PSA_ERROR_NOT_SUPPORTED:
7901 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7902 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7903 case PSA_ERROR_BUFFER_TOO_SMALL:
7904 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7905 case PSA_ERROR_INSUFFICIENT_MEMORY:
7906 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7907 default:
7908 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7909 }
7910 }
7911 return( 0 );
7912}
7913
7914#else
7915
7916int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7917 unsigned char *hash, size_t *hashlen,
7918 unsigned char *data, size_t data_len,
7919 mbedtls_md_type_t md_alg )
7920{
7921 int ret = 0;
7922 mbedtls_md_context_t ctx;
7923 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7924 *hashlen = mbedtls_md_get_size( md_info );
7925
7926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7927
7928 mbedtls_md_init( &ctx );
7929
7930 /*
7931 * digitally-signed struct {
7932 * opaque client_random[32];
7933 * opaque server_random[32];
7934 * ServerDHParams params;
7935 * };
7936 */
7937 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7938 {
7939 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7940 goto exit;
7941 }
7942 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7943 {
7944 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7945 goto exit;
7946 }
7947 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7948 {
7949 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7950 goto exit;
7951 }
7952 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7953 {
7954 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7955 goto exit;
7956 }
7957 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7958 {
7959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7960 goto exit;
7961 }
7962
7963exit:
7964 mbedtls_md_free( &ctx );
7965
7966 if( ret != 0 )
7967 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7968 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7969
7970 return( ret );
7971}
7972#endif /* MBEDTLS_USE_PSA_CRYPTO */
7973
Jerry Yud9d91da2022-02-17 14:57:06 +08007974#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7975
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007976/* Find the preferred hash for a given signature algorithm. */
7977unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7978 mbedtls_ssl_context *ssl,
7979 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007980{
Gabor Mezei078e8032022-04-27 21:17:56 +02007981 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007982 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007983
7984 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007985 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007986
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007987 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007988 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007989 unsigned int hash_alg_received =
7990 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7991 received_sig_algs[i] );
7992 unsigned int sig_alg_received =
7993 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7994 received_sig_algs[i] );
7995
7996 if( sig_alg == sig_alg_received )
7997 {
7998#if defined(MBEDTLS_USE_PSA_CRYPTO)
7999 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
8000 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008001 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +02008002 mbedtls_hash_info_psa_from_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008003
Neil Armstrong96eceb82022-06-30 18:05:05 +02008004 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8005 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8006 PSA_ALG_ECDSA( psa_hash_alg ),
8007 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008008 continue;
8009
Neil Armstrong96eceb82022-06-30 18:05:05 +02008010 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02008011 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
8012 PSA_ALG_RSA_PKCS1V15_SIGN(
8013 psa_hash_alg ),
8014 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008015 continue;
8016 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008017#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008018
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008019 return( hash_alg_received );
8020 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008021 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008022
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008023 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08008024}
8025
8026#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8027
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008028/* Serialization of TLS 1.2 sessions:
8029 *
8030 * struct {
8031 * uint64 start_time;
8032 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008033 * uint8 session_id_len; // at most 32
8034 * opaque session_id[32];
8035 * opaque master[48]; // fixed length in the standard
8036 * uint32 verify_result;
8037 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8038 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8039 * uint32 ticket_lifetime;
8040 * uint8 mfl_code; // up to 255 according to standard
8041 * uint8 encrypt_then_mac; // 0 or 1
8042 * } serialized_session_tls12;
8043 *
8044 */
Jerry Yu438ddd82022-07-07 06:55:50 +00008045static size_t ssl_tls12_session_save( const mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008046 unsigned char *buf,
8047 size_t buf_len )
8048{
8049 unsigned char *p = buf;
8050 size_t used = 0;
8051
8052#if defined(MBEDTLS_HAVE_TIME)
8053 uint64_t start;
8054#endif
8055#if defined(MBEDTLS_X509_CRT_PARSE_C)
8056#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8057 size_t cert_len;
8058#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8059#endif /* MBEDTLS_X509_CRT_PARSE_C */
8060
8061 /*
8062 * Time
8063 */
8064#if defined(MBEDTLS_HAVE_TIME)
8065 used += 8;
8066
8067 if( used <= buf_len )
8068 {
8069 start = (uint64_t) session->start;
8070
8071 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
8072 p += 8;
8073 }
8074#endif /* MBEDTLS_HAVE_TIME */
8075
8076 /*
8077 * Basic mandatory fields
8078 */
8079 used += 2 /* ciphersuite */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008080 + 1 /* id_len */
8081 + sizeof( session->id )
8082 + sizeof( session->master )
8083 + 4; /* verify_result */
8084
8085 if( used <= buf_len )
8086 {
8087 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
8088 p += 2;
8089
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008090 *p++ = MBEDTLS_BYTE_0( session->id_len );
8091 memcpy( p, session->id, 32 );
8092 p += 32;
8093
8094 memcpy( p, session->master, 48 );
8095 p += 48;
8096
8097 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
8098 p += 4;
8099 }
8100
8101 /*
8102 * Peer's end-entity certificate
8103 */
8104#if defined(MBEDTLS_X509_CRT_PARSE_C)
8105#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8106 if( session->peer_cert == NULL )
8107 cert_len = 0;
8108 else
8109 cert_len = session->peer_cert->raw.len;
8110
8111 used += 3 + cert_len;
8112
8113 if( used <= buf_len )
8114 {
8115 *p++ = MBEDTLS_BYTE_2( cert_len );
8116 *p++ = MBEDTLS_BYTE_1( cert_len );
8117 *p++ = MBEDTLS_BYTE_0( cert_len );
8118
8119 if( session->peer_cert != NULL )
8120 {
8121 memcpy( p, session->peer_cert->raw.p, cert_len );
8122 p += cert_len;
8123 }
8124 }
8125#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8126 if( session->peer_cert_digest != NULL )
8127 {
8128 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
8129 if( used <= buf_len )
8130 {
8131 *p++ = (unsigned char) session->peer_cert_digest_type;
8132 *p++ = (unsigned char) session->peer_cert_digest_len;
8133 memcpy( p, session->peer_cert_digest,
8134 session->peer_cert_digest_len );
8135 p += session->peer_cert_digest_len;
8136 }
8137 }
8138 else
8139 {
8140 used += 2;
8141 if( used <= buf_len )
8142 {
8143 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8144 *p++ = 0;
8145 }
8146 }
8147#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8148#endif /* MBEDTLS_X509_CRT_PARSE_C */
8149
8150 /*
8151 * Session ticket if any, plus associated data
8152 */
8153#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8154 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8155
8156 if( used <= buf_len )
8157 {
8158 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
8159 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
8160 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
8161
8162 if( session->ticket != NULL )
8163 {
8164 memcpy( p, session->ticket, session->ticket_len );
8165 p += session->ticket_len;
8166 }
8167
8168 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
8169 p += 4;
8170 }
8171#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8172
8173 /*
8174 * Misc extension-related info
8175 */
8176#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8177 used += 1;
8178
8179 if( used <= buf_len )
8180 *p++ = session->mfl_code;
8181#endif
8182
8183#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8184 used += 1;
8185
8186 if( used <= buf_len )
8187 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
8188#endif
8189
8190 return( used );
8191}
8192
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008193MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu438ddd82022-07-07 06:55:50 +00008194static int ssl_tls12_session_load( mbedtls_ssl_session *session,
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008195 const unsigned char *buf,
8196 size_t len )
8197{
8198#if defined(MBEDTLS_HAVE_TIME)
8199 uint64_t start;
8200#endif
8201#if defined(MBEDTLS_X509_CRT_PARSE_C)
8202#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8203 size_t cert_len;
8204#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8205#endif /* MBEDTLS_X509_CRT_PARSE_C */
8206
8207 const unsigned char *p = buf;
8208 const unsigned char * const end = buf + len;
8209
8210 /*
8211 * Time
8212 */
8213#if defined(MBEDTLS_HAVE_TIME)
8214 if( 8 > (size_t)( end - p ) )
8215 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8216
8217 start = ( (uint64_t) p[0] << 56 ) |
8218 ( (uint64_t) p[1] << 48 ) |
8219 ( (uint64_t) p[2] << 40 ) |
8220 ( (uint64_t) p[3] << 32 ) |
8221 ( (uint64_t) p[4] << 24 ) |
8222 ( (uint64_t) p[5] << 16 ) |
8223 ( (uint64_t) p[6] << 8 ) |
8224 ( (uint64_t) p[7] );
8225 p += 8;
8226
8227 session->start = (time_t) start;
8228#endif /* MBEDTLS_HAVE_TIME */
8229
8230 /*
8231 * Basic mandatory fields
8232 */
Thomas Daubney20f89a92022-06-20 15:12:19 +01008233 if( 2 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008234 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8235
8236 session->ciphersuite = ( p[0] << 8 ) | p[1];
8237 p += 2;
8238
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008239 session->id_len = *p++;
8240 memcpy( session->id, p, 32 );
8241 p += 32;
8242
8243 memcpy( session->master, p, 48 );
8244 p += 48;
8245
8246 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8247 ( (uint32_t) p[1] << 16 ) |
8248 ( (uint32_t) p[2] << 8 ) |
8249 ( (uint32_t) p[3] );
8250 p += 4;
8251
8252 /* Immediately clear invalid pointer values that have been read, in case
8253 * we exit early before we replaced them with valid ones. */
8254#if defined(MBEDTLS_X509_CRT_PARSE_C)
8255#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8256 session->peer_cert = NULL;
8257#else
8258 session->peer_cert_digest = NULL;
8259#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8260#endif /* MBEDTLS_X509_CRT_PARSE_C */
8261#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8262 session->ticket = NULL;
8263#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8264
8265 /*
8266 * Peer certificate
8267 */
8268#if defined(MBEDTLS_X509_CRT_PARSE_C)
8269#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8270 /* Deserialize CRT from the end of the ticket. */
8271 if( 3 > (size_t)( end - p ) )
8272 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8273
8274 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8275 p += 3;
8276
8277 if( cert_len != 0 )
8278 {
8279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8280
8281 if( cert_len > (size_t)( end - p ) )
8282 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8283
8284 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8285
8286 if( session->peer_cert == NULL )
8287 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8288
8289 mbedtls_x509_crt_init( session->peer_cert );
8290
8291 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8292 p, cert_len ) ) != 0 )
8293 {
8294 mbedtls_x509_crt_free( session->peer_cert );
8295 mbedtls_free( session->peer_cert );
8296 session->peer_cert = NULL;
8297 return( ret );
8298 }
8299
8300 p += cert_len;
8301 }
8302#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8303 /* Deserialize CRT digest from the end of the ticket. */
8304 if( 2 > (size_t)( end - p ) )
8305 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8306
8307 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8308 session->peer_cert_digest_len = (size_t) *p++;
8309
8310 if( session->peer_cert_digest_len != 0 )
8311 {
8312 const mbedtls_md_info_t *md_info =
8313 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8314 if( md_info == NULL )
8315 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8316 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8317 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8318
8319 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8320 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8321
8322 session->peer_cert_digest =
8323 mbedtls_calloc( 1, session->peer_cert_digest_len );
8324 if( session->peer_cert_digest == NULL )
8325 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8326
8327 memcpy( session->peer_cert_digest, p,
8328 session->peer_cert_digest_len );
8329 p += session->peer_cert_digest_len;
8330 }
8331#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8332#endif /* MBEDTLS_X509_CRT_PARSE_C */
8333
8334 /*
8335 * Session ticket and associated data
8336 */
8337#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8338 if( 3 > (size_t)( end - p ) )
8339 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8340
8341 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8342 p += 3;
8343
8344 if( session->ticket_len != 0 )
8345 {
8346 if( session->ticket_len > (size_t)( end - p ) )
8347 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8348
8349 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8350 if( session->ticket == NULL )
8351 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8352
8353 memcpy( session->ticket, p, session->ticket_len );
8354 p += session->ticket_len;
8355 }
8356
8357 if( 4 > (size_t)( end - p ) )
8358 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8359
8360 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8361 ( (uint32_t) p[1] << 16 ) |
8362 ( (uint32_t) p[2] << 8 ) |
8363 ( (uint32_t) p[3] );
8364 p += 4;
8365#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8366
8367 /*
8368 * Misc extension-related info
8369 */
8370#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8371 if( 1 > (size_t)( end - p ) )
8372 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8373
8374 session->mfl_code = *p++;
8375#endif
8376
8377#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8378 if( 1 > (size_t)( end - p ) )
8379 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8380
8381 session->encrypt_then_mac = *p++;
8382#endif
8383
8384 /* Done, should have consumed entire buffer */
8385 if( p != end )
8386 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8387
8388 return( 0 );
8389}
Jerry Yudc7bd172022-02-17 13:44:15 +08008390#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8391
XiaokangQian75d40ef2022-04-20 11:05:24 +00008392int mbedtls_ssl_validate_ciphersuite(
8393 const mbedtls_ssl_context *ssl,
8394 const mbedtls_ssl_ciphersuite_t *suite_info,
8395 mbedtls_ssl_protocol_version min_tls_version,
8396 mbedtls_ssl_protocol_version max_tls_version )
8397{
8398 (void) ssl;
8399
8400 if( suite_info == NULL )
8401 return( -1 );
8402
8403 if( ( suite_info->min_tls_version > max_tls_version ) ||
8404 ( suite_info->max_tls_version < min_tls_version ) )
8405 {
8406 return( -1 );
8407 }
8408
XiaokangQian060d8672022-04-21 09:24:56 +00008409#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008410#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8411 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8412 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8413 {
8414 return( -1 );
8415 }
8416#endif
8417
8418 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8419#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8420 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8421 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8422 {
8423 return( -1 );
8424 }
8425#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8426#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8427
8428 return( 0 );
8429}
8430
XiaokangQianeaf36512022-04-24 09:07:44 +00008431#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8432/*
8433 * Function for writing a signature algorithm extension.
8434 *
8435 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8436 * value (TLS 1.3 RFC8446):
8437 * enum {
8438 * ....
8439 * ecdsa_secp256r1_sha256( 0x0403 ),
8440 * ecdsa_secp384r1_sha384( 0x0503 ),
8441 * ecdsa_secp521r1_sha512( 0x0603 ),
8442 * ....
8443 * } SignatureScheme;
8444 *
8445 * struct {
8446 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8447 * } SignatureSchemeList;
8448 *
8449 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8450 * value (TLS 1.2 RFC5246):
8451 * enum {
8452 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8453 * sha512(6), (255)
8454 * } HashAlgorithm;
8455 *
8456 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8457 * SignatureAlgorithm;
8458 *
8459 * struct {
8460 * HashAlgorithm hash;
8461 * SignatureAlgorithm signature;
8462 * } SignatureAndHashAlgorithm;
8463 *
8464 * SignatureAndHashAlgorithm
8465 * supported_signature_algorithms<2..2^16-2>;
8466 *
8467 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8468 * generalization of the TLS 1.2 signature algorithm extension.
8469 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8470 * `SignatureScheme` field of TLS 1.3
8471 *
8472 */
8473int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8474 const unsigned char *end, size_t *out_len )
8475{
8476 unsigned char *p = buf;
8477 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8478 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8479
8480 *out_len = 0;
8481
8482 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8483
8484 /* Check if we have space for header and length field:
8485 * - extension_type (2 bytes)
8486 * - extension_data_length (2 bytes)
8487 * - supported_signature_algorithms_length (2 bytes)
8488 */
8489 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8490 p += 6;
8491
8492 /*
8493 * Write supported_signature_algorithms
8494 */
8495 supported_sig_alg = p;
8496 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8497 if( sig_alg == NULL )
8498 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8499
8500 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8501 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008502 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8503 *sig_alg,
8504 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008505 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8506 continue;
8507 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8508 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8509 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008511 *sig_alg,
8512 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008513 }
8514
8515 /* Length of supported_signature_algorithms */
8516 supported_sig_alg_len = p - supported_sig_alg;
8517 if( supported_sig_alg_len == 0 )
8518 {
8519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8520 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8521 }
8522
XiaokangQianeaf36512022-04-24 09:07:44 +00008523 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008524 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008525 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8526
XiaokangQianeaf36512022-04-24 09:07:44 +00008527 *out_len = p - buf;
8528
8529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8530 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8531#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8532 return( 0 );
8533}
8534#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8535
XiaokangQian40a35232022-05-07 09:02:40 +00008536#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008537/*
8538 * mbedtls_ssl_parse_server_name_ext
8539 *
8540 * Structure of server_name extension:
8541 *
8542 * enum {
8543 * host_name(0), (255)
8544 * } NameType;
8545 * opaque HostName<1..2^16-1>;
8546 *
8547 * struct {
8548 * NameType name_type;
8549 * select (name_type) {
8550 * case host_name: HostName;
8551 * } name;
8552 * } ServerName;
8553 * struct {
8554 * ServerName server_name_list<1..2^16-1>
8555 * } ServerNameList;
8556 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008557MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008558int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8559 const unsigned char *buf,
8560 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008561{
8562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8563 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008564 size_t server_name_list_len, hostname_len;
8565 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008566
XiaokangQianf2a94202022-05-20 06:44:24 +00008567 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008568
8569 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008570 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008571 p += 2;
8572
XiaokangQian9b2b7712022-05-17 02:57:00 +00008573 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8574 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008575 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008576 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008577 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008578 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008579 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8580 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008581
8582 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8583 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008584 /* sni_name is intended to be used only during the parsing of the
8585 * ClientHello message (it is reset to NULL before the end of
8586 * the message parsing). Thus it is ok to just point to the
8587 * reception buffer and not make a copy of it.
8588 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008589 ssl->handshake->sni_name = p + 3;
8590 ssl->handshake->sni_name_len = hostname_len;
8591 if( ssl->conf->f_sni == NULL )
8592 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008593 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008594 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008595 if( ret != 0 )
8596 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008597 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008598 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8599 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008600 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8601 }
8602 return( 0 );
8603 }
8604
8605 p += hostname_len + 3;
8606 }
8607
8608 return( 0 );
8609}
8610#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8611
XiaokangQianacb39922022-06-17 10:18:48 +00008612#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008613MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008614int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8615 const unsigned char *buf,
8616 const unsigned char *end )
8617{
8618 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008619 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008620 const unsigned char *protocol_name_list;
8621 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008622 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008623
8624 /* If ALPN not configured, just ignore the extension */
8625 if( ssl->conf->alpn_list == NULL )
8626 return( 0 );
8627
8628 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008629 * RFC7301, section 3.1
8630 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008631 *
XiaokangQianc7403452022-06-23 03:24:12 +00008632 * struct {
8633 * ProtocolName protocol_name_list<2..2^16-1>
8634 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008635 */
8636
XiaokangQianc7403452022-06-23 03:24:12 +00008637 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008638 * protocol_name_list_len 2 bytes
8639 * protocol_name_len 1 bytes
8640 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008641 */
XiaokangQianacb39922022-06-17 10:18:48 +00008642 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8643
XiaokangQianc7403452022-06-23 03:24:12 +00008644 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008645 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008646 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008647 protocol_name_list = p;
8648 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008649
8650 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008651 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008652 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008653 protocol_name_len = *p++;
8654 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8655 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008656 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008657 {
8658 MBEDTLS_SSL_PEND_FATAL_ALERT(
8659 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8660 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008661 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008662 }
8663
8664 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008665 }
8666
8667 /* Use our order of preference */
8668 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8669 {
8670 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008671 p = protocol_name_list;
8672 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008673 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008674 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008675 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008676 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008677 {
8678 ssl->alpn_chosen = *alpn;
8679 return( 0 );
8680 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008681
8682 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008683 }
8684 }
8685
XiaokangQian95d5f542022-06-24 02:29:26 +00008686 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008687 MBEDTLS_SSL_PEND_FATAL_ALERT(
8688 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8689 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8690 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8691}
8692
8693int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8694 unsigned char *buf,
8695 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008696 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008697{
8698 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008699 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008700 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008701
8702 if( ssl->alpn_chosen == NULL )
8703 {
8704 return( 0 );
8705 }
8706
XiaokangQian95d5f542022-06-24 02:29:26 +00008707 protocol_name_len = strlen( ssl->alpn_chosen );
8708 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008709
8710 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8711 /*
8712 * 0 . 1 ext identifier
8713 * 2 . 3 ext length
8714 * 4 . 5 protocol list length
8715 * 6 . 6 protocol name length
8716 * 7 . 7+n protocol name
8717 */
8718 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8719
XiaokangQian95d5f542022-06-24 02:29:26 +00008720 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008721
XiaokangQian95d5f542022-06-24 02:29:26 +00008722 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8723 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008724 /* Note: the length of the chosen protocol has been checked to be less
8725 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8726 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008727 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008728
XiaokangQian95d5f542022-06-24 02:29:26 +00008729 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008730 return ( 0 );
8731}
8732#endif /* MBEDTLS_SSL_ALPN */
8733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008734#endif /* MBEDTLS_SSL_TLS_C */