blob: 887daf83e56461db1a7c9f4a12141a5fd50b0eb6 [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
443static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
444 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 Yued14c932022-02-17 13:40:45 +0800448static int ssl_session_load_tls12( mbedtls_ssl_session *session,
449 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)
1896static size_t ssl_session_save_tls13( const mbedtls_ssl_session *session,
1897 unsigned char *buf,
1898 size_t buf_len )
1899{
1900 ((void) session);
1901 ((void) buf);
1902 ((void) buf_len);
1903 return( 0 );
1904}
1905#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1906
Przemyslaw Stekielf57b4562022-01-25 00:04:18 +01001907psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001908 size_t taglen,
1909 psa_algorithm_t *alg,
1910 psa_key_type_t *key_type,
1911 size_t *key_size )
1912{
1913 switch ( mbedtls_cipher_type )
1914 {
1915 case MBEDTLS_CIPHER_AES_128_CBC:
1916 *alg = PSA_ALG_CBC_NO_PADDING;
1917 *key_type = PSA_KEY_TYPE_AES;
1918 *key_size = 128;
1919 break;
1920 case MBEDTLS_CIPHER_AES_128_CCM:
1921 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1922 *key_type = PSA_KEY_TYPE_AES;
1923 *key_size = 128;
1924 break;
1925 case MBEDTLS_CIPHER_AES_128_GCM:
1926 *alg = PSA_ALG_GCM;
1927 *key_type = PSA_KEY_TYPE_AES;
1928 *key_size = 128;
1929 break;
1930 case MBEDTLS_CIPHER_AES_192_CCM:
1931 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1932 *key_type = PSA_KEY_TYPE_AES;
1933 *key_size = 192;
1934 break;
1935 case MBEDTLS_CIPHER_AES_192_GCM:
1936 *alg = PSA_ALG_GCM;
1937 *key_type = PSA_KEY_TYPE_AES;
1938 *key_size = 192;
1939 break;
1940 case MBEDTLS_CIPHER_AES_256_CBC:
1941 *alg = PSA_ALG_CBC_NO_PADDING;
1942 *key_type = PSA_KEY_TYPE_AES;
1943 *key_size = 256;
1944 break;
1945 case MBEDTLS_CIPHER_AES_256_CCM:
1946 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1947 *key_type = PSA_KEY_TYPE_AES;
1948 *key_size = 256;
1949 break;
1950 case MBEDTLS_CIPHER_AES_256_GCM:
1951 *alg = PSA_ALG_GCM;
1952 *key_type = PSA_KEY_TYPE_AES;
1953 *key_size = 256;
1954 break;
1955 case MBEDTLS_CIPHER_ARIA_128_CBC:
1956 *alg = PSA_ALG_CBC_NO_PADDING;
1957 *key_type = PSA_KEY_TYPE_ARIA;
1958 *key_size = 128;
1959 break;
1960 case MBEDTLS_CIPHER_ARIA_128_CCM:
1961 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1962 *key_type = PSA_KEY_TYPE_ARIA;
1963 *key_size = 128;
1964 break;
1965 case MBEDTLS_CIPHER_ARIA_128_GCM:
1966 *alg = PSA_ALG_GCM;
1967 *key_type = PSA_KEY_TYPE_ARIA;
1968 *key_size = 128;
1969 break;
1970 case MBEDTLS_CIPHER_ARIA_192_CCM:
1971 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1972 *key_type = PSA_KEY_TYPE_ARIA;
1973 *key_size = 192;
1974 break;
1975 case MBEDTLS_CIPHER_ARIA_192_GCM:
1976 *alg = PSA_ALG_GCM;
1977 *key_type = PSA_KEY_TYPE_ARIA;
1978 *key_size = 192;
1979 break;
1980 case MBEDTLS_CIPHER_ARIA_256_CBC:
1981 *alg = PSA_ALG_CBC_NO_PADDING;
1982 *key_type = PSA_KEY_TYPE_ARIA;
1983 *key_size = 256;
1984 break;
1985 case MBEDTLS_CIPHER_ARIA_256_CCM:
1986 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
1987 *key_type = PSA_KEY_TYPE_ARIA;
1988 *key_size = 256;
1989 break;
1990 case MBEDTLS_CIPHER_ARIA_256_GCM:
1991 *alg = PSA_ALG_GCM;
1992 *key_type = PSA_KEY_TYPE_ARIA;
1993 *key_size = 256;
1994 break;
1995 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
1996 *alg = PSA_ALG_CBC_NO_PADDING;
1997 *key_type = PSA_KEY_TYPE_CAMELLIA;
1998 *key_size = 128;
1999 break;
2000 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
2001 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2002 *key_type = PSA_KEY_TYPE_CAMELLIA;
2003 *key_size = 128;
2004 break;
2005 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2006 *alg = PSA_ALG_GCM;
2007 *key_type = PSA_KEY_TYPE_CAMELLIA;
2008 *key_size = 128;
2009 break;
2010 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
2011 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2012 *key_type = PSA_KEY_TYPE_CAMELLIA;
2013 *key_size = 192;
2014 break;
2015 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2016 *alg = PSA_ALG_GCM;
2017 *key_type = PSA_KEY_TYPE_CAMELLIA;
2018 *key_size = 192;
2019 break;
2020 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2021 *alg = PSA_ALG_CBC_NO_PADDING;
2022 *key_type = PSA_KEY_TYPE_CAMELLIA;
2023 *key_size = 256;
2024 break;
2025 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
2026 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, taglen ) : PSA_ALG_CCM;
2027 *key_type = PSA_KEY_TYPE_CAMELLIA;
2028 *key_size = 256;
2029 break;
2030 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2031 *alg = PSA_ALG_GCM;
2032 *key_type = PSA_KEY_TYPE_CAMELLIA;
2033 *key_size = 256;
2034 break;
2035 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2036 *alg = PSA_ALG_CHACHA20_POLY1305;
2037 *key_type = PSA_KEY_TYPE_CHACHA20;
2038 *key_size = 256;
2039 break;
2040 case MBEDTLS_CIPHER_NULL:
2041 *alg = MBEDTLS_SSL_NULL_CIPHER;
2042 *key_type = 0;
2043 *key_size = 0;
2044 break;
2045 default:
2046 return PSA_ERROR_NOT_SUPPORTED;
2047 }
2048
2049 return PSA_SUCCESS;
2050}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002051#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002052
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002053#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002054int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2055 const unsigned char *dhm_P, size_t P_len,
2056 const unsigned char *dhm_G, size_t G_len )
2057{
Janos Follath865b3eb2019-12-16 11:46:15 +00002058 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002059
Glenn Strausscee11292021-12-20 01:43:17 -05002060 mbedtls_mpi_free( &conf->dhm_P );
2061 mbedtls_mpi_free( &conf->dhm_G );
2062
Hanno Beckera90658f2017-10-04 15:29:08 +01002063 if( ( ret = mbedtls_mpi_read_binary( &conf->dhm_P, dhm_P, P_len ) ) != 0 ||
2064 ( ret = mbedtls_mpi_read_binary( &conf->dhm_G, dhm_G, G_len ) ) != 0 )
2065 {
2066 mbedtls_mpi_free( &conf->dhm_P );
2067 mbedtls_mpi_free( &conf->dhm_G );
2068 return( ret );
2069 }
2070
2071 return( 0 );
2072}
Paul Bakker5121ce52009-01-03 21:22:43 +00002073
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002074int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx )
Paul Bakker1b57b062011-01-06 15:48:19 +00002075{
Janos Follath865b3eb2019-12-16 11:46:15 +00002076 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002077
Glenn Strausscee11292021-12-20 01:43:17 -05002078 mbedtls_mpi_free( &conf->dhm_P );
2079 mbedtls_mpi_free( &conf->dhm_G );
2080
Gilles Peskinee5702482021-06-11 21:59:08 +02002081 if( ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_P,
2082 &conf->dhm_P ) ) != 0 ||
2083 ( ret = mbedtls_dhm_get_value( dhm_ctx, MBEDTLS_DHM_PARAM_G,
2084 &conf->dhm_G ) ) != 0 )
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002085 {
2086 mbedtls_mpi_free( &conf->dhm_P );
2087 mbedtls_mpi_free( &conf->dhm_G );
Paul Bakker1b57b062011-01-06 15:48:19 +00002088 return( ret );
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002089 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002090
2091 return( 0 );
2092}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002093#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002094
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002095#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2096/*
2097 * Set the minimum length for Diffie-Hellman parameters
2098 */
2099void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2100 unsigned int bitlen )
2101{
2102 conf->dhm_min_bitlen = bitlen;
2103}
2104#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2105
Gilles Peskineeccd8882020-03-10 12:19:08 +01002106#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002107#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002108/*
2109 * Set allowed/preferred hashes for handshake signatures
2110 */
2111void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2112 const int *hashes )
2113{
2114 conf->sig_hashes = hashes;
2115}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002116#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002117
Jerry Yuf017ee42022-01-12 15:49:48 +08002118/* Configure allowed signature algorithms for handshake */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002119void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
2120 const uint16_t* sig_algs )
2121{
Jerry Yuf017ee42022-01-12 15:49:48 +08002122#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2123 conf->sig_hashes = NULL;
2124#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2125 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002126}
Gilles Peskineeccd8882020-03-10 12:19:08 +01002127#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002128
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002129#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002130#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002131/*
2132 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002133 *
2134 * mbedtls_ssl_setup() takes the provided list
2135 * and translates it to a list of IANA TLS group identifiers,
2136 * stored in ssl->handshake->group_list.
2137 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002138 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002139void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002140 const mbedtls_ecp_group_id *curve_list )
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002141{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002142 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002143 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002144}
Brett Warrene0edc842021-08-17 09:53:13 +01002145#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker947194e2017-04-07 13:25:49 +01002146#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002147
Brett Warrene0edc842021-08-17 09:53:13 +01002148/*
2149 * Set the allowed groups
2150 */
2151void mbedtls_ssl_conf_groups( mbedtls_ssl_config *conf,
2152 const uint16_t *group_list )
2153{
2154#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
2155 conf->curve_list = NULL;
2156#endif
2157 conf->group_list = group_list;
2158}
2159
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002160#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname )
Paul Bakker5121ce52009-01-03 21:22:43 +00002162{
Hanno Becker947194e2017-04-07 13:25:49 +01002163 /* Initialize to suppress unnecessary compiler warning */
2164 size_t hostname_len = 0;
2165
2166 /* Check if new hostname is valid before
2167 * making any change to current one */
Hanno Becker947194e2017-04-07 13:25:49 +01002168 if( hostname != NULL )
2169 {
2170 hostname_len = strlen( hostname );
2171
2172 if( hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN )
2173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2174 }
2175
2176 /* Now it's clear that we will overwrite the old hostname,
2177 * so we can free it safely */
2178
2179 if( ssl->hostname != NULL )
2180 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05002181 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Hanno Becker947194e2017-04-07 13:25:49 +01002182 mbedtls_free( ssl->hostname );
2183 }
2184
2185 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002186
Paul Bakker5121ce52009-01-03 21:22:43 +00002187 if( hostname == NULL )
Hanno Becker947194e2017-04-07 13:25:49 +01002188 {
2189 ssl->hostname = NULL;
2190 }
2191 else
2192 {
2193 ssl->hostname = mbedtls_calloc( 1, hostname_len + 1 );
Hanno Becker947194e2017-04-07 13:25:49 +01002194 if( ssl->hostname == NULL )
2195 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002196
Hanno Becker947194e2017-04-07 13:25:49 +01002197 memcpy( ssl->hostname, hostname, hostname_len );
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002198
Hanno Becker947194e2017-04-07 13:25:49 +01002199 ssl->hostname[hostname_len] = '\0';
2200 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002201
2202 return( 0 );
2203}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002204#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002205
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002206#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002207void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 int (*f_sni)(void *, mbedtls_ssl_context *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002209 const unsigned char *, size_t),
2210 void *p_sni )
2211{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002212 conf->f_sni = f_sni;
2213 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002214}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002218int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002219{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002220 size_t cur_len, tot_len;
2221 const char **p;
2222
2223 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002224 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2225 * MUST NOT be truncated."
2226 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002227 */
2228 tot_len = 0;
2229 for( p = protos; *p != NULL; p++ )
2230 {
2231 cur_len = strlen( *p );
2232 tot_len += cur_len;
2233
Ronald Cron8216dd32020-04-23 16:41:44 +02002234 if( ( cur_len == 0 ) ||
2235 ( cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN ) ||
2236 ( tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN ) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002238 }
2239
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002240 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002241
2242 return( 0 );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002243}
2244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002246{
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002247 return( ssl->alpn_chosen );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002248}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002250
Johan Pascalb62bb512015-12-03 21:56:45 +01002251#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldoref72faf2018-07-12 11:54:20 +03002252void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
2253 int support_mki_value )
Ron Eldor591f1622018-01-22 12:30:04 +02002254{
2255 conf->dtls_srtp_mki_support = support_mki_value;
2256}
2257
Ron Eldoref72faf2018-07-12 11:54:20 +03002258int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
2259 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02002260 uint16_t mki_len )
Ron Eldor591f1622018-01-22 12:30:04 +02002261{
Johan Pascal5ef72d22020-10-28 17:05:47 +01002262 if( mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH )
Ron Eldora9788042018-12-05 11:04:31 +02002263 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002264 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Ron Eldora9788042018-12-05 11:04:31 +02002265 }
Ron Eldor591f1622018-01-22 12:30:04 +02002266
2267 if( ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED )
Ron Eldora9788042018-12-05 11:04:31 +02002268 {
Johan Pascald576fdb2020-09-22 10:39:53 +02002269 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Ron Eldora9788042018-12-05 11:04:31 +02002270 }
Ron Eldor591f1622018-01-22 12:30:04 +02002271
2272 memcpy( ssl->dtls_srtp_info.mki_value, mki_value, mki_len );
2273 ssl->dtls_srtp_info.mki_len = mki_len;
Ron Eldora9788042018-12-05 11:04:31 +02002274 return( 0 );
Ron Eldor591f1622018-01-22 12:30:04 +02002275}
2276
Ron Eldoref72faf2018-07-12 11:54:20 +03002277int mbedtls_ssl_conf_dtls_srtp_protection_profiles( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02002278 const mbedtls_ssl_srtp_profile *profiles )
Johan Pascalb62bb512015-12-03 21:56:45 +01002279{
Johan Pascal253d0262020-09-22 13:04:45 +02002280 const mbedtls_ssl_srtp_profile *p;
2281 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002282
Johan Pascal253d0262020-09-22 13:04:45 +02002283 /* check the profiles list: all entry must be valid,
2284 * its size cannot be more than the total number of supported profiles, currently 4 */
Johan Pascald387aa02020-09-23 18:47:56 +02002285 for( p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2286 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2287 p++ )
Johan Pascald576fdb2020-09-22 10:39:53 +02002288 {
Johan Pascal5ef72d22020-10-28 17:05:47 +01002289 if( mbedtls_ssl_check_srtp_profile_value( *p ) != MBEDTLS_TLS_SRTP_UNSET )
Johan Pascald576fdb2020-09-22 10:39:53 +02002290 {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002291 list_size++;
2292 }
2293 else
2294 {
2295 /* unsupported value, stop parsing and set the size to an error value */
2296 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002297 }
2298 }
2299
Johan Pascal5ef72d22020-10-28 17:05:47 +01002300 if( list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH )
Johan Pascald387aa02020-09-23 18:47:56 +02002301 {
Johan Pascal253d0262020-09-22 13:04:45 +02002302 conf->dtls_srtp_profile_list = NULL;
2303 conf->dtls_srtp_profile_list_len = 0;
2304 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2305 }
2306
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002307 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002308 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002309
2310 return( 0 );
2311}
2312
Johan Pascal5ef72d22020-10-28 17:05:47 +01002313void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
2314 mbedtls_dtls_srtp_info *dtls_srtp_info )
Johan Pascalb62bb512015-12-03 21:56:45 +01002315{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002316 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2317 /* do not copy the mki value if there is no chosen profile */
Johan Pascal5ef72d22020-10-28 17:05:47 +01002318 if( dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET )
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002319 {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002320 dtls_srtp_info->mki_len = 0;
Johan Pascal0dbcd1d2020-10-28 11:03:07 +01002321 }
Johan Pascal2258a4f2020-10-28 13:53:09 +01002322 else
2323 {
2324 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Johan Pascal5ef72d22020-10-28 17:05:47 +01002325 memcpy( dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2326 ssl->dtls_srtp_info.mki_len );
Johan Pascal2258a4f2020-10-28 13:53:09 +01002327 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002328}
Johan Pascalb62bb512015-12-03 21:56:45 +01002329#endif /* MBEDTLS_SSL_DTLS_SRTP */
2330
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002331void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker490ecc82011-10-06 13:04:09 +00002332{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002333 conf->max_tls_version = (major << 8) | minor;
Paul Bakker490ecc82011-10-06 13:04:09 +00002334}
2335
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002336void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor )
Paul Bakker1d29fb52012-09-28 13:28:45 +00002337{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04002338 conf->min_tls_version = (major << 8) | minor;
Paul Bakker1d29fb52012-09-28 13:28:45 +00002339}
2340
Janos Follath088ce432017-04-10 12:42:31 +01002341#if defined(MBEDTLS_SSL_SRV_C)
2342void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2343 char cert_req_ca_list )
2344{
2345 conf->cert_req_ca_list = cert_req_ca_list;
2346}
2347#endif
2348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002350void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm )
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002351{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002352 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002353}
2354#endif
2355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002357void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems )
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002358{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002359 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002360}
2361#endif
2362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002364int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002365{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366 if( mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
Angus Grattond8213d02016-05-25 20:56:48 +10002367 ssl_mfl_code_to_length( mfl_code ) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN )
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002368 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002370 }
2371
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002372 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002373
2374 return( 0 );
2375}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002377
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002378void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy )
Paul Bakker48916f92012-09-16 19:57:18 +00002379{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002380 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002381}
2382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002384void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation )
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002385{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002386 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002387}
2388
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002389void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002390{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002391 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002392}
2393
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002394void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002395 const unsigned char period[8] )
2396{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002397 memcpy( conf->renego_period, period, 8 );
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002398}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002402#if defined(MBEDTLS_SSL_CLI_C)
2403void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets )
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002404{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002405 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002406}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002407#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002408
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002409#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002410void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2411 mbedtls_ssl_ticket_write_t *f_ticket_write,
2412 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2413 void *p_ticket )
Paul Bakker606b4ba2013-08-14 16:52:14 +02002414{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002415 conf->f_ticket_write = f_ticket_write;
2416 conf->f_ticket_parse = f_ticket_parse;
2417 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002418}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002419#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002421
Hanno Becker7e6c1782021-06-08 09:24:55 +01002422void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2423 mbedtls_ssl_export_keys_t *f_export_keys,
2424 void *p_export_keys )
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002425{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002426 ssl->f_export_keys = f_export_keys;
2427 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002428}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002429
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002430#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002431void mbedtls_ssl_conf_async_private_cb(
2432 mbedtls_ssl_config *conf,
2433 mbedtls_ssl_async_sign_t *f_async_sign,
2434 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2435 mbedtls_ssl_async_resume_t *f_async_resume,
2436 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002437 void *async_config_data )
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002438{
2439 conf->f_async_sign_start = f_async_sign;
2440 conf->f_async_decrypt_start = f_async_decrypt;
2441 conf->f_async_resume = f_async_resume;
2442 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002443 conf->p_async_config_data = async_config_data;
2444}
2445
Gilles Peskine8f97af72018-04-26 11:46:10 +02002446void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf )
2447{
2448 return( conf->p_async_config_data );
2449}
2450
Gilles Peskine1febfef2018-04-30 11:54:39 +02002451void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl )
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002452{
2453 if( ssl->handshake == NULL )
2454 return( NULL );
2455 else
2456 return( ssl->handshake->user_async_ctx );
2457}
2458
Gilles Peskine1febfef2018-04-30 11:54:39 +02002459void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002460 void *ctx )
2461{
2462 if( ssl->handshake != NULL )
2463 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002464}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002465#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002466
Paul Bakker5121ce52009-01-03 21:22:43 +00002467/*
2468 * SSL get accessors
2469 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002470uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002471{
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002472 if( ssl->session != NULL )
2473 return( ssl->session->verify_result );
2474
2475 if( ssl->session_negotiate != NULL )
2476 return( ssl->session_negotiate->verify_result );
2477
Manuel Pégourié-Gonnard6ab9b002015-05-14 11:25:04 +02002478 return( 0xFFFFFFFF );
Paul Bakker5121ce52009-01-03 21:22:43 +00002479}
2480
Glenn Strauss8f526902022-01-13 00:04:49 -05002481int mbedtls_ssl_get_ciphersuite_id_from_ssl( const mbedtls_ssl_context *ssl )
2482{
2483 if( ssl == NULL || ssl->session == NULL )
2484 return( 0 );
2485
2486 return( ssl->session->ciphersuite );
2487}
2488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl )
Paul Bakker72f62662011-01-16 21:27:44 +00002490{
Paul Bakker926c8e42013-03-06 10:23:34 +01002491 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002492 return( NULL );
Paul Bakker926c8e42013-03-06 10:23:34 +01002493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 return mbedtls_ssl_get_ciphersuite_name( ssl->session->ciphersuite );
Paul Bakker72f62662011-01-16 21:27:44 +00002495}
2496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002498{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002500 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002501 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002502 switch( ssl->tls_version )
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002503 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002504 case MBEDTLS_SSL_VERSION_TLS1_2:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002505 return( "DTLSv1.2" );
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002506 default:
2507 return( "unknown (DTLS)" );
2508 }
2509 }
2510#endif
2511
Glenn Strauss60bfe602022-03-14 19:04:24 -04002512 switch( ssl->tls_version )
Paul Bakker43ca69c2011-01-15 17:35:19 +00002513 {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002514 case MBEDTLS_SSL_VERSION_TLS1_2:
Paul Bakker1ef83d62012-04-11 12:09:53 +00002515 return( "TLSv1.2" );
Glenn Strauss60bfe602022-03-14 19:04:24 -04002516 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskinec63a1e02022-01-13 01:10:24 +01002517 return( "TLSv1.3" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002518 default:
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002519 return( "unknown" );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002520 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002521}
2522
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002523#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002524size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl )
2525{
David Horstmann95d516f2021-05-04 18:36:56 +01002526 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002527 size_t read_mfl;
2528
2529 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
2530 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2531 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE )
2532 {
2533 return ssl_mfl_code_to_length( ssl->conf->mfl_code );
2534 }
2535
2536 /* Check if a smaller max length was negotiated */
2537 if( ssl->session_out != NULL )
2538 {
2539 read_mfl = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
2540 if( read_mfl < max_len )
2541 {
2542 max_len = read_mfl;
2543 }
2544 }
2545
2546 // During a handshake, use the value being negotiated
2547 if( ssl->session_negotiate != NULL )
2548 {
2549 read_mfl = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2550 if( read_mfl < max_len )
2551 {
2552 max_len = read_mfl;
2553 }
2554 }
2555
2556 return( max_len );
2557}
2558
2559size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002560{
2561 size_t max_len;
2562
2563 /*
2564 * Assume mfl_code is correct since it was checked when set
2565 */
Angus Grattond8213d02016-05-25 20:56:48 +10002566 max_len = ssl_mfl_code_to_length( ssl->conf->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002567
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002568 /* Check if a smaller max length was negotiated */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002569 if( ssl->session_out != NULL &&
Angus Grattond8213d02016-05-25 20:56:48 +10002570 ssl_mfl_code_to_length( ssl->session_out->mfl_code ) < max_len )
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002571 {
Angus Grattond8213d02016-05-25 20:56:48 +10002572 max_len = ssl_mfl_code_to_length( ssl->session_out->mfl_code );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002573 }
2574
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002575 /* During a handshake, use the value being negotiated */
2576 if( ssl->session_negotiate != NULL &&
2577 ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code ) < max_len )
2578 {
2579 max_len = ssl_mfl_code_to_length( ssl->session_negotiate->mfl_code );
2580 }
2581
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002582 return( max_len );
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002583}
2584#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2585
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002586#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002587size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002588{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002589 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
2590 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2591 ( ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2592 ssl->state == MBEDTLS_SSL_SERVER_HELLO ) )
2593 return ( 0 );
2594
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002595 if( ssl->handshake == NULL || ssl->handshake->mtu == 0 )
2596 return( ssl->mtu );
2597
2598 if( ssl->mtu == 0 )
2599 return( ssl->handshake->mtu );
2600
2601 return( ssl->mtu < ssl->handshake->mtu ?
2602 ssl->mtu : ssl->handshake->mtu );
2603}
2604#endif /* MBEDTLS_SSL_PROTO_DTLS */
2605
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002606int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl )
2607{
2608 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2609
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002610#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2611 !defined(MBEDTLS_SSL_PROTO_DTLS)
2612 (void) ssl;
2613#endif
2614
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002615#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002616 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002617
2618 if( max_len > mfl )
2619 max_len = mfl;
2620#endif
2621
2622#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker89490712020-02-05 10:50:12 +00002623 if( mbedtls_ssl_get_current_mtu( ssl ) != 0 )
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002624 {
Hanno Becker89490712020-02-05 10:50:12 +00002625 const size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002626 const int ret = mbedtls_ssl_get_record_expansion( ssl );
2627 const size_t overhead = (size_t) ret;
2628
2629 if( ret < 0 )
2630 return( ret );
2631
2632 if( mtu <= overhead )
2633 {
2634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "MTU too low for record expansion" ) );
2635 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2636 }
2637
2638 if( max_len > mtu - overhead )
2639 max_len = mtu - overhead;
2640 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002641#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002642
Hanno Becker0defedb2018-08-10 12:35:02 +01002643#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
2644 !defined(MBEDTLS_SSL_PROTO_DTLS)
2645 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002646#endif
2647
2648 return( (int) max_len );
2649}
2650
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002651int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl )
2652{
2653 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2654
2655#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2656 (void) ssl;
2657#endif
2658
2659#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2660 const size_t mfl = mbedtls_ssl_get_input_max_frag_len( ssl );
2661
2662 if( max_len > mfl )
2663 max_len = mfl;
2664#endif
2665
2666 return( (int) max_len );
2667}
2668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669#if defined(MBEDTLS_X509_CRT_PARSE_C)
2670const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl )
Paul Bakkerb0550d92012-10-30 07:51:03 +00002671{
2672 if( ssl == NULL || ssl->session == NULL )
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002673 return( NULL );
Paul Bakkerb0550d92012-10-30 07:51:03 +00002674
Hanno Beckere6824572019-02-07 13:18:46 +00002675#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Paul Bakkerd8bb8262014-06-17 14:06:49 +02002676 return( ssl->session->peer_cert );
Hanno Beckere6824572019-02-07 13:18:46 +00002677#else
2678 return( NULL );
2679#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002680}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683#if defined(MBEDTLS_SSL_CLI_C)
Hanno Beckerf852b1c2019-02-05 11:42:30 +00002684int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
2685 mbedtls_ssl_session *dst )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002686{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002687 int ret;
2688
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002689 if( ssl == NULL ||
2690 dst == NULL ||
2691 ssl->session == NULL ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002692 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT )
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002695 }
2696
Hanno Beckere810bbc2021-05-14 16:01:05 +01002697 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2698 * idempotent: Each session can only be exported once.
2699 *
2700 * (This is in preparation for TLS 1.3 support where we will
2701 * need the ability to export multiple sessions (aka tickets),
2702 * which will be achieved by calling mbedtls_ssl_get_session()
2703 * multiple times until it fails.)
2704 *
2705 * Check whether we have already exported the current session,
2706 * and fail if so.
2707 */
2708 if( ssl->session->exported == 1 )
2709 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2710
2711 ret = mbedtls_ssl_session_copy( dst, ssl->session );
2712 if( ret != 0 )
2713 return( ret );
2714
2715 /* Remember that we've exported the session. */
2716 ssl->session->exported = 1;
2717 return( 0 );
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002718}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002720
Paul Bakker5121ce52009-01-03 21:22:43 +00002721/*
Hanno Beckera835da52019-05-16 12:39:07 +01002722 * Define ticket header determining Mbed TLS version
2723 * and structure of the ticket.
2724 */
2725
Hanno Becker94ef3b32019-05-16 12:50:45 +01002726/*
Hanno Becker50b59662019-05-28 14:30:45 +01002727 * Define bitflag determining compile-time settings influencing
2728 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01002729 */
2730
Hanno Becker50b59662019-05-28 14:30:45 +01002731#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01002732#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01002733#else
Hanno Becker3e088662019-05-29 11:10:18 +01002734#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002735#endif /* MBEDTLS_HAVE_TIME */
2736
2737#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01002738#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002739#else
Hanno Becker3e088662019-05-29 11:10:18 +01002740#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002741#endif /* MBEDTLS_X509_CRT_PARSE_C */
2742
2743#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01002744#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002745#else
Hanno Becker3e088662019-05-29 11:10:18 +01002746#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002747#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
2748
2749#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01002750#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002751#else
Hanno Becker3e088662019-05-29 11:10:18 +01002752#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002753#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2754
Hanno Becker94ef3b32019-05-16 12:50:45 +01002755#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01002756#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01002757#else
Hanno Becker3e088662019-05-29 11:10:18 +01002758#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01002759#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2760
Hanno Becker94ef3b32019-05-16 12:50:45 +01002761#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2762#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
2763#else
2764#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
2765#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2766
Hanno Becker3e088662019-05-29 11:10:18 +01002767#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
2768#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
2769#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
2770#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01002771#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
2772#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01002773
Hanno Becker50b59662019-05-28 14:30:45 +01002774#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Hanno Becker3e088662019-05-29 11:10:18 +01002775 ( (uint16_t) ( \
2776 ( SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT ) | \
2777 ( SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT ) | \
2778 ( SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT ) | \
2779 ( SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT ) | \
Hanno Becker3e088662019-05-29 11:10:18 +01002780 ( SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT ) | \
Hanno Beckerbe34e8e2019-06-04 09:43:16 +01002781 ( SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT ) ) )
Hanno Becker94ef3b32019-05-16 12:50:45 +01002782
Hanno Beckerf8787072019-05-16 12:41:07 +01002783static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01002784 MBEDTLS_VERSION_MAJOR,
2785 MBEDTLS_VERSION_MINOR,
2786 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01002787 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
2788 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
Hanno Beckerf8787072019-05-16 12:41:07 +01002789};
Hanno Beckera835da52019-05-16 12:39:07 +01002790
2791/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002792 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02002793 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002794 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002795 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002796 *
Hanno Beckerdce50972021-08-01 05:39:23 +01002797 * opaque mbedtls_version[3]; // library version: major, minor, patch
2798 * opaque session_format[2]; // library-version specific 16-bit field
2799 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002800 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01002801 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002802 * Note: When updating the format, remember to keep
2803 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002804 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002805 * // In this version, `session_format` determines
2806 * // the setting of those compile-time
2807 * // configuration options which influence
2808 * // the structure of mbedtls_ssl_session.
2809 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002810 * uint8_t minor_ver; // Protocol minor version. Possible values:
2811 * // - TLS 1.2 (3)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002812 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002813 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002814 *
Glenn Straussda7851c2022-03-14 13:29:48 -04002815 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002816 * serialized_session_tls12 data;
2817 *
2818 * };
2819 *
2820 * } serialized_session;
2821 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002822 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002823
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002824MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002825static int ssl_session_save( const mbedtls_ssl_session *session,
2826 unsigned char omit_header,
2827 unsigned char *buf,
2828 size_t buf_len,
2829 size_t *olen )
2830{
2831 unsigned char *p = buf;
2832 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08002833 size_t remaining_len;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002834
2835 if( !omit_header )
2836 {
2837 /*
2838 * Add Mbed TLS version identifier
2839 */
2840
2841 used += sizeof( ssl_serialized_session_header );
2842
2843 if( used <= buf_len )
2844 {
2845 memcpy( p, ssl_serialized_session_header,
2846 sizeof( ssl_serialized_session_header ) );
2847 p += sizeof( ssl_serialized_session_header );
2848 }
2849 }
2850
2851 /*
2852 * TLS version identifier
2853 */
2854 used += 1;
2855 if( used <= buf_len )
2856 {
Glenn Straussda7851c2022-03-14 13:29:48 -04002857 *p++ = MBEDTLS_BYTE_0( session->tls_version );
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002858 }
2859
2860 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08002861 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Glenn Straussda7851c2022-03-14 13:29:48 -04002862 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002863 {
2864#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002865 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002866 {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002867 used += ssl_session_save_tls12( session, p, remaining_len );
2868 break;
2869 }
2870#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2871
Jerry Yu251a12e2022-07-13 15:15:48 +08002872#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
2873 case MBEDTLS_SSL_VERSION_TLS1_3:
2874 {
2875 used += ssl_session_save_tls13( session, p, remaining_len );
2876 break;
2877 }
2878#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2879
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002880 default:
2881 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2882 }
2883
2884 *olen = used;
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002885 if( used > buf_len )
2886 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002887
2888 return( 0 );
2889}
2890
2891/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002892 * Public wrapper for ssl_session_save()
2893 */
2894int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2895 unsigned char *buf,
2896 size_t buf_len,
2897 size_t *olen )
2898{
2899 return( ssl_session_save( session, 0, buf, buf_len, olen ) );
2900}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002901
Jerry Yuf1b23ca2022-02-18 11:48:47 +08002902/*
2903 * Deserialize session, see mbedtls_ssl_session_save() for format.
2904 *
2905 * This internal version is wrapped by a public function that cleans up in
2906 * case of error, and has an extra option omit_header.
2907 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002908MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002909static int ssl_session_load( mbedtls_ssl_session *session,
2910 unsigned char omit_header,
2911 const unsigned char *buf,
2912 size_t len )
2913{
2914 const unsigned char *p = buf;
2915 const unsigned char * const end = buf + len;
2916
2917 if( !omit_header )
2918 {
2919 /*
2920 * Check Mbed TLS version identifier
2921 */
2922
2923 if( (size_t)( end - p ) < sizeof( ssl_serialized_session_header ) )
2924 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2925
2926 if( memcmp( p, ssl_serialized_session_header,
2927 sizeof( ssl_serialized_session_header ) ) != 0 )
2928 {
2929 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
2930 }
2931 p += sizeof( ssl_serialized_session_header );
2932 }
2933
2934 /*
2935 * TLS version identifier
2936 */
2937 if( 1 > (size_t)( end - p ) )
2938 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Glenn Straussda7851c2022-03-14 13:29:48 -04002939 session->tls_version = 0x0300 | *p++;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002940
2941 /* Dispatch according to TLS version. */
Glenn Straussda7851c2022-03-14 13:29:48 -04002942 switch( session->tls_version )
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002943 {
2944#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Straussda7851c2022-03-14 13:29:48 -04002945 case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01002946 {
2947 size_t remaining_len = ( end - p );
2948 return( ssl_session_load_tls12( session, p, remaining_len ) );
2949 }
2950#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2951
2952 default:
2953 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2954 }
2955}
2956
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02002957/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02002958 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002959 */
2960int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2961 const unsigned char *buf,
2962 size_t len )
2963{
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02002964 int ret = ssl_session_load( session, 0, buf, len );
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02002965
2966 if( ret != 0 )
2967 mbedtls_ssl_session_free( session );
2968
2969 return( ret );
2970}
2971
2972/*
Paul Bakker1961b702013-01-25 14:49:24 +01002973 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00002974 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002975MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker41934dd2021-08-07 19:13:43 +01002976static int ssl_prepare_handshake_step( mbedtls_ssl_context *ssl )
2977{
2978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2979
Ronald Cron66dbf912022-02-02 15:33:46 +01002980 /*
2981 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01002982 * that were written into the output buffer by the previous handshake step,
2983 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01002984 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
2985 * We proceed to the next handshake step only when all data from the
2986 * previous one have been sent to the peer, thus we make sure that this is
2987 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
2988 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
2989 * we have to wait before to go ahead.
2990 * In the case of TLS 1.3, handshake step handlers do not send data to the
2991 * peer. Data are only sent here and through
2992 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002993 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01002994 */
Hanno Becker41934dd2021-08-07 19:13:43 +01002995 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2996 return( ret );
2997
2998#if defined(MBEDTLS_SSL_PROTO_DTLS)
2999 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3000 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
3001 {
3002 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
3003 return( ret );
3004 }
3005#endif /* MBEDTLS_SSL_PROTO_DTLS */
3006
3007 return( ret );
3008}
3009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00003011{
Hanno Becker41934dd2021-08-07 19:13:43 +01003012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003013
Hanno Becker41934dd2021-08-07 19:13:43 +01003014 if( ssl == NULL ||
3015 ssl->conf == NULL ||
3016 ssl->handshake == NULL ||
Paul Elliott27b0d942022-03-18 21:55:32 +00003017 mbedtls_ssl_is_handshake_over( ssl ) == 1 )
Hanno Becker41934dd2021-08-07 19:13:43 +01003018 {
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003019 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Hanno Becker41934dd2021-08-07 19:13:43 +01003020 }
3021
3022 ret = ssl_prepare_handshake_step( ssl );
3023 if( ret != 0 )
3024 return( ret );
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003025
Jerry Yue7047812021-09-13 19:26:39 +08003026 ret = mbedtls_ssl_handle_pending_alert( ssl );
3027 if( ret != 0 )
3028 goto cleanup;
3029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003031 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
Jerry Yub9930e72021-08-06 17:11:51 +08003032 {
Ronald Cron27c85e72022-03-08 11:37:55 +01003033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "client state: %s",
3034 mbedtls_ssl_states_str( ssl->state ) ) );
Jerry Yub9930e72021-08-06 17:11:51 +08003035
Ronald Cron9f0fba32022-02-10 16:45:15 +01003036 switch( ssl->state )
3037 {
3038 case MBEDTLS_SSL_HELLO_REQUEST:
3039 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
3040 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003041
Ronald Cron9f0fba32022-02-10 16:45:15 +01003042 case MBEDTLS_SSL_CLIENT_HELLO:
3043 ret = mbedtls_ssl_write_client_hello( ssl );
3044 break;
3045
3046 default:
3047#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04003048 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01003049 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3050 else
3051 ret = mbedtls_ssl_handshake_client_step( ssl );
3052#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3053 ret = mbedtls_ssl_handshake_client_step( ssl );
3054#else
3055 ret = mbedtls_ssl_tls13_handshake_client_step( ssl );
3056#endif
3057 }
Jerry Yub9930e72021-08-06 17:11:51 +08003058 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003059#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003060#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003061 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Jerry Yub9930e72021-08-06 17:11:51 +08003062 {
Ronald Cron6f135e12021-12-08 16:57:54 +01003063#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yub9930e72021-08-06 17:11:51 +08003064 if( mbedtls_ssl_conf_is_tls13_only( ssl->conf ) )
Jerry Yu27561932021-08-27 17:07:38 +08003065 ret = mbedtls_ssl_tls13_handshake_server_step( ssl );
Ronald Cron6f135e12021-12-08 16:57:54 +01003066#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yub9930e72021-08-06 17:11:51 +08003067
3068#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3069 if( mbedtls_ssl_conf_is_tls12_only( ssl->conf ) )
3070 ret = mbedtls_ssl_handshake_server_step( ssl );
3071#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3072 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003073#endif
3074
Jerry Yue7047812021-09-13 19:26:39 +08003075 if( ret != 0 )
3076 {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003077 /* handshake_step return error. And it is same
3078 * with alert_reason.
3079 */
Jerry Yu3bf1f972021-09-22 21:37:18 +08003080 if( ssl->send_alert )
Jerry Yue7047812021-09-13 19:26:39 +08003081 {
Jerry Yu3bf1f972021-09-22 21:37:18 +08003082 ret = mbedtls_ssl_handle_pending_alert( ssl );
Jerry Yue7047812021-09-13 19:26:39 +08003083 goto cleanup;
3084 }
3085 }
3086
3087cleanup:
Paul Bakker1961b702013-01-25 14:49:24 +01003088 return( ret );
3089}
3090
3091/*
3092 * Perform the SSL handshake
3093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl )
Paul Bakker1961b702013-01-25 14:49:24 +01003095{
3096 int ret = 0;
3097
Hanno Beckera817ea42020-10-20 15:20:23 +01003098 /* Sanity checks */
3099
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003100 if( ssl == NULL || ssl->conf == NULL )
3101 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3102
Hanno Beckera817ea42020-10-20 15:20:23 +01003103#if defined(MBEDTLS_SSL_PROTO_DTLS)
3104 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3105 ( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL ) )
3106 {
3107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
3108 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
3109 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3110 }
3111#endif /* MBEDTLS_SSL_PROTO_DTLS */
3112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> handshake" ) );
Paul Bakker1961b702013-01-25 14:49:24 +01003114
Hanno Beckera817ea42020-10-20 15:20:23 +01003115 /* Main handshake loop */
Paul Elliott27b0d942022-03-18 21:55:32 +00003116 while( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Paul Bakker1961b702013-01-25 14:49:24 +01003117 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 ret = mbedtls_ssl_handshake_step( ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003119
3120 if( ret != 0 )
3121 break;
3122 }
3123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= handshake" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003125
3126 return( ret );
3127}
3128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#if defined(MBEDTLS_SSL_RENEGOTIATION)
3130#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003131/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003132 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003133 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003134MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135static int ssl_write_hello_request( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003136{
Janos Follath865b3eb2019-12-16 11:46:15 +00003137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003140
3141 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3143 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003144
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003145 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003146 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02003147 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003148 return( ret );
3149 }
3150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello request" ) );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003152
3153 return( 0 );
3154}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003156
3157/*
3158 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 * - any side: calling mbedtls_ssl_renegotiate(),
3160 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3161 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003162 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003163 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003165 */
Hanno Becker40cdaa12020-02-05 10:48:27 +00003166int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003167{
Janos Follath865b3eb2019-12-16 11:46:15 +00003168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003171
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003172 if( ( ret = ssl_handshake_init( ssl ) ) != 0 )
3173 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003174
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003175 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3176 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003178 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003180 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003181 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003182 ssl->handshake->out_msg_seq = 1;
3183 else
3184 ssl->handshake->in_msg_seq = 1;
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003185 }
3186#endif
3187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3189 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Paul Bakker48916f92012-09-16 19:57:18 +00003192 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker48916f92012-09-16 19:57:18 +00003194 return( ret );
3195 }
3196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= renegotiate" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003198
3199 return( 0 );
3200}
3201
3202/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003203 * Renegotiate current connection on client,
3204 * or request renegotiation on server
3205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003207{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003209
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003210 if( ssl == NULL || ssl->conf == NULL )
3211 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003214 /* On server, just send the request */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003215 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003216 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003217 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003219
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003221
3222 /* Did we already try/start sending HelloRequest? */
3223 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 return( mbedtls_ssl_flush_output( ssl ) );
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02003225
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003226 return( ssl_write_hello_request( ssl ) );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003227 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003229
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003231 /*
3232 * On client, either start the renegotiation process or,
3233 * if already in progress, continue the handshake
3234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235 if( ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003236 {
Paul Elliott27b0d942022-03-18 21:55:32 +00003237 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003239
Hanno Becker40cdaa12020-02-05 10:48:27 +00003240 if( ( ret = mbedtls_ssl_start_renegotiation( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003241 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00003242 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003243 return( ret );
3244 }
3245 }
3246 else
3247 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003249 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003251 return( ret );
3252 }
3253 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003255
Paul Bakker37ce0ff2013-10-31 14:32:04 +01003256 return( ret );
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003257}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003259
Gilles Peskine9b562d52018-04-25 20:32:43 +02003260void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl )
Paul Bakker48916f92012-09-16 19:57:18 +00003261{
Gilles Peskine9b562d52018-04-25 20:32:43 +02003262 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
3263
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003264 if( handshake == NULL )
3265 return;
3266
Brett Warrene0edc842021-08-17 09:53:13 +01003267#if defined(MBEDTLS_ECP_C)
3268#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3269 if ( ssl->handshake->group_list_heap_allocated )
3270 mbedtls_free( (void*) handshake->group_list );
3271 handshake->group_list = NULL;
3272#endif /* MBEDTLS_DEPRECATED_REMOVED */
3273#endif /* MBEDTLS_ECP_C */
3274
Jerry Yuf017ee42022-01-12 15:49:48 +08003275#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
3276#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3277 if ( ssl->handshake->sig_algs_heap_allocated )
3278 mbedtls_free( (void*) handshake->sig_algs );
3279 handshake->sig_algs = NULL;
3280#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00003281#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3282 if( ssl->handshake->certificate_request_context )
3283 {
3284 mbedtls_free( (void*) handshake->certificate_request_context );
3285 }
3286#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuf017ee42022-01-12 15:49:48 +08003287#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
3288
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003289#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
3290 if( ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0 )
3291 {
Gilles Peskine8f97af72018-04-26 11:46:10 +02003292 ssl->conf->f_async_cancel( ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003293 handshake->async_in_progress = 0;
3294 }
3295#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
3296
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003297#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003298#if defined(MBEDTLS_USE_PSA_CRYPTO)
3299 psa_hash_abort( &handshake->fin_sha256_psa );
3300#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003301 mbedtls_sha256_free( &handshake->fin_sha256 );
3302#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003303#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +02003304#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -05003305#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -05003306 psa_hash_abort( &handshake->fin_sha384_psa );
Andrzej Kurekeb342242019-01-29 09:14:33 -05003307#else
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003308 mbedtls_sha512_free( &handshake->fin_sha512 );
3309#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05003310#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02003311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312#if defined(MBEDTLS_DHM_C)
3313 mbedtls_dhm_free( &handshake->dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +00003314#endif
Neil Armstrongf3f46412022-04-12 14:43:39 +02003315#if !defined(MBEDTLS_USE_PSA_CRYPTO) && defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316 mbedtls_ecdh_free( &handshake->ecdh_ctx );
Paul Bakker61d113b2013-07-04 11:51:43 +02003317#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003318#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003319 mbedtls_ecjpake_free( &handshake->ecjpake_ctx );
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02003320#if defined(MBEDTLS_SSL_CLI_C)
3321 mbedtls_free( handshake->ecjpake_cache );
3322 handshake->ecjpake_cache = NULL;
3323 handshake->ecjpake_cache_len = 0;
3324#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02003325#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02003326
Janos Follath4ae5c292016-02-10 11:27:43 +00003327#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
3328 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02003329 /* explicit void pointer cast for buggy MS compiler */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 mbedtls_free( (void *) handshake->curves );
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02003331#endif
3332
Gilles Peskineeccd8882020-03-10 12:19:08 +01003333#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02003334#if defined(MBEDTLS_USE_PSA_CRYPTO)
3335 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
3336 {
3337 /* The maintenance of the external PSK key slot is the
3338 * user's responsibility. */
3339 if( ssl->handshake->psk_opaque_is_internal )
3340 {
3341 psa_destroy_key( ssl->handshake->psk_opaque );
3342 ssl->handshake->psk_opaque_is_internal = 0;
3343 }
3344 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
3345 }
Neil Armstronge952a302022-05-03 10:22:14 +02003346#else
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003347 if( handshake->psk != NULL )
3348 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003349 mbedtls_platform_zeroize( handshake->psk, handshake->psk_len );
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003350 mbedtls_free( handshake->psk );
3351 }
Neil Armstronge952a302022-05-03 10:22:14 +02003352#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003353#endif
3354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3356 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02003357 /*
3358 * Free only the linked list wrapper, not the keys themselves
3359 * since the belong to the SNI callback
3360 */
Glenn Strauss36872db2022-01-22 05:06:31 -05003361 ssl_key_cert_free( handshake->sni_key_cert );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02003363
Gilles Peskineeccd8882020-03-10 12:19:08 +01003364#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +02003365 mbedtls_x509_crt_restart_free( &handshake->ecrs_ctx );
Hanno Becker3dad3112019-02-05 17:19:52 +00003366 if( handshake->ecrs_peer_cert != NULL )
3367 {
3368 mbedtls_x509_crt_free( handshake->ecrs_peer_cert );
3369 mbedtls_free( handshake->ecrs_peer_cert );
3370 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02003371#endif
3372
Hanno Becker75173122019-02-06 16:18:31 +00003373#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
3374 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3375 mbedtls_pk_free( &handshake->peer_pubkey );
3376#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3377
XiaokangQian9b93c0d2022-02-09 06:02:25 +00003378#if defined(MBEDTLS_SSL_CLI_C) && \
3379 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
3380 mbedtls_free( handshake->cookie );
3381#endif /* MBEDTLS_SSL_CLI_C &&
3382 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00003383
3384#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker533ab5f2020-02-05 10:49:13 +00003385 mbedtls_ssl_flight_free( handshake->flight );
3386 mbedtls_ssl_buffering_free( ssl );
XiaokangQian8499b6c2022-01-27 09:00:11 +00003387#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02003388
Ronald Cronf12b81d2022-03-15 10:42:41 +01003389#if defined(MBEDTLS_ECDH_C) && \
3390 ( defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
Neil Armstrongf716a702022-04-04 11:23:46 +02003391 if( handshake->ecdh_psa_privkey_is_external == 0 )
Neil Armstrong8113d252022-03-23 10:57:04 +01003392 psa_destroy_key( handshake->ecdh_psa_privkey );
Hanno Becker4a63ed42019-01-08 11:39:35 +00003393#endif /* MBEDTLS_ECDH_C && MBEDTLS_USE_PSA_CRYPTO */
3394
Ronald Cron6f135e12021-12-08 16:57:54 +01003395#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua1a568c2021-11-09 10:17:21 +08003396 mbedtls_ssl_transform_free( handshake->transform_handshake );
3397 mbedtls_ssl_transform_free( handshake->transform_earlydata );
Jerry Yuba9c7272021-10-30 11:54:10 +08003398 mbedtls_free( handshake->transform_earlydata );
3399 mbedtls_free( handshake->transform_handshake );
Ronald Cron6f135e12021-12-08 16:57:54 +01003400#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08003401
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003402
3403#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3404 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
3405 * processes datagrams and the fact that a datagram is allowed to have
3406 * several records in it, it is possible that the I/O buffers are not
3407 * empty at this stage */
Andrzej Kurek4a063792020-10-21 15:08:44 +02003408 handle_buffer_resizing( ssl, 1, mbedtls_ssl_get_input_buflen( ssl ),
3409 mbedtls_ssl_get_output_buflen( ssl ) );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05003410#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01003411
Jerry Yuba9c7272021-10-30 11:54:10 +08003412 /* mbedtls_platform_zeroize MUST be last one in this function */
3413 mbedtls_platform_zeroize( handshake,
3414 sizeof( mbedtls_ssl_handshake_params ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003415}
3416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417void mbedtls_ssl_session_free( mbedtls_ssl_session *session )
Paul Bakker48916f92012-09-16 19:57:18 +00003418{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003419 if( session == NULL )
3420 return;
3421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker1294a0b2019-02-05 12:38:15 +00003423 ssl_clear_peer_cert( session );
Paul Bakkered27a042013-04-18 22:46:23 +02003424#endif
Paul Bakker0a597072012-09-25 21:55:46 +00003425
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003426#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427 mbedtls_free( session->ticket );
Paul Bakkera503a632013-08-14 13:48:06 +02003428#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02003429
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05003430 mbedtls_platform_zeroize( session, sizeof( mbedtls_ssl_session ) );
Paul Bakker48916f92012-09-16 19:57:18 +00003431}
3432
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003433#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003434
3435#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3436#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
3437#else
3438#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
3439#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3440
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003441#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003442
3443#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3444#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
3445#else
3446#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
3447#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3448
3449#if defined(MBEDTLS_SSL_ALPN)
3450#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
3451#else
3452#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
3453#endif /* MBEDTLS_SSL_ALPN */
3454
3455#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
3456#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
3457#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
3458#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
3459
3460#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
3461 ( (uint32_t) ( \
3462 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT ) | \
3463 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT ) | \
3464 ( SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT ) | \
3465 ( SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT ) | \
3466 0u ) )
3467
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003468static unsigned char ssl_serialized_context_header[] = {
3469 MBEDTLS_VERSION_MAJOR,
3470 MBEDTLS_VERSION_MINOR,
3471 MBEDTLS_VERSION_PATCH,
Joe Subbiani2194dc42021-07-14 12:31:31 +01003472 MBEDTLS_BYTE_1( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3473 MBEDTLS_BYTE_0( SSL_SERIALIZED_SESSION_CONFIG_BITFLAG ),
3474 MBEDTLS_BYTE_2( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3475 MBEDTLS_BYTE_1( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
3476 MBEDTLS_BYTE_0( SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG ),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003477};
3478
Paul Bakker5121ce52009-01-03 21:22:43 +00003479/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003480 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003481 *
3482 * The format of the serialized data is:
3483 * (in the presentation language of TLS, RFC 8446 section 3)
3484 *
3485 * // header
3486 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003487 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003488 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003489 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02003490 * Note: When updating the format, remember to keep these
3491 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02003492 *
3493 * // session sub-structure
3494 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
3495 * // transform sub-structure
3496 * uint8 random[64]; // ServerHello.random+ClientHello.random
3497 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
3498 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
3499 * // fields from ssl_context
3500 * uint32 badmac_seen; // DTLS: number of records with failing MAC
3501 * uint64 in_window_top; // DTLS: last validated record seq_num
3502 * uint64 in_window; // DTLS: bitmask for replay protection
3503 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
3504 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
3505 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
3506 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
3507 *
3508 * Note that many fields of the ssl_context or sub-structures are not
3509 * serialized, as they fall in one of the following categories:
3510 *
3511 * 1. forced value (eg in_left must be 0)
3512 * 2. pointer to dynamically-allocated memory (eg session, transform)
3513 * 3. value can be re-derived from other data (eg session keys from MS)
3514 * 4. value was temporary (eg content of input buffer)
3515 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003516 */
3517int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3518 unsigned char *buf,
3519 size_t buf_len,
3520 size_t *olen )
3521{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003522 unsigned char *p = buf;
3523 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003524 size_t session_len;
3525 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003526
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003527 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003528 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
3529 * this function's documentation.
3530 *
3531 * These are due to assumptions/limitations in the implementation. Some of
3532 * them are likely to stay (no handshake in progress) some might go away
3533 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003534 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003535 /* The initial handshake must be over */
Paul Elliott27b0d942022-03-18 21:55:32 +00003536 if( mbedtls_ssl_is_handshake_over( ssl ) == 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003537 {
3538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Initial handshake isn't over" ) );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02003539 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003540 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003541 if( ssl->handshake != NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003542 {
3543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Handshake isn't completed" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003544 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003545 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003546 /* Double-check that sub-structures are indeed ready */
3547 if( ssl->transform == NULL || ssl->session == NULL )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003548 {
3549 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Serialised structures aren't ready" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003550 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003551 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003552 /* There must be no pending incoming or outgoing data */
3553 if( mbedtls_ssl_check_pending( ssl ) != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003554 {
3555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending incoming data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003556 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003557 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003558 if( ssl->out_left != 0 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003559 {
3560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "There is pending outgoing data" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003561 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003562 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003563 /* Protocol must be DLTS, not TLS */
3564 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003565 {
3566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only DTLS is supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003567 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003568 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003569 /* Version must be 1.2 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04003570 if( ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003571 {
3572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only version 1.2 supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003573 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003574 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003575 /* We must be using an AEAD ciphersuite */
3576 if( mbedtls_ssl_transform_uses_aead( ssl->transform ) != 1 )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003577 {
3578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Only AEAD ciphersuites supported" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003580 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003581 /* Renegotiation must not be enabled */
3582#if defined(MBEDTLS_SSL_RENEGOTIATION)
3583 if( ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003584 {
3585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Renegotiation must not be enabled" ) );
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003586 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03003587 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02003588#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003589
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003590 /*
3591 * Version and format identifier
3592 */
3593 used += sizeof( ssl_serialized_context_header );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003594
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003595 if( used <= buf_len )
3596 {
3597 memcpy( p, ssl_serialized_context_header,
3598 sizeof( ssl_serialized_context_header ) );
3599 p += sizeof( ssl_serialized_context_header );
3600 }
3601
3602 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003603 * Session (length + data)
3604 */
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003605 ret = ssl_session_save( ssl->session, 1, NULL, 0, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003606 if( ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL )
3607 return( ret );
3608
3609 used += 4 + session_len;
3610 if( used <= buf_len )
3611 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003612 MBEDTLS_PUT_UINT32_BE( session_len, p, 0 );
3613 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003614
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003615 ret = ssl_session_save( ssl->session, 1,
3616 p, session_len, &session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003617 if( ret != 0 )
3618 return( ret );
3619
3620 p += session_len;
3621 }
3622
3623 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003624 * Transform
3625 */
3626 used += sizeof( ssl->transform->randbytes );
3627 if( used <= buf_len )
3628 {
3629 memcpy( p, ssl->transform->randbytes,
3630 sizeof( ssl->transform->randbytes ) );
3631 p += sizeof( ssl->transform->randbytes );
3632 }
3633
3634#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3635 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
3636 if( used <= buf_len )
3637 {
3638 *p++ = ssl->transform->in_cid_len;
3639 memcpy( p, ssl->transform->in_cid, ssl->transform->in_cid_len );
3640 p += ssl->transform->in_cid_len;
3641
3642 *p++ = ssl->transform->out_cid_len;
3643 memcpy( p, ssl->transform->out_cid, ssl->transform->out_cid_len );
3644 p += ssl->transform->out_cid_len;
3645 }
3646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3647
3648 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003649 * Saved fields from top-level ssl_context structure
3650 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003651 used += 4;
3652 if( used <= buf_len )
3653 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003654 MBEDTLS_PUT_UINT32_BE( ssl->badmac_seen, p, 0 );
3655 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003656 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003657
3658#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3659 used += 16;
3660 if( used <= buf_len )
3661 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003662 MBEDTLS_PUT_UINT64_BE( ssl->in_window_top, p, 0 );
3663 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003664
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003665 MBEDTLS_PUT_UINT64_BE( ssl->in_window, p, 0 );
3666 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003667 }
3668#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3669
3670#if defined(MBEDTLS_SSL_PROTO_DTLS)
3671 used += 1;
3672 if( used <= buf_len )
3673 {
3674 *p++ = ssl->disable_datagram_packing;
3675 }
3676#endif /* MBEDTLS_SSL_PROTO_DTLS */
3677
Jerry Yuae0b2e22021-10-08 15:21:19 +08003678 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003679 if( used <= buf_len )
3680 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08003681 memcpy( p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
3682 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003683 }
3684
3685#if defined(MBEDTLS_SSL_PROTO_DTLS)
3686 used += 2;
3687 if( used <= buf_len )
3688 {
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01003689 MBEDTLS_PUT_UINT16_BE( ssl->mtu, p, 0 );
3690 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003691 }
3692#endif /* MBEDTLS_SSL_PROTO_DTLS */
3693
3694#if defined(MBEDTLS_SSL_ALPN)
3695 {
3696 const uint8_t alpn_len = ssl->alpn_chosen
Manuel Pégourié-Gonnardf041f4e2019-07-24 00:58:27 +02003697 ? (uint8_t) strlen( ssl->alpn_chosen )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003698 : 0;
3699
3700 used += 1 + alpn_len;
3701 if( used <= buf_len )
3702 {
3703 *p++ = alpn_len;
3704
3705 if( ssl->alpn_chosen != NULL )
3706 {
3707 memcpy( p, ssl->alpn_chosen, alpn_len );
3708 p += alpn_len;
3709 }
3710 }
3711 }
3712#endif /* MBEDTLS_SSL_ALPN */
3713
3714 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003715 * Done
3716 */
3717 *olen = used;
3718
3719 if( used > buf_len )
3720 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003721
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003722 MBEDTLS_SSL_DEBUG_BUF( 4, "saved context", buf, used );
3723
Hanno Becker43aefe22020-02-05 10:44:56 +00003724 return( mbedtls_ssl_session_reset_int( ssl, 0 ) );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003725}
3726
3727/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003728 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003729 *
3730 * This internal version is wrapped by a public function that cleans up in
3731 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003732 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003733MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003734static int ssl_context_load( mbedtls_ssl_context *ssl,
3735 const unsigned char *buf,
3736 size_t len )
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003737{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003738 const unsigned char *p = buf;
3739 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003740 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00003741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003742
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003743 /*
3744 * The context should have been freshly setup or reset.
3745 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02003746 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003747 * renegotiating, or if the user mistakenly loaded a session first.)
3748 */
3749 if( ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
3750 ssl->session != NULL )
3751 {
3752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3753 }
3754
3755 /*
3756 * We can't check that the config matches the initial one, but we can at
3757 * least check it matches the requirements for serializing.
3758 */
3759 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
Glenn Strauss2dfcea22022-03-14 17:26:42 -04003760 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
3761 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003762#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003763 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003764#endif
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02003765 0 )
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02003766 {
3767 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3768 }
3769
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003770 MBEDTLS_SSL_DEBUG_BUF( 4, "context to load", buf, len );
3771
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003772 /*
3773 * Check version identifier
3774 */
3775 if( (size_t)( end - p ) < sizeof( ssl_serialized_context_header ) )
3776 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3777
3778 if( memcmp( p, ssl_serialized_context_header,
3779 sizeof( ssl_serialized_context_header ) ) != 0 )
3780 {
3781 return( MBEDTLS_ERR_SSL_VERSION_MISMATCH );
3782 }
3783 p += sizeof( ssl_serialized_context_header );
3784
3785 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003786 * Session
3787 */
3788 if( (size_t)( end - p ) < 4 )
3789 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3790
3791 session_len = ( (size_t) p[0] << 24 ) |
3792 ( (size_t) p[1] << 16 ) |
3793 ( (size_t) p[2] << 8 ) |
3794 ( (size_t) p[3] );
3795 p += 4;
3796
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003797 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003798 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003799 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003800 ssl->session_in = ssl->session;
3801 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003802 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003803
3804 if( (size_t)( end - p ) < session_len )
3805 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3806
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003807 ret = ssl_session_load( ssl->session, 1, p, session_len );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003808 if( ret != 0 )
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003809 {
3810 mbedtls_ssl_session_free( ssl->session );
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003811 return( ret );
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003812 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003813
3814 p += session_len;
3815
3816 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003817 * Transform
3818 */
3819
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003820 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00003821 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003822 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003823 ssl->transform_in = ssl->transform;
3824 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02003825 ssl->transform_negotiate = NULL;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003826
3827 /* Read random bytes and populate structure */
3828 if( (size_t)( end - p ) < sizeof( ssl->transform->randbytes ) )
3829 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yu840fbb22022-02-17 14:59:29 +08003830#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerbd257552021-03-22 06:59:27 +00003831 ret = ssl_tls12_populate_transform( ssl->transform,
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003832 ssl->session->ciphersuite,
3833 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003834#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003835 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02003836#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003837 ssl_tls12prf_from_cs( ssl->session->ciphersuite ),
3838 p, /* currently pointing to randbytes */
Glenn Strauss07c64162022-03-14 12:34:51 -04003839 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003840 ssl->conf->endpoint,
3841 ssl );
3842 if( ret != 0 )
3843 return( ret );
Jerry Yu840fbb22022-02-17 14:59:29 +08003844#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003845 p += sizeof( ssl->transform->randbytes );
3846
3847#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3848 /* Read connection IDs and store them */
3849 if( (size_t)( end - p ) < 1 )
3850 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3851
3852 ssl->transform->in_cid_len = *p++;
3853
Manuel Pégourié-Gonnard5ea13b82019-07-23 15:02:54 +02003854 if( (size_t)( end - p ) < ssl->transform->in_cid_len + 1u )
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02003855 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3856
3857 memcpy( ssl->transform->in_cid, p, ssl->transform->in_cid_len );
3858 p += ssl->transform->in_cid_len;
3859
3860 ssl->transform->out_cid_len = *p++;
3861
3862 if( (size_t)( end - p ) < ssl->transform->out_cid_len )
3863 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3864
3865 memcpy( ssl->transform->out_cid, p, ssl->transform->out_cid_len );
3866 p += ssl->transform->out_cid_len;
3867#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3868
3869 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003870 * Saved fields from top-level ssl_context structure
3871 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003872 if( (size_t)( end - p ) < 4 )
3873 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3874
3875 ssl->badmac_seen = ( (uint32_t) p[0] << 24 ) |
3876 ( (uint32_t) p[1] << 16 ) |
3877 ( (uint32_t) p[2] << 8 ) |
3878 ( (uint32_t) p[3] );
3879 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003880
3881#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
3882 if( (size_t)( end - p ) < 16 )
3883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3884
3885 ssl->in_window_top = ( (uint64_t) p[0] << 56 ) |
3886 ( (uint64_t) p[1] << 48 ) |
3887 ( (uint64_t) p[2] << 40 ) |
3888 ( (uint64_t) p[3] << 32 ) |
3889 ( (uint64_t) p[4] << 24 ) |
3890 ( (uint64_t) p[5] << 16 ) |
3891 ( (uint64_t) p[6] << 8 ) |
3892 ( (uint64_t) p[7] );
3893 p += 8;
3894
3895 ssl->in_window = ( (uint64_t) p[0] << 56 ) |
3896 ( (uint64_t) p[1] << 48 ) |
3897 ( (uint64_t) p[2] << 40 ) |
3898 ( (uint64_t) p[3] << 32 ) |
3899 ( (uint64_t) p[4] << 24 ) |
3900 ( (uint64_t) p[5] << 16 ) |
3901 ( (uint64_t) p[6] << 8 ) |
3902 ( (uint64_t) p[7] );
3903 p += 8;
3904#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
3905
3906#if defined(MBEDTLS_SSL_PROTO_DTLS)
3907 if( (size_t)( end - p ) < 1 )
3908 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3909
3910 ssl->disable_datagram_packing = *p++;
3911#endif /* MBEDTLS_SSL_PROTO_DTLS */
3912
Jerry Yud9a94fe2021-09-28 18:58:59 +08003913 if( (size_t)( end - p ) < sizeof( ssl->cur_out_ctr ) )
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003914 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Jerry Yud9a94fe2021-09-28 18:58:59 +08003915 memcpy( ssl->cur_out_ctr, p, sizeof( ssl->cur_out_ctr ) );
3916 p += sizeof( ssl->cur_out_ctr );
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02003917
3918#if defined(MBEDTLS_SSL_PROTO_DTLS)
3919 if( (size_t)( end - p ) < 2 )
3920 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3921
3922 ssl->mtu = ( p[0] << 8 ) | p[1];
3923 p += 2;
3924#endif /* MBEDTLS_SSL_PROTO_DTLS */
3925
3926#if defined(MBEDTLS_SSL_ALPN)
3927 {
3928 uint8_t alpn_len;
3929 const char **cur;
3930
3931 if( (size_t)( end - p ) < 1 )
3932 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3933
3934 alpn_len = *p++;
3935
3936 if( alpn_len != 0 && ssl->conf->alpn_list != NULL )
3937 {
3938 /* alpn_chosen should point to an item in the configured list */
3939 for( cur = ssl->conf->alpn_list; *cur != NULL; cur++ )
3940 {
3941 if( strlen( *cur ) == alpn_len &&
3942 memcmp( p, cur, alpn_len ) == 0 )
3943 {
3944 ssl->alpn_chosen = *cur;
3945 break;
3946 }
3947 }
3948 }
3949
3950 /* can only happen on conf mismatch */
3951 if( alpn_len != 0 && ssl->alpn_chosen == NULL )
3952 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
3953
3954 p += alpn_len;
3955 }
3956#endif /* MBEDTLS_SSL_ALPN */
3957
3958 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003959 * Forced fields from top-level ssl_context structure
3960 *
3961 * Most of them already set to the correct value by mbedtls_ssl_init() and
3962 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
3963 */
3964 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04003965 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003966
Hanno Becker361b10d2019-08-30 10:42:49 +01003967 /* Adjust pointers for header fields of outgoing records to
3968 * the given transform, accounting for explicit IV and CID. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00003969 mbedtls_ssl_update_out_pointers( ssl, ssl->transform );
Hanno Becker361b10d2019-08-30 10:42:49 +01003970
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003971#if defined(MBEDTLS_SSL_PROTO_DTLS)
3972 ssl->in_epoch = 1;
3973#endif
3974
3975 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
3976 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00003977 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
3978 * inappropriately. */
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02003979 if( ssl->handshake != NULL )
3980 {
3981 mbedtls_ssl_handshake_free( ssl );
3982 mbedtls_free( ssl->handshake );
3983 ssl->handshake = NULL;
3984 }
3985
3986 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02003987 * Done - should have consumed entire buffer
3988 */
3989 if( p != end )
3990 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003991
3992 return( 0 );
3993}
3994
3995/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003996 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003997 */
3998int mbedtls_ssl_context_load( mbedtls_ssl_context *context,
3999 const unsigned char *buf,
4000 size_t len )
4001{
4002 int ret = ssl_context_load( context, buf, len );
4003
4004 if( ret != 0 )
4005 mbedtls_ssl_free( context );
4006
4007 return( ret );
4008}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004009#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004010
4011/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004012 * Free an SSL context
4013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014void mbedtls_ssl_free( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004015{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004016 if( ssl == NULL )
4017 return;
4018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> free" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004020
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004021 if( ssl->out_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004022 {
sander-visserb8aa2072020-05-06 22:05:13 +02004023#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4024 size_t out_buf_len = ssl->out_buf_len;
4025#else
4026 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4027#endif
4028
Darryl Greenb33cc762019-11-28 14:29:44 +00004029 mbedtls_platform_zeroize( ssl->out_buf, out_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030 mbedtls_free( ssl->out_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004031 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004032 }
4033
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01004034 if( ssl->in_buf != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004035 {
sander-visserb8aa2072020-05-06 22:05:13 +02004036#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4037 size_t in_buf_len = ssl->in_buf_len;
4038#else
4039 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4040#endif
4041
Darryl Greenb33cc762019-11-28 14:29:44 +00004042 mbedtls_platform_zeroize( ssl->in_buf, in_buf_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004043 mbedtls_free( ssl->in_buf );
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004044 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004045 }
4046
Paul Bakker48916f92012-09-16 19:57:18 +00004047 if( ssl->transform )
4048 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004049 mbedtls_ssl_transform_free( ssl->transform );
4050 mbedtls_free( ssl->transform );
Paul Bakker48916f92012-09-16 19:57:18 +00004051 }
4052
4053 if( ssl->handshake )
4054 {
Gilles Peskine9b562d52018-04-25 20:32:43 +02004055 mbedtls_ssl_handshake_free( ssl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056 mbedtls_ssl_transform_free( ssl->transform_negotiate );
4057 mbedtls_ssl_session_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004059 mbedtls_free( ssl->handshake );
4060 mbedtls_free( ssl->transform_negotiate );
4061 mbedtls_free( ssl->session_negotiate );
Paul Bakker48916f92012-09-16 19:57:18 +00004062 }
4063
Ronald Cron6f135e12021-12-08 16:57:54 +01004064#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker3aa186f2021-08-10 09:24:19 +01004065 mbedtls_ssl_transform_free( ssl->transform_application );
4066 mbedtls_free( ssl->transform_application );
Ronald Cron6f135e12021-12-08 16:57:54 +01004067#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004068
Paul Bakkerc0463502013-02-14 11:19:38 +01004069 if( ssl->session )
4070 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004071 mbedtls_ssl_session_free( ssl->session );
4072 mbedtls_free( ssl->session );
Paul Bakkerc0463502013-02-14 11:19:38 +01004073 }
4074
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004075#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker66d5d072014-06-17 16:39:18 +02004076 if( ssl->hostname != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004077 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004078 mbedtls_platform_zeroize( ssl->hostname, strlen( ssl->hostname ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004079 mbedtls_free( ssl->hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +00004080 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004081#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004082
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004083#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004084 mbedtls_free( ssl->cli_id );
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004085#endif
4086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= free" ) );
Paul Bakker2da561c2009-02-05 18:00:28 +00004088
Paul Bakker86f04f42013-02-14 11:20:09 +01004089 /* Actually clear after last debug message */
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004090 mbedtls_platform_zeroize( ssl, sizeof( mbedtls_ssl_context ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004091}
4092
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004093/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004094 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004095 */
4096void mbedtls_ssl_config_init( mbedtls_ssl_config *conf )
4097{
4098 memset( conf, 0, sizeof( mbedtls_ssl_config ) );
4099}
4100
Gilles Peskineae270bf2021-06-02 00:05:29 +02004101/* The selection should be the same as mbedtls_x509_crt_profile_default in
4102 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004103 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004104 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004105 * about this list.
4106 */
Brett Warrene0edc842021-08-17 09:53:13 +01004107static uint16_t ssl_preset_default_groups[] = {
Gilles Peskineae270bf2021-06-02 00:05:29 +02004108#if defined(MBEDTLS_ECP_DP_CURVE25519_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004109 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004110#endif
4111#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004112 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004113#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004114#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004115 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004116#endif
4117#if defined(MBEDTLS_ECP_DP_CURVE448_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004118 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004119#endif
4120#if defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004121 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004122#endif
Gilles Peskineae270bf2021-06-02 00:05:29 +02004123#if defined(MBEDTLS_ECP_DP_BP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004124 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004125#endif
Gilles Peskineb1940a72021-06-02 15:18:12 +02004126#if defined(MBEDTLS_ECP_DP_BP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004127 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004128#endif
4129#if defined(MBEDTLS_ECP_DP_BP512R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004130 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004131#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004132 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004133};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004134
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004135static int ssl_preset_suiteb_ciphersuites[] = {
4136 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4137 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4138 0
4139};
4140
Gilles Peskineeccd8882020-03-10 12:19:08 +01004141#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004142
Jerry Yu909df7b2022-01-22 11:56:27 +08004143/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004144 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004145 * rules SHOULD be upheld.
4146 * - No duplicate entries.
4147 * - But if there is a good reason, do not change the order of the algorithms.
4148 * - ssl_tls12_present* is for TLS 1.2 use only.
4149 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004150 *
Jerry Yua1255e62022-06-24 10:10:47 +08004151 * When GnuTLS/Openssl server is configured in TLS 1.2 mode with a certificate
4152 * declaring an RSA public key and Mbed TLS is configured in hybrid mode, if
4153 * `rsa_pss_rsae_*` algorithms are before `rsa_pkcs1_*` ones in this list then
Jerry Yucc539102022-06-27 16:27:35 +08004154 * the GnuTLS/Openssl server chooses an `rsa_pss_rsae_*` signature algorithm
4155 * for its signature in the key exchange message. As Mbed TLS 1.2 does not
Jerry Yua1255e62022-06-24 10:10:47 +08004156 * support them, the handshake fails.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004157 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004158static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004159
Jerry Yued5e9f42022-01-26 11:21:34 +08004160#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4161 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4162 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4163#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4164 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004165
Jerry Yu909df7b2022-01-22 11:56:27 +08004166#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4167 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4168 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4169#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4170 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
4171
Jerry Yued5e9f42022-01-26 11:21:34 +08004172#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA512_C) && \
4173 defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
4174 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
4175#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4176 MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004177
Ronald Cron8540cf62022-03-16 08:01:09 +01004178#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA512_C)
4179 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
4180#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA512_C */
4181
4182#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA384_C)
4183 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
4184#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA384_C */
4185
Jerry Yu53037892022-01-25 11:02:06 +08004186#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4187 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4188#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4189
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004190#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA512_C)
4191 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
4192#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA512_C */
4193
4194#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA384_C)
4195 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
4196#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA384_C */
4197
4198#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4199 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4200#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
4201
Gabor Mezei15b95a62022-05-09 16:37:58 +02004202 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004203};
4204
4205/* NOTICE: see above */
4206#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4207static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004208#if defined(MBEDTLS_SHA512_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004209#if defined(MBEDTLS_ECDSA_C)
4210 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004211#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004212#if defined(MBEDTLS_RSA_C)
4213 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512 ),
4214#endif
4215#endif /* MBEDTLS_SHA512_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004216#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004217#if defined(MBEDTLS_ECDSA_C)
4218 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004219#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004220#if defined(MBEDTLS_RSA_C)
4221 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4222#endif
4223#endif /* MBEDTLS_SHA384_C */
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004224#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004225#if defined(MBEDTLS_ECDSA_C)
4226 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08004227#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004228#if defined(MBEDTLS_RSA_C)
4229 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4230#endif
4231#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004232 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08004233};
4234#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4235/* NOTICE: see above */
4236static uint16_t ssl_preset_suiteb_sig_algs[] = {
4237
Jerry Yu909df7b2022-01-22 11:56:27 +08004238#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA256_C) && \
4239 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
4240 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
4241#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA256_C &&
4242 MBEDTLS_ECP_DP_SECP256R1_ENABLED */
4243
Jerry Yu53037892022-01-25 11:02:06 +08004244#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_SHA384_C) && \
4245 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
4246 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
4247#endif /* MBEDTLS_ECDSA_C && MBEDTLS_SHA384_C &&
4248 MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu909df7b2022-01-22 11:56:27 +08004249
4250#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_SHA256_C)
4251 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
4252#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_SHA256_C */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004253
Jerry Yu53037892022-01-25 11:02:06 +08004254#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_SHA256_C)
4255 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
4256#endif /* MBEDTLS_RSA_C && MBEDTLS_SHA256_C */
4257
Gabor Mezei15b95a62022-05-09 16:37:58 +02004258 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08004259};
Jerry Yu6106fdc2022-01-12 16:36:14 +08004260
Jerry Yu909df7b2022-01-22 11:56:27 +08004261/* NOTICE: see above */
4262#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4263static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Jerry Yu713013f2022-01-17 18:16:35 +08004264#if defined(MBEDTLS_SHA256_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004265#if defined(MBEDTLS_ECDSA_C)
4266 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256 ),
Jerry Yu713013f2022-01-17 18:16:35 +08004267#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004268#if defined(MBEDTLS_RSA_C)
4269 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256 ),
4270#endif
4271#endif /* MBEDTLS_SHA256_C */
Jerry Yu18c833e2022-01-25 10:55:47 +08004272#if defined(MBEDTLS_SHA384_C)
Gabor Mezeic1051b62022-05-10 13:13:58 +02004273#if defined(MBEDTLS_ECDSA_C)
4274 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384 ),
Jerry Yu18c833e2022-01-25 10:55:47 +08004275#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02004276#if defined(MBEDTLS_RSA_C)
4277 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384 ),
4278#endif
4279#endif /* MBEDTLS_SHA256_C */
Gabor Mezei15b95a62022-05-09 16:37:58 +02004280 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004281};
Jerry Yu909df7b2022-01-22 11:56:27 +08004282#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4283
Jerry Yu1a8b4812022-01-20 17:56:50 +08004284#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004285
Brett Warrene0edc842021-08-17 09:53:13 +01004286static uint16_t ssl_preset_suiteb_groups[] = {
Jaeden Amerod4311042019-06-03 08:27:16 +01004287#if defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004288 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004289#endif
4290#if defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Brett Warrene0edc842021-08-17 09:53:13 +01004291 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01004292#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004293 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004294};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004295
Jerry Yu1a8b4812022-01-20 17:56:50 +08004296#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004297/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08004298 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004299MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf377d642022-01-25 10:43:59 +08004300static int ssl_check_no_sig_alg_duplication( uint16_t * sig_algs )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004301{
4302 size_t i, j;
4303 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08004304
Gabor Mezei15b95a62022-05-09 16:37:58 +02004305 for( i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004306 {
Jerry Yuf377d642022-01-25 10:43:59 +08004307 for( j = 0; j < i; j++ )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004308 {
Jerry Yuf377d642022-01-25 10:43:59 +08004309 if( sig_algs[i] != sig_algs[j] )
4310 continue;
4311 mbedtls_printf( " entry(%04x,%" MBEDTLS_PRINTF_SIZET
4312 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
4313 sig_algs[i], j, i );
4314 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08004315 }
4316 }
4317 return( ret );
4318}
4319
4320#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4321
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004322/*
Tillmann Karras588ad502015-09-25 04:27:22 +02004323 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004324 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004325int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004326 int endpoint, int transport, int preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004327{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004328#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00004329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02004330#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004331
Jerry Yu1a8b4812022-01-20 17:56:50 +08004332#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yuf377d642022-01-25 10:43:59 +08004333 if( ssl_check_no_sig_alg_duplication( ssl_preset_suiteb_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004334 {
4335 mbedtls_printf( "ssl_preset_suiteb_sig_algs has duplicated entries\n" );
4336 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4337 }
4338
Jerry Yuf377d642022-01-25 10:43:59 +08004339 if( ssl_check_no_sig_alg_duplication( ssl_preset_default_sig_algs ) )
Jerry Yu1a8b4812022-01-20 17:56:50 +08004340 {
4341 mbedtls_printf( "ssl_preset_default_sig_algs has duplicated entries\n" );
4342 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4343 }
Jerry Yu909df7b2022-01-22 11:56:27 +08004344
4345#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yuf377d642022-01-25 10:43:59 +08004346 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_suiteb_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004347 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004348 mbedtls_printf( "ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004349 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4350 }
4351
Jerry Yuf377d642022-01-25 10:43:59 +08004352 if( ssl_check_no_sig_alg_duplication( ssl_tls12_preset_default_sig_algs ) )
Jerry Yu909df7b2022-01-22 11:56:27 +08004353 {
Jerry Yu909df7b2022-01-22 11:56:27 +08004354 mbedtls_printf( "ssl_tls12_preset_default_sig_algs has duplicated entries\n" );
Jerry Yu909df7b2022-01-22 11:56:27 +08004355 return( MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED );
4356 }
4357#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yu1a8b4812022-01-20 17:56:50 +08004358#endif /* MBEDTLS_DEBUG_C && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
4359
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02004360 /* Use the functions here so that they are covered in tests,
4361 * but otherwise access member directly for efficiency */
4362 mbedtls_ssl_conf_endpoint( conf, endpoint );
4363 mbedtls_ssl_conf_transport( conf, transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004364
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004365 /*
4366 * Things that are common to all presets
4367 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004368#if defined(MBEDTLS_SSL_CLI_C)
4369 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4370 {
4371 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
4372#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4373 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
4374#endif
4375 }
4376#endif
4377
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004378#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4379 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
4380#endif
4381
4382#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
4383 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
4384#endif
4385
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004386#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004387 conf->f_cookie_write = ssl_cookie_write_dummy;
4388 conf->f_cookie_check = ssl_cookie_check_dummy;
4389#endif
4390
4391#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4392 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
4393#endif
4394
Janos Follath088ce432017-04-10 12:42:31 +01004395#if defined(MBEDTLS_SSL_SRV_C)
4396 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02004397 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01004398#endif
4399
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004400#if defined(MBEDTLS_SSL_PROTO_DTLS)
4401 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
4402 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
4403#endif
4404
4405#if defined(MBEDTLS_SSL_RENEGOTIATION)
4406 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Andres AG2196c7f2016-12-15 17:01:16 +00004407 memset( conf->renego_period, 0x00, 2 );
4408 memset( conf->renego_period + 2, 0xFF, 6 );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004409#endif
4410
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004411#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckere2defad2021-07-24 05:59:17 +01004412 if( endpoint == MBEDTLS_SSL_IS_SERVER )
4413 {
4414 const unsigned char dhm_p[] =
4415 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
4416 const unsigned char dhm_g[] =
4417 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01004418
Hanno Beckere2defad2021-07-24 05:59:17 +01004419 if ( ( ret = mbedtls_ssl_conf_dh_param_bin( conf,
4420 dhm_p, sizeof( dhm_p ),
4421 dhm_g, sizeof( dhm_g ) ) ) != 0 )
4422 {
4423 return( ret );
4424 }
4425 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02004426#endif
4427
Ronald Cron6f135e12021-12-08 16:57:54 +01004428#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01004429 /*
4430 * Allow all TLS 1.3 key exchange modes by default.
4431 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00004432 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01004433#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01004434
XiaokangQian4d3a6042022-04-21 13:46:17 +00004435 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4436 {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004437#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00004438 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00004439 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00004440#else
XiaokangQian060d8672022-04-21 09:24:56 +00004441 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian060d8672022-04-21 09:24:56 +00004442#endif
XiaokangQian4d3a6042022-04-21 13:46:17 +00004443 }
4444 else
4445 {
4446#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4447 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
4448 {
4449 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4450 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4451 }
4452 else
4453 /* Hybrid TLS 1.2 / 1.3 is not supported on server side yet */
4454 {
4455 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4456 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4457 }
4458#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
4459 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4460 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
4461#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4462 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4463 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
4464#else
4465 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
4466#endif
4467 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004468
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004469 /*
4470 * Preset-specific defaults
4471 */
4472 switch( preset )
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004473 {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004474 /*
4475 * NSA Suite B
4476 */
4477 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004478
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004479 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004480
4481#if defined(MBEDTLS_X509_CRT_PARSE_C)
4482 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004483#endif
4484
Gilles Peskineeccd8882020-03-10 12:19:08 +01004485#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004486#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4487 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4488 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
4489 else
4490#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4491 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004492#endif
4493
Brett Warrene0edc842021-08-17 09:53:13 +01004494#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4495 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004496#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004497 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02004498 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004499
4500 /*
4501 * Default
4502 */
4503 default:
Ronald Cronf6606552022-03-15 11:23:25 +01004504
Hanno Beckerd60b6c62021-04-29 12:04:11 +01004505 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004506
4507#if defined(MBEDTLS_X509_CRT_PARSE_C)
4508 conf->cert_profile = &mbedtls_x509_crt_profile_default;
4509#endif
4510
Gilles Peskineeccd8882020-03-10 12:19:08 +01004511#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08004512#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
4513 if( mbedtls_ssl_conf_is_tls12_only( conf ) )
4514 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
4515 else
4516#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4517 conf->sig_algs = ssl_preset_default_sig_algs;
Hanno Beckerdeb68ce2021-08-10 16:04:05 +01004518#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004519
Brett Warrene0edc842021-08-17 09:53:13 +01004520#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
4521 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004522#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004523 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004524
4525#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
4526 conf->dhm_min_bitlen = 1024;
4527#endif
4528 }
4529
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004530 return( 0 );
4531}
4532
4533/*
4534 * Free mbedtls_ssl_config
4535 */
4536void mbedtls_ssl_config_free( mbedtls_ssl_config *conf )
4537{
4538#if defined(MBEDTLS_DHM_C)
4539 mbedtls_mpi_free( &conf->dhm_P );
4540 mbedtls_mpi_free( &conf->dhm_G );
4541#endif
4542
Gilles Peskineeccd8882020-03-10 12:19:08 +01004543#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004544#if defined(MBEDTLS_USE_PSA_CRYPTO)
4545 if( ! mbedtls_svc_key_id_is_null( conf->psk_opaque ) )
4546 {
Neil Armstrong501c9322022-05-03 09:35:09 +02004547 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4548 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02004549#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004550 if( conf->psk != NULL )
4551 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004552 mbedtls_platform_zeroize( conf->psk, conf->psk_len );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004553 mbedtls_free( conf->psk );
Azim Khan27e8a122018-03-21 14:24:11 +00004554 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004555 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09004556 }
4557
4558 if( conf->psk_identity != NULL )
4559 {
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004560 mbedtls_platform_zeroize( conf->psk_identity, conf->psk_identity_len );
junyeonLEE316b1622017-12-20 16:29:30 +09004561 mbedtls_free( conf->psk_identity );
Azim Khan27e8a122018-03-21 14:24:11 +00004562 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004563 conf->psk_identity_len = 0;
4564 }
4565#endif
4566
4567#if defined(MBEDTLS_X509_CRT_PARSE_C)
4568 ssl_key_cert_free( conf->key_cert );
4569#endif
4570
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05004571 mbedtls_platform_zeroize( conf, sizeof( mbedtls_ssl_config ) );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004572}
4573
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004574#if defined(MBEDTLS_PK_C) && \
4575 ( defined(MBEDTLS_RSA_C) || defined(MBEDTLS_ECDSA_C) )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004576/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004577 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk )
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004580{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581#if defined(MBEDTLS_RSA_C)
4582 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_RSA ) )
4583 return( MBEDTLS_SSL_SIG_RSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004584#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585#if defined(MBEDTLS_ECDSA_C)
4586 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECDSA ) )
4587 return( MBEDTLS_SSL_SIG_ECDSA );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004588#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004589 return( MBEDTLS_SSL_SIG_ANON );
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02004590}
4591
Hanno Becker7e5437a2017-04-28 17:15:26 +01004592unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type )
4593{
4594 switch( type ) {
4595 case MBEDTLS_PK_RSA:
4596 return( MBEDTLS_SSL_SIG_RSA );
4597 case MBEDTLS_PK_ECDSA:
4598 case MBEDTLS_PK_ECKEY:
4599 return( MBEDTLS_SSL_SIG_ECDSA );
4600 default:
4601 return( MBEDTLS_SSL_SIG_ANON );
4602 }
4603}
4604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004606{
4607 switch( sig )
4608 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609#if defined(MBEDTLS_RSA_C)
4610 case MBEDTLS_SSL_SIG_RSA:
4611 return( MBEDTLS_PK_RSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004612#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613#if defined(MBEDTLS_ECDSA_C)
4614 case MBEDTLS_SSL_SIG_ECDSA:
4615 return( MBEDTLS_PK_ECDSA );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004616#endif
4617 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618 return( MBEDTLS_PK_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004619 }
4620}
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02004621#endif /* MBEDTLS_PK_C && ( MBEDTLS_RSA_C || MBEDTLS_ECDSA_C ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004622
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004623/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004624 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02004625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash )
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004627{
4628 switch( hash )
4629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004630#if defined(MBEDTLS_MD5_C)
4631 case MBEDTLS_SSL_HASH_MD5:
4632 return( MBEDTLS_MD_MD5 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004633#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634#if defined(MBEDTLS_SHA1_C)
4635 case MBEDTLS_SSL_HASH_SHA1:
4636 return( MBEDTLS_MD_SHA1 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004637#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004638#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639 case MBEDTLS_SSL_HASH_SHA224:
4640 return( MBEDTLS_MD_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004641#endif
4642#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643 case MBEDTLS_SSL_HASH_SHA256:
4644 return( MBEDTLS_MD_SHA256 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004645#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004646#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004647 case MBEDTLS_SSL_HASH_SHA384:
4648 return( MBEDTLS_MD_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004649#endif
4650#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004651 case MBEDTLS_SSL_HASH_SHA512:
4652 return( MBEDTLS_MD_SHA512 );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004653#endif
4654 default:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655 return( MBEDTLS_MD_NONE );
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02004656 }
4657}
4658
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004659/*
4660 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
4661 */
4662unsigned char mbedtls_ssl_hash_from_md_alg( int md )
4663{
4664 switch( md )
4665 {
4666#if defined(MBEDTLS_MD5_C)
4667 case MBEDTLS_MD_MD5:
4668 return( MBEDTLS_SSL_HASH_MD5 );
4669#endif
4670#if defined(MBEDTLS_SHA1_C)
4671 case MBEDTLS_MD_SHA1:
4672 return( MBEDTLS_SSL_HASH_SHA1 );
4673#endif
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004674#if defined(MBEDTLS_SHA224_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004675 case MBEDTLS_MD_SHA224:
4676 return( MBEDTLS_SSL_HASH_SHA224 );
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02004677#endif
4678#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004679 case MBEDTLS_MD_SHA256:
4680 return( MBEDTLS_SSL_HASH_SHA256 );
4681#endif
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004682#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004683 case MBEDTLS_MD_SHA384:
4684 return( MBEDTLS_SSL_HASH_SHA384 );
Mateusz Starzyk3352a532021-04-06 14:28:22 +02004685#endif
4686#if defined(MBEDTLS_SHA512_C)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004687 case MBEDTLS_MD_SHA512:
4688 return( MBEDTLS_SSL_HASH_SHA512 );
4689#endif
4690 default:
4691 return( MBEDTLS_SSL_HASH_NONE );
4692 }
4693}
4694
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004695/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02004696 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004697 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004698 */
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004699int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id )
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004700{
Brett Warrene0edc842021-08-17 09:53:13 +01004701 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004702
Brett Warrene0edc842021-08-17 09:53:13 +01004703 if( group_list == NULL )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004704 return( -1 );
4705
Brett Warrene0edc842021-08-17 09:53:13 +01004706 for( ; *group_list != 0; group_list++ )
4707 {
4708 if( *group_list == tls_id )
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004709 return( 0 );
Brett Warrene0edc842021-08-17 09:53:13 +01004710 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004711
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02004712 return( -1 );
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01004713}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004714
4715#if defined(MBEDTLS_ECP_C)
4716/*
4717 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
4718 */
4719int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id )
4720{
Manuel Pégourié-Gonnard422370d2022-02-07 11:55:21 +01004721 uint16_t tls_id = mbedtls_ecp_curve_info_from_grp_id( grp_id )->tls_id;
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01004722 return mbedtls_ssl_check_curve_tls_id( ssl, tls_id );
4723}
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02004724#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726#if defined(MBEDTLS_X509_CRT_PARSE_C)
4727int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
4728 const mbedtls_ssl_ciphersuite_t *ciphersuite,
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004729 int cert_endpoint,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02004730 uint32_t *flags )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004731{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004732 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004733 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004734 const char *ext_oid;
4735 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004737 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004738 {
4739 /* Server part of the key exchange */
4740 switch( ciphersuite->key_exchange )
4741 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 case MBEDTLS_KEY_EXCHANGE_RSA:
4743 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004744 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004745 break;
4746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
4748 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
4749 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
4750 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004751 break;
4752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
4754 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004755 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004756 break;
4757
4758 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 case MBEDTLS_KEY_EXCHANGE_NONE:
4760 case MBEDTLS_KEY_EXCHANGE_PSK:
4761 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
4762 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02004763 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004764 usage = 0;
4765 }
4766 }
4767 else
4768 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
4770 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004771 }
4772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004773 if( mbedtls_x509_crt_check_key_usage( cert, usage ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004774 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004775 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004776 ret = -1;
4777 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779 if( cert_endpoint == MBEDTLS_SSL_IS_SERVER )
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004781 ext_oid = MBEDTLS_OID_SERVER_AUTH;
4782 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004783 }
4784 else
4785 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
4787 ext_len = MBEDTLS_OID_SIZE( MBEDTLS_OID_CLIENT_AUTH );
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004788 }
4789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790 if( mbedtls_x509_crt_check_extended_key_usage( cert, ext_oid, ext_len ) != 0 )
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004791 {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01004792 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004793 ret = -1;
4794 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02004795
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01004796 return( ret );
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02004797}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02004799
Jerry Yu148165c2021-09-24 23:20:59 +08004800#if defined(MBEDTLS_USE_PSA_CRYPTO)
4801int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4802 const mbedtls_md_type_t md,
4803 unsigned char *dst,
4804 size_t dst_len,
4805 size_t *olen )
4806{
Ronald Cronf6893e12022-01-07 22:09:01 +01004807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4808 psa_hash_operation_t *hash_operation_to_clone;
4809 psa_hash_operation_t hash_operation = psa_hash_operation_init();
4810
Jerry Yu148165c2021-09-24 23:20:59 +08004811 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01004812
4813 switch( md )
4814 {
4815#if defined(MBEDTLS_SHA384_C)
4816 case MBEDTLS_MD_SHA384:
4817 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
4818 break;
4819#endif
4820
4821#if defined(MBEDTLS_SHA256_C)
4822 case MBEDTLS_MD_SHA256:
4823 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
4824 break;
4825#endif
4826
4827 default:
4828 goto exit;
4829 }
4830
4831 status = psa_hash_clone( hash_operation_to_clone, &hash_operation );
4832 if( status != PSA_SUCCESS )
4833 goto exit;
4834
4835 status = psa_hash_finish( &hash_operation, dst, dst_len, olen );
4836 if( status != PSA_SUCCESS )
4837 goto exit;
4838
4839exit:
Ronald Cronb788c042022-02-15 09:14:15 +01004840 return( psa_ssl_status_to_mbedtls( status ) );
Jerry Yu148165c2021-09-24 23:20:59 +08004841}
4842#else /* MBEDTLS_USE_PSA_CRYPTO */
4843
Jerry Yu24c0ec32021-09-09 14:21:07 +08004844#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004845MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004846static int ssl_get_handshake_transcript_sha384( mbedtls_ssl_context *ssl,
4847 unsigned char *dst,
4848 size_t dst_len,
4849 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004850{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004851 int ret;
4852 mbedtls_sha512_context sha512;
4853
4854 if( dst_len < 48 )
4855 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4856
4857 mbedtls_sha512_init( &sha512 );
4858 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
4859
4860 if( ( ret = mbedtls_sha512_finish( &sha512, dst ) ) != 0 )
4861 {
4862 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha512_finish", ret );
4863 goto exit;
4864 }
4865
4866 *olen = 48;
4867
4868exit:
4869
4870 mbedtls_sha512_free( &sha512 );
4871 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004872}
4873#endif /* MBEDTLS_SHA384_C */
4874
4875#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004876MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08004877static int ssl_get_handshake_transcript_sha256( mbedtls_ssl_context *ssl,
4878 unsigned char *dst,
4879 size_t dst_len,
4880 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004881{
Jerry Yu24c0ec32021-09-09 14:21:07 +08004882 int ret;
4883 mbedtls_sha256_context sha256;
4884
4885 if( dst_len < 32 )
4886 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4887
4888 mbedtls_sha256_init( &sha256 );
4889 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
Jerry Yuc5aef882021-12-23 20:15:02 +08004890
Jerry Yu24c0ec32021-09-09 14:21:07 +08004891 if( ( ret = mbedtls_sha256_finish( &sha256, dst ) ) != 0 )
4892 {
4893 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_sha256_finish", ret );
4894 goto exit;
4895 }
4896
4897 *olen = 32;
4898
4899exit:
4900
4901 mbedtls_sha256_free( &sha256 );
4902 return( ret );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004903}
4904#endif /* MBEDTLS_SHA256_C */
4905
Jerry Yu000f9762021-09-14 11:12:51 +08004906int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
4907 const mbedtls_md_type_t md,
4908 unsigned char *dst,
4909 size_t dst_len,
4910 size_t *olen )
Jerry Yu24c0ec32021-09-09 14:21:07 +08004911{
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004912 switch( md )
4913 {
4914
Jerry Yu24c0ec32021-09-09 14:21:07 +08004915#if defined(MBEDTLS_SHA384_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004916 case MBEDTLS_MD_SHA384:
Jerry Yuc5aef882021-12-23 20:15:02 +08004917 return( ssl_get_handshake_transcript_sha384( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004918#endif /* MBEDTLS_SHA384_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004919
Jerry Yu24c0ec32021-09-09 14:21:07 +08004920#if defined(MBEDTLS_SHA256_C)
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004921 case MBEDTLS_MD_SHA256:
Jerry Yuc5aef882021-12-23 20:15:02 +08004922 return( ssl_get_handshake_transcript_sha256( ssl, dst, dst_len, olen ) );
Jerry Yuc10f6b42021-12-23 17:16:42 +08004923#endif /* MBEDTLS_SHA256_C */
Jerry Yuc1ddeef2021-10-08 15:14:45 +08004924
4925 default:
4926 break;
4927 }
Jerry Yuc5aef882021-12-23 20:15:02 +08004928 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu24c0ec32021-09-09 14:21:07 +08004929}
XiaokangQian647719a2021-12-07 09:16:29 +00004930
Jerry Yu148165c2021-09-24 23:20:59 +08004931#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08004932
Gabor Mezei078e8032022-04-27 21:17:56 +02004933#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
4934/* mbedtls_ssl_parse_sig_alg_ext()
4935 *
4936 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
4937 * value (TLS 1.3 RFC8446):
4938 * enum {
4939 * ....
4940 * ecdsa_secp256r1_sha256( 0x0403 ),
4941 * ecdsa_secp384r1_sha384( 0x0503 ),
4942 * ecdsa_secp521r1_sha512( 0x0603 ),
4943 * ....
4944 * } SignatureScheme;
4945 *
4946 * struct {
4947 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
4948 * } SignatureSchemeList;
4949 *
4950 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
4951 * value (TLS 1.2 RFC5246):
4952 * enum {
4953 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
4954 * sha512(6), (255)
4955 * } HashAlgorithm;
4956 *
4957 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
4958 * SignatureAlgorithm;
4959 *
4960 * struct {
4961 * HashAlgorithm hash;
4962 * SignatureAlgorithm signature;
4963 * } SignatureAndHashAlgorithm;
4964 *
4965 * SignatureAndHashAlgorithm
4966 * supported_signature_algorithms<2..2^16-2>;
4967 *
4968 * The TLS 1.3 signature algorithm extension was defined to be a compatible
4969 * generalization of the TLS 1.2 signature algorithm extension.
4970 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
4971 * `SignatureScheme` field of TLS 1.3
4972 *
4973 */
4974int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
4975 const unsigned char *buf,
4976 const unsigned char *end )
4977{
4978 const unsigned char *p = buf;
4979 size_t supported_sig_algs_len = 0;
4980 const unsigned char *supported_sig_algs_end;
4981 uint16_t sig_alg;
4982 uint32_t common_idx = 0;
4983
4984 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
4985 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE( p, 0 );
4986 p += 2;
4987
4988 memset( ssl->handshake->received_sig_algs, 0,
4989 sizeof(ssl->handshake->received_sig_algs) );
4990
4991 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, supported_sig_algs_len );
4992 supported_sig_algs_end = p + supported_sig_algs_len;
4993 while( p < supported_sig_algs_end )
4994 {
4995 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, supported_sig_algs_end, 2 );
4996 sig_alg = MBEDTLS_GET_UINT16_BE( p, 0 );
4997 p += 2;
Jerry Yuf3b46b52022-06-19 16:52:27 +08004998 MBEDTLS_SSL_DEBUG_MSG( 4, ( "received signature algorithm: 0x%x %s",
4999 sig_alg,
5000 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Jerry Yu2fe6c632022-06-29 10:02:38 +08005001#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu52b7d922022-07-01 18:03:31 +08005002 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
Jerry Yu2fe6c632022-06-29 10:02:38 +08005003 ( ! ( mbedtls_ssl_sig_alg_is_supported( ssl, sig_alg ) &&
5004 mbedtls_ssl_sig_alg_is_offered( ssl, sig_alg ) ) ) )
5005 {
Gabor Mezei078e8032022-04-27 21:17:56 +02005006 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005007 }
5008#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005009
Jerry Yuf3b46b52022-06-19 16:52:27 +08005010 MBEDTLS_SSL_DEBUG_MSG( 4, ( "valid signature algorithm: %s",
5011 mbedtls_ssl_sig_alg_to_str( sig_alg ) ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02005012
5013 if( common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE )
5014 {
5015 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5016 common_idx += 1;
5017 }
5018 }
5019 /* Check that we consumed all the message. */
5020 if( p != end )
5021 {
5022 MBEDTLS_SSL_DEBUG_MSG( 1,
5023 ( "Signature algorithms extension length misaligned" ) );
5024 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5025 MBEDTLS_ERR_SSL_DECODE_ERROR );
5026 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
5027 }
5028
5029 if( common_idx == 0 )
5030 {
5031 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no signature algorithm in common" ) );
5032 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5033 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5034 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
5035 }
5036
Gabor Mezei15b95a62022-05-09 16:37:58 +02005037 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005038 return( 0 );
5039}
5040
5041#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5042
Jerry Yudc7bd172022-02-17 13:44:15 +08005043#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5044
5045#if defined(MBEDTLS_USE_PSA_CRYPTO)
5046
5047static psa_status_t setup_psa_key_derivation( psa_key_derivation_operation_t* derivation,
5048 mbedtls_svc_key_id_t key,
5049 psa_algorithm_t alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005050 const unsigned char* raw_psk, size_t raw_psk_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005051 const unsigned char* seed, size_t seed_length,
5052 const unsigned char* label, size_t label_length,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005053 const unsigned char* other_secret,
5054 size_t other_secret_length,
Jerry Yudc7bd172022-02-17 13:44:15 +08005055 size_t capacity )
5056{
5057 psa_status_t status;
5058
5059 status = psa_key_derivation_setup( derivation, alg );
5060 if( status != PSA_SUCCESS )
5061 return( status );
5062
5063 if( PSA_ALG_IS_TLS12_PRF( alg ) || PSA_ALG_IS_TLS12_PSK_TO_MS( alg ) )
5064 {
5065 status = psa_key_derivation_input_bytes( derivation,
5066 PSA_KEY_DERIVATION_INPUT_SEED,
5067 seed, seed_length );
5068 if( status != PSA_SUCCESS )
5069 return( status );
5070
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005071 if ( other_secret != NULL )
Przemek Stekiel1f027032022-04-05 17:12:11 +02005072 {
5073 status = psa_key_derivation_input_bytes( derivation,
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005074 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
5075 other_secret, other_secret_length );
Przemek Stekiel1f027032022-04-05 17:12:11 +02005076 if( status != PSA_SUCCESS )
5077 return( status );
5078 }
5079
Jerry Yudc7bd172022-02-17 13:44:15 +08005080 if( mbedtls_svc_key_id_is_null( key ) )
5081 {
5082 status = psa_key_derivation_input_bytes(
5083 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005084 raw_psk, raw_psk_length );
Jerry Yudc7bd172022-02-17 13:44:15 +08005085 }
5086 else
5087 {
5088 status = psa_key_derivation_input_key(
5089 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key );
5090 }
5091 if( status != PSA_SUCCESS )
5092 return( status );
5093
5094 status = psa_key_derivation_input_bytes( derivation,
5095 PSA_KEY_DERIVATION_INPUT_LABEL,
5096 label, label_length );
5097 if( status != PSA_SUCCESS )
5098 return( status );
5099 }
5100 else
5101 {
5102 return( PSA_ERROR_NOT_SUPPORTED );
5103 }
5104
5105 status = psa_key_derivation_set_capacity( derivation, capacity );
5106 if( status != PSA_SUCCESS )
5107 return( status );
5108
5109 return( PSA_SUCCESS );
5110}
5111
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005112MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005113static int tls_prf_generic( mbedtls_md_type_t md_type,
5114 const unsigned char *secret, size_t slen,
5115 const char *label,
5116 const unsigned char *random, size_t rlen,
5117 unsigned char *dstbuf, size_t dlen )
5118{
5119 psa_status_t status;
5120 psa_algorithm_t alg;
5121 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
5122 psa_key_derivation_operation_t derivation =
5123 PSA_KEY_DERIVATION_OPERATION_INIT;
5124
5125 if( md_type == MBEDTLS_MD_SHA384 )
5126 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
5127 else
5128 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
5129
5130 /* Normally a "secret" should be long enough to be impossible to
5131 * find by brute force, and in particular should not be empty. But
5132 * this PRF is also used to derive an IV, in particular in EAP-TLS,
5133 * and for this use case it makes sense to have a 0-length "secret".
5134 * Since the key API doesn't allow importing a key of length 0,
5135 * keep master_key=0, which setup_psa_key_derivation() understands
5136 * to mean a 0-length "secret" input. */
5137 if( slen != 0 )
5138 {
5139 psa_key_attributes_t key_attributes = psa_key_attributes_init();
5140 psa_set_key_usage_flags( &key_attributes, PSA_KEY_USAGE_DERIVE );
5141 psa_set_key_algorithm( &key_attributes, alg );
5142 psa_set_key_type( &key_attributes, PSA_KEY_TYPE_DERIVE );
5143
5144 status = psa_import_key( &key_attributes, secret, slen, &master_key );
5145 if( status != PSA_SUCCESS )
5146 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5147 }
5148
5149 status = setup_psa_key_derivation( &derivation,
5150 master_key, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005151 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005152 random, rlen,
5153 (unsigned char const *) label,
5154 (size_t) strlen( label ),
Przemek Stekiel1f027032022-04-05 17:12:11 +02005155 NULL, 0,
Jerry Yudc7bd172022-02-17 13:44:15 +08005156 dlen );
5157 if( status != PSA_SUCCESS )
5158 {
5159 psa_key_derivation_abort( &derivation );
5160 psa_destroy_key( master_key );
5161 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5162 }
5163
5164 status = psa_key_derivation_output_bytes( &derivation, dstbuf, dlen );
5165 if( status != PSA_SUCCESS )
5166 {
5167 psa_key_derivation_abort( &derivation );
5168 psa_destroy_key( master_key );
5169 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5170 }
5171
5172 status = psa_key_derivation_abort( &derivation );
5173 if( status != PSA_SUCCESS )
5174 {
5175 psa_destroy_key( master_key );
5176 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5177 }
5178
5179 if( ! mbedtls_svc_key_id_is_null( master_key ) )
5180 status = psa_destroy_key( master_key );
5181 if( status != PSA_SUCCESS )
5182 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5183
5184 return( 0 );
5185}
5186
5187#else /* MBEDTLS_USE_PSA_CRYPTO */
5188
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005189MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005190static int tls_prf_generic( mbedtls_md_type_t md_type,
5191 const unsigned char *secret, size_t slen,
5192 const char *label,
5193 const unsigned char *random, size_t rlen,
5194 unsigned char *dstbuf, size_t dlen )
5195{
5196 size_t nb;
5197 size_t i, j, k, md_len;
5198 unsigned char *tmp;
5199 size_t tmp_len = 0;
5200 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
5201 const mbedtls_md_info_t *md_info;
5202 mbedtls_md_context_t md_ctx;
5203 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5204
5205 mbedtls_md_init( &md_ctx );
5206
5207 if( ( md_info = mbedtls_md_info_from_type( md_type ) ) == NULL )
5208 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5209
5210 md_len = mbedtls_md_get_size( md_info );
5211
5212 tmp_len = md_len + strlen( label ) + rlen;
5213 tmp = mbedtls_calloc( 1, tmp_len );
5214 if( tmp == NULL )
5215 {
5216 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
5217 goto exit;
5218 }
5219
5220 nb = strlen( label );
5221 memcpy( tmp + md_len, label, nb );
5222 memcpy( tmp + md_len + nb, random, rlen );
5223 nb += rlen;
5224
5225 /*
5226 * Compute P_<hash>(secret, label + random)[0..dlen]
5227 */
5228 if ( ( ret = mbedtls_md_setup( &md_ctx, md_info, 1 ) ) != 0 )
5229 goto exit;
5230
5231 ret = mbedtls_md_hmac_starts( &md_ctx, secret, slen );
5232 if( ret != 0 )
5233 goto exit;
5234 ret = mbedtls_md_hmac_update( &md_ctx, tmp + md_len, nb );
5235 if( ret != 0 )
5236 goto exit;
5237 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5238 if( ret != 0 )
5239 goto exit;
5240
5241 for( i = 0; i < dlen; i += md_len )
5242 {
5243 ret = mbedtls_md_hmac_reset ( &md_ctx );
5244 if( ret != 0 )
5245 goto exit;
5246 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len + nb );
5247 if( ret != 0 )
5248 goto exit;
5249 ret = mbedtls_md_hmac_finish( &md_ctx, h_i );
5250 if( ret != 0 )
5251 goto exit;
5252
5253 ret = mbedtls_md_hmac_reset ( &md_ctx );
5254 if( ret != 0 )
5255 goto exit;
5256 ret = mbedtls_md_hmac_update( &md_ctx, tmp, md_len );
5257 if( ret != 0 )
5258 goto exit;
5259 ret = mbedtls_md_hmac_finish( &md_ctx, tmp );
5260 if( ret != 0 )
5261 goto exit;
5262
5263 k = ( i + md_len > dlen ) ? dlen % md_len : md_len;
5264
5265 for( j = 0; j < k; j++ )
5266 dstbuf[i + j] = h_i[j];
5267 }
5268
5269exit:
5270 mbedtls_md_free( &md_ctx );
5271
5272 mbedtls_platform_zeroize( tmp, tmp_len );
5273 mbedtls_platform_zeroize( h_i, sizeof( h_i ) );
5274
5275 mbedtls_free( tmp );
5276
5277 return( ret );
5278}
5279#endif /* MBEDTLS_USE_PSA_CRYPTO */
5280
5281#if defined(MBEDTLS_SHA256_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005282MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005283static int tls_prf_sha256( const unsigned char *secret, size_t slen,
5284 const char *label,
5285 const unsigned char *random, size_t rlen,
5286 unsigned char *dstbuf, size_t dlen )
5287{
5288 return( tls_prf_generic( MBEDTLS_MD_SHA256, secret, slen,
5289 label, random, rlen, dstbuf, dlen ) );
5290}
5291#endif /* MBEDTLS_SHA256_C */
5292
5293#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005294MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yudc7bd172022-02-17 13:44:15 +08005295static int tls_prf_sha384( const unsigned char *secret, size_t slen,
5296 const char *label,
5297 const unsigned char *random, size_t rlen,
5298 unsigned char *dstbuf, size_t dlen )
5299{
5300 return( tls_prf_generic( MBEDTLS_MD_SHA384, secret, slen,
5301 label, random, rlen, dstbuf, dlen ) );
5302}
5303#endif /* MBEDTLS_SHA384_C */
5304
Jerry Yuf009d862022-02-17 14:01:37 +08005305/*
5306 * Set appropriate PRF function and other SSL / TLS1.2 functions
5307 *
5308 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08005309 * - hash associated with the ciphersuite (only used by TLS 1.2)
5310 *
5311 * Outputs:
5312 * - the tls_prf, calc_verify and calc_finished members of handshake structure
5313 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005314MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf009d862022-02-17 14:01:37 +08005315static int ssl_set_handshake_prfs( mbedtls_ssl_handshake_params *handshake,
Jerry Yuf009d862022-02-17 14:01:37 +08005316 mbedtls_md_type_t hash )
5317{
Jerry Yuf009d862022-02-17 14:01:37 +08005318#if defined(MBEDTLS_SHA384_C)
Ronald Cron81591aa2022-03-07 09:05:51 +01005319 if( hash == MBEDTLS_MD_SHA384 )
Jerry Yuf009d862022-02-17 14:01:37 +08005320 {
5321 handshake->tls_prf = tls_prf_sha384;
5322 handshake->calc_verify = ssl_calc_verify_tls_sha384;
5323 handshake->calc_finished = ssl_calc_finished_tls_sha384;
5324 }
5325 else
5326#endif
5327#if defined(MBEDTLS_SHA256_C)
Jerry Yuf009d862022-02-17 14:01:37 +08005328 {
Ronald Cron81591aa2022-03-07 09:05:51 +01005329 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005330 handshake->tls_prf = tls_prf_sha256;
5331 handshake->calc_verify = ssl_calc_verify_tls_sha256;
5332 handshake->calc_finished = ssl_calc_finished_tls_sha256;
5333 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005334#else
Jerry Yuf009d862022-02-17 14:01:37 +08005335 {
Jerry Yuf009d862022-02-17 14:01:37 +08005336 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01005337 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08005338 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5339 }
Ronald Cron81591aa2022-03-07 09:05:51 +01005340#endif
Jerry Yuf009d862022-02-17 14:01:37 +08005341
5342 return( 0 );
5343}
Jerry Yud6ab2352022-02-17 14:03:43 +08005344
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005345/*
5346 * Compute master secret if needed
5347 *
5348 * Parameters:
5349 * [in/out] handshake
5350 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
5351 * (PSA-PSK) ciphersuite_info, psk_opaque
5352 * [out] premaster (cleared)
5353 * [out] master
5354 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
5355 * debug: conf->f_dbg, conf->p_dbg
5356 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01005357 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005358 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005359MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005360static int ssl_compute_master( mbedtls_ssl_handshake_params *handshake,
5361 unsigned char *master,
5362 const mbedtls_ssl_context *ssl )
5363{
5364 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5365
5366 /* cf. RFC 5246, Section 8.1:
5367 * "The master secret is always exactly 48 bytes in length." */
5368 size_t const master_secret_len = 48;
5369
5370#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5371 unsigned char session_hash[48];
5372#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
5373
5374 /* The label for the KDF used for key expansion.
5375 * This is either "master secret" or "extended master secret"
5376 * depending on whether the Extended Master Secret extension
5377 * is used. */
5378 char const *lbl = "master secret";
5379
Przemek Stekielae4ed302022-04-05 17:15:55 +02005380 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005381 * - If the Extended Master Secret extension is not used,
5382 * this is ClientHello.Random + ServerHello.Random
5383 * (see Sect. 8.1 in RFC 5246).
5384 * - If the Extended Master Secret extension is used,
5385 * this is the transcript of the handshake so far.
5386 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02005387 unsigned char const *seed = handshake->randbytes;
5388 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005389
5390#if !defined(MBEDTLS_DEBUG_C) && \
5391 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
5392 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
5393 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
5394 ssl = NULL; /* make sure we don't use it except for those cases */
5395 (void) ssl;
5396#endif
5397
5398 if( handshake->resume != 0 )
5399 {
5400 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no premaster (session resumed)" ) );
5401 return( 0 );
5402 }
5403
5404#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5405 if( handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED )
5406 {
5407 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02005408 seed = session_hash;
5409 handshake->calc_verify( ssl, session_hash, &seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005410
5411 MBEDTLS_SSL_DEBUG_BUF( 3, "session hash for extended master secret",
Przemek Stekielae4ed302022-04-05 17:15:55 +02005412 session_hash, seed_len );
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005413 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02005414#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005415
Przemek Stekiel99114f32022-04-22 11:20:09 +02005416#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02005417 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstronge952a302022-05-03 10:22:14 +02005418 if( mbedtls_ssl_ciphersuite_uses_psk( handshake->ciphersuite_info ) == 1 )
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005419 {
5420 /* Perform PSK-to-MS expansion in a single step. */
5421 psa_status_t status;
5422 psa_algorithm_t alg;
5423 mbedtls_svc_key_id_t psk;
5424 psa_key_derivation_operation_t derivation =
5425 PSA_KEY_DERIVATION_OPERATION_INIT;
5426 mbedtls_md_type_t hash_alg = handshake->ciphersuite_info->mac;
5427
5428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "perform PSA-based PSK-to-MS expansion" ) );
5429
5430 psk = mbedtls_ssl_get_opaque_psk( ssl );
5431
5432 if( hash_alg == MBEDTLS_MD_SHA384 )
5433 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
5434 else
5435 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
5436
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005437 size_t other_secret_len = 0;
5438 unsigned char* other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02005439
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005440 switch( handshake->ciphersuite_info->key_exchange )
Przemek Stekielc2033402022-04-05 17:19:41 +02005441 {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005442 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005443 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005444 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02005445 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005446 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005447 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005448 other_secret_len = 48;
5449 other_secret = handshake->premaster + 2;
5450 break;
5451 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005452 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02005453 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
5454 other_secret = handshake->premaster + 2;
5455 break;
5456 default:
5457 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02005458 }
5459
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005460 status = setup_psa_key_derivation( &derivation, psk, alg,
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005461 ssl->conf->psk, ssl->conf->psk_len,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005462 seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005463 (unsigned char const *) lbl,
5464 (size_t) strlen( lbl ),
Przemek Stekiel51a1f362022-04-13 08:57:06 +02005465 other_secret, other_secret_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005466 master_secret_len );
5467 if( status != PSA_SUCCESS )
5468 {
5469 psa_key_derivation_abort( &derivation );
5470 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5471 }
5472
5473 status = psa_key_derivation_output_bytes( &derivation,
5474 master,
5475 master_secret_len );
5476 if( status != PSA_SUCCESS )
5477 {
5478 psa_key_derivation_abort( &derivation );
5479 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5480 }
5481
5482 status = psa_key_derivation_abort( &derivation );
5483 if( status != PSA_SUCCESS )
5484 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
5485 }
5486 else
5487#endif
5488 {
5489 ret = handshake->tls_prf( handshake->premaster, handshake->pmslen,
Przemek Stekielae4ed302022-04-05 17:15:55 +02005490 lbl, seed, seed_len,
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08005491 master,
5492 master_secret_len );
5493 if( ret != 0 )
5494 {
5495 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
5496 return( ret );
5497 }
5498
5499 MBEDTLS_SSL_DEBUG_BUF( 3, "premaster secret",
5500 handshake->premaster,
5501 handshake->pmslen );
5502
5503 mbedtls_platform_zeroize( handshake->premaster,
5504 sizeof(handshake->premaster) );
5505 }
5506
5507 return( 0 );
5508}
5509
Jerry Yud62f87e2022-02-17 14:09:02 +08005510int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl )
5511{
5512 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5513 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
5514 ssl->handshake->ciphersuite_info;
5515
5516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> derive keys" ) );
5517
5518 /* Set PRF, calc_verify and calc_finished function pointers */
5519 ret = ssl_set_handshake_prfs( ssl->handshake,
Jerry Yud62f87e2022-02-17 14:09:02 +08005520 ciphersuite_info->mac );
5521 if( ret != 0 )
5522 {
5523 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_set_handshake_prfs", ret );
5524 return( ret );
5525 }
5526
5527 /* Compute master secret if needed */
5528 ret = ssl_compute_master( ssl->handshake,
5529 ssl->session_negotiate->master,
5530 ssl );
5531 if( ret != 0 )
5532 {
5533 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compute_master", ret );
5534 return( ret );
5535 }
5536
5537 /* Swap the client and server random values:
5538 * - MS derivation wanted client+server (RFC 5246 8.1)
5539 * - key derivation wants server+client (RFC 5246 6.3) */
5540 {
5541 unsigned char tmp[64];
5542 memcpy( tmp, ssl->handshake->randbytes, 64 );
5543 memcpy( ssl->handshake->randbytes, tmp + 32, 32 );
5544 memcpy( ssl->handshake->randbytes + 32, tmp, 32 );
5545 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
5546 }
5547
5548 /* Populate transform structure */
5549 ret = ssl_tls12_populate_transform( ssl->transform_negotiate,
5550 ssl->session_negotiate->ciphersuite,
5551 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005552#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yud62f87e2022-02-17 14:09:02 +08005553 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005554#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yud62f87e2022-02-17 14:09:02 +08005555 ssl->handshake->tls_prf,
5556 ssl->handshake->randbytes,
Glenn Strauss60bfe602022-03-14 19:04:24 -04005557 ssl->tls_version,
Jerry Yud62f87e2022-02-17 14:09:02 +08005558 ssl->conf->endpoint,
5559 ssl );
5560 if( ret != 0 )
5561 {
5562 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls12_populate_transform", ret );
5563 return( ret );
5564 }
5565
5566 /* We no longer need Server/ClientHello.random values */
5567 mbedtls_platform_zeroize( ssl->handshake->randbytes,
5568 sizeof( ssl->handshake->randbytes ) );
5569
5570 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= derive keys" ) );
5571
5572 return( 0 );
5573}
Jerry Yu8392e0d2022-02-17 14:10:24 +08005574
Ronald Cron4dcbca92022-03-07 10:21:40 +01005575int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md )
5576{
Ronald Cron4dcbca92022-03-07 10:21:40 +01005577 switch( md )
5578 {
5579#if defined(MBEDTLS_SHA384_C)
5580 case MBEDTLS_SSL_HASH_SHA384:
5581 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
5582 break;
5583#endif
5584#if defined(MBEDTLS_SHA256_C)
5585 case MBEDTLS_SSL_HASH_SHA256:
5586 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
5587 break;
5588#endif
5589 default:
5590 return( -1 );
5591 }
5592
Ronald Cronc2f13a02022-03-07 10:25:24 +01005593 return( 0 );
Ronald Cron4dcbca92022-03-07 10:21:40 +01005594}
5595
Jerry Yu8392e0d2022-02-17 14:10:24 +08005596#if defined(MBEDTLS_SHA256_C)
5597void ssl_calc_verify_tls_sha256( const mbedtls_ssl_context *ssl,
5598 unsigned char *hash,
5599 size_t *hlen )
5600{
5601#if defined(MBEDTLS_USE_PSA_CRYPTO)
5602 size_t hash_size;
5603 psa_status_t status;
5604 psa_hash_operation_t sha256_psa = psa_hash_operation_init();
5605
5606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha256" ) );
5607 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
5608 if( status != PSA_SUCCESS )
5609 {
5610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5611 return;
5612 }
5613
5614 status = psa_hash_finish( &sha256_psa, hash, 32, &hash_size );
5615 if( status != PSA_SUCCESS )
5616 {
5617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5618 return;
5619 }
5620
5621 *hlen = 32;
5622 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5624#else
5625 mbedtls_sha256_context sha256;
5626
5627 mbedtls_sha256_init( &sha256 );
5628
5629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha256" ) );
5630
5631 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
5632 mbedtls_sha256_finish( &sha256, hash );
5633
5634 *hlen = 32;
5635
5636 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5638
5639 mbedtls_sha256_free( &sha256 );
5640#endif /* MBEDTLS_USE_PSA_CRYPTO */
5641 return;
5642}
5643#endif /* MBEDTLS_SHA256_C */
5644
Jerry Yuc1cb3842022-02-17 14:13:48 +08005645#if defined(MBEDTLS_SHA384_C)
5646void ssl_calc_verify_tls_sha384( const mbedtls_ssl_context *ssl,
5647 unsigned char *hash,
5648 size_t *hlen )
5649{
5650#if defined(MBEDTLS_USE_PSA_CRYPTO)
5651 size_t hash_size;
5652 psa_status_t status;
5653 psa_hash_operation_t sha384_psa = psa_hash_operation_init();
5654
5655 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> PSA calc verify sha384" ) );
5656 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
5657 if( status != PSA_SUCCESS )
5658 {
5659 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
5660 return;
5661 }
5662
5663 status = psa_hash_finish( &sha384_psa, hash, 48, &hash_size );
5664 if( status != PSA_SUCCESS )
5665 {
5666 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
5667 return;
5668 }
5669
5670 *hlen = 48;
5671 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated verify result", hash, *hlen );
5672 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= PSA calc verify" ) );
5673#else
5674 mbedtls_sha512_context sha512;
5675
5676 mbedtls_sha512_init( &sha512 );
5677
5678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc verify sha384" ) );
5679
5680 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
5681 mbedtls_sha512_finish( &sha512, hash );
5682
5683 *hlen = 48;
5684
5685 MBEDTLS_SSL_DEBUG_BUF( 3, "calculated verify result", hash, *hlen );
5686 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc verify" ) );
5687
5688 mbedtls_sha512_free( &sha512 );
5689#endif /* MBEDTLS_USE_PSA_CRYPTO */
5690 return;
5691}
5692#endif /* MBEDTLS_SHA384_C */
5693
Neil Armstrong80f6f322022-05-03 17:56:38 +02005694#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
5695 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005696int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex )
5697{
5698 unsigned char *p = ssl->handshake->premaster;
5699 unsigned char *end = p + sizeof( ssl->handshake->premaster );
5700 const unsigned char *psk = NULL;
5701 size_t psk_len = 0;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005702 int psk_ret = mbedtls_ssl_get_psk( ssl, &psk, &psk_len );
Jerry Yuce3dca42022-02-17 14:16:37 +08005703
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005704 if( psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED )
Jerry Yuce3dca42022-02-17 14:16:37 +08005705 {
5706 /*
5707 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005708 * checked before calling this function.
5709 *
5710 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02005711 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08005712 */
Przemek Stekielb293aaa2022-04-19 12:22:38 +02005713 if ( key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5714 {
5715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5716 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5717 }
Jerry Yuce3dca42022-02-17 14:16:37 +08005718 }
5719
5720 /*
5721 * PMS = struct {
5722 * opaque other_secret<0..2^16-1>;
5723 * opaque psk<0..2^16-1>;
5724 * };
5725 * with "other_secret" depending on the particular key exchange
5726 */
5727#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
5728 if( key_ex == MBEDTLS_KEY_EXCHANGE_PSK )
5729 {
5730 if( end - p < 2 )
5731 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5732
5733 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5734 p += 2;
5735
5736 if( end < p || (size_t)( end - p ) < psk_len )
5737 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5738
5739 memset( p, 0, psk_len );
5740 p += psk_len;
5741 }
5742 else
5743#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
5744#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
5745 if( key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
5746 {
5747 /*
5748 * other_secret already set by the ClientKeyExchange message,
5749 * and is 48 bytes long
5750 */
5751 if( end - p < 2 )
5752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5753
5754 *p++ = 0;
5755 *p++ = 48;
5756 p += 48;
5757 }
5758 else
5759#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
5760#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
5761 if( key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK )
5762 {
5763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5764 size_t len;
5765
5766 /* Write length only when we know the actual value */
5767 if( ( ret = mbedtls_dhm_calc_secret( &ssl->handshake->dhm_ctx,
5768 p + 2, end - ( p + 2 ), &len,
5769 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5770 {
5771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_dhm_calc_secret", ret );
5772 return( ret );
5773 }
5774 MBEDTLS_PUT_UINT16_BE( len, p, 0 );
5775 p += 2 + len;
5776
5777 MBEDTLS_SSL_DEBUG_MPI( 3, "DHM: K ", &ssl->handshake->dhm_ctx.K );
5778 }
5779 else
5780#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02005781#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Jerry Yuce3dca42022-02-17 14:16:37 +08005782 if( key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK )
5783 {
5784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5785 size_t zlen;
5786
5787 if( ( ret = mbedtls_ecdh_calc_secret( &ssl->handshake->ecdh_ctx, &zlen,
5788 p + 2, end - ( p + 2 ),
5789 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
5790 {
5791 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ecdh_calc_secret", ret );
5792 return( ret );
5793 }
5794
5795 MBEDTLS_PUT_UINT16_BE( zlen, p, 0 );
5796 p += 2 + zlen;
5797
5798 MBEDTLS_SSL_DEBUG_ECDH( 3, &ssl->handshake->ecdh_ctx,
5799 MBEDTLS_DEBUG_ECDH_Z );
5800 }
5801 else
Neil Armstrong80f6f322022-05-03 17:56:38 +02005802#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08005803 {
5804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5805 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5806 }
5807
5808 /* opaque psk<0..2^16-1>; */
5809 if( end - p < 2 )
5810 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5811
5812 MBEDTLS_PUT_UINT16_BE( psk_len, p, 0 );
5813 p += 2;
5814
5815 if( end < p || (size_t)( end - p ) < psk_len )
5816 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5817
5818 memcpy( p, psk, psk_len );
5819 p += psk_len;
5820
5821 ssl->handshake->pmslen = p - ssl->handshake->premaster;
5822
5823 return( 0 );
5824}
Neil Armstrong80f6f322022-05-03 17:56:38 +02005825#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08005826
5827#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005828MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc2c673d2022-02-17 14:20:39 +08005829static int ssl_write_hello_request( mbedtls_ssl_context *ssl );
5830
5831#if defined(MBEDTLS_SSL_PROTO_DTLS)
5832int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl )
5833{
5834 /* If renegotiation is not enforced, retransmit until we would reach max
5835 * timeout if we were using the usual handshake doubling scheme */
5836 if( ssl->conf->renego_max_records < 0 )
5837 {
5838 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
5839 unsigned char doublings = 1;
5840
5841 while( ratio != 0 )
5842 {
5843 ++doublings;
5844 ratio >>= 1;
5845 }
5846
5847 if( ++ssl->renego_records_seen > doublings )
5848 {
5849 MBEDTLS_SSL_DEBUG_MSG( 2, ( "no longer retransmitting hello request" ) );
5850 return( 0 );
5851 }
5852 }
5853
5854 return( ssl_write_hello_request( ssl ) );
5855}
5856#endif
5857#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08005858
Jerry Yud9526692022-02-17 14:23:47 +08005859/*
5860 * Handshake functions
5861 */
5862#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
5863/* No certificate support -> dummy functions */
5864int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5865{
5866 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5867 ssl->handshake->ciphersuite_info;
5868
5869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5870
5871 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5872 {
5873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5874 ssl->state++;
5875 return( 0 );
5876 }
5877
5878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5879 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5880}
5881
5882int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
5883{
5884 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5885 ssl->handshake->ciphersuite_info;
5886
5887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
5888
5889 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5890 {
5891 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
5892 ssl->state++;
5893 return( 0 );
5894 }
5895
5896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5897 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5898}
5899
5900#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
5901/* Some certificate support -> implement write and parse */
5902
5903int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl )
5904{
5905 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
5906 size_t i, n;
5907 const mbedtls_x509_crt *crt;
5908 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
5909 ssl->handshake->ciphersuite_info;
5910
5911 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate" ) );
5912
5913 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
5914 {
5915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5916 ssl->state++;
5917 return( 0 );
5918 }
5919
5920#if defined(MBEDTLS_SSL_CLI_C)
5921 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5922 {
5923 if( ssl->handshake->client_auth == 0 )
5924 {
5925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate" ) );
5926 ssl->state++;
5927 return( 0 );
5928 }
5929 }
5930#endif /* MBEDTLS_SSL_CLI_C */
5931#if defined(MBEDTLS_SSL_SRV_C)
5932 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
5933 {
5934 if( mbedtls_ssl_own_cert( ssl ) == NULL )
5935 {
5936 /* Should never happen because we shouldn't have picked the
5937 * ciphersuite if we don't have a certificate. */
5938 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5939 }
5940 }
5941#endif
5942
5943 MBEDTLS_SSL_DEBUG_CRT( 3, "own certificate", mbedtls_ssl_own_cert( ssl ) );
5944
5945 /*
5946 * 0 . 0 handshake type
5947 * 1 . 3 handshake length
5948 * 4 . 6 length of all certs
5949 * 7 . 9 length of cert. 1
5950 * 10 . n-1 peer certificate
5951 * n . n+2 length of cert. 2
5952 * n+3 . ... upper level cert, etc.
5953 */
5954 i = 7;
5955 crt = mbedtls_ssl_own_cert( ssl );
5956
5957 while( crt != NULL )
5958 {
5959 n = crt->raw.len;
5960 if( n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i )
5961 {
5962 MBEDTLS_SSL_DEBUG_MSG( 1, ( "certificate too large, %" MBEDTLS_PRINTF_SIZET
5963 " > %" MBEDTLS_PRINTF_SIZET,
5964 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
5965 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
5966 }
5967
5968 ssl->out_msg[i ] = MBEDTLS_BYTE_2( n );
5969 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1( n );
5970 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0( n );
5971
5972 i += 3; memcpy( ssl->out_msg + i, crt->raw.p, n );
5973 i += n; crt = crt->next;
5974 }
5975
5976 ssl->out_msg[4] = MBEDTLS_BYTE_2( i - 7 );
5977 ssl->out_msg[5] = MBEDTLS_BYTE_1( i - 7 );
5978 ssl->out_msg[6] = MBEDTLS_BYTE_0( i - 7 );
5979
5980 ssl->out_msglen = i;
5981 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
5982 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
5983
5984 ssl->state++;
5985
5986 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
5987 {
5988 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
5989 return( ret );
5990 }
5991
5992 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate" ) );
5993
5994 return( ret );
5995}
5996
5997#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
5998
5999#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006000MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006001static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6002 unsigned char *crt_buf,
6003 size_t crt_buf_len )
6004{
6005 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6006
6007 if( peer_crt == NULL )
6008 return( -1 );
6009
6010 if( peer_crt->raw.len != crt_buf_len )
6011 return( -1 );
6012
6013 return( memcmp( peer_crt->raw.p, crt_buf, peer_crt->raw.len ) );
6014}
6015#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006016MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006017static int ssl_check_peer_crt_unchanged( mbedtls_ssl_context *ssl,
6018 unsigned char *crt_buf,
6019 size_t crt_buf_len )
6020{
6021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6022 unsigned char const * const peer_cert_digest =
6023 ssl->session->peer_cert_digest;
6024 mbedtls_md_type_t const peer_cert_digest_type =
6025 ssl->session->peer_cert_digest_type;
6026 mbedtls_md_info_t const * const digest_info =
6027 mbedtls_md_info_from_type( peer_cert_digest_type );
6028 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6029 size_t digest_len;
6030
6031 if( peer_cert_digest == NULL || digest_info == NULL )
6032 return( -1 );
6033
6034 digest_len = mbedtls_md_get_size( digest_info );
6035 if( digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN )
6036 return( -1 );
6037
6038 ret = mbedtls_md( digest_info, crt_buf, crt_buf_len, tmp_digest );
6039 if( ret != 0 )
6040 return( -1 );
6041
6042 return( memcmp( tmp_digest, peer_cert_digest, digest_len ) );
6043}
6044#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6045#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6046
6047/*
6048 * Once the certificate message is read, parse it into a cert chain and
6049 * perform basic checks, but leave actual verification to the caller
6050 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006051MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006052static int ssl_parse_certificate_chain( mbedtls_ssl_context *ssl,
6053 mbedtls_x509_crt *chain )
6054{
6055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6056#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6057 int crt_cnt=0;
6058#endif
6059 size_t i, n;
6060 uint8_t alert;
6061
6062 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
6063 {
6064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6065 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6066 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6067 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6068 }
6069
6070 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE )
6071 {
6072 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6073 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
6074 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
6075 }
6076
6077 if( ssl->in_hslen < mbedtls_ssl_hs_hdr_len( ssl ) + 3 + 3 )
6078 {
6079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6080 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6081 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6082 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6083 }
6084
6085 i = mbedtls_ssl_hs_hdr_len( ssl );
6086
6087 /*
6088 * Same message structure as in mbedtls_ssl_write_certificate()
6089 */
6090 n = ( ssl->in_msg[i+1] << 8 ) | ssl->in_msg[i+2];
6091
6092 if( ssl->in_msg[i] != 0 ||
6093 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len( ssl ) )
6094 {
6095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6096 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6097 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6098 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6099 }
6100
6101 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6102 i += 3;
6103
6104 /* Iterate through and parse the CRTs in the provided chain. */
6105 while( i < ssl->in_hslen )
6106 {
6107 /* Check that there's room for the next CRT's length fields. */
6108 if ( i + 3 > ssl->in_hslen ) {
6109 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6110 mbedtls_ssl_send_alert_message( ssl,
6111 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6112 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6113 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6114 }
6115 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6116 * anything beyond 2**16 ~ 64K. */
6117 if( ssl->in_msg[i] != 0 )
6118 {
6119 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6120 mbedtls_ssl_send_alert_message( ssl,
6121 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6122 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT );
6123 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6124 }
6125
6126 /* Read length of the next CRT in the chain. */
6127 n = ( (unsigned int) ssl->in_msg[i + 1] << 8 )
6128 | (unsigned int) ssl->in_msg[i + 2];
6129 i += 3;
6130
6131 if( n < 128 || i + n > ssl->in_hslen )
6132 {
6133 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate message" ) );
6134 mbedtls_ssl_send_alert_message( ssl,
6135 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6136 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
6137 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
6138 }
6139
6140 /* Check if we're handling the first CRT in the chain. */
6141#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6142 if( crt_cnt++ == 0 &&
6143 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
6144 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6145 {
6146 /* During client-side renegotiation, check that the server's
6147 * end-CRTs hasn't changed compared to the initial handshake,
6148 * mitigating the triple handshake attack. On success, reuse
6149 * the original end-CRT instead of parsing it again. */
6150 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Check that peer CRT hasn't changed during renegotiation" ) );
6151 if( ssl_check_peer_crt_unchanged( ssl,
6152 &ssl->in_msg[i],
6153 n ) != 0 )
6154 {
6155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "new server cert during renegotiation" ) );
6156 mbedtls_ssl_send_alert_message( ssl,
6157 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6158 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED );
6159 return( MBEDTLS_ERR_SSL_BAD_CERTIFICATE );
6160 }
6161
6162 /* Now we can safely free the original chain. */
6163 ssl_clear_peer_cert( ssl->session );
6164 }
6165#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6166
6167 /* Parse the next certificate in the chain. */
6168#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6169 ret = mbedtls_x509_crt_parse_der( chain, ssl->in_msg + i, n );
6170#else
6171 /* If we don't need to store the CRT chain permanently, parse
6172 * it in-place from the input buffer instead of making a copy. */
6173 ret = mbedtls_x509_crt_parse_der_nocopy( chain, ssl->in_msg + i, n );
6174#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6175 switch( ret )
6176 {
6177 case 0: /*ok*/
6178 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
6179 /* Ignore certificate with an unknown algorithm: maybe a
6180 prior certificate was already trusted. */
6181 break;
6182
6183 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6184 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6185 goto crt_parse_der_failed;
6186
6187 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6188 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6189 goto crt_parse_der_failed;
6190
6191 default:
6192 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6193 crt_parse_der_failed:
6194 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert );
6195 MBEDTLS_SSL_DEBUG_RET( 1, " mbedtls_x509_crt_parse_der", ret );
6196 return( ret );
6197 }
6198
6199 i += n;
6200 }
6201
6202 MBEDTLS_SSL_DEBUG_CRT( 3, "peer certificate", chain );
6203 return( 0 );
6204}
6205
6206#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006207MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006208static int ssl_srv_check_client_no_crt_notification( mbedtls_ssl_context *ssl )
6209{
6210 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6211 return( -1 );
6212
6213 if( ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len( ssl ) &&
6214 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6215 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
6216 memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ), "\0\0\0", 3 ) == 0 )
6217 {
Ronald Cron19385882022-06-15 16:26:13 +02006218 MBEDTLS_SSL_DEBUG_MSG( 1, ( "peer has no certificate" ) );
Jerry Yud9526692022-02-17 14:23:47 +08006219 return( 0 );
6220 }
6221 return( -1 );
6222}
6223#endif /* MBEDTLS_SSL_SRV_C */
6224
6225/* Check if a certificate message is expected.
6226 * Return either
6227 * - SSL_CERTIFICATE_EXPECTED, or
6228 * - SSL_CERTIFICATE_SKIP
6229 * indicating whether a Certificate message is expected or not.
6230 */
6231#define SSL_CERTIFICATE_EXPECTED 0
6232#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006233MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006234static int ssl_parse_certificate_coordinate( mbedtls_ssl_context *ssl,
6235 int authmode )
6236{
6237 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6238 ssl->handshake->ciphersuite_info;
6239
6240 if( !mbedtls_ssl_ciphersuite_uses_srv_cert( ciphersuite_info ) )
6241 return( SSL_CERTIFICATE_SKIP );
6242
6243#if defined(MBEDTLS_SSL_SRV_C)
6244 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6245 {
6246 if( ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK )
6247 return( SSL_CERTIFICATE_SKIP );
6248
6249 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6250 {
6251 ssl->session_negotiate->verify_result =
6252 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
6253 return( SSL_CERTIFICATE_SKIP );
6254 }
6255 }
6256#else
6257 ((void) authmode);
6258#endif /* MBEDTLS_SSL_SRV_C */
6259
6260 return( SSL_CERTIFICATE_EXPECTED );
6261}
6262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006264static int ssl_parse_certificate_verify( mbedtls_ssl_context *ssl,
6265 int authmode,
6266 mbedtls_x509_crt *chain,
6267 void *rs_ctx )
6268{
6269 int ret = 0;
6270 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6271 ssl->handshake->ciphersuite_info;
6272 int have_ca_chain = 0;
6273
6274 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
6275 void *p_vrfy;
6276
6277 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
6278 return( 0 );
6279
6280 if( ssl->f_vrfy != NULL )
6281 {
6282 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use context-specific verification callback" ) );
6283 f_vrfy = ssl->f_vrfy;
6284 p_vrfy = ssl->p_vrfy;
6285 }
6286 else
6287 {
6288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Use configuration-specific verification callback" ) );
6289 f_vrfy = ssl->conf->f_vrfy;
6290 p_vrfy = ssl->conf->p_vrfy;
6291 }
6292
6293 /*
6294 * Main check: verify certificate
6295 */
6296#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
6297 if( ssl->conf->f_ca_cb != NULL )
6298 {
6299 ((void) rs_ctx);
6300 have_ca_chain = 1;
6301
6302 MBEDTLS_SSL_DEBUG_MSG( 3, ( "use CA callback for X.509 CRT verification" ) );
6303 ret = mbedtls_x509_crt_verify_with_ca_cb(
6304 chain,
6305 ssl->conf->f_ca_cb,
6306 ssl->conf->p_ca_cb,
6307 ssl->conf->cert_profile,
6308 ssl->hostname,
6309 &ssl->session_negotiate->verify_result,
6310 f_vrfy, p_vrfy );
6311 }
6312 else
6313#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
6314 {
6315 mbedtls_x509_crt *ca_chain;
6316 mbedtls_x509_crl *ca_crl;
6317
6318#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6319 if( ssl->handshake->sni_ca_chain != NULL )
6320 {
6321 ca_chain = ssl->handshake->sni_ca_chain;
6322 ca_crl = ssl->handshake->sni_ca_crl;
6323 }
6324 else
6325#endif
6326 {
6327 ca_chain = ssl->conf->ca_chain;
6328 ca_crl = ssl->conf->ca_crl;
6329 }
6330
6331 if( ca_chain != NULL )
6332 have_ca_chain = 1;
6333
6334 ret = mbedtls_x509_crt_verify_restartable(
6335 chain,
6336 ca_chain, ca_crl,
6337 ssl->conf->cert_profile,
6338 ssl->hostname,
6339 &ssl->session_negotiate->verify_result,
6340 f_vrfy, p_vrfy, rs_ctx );
6341 }
6342
6343 if( ret != 0 )
6344 {
6345 MBEDTLS_SSL_DEBUG_RET( 1, "x509_verify_cert", ret );
6346 }
6347
6348#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6349 if( ret == MBEDTLS_ERR_ECP_IN_PROGRESS )
6350 return( MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS );
6351#endif
6352
6353 /*
6354 * Secondary checks: always done, but change 'ret' only if it was 0
6355 */
6356
6357#if defined(MBEDTLS_ECP_C)
6358 {
6359 const mbedtls_pk_context *pk = &chain->pk;
6360
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02006361 /* If certificate uses an EC key, make sure the curve is OK.
6362 * This is a public key, so it can't be opaque, so can_do() is a good
6363 * enough check to ensure pk_ec() is safe to use here. */
Jerry Yud9526692022-02-17 14:23:47 +08006364 if( mbedtls_pk_can_do( pk, MBEDTLS_PK_ECKEY ) &&
6365 mbedtls_ssl_check_curve( ssl, mbedtls_pk_ec( *pk )->grp.id ) != 0 )
6366 {
6367 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
6368
6369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (EC key curve)" ) );
6370 if( ret == 0 )
6371 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6372 }
6373 }
6374#endif /* MBEDTLS_ECP_C */
6375
6376 if( mbedtls_ssl_check_cert_usage( chain,
6377 ciphersuite_info,
6378 ! ssl->conf->endpoint,
6379 &ssl->session_negotiate->verify_result ) != 0 )
6380 {
6381 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad certificate (usage extensions)" ) );
6382 if( ret == 0 )
6383 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
6384 }
6385
6386 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
6387 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
6388 * with details encoded in the verification flags. All other kinds
6389 * of error codes, including those from the user provided f_vrfy
6390 * functions, are treated as fatal and lead to a failure of
6391 * ssl_parse_certificate even if verification was optional. */
6392 if( authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
6393 ( ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
6394 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE ) )
6395 {
6396 ret = 0;
6397 }
6398
6399 if( have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED )
6400 {
6401 MBEDTLS_SSL_DEBUG_MSG( 1, ( "got no CA chain" ) );
6402 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
6403 }
6404
6405 if( ret != 0 )
6406 {
6407 uint8_t alert;
6408
6409 /* The certificate may have been rejected for several reasons.
6410 Pick one and send the corresponding alert. Which alert to send
6411 may be a subject of debate in some cases. */
6412 if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER )
6413 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
6414 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH )
6415 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
6416 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE )
6417 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6418 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE )
6419 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6420 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE )
6421 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6422 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK )
6423 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6424 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY )
6425 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6426 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED )
6427 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
6428 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED )
6429 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
6430 else if( ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED )
6431 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
6432 else
6433 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
6434 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6435 alert );
6436 }
6437
6438#if defined(MBEDTLS_DEBUG_C)
6439 if( ssl->session_negotiate->verify_result != 0 )
6440 {
6441 MBEDTLS_SSL_DEBUG_MSG( 3, ( "! Certificate verification flags %08x",
6442 (unsigned int) ssl->session_negotiate->verify_result ) );
6443 }
6444 else
6445 {
6446 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Certificate verification flags clear" ) );
6447 }
6448#endif /* MBEDTLS_DEBUG_C */
6449
6450 return( ret );
6451}
6452
6453#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006454MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006455static int ssl_remember_peer_crt_digest( mbedtls_ssl_context *ssl,
6456 unsigned char *start, size_t len )
6457{
6458 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6459 /* Remember digest of the peer's end-CRT. */
6460 ssl->session_negotiate->peer_cert_digest =
6461 mbedtls_calloc( 1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN );
6462 if( ssl->session_negotiate->peer_cert_digest == NULL )
6463 {
6464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%d bytes) failed",
6465 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN ) );
6466 mbedtls_ssl_send_alert_message( ssl,
6467 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6468 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6469
6470 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
6471 }
6472
6473 ret = mbedtls_md( mbedtls_md_info_from_type(
6474 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE ),
6475 start, len,
6476 ssl->session_negotiate->peer_cert_digest );
6477
6478 ssl->session_negotiate->peer_cert_digest_type =
6479 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
6480 ssl->session_negotiate->peer_cert_digest_len =
6481 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
6482
6483 return( ret );
6484}
6485
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006486MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yud9526692022-02-17 14:23:47 +08006487static int ssl_remember_peer_pubkey( mbedtls_ssl_context *ssl,
6488 unsigned char *start, size_t len )
6489{
6490 unsigned char *end = start + len;
6491 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6492
6493 /* Make a copy of the peer's raw public key. */
6494 mbedtls_pk_init( &ssl->handshake->peer_pubkey );
6495 ret = mbedtls_pk_parse_subpubkey( &start, end,
6496 &ssl->handshake->peer_pubkey );
6497 if( ret != 0 )
6498 {
6499 /* We should have parsed the public key before. */
6500 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
6501 }
6502
6503 return( 0 );
6504}
6505#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6506
6507int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl )
6508{
6509 int ret = 0;
6510 int crt_expected;
6511#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
6512 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
6513 ? ssl->handshake->sni_authmode
6514 : ssl->conf->authmode;
6515#else
6516 const int authmode = ssl->conf->authmode;
6517#endif
6518 void *rs_ctx = NULL;
6519 mbedtls_x509_crt *chain = NULL;
6520
6521 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate" ) );
6522
6523 crt_expected = ssl_parse_certificate_coordinate( ssl, authmode );
6524 if( crt_expected == SSL_CERTIFICATE_SKIP )
6525 {
6526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip parse certificate" ) );
6527 goto exit;
6528 }
6529
6530#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6531 if( ssl->handshake->ecrs_enabled &&
6532 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify )
6533 {
6534 chain = ssl->handshake->ecrs_peer_cert;
6535 ssl->handshake->ecrs_peer_cert = NULL;
6536 goto crt_verify;
6537 }
6538#endif
6539
6540 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
6541 {
6542 /* mbedtls_ssl_read_record may have sent an alert already. We
6543 let it decide whether to alert. */
6544 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
6545 goto exit;
6546 }
6547
6548#if defined(MBEDTLS_SSL_SRV_C)
6549 if( ssl_srv_check_client_no_crt_notification( ssl ) == 0 )
6550 {
6551 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
6552
6553 if( authmode != MBEDTLS_SSL_VERIFY_OPTIONAL )
6554 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
6555
6556 goto exit;
6557 }
6558#endif /* MBEDTLS_SSL_SRV_C */
6559
6560 /* Clear existing peer CRT structure in case we tried to
6561 * reuse a session but it failed, and allocate a new one. */
6562 ssl_clear_peer_cert( ssl->session_negotiate );
6563
6564 chain = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
6565 if( chain == NULL )
6566 {
6567 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
6568 sizeof( mbedtls_x509_crt ) ) );
6569 mbedtls_ssl_send_alert_message( ssl,
6570 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6571 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
6572
6573 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6574 goto exit;
6575 }
6576 mbedtls_x509_crt_init( chain );
6577
6578 ret = ssl_parse_certificate_chain( ssl, chain );
6579 if( ret != 0 )
6580 goto exit;
6581
6582#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6583 if( ssl->handshake->ecrs_enabled)
6584 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
6585
6586crt_verify:
6587 if( ssl->handshake->ecrs_enabled)
6588 rs_ctx = &ssl->handshake->ecrs_ctx;
6589#endif
6590
6591 ret = ssl_parse_certificate_verify( ssl, authmode,
6592 chain, rs_ctx );
6593 if( ret != 0 )
6594 goto exit;
6595
6596#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
6597 {
6598 unsigned char *crt_start, *pk_start;
6599 size_t crt_len, pk_len;
6600
6601 /* We parse the CRT chain without copying, so
6602 * these pointers point into the input buffer,
6603 * and are hence still valid after freeing the
6604 * CRT chain. */
6605
6606 crt_start = chain->raw.p;
6607 crt_len = chain->raw.len;
6608
6609 pk_start = chain->pk_raw.p;
6610 pk_len = chain->pk_raw.len;
6611
6612 /* Free the CRT structures before computing
6613 * digest and copying the peer's public key. */
6614 mbedtls_x509_crt_free( chain );
6615 mbedtls_free( chain );
6616 chain = NULL;
6617
6618 ret = ssl_remember_peer_crt_digest( ssl, crt_start, crt_len );
6619 if( ret != 0 )
6620 goto exit;
6621
6622 ret = ssl_remember_peer_pubkey( ssl, pk_start, pk_len );
6623 if( ret != 0 )
6624 goto exit;
6625 }
6626#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6627 /* Pass ownership to session structure. */
6628 ssl->session_negotiate->peer_cert = chain;
6629 chain = NULL;
6630#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6631
6632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate" ) );
6633
6634exit:
6635
6636 if( ret == 0 )
6637 ssl->state++;
6638
6639#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
6640 if( ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS )
6641 {
6642 ssl->handshake->ecrs_peer_cert = chain;
6643 chain = NULL;
6644 }
6645#endif
6646
6647 if( chain != NULL )
6648 {
6649 mbedtls_x509_crt_free( chain );
6650 mbedtls_free( chain );
6651 }
6652
6653 return( ret );
6654}
6655#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6656
Jerry Yu615bd6f2022-02-17 14:25:15 +08006657#if defined(MBEDTLS_SHA256_C)
6658static void ssl_calc_finished_tls_sha256(
6659 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6660{
6661 int len = 12;
6662 const char *sender;
6663 unsigned char padbuf[32];
6664#if defined(MBEDTLS_USE_PSA_CRYPTO)
6665 size_t hash_size;
6666 psa_hash_operation_t sha256_psa = PSA_HASH_OPERATION_INIT;
6667 psa_status_t status;
6668#else
6669 mbedtls_sha256_context sha256;
6670#endif
6671
6672 mbedtls_ssl_session *session = ssl->session_negotiate;
6673 if( !session )
6674 session = ssl->session;
6675
6676 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6677 ? "client finished"
6678 : "server finished";
6679
6680#if defined(MBEDTLS_USE_PSA_CRYPTO)
6681 sha256_psa = psa_hash_operation_init();
6682
6683 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha256" ) );
6684
6685 status = psa_hash_clone( &ssl->handshake->fin_sha256_psa, &sha256_psa );
6686 if( status != PSA_SUCCESS )
6687 {
6688 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6689 return;
6690 }
6691
6692 status = psa_hash_finish( &sha256_psa, padbuf, sizeof( padbuf ), &hash_size );
6693 if( status != PSA_SUCCESS )
6694 {
6695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6696 return;
6697 }
6698 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 32 );
6699#else
6700
6701 mbedtls_sha256_init( &sha256 );
6702
6703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha256" ) );
6704
6705 mbedtls_sha256_clone( &sha256, &ssl->handshake->fin_sha256 );
6706
6707 /*
6708 * TLSv1.2:
6709 * hash = PRF( master, finished_label,
6710 * Hash( handshake ) )[0.11]
6711 */
6712
6713#if !defined(MBEDTLS_SHA256_ALT)
6714 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha2 state", (unsigned char *)
6715 sha256.state, sizeof( sha256.state ) );
6716#endif
6717
6718 mbedtls_sha256_finish( &sha256, padbuf );
6719 mbedtls_sha256_free( &sha256 );
6720#endif /* MBEDTLS_USE_PSA_CRYPTO */
6721
6722 ssl->handshake->tls_prf( session->master, 48, sender,
6723 padbuf, 32, buf, len );
6724
6725 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6726
6727 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6728
6729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6730}
6731#endif /* MBEDTLS_SHA256_C */
6732
Jerry Yub7ba49e2022-02-17 14:25:53 +08006733
6734#if defined(MBEDTLS_SHA384_C)
6735
6736static void ssl_calc_finished_tls_sha384(
6737 mbedtls_ssl_context *ssl, unsigned char *buf, int from )
6738{
6739 int len = 12;
6740 const char *sender;
6741 unsigned char padbuf[48];
6742#if defined(MBEDTLS_USE_PSA_CRYPTO)
6743 size_t hash_size;
6744 psa_hash_operation_t sha384_psa = PSA_HASH_OPERATION_INIT;
6745 psa_status_t status;
6746#else
6747 mbedtls_sha512_context sha512;
6748#endif
6749
6750 mbedtls_ssl_session *session = ssl->session_negotiate;
6751 if( !session )
6752 session = ssl->session;
6753
6754 sender = ( from == MBEDTLS_SSL_IS_CLIENT )
6755 ? "client finished"
6756 : "server finished";
6757
6758#if defined(MBEDTLS_USE_PSA_CRYPTO)
6759 sha384_psa = psa_hash_operation_init();
6760
6761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc PSA finished tls sha384" ) );
6762
6763 status = psa_hash_clone( &ssl->handshake->fin_sha384_psa, &sha384_psa );
6764 if( status != PSA_SUCCESS )
6765 {
6766 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash clone failed" ) );
6767 return;
6768 }
6769
6770 status = psa_hash_finish( &sha384_psa, padbuf, sizeof( padbuf ), &hash_size );
6771 if( status != PSA_SUCCESS )
6772 {
6773 MBEDTLS_SSL_DEBUG_MSG( 2, ( "PSA hash finish failed" ) );
6774 return;
6775 }
6776 MBEDTLS_SSL_DEBUG_BUF( 3, "PSA calculated padbuf", padbuf, 48 );
6777#else
6778 mbedtls_sha512_init( &sha512 );
6779
6780 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> calc finished tls sha384" ) );
6781
6782 mbedtls_sha512_clone( &sha512, &ssl->handshake->fin_sha512 );
6783
6784 /*
6785 * TLSv1.2:
6786 * hash = PRF( master, finished_label,
6787 * Hash( handshake ) )[0.11]
6788 */
6789
6790#if !defined(MBEDTLS_SHA512_ALT)
6791 MBEDTLS_SSL_DEBUG_BUF( 4, "finished sha512 state", (unsigned char *)
6792 sha512.state, sizeof( sha512.state ) );
6793#endif
6794 mbedtls_sha512_finish( &sha512, padbuf );
6795
6796 mbedtls_sha512_free( &sha512 );
6797#endif
6798
6799 ssl->handshake->tls_prf( session->master, 48, sender,
6800 padbuf, 48, buf, len );
6801
6802 MBEDTLS_SSL_DEBUG_BUF( 3, "calc finished result", buf, len );
6803
6804 mbedtls_platform_zeroize( padbuf, sizeof( padbuf ) );
6805
6806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= calc finished" ) );
6807}
6808#endif /* MBEDTLS_SHA384_C */
6809
Jerry Yuaef00152022-02-17 14:27:31 +08006810void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl )
6811{
6812 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup: final free" ) );
6813
6814 /*
6815 * Free our handshake params
6816 */
6817 mbedtls_ssl_handshake_free( ssl );
6818 mbedtls_free( ssl->handshake );
6819 ssl->handshake = NULL;
6820
6821 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08006822 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08006823 */
6824 if( ssl->transform )
6825 {
6826 mbedtls_ssl_transform_free( ssl->transform );
6827 mbedtls_free( ssl->transform );
6828 }
6829 ssl->transform = ssl->transform_negotiate;
6830 ssl->transform_negotiate = NULL;
6831
6832 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup: final free" ) );
6833}
6834
Jerry Yu2a9fff52022-02-17 14:28:51 +08006835void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl )
6836{
6837 int resume = ssl->handshake->resume;
6838
6839 MBEDTLS_SSL_DEBUG_MSG( 3, ( "=> handshake wrapup" ) );
6840
6841#if defined(MBEDTLS_SSL_RENEGOTIATION)
6842 if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS )
6843 {
6844 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
6845 ssl->renego_records_seen = 0;
6846 }
6847#endif
6848
6849 /*
6850 * Free the previous session and switch in the current one
6851 */
6852 if( ssl->session )
6853 {
6854#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
6855 /* RFC 7366 3.1: keep the EtM state */
6856 ssl->session_negotiate->encrypt_then_mac =
6857 ssl->session->encrypt_then_mac;
6858#endif
6859
6860 mbedtls_ssl_session_free( ssl->session );
6861 mbedtls_free( ssl->session );
6862 }
6863 ssl->session = ssl->session_negotiate;
6864 ssl->session_negotiate = NULL;
6865
6866 /*
6867 * Add cache entry
6868 */
6869 if( ssl->conf->f_set_cache != NULL &&
6870 ssl->session->id_len != 0 &&
6871 resume == 0 )
6872 {
6873 if( ssl->conf->f_set_cache( ssl->conf->p_cache,
6874 ssl->session->id,
6875 ssl->session->id_len,
6876 ssl->session ) != 0 )
6877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cache did not store session" ) );
6878 }
6879
6880#if defined(MBEDTLS_SSL_PROTO_DTLS)
6881 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6882 ssl->handshake->flight != NULL )
6883 {
6884 /* Cancel handshake timer */
6885 mbedtls_ssl_set_timer( ssl, 0 );
6886
6887 /* Keep last flight around in case we need to resend it:
6888 * we need the handshake and transform structures for that */
6889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip freeing handshake and transform" ) );
6890 }
6891 else
6892#endif
6893 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
6894
6895 ssl->state++;
6896
6897 MBEDTLS_SSL_DEBUG_MSG( 3, ( "<= handshake wrapup" ) );
6898}
6899
Jerry Yu3c8e47b2022-02-17 14:30:01 +08006900int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl )
6901{
6902 int ret, hash_len;
6903
6904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write finished" ) );
6905
6906 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_negotiate );
6907
6908 ssl->handshake->calc_finished( ssl, ssl->out_msg + 4, ssl->conf->endpoint );
6909
6910 /*
6911 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
6912 * may define some other value. Currently (early 2016), no defined
6913 * ciphersuite does this (and this is unlikely to change as activity has
6914 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
6915 */
6916 hash_len = 12;
6917
6918#if defined(MBEDTLS_SSL_RENEGOTIATION)
6919 ssl->verify_data_len = hash_len;
6920 memcpy( ssl->own_verify_data, ssl->out_msg + 4, hash_len );
6921#endif
6922
6923 ssl->out_msglen = 4 + hash_len;
6924 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6925 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
6926
6927 /*
6928 * In case of session resuming, invert the client and server
6929 * ChangeCipherSpec messages order.
6930 */
6931 if( ssl->handshake->resume != 0 )
6932 {
6933#if defined(MBEDTLS_SSL_CLI_C)
6934 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
6935 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
6936#endif
6937#if defined(MBEDTLS_SSL_SRV_C)
6938 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
6939 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
6940#endif
6941 }
6942 else
6943 ssl->state++;
6944
6945 /*
6946 * Switch to our negotiated transform and session parameters for outbound
6947 * data.
6948 */
6949 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for outbound data" ) );
6950
6951#if defined(MBEDTLS_SSL_PROTO_DTLS)
6952 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6953 {
6954 unsigned char i;
6955
6956 /* Remember current epoch settings for resending */
6957 ssl->handshake->alt_transform_out = ssl->transform_out;
6958 memcpy( ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
6959 sizeof( ssl->handshake->alt_out_ctr ) );
6960
6961 /* Set sequence_number to zero */
6962 memset( &ssl->cur_out_ctr[2], 0, sizeof( ssl->cur_out_ctr ) - 2 );
6963
6964
6965 /* Increment epoch */
6966 for( i = 2; i > 0; i-- )
6967 if( ++ssl->cur_out_ctr[i - 1] != 0 )
6968 break;
6969
6970 /* The loop goes to its end iff the counter is wrapping */
6971 if( i == 0 )
6972 {
6973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
6974 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
6975 }
6976 }
6977 else
6978#endif /* MBEDTLS_SSL_PROTO_DTLS */
6979 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
6980
6981 ssl->transform_out = ssl->transform_negotiate;
6982 ssl->session_out = ssl->session_negotiate;
6983
6984#if defined(MBEDTLS_SSL_PROTO_DTLS)
6985 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
6986 mbedtls_ssl_send_flight_completed( ssl );
6987#endif
6988
6989 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
6990 {
6991 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
6992 return( ret );
6993 }
6994
6995#if defined(MBEDTLS_SSL_PROTO_DTLS)
6996 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
6997 ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
6998 {
6999 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flight_transmit", ret );
7000 return( ret );
7001 }
7002#endif
7003
7004 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write finished" ) );
7005
7006 return( 0 );
7007}
7008
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007009#define SSL_MAX_HASH_LEN 12
7010
7011int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl )
7012{
7013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7014 unsigned int hash_len = 12;
7015 unsigned char buf[SSL_MAX_HASH_LEN];
7016
7017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse finished" ) );
7018
7019 ssl->handshake->calc_finished( ssl, buf, ssl->conf->endpoint ^ 1 );
7020
7021 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
7022 {
7023 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
7024 goto exit;
7025 }
7026
7027 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE )
7028 {
7029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7030 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7031 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7032 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7033 goto exit;
7034 }
7035
7036 if( ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED )
7037 {
7038 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7039 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
7040 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7041 goto exit;
7042 }
7043
7044 if( ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) + hash_len )
7045 {
7046 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7047 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7048 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR );
7049 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7050 goto exit;
7051 }
7052
7053 if( mbedtls_ct_memcmp( ssl->in_msg + mbedtls_ssl_hs_hdr_len( ssl ),
7054 buf, hash_len ) != 0 )
7055 {
7056 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad finished message" ) );
7057 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7058 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR );
7059 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7060 goto exit;
7061 }
7062
7063#if defined(MBEDTLS_SSL_RENEGOTIATION)
7064 ssl->verify_data_len = hash_len;
7065 memcpy( ssl->peer_verify_data, buf, hash_len );
7066#endif
7067
7068 if( ssl->handshake->resume != 0 )
7069 {
7070#if defined(MBEDTLS_SSL_CLI_C)
7071 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
7072 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
7073#endif
7074#if defined(MBEDTLS_SSL_SRV_C)
7075 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER )
7076 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
7077#endif
7078 }
7079 else
7080 ssl->state++;
7081
7082#if defined(MBEDTLS_SSL_PROTO_DTLS)
7083 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
7084 mbedtls_ssl_recv_flight_completed( ssl );
7085#endif
7086
7087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse finished" ) );
7088
7089exit:
7090 mbedtls_platform_zeroize( buf, hash_len );
7091 return( ret );
7092}
7093
Jerry Yu392112c2022-02-17 14:34:10 +08007094#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7095/*
7096 * Helper to get TLS 1.2 PRF from ciphersuite
7097 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7098 */
7099static tls_prf_fn ssl_tls12prf_from_cs( int ciphersuite_id )
7100{
7101#if defined(MBEDTLS_SHA384_C)
7102 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7103 mbedtls_ssl_ciphersuite_from_id( ciphersuite_id );
7104
7105 if( ciphersuite_info->mac == MBEDTLS_MD_SHA384 )
7106 return( tls_prf_sha384 );
7107#else
7108 (void) ciphersuite_id;
7109#endif
7110 return( tls_prf_sha256 );
7111}
7112#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007113
7114static mbedtls_tls_prf_types tls_prf_get_type( mbedtls_ssl_tls_prf_cb *tls_prf )
7115{
7116 ((void) tls_prf);
7117#if defined(MBEDTLS_SHA384_C)
7118 if( tls_prf == tls_prf_sha384 )
7119 {
7120 return( MBEDTLS_SSL_TLS_PRF_SHA384 );
7121 }
7122 else
7123#endif
7124#if defined(MBEDTLS_SHA256_C)
7125 if( tls_prf == tls_prf_sha256 )
7126 {
7127 return( MBEDTLS_SSL_TLS_PRF_SHA256 );
7128 }
7129 else
7130#endif
7131 return( MBEDTLS_SSL_TLS_PRF_NONE );
7132}
7133
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007134/*
7135 * Populate a transform structure with session keys and all the other
7136 * necessary information.
7137 *
7138 * Parameters:
7139 * - [in/out]: transform: structure to populate
7140 * [in] must be just initialised with mbedtls_ssl_transform_init()
7141 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7142 * - [in] ciphersuite
7143 * - [in] master
7144 * - [in] encrypt_then_mac
7145 * - [in] compression
7146 * - [in] tls_prf: pointer to PRF to use for key derivation
7147 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007148 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007149 * - [in] endpoint: client or server
7150 * - [in] ssl: used for:
7151 * - ssl->conf->{f,p}_export_keys
7152 * [in] optionally used for:
7153 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7154 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007155MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007156static int ssl_tls12_populate_transform( mbedtls_ssl_transform *transform,
7157 int ciphersuite,
7158 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007159#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007160 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007161#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007162 ssl_tls_prf_t tls_prf,
7163 const unsigned char randbytes[64],
Glenn Strauss07c64162022-03-14 12:34:51 -04007164 mbedtls_ssl_protocol_version tls_version,
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007165 unsigned endpoint,
7166 const mbedtls_ssl_context *ssl )
7167{
7168 int ret = 0;
7169 unsigned char keyblk[256];
7170 unsigned char *key1;
7171 unsigned char *key2;
7172 unsigned char *mac_enc;
7173 unsigned char *mac_dec;
7174 size_t mac_key_len = 0;
7175 size_t iv_copy_len;
7176 size_t keylen;
7177 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007178 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01007179#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007180 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007181 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01007182#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007183
7184#if defined(MBEDTLS_USE_PSA_CRYPTO)
7185 psa_key_type_t key_type;
7186 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7187 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007188 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007189 size_t key_bits;
7190 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7191#endif
7192
7193#if !defined(MBEDTLS_DEBUG_C) && \
7194 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7195 if( ssl->f_export_keys == NULL )
7196 {
7197 ssl = NULL; /* make sure we don't use it except for these cases */
7198 (void) ssl;
7199 }
7200#endif
7201
7202 /*
7203 * Some data just needs copying into the structure
7204 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007205#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007206 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007207#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007208 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007209
7210#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7211 memcpy( transform->randbytes, randbytes, sizeof( transform->randbytes ) );
7212#endif
7213
7214#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss07c64162022-03-14 12:34:51 -04007215 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007216 {
7217 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7218 * generation separate. This should never happen. */
7219 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7220 }
7221#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7222
7223 /*
7224 * Get various info structures
7225 */
7226 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
7227 if( ciphersuite_info == NULL )
7228 {
7229 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ciphersuite info for %d not found",
7230 ciphersuite ) );
7231 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7232 }
7233
Neil Armstrongab555e02022-04-04 11:07:59 +02007234 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007235#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007236 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007237#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007238 ciphersuite_info );
7239
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007240 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
7241 transform->taglen =
7242 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
7243
7244#if defined(MBEDTLS_USE_PSA_CRYPTO)
7245 if( ( status = mbedtls_ssl_cipher_to_psa( ciphersuite_info->cipher,
7246 transform->taglen,
7247 &alg,
7248 &key_type,
7249 &key_bits ) ) != PSA_SUCCESS )
7250 {
7251 ret = psa_ssl_status_to_mbedtls( status );
7252 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cipher_to_psa", ret );
7253 goto end;
7254 }
7255#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007256 cipher_info = mbedtls_cipher_info_from_type( ciphersuite_info->cipher );
7257 if( cipher_info == NULL )
7258 {
7259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cipher info for %u not found",
7260 ciphersuite_info->cipher ) );
7261 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7262 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007263#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007264
Neil Armstronge4512952022-03-08 09:08:22 +01007265#if defined(MBEDTLS_USE_PSA_CRYPTO)
7266 mac_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
7267 if( mac_alg == 0 )
7268 {
7269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_psa_translate_md for %u not found",
7270 (unsigned) ciphersuite_info->mac ) );
7271 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7272 }
7273#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007274 md_info = mbedtls_md_info_from_type( ciphersuite_info->mac );
7275 if( md_info == NULL )
7276 {
7277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "mbedtls_md info for %u not found",
7278 (unsigned) ciphersuite_info->mac ) );
7279 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
7280 }
Neil Armstronge4512952022-03-08 09:08:22 +01007281#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007282
7283#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7284 /* Copy own and peer's CID if the use of the CID
7285 * extension has been negotiated. */
7286 if( ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED )
7287 {
7288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Copy CIDs into SSL transform" ) );
7289
7290 transform->in_cid_len = ssl->own_cid_len;
7291 memcpy( transform->in_cid, ssl->own_cid, ssl->own_cid_len );
7292 MBEDTLS_SSL_DEBUG_BUF( 3, "Incoming CID", transform->in_cid,
7293 transform->in_cid_len );
7294
7295 transform->out_cid_len = ssl->handshake->peer_cid_len;
7296 memcpy( transform->out_cid, ssl->handshake->peer_cid,
7297 ssl->handshake->peer_cid_len );
7298 MBEDTLS_SSL_DEBUG_BUF( 3, "Outgoing CID", transform->out_cid,
7299 transform->out_cid_len );
7300 }
7301#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7302
7303 /*
7304 * Compute key block using the PRF
7305 */
7306 ret = tls_prf( master, 48, "key expansion", randbytes, 64, keyblk, 256 );
7307 if( ret != 0 )
7308 {
7309 MBEDTLS_SSL_DEBUG_RET( 1, "prf", ret );
7310 return( ret );
7311 }
7312
7313 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ciphersuite = %s",
7314 mbedtls_ssl_get_ciphersuite_name( ciphersuite ) ) );
7315 MBEDTLS_SSL_DEBUG_BUF( 3, "master secret", master, 48 );
7316 MBEDTLS_SSL_DEBUG_BUF( 4, "random bytes", randbytes, 64 );
7317 MBEDTLS_SSL_DEBUG_BUF( 4, "key block", keyblk, 256 );
7318
7319 /*
7320 * Determine the appropriate key, IV and MAC length.
7321 */
7322
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007323#if defined(MBEDTLS_USE_PSA_CRYPTO)
7324 keylen = PSA_BITS_TO_BYTES(key_bits);
7325#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007326 keylen = mbedtls_cipher_info_get_key_bitlen( cipher_info ) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007327#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007328
7329#if defined(MBEDTLS_GCM_C) || \
7330 defined(MBEDTLS_CCM_C) || \
7331 defined(MBEDTLS_CHACHAPOLY_C)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007332 if( ssl_mode == MBEDTLS_SSL_MODE_AEAD )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007333 {
7334 size_t explicit_ivlen;
7335
7336 transform->maclen = 0;
7337 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007338
7339 /* All modes haves 96-bit IVs, but the length of the static parts vary
7340 * with mode and version:
7341 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7342 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7343 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7344 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7345 * sequence number).
7346 */
7347 transform->ivlen = 12;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007348#if defined(MBEDTLS_USE_PSA_CRYPTO)
7349 if( key_type == PSA_KEY_TYPE_CHACHA20 )
7350#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007351 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CHACHAPOLY )
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007352#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007353 transform->fixed_ivlen = 12;
7354 else
7355 transform->fixed_ivlen = 4;
7356
7357 /* Minimum length of encrypted record */
7358 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7359 transform->minlen = explicit_ivlen + transform->taglen;
7360 }
7361 else
7362#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
7363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007364 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
7365 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
7366 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007367 {
Neil Armstronge4512952022-03-08 09:08:22 +01007368#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrongd1be7672022-04-04 11:21:41 +02007369 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007370#else
7371 size_t block_size = cipher_info->block_size;
7372#endif /* MBEDTLS_USE_PSA_CRYPTO */
7373
7374#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007375 /* Get MAC length */
7376 mac_key_len = PSA_HASH_LENGTH(mac_alg);
7377#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007378 /* Initialize HMAC contexts */
7379 if( ( ret = mbedtls_md_setup( &transform->md_ctx_enc, md_info, 1 ) ) != 0 ||
7380 ( ret = mbedtls_md_setup( &transform->md_ctx_dec, md_info, 1 ) ) != 0 )
7381 {
7382 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7383 goto end;
7384 }
7385
7386 /* Get MAC length */
7387 mac_key_len = mbedtls_md_get_size( md_info );
Neil Armstronge4512952022-03-08 09:08:22 +01007388#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007389 transform->maclen = mac_key_len;
7390
7391 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007392#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong2230e6c2022-04-27 10:36:14 +02007393 transform->ivlen = PSA_CIPHER_IV_LENGTH( key_type, alg );
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007394#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007395 transform->ivlen = cipher_info->iv_size;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007396#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007397
7398 /* Minimum length */
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007399 if( ssl_mode == MBEDTLS_SSL_MODE_STREAM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007400 transform->minlen = transform->maclen;
7401 else
7402 {
7403 /*
7404 * GenericBlockCipher:
7405 * 1. if EtM is in use: one block plus MAC
7406 * otherwise: * first multiple of blocklen greater than maclen
7407 * 2. IV
7408 */
7409#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007410 if( ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007411 {
7412 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007413 + block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007414 }
7415 else
7416#endif
7417 {
7418 transform->minlen = transform->maclen
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007419 + block_size
7420 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007421 }
7422
Glenn Strauss07c64162022-03-14 12:34:51 -04007423 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007424 {
7425 transform->minlen += transform->ivlen;
7426 }
7427 else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007428 {
7429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7430 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7431 goto end;
7432 }
7433 }
7434 }
7435 else
7436#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7437 {
7438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7439 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
7440 }
7441
7442 MBEDTLS_SSL_DEBUG_MSG( 3, ( "keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7443 (unsigned) keylen,
7444 (unsigned) transform->minlen,
7445 (unsigned) transform->ivlen,
7446 (unsigned) transform->maclen ) );
7447
7448 /*
7449 * Finally setup the cipher contexts, IVs and MAC secrets.
7450 */
7451#if defined(MBEDTLS_SSL_CLI_C)
7452 if( endpoint == MBEDTLS_SSL_IS_CLIENT )
7453 {
7454 key1 = keyblk + mac_key_len * 2;
7455 key2 = keyblk + mac_key_len * 2 + keylen;
7456
7457 mac_enc = keyblk;
7458 mac_dec = keyblk + mac_key_len;
7459
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007460 iv_copy_len = ( transform->fixed_ivlen ) ?
7461 transform->fixed_ivlen : transform->ivlen;
7462 memcpy( transform->iv_enc, key2 + keylen, iv_copy_len );
7463 memcpy( transform->iv_dec, key2 + keylen + iv_copy_len,
7464 iv_copy_len );
7465 }
7466 else
7467#endif /* MBEDTLS_SSL_CLI_C */
7468#if defined(MBEDTLS_SSL_SRV_C)
7469 if( endpoint == MBEDTLS_SSL_IS_SERVER )
7470 {
7471 key1 = keyblk + mac_key_len * 2 + keylen;
7472 key2 = keyblk + mac_key_len * 2;
7473
7474 mac_enc = keyblk + mac_key_len;
7475 mac_dec = keyblk;
7476
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007477 iv_copy_len = ( transform->fixed_ivlen ) ?
7478 transform->fixed_ivlen : transform->ivlen;
7479 memcpy( transform->iv_dec, key1 + keylen, iv_copy_len );
7480 memcpy( transform->iv_enc, key1 + keylen + iv_copy_len,
7481 iv_copy_len );
7482 }
7483 else
7484#endif /* MBEDTLS_SSL_SRV_C */
7485 {
7486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
7487 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7488 goto end;
7489 }
7490
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007491 if( ssl != NULL && ssl->f_export_keys != NULL )
7492 {
7493 ssl->f_export_keys( ssl->p_export_keys,
7494 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7495 master, 48,
7496 randbytes + 32,
7497 randbytes,
7498 tls_prf_get_type( tls_prf ) );
7499 }
7500
7501#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007502 transform->psa_alg = alg;
7503
7504 if ( alg != MBEDTLS_SSL_NULL_CIPHER )
7505 {
7506 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_ENCRYPT );
7507 psa_set_key_algorithm( &attributes, alg );
7508 psa_set_key_type( &attributes, key_type );
7509
7510 if( ( status = psa_import_key( &attributes,
7511 key1,
7512 PSA_BITS_TO_BYTES( key_bits ),
7513 &transform->psa_key_enc ) ) != PSA_SUCCESS )
7514 {
7515 MBEDTLS_SSL_DEBUG_RET( 3, "psa_import_key", (int)status );
7516 ret = psa_ssl_status_to_mbedtls( status );
7517 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7518 goto end;
7519 }
7520
7521 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_DECRYPT );
7522
7523 if( ( status = psa_import_key( &attributes,
7524 key2,
7525 PSA_BITS_TO_BYTES( key_bits ),
7526 &transform->psa_key_dec ) ) != PSA_SUCCESS )
7527 {
7528 ret = psa_ssl_status_to_mbedtls( status );
7529 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_key", ret );
7530 goto end;
7531 }
7532 }
7533#else
7534 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_enc,
7535 cipher_info ) ) != 0 )
7536 {
7537 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7538 goto end;
7539 }
7540
7541 if( ( ret = mbedtls_cipher_setup( &transform->cipher_ctx_dec,
7542 cipher_info ) ) != 0 )
7543 {
7544 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setup", ret );
7545 goto end;
7546 }
7547
7548 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_enc, key1,
7549 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7550 MBEDTLS_ENCRYPT ) ) != 0 )
7551 {
7552 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7553 goto end;
7554 }
7555
7556 if( ( ret = mbedtls_cipher_setkey( &transform->cipher_ctx_dec, key2,
7557 (int) mbedtls_cipher_info_get_key_bitlen( cipher_info ),
7558 MBEDTLS_DECRYPT ) ) != 0 )
7559 {
7560 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_setkey", ret );
7561 goto end;
7562 }
7563
7564#if defined(MBEDTLS_CIPHER_MODE_CBC)
7565 if( mbedtls_cipher_info_get_mode( cipher_info ) == MBEDTLS_MODE_CBC )
7566 {
7567 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_enc,
7568 MBEDTLS_PADDING_NONE ) ) != 0 )
7569 {
7570 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7571 goto end;
7572 }
7573
7574 if( ( ret = mbedtls_cipher_set_padding_mode( &transform->cipher_ctx_dec,
7575 MBEDTLS_PADDING_NONE ) ) != 0 )
7576 {
7577 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_set_padding_mode", ret );
7578 goto end;
7579 }
7580 }
7581#endif /* MBEDTLS_CIPHER_MODE_CBC */
7582#endif /* MBEDTLS_USE_PSA_CRYPTO */
7583
Neil Armstrong29c0c042022-03-17 17:47:28 +01007584#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7585 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7586 For AEAD-based ciphersuites, there is nothing to do here. */
7587 if( mac_key_len != 0 )
7588 {
7589#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01007590 transform->psa_mac_alg = PSA_ALG_HMAC( mac_alg );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007591
7592 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_SIGN_MESSAGE );
Neil Armstronge4512952022-03-08 09:08:22 +01007593 psa_set_key_algorithm( &attributes, PSA_ALG_HMAC( mac_alg ) );
Neil Armstrong29c0c042022-03-17 17:47:28 +01007594 psa_set_key_type( &attributes, PSA_KEY_TYPE_HMAC );
7595
7596 if( ( status = psa_import_key( &attributes,
7597 mac_enc, mac_key_len,
7598 &transform->psa_mac_enc ) ) != PSA_SUCCESS )
7599 {
7600 ret = psa_ssl_status_to_mbedtls( status );
7601 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7602 goto end;
7603 }
7604
Ronald Cronfb39f152022-03-25 14:36:28 +01007605 if( ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ) ||
7606 ( ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING ) &&
7607 ( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED ) ) )
Neil Armstrong29c0c042022-03-17 17:47:28 +01007608 /* mbedtls_ct_hmac() requires the key to be exportable */
7609 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_EXPORT |
7610 PSA_KEY_USAGE_VERIFY_HASH );
7611 else
7612 psa_set_key_usage_flags( &attributes, PSA_KEY_USAGE_VERIFY_HASH );
7613
7614 if( ( status = psa_import_key( &attributes,
7615 mac_dec, mac_key_len,
7616 &transform->psa_mac_dec ) ) != PSA_SUCCESS )
7617 {
7618 ret = psa_ssl_status_to_mbedtls( status );
7619 MBEDTLS_SSL_DEBUG_RET( 1, "psa_import_mac_key", ret );
7620 goto end;
7621 }
7622#else
7623 ret = mbedtls_md_hmac_starts( &transform->md_ctx_enc, mac_enc, mac_key_len );
7624 if( ret != 0 )
7625 goto end;
7626 ret = mbedtls_md_hmac_starts( &transform->md_ctx_dec, mac_dec, mac_key_len );
7627 if( ret != 0 )
7628 goto end;
7629#endif /* MBEDTLS_USE_PSA_CRYPTO */
7630 }
7631#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7632
7633 ((void) mac_dec);
7634 ((void) mac_enc);
7635
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007636end:
7637 mbedtls_platform_zeroize( keyblk, sizeof( keyblk ) );
7638 return( ret );
7639}
7640
Jerry Yuee40f9d2022-02-17 14:55:16 +08007641#if defined(MBEDTLS_USE_PSA_CRYPTO)
7642int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7643 unsigned char *hash, size_t *hashlen,
7644 unsigned char *data, size_t data_len,
7645 mbedtls_md_type_t md_alg )
7646{
7647 psa_status_t status;
7648 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
7649 psa_algorithm_t hash_alg = mbedtls_psa_translate_md( md_alg );
7650
7651 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform PSA-based computation of digest of ServerKeyExchange" ) );
7652
7653 if( ( status = psa_hash_setup( &hash_operation,
7654 hash_alg ) ) != PSA_SUCCESS )
7655 {
7656 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_setup", status );
7657 goto exit;
7658 }
7659
7660 if( ( status = psa_hash_update( &hash_operation, ssl->handshake->randbytes,
7661 64 ) ) != PSA_SUCCESS )
7662 {
7663 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7664 goto exit;
7665 }
7666
7667 if( ( status = psa_hash_update( &hash_operation,
7668 data, data_len ) ) != PSA_SUCCESS )
7669 {
7670 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_update", status );
7671 goto exit;
7672 }
7673
7674 if( ( status = psa_hash_finish( &hash_operation, hash, PSA_HASH_MAX_SIZE,
7675 hashlen ) ) != PSA_SUCCESS )
7676 {
7677 MBEDTLS_SSL_DEBUG_RET( 1, "psa_hash_finish", status );
7678 goto exit;
7679 }
7680
7681exit:
7682 if( status != PSA_SUCCESS )
7683 {
7684 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7685 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7686 switch( status )
7687 {
7688 case PSA_ERROR_NOT_SUPPORTED:
7689 return( MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE );
7690 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
7691 case PSA_ERROR_BUFFER_TOO_SMALL:
7692 return( MBEDTLS_ERR_MD_BAD_INPUT_DATA );
7693 case PSA_ERROR_INSUFFICIENT_MEMORY:
7694 return( MBEDTLS_ERR_MD_ALLOC_FAILED );
7695 default:
7696 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
7697 }
7698 }
7699 return( 0 );
7700}
7701
7702#else
7703
7704int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
7705 unsigned char *hash, size_t *hashlen,
7706 unsigned char *data, size_t data_len,
7707 mbedtls_md_type_t md_alg )
7708{
7709 int ret = 0;
7710 mbedtls_md_context_t ctx;
7711 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( md_alg );
7712 *hashlen = mbedtls_md_get_size( md_info );
7713
7714 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Perform mbedtls-based computation of digest of ServerKeyExchange" ) );
7715
7716 mbedtls_md_init( &ctx );
7717
7718 /*
7719 * digitally-signed struct {
7720 * opaque client_random[32];
7721 * opaque server_random[32];
7722 * ServerDHParams params;
7723 * };
7724 */
7725 if( ( ret = mbedtls_md_setup( &ctx, md_info, 0 ) ) != 0 )
7726 {
7727 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_setup", ret );
7728 goto exit;
7729 }
7730 if( ( ret = mbedtls_md_starts( &ctx ) ) != 0 )
7731 {
7732 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_starts", ret );
7733 goto exit;
7734 }
7735 if( ( ret = mbedtls_md_update( &ctx, ssl->handshake->randbytes, 64 ) ) != 0 )
7736 {
7737 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7738 goto exit;
7739 }
7740 if( ( ret = mbedtls_md_update( &ctx, data, data_len ) ) != 0 )
7741 {
7742 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_update", ret );
7743 goto exit;
7744 }
7745 if( ( ret = mbedtls_md_finish( &ctx, hash ) ) != 0 )
7746 {
7747 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_finish", ret );
7748 goto exit;
7749 }
7750
7751exit:
7752 mbedtls_md_free( &ctx );
7753
7754 if( ret != 0 )
7755 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7756 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
7757
7758 return( ret );
7759}
7760#endif /* MBEDTLS_USE_PSA_CRYPTO */
7761
Jerry Yud9d91da2022-02-17 14:57:06 +08007762#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7763
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007764/* Find the preferred hash for a given signature algorithm. */
7765unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
7766 mbedtls_ssl_context *ssl,
7767 unsigned int sig_alg )
Jerry Yud9d91da2022-02-17 14:57:06 +08007768{
Gabor Mezei078e8032022-04-27 21:17:56 +02007769 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007770 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02007771
7772 if( sig_alg == MBEDTLS_SSL_SIG_ANON )
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007773 return( MBEDTLS_SSL_HASH_NONE );
Gabor Mezei078e8032022-04-27 21:17:56 +02007774
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007775 for( i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++ )
Jerry Yud9d91da2022-02-17 14:57:06 +08007776 {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007777 unsigned int hash_alg_received =
7778 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
7779 received_sig_algs[i] );
7780 unsigned int sig_alg_received =
7781 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
7782 received_sig_algs[i] );
7783
7784 if( sig_alg == sig_alg_received )
7785 {
7786#if defined(MBEDTLS_USE_PSA_CRYPTO)
7787 if( ssl->handshake->key_cert && ssl->handshake->key_cert->key )
7788 {
Neil Armstrong96eceb82022-06-30 18:05:05 +02007789 psa_algorithm_t psa_hash_alg =
7790 mbedtls_psa_translate_md( hash_alg_received );
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007791
Neil Armstrong96eceb82022-06-30 18:05:05 +02007792 if( sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
7793 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7794 PSA_ALG_ECDSA( psa_hash_alg ),
7795 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007796 continue;
7797
Neil Armstrong96eceb82022-06-30 18:05:05 +02007798 if( sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
Neil Armstrong971f30d2022-07-01 16:23:50 +02007799 ! mbedtls_pk_can_do_ext( ssl->handshake->key_cert->key,
7800 PSA_ALG_RSA_PKCS1V15_SIGN(
7801 psa_hash_alg ),
7802 PSA_KEY_USAGE_SIGN_HASH ) )
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007803 continue;
7804 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007805#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02007806
Neil Armstrong9f1176a2022-06-24 18:19:19 +02007807 return( hash_alg_received );
7808 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007809 }
Jerry Yud9d91da2022-02-17 14:57:06 +08007810
Gabor Mezeia3d016c2022-05-10 12:44:09 +02007811 return( MBEDTLS_SSL_HASH_NONE );
Jerry Yud9d91da2022-02-17 14:57:06 +08007812}
7813
7814#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7815
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007816/* Serialization of TLS 1.2 sessions:
7817 *
7818 * struct {
7819 * uint64 start_time;
7820 * uint8 ciphersuite[2]; // defined by the standard
7821 * uint8 compression; // 0 or 1
7822 * uint8 session_id_len; // at most 32
7823 * opaque session_id[32];
7824 * opaque master[48]; // fixed length in the standard
7825 * uint32 verify_result;
7826 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
7827 * opaque ticket<0..2^24-1>; // length 0 means no ticket
7828 * uint32 ticket_lifetime;
7829 * uint8 mfl_code; // up to 255 according to standard
7830 * uint8 encrypt_then_mac; // 0 or 1
7831 * } serialized_session_tls12;
7832 *
7833 */
7834static size_t ssl_session_save_tls12( const mbedtls_ssl_session *session,
7835 unsigned char *buf,
7836 size_t buf_len )
7837{
7838 unsigned char *p = buf;
7839 size_t used = 0;
7840
7841#if defined(MBEDTLS_HAVE_TIME)
7842 uint64_t start;
7843#endif
7844#if defined(MBEDTLS_X509_CRT_PARSE_C)
7845#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7846 size_t cert_len;
7847#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7848#endif /* MBEDTLS_X509_CRT_PARSE_C */
7849
7850 /*
7851 * Time
7852 */
7853#if defined(MBEDTLS_HAVE_TIME)
7854 used += 8;
7855
7856 if( used <= buf_len )
7857 {
7858 start = (uint64_t) session->start;
7859
7860 MBEDTLS_PUT_UINT64_BE( start, p, 0 );
7861 p += 8;
7862 }
7863#endif /* MBEDTLS_HAVE_TIME */
7864
7865 /*
7866 * Basic mandatory fields
7867 */
7868 used += 2 /* ciphersuite */
7869 + 1 /* compression */
7870 + 1 /* id_len */
7871 + sizeof( session->id )
7872 + sizeof( session->master )
7873 + 4; /* verify_result */
7874
7875 if( used <= buf_len )
7876 {
7877 MBEDTLS_PUT_UINT16_BE( session->ciphersuite, p, 0 );
7878 p += 2;
7879
7880 *p++ = MBEDTLS_BYTE_0( session->compression );
7881
7882 *p++ = MBEDTLS_BYTE_0( session->id_len );
7883 memcpy( p, session->id, 32 );
7884 p += 32;
7885
7886 memcpy( p, session->master, 48 );
7887 p += 48;
7888
7889 MBEDTLS_PUT_UINT32_BE( session->verify_result, p, 0 );
7890 p += 4;
7891 }
7892
7893 /*
7894 * Peer's end-entity certificate
7895 */
7896#if defined(MBEDTLS_X509_CRT_PARSE_C)
7897#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7898 if( session->peer_cert == NULL )
7899 cert_len = 0;
7900 else
7901 cert_len = session->peer_cert->raw.len;
7902
7903 used += 3 + cert_len;
7904
7905 if( used <= buf_len )
7906 {
7907 *p++ = MBEDTLS_BYTE_2( cert_len );
7908 *p++ = MBEDTLS_BYTE_1( cert_len );
7909 *p++ = MBEDTLS_BYTE_0( cert_len );
7910
7911 if( session->peer_cert != NULL )
7912 {
7913 memcpy( p, session->peer_cert->raw.p, cert_len );
7914 p += cert_len;
7915 }
7916 }
7917#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7918 if( session->peer_cert_digest != NULL )
7919 {
7920 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
7921 if( used <= buf_len )
7922 {
7923 *p++ = (unsigned char) session->peer_cert_digest_type;
7924 *p++ = (unsigned char) session->peer_cert_digest_len;
7925 memcpy( p, session->peer_cert_digest,
7926 session->peer_cert_digest_len );
7927 p += session->peer_cert_digest_len;
7928 }
7929 }
7930 else
7931 {
7932 used += 2;
7933 if( used <= buf_len )
7934 {
7935 *p++ = (unsigned char) MBEDTLS_MD_NONE;
7936 *p++ = 0;
7937 }
7938 }
7939#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7940#endif /* MBEDTLS_X509_CRT_PARSE_C */
7941
7942 /*
7943 * Session ticket if any, plus associated data
7944 */
7945#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
7946 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
7947
7948 if( used <= buf_len )
7949 {
7950 *p++ = MBEDTLS_BYTE_2( session->ticket_len );
7951 *p++ = MBEDTLS_BYTE_1( session->ticket_len );
7952 *p++ = MBEDTLS_BYTE_0( session->ticket_len );
7953
7954 if( session->ticket != NULL )
7955 {
7956 memcpy( p, session->ticket, session->ticket_len );
7957 p += session->ticket_len;
7958 }
7959
7960 MBEDTLS_PUT_UINT32_BE( session->ticket_lifetime, p, 0 );
7961 p += 4;
7962 }
7963#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
7964
7965 /*
7966 * Misc extension-related info
7967 */
7968#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
7969 used += 1;
7970
7971 if( used <= buf_len )
7972 *p++ = session->mfl_code;
7973#endif
7974
7975#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7976 used += 1;
7977
7978 if( used <= buf_len )
7979 *p++ = MBEDTLS_BYTE_0( session->encrypt_then_mac );
7980#endif
7981
7982 return( used );
7983}
7984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007985MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08007986static int ssl_session_load_tls12( mbedtls_ssl_session *session,
7987 const unsigned char *buf,
7988 size_t len )
7989{
7990#if defined(MBEDTLS_HAVE_TIME)
7991 uint64_t start;
7992#endif
7993#if defined(MBEDTLS_X509_CRT_PARSE_C)
7994#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7995 size_t cert_len;
7996#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7997#endif /* MBEDTLS_X509_CRT_PARSE_C */
7998
7999 const unsigned char *p = buf;
8000 const unsigned char * const end = buf + len;
8001
8002 /*
8003 * Time
8004 */
8005#if defined(MBEDTLS_HAVE_TIME)
8006 if( 8 > (size_t)( end - p ) )
8007 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8008
8009 start = ( (uint64_t) p[0] << 56 ) |
8010 ( (uint64_t) p[1] << 48 ) |
8011 ( (uint64_t) p[2] << 40 ) |
8012 ( (uint64_t) p[3] << 32 ) |
8013 ( (uint64_t) p[4] << 24 ) |
8014 ( (uint64_t) p[5] << 16 ) |
8015 ( (uint64_t) p[6] << 8 ) |
8016 ( (uint64_t) p[7] );
8017 p += 8;
8018
8019 session->start = (time_t) start;
8020#endif /* MBEDTLS_HAVE_TIME */
8021
8022 /*
8023 * Basic mandatory fields
8024 */
8025 if( 2 + 1 + 1 + 32 + 48 + 4 > (size_t)( end - p ) )
8026 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8027
8028 session->ciphersuite = ( p[0] << 8 ) | p[1];
8029 p += 2;
8030
8031 session->compression = *p++;
8032
8033 session->id_len = *p++;
8034 memcpy( session->id, p, 32 );
8035 p += 32;
8036
8037 memcpy( session->master, p, 48 );
8038 p += 48;
8039
8040 session->verify_result = ( (uint32_t) p[0] << 24 ) |
8041 ( (uint32_t) p[1] << 16 ) |
8042 ( (uint32_t) p[2] << 8 ) |
8043 ( (uint32_t) p[3] );
8044 p += 4;
8045
8046 /* Immediately clear invalid pointer values that have been read, in case
8047 * we exit early before we replaced them with valid ones. */
8048#if defined(MBEDTLS_X509_CRT_PARSE_C)
8049#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8050 session->peer_cert = NULL;
8051#else
8052 session->peer_cert_digest = NULL;
8053#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8054#endif /* MBEDTLS_X509_CRT_PARSE_C */
8055#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8056 session->ticket = NULL;
8057#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8058
8059 /*
8060 * Peer certificate
8061 */
8062#if defined(MBEDTLS_X509_CRT_PARSE_C)
8063#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8064 /* Deserialize CRT from the end of the ticket. */
8065 if( 3 > (size_t)( end - p ) )
8066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8067
8068 cert_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8069 p += 3;
8070
8071 if( cert_len != 0 )
8072 {
8073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8074
8075 if( cert_len > (size_t)( end - p ) )
8076 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8077
8078 session->peer_cert = mbedtls_calloc( 1, sizeof( mbedtls_x509_crt ) );
8079
8080 if( session->peer_cert == NULL )
8081 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8082
8083 mbedtls_x509_crt_init( session->peer_cert );
8084
8085 if( ( ret = mbedtls_x509_crt_parse_der( session->peer_cert,
8086 p, cert_len ) ) != 0 )
8087 {
8088 mbedtls_x509_crt_free( session->peer_cert );
8089 mbedtls_free( session->peer_cert );
8090 session->peer_cert = NULL;
8091 return( ret );
8092 }
8093
8094 p += cert_len;
8095 }
8096#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8097 /* Deserialize CRT digest from the end of the ticket. */
8098 if( 2 > (size_t)( end - p ) )
8099 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8100
8101 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
8102 session->peer_cert_digest_len = (size_t) *p++;
8103
8104 if( session->peer_cert_digest_len != 0 )
8105 {
8106 const mbedtls_md_info_t *md_info =
8107 mbedtls_md_info_from_type( session->peer_cert_digest_type );
8108 if( md_info == NULL )
8109 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8110 if( session->peer_cert_digest_len != mbedtls_md_get_size( md_info ) )
8111 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8112
8113 if( session->peer_cert_digest_len > (size_t)( end - p ) )
8114 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8115
8116 session->peer_cert_digest =
8117 mbedtls_calloc( 1, session->peer_cert_digest_len );
8118 if( session->peer_cert_digest == NULL )
8119 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8120
8121 memcpy( session->peer_cert_digest, p,
8122 session->peer_cert_digest_len );
8123 p += session->peer_cert_digest_len;
8124 }
8125#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8126#endif /* MBEDTLS_X509_CRT_PARSE_C */
8127
8128 /*
8129 * Session ticket and associated data
8130 */
8131#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8132 if( 3 > (size_t)( end - p ) )
8133 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8134
8135 session->ticket_len = ( p[0] << 16 ) | ( p[1] << 8 ) | p[2];
8136 p += 3;
8137
8138 if( session->ticket_len != 0 )
8139 {
8140 if( session->ticket_len > (size_t)( end - p ) )
8141 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8142
8143 session->ticket = mbedtls_calloc( 1, session->ticket_len );
8144 if( session->ticket == NULL )
8145 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
8146
8147 memcpy( session->ticket, p, session->ticket_len );
8148 p += session->ticket_len;
8149 }
8150
8151 if( 4 > (size_t)( end - p ) )
8152 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8153
8154 session->ticket_lifetime = ( (uint32_t) p[0] << 24 ) |
8155 ( (uint32_t) p[1] << 16 ) |
8156 ( (uint32_t) p[2] << 8 ) |
8157 ( (uint32_t) p[3] );
8158 p += 4;
8159#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8160
8161 /*
8162 * Misc extension-related info
8163 */
8164#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8165 if( 1 > (size_t)( end - p ) )
8166 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8167
8168 session->mfl_code = *p++;
8169#endif
8170
8171#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8172 if( 1 > (size_t)( end - p ) )
8173 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8174
8175 session->encrypt_then_mac = *p++;
8176#endif
8177
8178 /* Done, should have consumed entire buffer */
8179 if( p != end )
8180 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
8181
8182 return( 0 );
8183}
Jerry Yudc7bd172022-02-17 13:44:15 +08008184#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8185
XiaokangQian75d40ef2022-04-20 11:05:24 +00008186int mbedtls_ssl_validate_ciphersuite(
8187 const mbedtls_ssl_context *ssl,
8188 const mbedtls_ssl_ciphersuite_t *suite_info,
8189 mbedtls_ssl_protocol_version min_tls_version,
8190 mbedtls_ssl_protocol_version max_tls_version )
8191{
8192 (void) ssl;
8193
8194 if( suite_info == NULL )
8195 return( -1 );
8196
8197 if( ( suite_info->min_tls_version > max_tls_version ) ||
8198 ( suite_info->max_tls_version < min_tls_version ) )
8199 {
8200 return( -1 );
8201 }
8202
XiaokangQian060d8672022-04-21 09:24:56 +00008203#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008204#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
8205 if( suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
8206 mbedtls_ecjpake_check( &ssl->handshake->ecjpake_ctx ) != 0 )
8207 {
8208 return( -1 );
8209 }
8210#endif
8211
8212 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8213#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
8214 if( mbedtls_ssl_ciphersuite_uses_psk( suite_info ) &&
8215 mbedtls_ssl_conf_has_static_psk( ssl->conf ) == 0 )
8216 {
8217 return( -1 );
8218 }
8219#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8220#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8221
8222 return( 0 );
8223}
8224
XiaokangQianeaf36512022-04-24 09:07:44 +00008225#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8226/*
8227 * Function for writing a signature algorithm extension.
8228 *
8229 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8230 * value (TLS 1.3 RFC8446):
8231 * enum {
8232 * ....
8233 * ecdsa_secp256r1_sha256( 0x0403 ),
8234 * ecdsa_secp384r1_sha384( 0x0503 ),
8235 * ecdsa_secp521r1_sha512( 0x0603 ),
8236 * ....
8237 * } SignatureScheme;
8238 *
8239 * struct {
8240 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8241 * } SignatureSchemeList;
8242 *
8243 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8244 * value (TLS 1.2 RFC5246):
8245 * enum {
8246 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8247 * sha512(6), (255)
8248 * } HashAlgorithm;
8249 *
8250 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8251 * SignatureAlgorithm;
8252 *
8253 * struct {
8254 * HashAlgorithm hash;
8255 * SignatureAlgorithm signature;
8256 * } SignatureAndHashAlgorithm;
8257 *
8258 * SignatureAndHashAlgorithm
8259 * supported_signature_algorithms<2..2^16-2>;
8260 *
8261 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8262 * generalization of the TLS 1.2 signature algorithm extension.
8263 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8264 * `SignatureScheme` field of TLS 1.3
8265 *
8266 */
8267int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
8268 const unsigned char *end, size_t *out_len )
8269{
8270 unsigned char *p = buf;
8271 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8272 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8273
8274 *out_len = 0;
8275
8276 MBEDTLS_SSL_DEBUG_MSG( 3, ( "adding signature_algorithms extension" ) );
8277
8278 /* Check if we have space for header and length field:
8279 * - extension_type (2 bytes)
8280 * - extension_data_length (2 bytes)
8281 * - supported_signature_algorithms_length (2 bytes)
8282 */
8283 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
8284 p += 6;
8285
8286 /*
8287 * Write supported_signature_algorithms
8288 */
8289 supported_sig_alg = p;
8290 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
8291 if( sig_alg == NULL )
8292 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
8293
8294 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
8295 {
Jerry Yu53f5c152022-06-22 20:24:38 +08008296 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got signature scheme [%x] %s",
8297 *sig_alg,
8298 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008299 if( ! mbedtls_ssl_sig_alg_is_supported( ssl, *sig_alg ) )
8300 continue;
8301 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
8302 MBEDTLS_PUT_UINT16_BE( *sig_alg, p, 0 );
8303 p += 2;
Jerry Yu80dd5db2022-06-22 19:30:32 +08008304 MBEDTLS_SSL_DEBUG_MSG( 3, ( "sent signature scheme [%x] %s",
Jerry Yuf3b46b52022-06-19 16:52:27 +08008305 *sig_alg,
8306 mbedtls_ssl_sig_alg_to_str( *sig_alg ) ) );
XiaokangQianeaf36512022-04-24 09:07:44 +00008307 }
8308
8309 /* Length of supported_signature_algorithms */
8310 supported_sig_alg_len = p - supported_sig_alg;
8311 if( supported_sig_alg_len == 0 )
8312 {
8313 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No signature algorithms defined." ) );
8314 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
8315 }
8316
XiaokangQianeaf36512022-04-24 09:07:44 +00008317 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SIG_ALG, buf, 0 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008318 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len + 2, buf, 2 );
XiaokangQianeaf36512022-04-24 09:07:44 +00008319 MBEDTLS_PUT_UINT16_BE( supported_sig_alg_len, buf, 4 );
8320
XiaokangQianeaf36512022-04-24 09:07:44 +00008321 *out_len = p - buf;
8322
8323#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
8324 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
8325#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8326 return( 0 );
8327}
8328#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8329
XiaokangQian40a35232022-05-07 09:02:40 +00008330#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008331/*
8332 * mbedtls_ssl_parse_server_name_ext
8333 *
8334 * Structure of server_name extension:
8335 *
8336 * enum {
8337 * host_name(0), (255)
8338 * } NameType;
8339 * opaque HostName<1..2^16-1>;
8340 *
8341 * struct {
8342 * NameType name_type;
8343 * select (name_type) {
8344 * case host_name: HostName;
8345 * } name;
8346 * } ServerName;
8347 * struct {
8348 * ServerName server_name_list<1..2^16-1>
8349 * } ServerNameList;
8350 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008351MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00008352int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
8353 const unsigned char *buf,
8354 const unsigned char *end )
XiaokangQian40a35232022-05-07 09:02:40 +00008355{
8356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8357 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008358 size_t server_name_list_len, hostname_len;
8359 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008360
XiaokangQianf2a94202022-05-20 06:44:24 +00008361 MBEDTLS_SSL_DEBUG_MSG( 3, ( "parse ServerName extension" ) );
XiaokangQian40a35232022-05-07 09:02:40 +00008362
8363 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008364 server_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008365 p += 2;
8366
XiaokangQian9b2b7712022-05-17 02:57:00 +00008367 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, server_name_list_len );
8368 server_name_list_end = p + server_name_list_len;
XiaokangQian75fe8c72022-06-15 09:42:45 +00008369 while( p < server_name_list_end )
XiaokangQian40a35232022-05-07 09:02:40 +00008370 {
XiaokangQian9b2b7712022-05-17 02:57:00 +00008371 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end, 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008372 hostname_len = MBEDTLS_GET_UINT16_BE( p, 1 );
XiaokangQian9b2b7712022-05-17 02:57:00 +00008373 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, server_name_list_end,
8374 hostname_len + 3 );
XiaokangQian40a35232022-05-07 09:02:40 +00008375
8376 if( p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME )
8377 {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008378 /* sni_name is intended to be used only during the parsing of the
8379 * ClientHello message (it is reset to NULL before the end of
8380 * the message parsing). Thus it is ok to just point to the
8381 * reception buffer and not make a copy of it.
8382 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008383 ssl->handshake->sni_name = p + 3;
8384 ssl->handshake->sni_name_len = hostname_len;
8385 if( ssl->conf->f_sni == NULL )
8386 return( 0 );
XiaokangQian40a35232022-05-07 09:02:40 +00008387 ret = ssl->conf->f_sni( ssl->conf->p_sni,
XiaokangQian9b2b7712022-05-17 02:57:00 +00008388 ssl, p + 3, hostname_len );
XiaokangQian40a35232022-05-07 09:02:40 +00008389 if( ret != 0 )
8390 {
XiaokangQianf2a94202022-05-20 06:44:24 +00008391 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_sni_wrapper", ret );
XiaokangQian129aeb92022-06-02 09:29:18 +00008392 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8393 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
XiaokangQian40a35232022-05-07 09:02:40 +00008394 return( MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME );
8395 }
8396 return( 0 );
8397 }
8398
8399 p += hostname_len + 3;
8400 }
8401
8402 return( 0 );
8403}
8404#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8405
XiaokangQianacb39922022-06-17 10:18:48 +00008406#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008407MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00008408int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
8409 const unsigned char *buf,
8410 const unsigned char *end )
8411{
8412 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008413 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008414 const unsigned char *protocol_name_list;
8415 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008416 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008417
8418 /* If ALPN not configured, just ignore the extension */
8419 if( ssl->conf->alpn_list == NULL )
8420 return( 0 );
8421
8422 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008423 * RFC7301, section 3.1
8424 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008425 *
XiaokangQianc7403452022-06-23 03:24:12 +00008426 * struct {
8427 * ProtocolName protocol_name_list<2..2^16-1>
8428 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008429 */
8430
XiaokangQianc7403452022-06-23 03:24:12 +00008431 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008432 * protocol_name_list_len 2 bytes
8433 * protocol_name_len 1 bytes
8434 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008435 */
XiaokangQianacb39922022-06-17 10:18:48 +00008436 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
8437
XiaokangQianc7403452022-06-23 03:24:12 +00008438 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQianacb39922022-06-17 10:18:48 +00008439 p += 2;
XiaokangQianc7403452022-06-23 03:24:12 +00008440 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
XiaokangQian95d5f542022-06-24 02:29:26 +00008441 protocol_name_list = p;
8442 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008443
8444 /* Validate peer's list (lengths) */
XiaokangQian95d5f542022-06-24 02:29:26 +00008445 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008446 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008447 protocol_name_len = *p++;
8448 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end,
8449 protocol_name_len );
XiaokangQianc7403452022-06-23 03:24:12 +00008450 if( protocol_name_len == 0 )
XiaokangQian95d5f542022-06-24 02:29:26 +00008451 {
8452 MBEDTLS_SSL_PEND_FATAL_ALERT(
8453 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
8454 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQianacb39922022-06-17 10:18:48 +00008455 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian95d5f542022-06-24 02:29:26 +00008456 }
8457
8458 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008459 }
8460
8461 /* Use our order of preference */
8462 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
8463 {
8464 size_t const alpn_len = strlen( *alpn );
XiaokangQian95d5f542022-06-24 02:29:26 +00008465 p = protocol_name_list;
8466 while( p < protocol_name_list_end )
XiaokangQianacb39922022-06-17 10:18:48 +00008467 {
XiaokangQian95d5f542022-06-24 02:29:26 +00008468 protocol_name_len = *p++;
XiaokangQianc7403452022-06-23 03:24:12 +00008469 if( protocol_name_len == alpn_len &&
XiaokangQian95d5f542022-06-24 02:29:26 +00008470 memcmp( p, *alpn, alpn_len ) == 0 )
XiaokangQianacb39922022-06-17 10:18:48 +00008471 {
8472 ssl->alpn_chosen = *alpn;
8473 return( 0 );
8474 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008475
8476 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008477 }
8478 }
8479
XiaokangQian95d5f542022-06-24 02:29:26 +00008480 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008481 MBEDTLS_SSL_PEND_FATAL_ALERT(
8482 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8483 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8484 return( MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL );
8485}
8486
8487int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
8488 unsigned char *buf,
8489 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00008490 size_t *out_len )
XiaokangQianacb39922022-06-17 10:18:48 +00008491{
8492 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008493 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008494 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008495
8496 if( ssl->alpn_chosen == NULL )
8497 {
8498 return( 0 );
8499 }
8500
XiaokangQian95d5f542022-06-24 02:29:26 +00008501 protocol_name_len = strlen( ssl->alpn_chosen );
8502 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 + protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008503
8504 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server side, adding alpn extension" ) );
8505 /*
8506 * 0 . 1 ext identifier
8507 * 2 . 3 ext length
8508 * 4 . 5 protocol list length
8509 * 6 . 6 protocol name length
8510 * 7 . 7+n protocol name
8511 */
8512 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_ALPN, p, 0 );
8513
XiaokangQian95d5f542022-06-24 02:29:26 +00008514 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008515
XiaokangQian95d5f542022-06-24 02:29:26 +00008516 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 3, p, 2 );
8517 MBEDTLS_PUT_UINT16_BE( protocol_name_len + 1, p, 4 );
XiaokangQian0b776e22022-06-24 09:04:59 +00008518 /* Note: the length of the chosen protocol has been checked to be less
8519 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8520 */
XiaokangQian95d5f542022-06-24 02:29:26 +00008521 p[6] = MBEDTLS_BYTE_0( protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008522
XiaokangQian95d5f542022-06-24 02:29:26 +00008523 memcpy( p + 7, ssl->alpn_chosen, protocol_name_len );
XiaokangQianacb39922022-06-17 10:18:48 +00008524 return ( 0 );
8525}
8526#endif /* MBEDTLS_SSL_ALPN */
8527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008528#endif /* MBEDTLS_SSL_TLS_C */